elasticsearch/docs/reference/connector/apis/update-connector-error-api.asciidoc

[[update-connector-error-api]]
=== Update connector error API
++++
<titleabbrev>Update connector error</titleabbrev>
++++

preview::[]

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs].
--

Updates the `error` field of a connector.

To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[update-connector-error-api-request]]
==== {api-request-title}

`PUT _connector/<connector_id>/_error`

[[update-connector-error-api-prereq]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,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.

[[update-connector-error-api-desc]]
==== {api-description-title}

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`.

[[update-connector-error-api-path-params]]
==== {api-path-parms-title}

`<connector_id>`::
(Required, string)

[role="child_attributes"]
[[update-connector-error-api-request-body]]
==== {api-request-body-title}

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


[[update-connector-error-api-response-codes]]
==== {api-response-codes-title}

`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.

[[update-connector-error-api-example]]
==== {api-examples-title}

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

////
[source, console]
--------------------------------------------------
PUT _connector/my-connector
{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "service_type": "google_drive"
}
--------------------------------------------------
// TESTSETUP

[source,console]
--------------------------------------------------
DELETE _connector/my-connector
--------------------------------------------------
// TEARDOWN
////

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

[source,console-result]
----
{
    "result": "updated"
}
----