This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Check in connector API Update connector last sync stats API »
Elastic Docs ›Elasticsearch Guide [master] ›REST APIs ›Connector APIs

Update connector error API

edit

Update connector 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.

Updates the error field of a connector.

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

Request

edit

PUT _connector/<connector_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_id parameter should reference an existing connector.

Description

edit

Sets the error field for the specified 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

edit
<connector_id>
(Required, string)

Request body

edit
error
(Required, string) A messaged related to the last error encountered by the connector.

Response codes

edit
200
Connector error field was successfully updated.
400
The connector_id was not provided or the request payload was malformed.
404 (Missing resources)
No connector matching connector_id could be found.

Examples

edit

The following example updates the error field for the connector with ID my-connector:

resp = client.connector.update_error(
    connector_id="my-connector",
    error="Houston, we have a problem!",
)
print(resp)
response = client.connector.update_error(
  connector_id: 'my-connector',
  body: {
    error: 'Houston, we have a problem!'
  }
)
puts response
const response = await client.connector.updateError({
  connector_id: "my-connector",
  error: "Houston, we have a problem!",
});
console.log(response);
PUT _connector/my-connector/_error
{
    "error": "Houston, we have a problem!"
}
{
    "result": "updated"
}
« Check in connector API Update connector last sync stats API »