You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
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.
Requestedit
PUT _connector/<connector_id>/_name
Prerequisitesedit
- 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 parametersedit
-
<connector_id>
- (Required, string)
Request bodyedit
-
name
- (Required, string) Name of the connector.
-
description
- (Optional, string) Description of the connector.
Response codesedit
-
200
-
Connector
name
anddescription
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.
Examplesedit
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" }