It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Set cluster name
editSet cluster name
editAssigns a name to the Elasticsearch cluster.
Request
editPUT /api/v1/clusters/elasticsearch/{cluster_id}/metadata/name/{new_name}
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Elasticsearch cluster identifier |
|
|
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"')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XPUT {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/metadata/name/{new_name} \
-H "Authorization: ApiKey $ECE_API_KEY"