123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687 |
- [[delete-connector-api]]
- === Delete connector API
- ++++
- <titleabbrev>Delete connector</titleabbrev>
- ++++
- beta::[]
- .New API reference
- [sidebar]
- --
- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[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 <<es-connectors-tutorial-api, our tutorial>>.
- [[delete-connector-api-request]]
- ==== {api-request-title}
- `DELETE _connector/<connector_id>`
- [[delete-connector-api-prereq]]
- ==== {api-prereq-title}
- * To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,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.
- [[delete-connector-api-path-params]]
- ==== {api-path-parms-title}
- `<connector_id>`::
- (Required, string)
- `delete_sync_jobs`::
- (Optional, boolean) A flag indicating if associated sync jobs should be also removed. Defaults to `false`.
- [[delete-connector-api-response-codes]]
- ==== {api-response-codes-title}
- `400`::
- The `connector_id` was not provided.
- `404` (Missing resources)::
- No connector matching `connector_id` could be found.
- [[delete-connector-api-example]]
- ==== {api-examples-title}
- The following example deletes the connector with ID `my-connector`:
- ////
- [source, console]
- --------------------------------------------------
- PUT _connector/my-connector
- {
- "name": "My Connector",
- "service_type": "google_drive"
- }
- PUT _connector/another-connector
- {
- "name": "My Connector",
- "service_type": "google_drive"
- }
- --------------------------------------------------
- // TESTSETUP
- ////
- [source,console]
- ----
- DELETE _connector/another-connector?delete_sync_jobs=true
- ----
- [source,console-result]
- ----
- {
- "acknowledged": true
- }
- ----
- The following example deletes the connector with ID `another-connector` and its associated sync jobs.
|