Delete a connector sync job

Auth

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

Path parameters

connector_sync_job_id string required: The unique identifier of the connector sync job to be deleted

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

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
}