List connector sync jobs 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.
Returns information about all stored connector sync jobs ordered by their creation date in ascending order.
Requestedit
GET _connector/_sync_job
Prerequisitesedit
- To sync data using connectors, it’s essential to have the Elastic connectors service running.
Path parametersedit
-
size -
(Optional, integer) Maximum number of results to retrieve. Defaults to
100. -
from -
(Optional, integer) The offset from the first result to fetch. Defaults to
0. -
status - (Optional, job status) The job status the fetched sync jobs need to have.
-
connector_id - (Optional, string) The connector id the fetched sync jobs need to have.
-
job_type - (Optional, job type) A comma-separated list of job types.
Examplesedit
The following example lists all connector sync jobs:
response = client.connector_sync_job.list puts response
GET _connector/_sync_job
The following example lists the first two connector sync jobs:
response = client.connector_sync_job.list( from: 0, size: 2 ) puts response
GET _connector/_sync_job?from=0&size=2
The following example lists pending connector sync jobs (the first 100 per default):
response = client.connector_sync_job.list( status: 'pending' ) puts response
GET _connector/_sync_job?status=pending
The following example lists connector sync jobs (the first 100 per default) for the connector with id connector-1:
response = client.connector_sync_job.list( connector_id: 'connector-1' ) puts response
GET _connector/_sync_job?connector_id=connector-1
The following example lists connector sync jobs (the first 100 per default) for the connector with job type full or incremental:
GET _connector/_sync_job?job_type=full,incremental
Response codesedit
200:
Indicates that results were successfully returned (results can also be empty).
400:
Indicates that the request was malformed.