Create a connector sync job

POST /_connector/_sync_job

Auth

Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.

Request body

id string required: The id of the associated connector
job_type enum: Values: full incremental access_control
trigger_method enum: Values: on_demand scheduled

Response

application/json

id string required

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

POST _connector/_sync_job
{
  "id": "connector-id",
  "job_type": "full",
  "trigger_method": "on_demand"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.syncJobPost({
  id: "connector-id",
  job_type: "full",
  trigger_method: "on_demand",
});

Python Elasticsearch Python Client

resp = client.connector.sync_job_post(
    id="connector-id",
    job_type="full",
    trigger_method="on_demand",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_connector/_sync_job" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "connector-id",
    "job_type": "full",
    "trigger_method": "on_demand"
  }'

Java Elasticsearch Java Client

client.connector().syncJobPost(s -> s
    .id("connector-id")
    .jobType(SyncJobType.Full)
    .triggerMethod(SyncJobTriggerMethod.OnDemand)
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->syncJobPost([
    "body" => [
        "id" => "connector-id",
        "job_type" => "full",
        "trigger_method" => "on_demand",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.connector.sync_job_post(
  body: {
    "id": "connector-id",
    "job_type": "full",
    "trigger_method": "on_demand"
  }
)

Response

{
  "id": "string"
}

Generated from the API spec

Request body { }

Response

Request body