Set connector sync job error 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.
Sets a connector sync job error.
Requestedit
PUT _connector/_sync_job/<connector_sync_job_id>/_error
Prerequisitesedit
- To sync data using connectors, it’s essential to have the Elastic connectors service running.
-
The
connector_sync_job_idparameter should reference an existing connector sync job.
Descriptionedit
Sets the error field for the specified connector sync job and sets its status to error.
Path parametersedit
-
<connector_sync_job_id> - (Required, string)
Request bodyedit
-
error -
(Required, string) The error to set the connector sync job
errorfield to.
Response codesedit
-
200 - Indicates that the connector sync job error was set successfully.
-
404 -
No connector sync job matching
connector_sync_job_idcould be found.
Examplesedit
The following example sets the error some-error in the connector sync job my-connector-sync-job:
response = client.connector_sync_job.error(
connector_sync_job_id: 'my-connector-sync-job',
body: {
error: 'some-error'
}
)
puts response
PUT _connector/_sync_job/my-connector-sync-job/_error
{
"error": "some-error"
}