Sign in

v2

latestOpenAPI 3.1.0CC-BY-SA 2.02026-07-2617789528.6 KB
Groups

Update group category details

Update detailed information about a group category

post/groups/categories/{groupCategoryId}

Path parameters

groupCategoryIdstring uuid required

Group category id

Example:e0a311fa-f7b2-4f9e-89a9-db517b9c6b90

Request body

parentstring uuid required

The parent category of the groups

namestring required

Name of the group category

descriptionstring

Group category description

Example request

{
  "parent": "b9f6d98a-28bc-4d80-90f7-d2f14269e215",
  "name": "Hardware groups",
  "description": "Nodes by hardware provider"
}

Response

Groups category information

result'success' | 'error' required

Result of the request

action'UpdateGroupCategory' required

The id of the action

Example response

{
  "data": {
    "groupCategories": [
      {
        "parent": "b9f6d98a-28bc-4d80-90f7-d2f14269e215",
        "id": "32d013f7-b6d8-46c8-99d3-016307fa66c0",
        "name": "Hardware groups",
        "description": "Nodes by hardware provider"
      }
    ]
  }
}