IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Update connector error API
editUpdate connector error API
editThis 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 the tutorial.
Request
editPUT _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 native connectors.
-
The
connector_id
parameter should reference an existing connector.
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
editThe following example updates the error
field for the connector with ID my-connector
:
response = client.connector.update_error( connector_id: 'my-connector', body: { error: 'Houston, we have a problem!' } ) puts response
PUT _connector/my-connector/_error { "error": "Houston, we have a problem!" }
{ "result": "updated" }