Cancel connector sync job APIedit
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.
Requestedit
PUT _connector/_sync_job/<connector_sync_job_id>/_cancel
Prerequisitesedit
- To sync data using connectors, it’s essential to have the Elastic connectors service running.
-
The
connector_sync_job_idparameter should reference an existing connector sync job.
Descriptionedit
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 parametersedit
-
connector_sync_job_id - (Required, string)
Response codesedit
-
200 - Connector sync job cancellation was successfully requested.
-
404 -
No connector sync job matching
connector_sync_job_idcould be found.
Examplesedit
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