This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Update connector name and description API
editUpdate connector name and description API
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Updates the name
and description
fields of a connector.
To get started with Connector APIs, check out our tutorial.
Request
editPUT _connector/<connector_id>/_name
Prerequisites
edit- 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 Elastic managed connectors.
-
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
:
resp = client.connector.update_name( connector_id="my-connector", name="Custom connector", description="This is my customized connector", ) print(resp)
response = client.connector.update_name( connector_id: 'my-connector', body: { name: 'Custom connector', description: 'This is my customized connector' } ) puts response
const response = await client.connector.updateName({ connector_id: "my-connector", name: "Custom connector", description: "This is my customized connector", }); console.log(response);
PUT _connector/my-connector/_name { "name": "Custom connector", "description": "This is my customized connector" }
{ "result": "updated" }