IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« List connectors API Set connector sync job error API »

› › ›

List connector sync jobs API

edit

List connector sync jobs API

edit

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.

Request

edit

GET _connector/_sync_job

Prerequisites

edit

To sync data using connectors, it’s essential to have the Elastic connectors service running.

Path parameters

edit

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 and access_control.

Examples

edit

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 codes

edit

200: Indicates that results were successfully returned (results can also be empty).

400: Indicates that the request was malformed.

« List connectors API Set connector sync job error API »