IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Set cluster name
editSet cluster name
editThis endpoint is deprecated and scheduled to be removed in the next major version. Use update deployment instead.
Assigns a name to the APM instance.
Request
editPUT /api/v1/clusters/apm/{cluster_id}/metadata/name/{new_name}
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The APM deployment identifier. |
|
|
Y |
The new name for the cluster. |
Responses
edit-
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 example
editcurl -XPUT https://{{hostname}}/api/v1/clusters/apm/{cluster_id}/metadata/name/{new_name} \ -H "Authorization: ApiKey $ECE_API_KEY"