Update the connector name and description

PUT /_connector/{connector_id}/_name

Api key auth

Path Parameters

connector_id string Id required: The unique identifier of the connector to be updated

Request

Response

application/json

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT _connector/my-connector/_name
{
    "name": "Custom connector",
    "description": "This is my customized connector"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.updateName({
  connector_id: "my-connector",
  name: "Custom connector",
  description: "This is my customized connector",
});

Python Elasticsearch Python Client

resp = client.connector.update_name(
    connector_id="my-connector",
    name="Custom connector",
    description="This is my customized connector",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_connector/my-connector/_name" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Custom connector",
    "description": "This is my customized connector"
  }'

Java Elasticsearch Java Client

client.connector().updateName(u -> u
    .connectorId("my-connector")
    .description("This is my customized connector")
    .name("Custom connector")
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->updateName([
    "connector_id" => "my-connector",
    "body" => [
        "name" => "Custom connector",
        "description" => "This is my customized connector",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.connector.update_name(
  connector_id: "my-connector",
  body: {
    "name": "Custom connector",
    "description": "This is my customized connector"
  }
)

Response

{
  "result": "updated"
}

Path Parameters

Request { name , description , }

Response

Request