IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Update connector status API Set connector sync job error API »

› › ›

Check in connector sync job API

edit

Check in connector sync job API

edit

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).

To get started with Connector APIs, check out the tutorial.

Request

edit

PUT _connector/_sync_job/<connector_sync_job_id>/_check_in/

Prerequisites

edit

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 native connectors.
The connector_sync_job_id parameter should reference an existing connector sync job.

Description

edit

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

Path parameters

edit

<connector_sync_job_id>: (Required, string)

Response codes

edit

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

Examples

edit

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

resp = client.perform_request(
    "PUT",
    "/_connector/_sync_job/my-connector-sync-job/_check_in",
)
print(resp)

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

const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/_sync_job/my-connector-sync-job/_check_in",
});
console.log(response);

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

« Update connector status API Set connector sync job error API »