Delete a connector

DELETE /_connector/{connector_id}

Auth

Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually.

Path parameters

connector_id string required: The unique identifier of the connector to be deleted

Query parameters

delete_sync_jobs boolean · default: false: A flag indicating if associated sync jobs should be also removed.

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

DELETE _connector/my-connector-id&delete_sync_jobs=true

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.delete({
  connector_id: "my-connector-id&delete_sync_jobs=true",
});

Python Elasticsearch Python Client

resp = client.connector.delete(
    connector_id="my-connector-id&delete_sync_jobs=true",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_connector/my-connector-id&delete_sync_jobs=true" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.connector().delete(d -> d
    .connectorId("my-connector-id&delete_sync_jobs=true")
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->delete([
    "connector_id" => "my-connector-id&delete_sync_jobs=true",
]);

Ruby Elasticsearch Ruby Client

response = client.connector.delete(
  connector_id: "my-connector-id&delete_sync_jobs=true"
)

Response

{
    "acknowledged": true
}