searchSiteDevices
GET https://{{host}}/api/v1/sites/:site_id/devices/search
Filter Options
| Parameter | Type | Description |
|---|---|---|
| hostname | string | partial / full hostname |
| site_id | string | site id |
| model | string | device model |
| mac | string | AP mac |
| version | string | version |
| ip | string | ip address |
| mxtunnel_status | string | MxTunnel status, up / down |
| mxedge_id | string | Mist Edge id, if AP is connecting to a Mist Edge |
| lldpsystemname | string | LLDP system name |
| lldpsystemdesc | string | LLDP system description |
| lldpportid | string | LLDP port id |
| lldpmgmtaddr | string | LLDP management ip address |
| sort | string | sort options, timestamp/mac/model/sku, -prefix represents DESC order, default is -timestamp |
| stats | boolean | whether to return device stats, default is false |
NOTE: fuzzy logic can be used with ‘’, supported filters: mac, hostname, device, os, model. E.g. /clients/search?device=Mac&hostname=jerry
RESPONSES
status: OK
{"results":[{"mac":"5c5b35000001","model":"AP41-WW","ip":"192.168.1.2","version":"apfw-0.5.16833-ellaria-0455","uptime":1575742,"org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","lldp_system_name":"ME-DC2-ACC-SW","lldp_system_desc":"Cisco IOS Software, Version 12.2(55)SE5, ...","lldp_port_desc":"GigabitEthernet3/0/28","lldp_mgmt_addr":"192.168.1.15","lldp_chassis_id":"63:68:61:73:73:69"}]}