SitesDevices
listSiteDevices
List devices in a site. Use List Org Devices to retrieve devices across the organization, or Search Org Devices when filters are needed.
Authorization<token>
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
site_id*string
Format
uuidQuery Parameters
type?string
Filter results by type
Default
"ap"name?string
Filter results by name
limit?integer
Maximum number of results to return per page
Range
0 <= valueDefault
100page?integer
Select the page number to return when using page-based pagination; starts at 1
Range
1 <= valueDefault
1Response Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices"[ { "aeroscout": { "enabled": false, "host": "aero.pvt.net", "locate_connected": false, "port": 1144 }, "airista": { "enabled": false, "host": "airista.pvt.net", "port": 1144 }, "ble_config": { "beacon_enabled": true, "beacon_rate": 3, "beacon_rate_mode": "custom", "beam_disabled": [ 1, 3, 6 ], "custom_ble_packet_enabled": false, "custom_ble_packet_frame": "0x........", "custom_ble_packet_freq_msec": 300, "eddystone_uid_adv_power": -65, "eddystone_uid_beams": "2-4,7", "eddystone_uid_enabled": false, "eddystone_uid_freq_msec": 200, "eddystone_uid_instance": "5c5b35000001", "eddystone_uid_namespace": "2818e3868dec25629ede", "eddystone_url_adv_power": -65, "eddystone_url_beams": "2-4,7", "eddystone_url_enabled": false, "eddystone_url_freq_msec": 1000, "eddystone_url_url": "https://www.abc.com", "ibeacon_adv_power": -65, "ibeacon_beams": "2-4,7", "ibeacon_enabled": false, "ibeacon_freq_msec": 0, "ibeacon_major": 1234, "ibeacon_minor": 1234, "ibeacon_uuid": "f3f17139-704a-f03a-2786-0400279e37c3", "power": 6, "power_mode": "custom" }, "centrak": { "enabled": false }, "client_bridge": { "auth": { "psk": "foryoureyesonly", "type": "psk" }, "enabled": false, "ssid": "Uplink-SSID" }, "created_time": 0.1, "deviceprofile_id": "6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9", "disable_eth1": false, "disable_eth2": false, "disable_eth3": false, "disable_module": false, "enable_unii_4": false, "esl_config": { "cacert": "--BEGIN CERTIFICATE--\nMIIDXTCCAkWgAwIBAgIJAL5b1z4f3k2TMA0GCSqGSIb3DQEBCwUAMIGVMQsw\n", "channel": 3, "enabled": false, "host": "1.1.1.1", "port": 0, "type": "imagotag", "verify_cert": true, "vlan_id": 1 }, "flow_control": false, "for_site": true, "height": 2.75, "id": "53f10664-3ce8-4c27-b382-0ef66432349f", "image1_url": "string", "image2_url": "string", "image3_url": "string", "iot_config": { "A1": { "enabled": false, "name": "motion", "output": true, "pullup": "external", "value": 0 }, "A2": { "enabled": false, "name": "motion", "output": true, "pullup": "external", "value": 0 }, "A3": { "enabled": false, "name": "motion", "output": true, "pullup": "external", "value": 0 }, "A4": { "enabled": false, "name": "motion", "output": true, "pullup": "external", "value": 0 }, "DI1": { "enabled": false, "name": "motion", "pullup": "external" }, "DI2": { "enabled": false, "name": "motion", "pullup": "external" }, "DO": { "enabled": false, "name": "motion", "output": true, "pullup": "external", "value": 0 } }, "ip_config": { "dns": [ "8.8.8.8", "4.4.4.4" ], "dns_suffix": [ ".mist.local", ".mist.com" ], "gateway": "10.2.1.254", "gateway6": "2607:f8b0:4005:808::1", "ip": "10.2.1.1", "ip6": "2607:f8b0:4005:808::2004", "mtu": 0, "netmask": "255.255.255.0", "netmask6": "/32", "type": "static", "type6": "static", "vlan_id": 1 }, "lacp_config": { "enabled": false }, "led": { "brightness": 255, "enabled": true }, "locked": true, "mac": "string", "map_id": "63eda950-c6da-11e4-a628-60f81dd250cc", "mesh": { "bands": [ "24" ], "enabled": false, "group": 1, "role": "base", "use_wpa3_on_5": false }, "model": "string", "modified_time": 0.1, "mqtt_config": { "broker_host": "string", "broker_port": 0, "broker_proto": "ssl", "default_topic": "mist/asset/raw", "enabled": false, "format": "json", "password": "pa$$word", "username": "string" }, "name": "conference room", "notes": "slightly off center", "ntp_servers": [ "string" ], "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61", "orientation": 45, "poe_passthrough": false, "port_config": { "property1": { "disabled": false, "dynamic_vlan": { "default_vlan_id": 999, "enabled": true, "type": "airespace-interface-name", "vlans": { "1-10": null, "user": 10 } }, "enable_mac_auth": false, "forwarding": "all", "mac_auth_preferred": false, "mac_auth_protocol": "eap-md5", "mist_nac": { "acct_interim_interval": 60, "auth_servers_retries": 3, "auth_servers_timeout": 5, "coa_enabled": false, "coa_port": 3799, "enabled": false, "fast_dot1x_timers": false, "network": "default", "source_ip": "1.2.3.4" }, "mx_tunnel_id": "08cd7499-5841-51c8-e663-fb16b6f3b45e", "mxtunnel_name": "", "port_auth": "none", "port_vlan_id": 1, "radius_config": { "acct_interim_interval": 0, "acct_servers": [ { "host": "1.2.3.4", "keywrap_enabled": true, "keywrap_format": "ascii", "keywrap_kek": "1122334455", "keywrap_mack": "1122334455", "port": 1, "secret": "testing123" } ], "auth_servers": [ { "host": "1.2.3.4", "keywrap_enabled": true, "keywrap_format": "ascii", "keywrap_kek": "1122334455", "keywrap_mack": "1122334455", "port": 1, "require_message_authenticator": false, "secret": "testing123" } ], "auth_servers_retries": 3, "auth_servers_timeout": 5, "coa_enabled": false, "coa_port": 3799, "network": "string", "source_ip": "string" }, "radsec": { "coa_enabled": false, "enabled": true, "idle_timeout": 60, "mxcluster_ids": [ "572586b7-f97b-a22b-526c-8b97a3f609c4" ], "proxy_hosts": [ "mxedge1.local" ], "server_name": "radsec.abc.com", "servers": [ { "host": "1.1.1.1", "port": 1812 } ], "use_mxedge": true, "use_site_mxedge": false }, "vlan_id": 9, "vlan_ids": "10,20,30", "wxtunnel_id": "7dae216d-7c98-a51b-e068-dd7d477b7216", "wxtunnel_remote_id": "wifiguest" }, "property2": { "disabled": false, "dynamic_vlan": { "default_vlan_id": 999, "enabled": true, "type": "airespace-interface-name", "vlans": { "1-10": null, "user": 10 } }, "enable_mac_auth": false, "forwarding": "all", "mac_auth_preferred": false, "mac_auth_protocol": "eap-md5", "mist_nac": { "acct_interim_interval": 60, "auth_servers_retries": 3, "auth_servers_timeout": 5, "coa_enabled": false, "coa_port": 3799, "enabled": false, "fast_dot1x_timers": false, "network": "default", "source_ip": "1.2.3.4" }, "mx_tunnel_id": "08cd7499-5841-51c8-e663-fb16b6f3b45e", "mxtunnel_name": "", "port_auth": "none", "port_vlan_id": 1, "radius_config": { "acct_interim_interval": 0, "acct_servers": [ { "host": "1.2.3.4", "keywrap_enabled": true, "keywrap_format": "ascii", "keywrap_kek": "1122334455", "keywrap_mack": "1122334455", "port": 1, "secret": "testing123" } ], "auth_servers": [ { "host": "1.2.3.4", "keywrap_enabled": true, "keywrap_format": "ascii", "keywrap_kek": "1122334455", "keywrap_mack": "1122334455", "port": 1, "require_message_authenticator": false, "secret": "testing123" } ], "auth_servers_retries": 3, "auth_servers_timeout": 5, "coa_enabled": false, "coa_port": 3799, "network": "string", "source_ip": "string" }, "radsec": { "coa_enabled": false, "enabled": true, "idle_timeout": 60, "mxcluster_ids": [ "572586b7-f97b-a22b-526c-8b97a3f609c4" ], "proxy_hosts": [ "mxedge1.local" ], "server_name": "radsec.abc.com", "servers": [ { "host": "1.1.1.1", "port": 1812 } ], "use_mxedge": true, "use_site_mxedge": false }, "vlan_id": 9, "vlan_ids": "10,20,30", "wxtunnel_id": "7dae216d-7c98-a51b-e068-dd7d477b7216", "wxtunnel_remote_id": "wifiguest" } }, "pwr_config": { "base": 2000, "prefer_usb_over_wifi": false }, "radio_config": { "allow_rrm_disable": false, "ant_gain_24": 4, "ant_gain_5": 5, "ant_gain_6": 5, "antenna_mode": "1x1", "antenna_select": "external", "band_24": { "allow_rrm_disable": false, "ant_gain": 0, "antenna_mode": "default", "bandwidth": 20, "channel": 6, "channels": [], "disabled": false, "power": 3, "power_max": 3, "power_min": 0, "preamble": "auto" }, "band_24_usage": "24", "band_5": { "allow_rrm_disable": false, "ant_gain": 0, "antenna_beam_pattern": "narrow", "antenna_mode": "default", "bandwidth": 40, "channel": 100, "channels": [], "disabled": false, "power": 6, "power_max": 5, "power_min": 0, "preamble": "auto" }, "band_5_on_24_radio": { "allow_rrm_disable": false, "ant_gain": 0, "antenna_beam_pattern": "narrow", "antenna_mode": "default", "bandwidth": 40, "channel": 100, "channels": [], "disabled": false, "power": 6, "power_max": 5, "power_min": 0, "preamble": "auto" }, "band_6": { "allow_rrm_disable": false, "ant_gain": 0, "antenna_beam_pattern": "narrow", "antenna_mode": "default", "bandwidth": 80, "channel": 0, "channels": [], "disabled": false, "power": 7, "power_max": 5, "power_min": 0, "preamble": "auto", "standard_power": false }, "full_automatic_rrm": false, "indoor_use": false, "rrm_managed": true, "scanning_enabled": true }, "serial": "string", "site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6", "type": "ap", "uplink_port_config": { "dot1x": false, "keep_wlans_up_if_down": false }, "usb_config": { "cacert": "string", "channel": 3, "enabled": true, "host": "1.1.1.1", "port": 0, "type": "imagotag", "verify_cert": true, "vlan_id": 1 }, "uwb_config": { "enabled": false, "host": "coriva.example.com", "port": 9000, "slot": 0, "type": "zigpos" }, "vars": { "RADIUS_IP1": "172.31.2.5", "RADIUS_SECRET": "11s64632d" }, "x": 53.5, "y": 173.1, "zigbee_config": { "allow_join": "manual", "channel": 0, "enabled": false, "extended_pan_id": 1311768467294899700, "pan_id": "0x1234" } }]importSiteDevices POST
Import Information for Multiple Devices CSV format: ```csv mac,name,map_id,x,y,height,orientation,labels,band_24.power,band_24.bandwidth,band_24.channel,band_24.disabled,band_5.power,band_5.bandwidth,band_5.channel,band_5.disabled,band_6.power,band_6.bandwidth,band_6.channel,band_6.disabled 5c5b53010101,"AP 1",845a23bf-bed9-e43c-4c86-6fa474be7ae5,30,10,2.3,45,"guest, campus, vip",1,20,0,false,0,40,0,false,17,80,0,false ```
searchSiteDeviceConfigHistory GET
Search for entries in device config history