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

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. [[get-connector-sync-job-api]]
  2. === Get connector sync job API
  3. ++++
  4. <titleabbrev>Get connector sync job</titleabbrev>
  5. ++++
  6. preview::[]
  7. Retrieves the details about a connector sync job.
  8. [[get-connector-sync-job-api-request]]
  9. ==== {api-request-title}
  10. `GET _connector/_sync_job/<connector_sync_job_id>`
  11. [[get-connector-sync-job-api-prereq]]
  12. ==== {api-prereq-title}
  13. * 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.
  14. [[get-connector-sync-job-api-path-params]]
  15. ==== {api-path-parms-title}
  16. `<connector_sync_job_id>`::
  17. (Required, string)
  18. [[get-connector-sync-job-api-response-codes]]
  19. ==== {api-response-codes-title}
  20. `400`::
  21. The `connector_sync_job_id` was not provided.
  22. `404` (Missing resources)::
  23. No connector sync job matching `connector_sync_job_id` could be found.
  24. [[get-connector-sync-job-api-example]]
  25. ==== {api-examples-title}
  26. The following example gets the connector sync job `my-connector-sync-job`:
  27. [source,console]
  28. ----
  29. GET _connector/_sync_job/my-connector-sync-job
  30. ----
  31. // TEST[skip:there's no way to clean up after creating a connector sync job, as we don't know the id ahead of time. Therefore, skip this test.]