List Interfaces
Lists all the interfaces monitored in OpManager
HTTP Method
GETAPI URL
https://localhost:8060/api/json/device/listInterfaces?apiKey=***************&isFluidic=true&rows=100&page=1&sortByColumn=statusNum&sortByType=descParameters
| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |
| filters | custom conditions to filter interface results | JSONObject | ** groupOp - String - Allowed values: AND ** rules - JSONArray - -->field - String - Allowed values: interfaceDisplayName, displayName, adminStatus, operStatus, ipAddress, type, statusNum, isSuppressed, probeName, UDF followed by one or more digits (e.g., UDF1, UDF12) -->op - String - Allowed values: cn, eq -->data - String - No regex | No |
| page | To fetch interface list in batches. This should be combinedly used with 'rows' parameter [Example: page=1, rows=200, page=2, rows=200] | Integer | Allowed values: 1-5000 | No |
| sortByType | Defining ascending or descending sort of interfaces list [Example, sortByType=asc Or sortByType=desc] | String | Allowed values: asc, desc | No |
| sortByColumn | Sorting interfaces list with columns [Example: inSpeed, displayName, ipaddress, outSpeed, statusNum, severity - 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)] | String | Allowed values: statusNum, interfaceDisplayName, displayName, adminStatus, operStatus, ipAddress, type, inSpeed, outSpeed, inTraffic, outTraffic, isSuppressed, probeName, UDF followed by one or more digits (e.g., UDF1, UDF12) | No |
| rows | To fetch interface list in batches. This should be combinedly used with 'page' parameter [Example: page=1, rows=200, page=2, rows=200] | Integer | Allowed values: 1-20000 | Yes |
| _search | indicates if the request is a search query | Boolean | - | No |
| nd | request timestamp | Long | - | No |
| isFluidic | Set value as 'true' by default (for internal purpose) | Boolean | - | No |
| classification | Classification of Device | String | Allowed values: Network, Router, Switch, Printer, Server, PhysicalServer, Windows, Linux, MSSQL, Exchange, DomainController, Wireless, Firewall, IPMI, MonitoringAgent | No |
| severity | Filter interfaces with severity. [Example: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)] | String | Allowed values: 1–11, comma(,) | No |
| type | Filter interface with interface type. [Example: Ethernet,Software Loopback, etc] | 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(=), ampersand(&), single quote('), all non-Basic Latin characters | No |
| isIdleInterface | filters only idle or inactive interfaces | Boolean | - | No |
| intfProps | To fetch additional interface properties such as ifName (Interface ifName), moid (internal managed object identifier used for interface/device), physAddress | Boolean | - | No |
| intfGroupID | filters interfaces belonging to a specific interface group | Long | - | No |
| customFields | filter by custom fields | String | Allowed characters: A–Z, a–z, all Unicode letters, 0–9, space( ), dot(.), exclamation(!), colon(:), at(@), hyphen(-), underscore(_), backslash(\), slash(/), single quote('), comma(,) | No |
| isAPlus | flag related to advanced interface monitoring | Boolean | - | No |
Sample Response
HTTP Code: 200
{ "total": "0", "records": "0", "page": "1", "rows": [ { "interfaceDisplayName": "Switch loopback interface-lo0", "isSuppressed": false, "statusStr": "Trouble", "adminStatusImg": "
", "displayName": "10.5.5.1", "operStatusImg": "", "ipAddress": "", "outSpeed": "0 bps", "inSpeed": "0 bps", "type": "Software Loopback", "deviceName": "10.5.5.1", "interfaceStatus": 2, "outTraffic": "72.513 M (0.0%)", "statusNum": 2, "suppressedMessage": "", "inTraffic": "67.446 M (0.0%)", "adminStatus": "Up", "operStatus": "Up", "id": "494", "interfaceName": "IF-10.5.5.1-494", "iconPath": "images/intfTypes/anonIfType.gif"}, { "interfaceDisplayName": "VLAN3853-NWT-MGMT", "isSuppressed": false, "statusStr": "Trouble", "adminStatusImg": "", "displayName": "10.5.5.1", "operStatusImg": "", "ipAddress": "10.5.5.12", "outSpeed": "0 bps", "inSpeed": "0 bps", "type": "Proprietary Virtual", "deviceName": "10.5.5.1", "interfaceStatus": 2, "outTraffic": "93.811 M (0.0%)", "statusNum": 2, "suppressedMessage": "", "inTraffic": "69.148 M (0.0%)", "adminStatus": "Up", "operStatus": "Up", "id": "493", "interfaceName": "IF-10.5.5.1-493", "iconPath": "images/intfTypes/anonIfType.gif"} ]}Error Response
View common error responsesRate limit: 500 requests per minute. Exceeding this limit will block requests for 1 minute