You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Delete connector APIedit
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.
Requestedit
DELETE _connector/<connector_id>
Prerequisitesedit
- 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_idparameter should reference an existing connector.
Path parametersedit
-
<connector_id> - (Required, string)
-
delete_sync_jobs -
(Optional, boolean) A flag indicating if associated sync jobs should be also removed. Defaults to
false.
Response codesedit
-
400 -
The
connector_idwas not provided. -
404(Missing resources) -
No connector matching
connector_idcould be found.
Examplesedit
The following example deletes the connector with ID my-connector:
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.