Delete a connector

DELETE /_connector/{connector_id}

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.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

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
}