Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Access Points

Get a list of WLANs

This API endpoint retrieves a list of WLANs associated to a customer, based on the query parameters provided. Each WLAN in the returned list includes comprehensive details like name, security level, band, status, and VLAN configuration. The query parameters allow you to narrow down the results to WLANs that meet specific criteria, ensuring you receive only the relevant data.

get/network-monitoring/v1/wlans

Query parameters

site-idstring uuid

Id of a site where devices are associated.

Example:24833497

ID of the Site for which access point related information is requested

serial-numberstring const

The device serial number.

Example:AP00000001

Serial number of an access point device.

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.

FieldOperators
bandeq 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:wlanName,status 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 WLAN name.

Supported fields are wlanName, band, status, securityLevel, security, and vlan.

limitinteger
Example:20

Specifies the maximum number of WLANs 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: 1

Response

List of WLANs with comprehensive details, including filtering and pagination support.

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": [
    {
      "wlanName": "wlan1",
      "securityLevel": "Personal",
      "security": "Enhanced Open",
      "band": "2.4 GHz, 5 GHz",
      "status": "ENABLED",
      "vlan": "1",
      "id": "wlans/wlan1",
      "type": "network-monitoring/access-point-monitoring"
    }
  ],
  "count": 1,
  "total": 1,
  "next": null
}