v2

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

Groups

Create a group category

Create a new group category

put/groups/categories

Request body

parentstring uuid required

The parent category of the groups

idstring uuid

Group category id, only provide it when needed.

namestring required

Name of the group category

descriptionstring

Group category description

Example request

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

Response

Groups category information

result'success' | 'error' required

Result of the request

action'CreateGroupCategory' 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"
      }
    ]
  }
}