searchOrgWirelessClientEvents
Search wireless client event records across the organization with filters for event type, reason code, SSID, AP, key management, protocol, band, WLAN, NAC rule, and time range.
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidQuery Parameters
See List Device Events Definitions. Accepts multiple comma-separated values.
Reason code filter for association and disassociation events. Accepts multiple comma-separated integer values.
Filter results by SSID. Accepts multiple comma-separated values.
Filter results by AP MAC address. Accepts multiple comma-separated values.
Key management protocol used to filter client events. enum: WPA2-PSK, WPA2-PSK/CCMP, WPA2-PSK-FT, WPA2-PSK-SHA256, WPA3-EAP-SHA256, WPA3-EAP-SHA256/CCMP, WPA3-EAP-FT/GCMP256, WPA3-SAE-FT, WPA3-SAE-PSK. Accepts multiple comma-separated values.
802.11 protocol used to filter results. enum: a, ac, ax, b, be, g, n. Accepts multiple comma-separated values.
802.11 band used to filter radio results. enum: 24, 5, 5-dedicated, 5-selectable, 6, 6-dedicated, 6-selectable. Accepts multiple comma-separated values.
Filter results by WLAN identifier
uuidFilter results by NAC rule identifier. Accepts multiple comma-separated values.
uuidLower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w
Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now
Time range duration for the query, using relative units such as 10m, 7d, or 2w
"1d"On which field the list should be sorted, -prefix represents DESC order
"timestamp"Maximum number of results to return per page
0 <= value100Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the next URL from the previous response and should not be manually constructed.
Response Body
curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/clients/events/search?key_mgmt=WPA2-PSK%2CWPA2-PSK%2FCCMP&proto=ax%2Cac&band=6%2C5"{ "end": 0, "limit": 0, "results": [ { "ap": "string", "band": "24", "bssid": "string", "channel": 0, "proto": "a", "ssid": "string", "text": "string", "timestamp": 0, "type": "string", "type_code": 0, "wlan_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1" } ], "start": 0, "total": 0}countOrgWirelessClientsSessions GET
Count historical wireless client sessions across the organization, optionally grouped by `distinct` and filtered by AP, band, client attributes, SSID, WLAN, and time range.
searchOrgWirelessClientSessions GET
Search historical wireless client sessions across the organization with filters for AP, band, client family, manufacturer, model, OS, username, SSID, WLAN, PPSK, and time range.