Delete connector API

Delete connector API

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.

New API reference

For the most up-to-date API details, refer to Connector APIs.

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 our tutorial.

Request

DELETE _connector/<connector_id>

Prerequisites

  • 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 Elastic managed connectors.
  • The connector_id parameter should reference an existing connector.

Path parameters

<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

400

The connector_id was not provided.

404 (Missing resources)

No connector matching connector_id could be found.

Examples

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

  1. resp = client.connector.delete(
  2.     connector_id="another-connector",
  3.     delete_sync_jobs=True,
  4. )
  5. print(resp)
  1. const response = await client.connector.delete({
  2.   connector_id: "another-connector",
  3.   delete_sync_jobs: "true",
  4. });
  5. console.log(response);
  1. DELETE _connector/another-connector?delete_sync_jobs=true
  1. {
  2.     "acknowledged": true
  3. }

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