IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create connector API Get connector API »

› › ›

Delete connector API

edit

Delete connector API

edit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Removes a connector and associated sync jobs. This is a destructive action that is not recoverable.

Note: this action doesn’t delete any API key, ingest pipeline or data index associated with the connector. These need to be removed manually.

To get started with Connector APIs, check out the tutorial.

Request

edit

DELETE _connector/<connector_id>

Prerequisites

edit

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
The connector_id parameter should reference an existing connector.

Path parameters

edit

<connector_id>: (Required, string)
delete_sync_jobs: (Optional, boolean) A flag indicating if associated sync jobs should be also removed. Defaults to false.

Response codes

edit

400: The connector_id was not provided.
404 (Missing resources): No connector matching connector_id could be found.

Examples

edit

The following example deletes the connector with ID my-connector:

resp = client.connector.delete(
    connector_id="another-connector",
    delete_sync_jobs=True,
)
print(resp)

const response = await client.connector.delete({
  connector_id: "another-connector",
  delete_sync_jobs: "true",
});
console.log(response);

DELETE _connector/another-connector?delete_sync_jobs=true

{
    "acknowledged": true
}

The following example deletes the connector with ID another-connector and its associated sync jobs.

« Create connector API Get connector API »