Check in connector sync job APIedit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Checks in a connector sync job (updates last_seen to the current time).

Requestedit

PUT _connector/_sync_job/<connector_sync_job_id>/_check_in/

Prerequisitesedit

  • To sync data using connectors, it’s essential to have the Elastic connectors service running.
  • The connector_sync_job_id parameter should reference an existing connector sync job.

Descriptionedit

Checks in a connector sync job and sets last_seen to the time right before updating it in the internal index.

Path parametersedit

<connector_sync_job_id>
(Required, string)

Response codesedit

200
Connector sync job was successfully checked in.
404
No connector sync job matching connector_sync_job_id could be found.

Examplesedit

The following example checks in the connector sync job my-connector-sync-job:

response = client.connector_sync_job.check_in(
  connector_sync_job_id: 'my-connector-sync-job'
)
puts response
PUT _connector/_sync_job/my-connector-sync-job/_check_in