This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Create connector sync job API Delete connector sync job API »

› › ›

Cancel connector sync job API

edit

Cancel connector sync job API

edit

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.

To get started with Connector APIs, check out our tutorial.

Request

edit

PUT _connector/_sync_job/<connector_sync_job_id>/_cancel

Prerequisites

edit

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 Elastic managed connectors.
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:

resp = client.perform_request(
    "PUT",
    "/_connector/_sync_job/my-connector-sync-job-id/_cancel",
)
print(resp)

response = client.connector.sync_job_cancel(
  connector_sync_job_id: 'my-connector-sync-job-id'
)
puts response

const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/_sync_job/my-connector-sync-job-id/_cancel",
});
console.log(response);

PUT _connector/_sync_job/my-connector-sync-job-id/_cancel

« Create connector sync job API Delete connector sync job API »