Set a connector sync job error Technical preview

PUT /_connector/_sync_job/{connector_sync_job_id}/_error
Api key auth Basic auth Bearer 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.

application/json

Body Required

  • error string Required

    The error for the connector sync job error field.

Responses

  • 200 application/json
PUT /_connector/_sync_job/{connector_sync_job_id}/_error 
PUT _connector/_sync_job/my-connector-sync-job/_error { "error": "some-error" }
resp = client.connector.sync_job_error( connector_sync_job_id="my-connector-sync-job", error="some-error", )
const response = await client.connector.syncJobError({ connector_sync_job_id: "my-connector-sync-job", error: "some-error", });
response = client.connector.sync_job_error( connector_sync_job_id: "my-connector-sync-job", body: { "error": "some-error" } )
$resp = $client->connector()->syncJobError([ "connector_sync_job_id" => "my-connector-sync-job", "body" => [ "error" => "some-error", ], ]);
curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"error":"some-error"}' "$ELASTICSEARCH_URL/_connector/_sync_job/my-connector-sync-job/_error"
client.connector().syncJobError(s -> s .connectorSyncJobId("my-connector-sync-job") .error("some-error") );
Request example 
{ "error": "some-error" }