Update the connector error field

PUT /_connector/{connector_id}/_error

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.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Request body

Response

application/json

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"
}

Authentication

Path parameters

Request body { }

Response

Request body