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

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. [[delete-connector-sync-job-api]]
  2. === Delete connector sync job API
  3. ++++
  4. <titleabbrev>Delete connector sync job</titleabbrev>
  5. ++++
  6. preview::[]
  7. Removes a connector sync job and its associated data.
  8. This is a destructive action that is not recoverable.
  9. [[delete-connector-sync-job-api-request]]
  10. ==== {api-request-title}
  11. `DELETE _connector/_sync_job/<connector_sync_job_id>`
  12. [[delete-connector-sync-job-api-prereq]]
  13. ==== {api-prereq-title}
  14. * To sync data using connectors, it's essential to have the Elastic connectors service running.
  15. [[delete-connector-sync-job-api-path-params]]
  16. ==== {api-path-parms-title}
  17. `<connector_sync_job_id>`::
  18. (Required, string)
  19. [[delete-connector-sync-job-api-response-codes]]
  20. ==== {api-response-codes-title}
  21. `400`::
  22. The `connector_sync_job_id` was not provided.
  23. `404`::
  24. No connector sync job matching `connector_sync_job_id` could be found.
  25. [[delete-connector-sync-job-api-example]]
  26. ==== {api-examples-title}
  27. The following example deletes the connector sync job with ID `my-connector-sync-job-id`:
  28. [source,console]
  29. ----
  30. DELETE _connector/_sync_job/my-connector-sync-job-id
  31. ----
  32. // 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]
  33. [source,console-result]
  34. ----
  35. {
  36. "acknowledged": true
  37. }
  38. ----