POST api/topology/groups/{groupID}/lock
Description
Lock a Group for exclusive access by a user. Once locked, only the locking user can deploy configuration to the Group or Server instances under the Group. Equally, only the locking user can modify the Group. Only the original locker can unlock the Group, or another user with sufficient privileges to force an unlock of the Group, usually a user with an Administrator role in their user privileges.
The lock which gets generated has the username and timestamp of when it was created and is a sub-object of the Group.
Resource URL
https://localhost:8090/api/topology/groups/{groupID}/lock
Parameters
groupID | mandatory | The id of the Group to be locked. This is passed in the query string. |
Response Codes
Response Code | Description |
---|---|
200 | Success. The Group is locked, with the current user credentials, or the same user has relocked an already locked Group. No object is returned. |
403 | Forbidden. The Group has already been locked by a different user. |
404 | The Group doesn't exist. |
Example Request and Response
POST https://localhost:8090/api/topology/groups/group-2/lock
HTTP 1.1 200 OK