v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Access Points

Get a list of BSSIDs

This API endpoint retrieves a list of BSSIDs associated with a customer, based on the query parameters provided. Each BSSID in the returned list includes details like serial number, device name, MAC address, radio number, radio MAC address, BSSID, WLAN name, band, and site information. The query parameters allow you to narrow down the results to BSSIDs that meet specific criteria.

get/network-monitoring/v1/bssids

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
macAddress	eq and in
radioMacAddress	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,wlanName 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. Supported fields are siteId, siteName, serialNumber, deviceName, and wlanName.

limitinteger

Example:20

Specifies the maximum number of BSSIDs 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 BSSIDs, 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",
      "clusterId": "cluster1",
      "radioNumber": 0,
      "radioMacAddress": "11:22:33:44:55:77",
      "bssid": "11:22:33:44:55:88",
      "wlanName": "wlan1",
      "siteId": "24833497",
      "siteName": "site1",
      "clientcount": 3,
      "id": "AP00000001/bssids/11:22:33:44:55:88",
      "type": "network-monitoring/access-point-monitoring"
    }
  ],
  "count": 1,
  "total": 4,
  "next": "2"
}