List connector sync jobs APIedit
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features 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.
To get started with Connector APIs, check out the tutorial.
Requestedit
GET _connector/_sync_job
Prerequisitesedit
- To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
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) A comma-separated list of job statuses to filter the results. Available statuses include:
canceling
,canceled
,completed
,error
,in_progress
,pending
,suspended
. -
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. Available job types are:
full
,incremental
andaccess_control
.
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.