GET /api/v1/sites/{site_id}/devices/search

mist.com

Summary: searchSiteDevices
Operation ID: searchSiteDevices
Auth: unknown
Description

Search Device

Parameters (25)

band_24_channel (integer, query, optional)

Channel of band_24

band_5_channel (integer, query, optional)

Channel of band_5

band_6_channel (integer, query, optional)

Channel of band_6

desc-sort (string, query, optional)

sort options in reverse order

Constraints: {'enum': ['timestamp', 'mac', 'model', 'sku']}

duration (string, query, optional, default: 1d)

For historical stats and/or logs where time range is needed, you can specify the time range in a few different ways: * ?start=1430000000&end=1430864000 specify the start / end * ?end=1430864000&duration=1d specify end time and duration * ?duration=1d specify duration, end will be now() in seconds

end (integer, query, optional, default: 0)

Constraints: {'minimum': 0}

eth0_port_speed (integer, query, optional)

Port speed of eth0

hostname (string, query, optional)

partial / full hostname

ip address (string, query, optional)
limit (integer, query, optional, default: 100)

Constraints: {'minimum': 0}

lldp_mgmt_addr (string, query, optional)

LLDP management ip address

lldp_port_id (string, query, optional)

LLDP port id

lldp_system_desc (string, query, optional)

LLDP system description

lldp_system_name (string, query, optional)

LLDP system name

mac (string, query, optional)

device MAC

model (string, query, optional)

device model

mxedge_id (string, query, optional)

Mist Edge id, if AP is connecting to a Mist Edge

mxtunnel_status (string, query, optional)

MxTunnel status, up / down

Constraints: {'enum': ['up', 'down']}

power_constrained (boolean, query, optional)

power_constrained

site_id (string, path, required)
sort (string, query, optional, default: timestamp)

sort options

Constraints: {'enum': ['timestamp', 'mac', 'model', 'sku']}

start (integer, query, optional, default: 0)

Constraints: {'minimum': 0}

stats (boolean, query, optional, default: False)

whether to return device stats

type (string, query, optional, default: ap)

device type

Constraints: {'enum': ['ap', 'switch', 'gateway']}

version (string, query, optional)

version

No probe data for this endpoint yet.