Create connector sync job APIedit
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.
Creates a connector sync job.
response = client.connector_sync_job.post( body: { id: 'connector-id', job_type: 'full', trigger_method: 'on_demand' } ) puts response
POST _connector/_sync_job { "id": "connector-id", "job_type": "full", "trigger_method": "on_demand" }
Requestedit
POST _connector/_sync_job
Prerequisitesedit
- To sync data using connectors, it’s essential to have the Elastic connectors service running.
-
The
id
parameter should reference an existing connector.
Descriptionedit
Creates a connector sync job document in the internal index and initializes its counters and timestamps with default values. Certain values can be updated via the API.
Request bodyedit
-
id
- (Required, string) The id of the connector to create the sync job for.
-
job_type
-
(Optional, string) The job type of the created sync job. Defaults to
full
. -
trigger_method
-
(Optional, string) The trigger method of the created sync job. Defaults to
on_demand
.
Response bodyedit
-
id
- (string) The ID associated with the connector sync job document.
Response codesedit
-
201
- Indicates that the connector sync job was created successfully.
-
400
- Indicates that the request was malformed.
-
404
- Indicates that either the index or the referenced connector is missing.