Groups

Update an existing group attributes, including changing its parent group.

Changed on
patch/groups/{groupPath}

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

applyProfilestring

Optionally apply a profile to the device to update unset attributes with attributes from the profile.

Request body

category'group' | 'device'

Category of entity.

groupPathstring required

Path of the group.

templateIdstring required

Template of group. Use 'Group' if no custom attributes are required.

namestring

name of group.

parentPathstring

Path of the groups parent.

descriptionstring

Description of the group.

attributesobject
relationstring

Name of relation to this group (readonly, populated when displaying related groups only)

direction'in' | 'out'

Direction of relation (readonly, populated when displaying related groups only)

groupsobject

Paths of the groups that this Group is associated with.

Response

successful operation

Changes