IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get connector sync job 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.

Retrieves the details about a connector sync job.

Request

edit

GET _connector/_sync_job/<connector_sync_job_id>

Prerequisites

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

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:

response = client.connector_sync_job.get(
  connector_sync_job_id: 'my-connector-sync-job'
)
puts response
GET _connector/_sync_job/my-connector-sync-job