Set a connector sync job error

PUT /_connector/_sync_job/{connector_sync_job_id}/_error

Auth

Set the error field for a connector sync job and set its status to error.

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.

Path parameters

connector_sync_job_id string required: The unique identifier for the connector sync job.

Request body

error string required: The error for the connector sync job error field.

Response

application/json

Response Type: object

View as Markdown

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT _connector/_sync_job/my-connector-sync-job/_error
{
    "error": "some-error"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.syncJobError({
  connector_sync_job_id: "my-connector-sync-job",
  error: "some-error",
});

Python Elasticsearch Python Client

resp = client.connector.sync_job_error(
    connector_sync_job_id="my-connector-sync-job",
    error="some-error",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_connector/_sync_job/my-connector-sync-job/_error" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "error": "some-error"
  }'

Java Elasticsearch Java Client

client.connector().syncJobError(s -> s
    .connectorSyncJobId("my-connector-sync-job")
    .error("some-error")
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->syncJobError([
    "connector_sync_job_id" => "my-connector-sync-job",
    "body" => [
        "error" => "some-error",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.connector.sync_job_error(
  connector_sync_job_id: "my-connector-sync-job",
  body: {
    "error": "some-error"
  }
)

Response

{}

Generated from the API spec

Path parameters

Request body { }

Response

Request body