A newer version is available. For the latest information, see the
current release documentation.
Set cluster nameedit
DEPRECATED (Scheduled to be removed in the next major version): Assigns a name to the APM instance.
Requestedit
PUT /api/v1/clusters/apm/{cluster_id}/metadata/name/{new_name}
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The APM deployment identifier. |
|
|
Y |
The new name for the cluster. |
Responsesedit
-
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 exampleedit
curl -XPUT https://{{hostname}}/api/v1/clusters/apm/{cluster_id}/metadata/name/{new_name} \
-H "Authorization: ApiKey $ECE_API_KEY"