1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 |
- [[check-in-connector-sync-job-api]]
- === Check in connector sync job API
- ++++
- <titleabbrev>Check in connector sync job</titleabbrev>
- ++++
- preview::[]
- Checks in a connector sync job (updates `last_seen` to the current time).
- [[check-in-connector-sync-job-api-request]]
- ==== {api-request-title}
- `PUT _connector/_sync_job/<connector_sync_job_id>/_check_in/`
- [[check-in-connector-sync-job-api-prereqs]]
- ==== {api-prereq-title}
- * 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.
- * The `connector_sync_job_id` parameter should reference an existing connector sync job.
- [[check-in-connector-sync-job-api-desc]]
- ==== {api-description-title}
- Checks in a connector sync job and sets `last_seen` to the time right before updating it in the internal index.
- [[check-in-connector-sync-job-path-params]]
- ==== {api-path-parms-title}
- `<connector_sync_job_id>`::
- (Required, string)
- [[check-in-connector-sync-job-api-response-codes]]
- ==== {api-response-codes-title}
- `200`::
- Connector sync job was successfully checked in.
- `404`::
- No connector sync job matching `connector_sync_job_id` could be found.
- [[check-in-connector-sync-job-api-example]]
- ==== {api-examples-title}
- The following example checks in the connector sync job `my-connector-sync-job`:
- [source,console]
- ----
- PUT _connector/_sync_job/my-connector-sync-job/_check_in
- ----
- // 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.]
|