You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Cancel connector sync job APIedit
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features 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 self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
-
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