Update the connector error field

PUT /_connector/{connector_id}/_error

Auth

Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected.

Path parameters

connector_id string required: The unique identifier of the connector to be updated

Request body

error union string required nullable

Response

application/json

result enum required: Values: created updated deleted not_found noop

View as Markdown

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT _connector/my-connector/_error
{
    "error": "Houston, we have a problem!"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.updateError({
  connector_id: "my-connector",
  error: "Houston, we have a problem!",
});

Python Elasticsearch Python Client

resp = client.connector.update_error(
    connector_id="my-connector",
    error="Houston, we have a problem!",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_connector/my-connector/_error" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "error": "Houston, we have a problem!"
  }'

Java Elasticsearch Java Client

client.connector().updateError(u -> u
    .connectorId("my-connector")
    .error("Houston, we have a problem!")
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->updateError([
    "connector_id" => "my-connector",
    "body" => [
        "error" => "Houston, we have a problem!",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.connector.update_error(
  connector_id: "my-connector",
  body: {
    "error": "Houston, we have a problem!"
  }
)

Response

{
  "result": "updated"
}

Path parameters

Request body { }

Response

Request body