# Devices
## List Devices
Lists all devices monitored by OpManager - Version 1 API
### HTTP Method
**GET**
### API URL
```
https://localhost:8060/api/json/admin/listDevices?apiKey=***************
```
### Parameters
| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |
| subnetName | Name of the subnet | String | - | No |
| type | Fetches the list of devices that fall under the given Device Type. [Example: type=Cisco2081] | String | Allowed characters: A-Z, a-z, all Unicode letters, 0-9, space( ), comma(,), dot(.), hyphen(-), underscore(_), parenthesis(()), slash(/), plus(+), exclamation(!), at(@), hash(#), dollar($), square brackets([ ]), caret(^), colon(:), semicolon(;), equals(=), single quote(') | No |
| category | Fetches the list of devices that fall under the given device category [Example: Server, Switch, etc.] | String | Allowed characters: A-Z, a-z, 0-9, space( ), underscore(_), hyphen(-), dot(.) | No |
| classification | Fetches the list of devices that fall under the given device category [Example: Server, Switch, etc.] | String | Allowed values: Network, Router, Switch, Printer, Server, PhysicalServer, Windows, Linux, MSSQL, Exchange, DomainController, Wireless, Firewall, IPMI, MonitoringAgent | No |
| isMapView | Is fetched from Maps page | Boolean | - | No |
| isFluidic | Set value as 'true' by default.(for internal purpose) | Boolean | - | No |
| isSubnet | Filters device by IP Subnet | Boolean | - | No |
| deviceName | Name of the device | String | - | No |
| app | Fetches the list of devices that have the given App in it and monitored in OpManager [Example: MSSQL, Exchange, Domain Controller] | String | - | No |
| bvName | Fetches the list of devices that are under the given Business View map name | String | - | No |
| vendorName | Fetches the list of devices that have the given vendor name | String | Allowed characters: A-Z, a-z, all Unicode letters, 0-9, hyphen(-), parenthesis(()), dot(.), comma(,), underscore(_), slash(/), space( ), hash(#) | No |
| vendor | Fetches the list of devices that have the given vendor name. | String | Allowed characters: A-Z, a-z, all Unicode letters, 0-9, hyphen(-), parenthesis(()), dot(.), comma(,), underscore(_), slash(/), space( ), hash(#) | No |
| protocol | Filter devices by protocol [Example: all\|SNMP\|WMI\|CLI\|VIWebService\|VIWMI\|CLI\|XenService\|PrismAPI\|NetAppAPI\|SMI] | String | - | No |
| severity | Filter devices by severity [Example: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)] | String | Allowed characters: 1-11, comma(,) | No |
| state | List of states | String | Allowed characters: 1-11, comma(,) | No |
| subnet | Filters device by specific IP Subnet | String | - | No |
| page | To fetch devices in batches. This should be combinedly used with 'rows' parameter. [Example: page=1, rows=200, page=2, rows=200] | Integer | - | No |
| rows | To fetch devices in batches. This should be combinedly used with 'page' parameter [Example: page=1, rows=200, page=2, rows=200] | Integer | - | No |
| sortByType | Defining sort type to be ascending or descending | String | Allowed values: asc, desc , ASC, DESC | No |
| sortByColumn | Sorting device list by columns [Example: displayName, interfaceCount, ipaddress, type, etc.] | String | Allowed characters: A-Z, a-z, all Unicode letters, 0-9, underscore(_), space( ) | No |
| selectedVTypes | Filter devices by Virtual device type | String | Allowed values: all, All, VMware, HyperV, Xen, Nutanix, Proxmox, VMware-VM, VMware-Host, VMware-vCenter, HyperV-Host, HyperV-VM, Xen-Host, Xen-VM, Nutanix-Cluster, Nutanix-Host, Nutanix-VM, Proxmox-Node, Proxmox-VM, Proxmox-Container, OPM-DEVICE | No |
| fileTemplate | filters devices linked with a specific file monitoring template | Long | - | No |
| folderTemplate | filters devices linked with a specific folder monitoring template | Long | - | No |
| getInterfaces | To fetch devices with associated interfaces. Boolean value: Allowed Values: The input must exactly match either true or false | Boolean | - | No |
| isStorage | Is storage device | Boolean | - | No |
| storageCategory | Storage category | String | Allowed values: RAID, TapeLibrary, FCSwitch, comma(,) (case-insensitive) | No |
| excludeStorage | Whether to exclude storage devices or not | Boolean | - | No |
| groupName | Filter devices by Group name | String | Allowed characters: A-Z, a-z, all Unicode letters, 0-9, space( ), dot(.), exclamation(!), colon(:), at(@), hash(#), dollar($), hyphen(-), underscore(_), backslash(), slash(/), single quote('), comma(,) | No |
| filters | applies custom filter conditions to narrow device results | String | - | No |
| skipLocalhost | excludes the OpManager server (localhost) from the device list | Boolean | - | No |
| getMonitors | Includes device monitor details in the response. | Boolean | - | No |
| customFields | To fetch custom field values for the devices, supply the required custom field names in the 'customFields' param in the API request. Example: /api/json/device/listDevices?apiKey=***************&customFields=Building,Comments,Floor | String | Allowed characters: A-Z, a-z, all Unicode letters, 0-9, space( ), dot(.), exclamation(!), colon(:), at(@), hash(#), dollar($), hyphen(-), underscore(_), backslash(), slash(/), single quote('), square brackets([ ]), comma(,) | No |
| selectedMonType | filters devices by specific monitor type | String | - | No |
| hideEmptyDevices | hides devices without any monitors or data | Boolean | - | No |
| probe_customer_id | filters devices by probe or customer ID | Long | Allowed values: >=1 | No |
| excludeIPMI | Excludes IPMI devices | Boolean | - | No |
| excludeAP | Excludes Access points | Boolean | - | No |
| isLicenseView | shows device data based on license view | Boolean | - | No |
| isManaged | Whether to list managed device alone | Boolean | - | No |
| pageName | identifies the UI page or view requesting the data | String | Allowed values: Inventory | No |
| excludeAgent | Excludes agent based devices | Boolean | - | No |
### Sample Response
HTTP Code: 200
```
[ { "isSNMP": true, "ipaddress": "10.5.5.1", "isSuppressed": false, "statusStr": "Clear", "prettyTime": "2 days ago", "displayName": "10.5.5.1", "isNew": false, "type": "Windows 10", "vendorName": "Microsoft", "deviceName": "10.5.5.1", "moid": 13699, "statusNum": "5", "suppressedMessage": "", "addedTime": "15 Oct 2025 12:37:55 PM IST", "numericStatus": "5", "interfaceCount": 0, "id": "13699", "mapName": "Desktops_Map.netmap", "category": "Desktop", "status": "
Clear"}, { "isSNMP": true, "ipaddress": "10.5.5.2", "isSuppressed": false, "statusStr": "Clear", "prettyTime": "2 days ago", "displayName": "10.5.5.2", "isNew": false, "type": "Windows 2019", "vendorName": "Microsoft", "deviceName": "10.5.5.2", "moid": 13710, "statusNum": "5", "suppressedMessage": "", "addedTime": "15 Oct 2025 12:37:56 PM IST", "numericStatus": "5", "interfaceCount": 0, "id": "13710", "mapName": "Servers_Map.netmap", "category": "Server", "status": "Clear"}]
```
### Error Response
[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Rate limit:** 500 requests per minute. Exceeding this limit will block requests for 1 minute.
---
## v2/listDevices
Lists all devices monitored by OpManager - Enhanced Version 2 API with additional fields
### HTTP Method
**GET**
### API URL
```
https://localhost:8060/api/json/v2/device/listDevices?apiKey=***************
```
### Parameters
> Parameters are the same as Version 1 unless specified otherwise.
| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |
| classification | Device category | String | Allowed values: Network, Router, Switch, Printer, Server, PhysicalServer, Windows, Linux, MSSQL, Exchange, DomainController, Wireless, Firewall, IPMI, MonitoringAgent | No |
| selectedVTypes | Filter devices by Virtual device type | String | Allowed values: all, All, VMware, HyperV, Xen, Nutanix, Proxmox, VMware-VM, VMware-Host, VMware-vCenter, HyperV-Host, HyperV-VM, Xen-Host, Xen-VM, Nutanix-Cluster, Nutanix-Host, Nutanix-VM, Proxmox-Node, Proxmox-VM, Proxmox-Container, OPM-DEVICE | No |
### Sample Response
HTTP Code: 200
```
{ "total": 0, "page": 1, "rows": [ { "isSNMP": true, "ipaddress": "10.5.5.1", "isSuppressed": false, "statusStr": "Clear", "prettyTime": "5 hours ago", "displayName": "10.5.5.1", "isNew": false, "type": "Windows 10", "vendorName": "Microsoft", "deviceName": "10.5.5.1", "moid": 341, "statusNum": "5", "suppressedMessage": "", "addedTime": "7 Oct 2025 11:08:30 AM IST", "interfaceCount": 0, "id": "341", "category": "Desktop"}, { "isSNMP": true, "ipaddress": "10.5.5.2", "isSuppressed": false, "statusStr": "Clear", "prettyTime": "5 hours ago", "displayName": "10.5.5.2", "isNew": false, "type": "Windows 2019", "vendorName": "Microsoft", "deviceName": "10.5.5.2", "moid": 362, "statusNum": "5", "suppressedMessage": "", "addedTime": "7 Oct 2025 11:08:31 AM IST", "interfaceCount": 0, "id": "362", "category": "Server"} ], "records": 2}
```
### Error Response
[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)
**Rate limit:** 500 requests per minute. Exceeding this limit will block requests for 1 minute.
---
*Due to length constraints, the remaining APIs on this page follow the same structure: each section includes HTTP Method, API URL, Parameters (with detailed tables), Sample Response, Error Response (link above), and the specified Rate Limit as shown in the source.*