searchSiteWirelessClients
Search wireless clients connected to a site with filters for client identity, AP, SSID, VLAN, radio band, and time range. Fuzzy matching with * is supported on mac, hostname, device, os, and model, for example /clients/search?device=Mac*&hostname=jerry. Use Search Org Wireless Clients to search wireless clients across the organization.
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
Filter results by AP MAC address
Comma separated list of Radio band (e.g. 24,5). enum: 24, 5, 6
Comma separated list of Device type (e.g. Mac,iPhone). Case sensitive
Partial / full Client hostname. Use prefix* for prefix search or *substring* for contains search (e.g. everest* and *rest* match my-everest-client). Suffix-only wildcards (e.g. *everest) are not supported
Partial / full Client IP address. Use prefix* for prefix search or *substring* for contains search (e.g. 10.100.10.* and *100.10.* match 10.100.10.54). Suffix-only wildcards (e.g. *.54) are not supported
Partial / full Client MAC address. Use prefix* for prefix search or *substring* for contains search (e.g. aabbcc* and *bbcc* match aabbccddeeff). Suffix-only wildcards (e.g. *bccddeeff) are not supported
Only available for clients running the Marvis Client app, model, e.g. "MBP 15 late 2013", 6, 6s, "8+ GSM"
Only available for clients running the Marvis Client app, os, e.g. Sierra, Yosemite, Windows 10
PSK identifier used to filter the results
Only available for clients using PPSK authentication, the Name of the PSK
Filter results by SSID
Partial / full MAC address, hostname, username, psk_name or ip. Use prefix* for prefix search or *substring* for contains search (e.g. everest* and *rest* match my-everest-client). Suffix-only wildcards (e.g. *client) are not supported
Partial / full username. Use prefix* for prefix search or *substring* for contains search (e.g. johndoe* and *mycorp* match johndoe@mycorp.com). Suffix-only wildcards (e.g. *mycorp.com) are not supported
Filter results by VLAN ID
Maximum number of results to return per page
0 <= value100Lower 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"Pagination 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/sites/000000ab-00ab-00ab-00ab-0000000000ab/clients/search"{ "end": 17141231418.812, "limit": 118, "next": "next8", "results": [ { "ap": [ "a83a79a947ee", "003e73170b4c" ], "app_version": [ "0.100.3" ], "band": "5", "device": [ "Mac" ], "ftc": false, "hardware": "Apple Wi-Fi adapter", "hostname": [ "hostname-a", "hostname-b" ], "ip": [ "10.5.23.43", "192.168.0.2" ], "last_ap": "a83a79a947ee", "last_device": "Mac", "last_firmware": "wl0: Jan 20 2024 04:08:41 version 20.103.12.0.8.7.171 FWID 01-e09d2675", "last_hostname": "hostname-a", "last_ip": "10.5.23.43", "last_model": "MBP 16\\\" M1 2021", "last_os": "Sonoma", "last_os_version": "14.4.1 (Build 23E224)", "last_psk_id": "abf7dc5c-bb51-4bb7-93b6-5547400ffe11", "last_psk_name": "iot", "last_ssid": "IoT SSID", "last_username": "user@corp.com", "last_vlan": 10, "last_wlan_id": "e5d67b07-aae8-494b-8584-cbc20c8110aa", "mac": "bcd074000000", "mfg": "Apple", "model": "MBP 16\\\" M1 2021", "org_id": "1abff1aa-4571-4c1f-a409-153a1e7a7a24", "os": [ "Sonoma" ], "os_version": [ "14.4.1 (Build 23E224)" ], "protocol": "ax", "psk_id": [ "abf7dc5c-bb51-4bb7-93b6-5547400ffe11" ], "psk_name": [ "iot" ], "sdk_version": [ "0.100.3" ], "site_id": "25ff5219-9be7-4db9-907d-0c9b60445147", "site_ids": [ "25ff5219-9be7-4db9-907d-0c9b60445147" ], "ssid": [ "IoT SSID" ], "timestamp": 1714124722.113, "username": [ "user@corp.com" ], "vlan": [ 10 ] } ], "start": 10, "total": 44}searchSiteWirelessClientSessions GET
Search wireless client sessions for a site with filters for AP, SSID, WLAN, client attributes, PSK, and time range. Use [Search Org Wireless Client Sessions](/api/mist/orgs/orgs-clients/orgs-clients---wireless/searchOrgWirelessClientSessions) to search wireless client sessions across the organization.
listSiteDeviceProfilesDerived GET
Get the list of derived Device Profiles for a Site