v1/groups
Use the v1/groups API to create, update, list, or remove groups.
URI
http://<hostname>/ws/v1/groups
Formats
| HTTP method | Format | Description | Parameters |
|---|---|---|---|
| GET | /ws/v1/groups | Get summary of the groups APIs. | None |
| GET | /ws/v1/groups/inventory | Get a list of groups. | orderby query |
| POST | /ws/v1/groups/inventory/path | Create a new group. | path description |
| PUT | /ws/v1/groups/inventory/path | Change the name of a group. | None |
| DELETE | /ws/v1/groups/inventory/path | Remove one or more groups and subgroubs. | move_devices remove_subgroups |
Parameters
path
Full path for the group, including the group name.
description
Text description of the group.
move_devices
Specify whether to remove devices in the group being deleted. If you do not remove devices, any existing devices within the removed group are moved to the root group. If you delete devices, devices in removed groups are removed from your device inventory. The default is no.Text description of the group.