searchSiteWirelessClients
GET https://{{host}}/api/v1/sites/:site_id/clients/search
Request
| Name | Type | Description |
|---|---|---|
mac | string | partial / full MAC address |
hostname | string | partial / full hostname |
device | string | device type, e.g. Mac, Nvidia, iPhone |
os | string | os, e.g. Sierra, Yosemite, Windows 10 |
model | string | model, e.g. “MBP 15 late 2013”, 6, 6s, “8+ GSM” |
ap | string | AP mac where the client has connected to |
ssid | string | SSID |
text | string | partial / full MAC address, hostname, username, psk_name or ip |
psk_id | string | PSK ID |
psk_name | string | PSK name |
nacrule_id | string | nacrule_id |
NOTE: fuzzy logic can be used with ‘’, supported filters: mac, hostname, device, os, model. E.g. `/clients/search?device=Mac&hostname=jerry`
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
mac | null | partial / full MAC address | |
hostname | null | partial / full hostname | |
device | null | device type, e.g. Mac, Nvidia, iPhone | |
os | null | os, e.g. Sierra, Yosemite, Windows 10 | |
model | null | model, e.g. “MBP 15 late 2013”, 6, 6s, “8+ GSM” | |
ap | null | AP mac where the client has connected to | |
ssid | null | SSID | |
text | null | partial / full MAC address, hostname, username, psk_name or ip | |
psk_id | null | PSK ID | |
psk_name | null | PSK name | |
nacrule_id | null | nacrule_id |
RESPONSES
status: OK
{"results":[{"hostname":["jerry"],"ap":["5c5b350e0492","5c5b350eb39d","5c5b350e03c0"],"ip":["192.168.5.43","192.168.20.125"],"vlan":[1],"mac":"60f81dd250cc","device":["Mac"],"os":["Sierra","High Sierra"],"model":["","MBP 15\" late 2013"],"ssid":["Guest"]}]}