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 name and description API
editUpdate connector name and description 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 name
and description
fields of a connector.
Request
editPUT _connector/<connector_id>/_name
Prerequisites
edit- 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 parameters
edit-
<connector_id>
- (Required, string)
Request body
edit-
name
- (Required, string) Name of the connector.
-
description
- (Optional, string) Description of the connector.
Response codes
edit-
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.
Examples
editThe 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" }