IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Add or remove settings from the cluster keystore Get cluster metadata »

› › › ›

Set cluster name

edit

Set cluster name

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use update deployment instead.

Assigns a name to the Elasticsearch cluster.

Request

edit

PUT /api/v1/clusters/elasticsearch/{cluster_id}/metadata/name/{new_name}

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	Elasticsearch cluster identifier
`new_name`	`string`	Y	The new name for the cluster.

Responses

edit

200

(EmptyResponse)

The cluster name was successfully changed

404

(BasicFailedReply)

The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')

449

(BasicFailedReply)

Elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')

Request example

edit

curl -XPUT https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/metadata/name/{new_name} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Add or remove settings from the cluster keystore Get cluster metadata »