IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Connector APIs Check in connector API »
Elastic Docs ›Elasticsearch Guide [8.13] ›REST APIs ›Connector APIs

Cancel connector sync job API

edit

Cancel connector sync job API

edit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Cancels a connector sync job.

Request

edit

PUT _connector/_sync_job/<connector_sync_job_id>/_cancel

Prerequisites

edit
  • To sync data using connectors, it’s essential to have the Elastic connectors service running.
  • The connector_sync_job_id parameter should reference an existing connector sync job.

Description

edit

Cancels 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

edit
connector_sync_job_id
(Required, string)

Response codes

edit
200
Connector sync job cancellation was successfully requested.
404
No connector sync job matching connector_sync_job_id could be found.

Examples

edit

The following example cancels the connector sync job with ID my-connector-sync-job-id:

response = client.connector_sync_job.cancel(
  connector_sync_job_id: 'my-connector-sync-job-id'
)
puts response
PUT _connector/_sync_job/my-connector-sync-job-id/_cancel
« Connector APIs Check in connector API »