Cancel a connector sync job

PUT /_connector/_sync_job/{connector_sync_job_id}/_cancel

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.

Authentication

Api key

Authorization: <value>

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

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Response

application/json

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

No example