delete-connector-sync-job-api.asciidoc 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. [[delete-connector-sync-job-api]]
  2. === Delete connector sync job API
  3. ++++
  4. <titleabbrev>Delete connector sync job</titleabbrev>
  5. ++++
  6. beta::[]
  7. Removes a connector sync job and its associated data.
  8. This is a destructive action that is not recoverable.
  9. To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
  10. [[delete-connector-sync-job-api-request]]
  11. ==== {api-request-title}
  12. `DELETE _connector/_sync_job/<connector_sync_job_id>`
  13. [[delete-connector-sync-job-api-prereq]]
  14. ==== {api-prereq-title}
  15. * To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
  16. [[delete-connector-sync-job-api-path-params]]
  17. ==== {api-path-parms-title}
  18. `<connector_sync_job_id>`::
  19. (Required, string)
  20. [[delete-connector-sync-job-api-response-codes]]
  21. ==== {api-response-codes-title}
  22. `400`::
  23. The `connector_sync_job_id` was not provided.
  24. `404`::
  25. No connector sync job matching `connector_sync_job_id` could be found.
  26. [[delete-connector-sync-job-api-example]]
  27. ==== {api-examples-title}
  28. The following example deletes the connector sync job with ID `my-connector-sync-job-id`:
  29. [source,console]
  30. ----
  31. DELETE _connector/_sync_job/my-connector-sync-job-id
  32. ----
  33. // TEST[skip:there's no way to clean up after this code snippet, as we don't know the ids of sync jobs ahead of time]
  34. [source,console-result]
  35. ----
  36. {
  37. "acknowledged": true
  38. }
  39. ----