Sign in

v2

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

Update group details

Update detailed information about a group

post/groups/{groupId}

Path parameters

groupIdstring uuid required
Example:9a1773c9-0889-40b6-be89-f6504443ac1b

Id of the group

Request body

categorystring uuid

Id of the new group's category

displayNamestring

Name of the group

descriptionstring

Group description

dynamicboolean

Should the group be dynamically refreshed (if not, it is a static group)

enabledboolean

Enable or disable the group

Example request

{
  "category": "e17ecf6a-a9f2-44de-a97c-116d24d30ff4",
  "displayName": "Ubuntu 18.04 nodes",
  "description": "Documentation for the group",
  "query": {
    "composition": "and",
    "where": [
      {
        "objectType": "node",
        "attribute": "OS",
        "comparator": "eq",
        "value": "Linux"
      }
    ]
  }
}

Response

Groups information

result'success' | 'error' required

Result of the request

action'updateGroup' required

The id of the action

Example response

{
  "data": {
    "groups": [
      {
        "id": "32d013f7-b6d8-46c8-99d3-016307fa66c0",
        "displayName": "Ubuntu 18.04 nodes",
        "description": "Documentation for the group",
        "query": {
          "composition": "and",
          "where": [
            {
              "objectType": "node",
              "attribute": "OS",
              "comparator": "eq",
              "value": "Linux"
            }
          ]
        },
        "nodeIds": [
          "109142a2-40eb-4e6d-84b4-7ebe3670474c"
        ],
        "groupClass": [
          "group_ubuntu"
        ],
        "properties": [
          {
            "name": "os",
            "value": "debian10"
          }
        ]
      }
    ]
  }
}