About the Device Group Resource
Last updated - 23 July, 2025
The device group resource allows you to programmatically manage your LogicMonitor device groups.
Using LogicMonitor’s REST API you can:
Resource URI:
/device/groups
Resource Properties
All device groups have the following properties:
Property | Description | Type |
| id | The id of the device group | Integer |
| parentId | The id of the parent group for this device group (the root device group has an Id of 1) | Integer |
| name | The name of the device group | String |
| description | The description of the device group | String |
| groupType | The type of device group: normal and dynamic device groups will have groupType=Normal, and AWS groups will have a groupType value of AWS/SERVICE (e.g. AWS/S3) | Integer |
| awsRegionsInfo | The number of instances in each AWS region (only applies to AWS groups) | JSON Object |
| awsTestResult | The String result returned by the transaction that tests the AWS credentials associated with the AWS group | String |
| awsTestResultCode | The Status code result returned by the transaction that tests the AWS credentials associated with the AWS group | Integer |
| createdOn | The time, in epoch seconds format, that the device group was created | Long |
| disableAlerting | Indicates whether alerting is disabled (true) or enabled (false) for this device group | Boolean |
| appliesTo | The Applies to custom query for this group (only for dynamic groups) | String |
| customProperties | The properties associated with this device group | JSON object |
| fullPath | The full path of the device group (i.e. if the group ‘Dev’ is under a parent group named ‘Production’, the fullPath would be ‘Production/Dev’ | String |
| numOfHosts | The number of total devices, including both AWS and normal devices, that belong to this device group (includes normal devices in sub groups) | Integer |
| numOfAWSDevices | The number of AWS devices that belong to this device group (includes AWS devices in sub groups) | Integer |
| numOfDirectDevices | The number of AWS and normal devices that belong only to this device group (doesn’t include devices in sub-groups) | Integer |
| numOfDirectSubGroups | The number of sub-groups that belong only to this device group (doesn’t include groups under sub-groups) | Integer |
| effectiveAlertEnabled | Whether or not alerting is effectively disabled for this device group (alerting may be disabled at a higher level, e.g. parent group) | Integer |
| sdtStatus | This parameter has three values separated by ‘-‘. The first value indicates whether there is an active SDT for a parent device group, the second value indicates whether there is an active SDT for the device group itself, and the third value indicates whether there is an active SDT for a device within the device group | String |
| alertStatus | none | [confirmed | unconfirmed – warn | error | critical] Indicates whether or not there is an active alert for this device group, and if so what the alert severity and acknowledgement status are | String |
| alertStatusPriority | An priority integer associated with the alert, as used to determine how alert icons are rolled up in the device tree | Integer |
| clusterAlertStatus | none | [confirmed | unconfirmed – warn | error | critical] Indicates whether or not there is an active cluster alert for this device group, and if so what the alert severity and acknowledgement status are | String |
| clusterAlertStatusPriority | A priority integer associated with the cluster alert, as used to determine how alert icons are rolled up in the device tree | Integer |
| alertDisableStatus | This parameter has three values separated by ‘-‘. The first value indicates whether alerting is disabled for a parent group, the second value indicates whether alerting is disabled for the device group itself, and the third value indicates whether alerting is disabled for a device within the device group | String |
| groupStatus | normal | dead The status of this device group, where possible statuses are normal and dead. A group with a status of dead may indicate that one or more devices are dead within the group | String |
| userPermission | The permissions for the device group that are granted to the user that made this API request | String |
| subGroups | The child device groups within this device group | JSON Object |
