This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Delete connector sync job API List connector sync jobs API »

› › ›

Get connector sync job API

edit

Get connector sync job API

edit

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.

Retrieves the details about a connector sync job.

To get started with Connector APIs, check out our tutorial.

Request

edit

GET _connector/_sync_job/<connector_sync_job_id>

Prerequisites

edit

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

edit

<connector_sync_job_id>: (Required, string)

Response codes

edit

400: The connector_sync_job_id was not provided.
404 (Missing resources): No connector sync job matching connector_sync_job_id could be found.

Examples

edit

The following example gets the connector sync job my-connector-sync-job:

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job/my-connector-sync-job",
)
print(resp)

response = client.connector.sync_job_get(
  connector_sync_job_id: 'my-connector-sync-job'
)
puts response

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

GET _connector/_sync_job/my-connector-sync-job

« Delete connector sync job API List connector sync jobs API »