› › ›

List connector sync jobs API

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 our tutorial.

Request

GET _connector/_sync_job

Prerequisites

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 Elastic managed connectors.

Path parameters

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 job status to filter the results for. 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

The following example lists all connector sync jobs:

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
)
print(resp)

response = client.connector.sync_job_list
puts response

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
});
console.log(response);

GET _connector/_sync_job

The following example lists the first two connector sync jobs:

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "from": "0",
        "size": "2"
    },
)
print(resp)

response = client.connector.sync_job_list(
  from: 0,
  size: 2
)
puts response

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    from: "0",
    size: "2",
  },
});
console.log(response);

GET _connector/_sync_job?from=0&size=2

The following example lists pending connector sync jobs (the first 100 per default):

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "status": "pending"
    },
)
print(resp)

response = client.connector.sync_job_list(
  status: 'pending'
)
puts response

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    status: "pending",
  },
});
console.log(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:

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "connector_id": "connector-1"
    },
)
print(resp)

response = client.connector.sync_job_list(
  connector_id: 'connector-1'
)
puts response

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    connector_id: "connector-1",
  },
});
console.log(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:

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "job_type": "full,incremental"
    },
)
print(resp)

response = client.connector.sync_job_list(
  job_type: 'full,incremental'
)
puts response

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    job_type: "full,incremental",
  },
});
console.log(response);

GET _connector/_sync_job?job_type=full,incremental

Response codes

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

400: Indicates that the request was malformed.

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html