Qodex.ai

searchOrgWirelessClients

GET https://{{host}}/api/v1/orgs/:org_id/clients/search

Supported Filters

ParameterTypeDescription
macstringpartial / full MAC address
hostnamestringpartial / full hostname
devicestringdevice type, e.g. Mac, Nvidia, iPhone
osstringos, e.g. Sierra, Yosemite, Windows 10
modelstringmodel, e.g. “MBP 15 late 2013”, 6, 6s, “8+ GSM”
apstringAP mac where the client has connected to
ssidstringSSID
vlanstringvlan
psk_idstringPSK ID
psk_namestringPSK name
ipstringip address
textstringpartial / full MAC address, hostname, username, psk_name or ip

Request Params

KeyDatatypeRequiredDescription
macstringfdsfs
hostnamestring
devicestring
osstring
modelstring
apstring
ssidstring
vlanstring
ipstring
textstring

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"]}]}