About the Device Resource
Last updated on 24 February, 2021The device resource allows you to programmatically manage your LogicMonitor devices.
As with all of our API calls, authentication is required.
Using LogicMonitor’s REST API you can:
Resource URI
/device/devices
Resource Properties
All devices have the following properties:
Property |
Description |
Type |
| id | The Id of the device | Integer |
| name | The host name or IP address of the device | String |
| displayName | The display name of the device | String |
| deviceType | The type of device: 0 indicates a regular device, 2 indicates an AWS device, 4 indicates an Azure device | Integer |
| relatedDeviceId | The Id of the AWS EC2 instance related to this device, if one exists in the LogicMonitor account. This value defaults to -1, which indicates that there are no related devices. | Integer |
| currentCollectorId | The id of the collector currently monitoring the device and discovering instances | Integer |
| preferredCollectorId | The Id of the preferred collector assigned to monitor the device | Integer |
| preferredCollectorGroupId | The id of the Collector Group associated with the device’s preferred collector | Integer |
| preferredCollectorGroupName | The name of the Collector Group associated with the device’s preferred collector | String |
| description | The device description | String |
| createdOn | The time, in epoch seconds format, that the device was added to your LogicMonitor account | Long |
| updatedOn | The time, in epoch seconds format, that the device was last updated | Integer |
| disableAlerting | Indicates whether alerting is disabled (true) or enabled (false) for this device | Boolean |
| autoPropsAssignedOn | The time, in epoch seconds format, that properties were first discovered for this device | Integer |
| autoPropsUpdatedOn | The time, in epoch seconds, that auto properties last ran and updated the properties table for this device | Integer |
| scanConfigId | The Id of the netscan configuration which was used to discover this device. 0 indicates that the device was not discovered by a scan. | Integer |
| link | The URL link associated with the device | String |
| enableNetflow | Indicates whether Netflow is enabled (true) or disabled (false) for the device | Boolean |
| netflowCollectorId | The Id of the netflow collector associated with the device | Integer |
| netflowCollectorGroupId | The id of the Collector Group associated with the device’s netflow collector | Integer |
| netflowCollectorGroupId | The name of the Collector Group associated with the device’s netflow collector | String |
| lastDataTime | The last time, in epoch seconds, that the device received Netflow data | Integer |
| lastRawdataTime | The last time, in epoch seconds, that raw Netflow data was reported | Integer |
| hostGroupIds | The Id(s) of the groups the device is in, where multiple group ids are comma separated | String |
| sdtStatus | This parameter has three values separated by ‘-‘. The first value indicates whether there is an active SDT for a group the device belongs to, the second value indicates whether there is an active SDT for the device itself, and the third value indicates whether there is an active SDT for a datasource or instance on the device | String |
| userPermission | The read and/or write permissions for this device that are granted to the user who made the API request | String |
| hostStatus | The status of this device, where possible statuses are normal, dead and dead-collector | String |
| alertStatus | Indicates whether or not there is an active alert for this device, and if so what the alert severity (warn | error | critical) and acknowledgement status (confirmed | unconfirmed) are | String |
| alertStatusPriority | A numerical indicator that reflects the display priority of the alert, used to determine the alert icon displayed for a particular item in the device tree | Integer |
| awsState | The AWS instance state (if applicable): 1 indicates that the instance is running, 2 indicates that the instance is stopped and 3 the instance is terminated. | Integer |
| alertDisableStatus | This parameter has three values separated by ‘-‘. The first value indicates whether alerting is disabled for a group the device belongs to, the second value indicates whether alerting is disabled for the device itself, and the third value indicates whether alerting is disabled for a datasource, instance or datapoint for the device | String |
| alertingDisabledOn | Where alerting is disabled, if it is disabled | String |
| collectorDescription | The description/name of the collector for this device | String |
| netflowCollectorDescription | The description/name of the netflow collector for this device | String |
| customProperties | Any non-system properties (aside from system.categories) defined for this device | JSON object |
| upTimeInSeconds | The uptime of the device in seconds. This value will always be the largest value reported by the following datasources:
|
Integer |
| deleteTimeInMS | The time in milliseconds that the device has been dead for, or since the AWS device was filtered out | Integer |
| toDeleteTimeInMS | The number of milliseconds until the device will be automatically deleted from your LogicMonitor account (a value of zero indicates that a future delete time/date has not been scheduled) | Integer |
| hasDisabledSubResource | Indicates whether the device has monitoring disabled for a datasource, instance or datapoint associated with the device | Boolean |
| manualDiscoveryFlags | A read-only field related to monitored processes/services for the device | String |