IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Cancel connector sync job API
editCancel connector sync job API
editThis 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 the tutorial.
Request
editPUT _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 native connectors.
-
The
connector_sync_job_idparameter should reference an existing connector sync job.
Description
editCancels 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_idcould be found.
Examples
editThe 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