Set cluster name

edit

Assigns a name to the Kibana instance.

Request

edit

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

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The Kibana deployment identifier.

new_name

string

Y

The new name for the cluster.

Responses

edit
200

(EmptyResponse) The Kibana deployment name successfully changed.

404

(BasicFailedReply) The {cluster_id} can't be found. (code: 'clusters.cluster_not_found')

449

(BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XPUT {{hostname}}/api/v1/clusters/kibana/{cluster_id}/metadata/name/{new_name} \
-u $CLOUD_USER:$CLOUD_KEY