Cancel a connector sync job Beta

PUT /_connector/_sync_job/{connector_sync_job_id}/_cancel
Api key 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

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • result string Required

      Values are created, updated, deleted, not_found, or noop.
PUT /_connector/_sync_job/{connector_sync_job_id}/_cancel 
PUT _connector/_sync_job/my-connector-sync-job-id/_cancel 
resp = client.connector.sync_job_cancel( connector_sync_job_id="my-connector-sync-job-id", )
const response = await client.connector.syncJobCancel({ connector_sync_job_id: "my-connector-sync-job-id", });
response = client.connector.sync_job_cancel( connector_sync_job_id: "my-connector-sync-job-id" )
$resp = $client->connector()->syncJobCancel([ "connector_sync_job_id" => "my-connector-sync-job-id", ]);
curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_connector/_sync_job/my-connector-sync-job-id/_cancel"
client.connector().syncJobCancel(s -> s .connectorSyncJobId("my-connector-sync-job-id") );