v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Access Points

Get a list of Radios

This API endpoint retrieves a list of radios associated to a customer, based on the query parameters provided. Each radio in the returned list includes comprehensive details like serial number, device name, MAC address, band, status and its current statistics . The query parameters allow you to narrow down the results to radios that meet specific criteria, ensuring you receive only the relevant data.

get/network-monitoring/v1/radios

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
band	eq and in
bandwidth	eq and in
status	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:deviceName,band desc

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. By default, the response is sorted in ascending order by deviceName and descending order by band. Supported fields are deviceName, serialNumber, and band.

limitinteger

Example:20

Specifies the maximum number of radios returned in the response.

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 Radios, 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

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

Example response

{
  "items": [
    {
      "serialNumber": "AP00000001",
      "deviceName": "ap_1",
      "macAddress": "11:22:33:44:55:66",
      "status": "UP",
      "band": "2.4 GHz",
      "bandRange": "",
      "channel": "8",
      "bandwidth": "20 MHz",
      "mode": "Client Access",
      "radioNumber": 1,
      "power": 13,
      "siteId": "6658275",
      "siteName": "site1",
      "channelUtilization": "87",
      "nonWifiInterference": "3",
      "txUtilization": "21",
      "rxUtilization": "41",
      "noiseFloor": "-50",
      "drops": "14.44",
      "retries": "0",
      "channelQuality": "99",
      "channelChangeCount": 9,
      "powerChangeCount": 6,
      "antenna": "Internal",
      "spatialStream": "4x4:4",
      "radioType": "802.11n",
      "clientCount": 4,
      "id": "AP00000001/radios/1",
      "type": "network-monitoring/access-point-monitoring"
    }
  ],
  "count": 1,
  "total": 4,
  "next": "2"
}