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.

« Clusters - Kibana - CRUD - Configuration Get cluster metadata »

› › › ›

Set cluster name

edit

Set cluster name

edit

DEPRECATED (Scheduled to be removed in the next major version): 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 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

edit

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

« Clusters - Kibana - CRUD - Configuration Get cluster metadata »