check-in-connector-sync-job-api.asciidoc 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. [[check-in-connector-sync-job-api]]
  2. === Check in connector sync job API
  3. ++++
  4. <titleabbrev>Check in connector sync job</titleabbrev>
  5. ++++
  6. preview::[]
  7. Checks in a connector sync job (updates `last_seen` to the current time).
  8. [[check-in-connector-sync-job-api-request]]
  9. ==== {api-request-title}
  10. `PUT _connector/_sync_job/<connector_sync_job_id>/_check_in/`
  11. [[check-in-connector-sync-job-api-prereqs]]
  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. * The `connector_sync_job_id` parameter should reference an existing connector sync job.
  15. [[check-in-connector-sync-job-api-desc]]
  16. ==== {api-description-title}
  17. Checks in a connector sync job and sets `last_seen` to the time right before updating it in the internal index.
  18. [[check-in-connector-sync-job-path-params]]
  19. ==== {api-path-parms-title}
  20. `<connector_sync_job_id>`::
  21. (Required, string)
  22. [[check-in-connector-sync-job-api-response-codes]]
  23. ==== {api-response-codes-title}
  24. `200`::
  25. Connector sync job was successfully checked in.
  26. `404`::
  27. No connector sync job matching `connector_sync_job_id` could be found.
  28. [[check-in-connector-sync-job-api-example]]
  29. ==== {api-examples-title}
  30. The following example checks in the connector sync job `my-connector-sync-job`:
  31. [source,console]
  32. ----
  33. PUT _connector/_sync_job/my-connector-sync-job/_check_in
  34. ----
  35. // 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.]