openapi: 3.2.0 info: title: Mist Sites Stats - Devices API description: '> Version: **2607.1.1** > > Date: **August 17, 2026** NOTE: Some important API changes will be introduced.' contact: name: Thomas Munzer email: tmunzer@juniper.net version: 2607.1.1 servers: - url: https://api.mist.com variables: {} - url: https://api.gc1.mist.com variables: {} - url: https://api.ac2.mist.com variables: {} - url: https://api.gc2.mist.com variables: {} - url: https://api.gc4.mist.com variables: {} - url: https://api.eu.mist.com variables: {} - url: https://api.gc3.mist.com variables: {} - url: https://api.ac6.mist.com variables: {} - url: https://api.gc6.mist.com variables: {} - url: https://api.ac5.mist.com variables: {} - url: https://api.gc5.mist.com variables: {} - url: https://api.gc7.mist.com variables: {} security: - apiToken: [] - csrfToken: [] tags: - name: Sites Stats - Devices description: API Calls to retrieve statistics about the Mist Managed and Monitored Devices at the Site level paths: /api/v1/sites/{site_id}/stats/devices: parameters: [] get: tags: - Sites Stats - Devices summary: listSiteDevicesStats description: List device statistics for a site, including high-level status and performance fields over the requested time range. Use List Org Device Stats to retrieve device statistics across the organization. operationId: listSiteDevicesStats parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: type in: query description: Filter results by type style: form explode: true schema: type: string default: ap - name: status in: query description: 'Filter results by status. enum: `all`, `connected`, `disconnected`' style: form explode: true schema: allOf: - $ref: '#/components/schemas/stat_device_status_filter' - description: 'Filter results by status. enum: `all`, `connected`, `disconnected`' - name: limit in: query description: Maximum number of results to return per page style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 100 - name: page in: query description: Select the page number to return when using page-based pagination; starts at `1` style: form explode: true schema: minimum: 1 type: integer contentEncoding: int32 default: 1 responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/stats_device' description: Device statistics records returned by a stats response examples: - '[{"auto_upgrade_stat":{"lastcheck":1720594762},"ble_stat":{"beacon_enabled":true,"beacon_rate":4,"eddystone_uid_enabled":false,"eddystone_uid_freq_msec":1000,"eddystone_uid_instance":"5c5b35d0077b","eddystone_uid_namespace":"9777c1a06ef611e68bbf","eddystone_url_enabled":false,"eddystone_url_freq_msec":1000,"eddystone_url_url":"","ibeacon_enabled":false,"ibeacon_freq_msec":1000,"ibeacon_major":894,"ibeacon_minor":9328,"ibeacon_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","major":894,"minors":[9328,9329,9330,9331,9332,9333,9334,9335,-1],"power":8,"rx_bytes":158500843,"rx_pkts":3549163,"tx_bytes":509640,"tx_pkts":85411,"tx_resets":0,"uuid":"af010e2b-f829-4975-b49e-2e896ed1d627"},"config_reverted":false,"cpu_system":21921854,"cpu_user":7496631,"cpu_util":5,"created_time":1718228350,"env_stat":{"accel_x":-0.092,"accel_y":0.004,"accel_z":-1.02,"ambient_temp":43,"attitude":0,"cpu_temp":53,"humidity":9,"magne_x":0,"magne_y":0,"magne_z":0,"pressure":968,"vcore_voltage":0},"ext_ip":"66.129.234.28","hw_rev":"C02","id":"00000000-0000-0000-1000-5c5b35d0077b","inactive_wired_vlans":[],"ip":"192.168.95.3","ip_stat":{"dhcp_server":"192.168.95.1","dns":["8.8.8.8"],"gateway":"192.168.95.1","ip":"192.168.95.3","ip6":"fe80:0:0:0:5e5b:35ff:fed0:77b","ips":{"vlan1":"192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64"},"netmask":"255.255.255.0","netmask6":"/64"},"last_seen":1720595866,"last_trouble":{"code":"07","timestamp":1720039666},"lldp_stat":{"chassis_id":"d0:07:ca:f5:21:00","lldp_med_supported":false,"mgmt_addr":"100.123.105.1","mgmt_addrs":["100.123.105.1"],"port_desc":"ge-0/0/4","port_id":"ge-0/0/4","power_allocated":0,"power_draw":0,"power_request_count":0,"power_requested":0,"system_desc":"Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.","system_name":"Phoenix-Switch"},"mac":"5c5b35d0077b","mem_total_kb":505468,"mem_used_kb":202096,"model":"AP43","modified_time":1718530662,"mount":"faceup","name":"Phoenix","notes":"","num_clients":1,"org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","port_stat":{"eth0":{"full_duplex":true,"rx_bytes":1284143195,"rx_errors":0,"rx_peak_bps":17585,"rx_pkts":5199816,"speed":1000,"tx_bytes":1283744961,"tx_peak_bps":26484,"tx_pkts":3990463,"up":true},"eth1":{"full_duplex":false,"rx_bytes":0,"rx_errors":0,"rx_peak_bps":0,"rx_pkts":0,"speed":0,"tx_bytes":0,"tx_peak_bps":0,"tx_pkts":0,"up":false}},"power_budget":8400,"power_constrained":false,"power_src":"DC Input","radio_config":{},"radio_stat":{"band_24":{"bandwidth":20,"channel":11,"mac":"5c5b35dea810","noise_floor":-80,"num_clients":0,"power":17,"rx_bytes":12948211,"rx_pkts":65292,"tx_bytes":19071943,"tx_pkts":76926,"usage":"24","util_all":24,"util_non_wifi":2,"util_rx_in_bss":0,"util_rx_other_bss":17,"util_tx":4,"util_undecodable_wifi":0,"util_unknown_wifi":1},"band_5":{"bandwidth":40,"channel":36,"mac":"5c5b35dea7f0","noise_floor":-90,"num_clients":1,"power":17,"rx_bytes":578362619,"rx_pkts":2687577,"tx_bytes":1199571353,"tx_pkts":2479302,"usage":"5","util_all":13,"util_non_wifi":0,"util_rx_in_bss":0,"util_rx_other_bss":10,"util_tx":1,"util_undecodable_wifi":0,"util_unknown_wifi":1}},"rx_bps":9276,"rx_bytes":591310830,"rx_pkts":2752869,"serial":"A0703200709E6","site_id":"46fc665e-9706-4296-8fe2-78f42f2e67e4","status":"connected","switch_redundancy":{"num_redundant_aps":1},"tx_bps":8067,"tx_bytes":1218643296,"tx_pkts":2556228,"type":"ap","uptime":1593120,"version":"0.14.29313"}]' - '[{"arp_table_stats":{"arp_table_count":21,"max_entries_supported":64000},"auto_upgrade_stat":{"lastcheck":1720595477},"cert_expiry":1743292763,"cluster_config":{"configuration":"active-active","control_link_info":{"name":"fxp1","status":"Up"},"ethernet_connection":[{"name":"reth0","status":"Up"},{"name":"reth1","status":"Up"},{"name":"reth2","status":"Down"},{"name":"reth3","status":"Down"},{"name":"reth4","status":"Up"}],"fabric_link_info":{"DataPlaneNotifiedStatus":"Up","Interface":[],"InternalStatus":"Up","State":"Enabled","Status":"Enabled"},"last_status_change_reason":"No failures","operational":"active-active","primary_node_health":"Healthy","redundancy_group_information":[{"Id":0,"MonitoringFailure":"none","Threshold":255},{"Id":1,"MonitoringFailure":"interface-monitoring","Threshold":0},{"Id":2,"MonitoringFailure":"none","Threshold":255}],"secondary_node_health":"Not healthy","status":"Green"},"config_status":"COMMITED","config_timestamp":1720182848,"config_version":1720182848,"cpu2_stat":{"idle":86,"interrupt":0,"load_avg":[0.13,0.17,0.16],"system":5,"user":9},"cpu_stat":{"idle":76,"interrupt":0,"load_avg":[0.18,0.31,0.39],"system":10,"user":14},"created_time":1711756611,"deviceprofile_id":"5e5daedf-e650-4013-b41c-845f0d2b9414","deviceprofile_name":"wan_srx_tor_hub1","dhcpd_stat":{"byod_dc1":{"num_ips":100,"num_leased":0},"corp_dc1":{"num_ips":100,"num_leased":4},"guest_dc1":{"num_ips":241,"num_leased":0},"iot_dc1":{"num_ips":100,"num_leased":0},"mgmt_dc1":{"num_ips":100,"num_leased":2},"teleworker":{"num_ips":140,"num_leased":0}},"ext_ip":"69.196.157.189","fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1718392692.580769,"will_retry":false},"has_pcap":false,"hostname":"wan_srx_tor_hub1-srx","id":"00000000-0000-0000-1000-4db14e107134","if_stat":{"ge-0/0/5.130":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-0/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0},"ge-1/0/5.120":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-1/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0}},"ip":"69.196.157.190","ip_stat":{"gateway":"69.196.157.185","ip":"69.196.157.190","ips":{"vlan1":"69.196.157.190,69.196.157.190"},"netmask":"255.255.255.255"},"is_ha":true,"last_seen":1720598726,"mac":"4db14e107134","mac_table_stats":{"mac_table_count":0,"max_mac_entries_supported":160000},"memory2_stat":{"usage":32},"memory_stat":{"usage":39},"model":"SRX300","modified_time":1720092942,"module2_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598717,"mac":"ec38739270c0","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV2218AF1505","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":64,"name":"Routing Engine CPU","status":"ok"}],"uptime":580964,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"secondary","vc_state":"active","version":"21.2R3-S6.11"}],"module_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598716.999985,"mac":"4db14e107134","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV0219AN0335","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":65,"name":"Routing Engine CPU","status":"ok"}],"uptime":1945193,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"primary","vc_state":"active","version":"21.2R3-S6.11"}],"name":"wan_srx_tor_hub1-srx","org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","route_summary_stats":{"fib_routes":0,"max_unicast_routes_supported":1240000,"rib_routes":0,"total_routes":0},"serial":"CV0219AN0335","service_stat":{},"service_status":{"appid_status":"enabled","appid_version":3720,"ewf_status":"disabled","idp_install_result":"successful","idp_install_timestamp":"2024-07-10T06:29:11.708164029Z","idp_status":"disabled","idp_update_timestamp":"2024-07-10T06:28:28.567046244Z"},"site_id":"83c31971-ad70-4419-ae20-7f2b90748986","spu2_stat":[{"spu_cpu":0,"spu_current_session":39,"spu_max_session":32768,"spu_memory":31,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"spu_stat":[{"spu_cpu":1,"spu_current_session":47,"spu_max_session":32768,"spu_memory":34,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"status":"connected","tag_id":3550217,"tag_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","type":"gateway","uptime":581259,"version":"21.2R3-S6.11"}]' - '[{"ap_redundancy":{"num_aps":1,"num_aps_with_switch_redundancy":1},"arp_table_stats":{"arp_table_count":16,"max_entries_supported":32000},"auto_upgrade_stat":{"lastcheck":1720600596},"cert_expiry":1743932274,"clients":[{"device_mac":"0912f561b653","mac":"001132f5ad23","port_id":"ge-1/0/11"}],"clients_stats":{"total":{"num_aps":[0,0],"num_wired_clients":13}},"config_status":"COMMITED","config_timestamp":1720552389,"config_version":1720552389,"cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"created_time":1712346090,"dhcpd_stat":{"ifo":{"num_ips":5,"num_leased":0}},"ext_ip":"153.142.221.41","fw_versions_outofsync":false,"fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1712409702.9714448,"will_retry":false},"has_pcap":true,"hostname":"SW-HLAB-ea2e00","hw_rev":"A","id":"00000000-0000-0000-1000-0912f561b653","if_stat":{"ge-0/0/5.0":{"port_id":"ge-0/0/5","rx_bytes":0,"rx_pkts":78110,"tx_bytes":0,"tx_pkts":61037,"up":true},"ge-1/0/0.0":{"port_id":"ge-1/0/0","rx_bytes":0,"rx_pkts":56415,"tx_bytes":0,"tx_pkts":72209,"up":true},"irb.172":{"ips":["10.3.172.41/24"],"port_id":"irb","rx_bytes":0,"rx_pkts":1291755,"servp_info":{},"tx_bytes":0,"tx_pkts":990327,"up":true,"vlan":172},"vme.0":{"port_id":"vme","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true}},"ip":"10.3.10.10","ip_stat":{"gateway":"10.3.172.9","ip":"10.3.10.10","ips":{"vlan172":"10.3.172.41"},"netmask":"255.255.255.255"},"last_seen":1720601189,"last_trouble":{"code":"103","timestamp":1712412455215},"mac":"0912f561b653","mac_table_stats":{"mac_table_count":58,"max_mac_entries_supported":64000},"memory_stat":{"usage":16},"model":"EX4100-F-12P","modified_time":1720552388,"module_stat":[{"boot_partition":"junos","cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"fpc_idx":0,"mac":"0912f561b653","memory_stat":{"usage":16},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":7.3},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0324AV0077","temperatures":[{"celsius":51,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":51,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":50,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":57,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/1","port_id":"vcp-0/1/0"},{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/0","port_id":"vcp-0/1/1"}],"vc_mode":"HiGiG","vc_role":"master","vc_state":"present","version":"22.4R3.25"},{"boot_partition":"junos","cpu_stat":{"idle":79,"interrupt":0,"load_avg":[0.52,0.46,0.46],"system":6,"user":15},"fpc_idx":1,"mac":"485a0deb2380","memory_stat":{"usage":14},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":22.1},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0424AV0101","temperatures":[{"celsius":52,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":53,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":52,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":59,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/1","port_id":"vcp-1/1/0"},{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/0","port_id":"vcp-1/1/1"}],"vc_mode":"HiGiG","vc_role":"backup","vc_state":"present","version":"22.4R3.25"}],"name":"SW-HLAB-ea2e00","org_id":"c5324060-19da-48fa-af28-2b530bd08765","route_summary_stats":{"fib_routes":7,"max_unicast_routes_supported":32150,"rib_routes":40,"total_routes":3},"serial":"FJ0324AV0077","site_id":"a0e43ffb-94a6-4f27-92aa-9cf832e1143d","status":"connected","tag_id":3564806,"tag_uuid":"507604a4-6b34-449c-acb3-87955430b006","type":"switch","uptime":1692720,"vc_mac":"0912f561b653","vc_setup_info":{"config_type":"nonprovisioned","err_missing_dev_id_fpc":false},"version":"22.4R3.25"}]' contentMediaType: application/json examples: Access Point Stats: value: - auto_upgrade_stat: lastcheck: 1720594762 ble_stat: beacon_enabled: true beacon_rate: 4 eddystone_uid_enabled: false eddystone_uid_freq_msec: 1000 eddystone_uid_instance: 5c5b35d0077b eddystone_uid_namespace: 9777c1a06ef611e68bbf eddystone_url_enabled: false eddystone_url_freq_msec: 1000 eddystone_url_url: '' ibeacon_enabled: false ibeacon_freq_msec: 1000 ibeacon_major: 894 ibeacon_minor: 9328 ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627 major: 894 minors: - 9328 - 9329 - 9330 - 9331 - 9332 - 9333 - 9334 - 9335 - -1 power: 8 rx_bytes: 158500843 rx_pkts: 3549163 tx_bytes: 509640 tx_pkts: 85411 tx_resets: 0 uuid: af010e2b-f829-4975-b49e-2e896ed1d627 config_reverted: false cpu_system: 21921854 cpu_user: 7496631 cpu_util: 5 created_time: 1718228350 env_stat: accel_x: -0.092 accel_y: 0.004 accel_z: -1.02 ambient_temp: 43 attitude: 0 cpu_temp: 53 humidity: 9 magne_x: 0 magne_y: 0 magne_z: 0 pressure: 968 vcore_voltage: 0 ext_ip: 66.129.234.28 hw_rev: C02 id: 00000000-0000-0000-1000-5c5b35d0077b inactive_wired_vlans: [] ip: 192.168.95.3 ip_stat: dhcp_server: 192.168.95.1 dns: - 8.8.8.8 gateway: 192.168.95.1 ip: 192.168.95.3 ip6: fe80:0:0:0:5e5b:35ff:fed0:77b ips: vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64 netmask: 255.255.255.0 netmask6: /64 last_seen: 1720595866 last_trouble: code: '07' timestamp: 1720039666 lldp_stat: chassis_id: d0:07:ca:f5:21:00 lldp_med_supported: false mgmt_addr: 100.123.105.1 mgmt_addrs: - 100.123.105.1 port_desc: ge-0/0/4 port_id: ge-0/0/4 power_allocated: 0 power_draw: 0 power_request_count: 0 power_requested: 0 system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.' system_name: Phoenix-Switch mac: 5c5b35d0077b mem_total_kb: 505468 mem_used_kb: 202096 model: AP43 modified_time: 1718530662 mount: faceup name: Phoenix notes: '' num_clients: 1 org_id: af010e2b-f829-4975-b49e-2e896ed1d627 port_stat: eth0: full_duplex: true rx_bytes: 1284143195 rx_errors: 0 rx_peak_bps: 17585 rx_pkts: 5199816 speed: 1000 tx_bytes: 1283744961 tx_peak_bps: 26484 tx_pkts: 3990463 up: true eth1: full_duplex: false rx_bytes: 0 rx_errors: 0 rx_peak_bps: 0 rx_pkts: 0 speed: 0 tx_bytes: 0 tx_peak_bps: 0 tx_pkts: 0 up: false power_budget: 8400 power_constrained: false power_src: DC Input radio_config: {} radio_stat: band_24: bandwidth: 20 channel: 11 mac: 5c5b35dea810 noise_floor: -80 num_clients: 0 power: 17 rx_bytes: 12948211 rx_pkts: 65292 tx_bytes: 19071943 tx_pkts: 76926 usage: '24' util_all: 24 util_non_wifi: 2 util_rx_in_bss: 0 util_rx_other_bss: 17 util_tx: 4 util_undecodable_wifi: 0 util_unknown_wifi: 1 band_5: bandwidth: 40 channel: 36 mac: 5c5b35dea7f0 noise_floor: -90 num_clients: 1 power: 17 rx_bytes: 578362619 rx_pkts: 2687577 tx_bytes: 1199571353 tx_pkts: 2479302 usage: '5' util_all: 13 util_non_wifi: 0 util_rx_in_bss: 0 util_rx_other_bss: 10 util_tx: 1 util_undecodable_wifi: 0 util_unknown_wifi: 1 rx_bps: 9276 rx_bytes: 591310830 rx_pkts: 2752869 serial: A0703200709E6 site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4 status: connected switch_redundancy: num_redundant_aps: 1 tx_bps: 8067 tx_bytes: 1218643296 tx_pkts: 2556228 type: ap uptime: 1593120 version: 0.14.29313 Gateway Stats: value: - arp_table_stats: arp_table_count: 21 max_entries_supported: 64000 auto_upgrade_stat: lastcheck: 1720595477 cert_expiry: 1743292763 cluster_config: configuration: active-active control_link_info: name: fxp1 status: Up ethernet_connection: - name: reth0 status: Up - name: reth1 status: Up - name: reth2 status: Down - name: reth3 status: Down - name: reth4 status: Up fabric_link_info: DataPlaneNotifiedStatus: Up Interface: [] InternalStatus: Up State: Enabled Status: Enabled last_status_change_reason: No failures operational: active-active primary_node_health: Healthy redundancy_group_information: - Id: 0 MonitoringFailure: none Threshold: 255 - Id: 1 MonitoringFailure: interface-monitoring Threshold: 0 - Id: 2 MonitoringFailure: none Threshold: 255 secondary_node_health: Not healthy status: Green config_status: COMMITED config_timestamp: 1720182848 config_version: 1720182848 cpu2_stat: idle: 86 interrupt: 0 load_avg: - 0.13 - 0.17 - 0.16 system: 5 user: 9 cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.18 - 0.31 - 0.39 system: 10 user: 14 created_time: 1711756611 deviceprofile_id: 5e5daedf-e650-4013-b41c-845f0d2b9414 deviceprofile_name: wan_srx_tor_hub1 dhcpd_stat: byod_dc1: num_ips: 100 num_leased: 0 corp_dc1: num_ips: 100 num_leased: 4 guest_dc1: num_ips: 241 num_leased: 0 iot_dc1: num_ips: 100 num_leased: 0 mgmt_dc1: num_ips: 100 num_leased: 2 teleworker: num_ips: 140 num_leased: 0 ext_ip: 69.196.157.189 fwupdate: progress: 100 status: upgraded status_id: 3037 timestamp: 1718392692.580769 will_retry: false has_pcap: false hostname: wan_srx_tor_hub1-srx id: 00000000-0000-0000-1000-4db14e107134 if_stat: ge-0/0/5.130: address_mode: Unknown nat_addresses: [] network_name: '' port_id: ge-0/0/5 port_usage: lan rx_bytes: 0 rx_pkts: 0 tx_bytes: 0 tx_pkts: 0 up: true vlan: 0 ge-1/0/5.120: address_mode: Unknown nat_addresses: [] network_name: '' port_id: ge-1/0/5 port_usage: lan rx_bytes: 0 rx_pkts: 0 tx_bytes: 0 tx_pkts: 0 up: true vlan: 0 ip: 69.196.157.190 ip_stat: gateway: 69.196.157.185 ip: 69.196.157.190 ips: vlan1: 69.196.157.190,69.196.157.190 netmask: 255.255.255.255 is_ha: true last_seen: 1720598726 mac: 4db14e107134 mac_table_stats: mac_table_count: 0 max_mac_entries_supported: 160000 memory2_stat: usage: 32 memory_stat: usage: 39 model: SRX300 modified_time: 1720092942 module2_stat: - backup_version: 21.2R3-S7.7 fans: [] last_seen: 1720598717 mac: ec38739270c0 model: SRX300 psus: - name: Power Supply 0 status: ok recovery_version: 21.2R3-S7.7 serial: CV2218AF1505 status: connected temperatures: - celsius: 49 name: Routing Engine status: ok - celsius: 64 name: Routing Engine CPU status: ok uptime: 580964 vc_links: - neighbor_module_idx: 0 neighbor_port_id: fxp1 port_id: fxp1 vc_role: secondary vc_state: active version: 21.2R3-S6.11 module_stat: - backup_version: 21.2R3-S7.7 fans: [] last_seen: 1720598716.999985 mac: 4db14e107134 model: SRX300 psus: - name: Power Supply 0 status: ok recovery_version: 21.2R3-S7.7 serial: CV0219AN0335 status: connected temperatures: - celsius: 49 name: Routing Engine status: ok - celsius: 65 name: Routing Engine CPU status: ok uptime: 1945193 vc_links: - neighbor_module_idx: 1 neighbor_port_id: fxp1 port_id: fxp1 vc_role: primary vc_state: active version: 21.2R3-S6.11 name: wan_srx_tor_hub1-srx org_id: af010e2b-f829-4975-b49e-2e896ed1d627 route_summary_stats: fib_routes: 0 max_unicast_routes_supported: 1240000 rib_routes: 0 total_routes: 0 serial: CV0219AN0335 service_stat: {} service_status: appid_status: enabled appid_version: 3720 ewf_status: disabled idp_install_result: successful idp_install_timestamp: 2024-07-10 06:29:11.708164+00:00 idp_status: disabled idp_update_timestamp: 2024-07-10 06:28:28.567046+00:00 site_id: 83c31971-ad70-4419-ae20-7f2b90748986 spu2_stat: - spu_cpu: 0 spu_current_session: 39 spu_max_session: 32768 spu_memory: 31 spu_pending_session: 0 spu_uptime: 1944572 spu_valid_session: 0 spu_stat: - spu_cpu: 1 spu_current_session: 47 spu_max_session: 32768 spu_memory: 34 spu_pending_session: 0 spu_uptime: 1944572 spu_valid_session: 0 status: connected tag_id: 3550217 tag_uuid: af010e2b-f829-4975-b49e-2e896ed1d627 type: gateway uptime: 581259 version: 21.2R3-S6.11 Switch: value: - ap_redundancy: num_aps: 1 num_aps_with_switch_redundancy: 1 arp_table_stats: arp_table_count: 16 max_entries_supported: 32000 auto_upgrade_stat: lastcheck: 1720600596 cert_expiry: 1743932274 clients: - device_mac: 0912f561b653 mac: 001132f5ad23 port_id: ge-1/0/11 clients_stats: total: num_aps: - 0 - 0 num_wired_clients: 13 config_status: COMMITED config_timestamp: 1720552389 config_version: 1720552389 cpu_stat: idle: 74 interrupt: 0 load_avg: - 0.8 - 0.75 - 0.78 system: 13 user: 13 created_time: 1712346090 dhcpd_stat: ifo: num_ips: 5 num_leased: 0 ext_ip: 153.142.221.41 fw_versions_outofsync: false fwupdate: progress: 100 status: upgraded status_id: 3037 timestamp: 1712409702.9714448 will_retry: false has_pcap: true hostname: SW-HLAB-ea2e00 hw_rev: A id: 00000000-0000-0000-1000-0912f561b653 if_stat: ge-0/0/5.0: port_id: ge-0/0/5 rx_bytes: 0 rx_pkts: 78110 tx_bytes: 0 tx_pkts: 61037 up: true ge-1/0/0.0: port_id: ge-1/0/0 rx_bytes: 0 rx_pkts: 56415 tx_bytes: 0 tx_pkts: 72209 up: true irb.172: ips: - 10.3.172.41/24 port_id: irb rx_bytes: 0 rx_pkts: 1291755 servp_info: {} tx_bytes: 0 tx_pkts: 990327 up: true vlan: 172 vme.0: port_id: vme rx_bytes: 0 rx_pkts: 0 tx_bytes: 0 tx_pkts: 0 up: true ip: 10.3.10.10 ip_stat: gateway: 10.3.172.9 ip: 10.3.10.10 ips: vlan172: 10.3.172.41 netmask: 255.255.255.255 last_seen: 1720601189 last_trouble: code: '103' timestamp: 1712412455215 mac: 0912f561b653 mac_table_stats: mac_table_count: 58 max_mac_entries_supported: 64000 memory_stat: usage: 16 model: EX4100-F-12P modified_time: 1720552388 module_stat: - boot_partition: junos cpu_stat: idle: 74 interrupt: 0 load_avg: - 0.8 - 0.75 - 0.78 system: 13 user: 13 fpc_idx: 0 mac: 0912f561b653 memory_stat: usage: 16 model: EX4100-F-12P pics: - index: 0 model_number: EX4100-F-12P port_groups: - count: 12 type: GE - index: 1 model_number: EX4100-F-12P port_groups: - count: 4 type: SFP/SFP+ - index: 2 model_number: EX4100-F-12P port_groups: - count: 2 type: GE poe: max_power: 180 power_draw: 7.3 psus: - name: Power Supply 0 status: ok - name: Power Supply 1 status: absent - name: Power Supply 2 status: absent serial: FJ0324AV0077 temperatures: - celsius: 51 name: Thermal board Sensor 1 status: ok - celsius: 51 name: Thermal board Sensor 2 status: ok - celsius: 50 name: Thermal board Sensor 3 status: ok - celsius: 57 name: PFE Die Sensor status: ok type: fpc uptime: 1692720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/1 port_id: vcp-0/1/0 - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/1 vc_mode: HiGiG vc_role: master vc_state: present version: 22.4R3.25 - boot_partition: junos cpu_stat: idle: 79 interrupt: 0 load_avg: - 0.52 - 0.46 - 0.46 system: 6 user: 15 fpc_idx: 1 mac: 485a0deb2380 memory_stat: usage: 14 model: EX4100-F-12P pics: - index: 0 model_number: EX4100-F-12P port_groups: - count: 12 type: GE - index: 1 model_number: EX4100-F-12P port_groups: - count: 4 type: SFP/SFP+ - index: 2 model_number: EX4100-F-12P port_groups: - count: 2 type: GE poe: max_power: 180 power_draw: 22.1 psus: - name: Power Supply 0 status: ok - name: Power Supply 1 status: absent - name: Power Supply 2 status: absent serial: FJ0424AV0101 temperatures: - celsius: 52 name: Thermal board Sensor 1 status: ok - celsius: 53 name: Thermal board Sensor 2 status: ok - celsius: 52 name: Thermal board Sensor 3 status: ok - celsius: 59 name: PFE Die Sensor status: ok type: fpc uptime: 1692720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/1 port_id: vcp-1/1/0 - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/1 vc_mode: HiGiG vc_role: backup vc_state: present version: 22.4R3.25 name: SW-HLAB-ea2e00 org_id: c5324060-19da-48fa-af28-2b530bd08765 route_summary_stats: fib_routes: 7 max_unicast_routes_supported: 32150 rib_routes: 40 total_routes: 3 serial: FJ0324AV0077 site_id: a0e43ffb-94a6-4f27-92aa-9cf832e1143d status: connected tag_id: 3564806 tag_uuid: 507604a4-6b34-449c-acb3-87955430b006 type: switch uptime: 1692720 vc_mac: 0912f561b653 vc_setup_info: config_type: nonprovisioned err_missing_dev_id_fpc: false version: 22.4R3.25 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/stats_device' description: Device statistics records returned by a stats response examples: - '[{"auto_upgrade_stat":{"lastcheck":1720594762},"ble_stat":{"beacon_enabled":true,"beacon_rate":4,"eddystone_uid_enabled":false,"eddystone_uid_freq_msec":1000,"eddystone_uid_instance":"5c5b35d0077b","eddystone_uid_namespace":"9777c1a06ef611e68bbf","eddystone_url_enabled":false,"eddystone_url_freq_msec":1000,"eddystone_url_url":"","ibeacon_enabled":false,"ibeacon_freq_msec":1000,"ibeacon_major":894,"ibeacon_minor":9328,"ibeacon_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","major":894,"minors":[9328,9329,9330,9331,9332,9333,9334,9335,-1],"power":8,"rx_bytes":158500843,"rx_pkts":3549163,"tx_bytes":509640,"tx_pkts":85411,"tx_resets":0,"uuid":"af010e2b-f829-4975-b49e-2e896ed1d627"},"config_reverted":false,"cpu_system":21921854,"cpu_user":7496631,"cpu_util":5,"created_time":1718228350,"env_stat":{"accel_x":-0.092,"accel_y":0.004,"accel_z":-1.02,"ambient_temp":43,"attitude":0,"cpu_temp":53,"humidity":9,"magne_x":0,"magne_y":0,"magne_z":0,"pressure":968,"vcore_voltage":0},"ext_ip":"66.129.234.28","hw_rev":"C02","id":"00000000-0000-0000-1000-5c5b35d0077b","inactive_wired_vlans":[],"ip":"192.168.95.3","ip_stat":{"dhcp_server":"192.168.95.1","dns":["8.8.8.8"],"gateway":"192.168.95.1","ip":"192.168.95.3","ip6":"fe80:0:0:0:5e5b:35ff:fed0:77b","ips":{"vlan1":"192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64"},"netmask":"255.255.255.0","netmask6":"/64"},"last_seen":1720595866,"last_trouble":{"code":"07","timestamp":1720039666},"lldp_stat":{"chassis_id":"d0:07:ca:f5:21:00","lldp_med_supported":false,"mgmt_addr":"100.123.105.1","mgmt_addrs":["100.123.105.1"],"port_desc":"ge-0/0/4","port_id":"ge-0/0/4","power_allocated":0,"power_draw":0,"power_request_count":0,"power_requested":0,"system_desc":"Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.","system_name":"Phoenix-Switch"},"mac":"5c5b35d0077b","mem_total_kb":505468,"mem_used_kb":202096,"model":"AP43","modified_time":1718530662,"mount":"faceup","name":"Phoenix","notes":"","num_clients":1,"org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","port_stat":{"eth0":{"full_duplex":true,"rx_bytes":1284143195,"rx_errors":0,"rx_peak_bps":17585,"rx_pkts":5199816,"speed":1000,"tx_bytes":1283744961,"tx_peak_bps":26484,"tx_pkts":3990463,"up":true},"eth1":{"full_duplex":false,"rx_bytes":0,"rx_errors":0,"rx_peak_bps":0,"rx_pkts":0,"speed":0,"tx_bytes":0,"tx_peak_bps":0,"tx_pkts":0,"up":false}},"power_budget":8400,"power_constrained":false,"power_src":"DC Input","radio_config":{},"radio_stat":{"band_24":{"bandwidth":20,"channel":11,"mac":"5c5b35dea810","noise_floor":-80,"num_clients":0,"power":17,"rx_bytes":12948211,"rx_pkts":65292,"tx_bytes":19071943,"tx_pkts":76926,"usage":"24","util_all":24,"util_non_wifi":2,"util_rx_in_bss":0,"util_rx_other_bss":17,"util_tx":4,"util_undecodable_wifi":0,"util_unknown_wifi":1},"band_5":{"bandwidth":40,"channel":36,"mac":"5c5b35dea7f0","noise_floor":-90,"num_clients":1,"power":17,"rx_bytes":578362619,"rx_pkts":2687577,"tx_bytes":1199571353,"tx_pkts":2479302,"usage":"5","util_all":13,"util_non_wifi":0,"util_rx_in_bss":0,"util_rx_other_bss":10,"util_tx":1,"util_undecodable_wifi":0,"util_unknown_wifi":1}},"rx_bps":9276,"rx_bytes":591310830,"rx_pkts":2752869,"serial":"A0703200709E6","site_id":"46fc665e-9706-4296-8fe2-78f42f2e67e4","status":"connected","switch_redundancy":{"num_redundant_aps":1},"tx_bps":8067,"tx_bytes":1218643296,"tx_pkts":2556228,"type":"ap","uptime":1593120,"version":"0.14.29313"}]' - '[{"arp_table_stats":{"arp_table_count":21,"max_entries_supported":64000},"auto_upgrade_stat":{"lastcheck":1720595477},"cert_expiry":1743292763,"cluster_config":{"configuration":"active-active","control_link_info":{"name":"fxp1","status":"Up"},"ethernet_connection":[{"name":"reth0","status":"Up"},{"name":"reth1","status":"Up"},{"name":"reth2","status":"Down"},{"name":"reth3","status":"Down"},{"name":"reth4","status":"Up"}],"fabric_link_info":{"DataPlaneNotifiedStatus":"Up","Interface":[],"InternalStatus":"Up","State":"Enabled","Status":"Enabled"},"last_status_change_reason":"No failures","operational":"active-active","primary_node_health":"Healthy","redundancy_group_information":[{"Id":0,"MonitoringFailure":"none","Threshold":255},{"Id":1,"MonitoringFailure":"interface-monitoring","Threshold":0},{"Id":2,"MonitoringFailure":"none","Threshold":255}],"secondary_node_health":"Not healthy","status":"Green"},"config_status":"COMMITED","config_timestamp":1720182848,"config_version":1720182848,"cpu2_stat":{"idle":86,"interrupt":0,"load_avg":[0.13,0.17,0.16],"system":5,"user":9},"cpu_stat":{"idle":76,"interrupt":0,"load_avg":[0.18,0.31,0.39],"system":10,"user":14},"created_time":1711756611,"deviceprofile_id":"5e5daedf-e650-4013-b41c-845f0d2b9414","deviceprofile_name":"wan_srx_tor_hub1","dhcpd_stat":{"byod_dc1":{"num_ips":100,"num_leased":0},"corp_dc1":{"num_ips":100,"num_leased":4},"guest_dc1":{"num_ips":241,"num_leased":0},"iot_dc1":{"num_ips":100,"num_leased":0},"mgmt_dc1":{"num_ips":100,"num_leased":2},"teleworker":{"num_ips":140,"num_leased":0}},"ext_ip":"69.196.157.189","fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1718392692.580769,"will_retry":false},"has_pcap":false,"hostname":"wan_srx_tor_hub1-srx","id":"00000000-0000-0000-1000-4db14e107134","if_stat":{"ge-0/0/5.130":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-0/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0},"ge-1/0/5.120":{"address_mode":"Unknown","nat_addresses":[],"network_name":"","port_id":"ge-1/0/5","port_usage":"lan","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true,"vlan":0}},"ip":"69.196.157.190","ip_stat":{"gateway":"69.196.157.185","ip":"69.196.157.190","ips":{"vlan1":"69.196.157.190,69.196.157.190"},"netmask":"255.255.255.255"},"is_ha":true,"last_seen":1720598726,"mac":"4db14e107134","mac_table_stats":{"mac_table_count":0,"max_mac_entries_supported":160000},"memory2_stat":{"usage":32},"memory_stat":{"usage":39},"model":"SRX300","modified_time":1720092942,"module2_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598717,"mac":"ec38739270c0","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV2218AF1505","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":64,"name":"Routing Engine CPU","status":"ok"}],"uptime":580964,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"secondary","vc_state":"active","version":"21.2R3-S6.11"}],"module_stat":[{"backup_version":"21.2R3-S7.7","fans":[],"last_seen":1720598716.999985,"mac":"4db14e107134","model":"SRX300","psus":[{"name":"Power Supply 0","status":"ok"}],"recovery_version":"21.2R3-S7.7","serial":"CV0219AN0335","status":"connected","temperatures":[{"celsius":49,"name":"Routing Engine","status":"ok"},{"celsius":65,"name":"Routing Engine CPU","status":"ok"}],"uptime":1945193,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"fxp1","port_id":"fxp1"}],"vc_role":"primary","vc_state":"active","version":"21.2R3-S6.11"}],"name":"wan_srx_tor_hub1-srx","org_id":"af010e2b-f829-4975-b49e-2e896ed1d627","route_summary_stats":{"fib_routes":0,"max_unicast_routes_supported":1240000,"rib_routes":0,"total_routes":0},"serial":"CV0219AN0335","service_stat":{},"service_status":{"appid_status":"enabled","appid_version":3720,"ewf_status":"disabled","idp_install_result":"successful","idp_install_timestamp":"2024-07-10T06:29:11.708164029Z","idp_status":"disabled","idp_update_timestamp":"2024-07-10T06:28:28.567046244Z"},"site_id":"83c31971-ad70-4419-ae20-7f2b90748986","spu2_stat":[{"spu_cpu":0,"spu_current_session":39,"spu_max_session":32768,"spu_memory":31,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"spu_stat":[{"spu_cpu":1,"spu_current_session":47,"spu_max_session":32768,"spu_memory":34,"spu_pending_session":0,"spu_uptime":1944572,"spu_valid_session":0}],"status":"connected","tag_id":3550217,"tag_uuid":"af010e2b-f829-4975-b49e-2e896ed1d627","type":"gateway","uptime":581259,"version":"21.2R3-S6.11"}]' - '[{"ap_redundancy":{"num_aps":1,"num_aps_with_switch_redundancy":1},"arp_table_stats":{"arp_table_count":16,"max_entries_supported":32000},"auto_upgrade_stat":{"lastcheck":1720600596},"cert_expiry":1743932274,"clients":[{"device_mac":"0912f561b653","mac":"001132f5ad23","port_id":"ge-1/0/11"}],"clients_stats":{"total":{"num_aps":[0,0],"num_wired_clients":13}},"config_status":"COMMITED","config_timestamp":1720552389,"config_version":1720552389,"cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"created_time":1712346090,"dhcpd_stat":{"ifo":{"num_ips":5,"num_leased":0}},"ext_ip":"153.142.221.41","fw_versions_outofsync":false,"fwupdate":{"progress":100,"status":"upgraded","status_id":3037,"timestamp":1712409702.9714448,"will_retry":false},"has_pcap":true,"hostname":"SW-HLAB-ea2e00","hw_rev":"A","id":"00000000-0000-0000-1000-0912f561b653","if_stat":{"ge-0/0/5.0":{"port_id":"ge-0/0/5","rx_bytes":0,"rx_pkts":78110,"tx_bytes":0,"tx_pkts":61037,"up":true},"ge-1/0/0.0":{"port_id":"ge-1/0/0","rx_bytes":0,"rx_pkts":56415,"tx_bytes":0,"tx_pkts":72209,"up":true},"irb.172":{"ips":["10.3.172.41/24"],"port_id":"irb","rx_bytes":0,"rx_pkts":1291755,"servp_info":{},"tx_bytes":0,"tx_pkts":990327,"up":true,"vlan":172},"vme.0":{"port_id":"vme","rx_bytes":0,"rx_pkts":0,"tx_bytes":0,"tx_pkts":0,"up":true}},"ip":"10.3.10.10","ip_stat":{"gateway":"10.3.172.9","ip":"10.3.10.10","ips":{"vlan172":"10.3.172.41"},"netmask":"255.255.255.255"},"last_seen":1720601189,"last_trouble":{"code":"103","timestamp":1712412455215},"mac":"0912f561b653","mac_table_stats":{"mac_table_count":58,"max_mac_entries_supported":64000},"memory_stat":{"usage":16},"model":"EX4100-F-12P","modified_time":1720552388,"module_stat":[{"boot_partition":"junos","cpu_stat":{"idle":74,"interrupt":0,"load_avg":[0.8,0.75,0.78],"system":13,"user":13},"fpc_idx":0,"mac":"0912f561b653","memory_stat":{"usage":16},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":7.3},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0324AV0077","temperatures":[{"celsius":51,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":51,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":50,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":57,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/1","port_id":"vcp-0/1/0"},{"neighbor_module_idx":1,"neighbor_port_id":"vcp-1/1/0","port_id":"vcp-0/1/1"}],"vc_mode":"HiGiG","vc_role":"master","vc_state":"present","version":"22.4R3.25"},{"boot_partition":"junos","cpu_stat":{"idle":79,"interrupt":0,"load_avg":[0.52,0.46,0.46],"system":6,"user":15},"fpc_idx":1,"mac":"485a0deb2380","memory_stat":{"usage":14},"model":"EX4100-F-12P","pics":[{"index":0,"model_number":"EX4100-F-12P","port_groups":[{"count":12,"type":"GE"}]},{"index":1,"model_number":"EX4100-F-12P","port_groups":[{"count":4,"type":"SFP/SFP+"}]},{"index":2,"model_number":"EX4100-F-12P","port_groups":[{"count":2,"type":"GE"}]}],"poe":{"max_power":180,"power_draw":22.1},"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"absent"},{"name":"Power Supply 2","status":"absent"}],"serial":"FJ0424AV0101","temperatures":[{"celsius":52,"name":"Thermal board Sensor 1","status":"ok"},{"celsius":53,"name":"Thermal board Sensor 2","status":"ok"},{"celsius":52,"name":"Thermal board Sensor 3","status":"ok"},{"celsius":59,"name":"PFE Die Sensor","status":"ok"}],"type":"fpc","uptime":1692720,"vc_links":[{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/1","port_id":"vcp-1/1/0"},{"neighbor_module_idx":0,"neighbor_port_id":"vcp-0/1/0","port_id":"vcp-1/1/1"}],"vc_mode":"HiGiG","vc_role":"backup","vc_state":"present","version":"22.4R3.25"}],"name":"SW-HLAB-ea2e00","org_id":"c5324060-19da-48fa-af28-2b530bd08765","route_summary_stats":{"fib_routes":7,"max_unicast_routes_supported":32150,"rib_routes":40,"total_routes":3},"serial":"FJ0324AV0077","site_id":"a0e43ffb-94a6-4f27-92aa-9cf832e1143d","status":"connected","tag_id":3564806,"tag_uuid":"507604a4-6b34-449c-acb3-87955430b006","type":"switch","uptime":1692720,"vc_mac":"0912f561b653","vc_setup_info":{"config_type":"nonprovisioned","err_missing_dev_id_fpc":false},"version":"22.4R3.25"}]' contentMediaType: application/vnd.api+json examples: Access Point Stats: value: - auto_upgrade_stat: lastcheck: 1720594762 ble_stat: beacon_enabled: true beacon_rate: 4 eddystone_uid_enabled: false eddystone_uid_freq_msec: 1000 eddystone_uid_instance: 5c5b35d0077b eddystone_uid_namespace: 9777c1a06ef611e68bbf eddystone_url_enabled: false eddystone_url_freq_msec: 1000 eddystone_url_url: '' ibeacon_enabled: false ibeacon_freq_msec: 1000 ibeacon_major: 894 ibeacon_minor: 9328 ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627 major: 894 minors: - 9328 - 9329 - 9330 - 9331 - 9332 - 9333 - 9334 - 9335 - -1 power: 8 rx_bytes: 158500843 rx_pkts: 3549163 tx_bytes: 509640 tx_pkts: 85411 tx_resets: 0 uuid: af010e2b-f829-4975-b49e-2e896ed1d627 config_reverted: false cpu_system: 21921854 cpu_user: 7496631 cpu_util: 5 created_time: 1718228350 env_stat: accel_x: -0.092 accel_y: 0.004 accel_z: -1.02 ambient_temp: 43 attitude: 0 cpu_temp: 53 humidity: 9 magne_x: 0 magne_y: 0 magne_z: 0 pressure: 968 vcore_voltage: 0 ext_ip: 66.129.234.28 hw_rev: C02 id: 00000000-0000-0000-1000-5c5b35d0077b inactive_wired_vlans: [] ip: 192.168.95.3 ip_stat: dhcp_server: 192.168.95.1 dns: - 8.8.8.8 gateway: 192.168.95.1 ip: 192.168.95.3 ip6: fe80:0:0:0:5e5b:35ff:fed0:77b ips: vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64 netmask: 255.255.255.0 netmask6: /64 last_seen: 1720595866 last_trouble: code: '07' timestamp: 1720039666 lldp_stat: chassis_id: d0:07:ca:f5:21:00 lldp_med_supported: false mgmt_addr: 100.123.105.1 mgmt_addrs: - 100.123.105.1 port_desc: ge-0/0/4 port_id: ge-0/0/4 power_allocated: 0 power_draw: 0 power_request_count: 0 power_requested: 0 system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.' system_name: Phoenix-Switch mac: 5c5b35d0077b mem_total_kb: 505468 mem_used_kb: 202096 model: AP43 modified_time: 1718530662 mount: faceup name: Phoenix notes: '' num_clients: 1 org_id: af010e2b-f829-4975-b49e-2e896ed1d627 port_stat: eth0: full_duplex: true rx_bytes: 1284143195 rx_errors: 0 rx_peak_bps: 17585 rx_pkts: 5199816 speed: 1000 tx_bytes: 1283744961 tx_peak_bps: 26484 tx_pkts: 3990463 up: true eth1: full_duplex: false rx_bytes: 0 rx_errors: 0 rx_peak_bps: 0 rx_pkts: 0 speed: 0 tx_bytes: 0 tx_peak_bps: 0 tx_pkts: 0 up: false power_budget: 8400 power_constrained: false power_src: DC Input radio_config: {} radio_stat: band_24: bandwidth: 20 channel: 11 mac: 5c5b35dea810 noise_floor: -80 num_clients: 0 power: 17 rx_bytes: 12948211 rx_pkts: 65292 tx_bytes: 19071943 tx_pkts: 76926 usage: '24' util_all: 24 util_non_wifi: 2 util_rx_in_bss: 0 util_rx_other_bss: 17 util_tx: 4 util_undecodable_wifi: 0 util_unknown_wifi: 1 band_5: bandwidth: 40 channel: 36 mac: 5c5b35dea7f0 noise_floor: -90 num_clients: 1 power: 17 rx_bytes: 578362619 rx_pkts: 2687577 tx_bytes: 1199571353 tx_pkts: 2479302 usage: '5' util_all: 13 util_non_wifi: 0 util_rx_in_bss: 0 util_rx_other_bss: 10 util_tx: 1 util_undecodable_wifi: 0 util_unknown_wifi: 1 rx_bps: 9276 rx_bytes: 591310830 rx_pkts: 2752869 serial: A0703200709E6 site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4 status: connected switch_redundancy: num_redundant_aps: 1 tx_bps: 8067 tx_bytes: 1218643296 tx_pkts: 2556228 type: ap uptime: 1593120 version: 0.14.29313 Gateway Stats: value: - arp_table_stats: arp_table_count: 21 max_entries_supported: 64000 auto_upgrade_stat: lastcheck: 1720595477 cert_expiry: 1743292763 cluster_config: configuration: active-active control_link_info: name: fxp1 status: Up ethernet_connection: - name: reth0 status: Up - name: reth1 status: Up - name: reth2 status: Down - name: reth3 status: Down - name: reth4 status: Up fabric_link_info: DataPlaneNotifiedStatus: Up Interface: [] InternalStatus: Up State: Enabled Status: Enabled last_status_change_reason: No failures operational: active-active primary_node_health: Healthy redundancy_group_information: - Id: 0 MonitoringFailure: none Threshold: 255 - Id: 1 MonitoringFailure: interface-monitoring Threshold: 0 - Id: 2 MonitoringFailure: none Threshold: 255 secondary_node_health: Not healthy status: Green config_status: COMMITED config_timestamp: 1720182848 config_version: 1720182848 cpu2_stat: idle: 86 interrupt: 0 load_avg: - 0.13 - 0.17 - 0.16 system: 5 user: 9 cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.18 - 0.31 - 0.39 system: 10 user: 14 created_time: 1711756611 deviceprofile_id: 5e5daedf-e650-4013-b41c-845f0d2b9414 deviceprofile_name: wan_srx_tor_hub1 dhcpd_stat: byod_dc1: num_ips: 100 num_leased: 0 corp_dc1: num_ips: 100 num_leased: 4 guest_dc1: num_ips: 241 num_leased: 0 iot_dc1: num_ips: 100 num_leased: 0 mgmt_dc1: num_ips: 100 num_leased: 2 teleworker: num_ips: 140 num_leased: 0 ext_ip: 69.196.157.189 fwupdate: progress: 100 status: upgraded status_id: 3037 timestamp: 1718392692.580769 will_retry: false has_pcap: false hostname: wan_srx_tor_hub1-srx id: 00000000-0000-0000-1000-4db14e107134 if_stat: ge-0/0/5.130: address_mode: Unknown nat_addresses: [] network_name: '' port_id: ge-0/0/5 port_usage: lan rx_bytes: 0 rx_pkts: 0 tx_bytes: 0 tx_pkts: 0 up: true vlan: 0 ge-1/0/5.120: address_mode: Unknown nat_addresses: [] network_name: '' port_id: ge-1/0/5 port_usage: lan rx_bytes: 0 rx_pkts: 0 tx_bytes: 0 tx_pkts: 0 up: true vlan: 0 ip: 69.196.157.190 ip_stat: gateway: 69.196.157.185 ip: 69.196.157.190 ips: vlan1: 69.196.157.190,69.196.157.190 netmask: 255.255.255.255 is_ha: true last_seen: 1720598726 mac: 4db14e107134 mac_table_stats: mac_table_count: 0 max_mac_entries_supported: 160000 memory2_stat: usage: 32 memory_stat: usage: 39 model: SRX300 modified_time: 1720092942 module2_stat: - backup_version: 21.2R3-S7.7 fans: [] last_seen: 1720598717 mac: ec38739270c0 model: SRX300 psus: - name: Power Supply 0 status: ok recovery_version: 21.2R3-S7.7 serial: CV2218AF1505 status: connected temperatures: - celsius: 49 name: Routing Engine status: ok - celsius: 64 name: Routing Engine CPU status: ok uptime: 580964 vc_links: - neighbor_module_idx: 0 neighbor_port_id: fxp1 port_id: fxp1 vc_role: secondary vc_state: active version: 21.2R3-S6.11 module_stat: - backup_version: 21.2R3-S7.7 fans: [] last_seen: 1720598716.999985 mac: 4db14e107134 model: SRX300 psus: - name: Power Supply 0 status: ok recovery_version: 21.2R3-S7.7 serial: CV0219AN0335 status: connected temperatures: - celsius: 49 name: Routing Engine status: ok - celsius: 65 name: Routing Engine CPU status: ok uptime: 1945193 vc_links: - neighbor_module_idx: 1 neighbor_port_id: fxp1 port_id: fxp1 vc_role: primary vc_state: active version: 21.2R3-S6.11 name: wan_srx_tor_hub1-srx org_id: af010e2b-f829-4975-b49e-2e896ed1d627 route_summary_stats: fib_routes: 0 max_unicast_routes_supported: 1240000 rib_routes: 0 total_routes: 0 serial: CV0219AN0335 service_stat: {} service_status: appid_status: enabled appid_version: 3720 ewf_status: disabled idp_install_result: successful idp_install_timestamp: 2024-07-10 06:29:11.708164+00:00 idp_status: disabled idp_update_timestamp: 2024-07-10 06:28:28.567046+00:00 site_id: 83c31971-ad70-4419-ae20-7f2b90748986 spu2_stat: - spu_cpu: 0 spu_current_session: 39 spu_max_session: 32768 spu_memory: 31 spu_pending_session: 0 spu_uptime: 1944572 spu_valid_session: 0 spu_stat: - spu_cpu: 1 spu_current_session: 47 spu_max_session: 32768 spu_memory: 34 spu_pending_session: 0 spu_uptime: 1944572 spu_valid_session: 0 status: connected tag_id: 3550217 tag_uuid: af010e2b-f829-4975-b49e-2e896ed1d627 type: gateway uptime: 581259 version: 21.2R3-S6.11 Switch: value: - ap_redundancy: num_aps: 1 num_aps_with_switch_redundancy: 1 arp_table_stats: arp_table_count: 16 max_entries_supported: 32000 auto_upgrade_stat: lastcheck: 1720600596 cert_expiry: 1743932274 clients: - device_mac: 0912f561b653 mac: 001132f5ad23 port_id: ge-1/0/11 clients_stats: total: num_aps: - 0 - 0 num_wired_clients: 13 config_status: COMMITED config_timestamp: 1720552389 config_version: 1720552389 cpu_stat: idle: 74 interrupt: 0 load_avg: - 0.8 - 0.75 - 0.78 system: 13 user: 13 created_time: 1712346090 dhcpd_stat: ifo: num_ips: 5 num_leased: 0 ext_ip: 153.142.221.41 fw_versions_outofsync: false fwupdate: progress: 100 status: upgraded status_id: 3037 timestamp: 1712409702.9714448 will_retry: false has_pcap: true hostname: SW-HLAB-ea2e00 hw_rev: A id: 00000000-0000-0000-1000-0912f561b653 if_stat: ge-0/0/5.0: port_id: ge-0/0/5 rx_bytes: 0 rx_pkts: 78110 tx_bytes: 0 tx_pkts: 61037 up: true ge-1/0/0.0: port_id: ge-1/0/0 rx_bytes: 0 rx_pkts: 56415 tx_bytes: 0 tx_pkts: 72209 up: true irb.172: ips: - 10.3.172.41/24 port_id: irb rx_bytes: 0 rx_pkts: 1291755 servp_info: {} tx_bytes: 0 tx_pkts: 990327 up: true vlan: 172 vme.0: port_id: vme rx_bytes: 0 rx_pkts: 0 tx_bytes: 0 tx_pkts: 0 up: true ip: 10.3.10.10 ip_stat: gateway: 10.3.172.9 ip: 10.3.10.10 ips: vlan172: 10.3.172.41 netmask: 255.255.255.255 last_seen: 1720601189 last_trouble: code: '103' timestamp: 1712412455215 mac: 0912f561b653 mac_table_stats: mac_table_count: 58 max_mac_entries_supported: 64000 memory_stat: usage: 16 model: EX4100-F-12P modified_time: 1720552388 module_stat: - boot_partition: junos cpu_stat: idle: 74 interrupt: 0 load_avg: - 0.8 - 0.75 - 0.78 system: 13 user: 13 fpc_idx: 0 mac: 0912f561b653 memory_stat: usage: 16 model: EX4100-F-12P pics: - index: 0 model_number: EX4100-F-12P port_groups: - count: 12 type: GE - index: 1 model_number: EX4100-F-12P port_groups: - count: 4 type: SFP/SFP+ - index: 2 model_number: EX4100-F-12P port_groups: - count: 2 type: GE poe: max_power: 180 power_draw: 7.3 psus: - name: Power Supply 0 status: ok - name: Power Supply 1 status: absent - name: Power Supply 2 status: absent serial: FJ0324AV0077 temperatures: - celsius: 51 name: Thermal board Sensor 1 status: ok - celsius: 51 name: Thermal board Sensor 2 status: ok - celsius: 50 name: Thermal board Sensor 3 status: ok - celsius: 57 name: PFE Die Sensor status: ok type: fpc uptime: 1692720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/1 port_id: vcp-0/1/0 - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/1 vc_mode: HiGiG vc_role: master vc_state: present version: 22.4R3.25 - boot_partition: junos cpu_stat: idle: 79 interrupt: 0 load_avg: - 0.52 - 0.46 - 0.46 system: 6 user: 15 fpc_idx: 1 mac: 485a0deb2380 memory_stat: usage: 14 model: EX4100-F-12P pics: - index: 0 model_number: EX4100-F-12P port_groups: - count: 12 type: GE - index: 1 model_number: EX4100-F-12P port_groups: - count: 4 type: SFP/SFP+ - index: 2 model_number: EX4100-F-12P port_groups: - count: 2 type: GE poe: max_power: 180 power_draw: 22.1 psus: - name: Power Supply 0 status: ok - name: Power Supply 1 status: absent - name: Power Supply 2 status: absent serial: FJ0424AV0101 temperatures: - celsius: 52 name: Thermal board Sensor 1 status: ok - celsius: 53 name: Thermal board Sensor 2 status: ok - celsius: 52 name: Thermal board Sensor 3 status: ok - celsius: 59 name: PFE Die Sensor status: ok type: fpc uptime: 1692720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/1 port_id: vcp-1/1/0 - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/1 vc_mode: HiGiG vc_role: backup vc_state: present version: 22.4R3.25 name: SW-HLAB-ea2e00 org_id: c5324060-19da-48fa-af28-2b530bd08765 route_summary_stats: fib_routes: 7 max_unicast_routes_supported: 32150 rib_routes: 40 total_routes: 3 serial: FJ0324AV0077 site_id: a0e43ffb-94a6-4f27-92aa-9cf832e1143d status: connected tag_id: 3564806 tag_uuid: 507604a4-6b34-449c-acb3-87955430b006 type: switch uptime: 1692720 vc_mac: 0912f561b653 vc_setup_info: config_type: nonprovisioned err_missing_dev_id_fpc: false version: 22.4R3.25 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/stats/devices/{device_id}: parameters: [] get: tags: - Sites Stats - Devices summary: getSiteDeviceStats description: Get Site Device Stats Details operationId: getSiteDeviceStats parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: device_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: fields in: query description: List of additional fields requests, comma separated, or `fields=*` for all of them style: form explode: true schema: type: string examples: - field1,field2 responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/stats_device' - description: Device statistics record for an AP, switch, or gateway examples: - auto_upgrade_stat: lastcheck: 1720594762 ble_stat: beacon_enabled: true beacon_rate: 4 eddystone_uid_enabled: false eddystone_uid_freq_msec: 1000 eddystone_uid_instance: 5c5b35d0077b eddystone_uid_namespace: 9777c1a06ef611e68bbf eddystone_url_enabled: false eddystone_url_freq_msec: 1000 eddystone_url_url: '' ibeacon_enabled: false ibeacon_freq_msec: 1000 ibeacon_major: 894 ibeacon_minor: 9328 ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627 major: 894 minors: - 9328 - 9329 - 9330 - 9331 - 9332 - 9333 - 9334 - 9335 - -1 power: 8 rx_bytes: 158500843 rx_pkts: 3549163 tx_bytes: 509640 tx_pkts: 85411 tx_resets: 0 uuid: af010e2b-f829-4975-b49e-2e896ed1d627 config_reverted: false cpu_system: 21921854 cpu_user: 7496631 cpu_util: 5 created_time: 1718228350 env_stat: accel_x: -0.092 accel_y: 0.004 accel_z: -1.02 ambient_temp: 43 attitude: 0 cpu_temp: 53 humidity: 9 magne_x: 0 magne_y: 0 magne_z: 0 pressure: 968 vcore_voltage: 0 ext_ip: 66.129.234.28 hw_rev: C02 id: 00000000-0000-0000-1000-5c5b35d0077b inactive_wired_vlans: [] ip: 192.168.95.3 ip_stat: dhcp_server: 192.168.95.1 dns: - 8.8.8.8 gateway: 192.168.95.1 ip: 192.168.95.3 ip6: fe80:0:0:0:5e5b:35ff:fed0:77b ips: vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64 netmask: 255.255.255.0 netmask6: /64 last_seen: 1720595866 last_trouble: code: '07' timestamp: 1720039666 lldp_stat: chassis_id: d0:07:ca:f5:21:00 lldp_med_supported: false mgmt_addr: 100.123.105.1 mgmt_addrs: - 100.123.105.1 port_desc: ge-0/0/4 port_id: ge-0/0/4 power_allocated: 0 power_draw: 0 power_request_count: 0 power_requested: 0 system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.' system_name: Phoenix-Switch mac: 5c5b35d0077b mem_total_kb: 505468 mem_used_kb: 202096 model: AP43 modified_time: 1718530662 mount: faceup name: Phoenix notes: '' num_clients: 1 org_id: af010e2b-f829-4975-b49e-2e896ed1d627 port_stat: eth0: full_duplex: true rx_bytes: 1284143195 rx_errors: 0 rx_peak_bps: 17585 rx_pkts: 5199816 speed: 1000 tx_bytes: 1283744961 tx_peak_bps: 26484 tx_pkts: 3990463 up: true eth1: full_duplex: false rx_bytes: 0 rx_errors: 0 rx_peak_bps: 0 rx_pkts: 0 speed: 0 tx_bytes: 0 tx_peak_bps: 0 tx_pkts: 0 up: false power_budget: 8400 power_constrained: false power_src: DC Input radio_config: {} radio_stat: band_24: bandwidth: 20 channel: 11 mac: 5c5b35dea810 noise_floor: -80 num_clients: 0 power: 17 rx_bytes: 12948211 rx_pkts: 65292 tx_bytes: 19071943 tx_pkts: 76926 usage: '24' util_all: 24 util_non_wifi: 2 util_rx_in_bss: 0 util_rx_other_bss: 17 util_tx: 4 util_undecodable_wifi: 0 util_unknown_wifi: 1 band_5: bandwidth: 40 channel: 36 mac: 5c5b35dea7f0 noise_floor: -90 num_clients: 1 power: 17 rx_bytes: 578362619 rx_pkts: 2687577 tx_bytes: 1199571353 tx_pkts: 2479302 usage: '5' util_all: 13 util_non_wifi: 0 util_rx_in_bss: 0 util_rx_other_bss: 10 util_tx: 1 util_undecodable_wifi: 0 util_unknown_wifi: 1 rx_bps: 9276 rx_bytes: 591310830 rx_pkts: 2752869 serial: A0703200709E6 site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4 status: connected switch_redundancy: num_redundant_aps: 1 tx_bps: 8067 tx_bytes: 1218643296 tx_pkts: 2556228 type: ap uptime: 1593120 version: 0.14.29313 contentMediaType: application/json examples: Access Point Stats: value: auto_upgrade_stat: lastcheck: 1720594762 ble_stat: beacon_enabled: true beacon_rate: 4 eddystone_uid_enabled: false eddystone_uid_freq_msec: 1000 eddystone_uid_instance: 5c5b35d0077b eddystone_uid_namespace: 9777c1a06ef611e68bbf eddystone_url_enabled: false eddystone_url_freq_msec: 1000 eddystone_url_url: '' ibeacon_enabled: false ibeacon_freq_msec: 1000 ibeacon_major: 894 ibeacon_minor: 9328 ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627 major: 894 minors: - 9328 - 9329 - 9330 - 9331 - 9332 - 9333 - 9334 - 9335 - -1 power: 8 rx_bytes: 158500843 rx_pkts: 3549163 tx_bytes: 509640 tx_pkts: 85411 tx_resets: 0 uuid: af010e2b-f829-4975-b49e-2e896ed1d627 config_reverted: false cpu_system: 21921854 cpu_user: 7496631 cpu_util: 5 created_time: 1718228350 env_stat: accel_x: -0.092 accel_y: 0.004 accel_z: -1.02 ambient_temp: 43 attitude: 0 cpu_temp: 53 humidity: 9 magne_x: 0 magne_y: 0 magne_z: 0 pressure: 968 vcore_voltage: 0 ext_ip: 66.129.234.28 hw_rev: C02 id: 00000000-0000-0000-1000-5c5b35d0077b inactive_wired_vlans: [] ip: 192.168.95.3 ip_stat: dhcp_server: 192.168.95.1 dns: - 8.8.8.8 gateway: 192.168.95.1 ip: 192.168.95.3 ip6: fe80:0:0:0:5e5b:35ff:fed0:77b ips: vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64 netmask: 255.255.255.0 netmask6: /64 last_seen: 1720595866 last_trouble: code: '07' timestamp: 1720039666 lldp_stat: chassis_id: d0:07:ca:f5:21:00 lldp_med_supported: false mgmt_addr: 100.123.105.1 mgmt_addrs: - 100.123.105.1 port_desc: ge-0/0/4 port_id: ge-0/0/4 power_allocated: 0 power_draw: 0 power_request_count: 0 power_requested: 0 system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.' system_name: Phoenix-Switch mac: 5c5b35d0077b mem_total_kb: 505468 mem_used_kb: 202096 model: AP43 modified_time: 1718530662 mount: faceup name: Phoenix notes: '' num_clients: 1 org_id: af010e2b-f829-4975-b49e-2e896ed1d627 port_stat: eth0: full_duplex: true rx_bytes: 1284143195 rx_errors: 0 rx_peak_bps: 17585 rx_pkts: 5199816 speed: 1000 tx_bytes: 1283744961 tx_peak_bps: 26484 tx_pkts: 3990463 up: true eth1: full_duplex: false rx_bytes: 0 rx_errors: 0 rx_peak_bps: 0 rx_pkts: 0 speed: 0 tx_bytes: 0 tx_peak_bps: 0 tx_pkts: 0 up: false power_budget: 8400 power_constrained: false power_src: DC Input radio_config: {} radio_stat: band_24: bandwidth: 20 channel: 11 mac: 5c5b35dea810 noise_floor: -80 num_clients: 0 power: 17 rx_bytes: 12948211 rx_pkts: 65292 tx_bytes: 19071943 tx_pkts: 76926 usage: '24' util_all: 24 util_non_wifi: 2 util_rx_in_bss: 0 util_rx_other_bss: 17 util_tx: 4 util_undecodable_wifi: 0 util_unknown_wifi: 1 band_5: bandwidth: 40 channel: 36 mac: 5c5b35dea7f0 noise_floor: -90 num_clients: 1 power: 17 rx_bytes: 578362619 rx_pkts: 2687577 tx_bytes: 1199571353 tx_pkts: 2479302 usage: '5' util_all: 13 util_non_wifi: 0 util_rx_in_bss: 0 util_rx_other_bss: 10 util_tx: 1 util_undecodable_wifi: 0 util_unknown_wifi: 1 rx_bps: 9276 rx_bytes: 591310830 rx_pkts: 2752869 serial: A0703200709E6 site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4 status: connected switch_redundancy: num_redundant_aps: 1 tx_bps: 8067 tx_bytes: 1218643296 tx_pkts: 2556228 type: ap uptime: 1593120 version: 0.14.29313 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/stats_device' - description: Device statistics record for an AP, switch, or gateway examples: - auto_upgrade_stat: lastcheck: 1720594762 ble_stat: beacon_enabled: true beacon_rate: 4 eddystone_uid_enabled: false eddystone_uid_freq_msec: 1000 eddystone_uid_instance: 5c5b35d0077b eddystone_uid_namespace: 9777c1a06ef611e68bbf eddystone_url_enabled: false eddystone_url_freq_msec: 1000 eddystone_url_url: '' ibeacon_enabled: false ibeacon_freq_msec: 1000 ibeacon_major: 894 ibeacon_minor: 9328 ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627 major: 894 minors: - 9328 - 9329 - 9330 - 9331 - 9332 - 9333 - 9334 - 9335 - -1 power: 8 rx_bytes: 158500843 rx_pkts: 3549163 tx_bytes: 509640 tx_pkts: 85411 tx_resets: 0 uuid: af010e2b-f829-4975-b49e-2e896ed1d627 config_reverted: false cpu_system: 21921854 cpu_user: 7496631 cpu_util: 5 created_time: 1718228350 env_stat: accel_x: -0.092 accel_y: 0.004 accel_z: -1.02 ambient_temp: 43 attitude: 0 cpu_temp: 53 humidity: 9 magne_x: 0 magne_y: 0 magne_z: 0 pressure: 968 vcore_voltage: 0 ext_ip: 66.129.234.28 hw_rev: C02 id: 00000000-0000-0000-1000-5c5b35d0077b inactive_wired_vlans: [] ip: 192.168.95.3 ip_stat: dhcp_server: 192.168.95.1 dns: - 8.8.8.8 gateway: 192.168.95.1 ip: 192.168.95.3 ip6: fe80:0:0:0:5e5b:35ff:fed0:77b ips: vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64 netmask: 255.255.255.0 netmask6: /64 last_seen: 1720595866 last_trouble: code: '07' timestamp: 1720039666 lldp_stat: chassis_id: d0:07:ca:f5:21:00 lldp_med_supported: false mgmt_addr: 100.123.105.1 mgmt_addrs: - 100.123.105.1 port_desc: ge-0/0/4 port_id: ge-0/0/4 power_allocated: 0 power_draw: 0 power_request_count: 0 power_requested: 0 system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.' system_name: Phoenix-Switch mac: 5c5b35d0077b mem_total_kb: 505468 mem_used_kb: 202096 model: AP43 modified_time: 1718530662 mount: faceup name: Phoenix notes: '' num_clients: 1 org_id: af010e2b-f829-4975-b49e-2e896ed1d627 port_stat: eth0: full_duplex: true rx_bytes: 1284143195 rx_errors: 0 rx_peak_bps: 17585 rx_pkts: 5199816 speed: 1000 tx_bytes: 1283744961 tx_peak_bps: 26484 tx_pkts: 3990463 up: true eth1: full_duplex: false rx_bytes: 0 rx_errors: 0 rx_peak_bps: 0 rx_pkts: 0 speed: 0 tx_bytes: 0 tx_peak_bps: 0 tx_pkts: 0 up: false power_budget: 8400 power_constrained: false power_src: DC Input radio_config: {} radio_stat: band_24: bandwidth: 20 channel: 11 mac: 5c5b35dea810 noise_floor: -80 num_clients: 0 power: 17 rx_bytes: 12948211 rx_pkts: 65292 tx_bytes: 19071943 tx_pkts: 76926 usage: '24' util_all: 24 util_non_wifi: 2 util_rx_in_bss: 0 util_rx_other_bss: 17 util_tx: 4 util_undecodable_wifi: 0 util_unknown_wifi: 1 band_5: bandwidth: 40 channel: 36 mac: 5c5b35dea7f0 noise_floor: -90 num_clients: 1 power: 17 rx_bytes: 578362619 rx_pkts: 2687577 tx_bytes: 1199571353 tx_pkts: 2479302 usage: '5' util_all: 13 util_non_wifi: 0 util_rx_in_bss: 0 util_rx_other_bss: 10 util_tx: 1 util_undecodable_wifi: 0 util_unknown_wifi: 1 rx_bps: 9276 rx_bytes: 591310830 rx_pkts: 2752869 serial: A0703200709E6 site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4 status: connected switch_redundancy: num_redundant_aps: 1 tx_bps: 8067 tx_bytes: 1218643296 tx_pkts: 2556228 type: ap uptime: 1593120 version: 0.14.29313 contentMediaType: application/vnd.api+json examples: Access Point Stats: value: auto_upgrade_stat: lastcheck: 1720594762 ble_stat: beacon_enabled: true beacon_rate: 4 eddystone_uid_enabled: false eddystone_uid_freq_msec: 1000 eddystone_uid_instance: 5c5b35d0077b eddystone_uid_namespace: 9777c1a06ef611e68bbf eddystone_url_enabled: false eddystone_url_freq_msec: 1000 eddystone_url_url: '' ibeacon_enabled: false ibeacon_freq_msec: 1000 ibeacon_major: 894 ibeacon_minor: 9328 ibeacon_uuid: af010e2b-f829-4975-b49e-2e896ed1d627 major: 894 minors: - 9328 - 9329 - 9330 - 9331 - 9332 - 9333 - 9334 - 9335 - -1 power: 8 rx_bytes: 158500843 rx_pkts: 3549163 tx_bytes: 509640 tx_pkts: 85411 tx_resets: 0 uuid: af010e2b-f829-4975-b49e-2e896ed1d627 config_reverted: false cpu_system: 21921854 cpu_user: 7496631 cpu_util: 5 created_time: 1718228350 env_stat: accel_x: -0.092 accel_y: 0.004 accel_z: -1.02 ambient_temp: 43 attitude: 0 cpu_temp: 53 humidity: 9 magne_x: 0 magne_y: 0 magne_z: 0 pressure: 968 vcore_voltage: 0 ext_ip: 66.129.234.28 hw_rev: C02 id: 00000000-0000-0000-1000-5c5b35d0077b inactive_wired_vlans: [] ip: 192.168.95.3 ip_stat: dhcp_server: 192.168.95.1 dns: - 8.8.8.8 gateway: 192.168.95.1 ip: 192.168.95.3 ip6: fe80:0:0:0:5e5b:35ff:fed0:77b ips: vlan1: 192.168.95.3/24,fe80:0:0:0:5e5b:35ff:fed0:77b/64 netmask: 255.255.255.0 netmask6: /64 last_seen: 1720595866 last_trouble: code: '07' timestamp: 1720039666 lldp_stat: chassis_id: d0:07:ca:f5:21:00 lldp_med_supported: false mgmt_addr: 100.123.105.1 mgmt_addrs: - 100.123.105.1 port_desc: ge-0/0/4 port_id: ge-0/0/4 power_allocated: 0 power_draw: 0 power_request_count: 0 power_requested: 0 system_desc: 'Juniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.' system_name: Phoenix-Switch mac: 5c5b35d0077b mem_total_kb: 505468 mem_used_kb: 202096 model: AP43 modified_time: 1718530662 mount: faceup name: Phoenix notes: '' num_clients: 1 org_id: af010e2b-f829-4975-b49e-2e896ed1d627 port_stat: eth0: full_duplex: true rx_bytes: 1284143195 rx_errors: 0 rx_peak_bps: 17585 rx_pkts: 5199816 speed: 1000 tx_bytes: 1283744961 tx_peak_bps: 26484 tx_pkts: 3990463 up: true eth1: full_duplex: false rx_bytes: 0 rx_errors: 0 rx_peak_bps: 0 rx_pkts: 0 speed: 0 tx_bytes: 0 tx_peak_bps: 0 tx_pkts: 0 up: false power_budget: 8400 power_constrained: false power_src: DC Input radio_config: {} radio_stat: band_24: bandwidth: 20 channel: 11 mac: 5c5b35dea810 noise_floor: -80 num_clients: 0 power: 17 rx_bytes: 12948211 rx_pkts: 65292 tx_bytes: 19071943 tx_pkts: 76926 usage: '24' util_all: 24 util_non_wifi: 2 util_rx_in_bss: 0 util_rx_other_bss: 17 util_tx: 4 util_undecodable_wifi: 0 util_unknown_wifi: 1 band_5: bandwidth: 40 channel: 36 mac: 5c5b35dea7f0 noise_floor: -90 num_clients: 1 power: 17 rx_bytes: 578362619 rx_pkts: 2687577 tx_bytes: 1199571353 tx_pkts: 2479302 usage: '5' util_all: 13 util_non_wifi: 0 util_rx_in_bss: 0 util_rx_other_bss: 10 util_tx: 1 util_undecodable_wifi: 0 util_unknown_wifi: 1 rx_bps: 9276 rx_bytes: 591310830 rx_pkts: 2752869 serial: A0703200709E6 site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4 status: connected switch_redundancy: num_redundant_aps: 1 tx_bps: 8067 tx_bytes: 1218643296 tx_pkts: 2556228 type: ap uptime: 1593120 version: 0.14.29313 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/stats/devices/{device_id}/clients: parameters: [] get: tags: - Sites Stats - Devices summary: getSiteAllClientsStatsByDevice description: Get wireless client stat by Device operationId: getSiteAllClientsStatsByDevice parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: device_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/stats_wireless_client' description: Wireless client statistics records returned by a stats response contentMediaType: application/json '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/stats/gateways/metrics: parameters: [] get: tags: - Sites Stats - Devices summary: getSiteGatewayMetrics description: Get Site Gateway Metrics operationId: getSiteGatewayMetrics parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/gateway_metrics' - description: Gateway metric scores returned by the site gateway metrics API examples: - config_success: 99.9 version_compliance: major_version: SRX320: major_count: 0 major_version: 19.4R2-S1.2 score: 99.9 type: gateway contentMediaType: application/json examples: Example: value: config_success: 99.9 version_compliance: major_version: SRX320: major_count: 0 major_version: 19.4R2-S1.2 score: 99.9 type: gateway application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/gateway_metrics' - description: Gateway metric scores returned by the site gateway metrics API examples: - config_success: 99.9 version_compliance: major_version: SRX320: major_count: 0 major_version: 19.4R2-S1.2 score: 99.9 type: gateway contentMediaType: application/vnd.api+json examples: Example: value: config_success: 99.9 version_compliance: major_version: SRX320: major_count: 0 major_version: 19.4R2-S1.2 score: 99.9 type: gateway '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/stats/switches/metrics: parameters: [] get: tags: - Sites Stats - Devices summary: getSiteSwitchesMetrics description: Get version compliance metrics for managed or monitored switches operationId: getSiteSwitchesMetrics parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: type in: query description: 'Filter results by type. enum: `active_ports_summary`' style: form explode: true schema: allOf: - $ref: '#/components/schemas/switch_metric_type' - description: 'Filter results by type. enum: `active_ports_summary`' - name: scope in: query description: 'Filter results by scope. enum: `site`, `switch`' style: form explode: true schema: allOf: - $ref: '#/components/schemas/switch_metric_scope' - description: 'Filter results by scope. enum: `site`, `switch`' - name: switch_mac in: query description: Switch mac, used only with metric `type`==`active_ports_summary` style: form explode: true schema: type: string examples: - 5c5b350e0410 responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_switch_metrics' - description: Switch metrics returned for the requested site or switch scope examples: - '{"active_ports_summary":{"details":{"active_port_count":4,"total_port_count":4},"score":100,"total_switch_count":2},"config_success":{"details":{"config_success_count":2},"score":100,"total_switch_count":2},"version_compliance":{"details":{"major_versions":[{"major_count":1,"major_version":"21.4R3.5","model":"EX2300-C-12P","system_names":[]},{"major_count":1,"major_version":"6.0.4-11","model":"SSR120","system_names":[]}]},"score":100,"total_switch_count":2}}' - '{"active_ports_summary":{"details":{"active_port_count":1,"total_port_count":2},"score":50,"total_switch_count":1}}' contentMediaType: application/json examples: Site Scoped: value: active_ports_summary: details: active_port_count: 4 total_port_count: 4 score: 100 total_switch_count: 2 config_success: details: config_success_count: 2 score: 100 total_switch_count: 2 version_compliance: details: major_versions: - major_count: 1 major_version: 21.4R3.5 model: EX2300-C-12P system_names: [] - major_count: 1 major_version: 6.0.4-11 model: SSR120 system_names: [] score: 100 total_switch_count: 2 Switch Scoped: value: active_ports_summary: details: active_port_count: 1 total_port_count: 2 score: 50 total_switch_count: 1 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_switch_metrics' - description: Switch metrics returned for the requested site or switch scope examples: - '{"active_ports_summary":{"details":{"active_port_count":4,"total_port_count":4},"score":100,"total_switch_count":2},"config_success":{"details":{"config_success_count":2},"score":100,"total_switch_count":2},"version_compliance":{"details":{"major_versions":[{"major_count":1,"major_version":"21.4R3.5","model":"EX2300-C-12P","system_names":[]},{"major_count":1,"major_version":"6.0.4-11","model":"SSR120","system_names":[]}]},"score":100,"total_switch_count":2}}' - '{"active_ports_summary":{"details":{"active_port_count":1,"total_port_count":2},"score":50,"total_switch_count":1}}' contentMediaType: application/vnd.api+json examples: Site Scoped: value: active_ports_summary: details: active_port_count: 4 total_port_count: 4 score: 100 total_switch_count: 2 config_success: details: config_success_count: 2 score: 100 total_switch_count: 2 version_compliance: details: major_versions: - major_count: 1 major_version: 21.4R3.5 model: EX2300-C-12P system_names: [] - major_count: 1 major_version: 6.0.4-11 model: SSR120 system_names: [] score: 100 total_switch_count: 2 Switch Scoped: value: active_ports_summary: details: active_port_count: 1 total_port_count: 2 score: 50 total_switch_count: 1 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false components: schemas: port_stp_state1: title: port_stp_state1 enum: - blocking - disabled - forwarding - learning - listening type: string description: 'Current spanning tree state of the port. enum: ``, `blocking`, `disabled`, `forwarding`, `learning`, `listening`.' stats_ap_l2tp_stat_session: title: stats_ap_l2tp_stat_session type: object properties: local_sid: type: - integer - 'null' description: Local L2TP session identifier for this tunnel session contentEncoding: int32 readOnly: true examples: - 31 remote_id: type: - string - 'null' description: User-configured remote identifier for the WxLAN tunnel readOnly: true examples: - vpn1 remote_sid: type: - integer - 'null' description: Remote L2TP session identifier for this tunnel session contentEncoding: int32 readOnly: true examples: - 13 state: allOf: - $ref: '#/components/schemas/l2tp_state1' - description: 'L2TP session state reported by the AP. enum: `established`, `established_with_session`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`.' examples: - established description: L2TP tunnel session reported by an AP stats_switch_ap_redundancy2: title: stats_switch_ap_redundancy2 type: object properties: modules: type: object additionalProperties: $ref: '#/components/schemas/stats_switch_ap_redundancy_module' description: Per-module AP redundancy counts for VC or stacked switches num_aps: type: integer description: Total number of APs considered for switch redundancy contentEncoding: int32 examples: - 15 num_aps_with_switch_redundancy: type: integer description: Number of APs that have switch redundancy coverage contentEncoding: int32 examples: - 8 description: AP redundancy statistics associated with the switch response_http400: title: response_http400 type: object properties: detail: type: string description: Human-readable explanation of the bad request error examples: - 'JSON parse error - Expecting value: line 5 column 8 (char 56)' description: Standard HTTP 400 bad request error response bgp_peer: title: bgp_peer type: object properties: evpn_overlay: type: boolean description: If this is created for evpn overlay for_overlay: type: boolean description: If this is created for overlay local_as: anyOf: - type: string - maximum: 4294967294 minimum: 1 type: integer contentEncoding: int32 description: Local Autonomous System (AS) number used by this BGP session examples: - '65000' neighbor: type: string description: IP address of the BGP neighbor examples: - 15.8.3.5 neighbor_as: anyOf: - type: string - maximum: 4294967294 minimum: 1 type: integer contentEncoding: int32 description: Autonomous System (AS) number of the BGP neighbor examples: - '65000' neighbor_mac: type: string description: MAC address of the BGP neighbor when it is another device in the same organization examples: - 020001c04600 node: type: string description: HA node reporting this BGP peer, such as node0 or node1 examples: - node0 rx_pkts: type: - integer - 'null' description: Packets received from this BGP neighbor contentEncoding: int64 readOnly: true examples: - 57770567 rx_routes: type: integer description: Number of received routes contentEncoding: int32 examples: - 60 state: allOf: - $ref: '#/components/schemas/bgp_stats_state1' - description: 'Current state of the BGP session. enum: `active`, `connect`, `established`, `idle`, `open_config`, `open_sent`.' examples: - established timestamp: type: number description: Time when these BGP peer stats were sampled readOnly: true tx_pkts: type: - integer - 'null' description: Packets sent to this BGP neighbor contentEncoding: int64 readOnly: true examples: - 812204062 tx_routes: type: integer description: Number of routes advertised to this BGP neighbor contentEncoding: int32 examples: - 60 up: type: boolean description: Whether the BGP session is currently up uptime: type: integer description: Number of seconds the BGP session has been up contentEncoding: int32 examples: - 31355 vrf_name: type: string description: VRF name associated with this BGP session examples: - default description: Only present when `bgp_peers` in `fields` query parameter response_http401: title: response_http401 type: object properties: detail: type: string description: Human-readable explanation of the authentication error examples: - Authentication credentials were not provided. description: Standard HTTP 401 authentication error response ap_radio_stat2: title: ap_radio_stat2 type: object properties: bandwidth: allOf: - $ref: '#/components/schemas/dot11_bandwidth8' - description: 'Current channel width reported for this radio. enum: `0`, `20`, `40`, `80`, `160`.' examples: - 20 channel: type: - integer - 'null' description: Current channel the radio is running on contentEncoding: int32 readOnly: true dynamic_chaining_enabled: type: - boolean - 'null' description: Use dynamic chaining for downlink readOnly: true mac: type: - string - 'null' description: Radio base MAC address; a base radio MAC can represent up to 16 BSSIDs (e.g. 5c5b350001a0-5c5b350001af) readOnly: true noise_floor: type: - integer - 'null' description: Measured noise floor for this radio, in dBm contentEncoding: int32 readOnly: true examples: - -90 num_clients: type: - integer - 'null' description: Number of clients currently connected on this radio contentEncoding: int32 readOnly: true num_wlans: type: integer description: How many WLANs are applied to the radio contentEncoding: int32 power: type: - integer - 'null' description: Transmit power (in dBm) contentEncoding: int32 readOnly: true rx_bytes: type: - integer - 'null' description: Received byte count reported for this radio contentEncoding: int64 readOnly: true examples: - 8515104416 rx_pkts: type: - integer - 'null' description: Received packet count reported for this radio contentEncoding: int64 readOnly: true examples: - 57770567 tx_bytes: type: - integer - 'null' description: Transmitted byte count reported for this radio contentEncoding: int64 readOnly: true examples: - 211217389682 tx_pkts: type: - integer - 'null' description: Transmitted packet count reported for this radio contentEncoding: int64 readOnly: true examples: - 812204062 usage: type: - string - 'null' description: Operating band reported for this radio, such as 24, 5, or 6 readOnly: true examples: - '24' util_all: type: - integer - 'null' description: All utilization in percentage contentEncoding: int32 readOnly: true util_non_wifi: type: - integer - 'null' description: Reception of "No Packets" utilization in percentage, received frames with invalid PLCPs and CRS glitches as noise contentEncoding: int32 readOnly: true util_rx_in_bss: type: - integer - 'null' description: Reception of "In BSS" utilization in percentage, only frames that are received from AP/STAs within the BSS contentEncoding: int32 readOnly: true util_rx_other_bss: type: - integer - 'null' description: Reception of "Other BSS" utilization in percentage, all frames received from AP/STAs that are outside the BSS contentEncoding: int32 readOnly: true util_tx: type: - integer - 'null' description: Transmission utilization in percentage contentEncoding: int32 readOnly: true util_undecodable_wifi: type: - integer - 'null' description: Reception of "UnDecodable Wifi" utilization in percentage, only Preamble, PLCP header is decoded, Rest is undecodable in this radio contentEncoding: int32 readOnly: true util_unknown_wifi: type: - integer - 'null' description: Reception of "No Category" utilization in percentage, all 802.11 frames that are corrupted at the receiver contentEncoding: int32 readOnly: true description: 5 GHz radio statistics reported by the AP stats_cluster_config1: title: stats_cluster_config1 type: object properties: configuration: type: string description: Configured high-availability mode for the gateway cluster, such as active-active control_link_info: allOf: - $ref: '#/components/schemas/stats_cluster_config_control_link_info2' - description: Control link interface and operational state for the gateway cluster ethernet_connection: type: array items: $ref: '#/components/schemas/stats_cluster_config_ethernet_connection_item' description: Ethernet interface connection states used by the gateway cluster fabric_link_info: allOf: - $ref: '#/components/schemas/stats_cluster_config_fabric_link_info2' - description: Fabric link state and data-plane notification details for the gateway cluster last_status_change_reason: type: string description: Reason reported for the most recent gateway cluster status change operational: type: string description: Current operational high-availability mode of the gateway cluster primary_node_health: type: string description: Health state reported for the primary gateway cluster node redundancy_group_information: type: array items: $ref: '#/components/schemas/stats_cluster_config_redundancy_group_info_item' description: Redundancy group monitoring state reported by the gateway cluster secondary_node_health: type: string description: Health state reported for the secondary gateway cluster node status: type: string description: Overall health status reported for the gateway cluster description: High-availability cluster configuration and health for the gateway stats_gateway_module_stat_item: title: stats_gateway_module_stat_item type: object properties: backup_version: type: - string - 'null' description: Backup software version stored on the gateway module readOnly: true bios_version: type: - string - 'null' description: BIOS firmware version reported for the gateway module readOnly: true boot_partition: type: string description: Active boot partition used by the gateway module cpld_version: type: - string - 'null' description: CPLD firmware version reported for the gateway module readOnly: true fans: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_fans_items' description: Cooling fan status records for the gateway module fpga_version: type: - string - 'null' description: FPGA firmware version reported for the gateway module readOnly: true last_seen: type: - number - 'null' description: Time when Mist last observed this gateway module, in epoch seconds readOnly: true examples: - 1470417522 locating: type: boolean description: Whether the gateway module locator indicator is active mac: type: string description: Gateway module MAC address reported by Mist examples: - fc3342123456 memory_stat: allOf: - $ref: '#/components/schemas/memory_stat5' - description: Utilization statistics for gateway module memory model: type: - string - 'null' description: Gateway module model name reported by Mist readOnly: true examples: - EX4300-48P network_resources: type: array items: $ref: '#/components/schemas/module_stat_item_network_resource' description: Network resource utilization counters for the gateway module optics_cpld_version: type: - string - 'null' description: Optics CPLD firmware version reported for the gateway module readOnly: true pending_version: type: - string - 'null' description: Pending software version staged for the gateway module readOnly: true poe: allOf: - $ref: '#/components/schemas/module_stat_item_poe2' - description: Power over Ethernet telemetry for the gateway module poe_version: type: - string - 'null' description: PoE controller firmware version reported for the gateway module readOnly: true power_cpld_version: type: - string - 'null' description: Power CPLD firmware version reported for the gateway module readOnly: true psus: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_psus_item' description: Power supply status records for the gateway module re_fpga_version: type: - string - 'null' description: Routing Engine FPGA firmware version reported for the gateway module readOnly: true recovery_version: type: - string - 'null' description: Recovery software version stored on the gateway module readOnly: true serial: type: - string - 'null' description: Gateway module serial number reported by Mist readOnly: true examples: - PX8716230021 status: type: - string - 'null' description: Connection status reported for the gateway module readOnly: true temperatures: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_temperatures_item' description: Temperature sensor readings for the gateway module tmc_fpga_version: type: - string - 'null' description: TMC FPGA firmware version reported for the gateway module readOnly: true uboot_version: type: - string - 'null' description: U-Boot firmware version reported for the gateway module readOnly: true uptime: type: - integer - 'null' description: Elapsed time since the gateway module last booted, in seconds contentEncoding: int32 readOnly: true vc_links: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_vc_links_item' description: Virtual chassis link records for the gateway module vc_mode: type: - string - 'null' description: Virtual chassis mode reported for the gateway module readOnly: true vc_role: type: - string - 'null' description: 'Virtual chassis role reported for the gateway module. enum: `master`, `backup`, `linecard`' readOnly: true examples: - master vc_state: type: - string - 'null' description: Virtual chassis state reported for the gateway module readOnly: true version: type: - string - 'null' description: Software version running on the gateway module readOnly: true description: Hardware module status and firmware inventory for a gateway ap_radio_stat3: title: ap_radio_stat3 type: object properties: bandwidth: allOf: - $ref: '#/components/schemas/dot11_bandwidth8' - description: 'Current channel width reported for this radio. enum: `0`, `20`, `40`, `80`, `160`.' examples: - 20 channel: type: - integer - 'null' description: Current channel the radio is running on contentEncoding: int32 readOnly: true dynamic_chaining_enabled: type: - boolean - 'null' description: Use dynamic chaining for downlink readOnly: true mac: type: - string - 'null' description: Radio base MAC address; a base radio MAC can represent up to 16 BSSIDs (e.g. 5c5b350001a0-5c5b350001af) readOnly: true noise_floor: type: - integer - 'null' description: Measured noise floor for this radio, in dBm contentEncoding: int32 readOnly: true examples: - -90 num_clients: type: - integer - 'null' description: Number of clients currently connected on this radio contentEncoding: int32 readOnly: true num_wlans: type: integer description: How many WLANs are applied to the radio contentEncoding: int32 power: type: - integer - 'null' description: Transmit power (in dBm) contentEncoding: int32 readOnly: true rx_bytes: type: - integer - 'null' description: Received byte count reported for this radio contentEncoding: int64 readOnly: true examples: - 8515104416 rx_pkts: type: - integer - 'null' description: Received packet count reported for this radio contentEncoding: int64 readOnly: true examples: - 57770567 tx_bytes: type: - integer - 'null' description: Transmitted byte count reported for this radio contentEncoding: int64 readOnly: true examples: - 211217389682 tx_pkts: type: - integer - 'null' description: Transmitted packet count reported for this radio contentEncoding: int64 readOnly: true examples: - 812204062 usage: type: - string - 'null' description: Operating band reported for this radio, such as 24, 5, or 6 readOnly: true examples: - '24' util_all: type: - integer - 'null' description: All utilization in percentage contentEncoding: int32 readOnly: true util_non_wifi: type: - integer - 'null' description: Reception of "No Packets" utilization in percentage, received frames with invalid PLCPs and CRS glitches as noise contentEncoding: int32 readOnly: true util_rx_in_bss: type: - integer - 'null' description: Reception of "In BSS" utilization in percentage, only frames that are received from AP/STAs within the BSS contentEncoding: int32 readOnly: true util_rx_other_bss: type: - integer - 'null' description: Reception of "Other BSS" utilization in percentage, all frames received from AP/STAs that are outside the BSS contentEncoding: int32 readOnly: true util_tx: type: - integer - 'null' description: Transmission utilization in percentage contentEncoding: int32 readOnly: true util_undecodable_wifi: type: - integer - 'null' description: Reception of "UnDecodable Wifi" utilization in percentage, only Preamble, PLCP header is decoded, Rest is undecodable in this radio contentEncoding: int32 readOnly: true util_unknown_wifi: type: - integer - 'null' description: Reception of "No Category" utilization in percentage, all 802.11 frames that are corrupted at the receiver contentEncoding: int32 readOnly: true description: 6 GHz radio statistics reported by the AP ap_led4: title: ap_led4 type: object properties: brightness: maximum: 255 minimum: 0 type: integer description: Indicator LED brightness level from 0 to 255 contentEncoding: int32 default: 255 examples: - 255 enabled: type: boolean description: Whether the AP indicator LED is enabled default: true description: Light indicator state for the AP fwupdate_stat2: title: fwupdate_stat2 type: object properties: progress: maximum: 100 minimum: 0 type: - integer - 'null' description: Firmware update progress percentage, or null when unavailable contentEncoding: int32 readOnly: true examples: - 10 status: allOf: - oneOf: - {} - $ref: '#/components/schemas/fwupdate_stat_status2' - description: 'Current firmware update status. enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`.' readOnly: true status_id: type: - integer - 'null' description: Numeric firmware update status identifier contentEncoding: int32 readOnly: true examples: - 5 timestamp: type: number description: Time when the firmware update status was last updated readOnly: true will_retry: type: - boolean - 'null' description: Whether the firmware update process will retry after the current status readOnly: true examples: - false description: Firmware update status for the AP ap_ip_config3: title: ap_ip_config3 type: object properties: dns: type: array items: type: string description: If `type`==`static`. DNS server IP addresses for AP management traffic examples: - - 8.8.8.8 - 4.4.4.4 dns_suffix: type: array items: type: string description: If `type`==`static`. DNS search suffixes applied to AP management lookups examples: - - .mist.local - .mist.com gateway: type: string description: Required if `type`==`static`. IPv4 default gateway for AP management traffic contentEncoding: ipv4 examples: - 10.2.1.254 gateway6: type: string description: Required if `type6`==`static`. IPv6 default gateway for AP management traffic when static IPv6 addressing is used contentEncoding: ipv6 examples: - 2607:f8b0:4005:808::1 ip: type: string description: Required if `type`==`static`. Static IPv4 address for the AP management interface contentEncoding: ipv4 examples: - 10.2.1.1 ip6: type: string description: Required if `type6`==`static`. Static IPv6 address for the AP management interface contentEncoding: ipv6 examples: - 2607:f8b0:4005:808::2004 mtu: type: integer description: Maximum transmission unit for AP management traffic contentEncoding: int32 examples: - 0 netmask: type: string description: Required if `type`==`static`. IPv4 netmask for the AP management interface examples: - 255.255.255.0 netmask6: type: string description: Required if `type6`==`static`. IPv6 prefix length for the AP management interface examples: - /32 type: allOf: - $ref: '#/components/schemas/ip_type13' - description: 'IPv4 address assignment mode for AP management traffic. enum: `dhcp`, `static`.' examples: - static type6: allOf: - $ref: '#/components/schemas/ip_type64' - description: 'IPv6 address assignment mode for AP management traffic. enum: `autoconf`, `dhcp`, `disabled`, `static`.' examples: - static vlan_id: type: integer description: Management VLAN ID, default is 1 (untagged) contentEncoding: int32 default: 1 examples: - 1 description: IP configuration applied to the AP management interface stats_ap_lldp_stat: title: stats_ap_lldp_stat type: object properties: chassis_id: type: - string - 'null' description: LLDP neighbor chassis identifier readOnly: true lldp_med_supported: type: - boolean - 'null' description: Whether it support LLDP-MED readOnly: true mgmt_addr: type: - string - 'null' description: Management IP address of the switch readOnly: true mgmt_addrs: type: array items: type: string description: Management IP addresses advertised by the LLDP neighbor port_desc: type: - string - 'null' description: Port description, e.g. “2/20”, “Port 2 on Switch0” readOnly: true examples: - 2/20 port_id: type: - string - 'null' description: LLDP neighbor port identifier readOnly: true examples: - ge-0/0/4 power_allocated: type: - number - 'null' description: In mW, power allocated by PSE readOnly: true power_avail: type: integer description: In mW, total Power Avail at AP from pwr source contentEncoding: int32 power_budget: type: integer description: In mW, surplus if positive or deficit if negative contentEncoding: int32 power_constrained: type: boolean description: Whether power is insufficient power_draw: type: - number - 'null' description: In mW, total power needed by PD readOnly: true power_needed: type: integer description: In mW, total Power needed incl Peripherals contentEncoding: int32 power_opmode: type: string description: Power operating mode negotiated through LLDP power_request_count: type: - integer - 'null' description: Number of negotiations, if it keeps increasing, we don’ t have a stable power contentEncoding: int32 readOnly: true power_requested: type: - number - 'null' description: In mW, power requested by PD readOnly: true power_src: type: string description: Primary AP power source reported through LLDP power_srcs: type: array items: type: string description: AP power sources reported through LLDP system_desc: type: - string - 'null' description: Description provided by switch readOnly: true examples: - 'uniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.' system_name: type: - string - 'null' description: Name of the switch readOnly: true examples: - Core-AE23 description: LLDP neighbor information and power negotiations. For backward compatibility, when multiple neighbors exist, only information from the first neighbor is displayed. response_switch_metrics_version_compliance_details2: title: response_switch_metrics_version_compliance_details2 type: object properties: major_versions: type: array items: $ref: '#/components/schemas/switch_metrics_compliance_major_version' description: Software version groupings found among the evaluated switches description: Version groupings used to calculate the compliance metric memory_stat2: title: memory_stat2 required: - usage type: object properties: usage: type: number description: Current memory utilization percentage for the device or master Routing Engine description: Utilization statistics for switch memory ip_type13: title: ip_type13 enum: - dhcp - static type: string description: 'IPv4 address assignment mode for AP management traffic. enum: `dhcp`, `static`.' examples: - static stats_device: oneOf: - $ref: '#/components/schemas/stats_ap' - $ref: '#/components/schemas/stats_switch' - $ref: '#/components/schemas/stats_gateway' description: Device statistics record for an AP, switch, or gateway discriminator: propertyName: type mapping: ap: stats_ap gateway: stats_gateway switch: stats_switch stats_ap_auto_placement_info2: title: stats_ap_auto_placement_info2 type: object properties: cluster_number: type: integer description: All APs sharing a given cluster number can be placed relative to each other contentEncoding: int32 examples: - 0 orientation_stats: type: integer description: The orientation of an AP contentEncoding: int32 examples: - 0 probability_surface: allOf: - $ref: '#/components/schemas/stats_ap_auto_placement_info_probability_surface2' - description: Uncertainty area for the AP auto placement result description: Additional diagnostics for the AP auto placement result tunnel_priority1: title: tunnel_priority1 enum: - primary - secondary type: string description: 'Relative preference assigned to the tunnel. enum: `primary`, `secondary`.' stats_ap_gps_stat_src2: title: stats_ap_gps_stat_src2 enum: - gps - other_ap - other_aps type: string description: 'Source of the GPS location data. enum: `gps`, `other_ap`, `other_aps`.' module_stat_item_fans_items: title: module_stat_item_fans_items type: object properties: airflow: type: string description: Direction of airflow reported for the fan examples: - out name: type: string description: Fan label reported by the device examples: - Fan 0 rpm: type: integer description: Current fan speed in revolutions per minute contentEncoding: int32 status: type: string description: Operational status reported for the fan examples: - ok description: Cooling fan telemetry for a device module stats_ap_zigbee_stat2: title: stats_ap_zigbee_stat2 type: object properties: iotproxy_status: type: - string - 'null' description: Connection status of the IoT proxy readOnly: true examples: - connected num_iotendpoints: type: - integer - 'null' description: Number of IoT endpoints connected through the AP contentEncoding: int32 readOnly: true examples: - 3 description: ZigBee statistics reported by the AP, present only when ZigBee is enabled on the AP stats_switch_clients_stats2: title: stats_switch_clients_stats2 type: object properties: total: allOf: - $ref: '#/components/schemas/stats_switch_clients_stats_total2' - description: Aggregate client counts across the switch description: Aggregate client counts reported for the switch stats_gateway_service_status2: title: stats_gateway_service_status2 type: object properties: appid_install_result: type: string description: Installation result reported for the AppID package appid_install_timestamp: type: string description: Installation time reported for the AppID package appid_status: type: string description: Operational status of the AppID service on the gateway appid_version: type: integer description: Installed AppID package version number contentEncoding: int32 ewf_status: type: string description: Enhanced Web Filtering service status reported by the gateway idp_install_result: type: string description: Installation result reported for the intrusion detection and prevention package idp_install_timestamp: type: string description: Installation time reported for the intrusion detection and prevention package idp_policy: type: string description: Intrusion detection and prevention policy applied to the gateway idp_status: type: string description: Intrusion detection and prevention service status reported by the gateway idp_update_timestamp: type: string description: Last update time reported for the intrusion detection and prevention package description: Security service status reported by the gateway ap_stat_mesh_downlink: title: ap_stat_mesh_downlink type: object properties: band: type: string description: Radio band used by this mesh downlink examples: - '5' channel: type: integer description: Radio channel used by this mesh downlink contentEncoding: int32 examples: - 36 idle_time: type: integer description: Seconds since traffic was last observed on this mesh downlink contentEncoding: int32 examples: - 3 last_seen: type: - number - 'null' description: Timestamp when this mesh downlink was last observed readOnly: true examples: - 1470417522 proto: type: string description: 802.11 protocol reported for this mesh downlink examples: - n rssi: type: integer description: Received signal strength for this mesh downlink, in dBm contentEncoding: int32 examples: - -65 rx_bps: type: - integer - 'null' description: Inbound throughput on this mesh downlink, in bits per second contentEncoding: int64 readOnly: true examples: - 60003 rx_bytes: type: - integer - 'null' description: Inbound byte count for this mesh downlink contentEncoding: int64 readOnly: true examples: - 8515104416 rx_packets: type: - integer - 'null' description: Inbound packet count for this mesh downlink contentEncoding: int64 readOnly: true examples: - 57770567 rx_rate: type: - number - 'null' description: Inbound data rate reported for this mesh downlink readOnly: true rx_retries: type: - integer - 'null' description: Inbound retry count reported for this mesh downlink contentEncoding: int32 readOnly: true site_id: type: string description: Site associated with this mesh downlink statistic contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 snr: type: integer description: Signal-to-noise ratio for this mesh downlink, in dB contentEncoding: int32 examples: - 31 tx_bps: type: - integer - 'null' description: Outbound throughput on this mesh downlink, in bits per second contentEncoding: int64 readOnly: true examples: - 634301 tx_bytes: type: - integer - 'null' description: Outbound byte count for this mesh downlink contentEncoding: int64 readOnly: true examples: - 211217389682 tx_packets: type: - integer - 'null' description: Outbound packet count for this mesh downlink contentEncoding: int64 readOnly: true examples: - 812204062 tx_rate: type: - number - 'null' description: Outbound data rate reported for this mesh downlink readOnly: true tx_retries: type: - integer - 'null' description: Outbound retry count reported for this mesh downlink contentEncoding: int32 readOnly: true description: Runtime statistics for a mesh downlink from this AP stats_switch_port_poe_mode1: title: stats_switch_port_poe_mode1 enum: - 802.3af - 802.3at - 802.3bt type: string description: 'PoE mode reported for the port. enum: `802.3af`, `802.3at`, `802.3bt`.' if_stat_property: title: if_stat_property type: object properties: address_mode: type: string description: Address assignment mode reported for the interface ips: uniqueItems: true type: array items: type: string description: Interface IP addresses reported with prefix information nat_addresses: uniqueItems: true type: array items: type: string description: NAT addresses associated with this interface network_name: type: string description: Mist network name associated with this interface port_id: type: string description: Physical or logical port identifier for this interface port_usage: type: string description: Configured usage for this interface, such as LAN or WAN redundancy_state: type: string description: Redundancy state reported for this interface rx_bytes: type: - integer - 'null' description: Received byte counter for this interface contentEncoding: int64 readOnly: true examples: - 8515104416 rx_pkts: type: - integer - 'null' description: Received packet counter for this interface contentEncoding: int64 readOnly: true examples: - 57770567 servp_info: allOf: - $ref: '#/components/schemas/if_stat_property_servp_info2' - description: Service-provider and geolocation details for this interface tx_bytes: type: - integer - 'null' description: Transmitted byte counter for this interface contentEncoding: int64 readOnly: true examples: - 211217389682 tx_pkts: type: - integer - 'null' description: Transmitted packet counter for this interface contentEncoding: int64 readOnly: true examples: - 812204062 up: type: boolean description: Whether the interface is operationally up vlan: type: integer description: Associated VLAN ID for this interface contentEncoding: int32 wan_name: type: string description: Configured WAN name associated with this interface wan_type: type: string description: Configured WAN uplink type associated with this interface description: Interface statistics and metadata reported by a device service_stat_property: title: service_stat_property type: object properties: ash_version: type: string description: Version of the ASH service package cia_version: type: string description: Version of the CIA service package ember_version: type: string description: Version of the Ember service package ipsec_client_version: type: string description: Version of the IPsec client package mist_agent_version: type: string description: Version of the Mist agent package package_version: type: string description: Version of the service package testing_tools_version: type: string description: Version of the testing tools package wheeljack_version: type: string description: Version of the Wheeljack service package description: Version information for gateway service packages stats_wireless_client_wxrule_usage: title: stats_wireless_client_wxrule_usage type: object properties: tag_id: type: string description: WxLAN tag identifier for this rule usage entry contentEncoding: uuid usage: type: integer description: Count recorded for this WxLAN rule usage entry contentEncoding: int32 description: WxLAN rule usage counter for one wireless tag mac_table_stats1: title: mac_table_stats1 type: object properties: mac_table_count: type: integer description: Number of learned MAC table entries currently present contentEncoding: int32 max_mac_entries_supported: type: integer description: Maximum number of MAC table entries supported contentEncoding: int32 description: Layer 2 MAC table utilization statistics for the switch stats_gateway_port: title: stats_gateway_port required: - neighbor_mac - port_id - port_mac type: object properties: active: type: boolean description: Indicates if interface is active/inactive readOnly: true auth_state: allOf: - $ref: '#/components/schemas/port_auth_state1' - description: 'Authentication state of the port. enum: ``, `authenticated`, `authenticating`, `held`, `init`.' disabled: type: boolean description: Indicates if interface is disabled readOnly: true for_site: type: boolean description: Whether the reporting device is scoped to a specific site readOnly: true full_duplex: type: boolean description: Indicates full or half duplex examples: - true jitter: type: number description: Last sampled jitter of the interface readOnly: true latency: type: number description: Last sampled latency of the interface readOnly: true loss: type: number description: Last sampled loss of the interface readOnly: true lte_iccid: type: - string - 'null' description: LTE ICCID value, Check for null/empty lte_imei: type: - string - 'null' description: LTE IMEI value, Check for null/empty lte_imsi: type: - string - 'null' description: LTE IMSI value, Check for null/empty mac_count: type: integer description: Number of MAC addresses in the forwarding table contentEncoding: int32 readOnly: true mac_limit: minimum: 0 type: integer description: Limit on number of dynamically learned macs contentEncoding: int32 readOnly: true neighbor_mac: type: string description: chassis identifier of the chassis type listed readOnly: true examples: - 64d814353400 neighbor_port_desc: type: string description: Description supplied by the system on the interface E.g. "GigabitEthernet2/0/39" readOnly: true examples: - GigabitEthernet1/0/21 neighbor_system_name: type: string description: Name supplied by the system on the interface E.g. neighbor system name E.g. "Kumar-Acc-SW.mist.local" readOnly: true examples: - CORP-D-SW-2 poe_disabled: type: boolean description: Is the POE configured not be disabled. readOnly: true poe_mode: allOf: - $ref: '#/components/schemas/stats_switch_port_poe_mode1' - description: 'PoE mode reported for the port. enum: `802.3af`, `802.3at`, `802.3bt`.' poe_on: type: boolean description: Is the device attached to POE readOnly: true port_id: type: string description: Identifier of the port reporting these statistics readOnly: true examples: - ge-0/0/0 port_mac: type: string description: MAC address assigned to the interface readOnly: true examples: - 5c4527a96580 port_usage: type: string description: Logical usage assigned to the port examples: - lan power_draw: type: number description: Amount of power being used by the interface at the time the command is executed. Unit in watts. readOnly: true rx_bcast_pkts: type: integer description: Number of broadcast packets received on the interface contentEncoding: int32 readOnly: true rx_bps: type: - integer - 'null' description: Receive throughput of the port, in bits per second contentEncoding: int64 readOnly: true examples: - 60003 rx_bytes: type: - integer - 'null' description: Total bytes received on the port contentEncoding: int64 readOnly: true examples: - 8515104416 rx_errors: type: integer description: Number of receive errors observed on the interface contentEncoding: int32 readOnly: true rx_mcast_pkts: type: integer description: Number of multicast packets received on the interface contentEncoding: int32 readOnly: true rx_pkts: type: - integer - 'null' description: Total packets received on the port contentEncoding: int64 readOnly: true examples: - 57770567 speed: type: integer description: Current link speed of the port, in Mbps contentEncoding: int32 readOnly: true examples: - 1000 stp_role: allOf: - $ref: '#/components/schemas/port_stp_role1' - description: 'Current spanning tree role of the port. enum: ``, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`.' stp_state: allOf: - $ref: '#/components/schemas/port_stp_state1' - description: 'Current spanning tree state of the port. enum: ``, `blocking`, `disabled`, `forwarding`, `learning`, `listening`.' tx_bcast_pkts: type: integer description: Number of broadcast packets transmitted on the interface contentEncoding: int32 readOnly: true tx_bps: type: - integer - 'null' description: Transmit throughput of the port, in bits per second contentEncoding: int64 readOnly: true examples: - 634301 tx_bytes: type: - integer - 'null' description: Total bytes transmitted on the port contentEncoding: int64 readOnly: true examples: - 211217389682 tx_errors: type: integer description: Number of transmit errors observed on the interface contentEncoding: int32 readOnly: true tx_mcast_pkts: type: integer description: Number of multicast packets transmitted on the interface contentEncoding: int32 readOnly: true tx_pkts: type: - integer - 'null' description: Total packets transmitted on the port contentEncoding: int64 readOnly: true examples: - 812204062 type: allOf: - $ref: '#/components/schemas/stats_switch_port_type1' - description: 'Detected device category connected to the port, when available. enum: `ap`, `ble`, `gateway`, `mxedge`, `nac`, `switch`.' examples: - gateway unconfigured: type: boolean description: Indicates if interface is unconfigured readOnly: true up: type: boolean description: Indicates if interface is up readOnly: true xcvr_model: type: string description: Optic Slot ModelName, Check for null/empty readOnly: true examples: - SFP+-10G-SR xcvr_part_number: type: string description: Optic Slot Partnumber, Check for null/empty readOnly: true examples: - 740-021487 xcvr_serial: type: string description: Optic Slot SerialNumber, Check for null/empty readOnly: true examples: - N6AA9HT description: Gateway port statistics record returned by stats APIs route_summary_stats1: title: route_summary_stats1 type: object properties: fib_routes: type: integer description: Number of routes installed in the forwarding information base contentEncoding: int32 max_unicast_routes_supported: type: integer description: Supported maximum number of unicast routes contentEncoding: int32 rib_routes: type: integer description: Number of routes present in the routing information base contentEncoding: int32 total_routes: type: integer description: Aggregate number of routes reported by the device contentEncoding: int32 description: Route table summary statistics for the switch response_switch_metrics_version_compliance2: title: response_switch_metrics_version_compliance2 type: object properties: details: allOf: - $ref: '#/components/schemas/response_switch_metrics_version_compliance_details2' - description: Version groupings used to calculate the compliance metric score: type: integer description: Reported metric score for switch software version compliance contentEncoding: int32 total_switch_count: type: integer description: Number of switches included in the version compliance metric contentEncoding: int32 description: Software version compliance metric for switches in the requested scope dot11_bandwidth8: title: dot11_bandwidth8 enum: - 0 - 20 - 40 - 80 - 160 type: integer description: 'Current channel width reported for this radio. enum: `0`, `20`, `40`, `80`, `160`.' examples: - 20 arp_table_stats2: title: arp_table_stats2 type: object properties: arp_table_count: type: integer description: Number of ARP table entries currently present on the device contentEncoding: int32 max_entries_supported: type: integer description: Supported ARP table capacity for the device contentEncoding: int32 description: ARP table utilization statistics for the gateway gateway_compliance_version1: title: gateway_compliance_version1 type: object properties: major_version: type: object additionalProperties: $ref: '#/components/schemas/gateway_compliance_major_version_properties' description: Per-model gateway major-version compliance details score: type: number description: Gateway software version compliance score examples: - 99.9 type: type: string description: Device type represented by the gateway compliance metric examples: - gateway description: Gateway software version compliance metric module_stat_item_pics_item: title: module_stat_item_pics_item type: object properties: index: type: integer description: PIC index within the device module contentEncoding: int32 model_number: type: string description: Model number reported for the PIC port_groups: type: array items: $ref: '#/components/schemas/module_stat_item_pics_item_port_groups_item' description: Port groups provided by this PIC description: Physical Interface Card summary for a device module ap_radio_stat1: title: ap_radio_stat1 type: object properties: bandwidth: allOf: - $ref: '#/components/schemas/dot11_bandwidth8' - description: 'Current channel width reported for this radio. enum: `0`, `20`, `40`, `80`, `160`.' examples: - 20 channel: type: - integer - 'null' description: Current channel the radio is running on contentEncoding: int32 readOnly: true dynamic_chaining_enabled: type: - boolean - 'null' description: Use dynamic chaining for downlink readOnly: true mac: type: - string - 'null' description: Radio base MAC address; a base radio MAC can represent up to 16 BSSIDs (e.g. 5c5b350001a0-5c5b350001af) readOnly: true noise_floor: type: - integer - 'null' description: Measured noise floor for this radio, in dBm contentEncoding: int32 readOnly: true examples: - -90 num_clients: type: - integer - 'null' description: Number of clients currently connected on this radio contentEncoding: int32 readOnly: true num_wlans: type: integer description: How many WLANs are applied to the radio contentEncoding: int32 power: type: - integer - 'null' description: Transmit power (in dBm) contentEncoding: int32 readOnly: true rx_bytes: type: - integer - 'null' description: Received byte count reported for this radio contentEncoding: int64 readOnly: true examples: - 8515104416 rx_pkts: type: - integer - 'null' description: Received packet count reported for this radio contentEncoding: int64 readOnly: true examples: - 57770567 tx_bytes: type: - integer - 'null' description: Transmitted byte count reported for this radio contentEncoding: int64 readOnly: true examples: - 211217389682 tx_pkts: type: - integer - 'null' description: Transmitted packet count reported for this radio contentEncoding: int64 readOnly: true examples: - 812204062 usage: type: - string - 'null' description: Operating band reported for this radio, such as 24, 5, or 6 readOnly: true examples: - '24' util_all: type: - integer - 'null' description: All utilization in percentage contentEncoding: int32 readOnly: true util_non_wifi: type: - integer - 'null' description: Reception of "No Packets" utilization in percentage, received frames with invalid PLCPs and CRS glitches as noise contentEncoding: int32 readOnly: true util_rx_in_bss: type: - integer - 'null' description: Reception of "In BSS" utilization in percentage, only frames that are received from AP/STAs within the BSS contentEncoding: int32 readOnly: true util_rx_other_bss: type: - integer - 'null' description: Reception of "Other BSS" utilization in percentage, all frames received from AP/STAs that are outside the BSS contentEncoding: int32 readOnly: true util_tx: type: - integer - 'null' description: Transmission utilization in percentage contentEncoding: int32 readOnly: true util_undecodable_wifi: type: - integer - 'null' description: Reception of "UnDecodable Wifi" utilization in percentage, only Preamble, PLCP header is decoded, Rest is undecodable in this radio contentEncoding: int32 readOnly: true util_unknown_wifi: type: - integer - 'null' description: Reception of "No Category" utilization in percentage, all 802.11 frames that are corrupted at the receiver contentEncoding: int32 readOnly: true description: 2.4 GHz radio statistics reported by the AP l2tp_state2: title: l2tp_state2 enum: - established - established_with_session - idle - wait-ctrl-conn - wait-ctrl-reply type: string description: 'L2TP tunnel state reported by the AP. enum: `established`, `established_with_session`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`.' examples: - established stats_ap_gps_stat2: title: stats_ap_gps_stat2 type: object properties: accuracy: type: number description: The estimated accuracy or accuracy of the GPS coordinates, measured in meters. examples: - 12.5 altitude: type: number description: The elevation of the AP above sea level, measured in meters. examples: - 99.939 latitude: type: number description: The geographic latitude of the AP, measured in degrees. examples: - 37.29548 longitude: type: number description: The geographic longitude of the AP, measured in degrees. examples: - -122.03304 src: allOf: - $ref: '#/components/schemas/stats_ap_gps_stat_src2' - description: 'Source of the GPS location data. enum: `gps`, `other_ap`, `other_aps`.' timestamp: type: number description: Time when the GPS location data was observed, in epoch seconds readOnly: true description: GPS location data reported for the AP stats_switch_port_type1: title: stats_switch_port_type1 enum: - ap - ble - gateway - mxedge - nac - switch type: string description: 'Detected device category connected to the port, when available. enum: `ap`, `ble`, `gateway`, `mxedge`, `nac`, `switch`.' examples: - gateway stats_gateway_mac_table_stats2: title: stats_gateway_mac_table_stats2 type: object properties: mac_table_count: type: integer description: Number of MAC table entries currently learned by the gateway contentEncoding: int32 max_mac_entries_supported: type: integer description: Maximum MAC table entries supported by the gateway contentEncoding: int32 description: Layer 2 MAC table utilization statistics for the gateway cpu_stat1: title: cpu_stat1 type: object properties: idle: type: - number - 'null' description: Percentage of CPU time that is idle readOnly: true interrupt: type: - number - 'null' description: Percentage of CPU time being used by interrupts readOnly: true load_avg: type: array items: type: number description: Load averages for the last 1, 5, and 15 minutes system: type: - number - 'null' description: Percentage of CPU time being used by system processes readOnly: true usage: type: - number - 'null' description: Overall CPU usage percentage readOnly: true user: type: - number - 'null' description: Percentage of CPU time being used by user processes readOnly: true description: Processor utilization statistics for the switch module response_switch_metrics: title: response_switch_metrics type: object properties: active_ports_summary: allOf: - $ref: '#/components/schemas/response_switch_metrics_active_ports_summary2' - description: Summary metric for active switch ports config_success: allOf: - $ref: '#/components/schemas/response_switch_metrics_config_success' - description: Configuration success metric for switches in the requested scope version_compliance: allOf: - $ref: '#/components/schemas/response_switch_metrics_version_compliance2' - description: Software version compliance metric for switches in the requested scope description: Switch metrics returned for the requested site or switch scope stats_switch_module_stat_item: title: stats_switch_module_stat_item type: object properties: backup_version: type: - string - 'null' description: Backup software version stored on the switch module readOnly: true bios_version: type: - string - 'null' description: BIOS firmware version reported for the switch module readOnly: true boot_partition: type: string description: Active boot partition used by the switch module cpld_version: type: - string - 'null' description: CPLD firmware version reported for the switch module readOnly: true cpu_stat: allOf: - $ref: '#/components/schemas/cpu_stat1' - description: Processor utilization statistics for the switch module errors: type: array items: $ref: '#/components/schemas/module_stat_item_errors_items' description: Hardware error records reported for the switch module fans: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_fans_items' description: Cooling fan status records for the switch module fpc_idx: type: integer description: FPC index identifying this switch module contentEncoding: int32 readOnly: true fpga_version: type: - string - 'null' description: FPGA firmware version reported for the switch module readOnly: true last_seen: type: - number - 'null' description: Time when Mist last observed this switch module, in epoch seconds readOnly: true examples: - 1470417522 locating: type: boolean description: Whether the switch module locator indicator is active mac: type: string description: Switch module MAC address reported by Mist examples: - fc3342123456 memory_stat: allOf: - $ref: '#/components/schemas/memory_stat1' - description: Utilization statistics for switch module memory model: type: - string - 'null' description: Switch module model name reported by Mist readOnly: true examples: - EX4300-48P optics_cpld_version: type: - string - 'null' description: Optics CPLD firmware version reported for the switch module readOnly: true pending_version: type: - string - 'null' description: Pending software version staged for the switch module readOnly: true pics: type: array items: $ref: '#/components/schemas/module_stat_item_pics_item' description: Physical Interface Card status records for the switch module poe: allOf: - $ref: '#/components/schemas/module_stat_item_poe1' - description: Power over Ethernet telemetry for the switch module poe_version: type: - string - 'null' description: PoE controller firmware version reported for the switch module readOnly: true power_cpld_version: type: - string - 'null' description: Power CPLD firmware version reported for the switch module readOnly: true psus: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_psus_item' description: Power supply status records for the switch module re_fpga_version: type: - string - 'null' description: Routing Engine FPGA firmware version reported for the switch module readOnly: true recovery_version: type: - string - 'null' description: Recovery software version stored on the switch module readOnly: true serial: type: - string - 'null' description: Switch module serial number reported by Mist readOnly: true examples: - PX8716230021 status: type: - string - 'null' description: Connection status reported for the switch module readOnly: true temperatures: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_temperatures_item' description: Temperature sensor readings for the switch module tmc_fpga_version: type: - string - 'null' description: TMC FPGA firmware version reported for the switch module readOnly: true type: type: - string - 'null' description: Module type reported for the switch module readOnly: true uboot_version: type: - string - 'null' description: U-Boot firmware version reported for the switch module readOnly: true uptime: type: - integer - 'null' description: Elapsed time since the switch module last booted, in seconds contentEncoding: int32 readOnly: true vc_links: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_vc_links_item' description: Virtual chassis link records for the switch module vc_mode: type: - string - 'null' description: Virtual chassis mode reported for the switch module readOnly: true vc_role: type: - string - 'null' description: 'enum: `master`, `backup`, `linecard`' readOnly: true examples: - master vc_state: type: - string - 'null' description: Virtual chassis state reported for the switch module readOnly: true version: type: - string - 'null' description: Software version running on the switch module readOnly: true description: Hardware module status and firmware inventory for a switch stats_switch_clients_stats_total2: title: stats_switch_clients_stats_total2 type: object properties: num_aps: type: array items: type: integer contentEncoding: int32 description: AP counts included in the aggregate switch client statistics num_wired_clients: type: integer description: Number of wired clients included in the aggregate switch client statistics contentEncoding: int32 description: Aggregate client counts across the switch module_stat_item_temperatures_item: title: module_stat_item_temperatures_item type: object properties: celsius: type: number description: Temperature reading for the sensor, in degrees Celsius examples: - 45 name: type: string description: Temperature sensor label reported by the device examples: - CPU status: type: string description: Operational status reported for the temperature sensor examples: - ok description: Temperature sensor reading for a device module fwupdate_stat4: title: fwupdate_stat4 type: object properties: progress: maximum: 100 minimum: 0 type: - integer - 'null' description: Firmware update progress percentage, or null when unavailable contentEncoding: int32 readOnly: true examples: - 10 status: allOf: - oneOf: - {} - $ref: '#/components/schemas/fwupdate_stat_status2' - description: 'Current firmware update status. enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`.' readOnly: true status_id: type: - integer - 'null' description: Numeric firmware update status identifier contentEncoding: int32 readOnly: true examples: - 5 timestamp: type: number description: Time when the firmware update status was last updated readOnly: true will_retry: type: - boolean - 'null' description: Whether the firmware update process will retry after the current status readOnly: true examples: - false description: Firmware update status for the gateway stats_ap_radio_config_band4: title: stats_ap_radio_config_band4 type: object properties: allow_rrm_disable: type: - boolean - 'null' description: Whether RRM disablement is allowed for this radio band readOnly: true bandwidth: type: - number - 'null' description: Channel bandwidth configured for this radio band readOnly: true examples: - 20 channel: type: integer description: Operating channel configured for this radio band contentEncoding: int32 examples: - 1 disabled: type: - boolean - 'null' description: Whether this radio band is disabled readOnly: true dynamic_chaining_enabled: type: - boolean - 'null' description: Whether dynamic chaining is enabled for this radio band readOnly: true examples: - false power: type: - number - 'null' description: Transmit power configured for this radio band readOnly: true examples: - 10 power_max: type: - number - 'null' description: Maximum transmit power allowed for this radio band readOnly: true examples: - 10 power_min: type: - number - 'null' description: Minimum transmit power allowed for this radio band readOnly: true examples: - 10 rx_chain: type: - integer - 'null' description: Number of receive chains enabled for this radio band contentEncoding: int32 readOnly: true examples: - 4 tx_chain: type: - integer - 'null' description: Number of transmit chains enabled for this radio band contentEncoding: int32 readOnly: true examples: - 4 description: 2.4 GHz radio configuration reported by the AP fwupdate_stat3: title: fwupdate_stat3 type: object properties: progress: maximum: 100 minimum: 0 type: - integer - 'null' description: Firmware update progress percentage, or null when unavailable contentEncoding: int32 readOnly: true examples: - 10 status: allOf: - oneOf: - {} - $ref: '#/components/schemas/fwupdate_stat_status2' - description: 'Current firmware update status. enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`.' readOnly: true status_id: type: - integer - 'null' description: Numeric firmware update status identifier contentEncoding: int32 readOnly: true examples: - 5 timestamp: type: number description: Time when the firmware update status was last updated readOnly: true will_retry: type: - boolean - 'null' description: Whether the firmware update process will retry after the current status readOnly: true examples: - false description: Firmware update status for the switch memory_stat1: title: memory_stat1 required: - usage type: object properties: usage: type: number description: Current memory utilization percentage for the device or master Routing Engine description: Utilization statistics for switch module memory route_summary_stats2: title: route_summary_stats2 type: object properties: fib_routes: type: integer description: Number of routes installed in the forwarding information base contentEncoding: int32 max_unicast_routes_supported: type: integer description: Supported maximum number of unicast routes contentEncoding: int32 rib_routes: type: integer description: Number of routes present in the routing information base contentEncoding: int32 total_routes: type: integer description: Aggregate number of routes reported by the device contentEncoding: int32 description: Route table summary statistics for the gateway memory_stat3: title: memory_stat3 required: - usage type: object properties: usage: type: number description: Current memory utilization percentage for the device or master Routing Engine description: Secondary-node memory utilization statistics for the gateway port_stp_role1: title: port_stp_role1 enum: - alternate - backup - designated - disabled - root - root-prevented type: string description: 'Current spanning tree role of the port. enum: ``, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`.' dot11_band3: title: dot11_band3 enum: - '24' - '5' - 5-dedicated - 5-selectable - '6' - 6-dedicated - 6-selectable type: string description: 'Wi-Fi radio band used by the wireless client connection. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`.' stats_wireless_client_airwatch2: title: stats_wireless_client_airwatch2 required: - authorized type: object properties: authorized: type: boolean description: Whether the wireless client is authorized by AirWatch description: Mobile device management authorization information from AirWatch for the wireless client stats_gateway: title: stats_gateway required: - mac - type type: object properties: ap_redundancy: allOf: - $ref: '#/components/schemas/ap_redundancy2' - description: AP redundancy statistics associated with the gateway arp_table_stats: allOf: - $ref: '#/components/schemas/arp_table_stats2' - description: ARP table utilization statistics for the gateway auto_upgrade_stat: allOf: - $ref: '#/components/schemas/stats_ap_auto_upgrade3' - description: Automatic firmware upgrade status for the gateway bgp_peers: type: array items: $ref: '#/components/schemas/bgp_peer' description: BGP peer statistics reported by the gateway cert_expiry: type: integer description: Time when the gateway certificate expires, in epoch seconds contentEncoding: int64 cluster_config: allOf: - $ref: '#/components/schemas/stats_cluster_config1' - description: High-availability cluster configuration and health for the gateway cluster_stat: allOf: - $ref: '#/components/schemas/stats_gateway_cluster2' - description: High-availability cluster state summary for the gateway conductor_name: type: string description: SSR conductor name associated with the gateway, when applicable readOnly: true config_status: type: string description: Configuration synchronization status reported for the gateway readOnly: true config_timestamp: type: integer description: Time when the gateway configuration status was last updated, in epoch seconds contentEncoding: int32 config_version: type: integer description: Currently applied configuration version for the gateway contentEncoding: int32 cpu2_stat: allOf: - $ref: '#/components/schemas/cpu_stat3' - description: Processor utilization statistics for the secondary HA node cpu_stat: allOf: - $ref: '#/components/schemas/cpu_stat4' - description: Processor utilization statistics for the gateway or primary HA node created_time: type: number description: Time when the gateway record was created, in epoch seconds readOnly: true deviceprofile_id: type: - string - 'null' description: Applied device profile identifier for the gateway, when present contentEncoding: uuid readOnly: true deviceprofile_name: type: string description: Applied device profile name for the gateway dhcpd2_stat: type: object additionalProperties: $ref: '#/components/schemas/dhcpd_stat_lan' description: Lease pool statistics from the secondary-node DHCP service dhcpd_stat: type: object additionalProperties: $ref: '#/components/schemas/dhcpd_stat_lan' description: Lease pool statistics from the gateway DHCP service evpntopo_id: type: - string - 'null' description: Associated EVPN topology identifier for the gateway, when present contentEncoding: uuid readOnly: true ext_ip: type: - string - 'null' description: Public IP address observed for the gateway readOnly: true examples: - 66.129.234.224 fwupdate: allOf: - $ref: '#/components/schemas/fwupdate_stat4' - description: Firmware update status for the gateway has_pcap: type: - boolean - 'null' description: Whether packet capture is available for the gateway readOnly: true hostname: type: string description: Device-reported hostname for the gateway examples: - sj1 id: type: string description: Unique identifier of the gateway record contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f if2_stat: type: object additionalProperties: $ref: '#/components/schemas/if_stat_property' description: Interface traffic statistics for the secondary HA node if_stat: type: object additionalProperties: $ref: '#/components/schemas/if_stat_property' description: Interface traffic statistics for the gateway or primary HA node ip: type: - string - 'null' description: Management IP address reported for the gateway readOnly: true examples: - 10.2.11.137 ip2_stat: allOf: - $ref: '#/components/schemas/ip_stat3' - description: Layer 3 address statistics for the secondary HA node ip_stat: allOf: - $ref: '#/components/schemas/ip_stat4' - description: Layer 3 address statistics for the gateway or primary HA node is_ha: type: - boolean - 'null' description: Whether the gateway is part of an HA cluster readOnly: true last_seen: type: - number - 'null' description: Time when Mist last observed the gateway, in epoch seconds readOnly: true examples: - 1470417522 mac: type: string description: Gateway MAC address reported by Mist examples: - dc38e1dbf3cd mac_table_stats: allOf: - $ref: '#/components/schemas/stats_gateway_mac_table_stats2' - description: Layer 2 MAC table utilization statistics for the gateway map_id: type: - string - 'null' description: Placement map identifier associated with the gateway, when present contentEncoding: uuid readOnly: true memory2_stat: allOf: - $ref: '#/components/schemas/memory_stat3' - description: Secondary-node memory utilization statistics for the gateway memory_stat: allOf: - $ref: '#/components/schemas/memory_stat4' - description: Utilization statistics for gateway memory model: type: string description: Gateway model name reported by Mist examples: - SRX320 modified_time: type: number description: Time when the gateway record was last modified, in epoch seconds readOnly: true module2_stat: maxItems: 1 minItems: 0 type: array items: $ref: '#/components/schemas/stats_gateway_module_stat_item' description: Hardware module statistics for the secondary HA node module_stat: maxItems: 1 minItems: 0 type: array items: $ref: '#/components/schemas/stats_gateway_module_stat_item' description: Hardware module statistics for the gateway or primary HA node name: type: string description: Device name if configured readOnly: true examples: - sj1 node_name: type: string description: HA node name for the gateway, such as node0 or node1 readOnly: true examples: - node0 org_id: type: string description: Owning organization identifier for the gateway statistics record contentEncoding: uuid readOnly: true examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 ports: type: array items: $ref: '#/components/schemas/stats_gateway_port' description: Port statistics reported by the gateway route_summary_stats: allOf: - $ref: '#/components/schemas/route_summary_stats2' - description: Route table summary statistics for the gateway router_name: type: string description: Device name if configured readOnly: true examples: - sj1 serial: type: string description: Gateway serial number reported by Mist readOnly: true examples: - TC3714190003 service2_stat: type: object additionalProperties: $ref: '#/components/schemas/service_stat_property' description: System service statistics for the secondary HA node service_stat: type: object additionalProperties: $ref: '#/components/schemas/service_stat_property' description: System service statistics for the gateway or primary HA node service_status: allOf: - $ref: '#/components/schemas/stats_gateway_service_status2' - description: Security service status reported by the gateway site_id: type: string description: Associated site identifier for the gateway statistics record contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 spu2_stat: type: array items: $ref: '#/components/schemas/stats_gateway_spu_item' description: Secondary-node Services Processing Unit statistics for the gateway spu_stat: type: array items: $ref: '#/components/schemas/stats_gateway_spu_item' description: Services Processing Unit statistics for the gateway or primary HA node status: type: string description: Connection status reported for the gateway, such as connected readOnly: true examples: - connected tag_id: type: integer description: Numeric inventory tag identifier associated with the gateway contentEncoding: int32 tag_uuid: type: string description: Inventory tag UUID associated with the gateway contentEncoding: uuid tunnels: type: array items: $ref: '#/components/schemas/stats_gateway_wan_tunnel' description: WAN tunnel statistics for the gateway type: const: gateway type: string description: Device type discriminator for gateway statistics readOnly: true uptime: type: - number - 'null' description: Elapsed time since the gateway last booted, in seconds readOnly: true examples: - 3671219 version: type: - string - 'null' description: Software version running on the gateway readOnly: true examples: - 18.4R1.8 vpn_peers: type: array items: $ref: '#/components/schemas/stats_gateway_vpn_peer' description: Remote VPN peer statistics for the gateway description: Gateway statistics reported by Mist for a site or organization stats response cpu_stat2: title: cpu_stat2 type: object properties: idle: type: - number - 'null' description: Percentage of CPU time that is idle readOnly: true interrupt: type: - number - 'null' description: Percentage of CPU time being used by interrupts readOnly: true load_avg: type: array items: type: number description: Load averages for the last 1, 5, and 15 minutes system: type: - number - 'null' description: Percentage of CPU time being used by system processes readOnly: true usage: type: - number - 'null' description: Overall CPU usage percentage readOnly: true user: type: - number - 'null' description: Percentage of CPU time being used by user processes readOnly: true description: Processor utilization statistics for the switch stats_ap_lldp_stat2: title: stats_ap_lldp_stat2 type: object properties: chassis_id: type: - string - 'null' description: LLDP neighbor chassis identifier readOnly: true lldp_med_supported: type: - boolean - 'null' description: Whether it support LLDP-MED readOnly: true mgmt_addr: type: - string - 'null' description: Management IP address of the switch readOnly: true mgmt_addrs: type: array items: type: string description: Management IP addresses advertised by the LLDP neighbor port_desc: type: - string - 'null' description: Port description, e.g. “2/20”, “Port 2 on Switch0” readOnly: true examples: - 2/20 port_id: type: - string - 'null' description: LLDP neighbor port identifier readOnly: true examples: - ge-0/0/4 power_allocated: type: - number - 'null' description: In mW, power allocated by PSE readOnly: true power_avail: type: integer description: In mW, total Power Avail at AP from pwr source contentEncoding: int32 power_budget: type: integer description: In mW, surplus if positive or deficit if negative contentEncoding: int32 power_constrained: type: boolean description: Whether power is insufficient power_draw: type: - number - 'null' description: In mW, total power needed by PD readOnly: true power_needed: type: integer description: In mW, total Power needed incl Peripherals contentEncoding: int32 power_opmode: type: string description: Power operating mode negotiated through LLDP power_request_count: type: - integer - 'null' description: Number of negotiations, if it keeps increasing, we don’ t have a stable power contentEncoding: int32 readOnly: true power_requested: type: - number - 'null' description: In mW, power requested by PD readOnly: true power_src: type: string description: Primary AP power source reported through LLDP power_srcs: type: array items: type: string description: AP power sources reported through LLDP system_desc: type: - string - 'null' description: Description provided by switch readOnly: true examples: - 'uniper Networks, Inc. ex4300-48t internet router, kernel JUNOS 20.4R3-S7.2, Build date: 2023-04-21 19:47:18 UTC Copyright (c) 1996-2023 Juniper Networks, Inc.' system_name: type: - string - 'null' description: Name of the switch readOnly: true examples: - Core-AE23 description: Primary LLDP neighbor and power negotiation details for the AP stats_wireless_client_rssi_zone: title: stats_wireless_client_rssi_zone type: object properties: id: type: string description: RSSI zone identifier that currently contains the wireless client contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f since: type: number description: Time when the wireless client entered the RSSI zone, in epoch seconds description: RSSI zone currently containing a wireless client stats_ap_env_stat2: title: stats_ap_env_stat2 type: object properties: accel_x: type: - number - 'null' description: X-axis accelerometer reading reported by the AP readOnly: true examples: - 0 accel_y: type: - number - 'null' description: Y-axis accelerometer reading reported by the AP readOnly: true examples: - 0.032 accel_z: type: - number - 'null' description: Z-axis accelerometer reading reported by the AP readOnly: true examples: - -1.088 ambient_temp: type: - integer - 'null' description: Temperature reading from the AP ambient sensor contentEncoding: int32 readOnly: true examples: - 43 attitude: type: - integer - 'null' description: Device attitude or orientation reading reported by the AP contentEncoding: int32 readOnly: true examples: - 0 cpu_temp: type: - integer - 'null' description: Temperature reading from the AP CPU sensor contentEncoding: int32 readOnly: true examples: - 61 humidity: type: - integer - 'null' description: Relative humidity sensor reading reported by the AP contentEncoding: int32 readOnly: true examples: - 9 magne_x: type: - number - 'null' description: X-axis magnetometer reading reported by the AP readOnly: true examples: - 0 magne_y: type: - number - 'null' description: Y-axis magnetometer reading reported by the AP readOnly: true examples: - 0 magne_z: type: - number - 'null' description: Z-axis magnetometer reading reported by the AP readOnly: true examples: - 0 pressure: type: - number - 'null' description: Barometric pressure sensor reading reported by the AP readOnly: true examples: - 968 vcore_voltage: type: - integer - 'null' description: Core voltage sensor reading reported by the AP contentEncoding: int32 readOnly: true examples: - 0 description: Environmental sensor readings reported by the AP ip_stat1: title: ip_stat1 type: object properties: dhcp_server: type: - string - 'null' description: Reported DHCP server IPv4 address for the interface, when available readOnly: true examples: - 192.168.95.1 dns: uniqueItems: true type: array items: type: string description: Reported DNS server addresses for the interface dns_suffix: uniqueItems: true type: array items: type: string description: Reported DNS search suffixes for the interface gateway: type: - string - 'null' description: Current IPv4 default gateway for the interface, when available readOnly: true gateway6: type: - string - 'null' description: Current IPv6 default gateway for the interface, when available readOnly: true examples: - fdad:b0bc:f29e::1 ip: type: - string - 'null' description: Current IPv4 address for the interface, when available readOnly: true examples: - 10.3.3.1 ip6: type: - string - 'null' description: Current IPv6 address for the interface, when available readOnly: true examples: - fdad:b0bc:f29e::3d16 ips: type: object additionalProperties: type: string nullable: true description: Per-VLAN IP address summaries keyed by VLAN name netmask: type: - string - 'null' description: Current IPv4 subnet mask for the interface, when available readOnly: true examples: - 255.255.255.0 netmask6: type: - string - 'null' description: Current IPv6 prefix length for the interface, when available readOnly: true examples: - /64 description: Read-only IP addressing status reported by the AP stats_ap_auto_upgrade4: title: stats_ap_auto_upgrade4 type: object properties: lastcheck: type: - integer - 'null' description: Time when the AP last checked for auto-upgrade, in epoch seconds contentEncoding: int64 readOnly: true examples: - 1720594762 description: Automatic firmware upgrade status for the AP ip_stat2: title: ip_stat2 type: object properties: dhcp_server: type: - string - 'null' description: Reported DHCP server IPv4 address for the interface, when available readOnly: true examples: - 192.168.95.1 dns: uniqueItems: true type: array items: type: string description: Reported DNS server addresses for the interface dns_suffix: uniqueItems: true type: array items: type: string description: Reported DNS search suffixes for the interface gateway: type: - string - 'null' description: Current IPv4 default gateway for the interface, when available readOnly: true gateway6: type: - string - 'null' description: Current IPv6 default gateway for the interface, when available readOnly: true examples: - fdad:b0bc:f29e::1 ip: type: - string - 'null' description: Current IPv4 address for the interface, when available readOnly: true examples: - 10.3.3.1 ip6: type: - string - 'null' description: Current IPv6 address for the interface, when available readOnly: true examples: - fdad:b0bc:f29e::3d16 ips: type: object additionalProperties: type: string nullable: true description: Per-VLAN IP address summaries keyed by VLAN name netmask: type: - string - 'null' description: Current IPv4 subnet mask for the interface, when available readOnly: true examples: - 255.255.255.0 netmask6: type: - string - 'null' description: Current IPv6 prefix length for the interface, when available readOnly: true examples: - /64 description: Layer 3 address statistics for the switch switch_metric_type: title: switch_metric_type const: active_ports_summary type: string description: 'Switch metric type requested for active port summaries. enum: `active_ports_summary`' switch_metrics_active_ports_summary_details2: title: switch_metrics_active_ports_summary_details2 type: object properties: active_port_count: type: integer description: Number of active ports observed across evaluated switches contentEncoding: int32 total_port_count: type: integer description: Total number of ports evaluated for the active-port metric contentEncoding: int32 description: Port counts used to calculate the active-port summary metric switch_metrics_compliance_major_version: title: switch_metrics_compliance_major_version type: object properties: major_count: type: integer description: Number of switches in this software version grouping contentEncoding: int32 major_version: type: string description: Software version represented by this compliance grouping model: type: string description: Switch model represented by this compliance grouping system_names: uniqueItems: true type: array items: type: string description: Switch system names included in this compliance grouping description: Version compliance grouping for one switch model stats_ap_iot_stat_additional_properties: title: stats_ap_iot_stat_additional_properties type: object properties: value: type: - integer - 'null' description: Reported value for this IoT input contentEncoding: int32 readOnly: true description: IoT input statistic value wan_tunnel_protocol1: title: wan_tunnel_protocol1 enum: - gre - ipsec type: string description: 'Tunnel protocol used for the connection. enum: `gre`, `ipsec`.' stats_ap_auto_upgrade2: title: stats_ap_auto_upgrade2 type: object properties: lastcheck: type: - integer - 'null' description: Time when the AP last checked for auto-upgrade, in epoch seconds contentEncoding: int64 readOnly: true examples: - 1720594762 description: Automatic firmware upgrade status for the switch switch_metric_scope: title: switch_metric_scope enum: - site - switch type: string description: 'Scope level used when querying switch metrics. enum: `site`, `switch`' stats_gateway_cluster2: title: stats_gateway_cluster2 type: object properties: state: type: - string - 'null' description: Current HA cluster state for the gateway readOnly: true description: High-availability cluster state summary for the gateway response_http403: title: response_http403 type: object properties: detail: type: string description: Human-readable explanation of the permission error examples: - You do not have permission to perform this action. description: Standard HTTP 403 permission error response stats_cluster_config_control_link_info2: title: stats_cluster_config_control_link_info2 type: object properties: name: type: string description: Control link interface name reported by the gateway cluster status: type: string description: Operational state reported for the control link description: Control link interface and operational state for the gateway cluster stats_switch_port: title: stats_switch_port required: - mac - org_id - port_id - site_id type: object properties: active: type: boolean description: Indicates if interface is active/inactive readOnly: true auth_state: allOf: - $ref: '#/components/schemas/port_auth_state1' - description: 'Authentication state of the port. enum: ``, `authenticated`, `authenticating`, `held`, `init`.' disabled: type: boolean description: Indicates if interface is disabled readOnly: true for_site: type: boolean description: Whether the reporting device is scoped to a specific site readOnly: true full_duplex: type: boolean description: Indicates full or half duplex examples: - true jitter: type: number description: Last sampled jitter of the interface readOnly: true last_flapped: type: number description: Indicates when the port was last flapped readOnly: true latency: type: number description: Last sampled latency of the interface readOnly: true loss: type: number description: Last sampled loss of the interface readOnly: true lte_iccid: type: - string - 'null' description: LTE ICCID value, Check for null/empty lte_imei: type: - string - 'null' description: LTE IMEI value, Check for null/empty lte_imsi: type: - string - 'null' description: LTE IMSI value, Check for null/empty mac: type: string description: Switch MAC address that reported these port statistics readOnly: true examples: - 5c4527a96580 mac_count: type: integer description: Number of MAC addresses in the forwarding table contentEncoding: int32 readOnly: true mac_limit: minimum: 0 type: integer description: Limit on number of dynamically learned macs contentEncoding: int32 readOnly: true neighbor_mac: type: string description: chassis identifier of the chassis type listed readOnly: true examples: - 64d814353400 neighbor_port_desc: type: string description: Description supplied by the system on the interface E.g. "GigabitEthernet2/0/39" readOnly: true examples: - GigabitEthernet1/0/21 neighbor_system_name: type: string description: Name supplied by the system on the interface E.g. neighbor system name E.g. "Kumar-Acc-SW.mist.local" readOnly: true examples: - CORP-D-SW-2 org_id: type: string description: Organization identifier of the reporting switch contentEncoding: uuid readOnly: true examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 poe_disabled: type: boolean description: Is the POE disabled readOnly: true poe_mode: allOf: - $ref: '#/components/schemas/stats_switch_port_poe_mode1' - description: 'PoE mode reported for the port. enum: `802.3af`, `802.3at`, `802.3bt`.' poe_on: type: boolean description: Is the device attached to POE readOnly: true poe_priority: allOf: - $ref: '#/components/schemas/poe_priority2' - description: 'PoE priority configured for the port. enum: `low`, `high`.' port_id: type: string description: Identifier of the port reporting these statistics readOnly: true examples: - ge-0/0/0 port_mac: type: string description: MAC address assigned to the interface readOnly: true examples: - 5c4527a96580 port_usage: type: string description: Logical usage assigned to the port examples: - lan power_draw: type: number description: Amount of power being used by the interface at the time the command is executed. Unit in watts. readOnly: true rx_bcast_pkts: type: integer description: Number of broadcast packets received on the interface contentEncoding: int32 readOnly: true rx_bps: type: - integer - 'null' description: Receive throughput of the port, in bits per second contentEncoding: int64 readOnly: true examples: - 60003 rx_bytes: type: - integer - 'null' description: Total bytes received on the port contentEncoding: int64 readOnly: true examples: - 8515104416 rx_errors: type: integer description: Number of receive errors observed on the interface contentEncoding: int32 readOnly: true rx_mcast_pkts: type: integer description: Number of multicast packets received on the interface contentEncoding: int32 readOnly: true rx_pkts: type: - integer - 'null' description: Total packets received on the port contentEncoding: int64 readOnly: true examples: - 57770567 site_id: type: string description: Site identifier of the reporting switch contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 speed: type: integer description: Current link speed of the port, in Mbps contentEncoding: int32 readOnly: true examples: - 1000 stp_role: allOf: - $ref: '#/components/schemas/port_stp_role1' - description: 'Current spanning tree role of the port. enum: ``, `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`.' stp_state: allOf: - $ref: '#/components/schemas/port_stp_state1' - description: 'Current spanning tree state of the port. enum: ``, `blocking`, `disabled`, `forwarding`, `learning`, `listening`.' tx_bcast_pkts: type: integer description: Number of broadcast packets transmitted on the interface contentEncoding: int32 readOnly: true tx_bps: type: - integer - 'null' description: Transmit throughput of the port, in bits per second contentEncoding: int64 readOnly: true examples: - 634301 tx_bytes: type: - integer - 'null' description: Total bytes transmitted on the port contentEncoding: int64 readOnly: true examples: - 211217389682 tx_errors: type: integer description: Number of transmit errors observed on the interface contentEncoding: int32 readOnly: true tx_mcast_pkts: type: integer description: Number of multicast packets transmitted on the interface contentEncoding: int32 readOnly: true tx_pkts: type: - integer - 'null' description: Total packets transmitted on the port contentEncoding: int64 readOnly: true examples: - 812204062 type: allOf: - $ref: '#/components/schemas/stats_switch_port_type1' - description: 'Detected device category connected to the port, when available. enum: `ap`, `ble`, `gateway`, `mxedge`, `nac`, `switch`.' examples: - gateway unconfigured: type: boolean description: Indicates if interface is unconfigured readOnly: true up: type: boolean description: Indicates if interface is up readOnly: true uplink: type: boolean description: Indicates if interface is an uplink port readOnly: true xcvr_model: type: string description: Optic Slot ModelName, Check for null/empty readOnly: true examples: - SFP+-10G-SR xcvr_part_number: type: string description: Optic Slot Partnumber, Check for null/empty readOnly: true examples: - 740-021487 xcvr_serial: type: string description: Optic Slot SerialNumber, Check for null/empty readOnly: true examples: - N6AA9HT description: Switch port statistics record returned by stats APIs dhcpd_stat_lan: title: dhcpd_stat_lan type: object properties: num_ips: type: integer description: Total number of IP addresses in the DHCP pool contentEncoding: int32 examples: - 100 num_leased: type: integer description: Number of DHCP pool addresses currently leased contentEncoding: int32 examples: - 20 description: DHCP lease statistics for one network stats_switch_client_item: title: stats_switch_client_item type: object properties: device_mac: type: string description: Switch MAC address for the device reporting this client entry hostname: type: string description: Reported client hostname, when known mac: type: string description: Client MAC address observed on the switch port port_id: type: string description: Switch port identifier where the client was observed description: Client observed on a switch port in switch statistics stats_switch_ap_redundancy_module: title: stats_switch_ap_redundancy_module type: object properties: num_aps: type: integer description: Total number of APs connected through this switch member contentEncoding: int32 examples: - 15 num_aps_with_switch_redundancy: type: integer description: Number of APs on this switch member with switch redundancy coverage contentEncoding: int32 examples: - 8 description: AP switch redundancy counts for one VC or stack member stats_gateway_wan_tunnel: title: stats_gateway_wan_tunnel type: object properties: auth_algo: type: string description: Authentication algorithm negotiated for the tunnel encrypt_algo: type: string description: Encryption algorithm negotiated for the tunnel ike_version: type: string description: IKE version used to establish the tunnel ip: type: string description: Local IP address used by the tunnel last_event: type: string description: Most recent reason the tunnel went down last_flapped: type: number description: Indicates when the tunnel last flapped node: type: string description: HA node handling the tunnel, such as node0 or node1 peer_host: type: string description: Hostname or configured peer host of the remote tunnel endpoint peer_ip: type: string description: IP address of the remote tunnel endpoint priority: allOf: - $ref: '#/components/schemas/tunnel_priority1' - description: 'Relative preference assigned to the tunnel. enum: `primary`, `secondary`.' protocol: allOf: - $ref: '#/components/schemas/wan_tunnel_protocol1' - description: 'Tunnel protocol used for the connection. enum: `gre`, `ipsec`.' rx_bytes: type: - integer - 'null' description: Total bytes received on the tunnel contentEncoding: int64 readOnly: true examples: - 8515104416 rx_pkts: type: - integer - 'null' description: Total packets received on the tunnel contentEncoding: int64 readOnly: true examples: - 57770567 tunnel_name: type: string description: Name of the Mist-managed WAN tunnel tx_bytes: type: - integer - 'null' description: Total bytes transmitted on the tunnel contentEncoding: int64 readOnly: true examples: - 211217389682 tx_pkts: type: - integer - 'null' description: Total packets transmitted on the tunnel contentEncoding: int64 readOnly: true examples: - 812204062 up: type: boolean description: Indicates whether the tunnel is currently up uptime: type: integer description: Duration since the tunnel security association was established contentEncoding: int32 wan_name: type: string description: Name of the WAN interface carrying the tunnel examples: - wan description: WAN tunnel statistics reported by a gateway l2tp_state1: title: l2tp_state1 enum: - established - established_with_session - idle - wait-ctrl-conn - wait-ctrl-reply type: string description: 'L2TP session state reported by the AP. enum: `established`, `established_with_session`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`.' examples: - established memory_stat4: title: memory_stat4 required: - usage type: object properties: usage: type: number description: Current memory utilization percentage for the device or master Routing Engine description: Utilization statistics for gateway memory stats_ap_ble2: title: stats_ap_ble2 type: object properties: beacon_enabled: type: - boolean - 'null' description: Whether Mist BLE beacon transmission is enabled readOnly: true beacon_rate: type: - integer - 'null' description: Mist BLE beacon transmit rate, in beacons per second contentEncoding: int32 readOnly: true examples: - 3 eddystone_uid_enabled: type: - boolean - 'null' description: Whether Eddystone-UID beacon transmission is enabled readOnly: true examples: - false eddystone_uid_freq_msec: type: - integer - 'null' description: Interval for Eddystone-UID advertisements, in milliseconds contentEncoding: int32 readOnly: true examples: - 2000 eddystone_uid_instance: type: - string - 'null' description: Eddystone-UID instance value broadcast by the AP readOnly: true examples: - 5c5b35000001 eddystone_uid_namespace: type: - string - 'null' description: Eddystone-UID namespace value broadcast by the AP readOnly: true examples: - 2818e3868dec25629ede eddystone_url_enabled: type: - boolean - 'null' description: Whether Eddystone-URL beacon transmission is enabled readOnly: true examples: - true eddystone_url_freq_msec: type: - integer - 'null' description: Interval for Eddystone-URL advertisements, in milliseconds contentEncoding: int32 readOnly: true examples: - 100 eddystone_url_url: type: - string - 'null' description: URL broadcast by the Eddystone-URL beacon readOnly: true examples: - https://www.abc.com ibeacon_enabled: type: - boolean - 'null' description: Whether iBeacon transmission is enabled readOnly: true examples: - true ibeacon_freq_msec: type: - integer - 'null' description: Interval for iBeacon advertisements, in milliseconds contentEncoding: int32 readOnly: true examples: - 2000 ibeacon_major: maximum: 65535 minimum: 1 type: - integer - 'null' description: Major value broadcast in iBeacon advertisements contentEncoding: int32 examples: - 1234 ibeacon_minor: maximum: 65535 minimum: 1 type: - integer - 'null' description: Minor value broadcast in iBeacon advertisements contentEncoding: int32 examples: - 1234 ibeacon_uuid: type: - string - 'null' description: UUID value broadcast in iBeacon advertisements contentEncoding: uuid examples: - f3f17139-704a-f03a-2786-0400279e37c3 major: type: - integer - 'null' description: Reported iBeacon major value for BLE statistics contentEncoding: int32 readOnly: true examples: - 12345 minors: type: array items: type: integer contentEncoding: int32 description: Reported iBeacon minor values for BLE statistics power: type: - integer - 'null' description: BLE transmit power setting reported by the AP contentEncoding: int32 readOnly: true examples: - 10 rx_bytes: type: - integer - 'null' description: BLE bytes received by the AP contentEncoding: int64 readOnly: true examples: - 8515104416 rx_pkts: type: - integer - 'null' description: BLE packets received by the AP contentEncoding: int64 readOnly: true examples: - 57770567 tx_bytes: type: - integer - 'null' description: BLE bytes transmitted by the AP contentEncoding: int64 readOnly: true examples: - 211217389682 tx_pkts: type: - integer - 'null' description: BLE packets transmitted by the AP contentEncoding: int64 readOnly: true examples: - 812204062 tx_resets: type: - integer - 'null' description: Resets due to tx hung contentEncoding: int32 readOnly: true examples: - 0 uuid: type: - string - 'null' description: Beacon UUID reported by BLE statistics contentEncoding: uuid readOnly: true examples: - ada72f8f-1643-e5c6-94db-f2a5636f1a64 description: BLE radio and beacon statistics reported by the AP gateway_compliance_major_version_properties: title: gateway_compliance_major_version_properties type: object properties: major_count: type: integer description: Number of gateways counted in this major-version compliance entry contentEncoding: int32 major_version: type: string description: Gateway software major version represented by this compliance entry examples: - 19.4R2-S1.2 description: Version-compliance details for one gateway model stats_ap_switch_redundancy2: title: stats_ap_switch_redundancy2 type: object properties: num_redundant_aps: type: - integer - 'null' description: Number of redundant APs available for switch redundancy contentEncoding: int32 readOnly: true examples: - 1 description: Switch redundancy status reported for the AP module_stat_item_poe2: title: module_stat_item_poe2 type: object properties: max_power: type: number description: Total PoE power budget available to the module, in watts examples: - 250 power_draw: type: number description: Current PoE power draw on the module, in watts examples: - 120.3 status: type: string description: Operational status of PoE on the module description: Power over Ethernet telemetry for the gateway module ap_stat_mesh_uplink1: title: ap_stat_mesh_uplink1 type: object properties: band: type: string description: Radio band used by this mesh uplink examples: - '5' channel: type: integer description: Radio channel used by this mesh uplink contentEncoding: int32 examples: - 36 idle_time: type: integer description: Seconds since traffic was last observed on this mesh uplink contentEncoding: int32 examples: - 3 last_seen: type: - number - 'null' description: Timestamp when this mesh uplink was last observed readOnly: true examples: - 1470417522 proto: type: string description: 802.11 protocol reported for this mesh uplink examples: - n rssi: type: integer description: Received signal strength for this mesh uplink, in dBm contentEncoding: int32 examples: - -65 rx_bps: type: - integer - 'null' description: Inbound throughput on this mesh uplink, in bits per second contentEncoding: int64 readOnly: true examples: - 60003 rx_bytes: type: - integer - 'null' description: Inbound byte count for this mesh uplink contentEncoding: int64 readOnly: true examples: - 8515104416 rx_packets: type: - integer - 'null' description: Inbound packet count for this mesh uplink contentEncoding: int64 readOnly: true examples: - 57770567 rx_rate: type: - number - 'null' description: Inbound data rate reported for this mesh uplink readOnly: true rx_retries: type: - integer - 'null' description: Inbound retry count reported for this mesh uplink contentEncoding: int32 readOnly: true site_id: type: string description: Site associated with this mesh uplink statistic contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 snr: type: integer description: Signal-to-noise ratio for this mesh uplink, in dB contentEncoding: int32 examples: - 31 tx_bps: type: - integer - 'null' description: Outbound throughput on this mesh uplink, in bits per second contentEncoding: int64 readOnly: true examples: - 634301 tx_bytes: type: - integer - 'null' description: Outbound byte count for this mesh uplink contentEncoding: int64 readOnly: true examples: - 211217389682 tx_packets: type: - integer - 'null' description: Outbound packet count for this mesh uplink contentEncoding: int64 readOnly: true examples: - 812204062 tx_rate: type: - number - 'null' description: Outbound data rate reported for this mesh uplink readOnly: true tx_retries: type: - integer - 'null' description: Outbound retry count reported for this mesh uplink contentEncoding: int32 readOnly: true uplink_ap_id: type: string description: Identifier of the upstream AP for this mesh uplink contentEncoding: uuid examples: - 00000000-0000-0000-1000-5c5b35000010 description: Mesh uplink status for the AP stats_wireless_client_vbeacon: title: stats_wireless_client_vbeacon type: object properties: id: type: string description: Virtual beacon identifier currently associated with the wireless client contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f since: type: number description: Time when the wireless client began matching the virtual beacon, in epoch seconds description: Virtual beacon currently associated with a wireless client stats_wireless_client: title: stats_wireless_client required: - ap_id - ap_mac - band - channel - is_guest - key_mgmt - mac - proto - rssi - snr - ssid - wlan_id type: object properties: accuracy: type: integer description: Estimated client location accuracy, in meter contentEncoding: int32 airespace_ifname: type: string description: RADIUS Airespace interface name reported for the wireless client, when available airwatch: allOf: - $ref: '#/components/schemas/stats_wireless_client_airwatch2' - description: Mobile device management authorization information from AirWatch for the wireless client annotation: type: string description: User-visible annotation label applied to the wireless client ap_id: type: string description: AP ID the client is connected to contentEncoding: uuid ap_mac: type: string description: AP the client is connected to assoc_time: type: integer description: Time when the wireless client associated to the AP, in epoch seconds contentEncoding: int32 band: allOf: - $ref: '#/components/schemas/dot11_band3' - description: 'Wi-Fi radio band used by the wireless client connection. enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`.' bssid: type: string description: AP radio BSSID serving the wireless client connection channel: type: integer description: Radio channel used by the wireless client connection contentEncoding: int32 dual_band: type: boolean description: Whether the client is dual_band capable (determined by whether we’ve seen probe requests from both bands) family: type: string description: Device family, through fingerprinting. iPod / Nexus Galaxy / Windows Mobile or CE … group: type: string description: Client group label reported for the wireless client guest: allOf: - $ref: '#/components/schemas/guest1' - description: Portal guest details for the wireless client hostname: type: string description: DHCP hostname learned for the wireless client idle_time: type: number description: How long, in seconds, has the client been idle (since the last RX packet) ip: type: string description: Current IP address reported for the wireless client is_guest: type: boolean description: Whether this is a guest key_mgmt: type: string description: Security key-management and cipher suite used by the wireless client last_seen: type: - number - 'null' description: Time when Mist last observed the wireless client, in epoch seconds readOnly: true examples: - 1470417522 mac: type: string description: Wireless client MAC address observed by Mist manufacture: type: string description: Device manufacture, through fingerprinting or OUI map_id: type: string description: Estimated client location - map_id contentEncoding: uuid model: type: string description: Device model, may be available if we can identify them mxedge_id: type: string description: Mist Edge the wireless client connection is tunneled through, when applicable contentEncoding: uuid num_locating_aps: type: integer description: Number of APs used to locate this client contentEncoding: int32 os: type: string description: Device os, through fingerprinting power_saving: type: boolean description: If it’s currently in power-save mode proto: allOf: - $ref: '#/components/schemas/dot11_proto2' - description: '802.11 protocol amendment used by the wireless client. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`.' psk_id: type: string description: PSK id (if multi-psk is used) contentEncoding: uuid rssi: type: number description: Received signal strength indicator for the wireless client, in dBm rssizones: type: array items: $ref: '#/components/schemas/stats_wireless_client_rssi_zone' description: RSSI zone memberships for the wireless client rx_bps: type: - integer - 'null' description: Receive throughput for the wireless client, in bits per second contentEncoding: int64 readOnly: true examples: - 60003 rx_bytes: type: - integer - 'null' description: Total bytes received by the wireless client connection contentEncoding: int64 readOnly: true examples: - 8515104416 rx_pkts: type: - integer - 'null' description: Total packets received by the wireless client connection contentEncoding: int64 readOnly: true examples: - 57770567 rx_rate: type: - number - 'null' description: Receive PHY rate for the wireless client connection, in Mbps readOnly: true rx_retries: type: - integer - 'null' description: Receive retry count for the wireless client connection contentEncoding: int32 readOnly: true site_id: type: string description: Site identifier associated with the wireless client statistics record contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 snr: type: number description: Signal-to-noise ratio for the wireless client connection ssid: type: string description: Wireless SSID used by the client connection tx_bps: type: - integer - 'null' description: Transmit throughput for the wireless client, in bits per second contentEncoding: int64 readOnly: true examples: - 634301 tx_bytes: type: - integer - 'null' description: Total bytes transmitted by the wireless client connection contentEncoding: int64 readOnly: true examples: - 211217389682 tx_pkts: type: - integer - 'null' description: Total packets transmitted by the wireless client connection contentEncoding: int64 readOnly: true examples: - 812204062 tx_rate: type: - number - 'null' description: Transmit PHY rate for the wireless client connection, in Mbps readOnly: true tx_retries: type: - integer - 'null' description: Transmit retry count for the wireless client connection contentEncoding: int32 readOnly: true type: type: string description: Client’s type, regular / vip / resource / blocked (if client object is created) uptime: type: number description: How long, in seconds, has the client been connected username: type: string description: User identity learned from 802.1X, per-user PSK, or user portal authentication vbeacons: type: array items: $ref: '#/components/schemas/stats_wireless_client_vbeacon' description: Virtual beacon associations for the wireless client vlan_id: type: string description: VLAN ID, could be empty (from older AP) wlan_id: type: string description: WLAN ID the client is connected to contentEncoding: uuid wxrule_id: type: string description: Current WxlanRule using for a Client or an authorized Guest (portal user). null if default rule is matched. contentEncoding: uuid wxrule_usage: type: array items: $ref: '#/components/schemas/stats_wireless_client_wxrule_usage' description: WxLAN rule usage counters for the wireless client x: type: number description: Estimated client location in pixels x_m: type: number description: Estimated client location in meter y: type: number description: Estimated client location in pixels y_m: type: number description: Estimated client location in meter zones: type: array items: $ref: '#/components/schemas/stats_wireless_client_zone' description: Zone memberships for the wireless client description: Wireless client connection, traffic, and location statistics response_switch_metrics_config_success_details2: title: response_switch_metrics_config_success_details2 type: object properties: config_success_count: type: integer description: Number of switches with successful configuration status contentEncoding: int32 description: Configuration success counts used to calculate the metric stats_switch_vc_setup_info2: title: stats_switch_vc_setup_info2 type: object properties: config_type: type: string description: Provisioning mode used for the Virtual Chassis setup readOnly: true examples: - nonprovisioned current_stats: type: string description: Status currently reported for the Virtual Chassis setup workflow readOnly: true examples: - VCSETUP_WAITING err_missing_dev_id_fpc: type: boolean description: Whether the Virtual Chassis setup is missing a device ID for an FPC member readOnly: true last_update: type: number description: Most recent update time for the Virtual Chassis setup status readOnly: true request_time: type: number description: Time when the Virtual Chassis setup request was submitted readOnly: true request_type: type: string description: Virtual Chassis setup request type readOnly: true examples: - vc_create description: Virtual Chassis setup request and status details for the switch module_stat_item_vc_links_item: title: module_stat_item_vc_links_item type: object properties: neighbor_module_idx: type: integer description: Index of the neighboring module connected through this virtual chassis link contentEncoding: int32 examples: - 1 neighbor_port_id: type: string description: Port identifier on the neighboring module for this virtual chassis link examples: - vcp-255/1/0 port_id: type: string description: Local port identifier for this virtual chassis link examples: - vcp-255/1/0 description: Virtual chassis link endpoint for a device module stats_switch: title: stats_switch required: - type type: object properties: ap_redundancy: allOf: - $ref: '#/components/schemas/stats_switch_ap_redundancy2' - description: AP redundancy statistics associated with the switch arp_table_stats: allOf: - $ref: '#/components/schemas/arp_table_stats1' - description: ARP table utilization statistics for the switch auto_upgrade_stat: allOf: - $ref: '#/components/schemas/stats_ap_auto_upgrade2' - description: Automatic firmware upgrade status for the switch cert_expiry: type: integer description: Time when the switch certificate expires, in epoch seconds contentEncoding: int64 clients: type: array items: $ref: '#/components/schemas/stats_switch_client_item' description: Switch port clients currently observed by the switch clients_stats: allOf: - $ref: '#/components/schemas/stats_switch_clients_stats2' - description: Aggregate client counts reported for the switch config_status: type: string description: Configuration synchronization status reported for the switch readOnly: true config_timestamp: type: integer description: Time when the switch configuration status was last updated, in epoch seconds contentEncoding: int32 config_version: type: integer description: Currently applied configuration version for the switch contentEncoding: int32 cpu_stat: allOf: - $ref: '#/components/schemas/cpu_stat2' - description: Processor utilization statistics for the switch created_time: type: number description: Time when the switch record was created, in epoch seconds readOnly: true deviceprofile_id: type: - string - 'null' description: Applied device profile identifier for the switch, when present contentEncoding: uuid readOnly: true dhcpd_stat: type: object additionalProperties: $ref: '#/components/schemas/dhcpd_stat_lan' description: Lease pool statistics from the switch DHCP service evpntopo_id: type: - string - 'null' description: Associated EVPN topology identifier for the switch, when present contentEncoding: uuid readOnly: true ext_ip: type: string description: Public IP address observed for the switch fw_versions_outofsync: type: boolean description: Whether firmware versions are out of sync across switch members readOnly: true fwupdate: allOf: - $ref: '#/components/schemas/fwupdate_stat3' - description: Firmware update status for the switch has_pcap: type: boolean description: Whether the switch supports packet capture readOnly: true examples: - false hostname: type: string description: Device-reported hostname for the switch readOnly: true examples: - sj-sw1 hw_rev: type: string description: Device hardware revision number id: type: string description: Unique identifier of the switch record contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f if_stat: type: object additionalProperties: $ref: '#/components/schemas/if_stat_property' description: Interface traffic statistics for the switch ip: type: string description: Management IP address reported for the switch readOnly: true examples: - 10.2.11.137 ip_stat: allOf: - $ref: '#/components/schemas/ip_stat2' - description: Layer 3 address statistics for the switch last_seen: type: - number - 'null' description: Time when Mist last observed the switch, in epoch seconds readOnly: true examples: - 1470417522 last_trouble: allOf: - $ref: '#/components/schemas/last_trouble2' - description: Most recent trouble-code summary reported for the switch mac: type: string description: Switch MAC address reported by Mist readOnly: true mac_table_stats: allOf: - $ref: '#/components/schemas/mac_table_stats1' - description: Layer 2 MAC table utilization statistics for the switch map_id: type: - string - 'null' description: Placement map identifier associated with the switch, when present contentEncoding: uuid readOnly: true memory_stat: allOf: - $ref: '#/components/schemas/memory_stat2' - description: Utilization statistics for switch memory model: type: string description: Switch model name reported by Mist readOnly: true examples: - EX4600 modified_time: type: number description: Time when the switch record was last modified, in epoch seconds readOnly: true module_stat: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/stats_switch_module_stat_item' description: Hardware module statistics for the switch name: type: string description: Device name if configured readOnly: true examples: - sj-sw1 org_id: type: string description: Owning organization identifier for the switch statistics record contentEncoding: uuid readOnly: true examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 ports: type: array items: $ref: '#/components/schemas/stats_switch_port' description: Port statistics reported by the switch route_summary_stats: allOf: - $ref: '#/components/schemas/route_summary_stats1' - description: Route table summary statistics for the switch serial: type: string description: Switch serial number reported by Mist readOnly: true examples: - TC3714190003 service_stat: type: object additionalProperties: $ref: '#/components/schemas/service_stat_property' description: System service statistics for the switch site_id: type: string description: Associated site identifier for the switch statistics record contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 status: type: string description: Connection status reported for the switch, such as connected readOnly: true examples: - connected tag_id: type: integer description: Numeric inventory tag identifier associated with the switch contentEncoding: int32 tag_uuid: type: string description: Inventory tag UUID associated with the switch contentEncoding: uuid type: const: switch type: string description: Device type discriminator for switch statistics uptime: type: - number - 'null' description: Elapsed time since the switch last booted, in seconds readOnly: true examples: - 13501 vc_mac: type: - string - 'null' description: Virtual Chassis MAC address reported for the switch, when present readOnly: true vc_setup_info: allOf: - $ref: '#/components/schemas/stats_switch_vc_setup_info2' - description: Virtual Chassis setup request and status details for the switch version: type: - string - 'null' description: Software version running on the switch readOnly: true examples: - 18.4R1.8 description: Switch statistics reported by Mist for a site or organization stats response ip_stat4: title: ip_stat4 type: object properties: dhcp_server: type: - string - 'null' description: Reported DHCP server IPv4 address for the interface, when available readOnly: true examples: - 192.168.95.1 dns: uniqueItems: true type: array items: type: string description: Reported DNS server addresses for the interface dns_suffix: uniqueItems: true type: array items: type: string description: Reported DNS search suffixes for the interface gateway: type: - string - 'null' description: Current IPv4 default gateway for the interface, when available readOnly: true gateway6: type: - string - 'null' description: Current IPv6 default gateway for the interface, when available readOnly: true examples: - fdad:b0bc:f29e::1 ip: type: - string - 'null' description: Current IPv4 address for the interface, when available readOnly: true examples: - 10.3.3.1 ip6: type: - string - 'null' description: Current IPv6 address for the interface, when available readOnly: true examples: - fdad:b0bc:f29e::3d16 ips: type: object additionalProperties: type: string nullable: true description: Per-VLAN IP address summaries keyed by VLAN name netmask: type: - string - 'null' description: Current IPv4 subnet mask for the interface, when available readOnly: true examples: - 255.255.255.0 netmask6: type: - string - 'null' description: Current IPv6 prefix length for the interface, when available readOnly: true examples: - /64 description: Layer 3 address statistics for the gateway or primary HA node response_switch_metrics_config_success: title: response_switch_metrics_config_success type: object properties: details: allOf: - $ref: '#/components/schemas/response_switch_metrics_config_success_details2' - description: Configuration success counts used to calculate the metric score: type: integer description: Reported metric score for switch configuration success contentEncoding: int32 total_switch_count: type: integer description: Number of switches included in the configuration success metric contentEncoding: int32 description: Configuration success metric for switches in the requested scope ap_redundancy2: title: ap_redundancy2 type: object properties: modules: type: object additionalProperties: $ref: '#/components/schemas/ap_redundancy_module' description: Per-module AP redundancy counts keyed by switch node ID num_aps: type: integer description: Total number of APs considered for switch redundancy contentEncoding: int32 examples: - 15 num_aps_with_switch_redundancy: type: integer description: Number of APs that have switch redundancy coverage contentEncoding: int32 examples: - 8 description: AP redundancy statistics associated with the gateway module_stat_item_network_resource: title: module_stat_item_network_resource type: object properties: count: minimum: 0 type: integer description: Current utilization count for the network resource contentEncoding: int32 examples: - 17 limit: minimum: 0 type: integer description: Maximum supported count for the network resource contentEncoding: int32 examples: - 768000 type: type: string description: Network resource category, such as FIB or FLOW examples: - FIB description: Network resource usage counter reported by a device module cpu_stat4: title: cpu_stat4 type: object properties: idle: type: - number - 'null' description: Percentage of CPU time that is idle readOnly: true interrupt: type: - number - 'null' description: Percentage of CPU time being used by interrupts readOnly: true load_avg: type: array items: type: number description: Load averages for the last 1, 5, and 15 minutes system: type: - number - 'null' description: Percentage of CPU time being used by system processes readOnly: true usage: type: - number - 'null' description: Overall CPU usage percentage readOnly: true user: type: - number - 'null' description: Percentage of CPU time being used by user processes readOnly: true description: Processor utilization statistics for the gateway or primary HA node stats_ap_usb_stat2: title: stats_ap_usb_stat2 type: object properties: channel: type: - integer - 'null' description: Radio channel used by the USB peripheral contentEncoding: int32 readOnly: true examples: - 3 connected: type: - boolean - 'null' description: Whether the USB peripheral is connected readOnly: true examples: - true last_activity: type: - integer - 'null' description: Time of the last USB peripheral activity, in epoch seconds contentEncoding: int32 readOnly: true examples: - 1586873254 type: type: - string - 'null' description: USB peripheral type reported by the AP readOnly: true examples: - imagotag up: type: - boolean - 'null' description: Whether the USB peripheral is operational readOnly: true examples: - true description: USB peripheral status reported by the AP stat_device_status_filter: title: stat_device_status_filter enum: - all - connected - disconnected type: string description: 'enum: `all`, `connected`, `disconnected`' stats_gateway_spu_item: title: stats_gateway_spu_item type: object properties: spu_cpu: type: integer description: CPU utilization reported for the Services Processing Unit contentEncoding: int32 examples: - 3670632 spu_current_session: type: integer description: Current session count handled by the Services Processing Unit contentEncoding: int32 examples: - 215 spu_max_session: type: integer description: Maximum sessions supported by the Services Processing Unit contentEncoding: int32 examples: - 131072 spu_memory: type: integer description: Memory utilization reported for the Services Processing Unit contentEncoding: int32 examples: - 46 spu_pending_session: type: integer description: Pending session count on the Services Processing Unit contentEncoding: int32 examples: - 0 spu_uptime: type: integer description: Elapsed time since the Services Processing Unit started, in seconds contentEncoding: int32 examples: - 0 spu_valid_session: type: integer description: Valid session count currently tracked by the Services Processing Unit contentEncoding: int32 description: Services Processing Unit resource and session counters last_trouble1: title: last_trouble1 type: object properties: code: type: string description: Trouble code; definitions are listed at [List Ap Led Definition]($e/Constants%20Definitions/listApLedDefinition) examples: - '03' timestamp: type: number description: Time when the last trouble code was reported readOnly: true description: Most recent AP trouble indicator and timestamp bgp_stats_state1: title: bgp_stats_state1 enum: - active - connect - established - idle - open_config - open_sent type: string description: 'Current state of the BGP session. enum: `active`, `connect`, `established`, `idle`, `open_config`, `open_sent`.' examples: - established if_stat_property_servp_info2: title: if_stat_property_servp_info2 type: object properties: asn: type: string description: Autonomous System Number associated with the service provider city: type: string description: Detected city for the service provider address country_code: type: string description: ISO country code for the service provider address latitude: type: number description: Geographic latitude for the service provider address longitude: type: number description: Geographic longitude for the service provider address org: type: string description: Service provider organization name region_code: type: string description: Administrative region code for the service provider address description: Service-provider and geolocation details for this interface response_http404: title: response_http404 type: object properties: id: type: string description: Missing resource identifier, when the API includes one description: Standard HTTP 404 not found error response stats_ap_radio_config_band2: title: stats_ap_radio_config_band2 type: object properties: allow_rrm_disable: type: - boolean - 'null' description: Whether RRM disablement is allowed for this radio band readOnly: true bandwidth: type: - number - 'null' description: Channel bandwidth configured for this radio band readOnly: true examples: - 20 channel: type: integer description: Operating channel configured for this radio band contentEncoding: int32 examples: - 1 disabled: type: - boolean - 'null' description: Whether this radio band is disabled readOnly: true dynamic_chaining_enabled: type: - boolean - 'null' description: Whether dynamic chaining is enabled for this radio band readOnly: true examples: - false power: type: - number - 'null' description: Transmit power configured for this radio band readOnly: true examples: - 10 power_max: type: - number - 'null' description: Maximum transmit power allowed for this radio band readOnly: true examples: - 10 power_min: type: - number - 'null' description: Minimum transmit power allowed for this radio band readOnly: true examples: - 10 rx_chain: type: - integer - 'null' description: Number of receive chains enabled for this radio band contentEncoding: int32 readOnly: true examples: - 4 tx_chain: type: - integer - 'null' description: Number of transmit chains enabled for this radio band contentEncoding: int32 readOnly: true examples: - 4 description: 6 GHz radio configuration reported by the AP response_http429: title: response_http429 type: object properties: detail: type: string description: Human-readable explanation of the rate limit error examples: - Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold description: Standard HTTP 429 rate limit error response antenna_select2: title: antenna_select2 enum: - external - internal type: string description: 'Selectable antenna mode reported for the AP. enum: ``, `external`, `internal`.' examples: - external arp_table_stats1: title: arp_table_stats1 type: object properties: arp_table_count: type: integer description: Number of ARP table entries currently present on the device contentEncoding: int32 max_entries_supported: type: integer description: Supported ARP table capacity for the device contentEncoding: int32 description: ARP table utilization statistics for the switch memory_stat5: title: memory_stat5 required: - usage type: object properties: usage: type: number description: Current memory utilization percentage for the device or master Routing Engine description: Utilization statistics for gateway module memory stats_cluster_config_redundancy_group_info_item: title: stats_cluster_config_redundancy_group_info_item type: object properties: Id: type: integer description: Redundancy group identifier reported by the gateway contentEncoding: int32 MonitoringFailure: type: string description: Detected monitoring failure condition for the redundancy group Threshold: type: integer description: Configured monitoring threshold for the redundancy group contentEncoding: int32 description: Redundancy group monitoring entry for a gateway cluster gateway_metrics: title: gateway_metrics type: object properties: config_success: type: number description: Gateway configuration success score examples: - 99.9 version_compliance: allOf: - $ref: '#/components/schemas/gateway_compliance_version1' - description: Gateway software version compliance metric description: Gateway metric scores returned by the site gateway metrics API stats_cluster_config_ethernet_connection_item: title: stats_cluster_config_ethernet_connection_item type: object properties: name: type: string description: Ethernet interface name reported for cluster connectivity status: type: string description: Operational state reported for the Ethernet interface description: Ethernet interface connection state for a gateway cluster member stats_ap_auto_placement2: title: stats_ap_auto_placement2 type: object properties: info: allOf: - $ref: '#/components/schemas/stats_ap_auto_placement_info2' - description: Additional diagnostics for the AP auto placement result recommended_anchor: type: boolean description: Flag to represent if AP is recommended as an anchor by auto placement service status: type: string description: Current auto placement status for the AP examples: - localized status_detail: type: string description: Additional info about placement status examples: - localized x: type: number description: Auto-placed X coordinate, in pixels examples: - 53.5 x_m: type: number description: Auto-placed X coordinate, in meters examples: - 5.35 y: type: number description: Auto-placed Y coordinate, in pixels examples: - 173.1 y_m: type: number description: Auto-placed Y coordinate, in meters examples: - 17.31 description: Auto placement result and status for the AP stats_ap_l2tp_stat: title: stats_ap_l2tp_stat type: object properties: sessions: type: array items: $ref: '#/components/schemas/stats_ap_l2tp_stat_session' description: L2TP session entries for this tunnel state: allOf: - $ref: '#/components/schemas/l2tp_state2' - description: 'L2TP tunnel state reported by the AP. enum: `established`, `established_with_session`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`.' examples: - established uptime: type: - integer - 'null' description: Tunnel uptime, in seconds contentEncoding: int32 readOnly: true examples: - 135 wxtunnel_id: type: - string - 'null' description: Identifier of the associated WxLAN tunnel contentEncoding: uuid readOnly: true examples: - 7dae216d-7c98-a51b-e068-dd7d477b7216 description: L2TP tunnel status reported by an AP module_stat_item_psus_item: title: module_stat_item_psus_item type: object properties: name: type: string description: Power supply label reported by the device examples: - Power Supply 0 status: type: string description: Operational status reported for the power supply examples: - ok description: Power supply status for a device module port_auth_state1: title: port_auth_state1 enum: - authenticated - authenticating - held - init type: string description: 'Authentication state of the port. enum: ``, `authenticated`, `authenticating`, `held`, `init`.' fwupdate_stat_status2: title: fwupdate_stat_status2 enum: - inprogress - failed - upgraded - success - scheduled - error type: string description: 'Current firmware update status. enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`.' stats_wireless_client_zone: title: stats_wireless_client_zone type: object properties: id: type: string description: Zone identifier that currently contains the wireless client contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f since: type: number description: Time when the wireless client entered the zone, in epoch seconds description: Zone currently containing a wireless client stats_ap_radio_config_band1: title: stats_ap_radio_config_band1 type: object properties: allow_rrm_disable: type: - boolean - 'null' description: Whether RRM disablement is allowed for this radio band readOnly: true bandwidth: type: - number - 'null' description: Channel bandwidth configured for this radio band readOnly: true examples: - 20 channel: type: integer description: Operating channel configured for this radio band contentEncoding: int32 examples: - 1 disabled: type: - boolean - 'null' description: Whether this radio band is disabled readOnly: true dynamic_chaining_enabled: type: - boolean - 'null' description: Whether dynamic chaining is enabled for this radio band readOnly: true examples: - false power: type: - number - 'null' description: Transmit power configured for this radio band readOnly: true examples: - 10 power_max: type: - number - 'null' description: Maximum transmit power allowed for this radio band readOnly: true examples: - 10 power_min: type: - number - 'null' description: Minimum transmit power allowed for this radio band readOnly: true examples: - 10 rx_chain: type: - integer - 'null' description: Number of receive chains enabled for this radio band contentEncoding: int32 readOnly: true examples: - 4 tx_chain: type: - integer - 'null' description: Number of transmit chains enabled for this radio band contentEncoding: int32 readOnly: true examples: - 4 description: 5 GHz radio configuration reported by the AP module_stat_item_poe1: title: module_stat_item_poe1 type: object properties: max_power: type: number description: Total PoE power budget available to the module, in watts examples: - 250 power_draw: type: number description: Current PoE power draw on the module, in watts examples: - 120.3 status: type: string description: Operational status of PoE on the module description: Power over Ethernet telemetry for the switch module guest1: title: guest1 type: object properties: access_code_email: type: string description: If `auth_method`==`email`, the email address where the authorization code has been sent to readOnly: true ap_mac: type: string description: MAC address of the AP used during guest registration readOnly: true auth_method: type: string description: Guest authentication method used for the authorization readOnly: true authorized: type: boolean description: Whether the guest is currently authorized default: true authorized_expiring_time: type: number description: Unix timestamp when the guest authorization expires readOnly: true examples: - 1480704955 authorized_time: type: number description: Unix timestamp when the guest was authorized readOnly: true examples: - 1480704355 company: type: string description: Optional company name provided by the guest during registration examples: - abc email: type: string description: Optional email address provided by the guest during registration contentEncoding: email examples: - john@abc.com field1: type: string description: Optional custom field 1 value provided by the guest during registration field2: type: string description: Optional custom field 2 value provided by the guest during registration field3: type: string description: Optional custom field 3 value provided by the guest during registration field4: type: string description: Optional custom field 4 value provided by the guest during registration mac: type: string description: Device MAC address captured during guest registration readOnly: true minutes: maximum: 259200 minimum: 0 type: integer description: Authorization duration, in minutes. Default is 1440 minutes (1 day), maximum is 259200 (180 days) contentEncoding: int32 default: 1440 name: type: string description: Optional name provided by the guest during registration readOnly: true examples: - John Smith random_mac: type: boolean description: Whether the guest device used a randomized MAC address to connect to the SSID readOnly: true ssid: type: string description: Name of the SSID readOnly: true examples: - Guest-SSID wlan_id: type: string description: Identifier of the WLAN used for the guest authorization contentEncoding: uuid readOnly: true examples: - 6748cfa6-4e12-11e6-9188-0242ac110007 description: Portal guest details for the wireless client stats_ap_radio_config2: title: stats_ap_radio_config2 type: object properties: band_24: allOf: - $ref: '#/components/schemas/stats_ap_radio_config_band4' - description: 2.4 GHz radio configuration reported by the AP band_24_usage: type: - string - 'null' description: Current operating use for the 2.4 GHz radio readOnly: true examples: - '5' band_5: allOf: - $ref: '#/components/schemas/stats_ap_radio_config_band1' - description: 5 GHz radio configuration reported by the AP band_6: allOf: - $ref: '#/components/schemas/stats_ap_radio_config_band2' - description: 6 GHz radio configuration reported by the AP scanning_enabled: type: boolean description: Whether radio scanning is enabled on the AP description: Radio configuration currently applied to the AP ip_stat3: title: ip_stat3 type: object properties: dhcp_server: type: - string - 'null' description: Reported DHCP server IPv4 address for the interface, when available readOnly: true examples: - 192.168.95.1 dns: uniqueItems: true type: array items: type: string description: Reported DNS server addresses for the interface dns_suffix: uniqueItems: true type: array items: type: string description: Reported DNS search suffixes for the interface gateway: type: - string - 'null' description: Current IPv4 default gateway for the interface, when available readOnly: true gateway6: type: - string - 'null' description: Current IPv6 default gateway for the interface, when available readOnly: true examples: - fdad:b0bc:f29e::1 ip: type: - string - 'null' description: Current IPv4 address for the interface, when available readOnly: true examples: - 10.3.3.1 ip6: type: - string - 'null' description: Current IPv6 address for the interface, when available readOnly: true examples: - fdad:b0bc:f29e::3d16 ips: type: object additionalProperties: type: string nullable: true description: Per-VLAN IP address summaries keyed by VLAN name netmask: type: - string - 'null' description: Current IPv4 subnet mask for the interface, when available readOnly: true examples: - 255.255.255.0 netmask6: type: - string - 'null' description: Current IPv6 prefix length for the interface, when available readOnly: true examples: - /64 description: Layer 3 address statistics for the secondary HA node stats_ap_auto_upgrade3: title: stats_ap_auto_upgrade3 type: object properties: lastcheck: type: - integer - 'null' description: Time when the AP last checked for auto-upgrade, in epoch seconds contentEncoding: int64 readOnly: true examples: - 1720594762 description: Automatic firmware upgrade status for the gateway response_switch_metrics_active_ports_summary2: title: response_switch_metrics_active_ports_summary2 type: object properties: details: allOf: - $ref: '#/components/schemas/switch_metrics_active_ports_summary_details2' - description: Port counts used to calculate the active-port summary metric score: type: integer description: Reported metric score for active switch ports contentEncoding: int32 total_switch_count: type: integer description: Number of switches included in the active-port summary metric contentEncoding: int32 description: Summary metric for active switch ports ip_type64: title: ip_type64 enum: - autoconf - dhcp - disabled - static type: string description: 'IPv6 address assignment mode for AP management traffic. enum: `autoconf`, `dhcp`, `disabled`, `static`.' examples: - static stats_ap: title: stats_ap required: - type type: object properties: antenna_select: allOf: - $ref: '#/components/schemas/antenna_select2' - description: 'Selectable antenna mode reported for the AP. enum: ``, `external`, `internal`.' examples: - external auto_placement: allOf: - $ref: '#/components/schemas/stats_ap_auto_placement2' - description: Auto placement result and status for the AP auto_upgrade_stat: allOf: - $ref: '#/components/schemas/stats_ap_auto_upgrade4' - description: Automatic firmware upgrade status for the AP ble_stat: allOf: - $ref: '#/components/schemas/stats_ap_ble2' - description: BLE radio and beacon statistics reported by the AP cert_expiry: type: - number - 'null' description: Certificate expiry timestamp for the AP, in epoch seconds readOnly: true examples: - 1534534392 config_reverted: type: - boolean - 'null' description: Whether the AP configuration was reverted by the device readOnly: true cpu_system: type: - integer - 'null' description: CPU system utilization reported by the AP contentEncoding: int64 readOnly: true cpu_user: type: - integer - 'null' description: CPU user utilization reported by the AP contentEncoding: int32 readOnly: true cpu_util: type: - integer - 'null' description: Total CPU utilization reported by the AP contentEncoding: int32 readOnly: true created_time: type: number description: Time when the AP record was created, in epoch seconds readOnly: true deviceprofile_id: type: - string - 'null' description: Device profile identifier applied to the AP, when present contentEncoding: uuid readOnly: true env_stat: allOf: - $ref: '#/components/schemas/stats_ap_env_stat2' - description: Environmental sensor readings reported by the AP esl_stat: allOf: - oneOf: - {} - $ref: '#/components/schemas/stats_ap_esl_stat2' - description: Electronic shelf label dongle status reported by the AP readOnly: true evpntopo_id: type: - string - 'null' description: EVPN topology identifier associated with the AP, when present contentEncoding: uuid readOnly: true expiring_certs: type: object additionalProperties: type: integer format: int32 description: Certificates on the AP that are expiring within 30 days ext_ip: type: - string - 'null' description: Public IP address observed for the AP readOnly: true examples: - 73.92.124.103 fwupdate: allOf: - $ref: '#/components/schemas/fwupdate_stat2' - description: Firmware update status for the AP gps_stat: allOf: - $ref: '#/components/schemas/stats_ap_gps_stat2' - description: GPS location data reported for the AP hw_rev: type: - string - 'null' description: Hardware revision reported by the AP readOnly: true id: type: string description: Unique identifier for the AP contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f inactive_wired_vlans: type: array items: type: integer contentEncoding: int32 description: Wired VLAN identifiers currently inactive on the AP iot_stat: type: object additionalProperties: $ref: '#/components/schemas/stats_ap_iot_stat_additional_properties' description: IoT input statistics reported by the AP examples: - DI2: value: 0 ip: type: - string - 'null' description: Management IP address currently reported by the AP readOnly: true examples: - 10.2.9.159 ip_config: allOf: - $ref: '#/components/schemas/ap_ip_config3' - description: IP configuration applied to the AP management interface ip_stat: allOf: - $ref: '#/components/schemas/ip_stat1' - description: Read-only IP addressing status reported by the AP l2tp_stat: type: object additionalProperties: $ref: '#/components/schemas/stats_ap_l2tp_stat' description: L2TP tunnel status (key is the wxtunnel_id) last_seen: type: - number - 'null' description: Time when the AP was last seen by Mist, in epoch seconds readOnly: true examples: - 1470417522 last_trouble: allOf: - $ref: '#/components/schemas/last_trouble1' - description: Most recent AP trouble indicator and timestamp led: allOf: - $ref: '#/components/schemas/ap_led4' - description: Light indicator state for the AP lldp_stat: allOf: - $ref: '#/components/schemas/stats_ap_lldp_stat2' - description: Primary LLDP neighbor and power negotiation details for the AP lldp_stats: type: object additionalProperties: $ref: '#/components/schemas/stats_ap_lldp_stat' description: Per-port LLDP neighbor and power negotiation details for the AP locating: type: - boolean - 'null' description: Whether AP locating mode is currently active readOnly: true examples: - false locked: type: - boolean - 'null' description: Whether this AP is considered locked (placement / orientation has been vetted) readOnly: true examples: - true mac: type: - string - 'null' description: AP MAC address reported by Mist readOnly: true examples: - 5c5b35000010 map_id: type: - string - 'null' description: Map identifier where the AP is placed, when available contentEncoding: uuid readOnly: true examples: - 63eda950-c6da-11e4-a628-60f81dd250cc mem_total_kb: type: - integer - 'null' description: Total memory available on the AP, in kilobytes contentEncoding: int64 readOnly: true mem_used_kb: type: - integer - 'null' description: Memory currently used on the AP, in kilobytes contentEncoding: int64 readOnly: true mesh_downlinks: type: object additionalProperties: $ref: '#/components/schemas/ap_stat_mesh_downlink' description: Property key is the mesh downlink id (e.g. `00000000-0000-0000-1000-5c5b35000010`) mesh_uplink: allOf: - $ref: '#/components/schemas/ap_stat_mesh_uplink1' - description: Mesh uplink status for the AP model: type: - string - 'null' description: AP model identifier reported by Mist readOnly: true examples: - AP200 modified_time: type: number description: Time when the AP record was last modified, in epoch seconds readOnly: true mount: type: - string - 'null' description: Orientation configured for the AP mount readOnly: true examples: - faceup name: type: - string - 'null' description: Display name of the AP readOnly: true examples: - conference room notes: type: - string - 'null' description: Free-form notes configured on the AP record readOnly: true num_clients: type: - integer - 'null' description: How many wireless clients are currently connected contentEncoding: int32 readOnly: true num_wlans: type: integer description: How many WLANs are applied to the device contentEncoding: int32 org_id: type: string description: Organization identifier that owns the AP contentEncoding: uuid readOnly: true examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 port_stat: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/stats_ap_port_stat' description: Property key is the port name (e.g. `eth0`) readOnly: true power_budget: type: - integer - 'null' description: In mW, surplus if positive or deficit if negative contentEncoding: int32 readOnly: true examples: - 1000 power_constrained: type: - boolean - 'null' description: Whether the AP is operating with insufficient power readOnly: true examples: - false power_opmode: type: - string - 'null' description: Operating mode used while AP power is constrained readOnly: true examples: - '[20] 6GHz(2x2) 5GHz(4x4) 2.4GHz(2x2).' power_src: type: - string - 'null' description: DC Input / PoE 802.3at / PoE 802.3af / LLDP / ? (unknown) readOnly: true examples: - PoE 802.3af radio_config: allOf: - $ref: '#/components/schemas/stats_ap_radio_config2' - description: Radio configuration currently applied to the AP radio_stat: allOf: - $ref: '#/components/schemas/stats_ap_radio_stat2' - description: Radio statistics reported by AP bands rx_bps: type: - integer - 'null' description: Receive throughput for AP traffic, in bits per second contentEncoding: int64 readOnly: true examples: - 60003 rx_bytes: type: - integer - 'null' description: Total bytes received by the AP since connection contentEncoding: int64 readOnly: true examples: - 8515104416 rx_pkts: type: - integer - 'null' description: Total packets received by the AP since connection contentEncoding: int64 readOnly: true examples: - 57770567 serial: type: - string - 'null' description: Device serial number for the AP readOnly: true examples: - FXLH2015170017 site_id: type: string description: Site identifier where the AP is assigned contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 status: type: - string - 'null' description: Connection status reported for the AP readOnly: true switch_redundancy: allOf: - $ref: '#/components/schemas/stats_ap_switch_redundancy2' - description: Switch redundancy status reported for the AP tx_bps: type: - integer - 'null' description: Transmit throughput for AP traffic, in bits per second contentEncoding: int64 readOnly: true examples: - 634301 tx_bytes: type: - integer - 'null' description: Total bytes transmitted by the AP since connection contentEncoding: int64 readOnly: true examples: - 211217389682 tx_pkts: type: - integer - 'null' description: Total packets transmitted by the AP since connection contentEncoding: int64 readOnly: true examples: - 812204062 type: const: ap type: string description: 'Device type for this statistics record. enum: `ap`.' readOnly: true uptime: type: - number - 'null' description: How long, in seconds, has the device been up (or rebooted) readOnly: true examples: - 13500 usb_stat: allOf: - $ref: '#/components/schemas/stats_ap_usb_stat2' - description: USB peripheral status reported by the AP version: type: - string - 'null' description: Firmware version running on the AP readOnly: true examples: - 0.14.12345 x: type: - number - 'null' description: Map X coordinate of the AP placement, in pixels readOnly: true examples: - 53.5 y: type: - number - 'null' description: Map Y coordinate of the AP placement, in pixels readOnly: true examples: - 173.1 zigbee_stat: allOf: - $ref: '#/components/schemas/stats_ap_zigbee_stat2' - description: ZigBee statistics reported by the AP, present only when ZigBee is enabled on the AP description: AP runtime statistics, placement data, and inventory metadata module_stat_item_pics_item_port_groups_item: title: module_stat_item_pics_item_port_groups_item type: object properties: count: type: integer description: Number of ports in this PIC port group contentEncoding: int32 type: type: string description: Port media or interface type for this PIC port group description: Port group summary for a PIC stats_ap_esl_stat2: title: stats_ap_esl_stat2 type: object properties: channel: type: - integer - 'null' description: Radio channel used by the ESL dongle contentEncoding: int32 readOnly: true connected: type: - boolean - 'null' description: Whether the ESL dongle is connected readOnly: true ip: type: - string - 'null' description: Network IP address of Hanshow and SoluM dongles readOnly: true examples: - 172.16.2.249 mac: type: - string - 'null' description: Dongle MAC address for Hanshow and SoluM dongles readOnly: true examples: - 98-6d-35-79-76-3b product_id: type: - string - 'null' description: Product ID of Hanshow and SoluM dongles readOnly: true examples: - A4A2 type: type: - string - 'null' description: ESL dongle type reported by the AP readOnly: true examples: - imagotag up: type: - boolean - 'null' description: Whether the ESL dongle is operational readOnly: true vendor_id: type: - string - 'null' description: Vendor ID of Hanshow and SoluM dongles readOnly: true examples: - '0525' description: Electronic shelf label dongle status reported by the AP ap_redundancy_module: title: ap_redundancy_module type: object properties: num_aps: type: integer description: Total number of APs connected through this VC member contentEncoding: int32 examples: - 15 num_aps_with_switch_redundancy: type: integer description: Number of APs on this VC member with switch redundancy coverage contentEncoding: int32 examples: - 8 description: AP switch redundancy counts for one VC member poe_priority2: title: poe_priority2 enum: - low - high type: string description: 'PoE priority configured for the port. enum: `low`, `high`.' cpu_stat3: title: cpu_stat3 type: object properties: idle: type: - number - 'null' description: Percentage of CPU time that is idle readOnly: true interrupt: type: - number - 'null' description: Percentage of CPU time being used by interrupts readOnly: true load_avg: type: array items: type: number description: Load averages for the last 1, 5, and 15 minutes system: type: - number - 'null' description: Percentage of CPU time being used by system processes readOnly: true usage: type: - number - 'null' description: Overall CPU usage percentage readOnly: true user: type: - number - 'null' description: Percentage of CPU time being used by user processes readOnly: true description: Processor utilization statistics for the secondary HA node module_stat_item_errors_items: title: module_stat_item_errors_items required: - since - type type: object properties: feature: type: string description: Affected feature associated with this module error condition examples: - Mist-Management minimum_version: type: string description: Minimum software version associated with this module error examples: - 128T-6.0.0-1 reason: type: string description: Human-readable reason for the module error condition since: type: integer description: Epoch timestamp when the module error condition began contentEncoding: int32 examples: - 1657497600 type: type: string description: Module error type code reported by the device examples: - FW_UPGRADE_REQUIRED_BY_FEATURE description: Error condition reported for a device module last_trouble2: title: last_trouble2 type: object properties: code: type: string description: Trouble code; definitions are listed at [List Ap Led Definition]($e/Constants%20Definitions/listApLedDefinition) examples: - '03' timestamp: type: number description: Time when the last trouble code was reported readOnly: true description: Most recent trouble-code summary reported for the switch stats_ap_radio_stat2: title: stats_ap_radio_stat2 type: object properties: band_24: allOf: - $ref: '#/components/schemas/ap_radio_stat1' - description: 2.4 GHz radio statistics reported by the AP band_5: allOf: - $ref: '#/components/schemas/ap_radio_stat2' - description: 5 GHz radio statistics reported by the AP band_6: allOf: - $ref: '#/components/schemas/ap_radio_stat3' - description: 6 GHz radio statistics reported by the AP description: Radio statistics reported by AP bands dot11_proto2: title: dot11_proto2 enum: - a - ac - ax - b - be - g - n type: string description: '802.11 protocol amendment used by the wireless client. enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`.' stats_ap_auto_placement_info_probability_surface2: title: stats_ap_auto_placement_info_probability_surface2 type: object properties: radius: type: number description: The RADIUS representing placement uncertainty, measured in pixels examples: - 2.1 radius_m: type: number description: The RADIUS representing placement uncertainty, measured in meters x: type: number description: Potential placement center X coordinate, in pixels examples: - 17 description: Uncertainty area for the AP auto placement result stats_ap_port_stat: title: stats_ap_port_stat type: object properties: full_duplex: type: - boolean - 'null' description: Whether the AP Ethernet port is operating in full-duplex mode readOnly: true examples: - true rx_bytes: type: - integer - 'null' description: Bytes received on the AP Ethernet port contentEncoding: int64 readOnly: true examples: - 8515104416 rx_errors: type: - integer - 'null' description: Receive error count reported for the AP Ethernet port contentEncoding: int32 readOnly: true examples: - 0 rx_peak_bps: type: - integer - 'null' description: Peak receive throughput on the AP Ethernet port, in bits per second contentEncoding: int32 readOnly: true examples: - 22185 rx_pkts: type: - integer - 'null' description: Packets received on the AP Ethernet port contentEncoding: int64 readOnly: true examples: - 57770567 speed: type: - integer - 'null' description: Negotiated Ethernet link speed for the AP port, in Mbps contentEncoding: int32 readOnly: true examples: - 1000 tx_bytes: type: - integer - 'null' description: Bytes transmitted on the AP Ethernet port contentEncoding: int64 readOnly: true examples: - 211217389682 tx_peak_bps: type: - integer - 'null' description: Peak transmit throughput on the AP Ethernet port, in bits per second contentEncoding: int32 readOnly: true examples: - 43922 tx_pkts: type: - integer - 'null' description: Packets transmitted on the AP Ethernet port contentEncoding: int64 readOnly: true examples: - 812204062 up: type: - boolean - 'null' description: Whether the AP Ethernet port link is up readOnly: true examples: - true description: Ethernet port statistics reported by an AP stats_cluster_config_fabric_link_info2: title: stats_cluster_config_fabric_link_info2 type: object properties: DataPlaneNotifiedStatus: type: string description: Fabric link data-plane notification status reported by the gateway Interface: uniqueItems: true type: array items: type: string description: Fabric link interfaces reported for the gateway cluster InternalStatus: type: string description: Gateway-reported internal status for the fabric link State: type: string description: Administrative state of the fabric link Status: type: string description: Operational status of the fabric link description: Fabric link state and data-plane notification details for the gateway cluster stats_gateway_vpn_peer: title: stats_gateway_vpn_peer type: object properties: is_active: type: boolean description: Whether this VPN peer path is the active redundant path jitter: minimum: 0 type: number description: Last sampled VPN peer jitter, in milliseconds last_seen: type: - number - 'null' description: Time when this VPN peer was last observed, in epoch seconds readOnly: true examples: - 1470417522 latency: minimum: 0 type: number description: Last sampled VPN peer latency, in milliseconds loss: maximum: 100 minimum: 0 type: number description: Packet loss observed for the VPN peer, as a percentage mos: maximum: 5 minimum: 0 type: number description: Mean Opinion Score for VPN link quality, from 0 to 5 mtu: type: integer description: Maximum transmission unit for the VPN peer path, in bytes contentEncoding: int32 peer_mac: minLength: 1 type: string description: Peer router MAC address for the VPN link peer_port_id: minLength: 1 type: string description: Peer router interface identifier for the VPN link peer_router_name: minLength: 1 type: string description: Peer router name reported for the VPN link peer_site_id: type: string description: Site identifier for the peer side of the VPN link contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 port_id: minLength: 1 type: string description: Local router interface identifier for the VPN link router_name: minLength: 1 type: string description: Local router name reported for the VPN link type: minLength: 1 type: string description: VPN implementation type for the peer, such as `ipsec` for SRX or `svr` for SSR up: type: boolean description: Whether the VPN peer is currently up uptime: type: integer description: Gateway-reported VPN peer uptime value, in seconds contentEncoding: int32 description: VPN peer path statistics reported by a gateway securitySchemes: apiToken: type: apiKey description: "Preferred authentication method for automation and integrations. Send the API token in the HTTP `Authorization` header.\n\n**Format**:\n `Authorization: Token {apitoken}`\n\n**Notes**:\n* An API token generated for a specific admin has the same privileges as that admin\n* An API token is automatically removed if it is not used for more than 90 days\n* SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed." name: Authorization in: header csrfToken: type: apiKey description: 'Session-based authentication for browser or login/password flows. After a successful [Login]($e/Admins%20Login/login) request, Mist returns a `csrftoken` cookie. Send that value in the `X-CSRFToken` header on later API requests that use the login session. **Format**: ``` X-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx ``` For automation, API Token authentication is preferred.' name: X-CSRFToken in: header