Claim a connector sync job

PUT /_connector/_sync_job/{connector_sync_job_id}/_claim

This action updates the job status to in_progress and sets the last_seen and started_at timestamps to the current time. Additionally, it can set the sync_cursor property for the sync job.

This API is not intended for direct connector management by users. It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.

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 Id required: The unique identifier of the connector sync job.

Request

Response

application/json

Examples

An example body for a PUT _connector/_sync_job/my-connector-sync-job-id/_claim request.

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT _connector/_sync_job/my-connector-sync-job-id/_claim
{
  "worker_hostname": "some-machine"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.syncJobClaim({
  connector_sync_job_id: "my-connector-sync-job-id",
  worker_hostname: "some-machine",
});

Python Elasticsearch Python Client

resp = client.connector.sync_job_claim(
    connector_sync_job_id="my-connector-sync-job-id",
    worker_hostname="some-machine",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_connector/_sync_job/my-connector-sync-job-id/_claim" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "worker_hostname": "some-machine"
  }'

Java Elasticsearch Java Client

client.connector().syncJobClaim(s -> s
    .connectorSyncJobId("my-connector-sync-job-id")
    .workerHostname("some-machine")
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->syncJobClaim([
    "connector_sync_job_id" => "my-connector-sync-job-id",
    "body" => [
        "worker_hostname" => "some-machine",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.connector.sync_job_claim(
  connector_sync_job_id: "my-connector-sync-job-id",
  body: {
    "worker_hostname": "some-machine"
  }
)

Response

No example

Path Parameters

Request { sync_cursor , worker_hostname , }

Response

Request