A newer version is available. For the latest information, see the
current release documentation.
Set cluster nameedit
This endpoint is deprecated and scheduled to be removed in the next major version. Use update deployment instead.
Assigns a name to the Kibana instance.
Requestedit
PUT /api/v1/clusters/kibana/{cluster_id}/metadata/name/{new_name}
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Kibana deployment identifier. |
|
|
Y |
The new name for the cluster. |
Responsesedit
-
200 -
The cluster name was successfully changed
-
404 -
The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
-
449 -
Elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')
Request exampleedit
curl -XPUT https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/metadata/name/{new_name} \
-H "Authorization: ApiKey $ECE_API_KEY"