Juniper Mist AI Sites Stats - Devices API
API Calls to retrieve statistics about the Mist Managed and Monitored Devices at the Site level
Juniper Mist AI Sites Stats - Devices API is one of 211 APIs that Juniper Mist AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sites Stats - Devices. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 5 paths, and defines 186 schemas. It is described by OpenAPI 3.1.0, at version 2604.1.1.
Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.
5 operations
5 paths
186 schemas
5 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Juniper Mist AI Sites Stats - Devices API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiToken).
It accepts HTTP basic authentication (basicAuth).
An API key is passed in the header as X-CSRFToken (csrfToken).
By default, every request must be authenticated.
apiToken— Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…basicAuth— While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.csrfToken— This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.
Sites Stats - Devices 5
API Calls to retrieve statistics about the Mist Managed and Monitored Devices at the Site level
GET
/api/v1/sites/{site_id}/stats/devices
listSiteDevicesStats
GET
/api/v1/sites/{site_id}/stats/devices/{device_id}
getSiteDeviceStats
GET
/api/v1/sites/{site_id}/stats/devices/{device_id}/clients
getSiteAllClientsStatsByDevice
GET
/api/v1/sites/{site_id}/stats/gateways/metrics
getSiteGatewayMetrics
GET
/api/v1/sites/{site_id}/stats/switches/metrics
getSiteSwitchesMetrics
Schemas 186
The contract defines 186 schemas that model the data the API accepts and returns. The most detailed are stats_ap (70 properties), stats_gateway (61 properties), stats_wireless_client (57 properties), stats_switch_port (50 properties). Each schema is shown below with its type and property counts.
stats_ap_env_stat
object
Device environment, including CPU temperature, Ambient temperature, Humidity, Attitude, Pressure, Accelerometers, Magnetometers and vCore Voltage
12 properties
dhcpd_stat_lan
object
2 properties
stats_ap_auto_placement_info_probability_surface
object
Coordinates representing a circle where the AP is most likely exists in the event of an inaccurate placement result
3 properties
strings
array
stats_ap_expiring_certs
object
Map of certificate serial numbers to their expiry timestamps (in epoch) for certificates expiring within 30 days. Property key is the certificate serial number
port_stp_role
string
enum: alternate, backup, designated, disabled, root, root-prevented
stats_gateway_spu
array
dot11_proto
string
enum: a, ac, ax, b, be, g, n
port_stp_state
string
enum: blocking, disabled, forwarding, learning, listening
stats_ap_switch_redundancy
object
1 property
stats_ap_port_stat
object
10 properties
stats_ap_auto_upgrade
object
1 property
stats_ap_auto_placement_info
object
Additional information about auto placements AP data
3 properties
response_switch_metrics_config_success
object
3 properties
stats_ap_lldp_stat_power_srcs
array
List of management IP addresses (IPv4 and IPv6)
if_stat_property
object
16 properties
timestamp
number
Epoch (seconds)
stats_ap_iot_stat_additional_properties
object
1 property
stats_ap_esl_stat
objectnull
8 properties
stats_switch_ap_redundancy
object
3 properties
ip_stat_ips
stringnull
Property key is the VLAN name
if_stat
object
Property key is the interface name
module_stat_item_errors
array
Used to report all error states the device node is running into. An error should always have type and since fields, and could have some other fields specific t…
stats_gateway_cluster
object
1 property
ap_radio_stat
object
Radio stat
20 properties
switch_metrics_compliance_major_versions
array
module_stat_item_pics_item_port_groups
array
stats_switch_clients_stats_total
object
2 properties
stats_gateway_vpn_peer
object
16 properties
ap_redundancy_modules
object
Property key is the node id
arp_table_stats
object
2 properties
module_stat_item_vc_links
array
stats_ap_usb_stat
object
5 properties
stats_ap_radio_config
object
5 properties
module_stat_item_poe
object
3 properties
stats_cluster_config_ethernet_connection
array
stat_device_status_filter
string
enum: all, connected, disconnected
service_stat
object
response_http401
object
1 property
switch_metrics_active_ports_summary_details
object
2 properties
module_stat_item_pics_item_port_groups_item
object
2 properties
stats_ap_l2tp_stat
object
4 properties
module_stat_item_pics_item
object
3 properties
stats_gateway_mac_table_stats
object
2 properties
ap_redundancy
object
3 properties
stats_gateway_vpn_peers
array
Only present when vpnpeers in fields query parameter. Each port object is same as GET /api/v1/sites/{siteid}/stats/vpnpeers/search result object, except that o…
stats_switch_ports
array
device_type_switch
string
Device Type. enum: switch
stats_wireless_client_rssi_zone
object
2 properties
stats_ap_auto_placement
object
8 properties
stats_cluster_config
object
10 properties
l2tp_state
string
enum: established, establishedwithsession, idle, wait-ctrl-conn, wait-ctrl-reply
mac_table_stats
object
2 properties
module_stat_item_psus
array
rx_rate
numbernull
RX Rate, Mbps
ibeacon_uuid
stringnull
ap_stat_mesh_uplink
object
19 properties
gateway_metrics
object
2 properties
fwupdate_stat
object
5 properties
switch_metrics_compliance_major_version
object
4 properties
stats_switch_module_stat
array
stats_gateway_module_stat
array
response_switch_metrics_version_compliance_details
object
1 property
stats_gateway_wan_tunnels
array
Only present when tunnels in fields query parameter. Each port object is same as GET /api/v1/sites/{siteid}/stats/tunnels/search result object, except that org…
stats_ap_l2tp_stat_sessions
array
List of sessions
stats_ap_iot_stat
object
stats_ap_radio_config_band
object
10 properties
device_type_with_all
string
ap, switch, gateway, router, all, default is ap. Supports comma-separated values for multiple types (e.g., type=switch,gateway)
stats_gateway_module_stat_item
object
31 properties
stats_wireless_client_zones
array
List of zoneid’s where client is in and since when (if known)
ip_stat
object
10 properties
stats_wireless_client_wxrule_usages
array
Current WxlanRule usage per tagid
module_stat_item_vc_links_item
object
3 properties
tx_bytes
integernull
Amount of traffic sent since connection
module_stat_item_network_resource
object
3 properties
stats_gateway_service_status
object
10 properties
stats_switch_port
object
Switch port statistics
50 properties
4 required
bgp_stats_state
string
enum: active, connect, established, idle, openconfig, opensent
stats_switch_vc_setup_info
object
6 properties
stats_switch_port_type
string
device type. enum: ap, ble, gateway, mxedge, nac, switch
stats_cluster_config_fabric_link_info
object
5 properties
ap_led
object
LED AP settings
2 properties
stats_gateway
object
Gateway statistics
61 properties
2 required
stats_wireless_clients
array
stats_wireless_client_wxrule_usage
object
2 properties
stats_ap_lldp_stat
object
LLDP neighbor information and power negotiations. For backward compatibility, when multiple neighbors exist, only information from the first neighbor is displa…
19 properties
stats_ap_lldp_stat_mgmt_addrs
array
List of management IP addresses (IPv4 and IPv6)
ibeacon_minor
integernull
Minor number for iBeacon
route_summary_stats
object
4 properties
stats_cluster_config_redundancy_group_info_item
object
3 properties
cpu_stat_load_avg
array
Load averages for the last 1, 5, and 15 minutes
tx_rate
numbernull
TX Rate, Mbps
stats_ap_l2tp_stat_session
object
4 properties
created_time
number
When the object has been created, in epoch
module_stat_item_temperatures_item
object
3 properties
stats_switch_ap_redundancy_module
object
2 properties
stats_ap_ble
object
23 properties
stats_switch_clients_stats_total_total_num_aps
array
ap_ip_config_dns
array
If type==static
stats_switch_clients_stats
object
1 property
ap_ip_config
object
IP AP settings
12 properties
module_stat_item_network_resources
array
stats_gateway_wan_tunnel
object
19 properties
tx_bps
integernull
Rate of transmitting traffic, bits/seconds, last known
tx_retries
integernull
Amount of tx retries
ap_ip_config_dns_suffix
array
Required if type==static
response_switch_metrics_config_success_details
object
1 property
stats_wireless_client_rssi_zones
array
List of rssizoneid’s where client is in and since when (if known)
stats_switch_port_poe_mode
string
enum: 802.3af, 802.3at, 802.3bt
antenna_select
string
Antenna Mode for AP which supports selectable antennas. enum: "" (default), external, internal
bgp_as
BGP AS, value in range 1-4294967294. Can be a Variable (e.g. {{bgpas}} )
tunnel_priority
string
enum: primary, secondary
dhcpd_stat
object
Property key is the network name
stats_ap_gps_stat
object
6 properties
stats_switch
object
Switch statistics
48 properties
1 required
stats_wireless_client_airwatch
object
Information if airwatch enabled
1 property
1 required
rx_bps
integernull
Rate of receiving traffic, bits/seconds, last known
guest
object
Guest
18 properties
gateway_compliance_major_version_properties
object
2 properties
cpu_stat
object
6 properties
stats_wireless_client_vbeacons
array
List of beaconid’s where the client is in and since when (if known)
stats_switch_clients
array
response_http429
object
1 property
stats_ap_gps_stat_src
string
The origin of the GPS data. enum: gps: from this device GPS estimates, otherap from neighboring device GPS estimates. Note: API responses may return otheraps w…
gateway_compliance_major_version
object
rx_retries
integernull
Amount of rx retries
if_stat_property_servp_info
object
7 properties
module_stat_item_fans
array
stats_gateway_spu_item
object
7 properties
memory_stat
object
Memory usage stat (for virtual chassis, memory usage of master RE)
1 property
1 required
port_auth_state
string
enum: authenticated, authenticating, held, init
bgp_peers
array
Only present when bgppeers in fields query parameter. Each port object is same as GET /api/v1/sites/{siteid}/stats/bgppeers/search result object, except that o…
module_stat_item_temperatures
array
module_stat_item_errors_items
object
5 properties
2 required
const_device_type_gateway
string
Device Type. enum: gateway
org_id
string
ip_type6
string
enum: autoconf, dhcp, disabled, static
last_trouble
object
Last trouble code of switch
2 properties
stats_ap_radio_stat
object
3 properties
id
string
Unique ID of the object instance in the Mist Organization
stats_ap_lldp_stats
object
Property key is the port name (e.g. "eth0", "eth1", ...). Map of ethernet ports to their respective LLDP neighbor information and power negotiations. Only pres…
stats_devices
array
stats_wireless_client_zone
object
2 properties
stats_gateway_ports
array
Only present when ports in fields query parameter. Each port object is same as GET /api/v1/sites/{siteid}/stats/ports/search result object, except that orgid,…
gateway_compliance_version
object
Version compliance score, major version for gateway, type
3 properties
response_http403
object
1 property
stats_gateway_port
object
Port statistics
44 properties
3 required
wan_tunnel_protocol
string
enum: gre, ipsec
stats_wireless_client_vbeacon
object
2 properties
stats_ap_lldp_stat_power_src
string
Single power source (DC Input / PoE 802.3at / PoE 802.3af / PoE 802.3bt / MULTI-PD / LLDP / ? (unknown)).
response_switch_metrics_active_ports_summary
object
3 properties
stats_switch_client_item
object
4 properties
ip_type
string
enum: dhcp, static
tx_pkts
integernull
Amount of packets sent since connection
site_id
string
stats_switch_module_stat_item
object
35 properties
last_seen
numbernull
Last seen timestamp
response_http404
object
1 property
const_device_type_ap
string
Device Type. enum: ap
response_switch_metrics
object
3 properties
response_switch_metrics_version_compliance
object
3 properties
ap_redundancy_module
object
2 properties
switch_metric_scope
string
enum: site, switch
stats_cluster_config_ethernet_connection_item
object
2 properties
bgp_peer
object
Only present when bgppeers in fields query parameter
16 properties
service_stat_property
object
8 properties
response_http400
object
1 property
ap_stat_mesh_downlink
object
18 properties
stats_ap
object
AP statistics
70 properties
1 required
integers
array
stats_device
poe_priority
string
PoE priority. enum: low, high
module_stat_item_psus_item
object
2 properties
fwupdate_stat_status
stringnull
enum: inprogress, failed, upgraded, success, scheduled, error
module_stat_item_pics
array
module_stat_item_fans_items
object
4 properties
dot11_band
string
enum: 24, 5, 5-dedicated, 5-selectable, 6, 6-dedicated, 6-selectable
switch_metric_type
string
enum: activeportssummary
ibeacon_major
integernull
Major number for iBeacon
stats_wireless_client
object
57 properties
12 required
dot11_bandwidth
integer
channel width for the band.enum: 0(disabled, response only), 20, 40, 80 (only applicable for band5 and band6), 160 (only for band6)
rx_bytes
integernull
Amount of traffic received since connection
rx_pkts
integernull
Amount of packets received since connection
modified_time
number
When the object has been modified for the last time, in epoch
stats_cluster_config_control_link_info
object
2 properties
stats_cluster_config_redundancy_group_info
array
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Juniper Mist AI 12
Other APIs Juniper Mist AI publishes across the network.
Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API
#Sites Stats - Devices