Set cluster name

DEPRECATED (Scheduled to be removed in the next major version): Assigns a name to the Kibana instance.

Request

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

Path parameters

Name Type Required Description

cluster_id

string

Y

The Kibana deployment identifier.

new_name

string

Y

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) 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

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