v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Devices

Get a device inventory list

This API endpoint retrieves a list of network devices that are present in inventory, such as access points, switches, and gateways. The API includes devices yet to be on-boarded, as well as those already on-boarded and currently being monitored by the system. Each device in the returned list includes details like serial number, device name, part number, deployment, device function, scope ID, device group ID, whether the device is provisioned, etc. The query parameters allow you to narrow down the results to devices that meet specific criteria, ensuring you receive only the relevant data.

get/network-monitoring/v1/device-inventory

Query parameters

filterstring const

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction; ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.

Field	Operators
siteId	eq and in
siteName	eq and in
serialNumber	eq and in
deviceName	eq and in
deviceType	eq and in
model	eq and in
firmwareVersion	eq and in
deviceFunction	eq and in
isProvisioned	eq and in
deviceGroupName	eq and in

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

sortstring const

Example:totalVisitorCount ASC

A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending. Supported fields are siteId, siteName, serialNumber, deviceName, macAddress, deviceType, ipv4, model, deviceGroupName, and deviceFunction.

site-assigned'ASSIGNED' | 'UNASSIGNED'

Specifies the site assignment status of the devices. Can be either "ASSIGNED" or "UNASSIGNED".

limitinteger

Specifies the number of results to be returned

Example:20

Specifies the maximum number of devices returned in the response. Maximum value is 1000.

nextstring

Specifies the pagination cursor for the next page of resources.

Example:1

Specifies the pagination cursor for the next page of resources. The minimum value is 1.

Response

List of network devices, including Access Points, Switches, and Gateways from device inventory, along with their details and associated pagination information.

countinteger required

Number of items in the response.

totalinteger

Specifies the total number of items available for a given filter query.

nextstring int32 required

Indicates the next page number, null if there are no further pages.

Example response

{
  "items": [
    {
      "model": "2930M",
      "serialNumber": "SG7BJQL6PD",
      "deviceType": "SWITCH",
      "role": "Conductor",
      "siteId": "8022800",
      "deviceFunction": "-",
      "deviceGroupId": "8100143262",
      "scopeId": "9842216",
      "siteName": "site-12-dec",
      "deviceGroupName": "SWITCH Persona group",
      "firmwareVersion": "WC.16.11.0014",
      "isProvisioned": "Yes",
      "deviceName": "Aruba-Stack-2930M",
      "tier": null,
      "subscriptionKey": "ET45ENIPPEADN9FQ",
      "stackId": "1f00d067-267edc80",
      "type": "network-monitoring/device-monitoring",
      "macAddress": "D0:67:26:7E:DC:80",
      "ipv4": "10.27.113.203",
      "id": "SG7BJQL6PD",
      "deployment": "Stack",
      "status": "OFFLINE",
      "partNumber": "JL320A"
    }
  ],
  "count": 1,
  "total": 4,
  "next": "2"
}