Get a connector sync job

GET /_connector/_sync_job/{connector_sync_job_id}

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Response

application/json

cancelation_requested_at union
canceled_at union
completed_at union
connector object required
created_at union required
deleted_document_count number required
error string
id string required
indexed_document_count number required
indexed_document_volume number required
job_type enum required: Values: full incremental access_control
last_seen union
metadata map string to object required
started_at union
status enum required: Values: canceling canceled completed error in_progress pending suspended
total_document_count number required
trigger_method enum required: Values: on_demand scheduled
worker_hostname string

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET _connector/_sync_job/my-connector-sync-job

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

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

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

No example