PUT /api/management/groupname

Description

Update the in-memory name of the group that the API Server or Node Manager is running in. This is the name used to identify the group within the domain topology.

This method is called internally from the Node Manager's Topology API when a user updates a group name. This method should not normally be invoked any other way. This method will only update the in-memory group name of the API Server or Node Manager. For the update to be persisted into the topology, it must be done via the Topology API method PUT /api/topology/groups.

The Management API resides in the API Servers, therefore this method must be invoked via the Routing API in the Admin Node Manager, e.g. https://localhost:8090/api/router/service/instance-1/api/management/groupname.

---

Resource URL

https://localhost:8090/api/management/groupname?name={groupname}
https://localhost:8090/api/router/service/{serviceID}/api/management/groupname?name={groupname}

---

Parameters

name

mandatory

The new group name.

---

Response Codes

Response Code	Description
200	Success. The response body contains a group name.

---

Example Request and Response

PUT https://localhost:8090/api/router/service/instance-1/api/management/groupname?name=Group1

HTTP 1.1 200 OK

{
    "result": "Group1"
}