New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Delete connector API Get connector API »
Elastic Docs ›Elasticsearch Guide [8.12] ›REST APIs ›Connector APIs

Delete connector sync job API

edit

Delete connector sync job API

edit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Removes a connector sync job and its associated data. This is a destructive action that is not recoverable.

Request

edit

DELETE _connector/_sync_job/<connector_sync_job_id>

Prerequisites

edit
  • To sync data using connectors, it’s essential to have the Elastic connectors service running.

Path parameters

edit
<connector_sync_job_id>
(Required, string)

Response codes

edit
400
The connector_sync_job_id was not provided.
404
No connector sync job matching connector_sync_job_id could be found.

Examples

edit

The following example deletes the connector sync job with ID my-connector-sync-job-id:

response = client.connector_sync_job.delete(
  connector_sync_job_id: 'my-connector-sync-job-id'
)
puts response
DELETE _connector/_sync_job/my-connector-sync-job-id
Copy as curlTry in Elastic 
{
    "acknowledged": true
}
« Delete connector API Get connector API »

On this page

Was this helpful?
Feedback