Set cluster name

Sets the name of an Elasticsearch cluster.

Request

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

Path Parameters

cluster_id (required)
(string) Identifier for the Elasticsearch cluster
new_name (required)
(string) The new name for the cluster

Responses

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) When running as an administrator (other than root), sudo is required (code: 'root.needs_sudo')