Cancel a connector sync job

PUT /_connector/_sync_job/{connector_sync_job_id}/_cancel

Auth

Cancel a connector sync job, which sets the status to cancelling and updates cancellation_requested_at to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled.

Path parameters

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

Response

application/json

result enum required: Values: created updated deleted not_found noop

View as Markdown

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT _connector/_sync_job/my-connector-sync-job-id/_cancel

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

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

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

{
  "result": "created"
}

Generated from the API spec