Create a connector sync job Beta; Added in 8.12.0

POST /_connector/_sync_job
Api key auth Basic auth Bearer auth

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

application/json

Body Required

  • id string Required

    The id of the associated connector

  • job_type string

    Values are full, incremental, or access_control.

  • trigger_method string

    Values are on_demand or scheduled.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • id string Required
POST /_connector/_sync_job 
POST _connector/_sync_job { "id": "connector-id", "job_type": "full", "trigger_method": "on_demand" }
resp = client.connector.sync_job_post( id="connector-id", job_type="full", trigger_method="on_demand", )
const response = await client.connector.syncJobPost({ id: "connector-id", job_type: "full", trigger_method: "on_demand", });
response = client.connector.sync_job_post( body: { "id": "connector-id", "job_type": "full", "trigger_method": "on_demand" } )
$resp = $client->connector()->syncJobPost([ "body" => [ "id" => "connector-id", "job_type" => "full", "trigger_method" => "on_demand", ], ]);
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"id":"connector-id","job_type":"full","trigger_method":"on_demand"}' "$ELASTICSEARCH_URL/_connector/_sync_job"
client.connector().syncJobPost(s -> s .id("connector-id") .jobType(SyncJobType.Full) .triggerMethod(SyncJobTriggerMethod.OnDemand) );
Request example 
{ "id": "connector-id", "job_type": "full", "trigger_method": "on_demand" }