elasticsearch/docs/reference/connector/apis/update-connector-name-description-api.asciidoc

[[update-connector-name-description-api]]
=== Update connector name and description API
++++
<titleabbrev>Update connector name and description</titleabbrev>
++++

beta::[]

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

Updates the `name` and `description` fields of a connector.

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


[[update-connector-name-description-api-request]]
==== {api-request-title}

`PUT _connector/<connector_id>/_name`

[[update-connector-name-description-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-name-description-api-path-params]]
==== {api-path-parms-title}

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

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

`name`::
(Required, string) Name of the connector.

`description`::
(Optional, string) Description of the connector.


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

`200`::
Connector `name` and `description` fields were 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-name-description-api-example]]
==== {api-examples-title}

The following example updates the `name` and `description` fields 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/_name
{
    "name": "Custom connector",
    "description": "This is my customized connector"
}
----

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