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

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. [[delete-connector-sync-job-api]]
  2. === Delete connector sync job API
  3. ++++
  4. <titleabbrev>Delete connector sync job</titleabbrev>
  5. ++++
  6. beta::[]
  7. .New API reference
  8. [sidebar]
  9. --
  10. For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs].
  11. --
  12. Removes a connector sync job and its associated data.
  13. This is a destructive action that is not recoverable.
  14. To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.
  15. [[delete-connector-sync-job-api-request]]
  16. ==== {api-request-title}
  17. `DELETE _connector/_sync_job/<connector_sync_job_id>`
  18. [[delete-connector-sync-job-api-prereq]]
  19. ==== {api-prereq-title}
  20. * To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
  21. [[delete-connector-sync-job-api-path-params]]
  22. ==== {api-path-parms-title}
  23. `<connector_sync_job_id>`::
  24. (Required, string)
  25. [[delete-connector-sync-job-api-response-codes]]
  26. ==== {api-response-codes-title}
  27. `400`::
  28. The `connector_sync_job_id` was not provided.
  29. `404`::
  30. No connector sync job matching `connector_sync_job_id` could be found.
  31. [[delete-connector-sync-job-api-example]]
  32. ==== {api-examples-title}
  33. The following example deletes the connector sync job with ID `my-connector-sync-job-id`:
  34. [source,console]
  35. ----
  36. DELETE _connector/_sync_job/my-connector-sync-job-id
  37. ----
  38. // 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]
  39. [source,console-result]
  40. ----
  41. {
  42. "acknowledged": true
  43. }
  44. ----