Update connector name and description APIedit

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 name and description fields of a connector.


PUT _connector/<connector_id>/_name


  • To sync data using connectors, it’s essential to have the Elastic connectors service running.
  • The connector_id parameter should reference an existing connector.

Path parametersedit

(Required, string)

Request bodyedit

(Required, string) Name of the connector.
(Optional, string) Description of the connector.

Response codesedit

Connector name and description fields were successfully updated.
The connector_id was not provided or the request payload was malformed.
404 (Missing resources)
No connector matching connector_id could be found.


The following example updates the name and description fields for the connector with ID my-connector:

response = client.connector.update_name(
  connector_id: 'my-connector',
  body: {
    name: 'Custom connector',
    description: 'This is my customized connector'
puts response
PUT _connector/my-connector/_name
    "name": "Custom connector",
    "description": "This is my customized connector"
    "result": "updated"