Delete a connector sync job

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

Authentication

Authorization: <value>

Elasticsearch APIs use 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}"

For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to Get started with Elasticsearch Serverless.

application/json

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

DELETE _connector/_sync_job/my-connector-sync-job-id

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.syncJobDelete({
  connector_sync_job_id: "my-connector-sync-job-id",
});

Python Elasticsearch Python Client

resp = client.connector.sync_job_delete(
    connector_sync_job_id="my-connector-sync-job-id",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_connector/_sync_job/my-connector-sync-job-id" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.connector().syncJobDelete(s -> s
    .connectorSyncJobId("my-connector-sync-job-id")
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->syncJobDelete([
    "connector_sync_job_id" => "my-connector-sync-job-id",
]);

Ruby Elasticsearch Ruby Client

response = client.connector.sync_job_delete(
  connector_sync_job_id: "my-connector-sync-job-id"
)

Response

{
  "acknowledged": true
}