Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Access Points

Get a specific WLAN by name

This API retrieves detailed information about a specific WLAN.

get/network-monitoring/v1/wlans/{wlan-name}

Path parameters

wlan-namestring required
Example:wlan1

Name of the WLAN for which information is requested.

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.

Response

Detailed information about a specific WLAN, including name, primary usage, security level, security, band, status, and VLAN configuration.

wlanNamestring const required

The name of the WLAN.

securityLevel'Enterprise' | 'Personal' | 'Open' | 'Captive Portal' required

Type of the WLAN.

securitystring

Security type of the WLAN.

bandstring

Specifies the bands supported by WLAN. Possible values include '2.4 GHz', '5 GHz', '6 GHz', or combinations like '2.4 GHz, 5 GHz'.

status'ENABLED' | 'DISABLED'

The operational status of the WLAN.

vlanstring

WLAN VLAN ID.

clientCountinteger
idstring const required

Primary identifier of a WLAN.

typestring const required

The type of the resource.

Example response

{
  "wlanName": "wlan1",
  "securityLevel": "Personal",
  "security": "Enhanced Open",
  "band": "2.4 GHz, 5 GHz",
  "status": "ENABLED",
  "vlan": "1",
  "clientCount": 15,
  "id": "wlans/wlan1",
  "type": "network-monitoring/access-point-monitoring"
}