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 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.
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_id
was not provided. -
404
(Missing resources) -
No connector sync job matching
connector_sync_job_id
could 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