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.
Delete connector sync job API
editDelete 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.
Removes a connector sync job and its associated data. This is a destructive action that is not recoverable.
To get started with Connector APIs, check out our tutorial.
Request
editDELETE _connector/_sync_job/<connector_sync_job_id>
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.
Path parameters
edit-
<connector_sync_job_id> - (Required, string)
Response codes
edit-
400 -
The
connector_sync_job_idwas not provided. -
404 -
No connector sync job matching
connector_sync_job_idcould be found.
Examples
editThe following example deletes the connector sync job with ID my-connector-sync-job-id:
resp = client.perform_request(
"DELETE",
"/_connector/_sync_job/my-connector-sync-job-id",
)
print(resp)
response = client.connector.sync_job_delete( connector_sync_job_id: 'my-connector-sync-job-id' ) puts response
const response = await client.transport.request({
method: "DELETE",
path: "/_connector/_sync_job/my-connector-sync-job-id",
});
console.log(response);
DELETE _connector/_sync_job/my-connector-sync-job-id
{
"acknowledged": true
}