You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Get connector sync job 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.
Retrieves the details about a connector sync job.
Requestedit
GET _connector/_sync_job/<connector_sync_job_id>
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
-
<connector_sync_job_id> - (Required, string)
Response codesedit
-
400 -
The
connector_sync_job_idwas not provided. -
404(Missing resources) -
No connector sync job matching
connector_sync_job_idcould be found.
Examplesedit
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