Update the connector name and description Beta; Added in 8.12.0

PUT /_connector/{connector_id}/_name
Api key auth Basic auth Bearer auth

Path parameters

  • connector_id string Required

    The unique identifier of the connector to be updated

application/json

Body Required

  • name string
  • description string

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • result string Required

      Values are created, updated, deleted, not_found, or noop.
PUT /_connector/{connector_id}/_name 
PUT _connector/my-connector/_name { "name": "Custom connector", "description": "This is my customized connector" }
resp = client.connector.update_name( connector_id="my-connector", name="Custom connector", description="This is my customized connector", )
const response = await client.connector.updateName({ connector_id: "my-connector", name: "Custom connector", description: "This is my customized connector", });
response = client.connector.update_name( connector_id: "my-connector", body: { "name": "Custom connector", "description": "This is my customized connector" } )
$resp = $client->connector()->updateName([ "connector_id" => "my-connector", "body" => [ "name" => "Custom connector", "description" => "This is my customized connector", ], ]);
curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"name":"Custom connector","description":"This is my customized connector"}' "$ELASTICSEARCH_URL/_connector/my-connector/_name"
Request example 
{ "name": "Custom connector", "description": "This is my customized connector" }
Response examples (200) 
{ "result": "updated" }