v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Devices

Get a list of devices

This API endpoint retrieves a list of network devices that are on-boarded and currently being monitored, such as access points, switches, and gateways, based on the query parameters provided. Each device in the returned list includes details like serial number, MAC address, device name, device type, IP address, status, etc. The query parameters allow you to narrow down the results to devices that meet specific criteria, ensuring you receive only the relevant data.

Notes: The notes field in the response will have a value only when the request is filtered by the site ID or serialNumber.

get/network-monitoring/v1/devices

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
status	eq and in
model	eq and in
firmwareVersion	eq and in
deployment	eq and in
clusterName	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, deployment, and model.

limitinteger required

Example:20

Denotes the maximum number of tenants returned in the response. Maximum value is 100.

nextstring required

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, 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": [
    {
      "serialNumber": "CMZR001874",
      "macAddress": "bb:5d:11:85:c0:00",
      "deviceName": "ArubaAP",
      "deviceType": "ACCESS_POINT",
      "model": "AP-115",
      "partNumber": "JZ336A",
      "deployment": "Standalone",
      "role": "Conductor",
      "deviceFunction": "Instant",
      "firmwareVersion": "8.5.2.0_59123",
      "ipv4": "114.191.59.254",
      "ipv6": "10.27.119.19",
      "status": "ONLINE",
      "uptimeInMillis": 1702794777,
      "lastSeenAt": null,
      "siteId": "1120972196",
      "buildingId": "1120972196_1",
      "floorId": "1120972196_1_",
      "configStatus": null,
      "configLastModifiedAt": null,
      "siteName": "site-12-dec",
      "clusterName": "cluster 1",
      "notes": "Device is located in Building A, Floor 2",
      "id": "AP00000001",
      "type": "network-monitoring/device-monitoring"
    }
  ],
  "count": 1,
  "total": 4,
  "next": "2"
}