Set connector sync job error API

edit

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

Sets a connector sync job error.

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

Request

edit

PUT _connector/_sync_job/<connector_sync_job_id>/_error

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.
  • The connector_sync_job_id parameter should reference an existing connector sync job.

Description

edit

Sets the error field for the specified connector sync job and sets its status to error.

Path parameters

edit
<connector_sync_job_id>
(Required, string)

Request body

edit
error
(Required, string) The error to set the connector sync job error field to.

Response codes

edit
200
Indicates that the connector sync job error was set successfully.
404
No connector sync job matching connector_sync_job_id could be found.

Examples

edit

The following example sets the error some-error in the connector sync job my-connector-sync-job:

resp = client.perform_request(
    "PUT",
    "/_connector/_sync_job/my-connector-sync-job/_error",
    headers={"Content-Type": "application/json"},
    body={
        "error": "some-error"
    },
)
print(resp)
response = client.connector.sync_job_error(
  connector_sync_job_id: 'my-connector-sync-job',
  body: {
    error: 'some-error'
  }
)
puts response
const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/_sync_job/my-connector-sync-job/_error",
  body: {
    error: "some-error",
  },
});
console.log(response);
PUT _connector/_sync_job/my-connector-sync-job/_error
{
    "error": "some-error"
}