delete_datasource

DatasourcesApi.delete_datasource(datasource_id, role_id, delete_lineage=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete the datasource

Deletes a datasource (owner access required). Fails if dependent schedules or insight dashboards still exist for applicable types. Optional delete-lineage=true also removes lineage associations.

Parameters:

  • datasource_id (str) – (required)

  • role_id (str) – (required)

  • delete_lineage (str) – When true, also deletes lineage associated with the datasource. Defaults to false.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

MessageStatus

Returns:

Returns the result object.

Request and Response Examples

HTTP: DELETE /datasources/{datasource_id}

Success (HTTP 200)

Datasource deleted successfully or deletion triggered in background

Errors

HTTP 400

Missing required request parameters

HTTP 500

Something went wrong at backend