Check in a connector sync job

PUT /_connector/_sync_job/{connector_sync_job_id}/_check_in

Auth

Check in a connector sync job and set the last_seen field to the current time before updating it in the internal index.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

Path parameters

connector_sync_job_id string required: The unique identifier of the connector sync job to be checked in.

Response

application/json

Response Type: object

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT _connector/_sync_job/my-connector-sync-job/_check_in

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.syncJobCheckIn({
  connector_sync_job_id: "my-connector-sync-job",
});

Python Elasticsearch Python Client

resp = client.connector.sync_job_check_in(
    connector_sync_job_id="my-connector-sync-job",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_connector/_sync_job/my-connector-sync-job/_check_in" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.connector().syncJobCheckIn(s -> s
    .connectorSyncJobId("my-connector-sync-job")
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->syncJobCheckIn([
    "connector_sync_job_id" => "my-connector-sync-job",
]);

Ruby Elasticsearch Ruby Client

response = client.connector.sync_job_check_in(
  connector_sync_job_id: "my-connector-sync-job"
)

Response

{}

Generated from the API spec