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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. [[get-connector-sync-job-api]]
  2. === Get connector sync job API
  3. ++++
  4. <titleabbrev>Get 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. Retrieves the details about a connector sync job.
  13. To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.
  14. [[get-connector-sync-job-api-request]]
  15. ==== {api-request-title}
  16. `GET _connector/_sync_job/<connector_sync_job_id>`
  17. [[get-connector-sync-job-api-prereq]]
  18. ==== {api-prereq-title}
  19. * 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.
  20. [[get-connector-sync-job-api-path-params]]
  21. ==== {api-path-parms-title}
  22. `<connector_sync_job_id>`::
  23. (Required, string)
  24. [[get-connector-sync-job-api-response-codes]]
  25. ==== {api-response-codes-title}
  26. `400`::
  27. The `connector_sync_job_id` was not provided.
  28. `404` (Missing resources)::
  29. No connector sync job matching `connector_sync_job_id` could be found.
  30. [[get-connector-sync-job-api-example]]
  31. ==== {api-examples-title}
  32. The following example gets the connector sync job `my-connector-sync-job`:
  33. [source,console]
  34. ----
  35. GET _connector/_sync_job/my-connector-sync-job
  36. ----
  37. // 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.]