openapi: 3.1.0
info:
contact:
email: tmunzer@juniper.net
name: Thomas Munzer
description: '> Version: **2604.1.1**
>
> Date: **May 13, 2026**
NOTE:
Some important API changes will be introduced. Please make sure to read the
announcements
---
## Additional Documentation
* [Mist Automation Guide](https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html)
* [Mist Location SDK](https://www.juniper.net/documentation/us/en/software/mist/location-services/topics/concept/mist-how-get-mist-sdk.html)
* [Mist Product Updates](https://www.juniper.net/documentation/us/en/software/mist/product-updates/)
## Helpful Resources
* [API Sandbox and Exercises](https://api-class.mist.com/)
* [Postman Collection, Runners and Webhook Samples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace)
* [Python Script Examples](https://github.com/tmunzer/mist_library)
* [API Demo Apps](https://apps.mist-lab.fr/)
* [Juniper Blog](https://blogs.juniper.net/)
## Mist Web Browser Extension:
* Google Chrome, Microsoft Edge and other Chromium-based browser: [Chrome Web Store](https://chromewebstore.google.com/detail/mist-extension/ejhpdcljeamillfhdihkkmoakanpbplh)
* Firefox: [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mist-extension/)
---'
license:
name: MIT
url: https://raw.githubusercontent.com/tmunzer/Mist-OAS3.0/main/LICENSE
title: Mist Admins Sites Stats - Devices API
version: 2604.1.1
x-logo:
altText: Juniper-MistAI
backgroundColor: '#FFFFFF'
url: https://www.mist.com/wp-content/uploads/logo.png
servers:
- description: Mist Global 01
url: https://api.mist.com
- description: Mist Global 02
url: https://api.gc1.mist.com
- description: Mist Global 03
url: https://api.ac2.mist.com
- description: Mist Global 04
url: https://api.gc2.mist.com
- description: Mist Global 05
url: https://api.gc4.mist.com
- description: Mist EMEA 01
url: https://api.eu.mist.com
- description: Mist EMEA 02
url: https://api.gc3.mist.com
- description: Mist EMEA 03
url: https://api.ac6.mist.com
- description: Mist EMEA 04
url: https://api.gc6.mist.com
- description: Mist APAC 01
url: https://api.ac5.mist.com
- description: Mist APAC 02
url: https://api.gc5.mist.com
- description: Mist APAC 03
url: https://api.gc7.mist.com
security:
- apiToken: []
- basicAuth: []
- basicAuth: []
csrfToken: []
tags:
- description: API Calls to retrieve statistics about the Mist Managed and Monitored Devices at the Site level
name: Sites Stats - Devices
paths:
/api/v1/sites/{site_id}/stats/devices:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Get List of Site Devices Stats
operationId: listSiteDevicesStats
parameters:
- in: query
name: type
schema:
$ref: '#/components/schemas/device_type_with_all'
- in: query
name: status
schema:
$ref: '#/components/schemas/stat_device_status_filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/page'
responses:
'200':
$ref: '#/components/responses/DevicesArrayStatsSite'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: listSiteDevicesStats
tags:
- Sites Stats - Devices
/api/v1/sites/{site_id}/stats/devices/{device_id}:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
get:
description: Get Site Device Stats Details
operationId: getSiteDeviceStats
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
$ref: '#/components/responses/DeviceStats'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: getSiteDeviceStats
tags:
- Sites Stats - Devices
/api/v1/sites/{site_id}/stats/devices/{device_id}/clients:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
get:
description: Get wireless client stat by Device
operationId: getSiteAllClientsStatsByDevice
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/stats_wireless_clients'
description: OK
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: getSiteAllClientsStatsByDevice
tags:
- Sites Stats - Devices
/api/v1/sites/{site_id}/stats/gateways/metrics:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Get Site Gateway Metrics
operationId: getSiteGatewayMetrics
responses:
'200':
$ref: '#/components/responses/GatewayMetrics'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: getSiteGatewayMetrics
tags:
- Sites Stats - Devices
/api/v1/sites/{site_id}/stats/switches/metrics:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Get version compliance metrics for managed or monitored switches
operationId: getSiteSwitchesMetrics
parameters:
- in: query
name: type
schema:
$ref: '#/components/schemas/switch_metric_type'
- in: query
name: scope
schema:
$ref: '#/components/schemas/switch_metric_scope'
- description: Switch mac, used only with metric `type`==`active_ports_summary`
in: query
name: switch_mac
schema:
examples:
- 5c5b350e0410
type: string
responses:
'200':
$ref: '#/components/responses/SwitchMetrics'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: getSiteSwitchesMetrics
tags:
- Sites Stats - Devices
components:
examples:
DevicesArrayStatsSiteGatewayStats:
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-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
HTTP403Example:
value:
detail: You do not have permission to perform this action.
DevicesArrayStatsSiteAccessPointStats:
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
DevicesArrayStatsSiteSwitch:
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
GatewayMetricsExample:
value:
config_success: 99.9
version_compliance:
major_version:
SRX320:
major_count: 0
major_version: 19.4R2-S1.2
score: 99.9
type: gateway
DeviceStatsSwitchStats:
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
SwitchMetricsSiteScoped:
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
HTTP429Example:
value:
detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
SwitchMetricsSwitchScoped:
value:
active_ports_summary:
details:
active_port_count: 1
total_port_count: 2
score: 50
total_switch_count: 1
DeviceStatsGatewayStats:
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: []
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: []
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
DeviceStatsAccessPointStats:
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
HTTP400Example:
value:
detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
HTTP401Example:
value:
detail: Authentication credentials were not provided.
schemas:
stats_ap_env_stat:
additionalProperties: false
description: Device environment, including CPU temperature, Ambient temperature, Humidity, Attitude, Pressure, Accelerometers, Magnetometers and vCore Voltage
properties:
accel_x:
examples:
- 0
format: float
readOnly: true
type:
- number
- 'null'
accel_y:
examples:
- 0.032
format: float
readOnly: true
type:
- number
- 'null'
accel_z:
examples:
- -1.088
format: float
readOnly: true
type:
- number
- 'null'
ambient_temp:
examples:
- 43
format: int32
readOnly: true
type:
- integer
- 'null'
attitude:
examples:
- 0
format: int32
readOnly: true
type:
- integer
- 'null'
cpu_temp:
examples:
- 61
format: int32
readOnly: true
type:
- integer
- 'null'
humidity:
examples:
- 9
format: int32
readOnly: true
type:
- integer
- 'null'
magne_x:
examples:
- 0
format: float
readOnly: true
type:
- number
- 'null'
magne_y:
examples:
- 0
format: float
readOnly: true
type:
- number
- 'null'
magne_z:
examples:
- 0
format: float
readOnly: true
type:
- number
- 'null'
pressure:
examples:
- 968
format: float
readOnly: true
type:
- number
- 'null'
vcore_voltage:
examples:
- 0
format: int32
readOnly: true
type:
- integer
- 'null'
type: object
dhcpd_stat_lan:
additionalProperties: false
properties:
num_ips:
examples:
- 100
type: integer
num_leased:
examples:
- 20
type: integer
type: object
stats_ap_auto_placement_info_probability_surface:
additionalProperties: false
description: Coordinates representing a circle where the AP is most likely exists in the event of an inaccurate placement result
properties:
radius:
description: The radius representing placement uncertainty, measured in pixels
examples:
- 2.1
type: number
radius_m:
description: The radius representing placement uncertainty, measured in meters
type: number
x:
description: Y-coordinate of the potential placement’s center, measured in pixels
examples:
- 17
format: double
type: number
type: object
strings:
items:
type: string
type: array
uniqueItems: true
stats_ap_expiring_certs:
additionalProperties:
description: Expiry time in epoch seconds
type: integer
description: Map of certificate serial numbers to their expiry timestamps (in epoch) for certificates expiring within 30 days. Property key is the certificate serial number
type: object
port_stp_role:
description: 'enum: `alternate`, `backup`, `designated`, `disabled`, `root`, `root-prevented`'
enum:
- ''
- alternate
- backup
- designated
- disabled
- root
- root-prevented
type: string
stats_gateway_spu:
items:
$ref: '#/components/schemas/stats_gateway_spu_item'
type: array
dot11_proto:
description: 'enum: `a`, `ac`, `ax`, `b`, `be`, `g`, `n`'
enum:
- a
- ac
- ax
- b
- be
- g
- n
type: string
port_stp_state:
description: 'enum: `blocking`, `disabled`, `forwarding`, `learning`, `listening`'
enum:
- ''
- blocking
- disabled
- forwarding
- learning
- listening
type: string
stats_ap_switch_redundancy:
additionalProperties: false
properties:
num_redundant_aps:
examples:
- 1
readOnly: true
type:
- integer
- 'null'
type: object
stats_ap_port_stat:
additionalProperties: false
properties:
full_duplex:
examples:
- true
readOnly: true
type:
- boolean
- 'null'
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
rx_errors:
examples:
- 0
readOnly: true
type:
- integer
- 'null'
rx_peak_bps:
examples:
- 22185
readOnly: true
type:
- integer
- 'null'
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
speed:
examples:
- 1000
readOnly: true
type:
- integer
- 'null'
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
tx_peak_bps:
examples:
- 43922
readOnly: true
type:
- integer
- 'null'
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
up:
examples:
- true
readOnly: true
type:
- boolean
- 'null'
type: object
stats_ap_auto_upgrade:
additionalProperties: false
properties:
lastcheck:
examples:
- 1720594762
format: int64
readOnly: true
type:
- integer
- 'null'
type: object
stats_ap_auto_placement_info:
additionalProperties: false
description: Additional information about auto placements AP data
properties:
cluster_number:
description: All APs sharing a given cluster number can be placed relative to each other
examples:
- 0
type: integer
orientation_stats:
description: The orientation of an AP
examples:
- 0
type: integer
probability_surface:
$ref: '#/components/schemas/stats_ap_auto_placement_info_probability_surface'
type: object
response_switch_metrics_config_success:
additionalProperties: false
properties:
details:
$ref: '#/components/schemas/response_switch_metrics_config_success_details'
score:
type: integer
total_switch_count:
type: integer
type: object
stats_ap_lldp_stat_power_srcs:
description: List of management IP addresses (IPv4 and IPv6)
items:
$ref: '#/components/schemas/stats_ap_lldp_stat_power_src'
type: array
if_stat_property:
additionalProperties: false
properties:
address_mode:
type: string
ips:
$ref: '#/components/schemas/strings'
nat_addresses:
$ref: '#/components/schemas/strings'
network_name:
type: string
port_id:
type: string
port_usage:
type: string
redundancy_state:
type: string
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
servp_info:
$ref: '#/components/schemas/if_stat_property_servp_info'
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
up:
type: boolean
vlan:
type: integer
wan_name:
type: string
wan_type:
type: string
type: object
timestamp:
description: Epoch (seconds)
format: double
readOnly: true
type: number
stats_ap_iot_stat_additional_properties:
additionalProperties: false
properties:
value:
readOnly: true
type:
- integer
- 'null'
type: object
stats_ap_esl_stat:
additionalProperties: false
properties:
channel:
readOnly: true
type:
- integer
- 'null'
connected:
readOnly: true
type:
- boolean
- 'null'
ip:
description: IP address of Hanshow and SoluM dongles
examples:
- 172.16.2.249
readOnly: true
type:
- string
- 'null'
mac:
description: MAC address of Hanshow and SoluM dongles
examples:
- 98-6d-35-79-76-3b
readOnly: true
type:
- string
- 'null'
product_id:
description: Product ID of Hanshow and SoluM dongles
examples:
- A4A2
readOnly: true
type:
- string
- 'null'
type:
examples:
- imagotag
readOnly: true
type:
- string
- 'null'
up:
readOnly: true
type:
- boolean
- 'null'
vendor_id:
description: Vendor ID of Hanshow and SoluM dongles
examples:
- '0525'
readOnly: true
type:
- string
- 'null'
readOnly: true
type:
- object
- 'null'
stats_switch_ap_redundancy:
additionalProperties: false
properties:
modules:
additionalProperties:
$ref: '#/components/schemas/stats_switch_ap_redundancy_module'
description: For a VC / stacked switches.
type: object
num_aps:
examples:
- 15
type: integer
num_aps_with_switch_redundancy:
examples:
- 8
type: integer
type: object
ip_stat_ips:
description: Property key is the VLAN name
readOnly: true
type:
- string
- 'null'
if_stat:
additionalProperties:
$ref: '#/components/schemas/if_stat_property'
description: Property key is the interface name
type: object
module_stat_item_errors:
description: Used to report all error states the device node is running into. An error should always have `type` and `since` fields, and could have some other fields specific to that type.
items:
$ref: '#/components/schemas/module_stat_item_errors_items'
type: array
stats_gateway_cluster:
additionalProperties: false
properties:
state:
readOnly: true
type:
- string
- 'null'
type: object
ap_radio_stat:
additionalProperties: false
description: Radio stat
properties:
bandwidth:
$ref: '#/components/schemas/dot11_bandwidth'
channel:
description: Current channel the radio is running on
readOnly: true
type:
- integer
- 'null'
dynamic_chaining_enabled:
description: Use dynamic chaining for downlink
readOnly: true
type:
- boolean
- 'null'
mac:
description: Radio (base) mac, it can have 16 bssids (e.g. 5c5b350001a0-5c5b350001af)
readOnly: true
type:
- string
- 'null'
noise_floor:
examples:
- -90
readOnly: true
type:
- integer
- 'null'
num_clients:
readOnly: true
type:
- integer
- 'null'
num_wlans:
description: How many WLANs are applied to the radio
type: integer
power:
description: Transmit power (in dBm)
readOnly: true
type:
- integer
- 'null'
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
usage:
examples:
- '24'
readOnly: true
type:
- string
- 'null'
util_all:
description: All utilization in percentage
readOnly: true
type:
- integer
- 'null'
util_non_wifi:
description: Reception of "No Packets" utilization in percentage, received frames with invalid PLCPs and CRS glitches as noise
readOnly: true
type:
- integer
- 'null'
util_rx_in_bss:
description: Reception of "In BSS" utilization in percentage, only frames that are received from AP/STAs within the BSS
readOnly: true
type:
- integer
- 'null'
util_rx_other_bss:
description: Reception of "Other BSS" utilization in percentage, all frames received from AP/STAs that are outside the BSS
readOnly: true
type:
- integer
- 'null'
util_tx:
description: Transmission utilization in percentage
readOnly: true
type:
- integer
- 'null'
util_undecodable_wifi:
description: Reception of "UnDecodable Wifi" utilization in percentage, only Preamble, PLCP header is decoded, Rest is undecodable in this radio
readOnly: true
type:
- integer
- 'null'
util_unknown_wifi:
description: Reception of "No Category" utilization in percentage, all 802.11 frames that are corrupted at the receiver
readOnly: true
type:
- integer
- 'null'
type: object
switch_metrics_compliance_major_versions:
items:
$ref: '#/components/schemas/switch_metrics_compliance_major_version'
type: array
module_stat_item_pics_item_port_groups:
items:
$ref: '#/components/schemas/module_stat_item_pics_item_port_groups_item'
type: array
stats_switch_clients_stats_total:
additionalProperties: false
properties:
num_aps:
$ref: '#/components/schemas/stats_switch_clients_stats_total_total_num_aps'
num_wired_clients:
type: integer
type: object
stats_gateway_vpn_peer:
additionalProperties: false
properties:
is_active:
description: Redundancy status of the associated interface
type: boolean
jitter:
description: Jitter in milliseconds
minimum: 0
type: number
last_seen:
$ref: '#/components/schemas/last_seen'
latency:
description: Latency in milliseconds
minimum: 0
type: number
loss:
description: Packet loss in percentage
maximum: 100
minimum: 0
type: number
mos:
description: Mean Opinion Score, a measure of the quality of the VPN link
maximum: 5
minimum: 0
type: number
mtu:
type: integer
peer_mac:
description: Peer router mac address
minLength: 1
type: string
peer_port_id:
description: Peer router device interface
minLength: 1
type: string
peer_router_name:
minLength: 1
type: string
peer_site_id:
$ref: '#/components/schemas/site_id'
port_id:
description: Router device interface
minLength: 1
type: string
router_name:
minLength: 1
type: string
type:
description: '`ipsec`for SRX, `svr` for 128T'
minLength: 1
type: string
up:
type: boolean
uptime:
type: integer
type: object
ap_redundancy_modules:
additionalProperties:
$ref: '#/components/schemas/ap_redundancy_module'
description: Property key is the node id
type: object
arp_table_stats:
additionalProperties: false
properties:
arp_table_count:
type: integer
max_entries_supported:
type: integer
type: object
module_stat_item_vc_links:
items:
$ref: '#/components/schemas/module_stat_item_vc_links_item'
type: array
uniqueItems: true
stats_ap_usb_stat:
additionalProperties: false
properties:
channel:
examples:
- 3
readOnly: true
type:
- integer
- 'null'
connected:
examples:
- true
readOnly: true
type:
- boolean
- 'null'
last_activity:
examples:
- 1586873254
readOnly: true
type:
- integer
- 'null'
type:
examples:
- imagotag
readOnly: true
type:
- string
- 'null'
up:
examples:
- true
readOnly: true
type:
- boolean
- 'null'
type: object
stats_ap_radio_config:
additionalProperties: false
properties:
band_24:
$ref: '#/components/schemas/stats_ap_radio_config_band'
band_24_usage:
examples:
- '5'
readOnly: true
type:
- string
- 'null'
band_5:
$ref: '#/components/schemas/stats_ap_radio_config_band'
band_6:
$ref: '#/components/schemas/stats_ap_radio_config_band'
scanning_enabled:
type: boolean
type: object
module_stat_item_poe:
additionalProperties: false
properties:
max_power:
examples:
- 250
type: number
power_draw:
examples:
- 120.3
type: number
status:
type: string
type: object
stats_cluster_config_ethernet_connection:
items:
$ref: '#/components/schemas/stats_cluster_config_ethernet_connection_item'
type: array
stat_device_status_filter:
default: all
description: 'enum: `all`, `connected`, `disconnected`'
enum:
- all
- connected
- disconnected
type: string
service_stat:
additionalProperties:
$ref: '#/components/schemas/service_stat_property'
type: object
response_http401:
additionalProperties: false
properties:
detail:
examples:
- Authentication credentials were not provided.
type: string
type: object
switch_metrics_active_ports_summary_details:
additionalProperties: false
properties:
active_port_count:
type: integer
total_port_count:
type: integer
type: object
module_stat_item_pics_item_port_groups_item:
additionalProperties: false
properties:
count:
type: integer
type:
type: string
type: object
stats_ap_l2tp_stat:
additionalProperties: false
properties:
sessions:
$ref: '#/components/schemas/stats_ap_l2tp_stat_sessions'
state:
$ref: '#/components/schemas/l2tp_state'
uptime:
description: Uptime
examples:
- 135
readOnly: true
type:
- integer
- 'null'
wxtunnel_id:
description: WxlanTunnel ID
examples:
- 7dae216d-7c98-a51b-e068-dd7d477b7216
format: uuid
readOnly: true
type:
- string
- 'null'
type: object
module_stat_item_pics_item:
additionalProperties: false
properties:
index:
type: integer
model_number:
type: string
port_groups:
$ref: '#/components/schemas/module_stat_item_pics_item_port_groups'
type: object
stats_gateway_mac_table_stats:
additionalProperties: false
properties:
mac_table_count:
type: integer
max_mac_entries_supported:
type: integer
type: object
ap_redundancy:
additionalProperties: false
properties:
modules:
$ref: '#/components/schemas/ap_redundancy_modules'
num_aps:
examples:
- 15
type: integer
num_aps_with_switch_redundancy:
examples:
- 8
type: integer
type: object
stats_gateway_vpn_peers:
description: Only present when `vpn_peers` in `fields` query parameter. Each port object is same as `GET /api/v1/sites/{site_id}/stats/vpn_peers/search` result object, except that org_id, site_id, mac, model are removed
items:
$ref: '#/components/schemas/stats_gateway_vpn_peer'
type: array
stats_switch_ports:
items:
$ref: '#/components/schemas/stats_switch_port'
type: array
device_type_switch:
description: 'Device Type. enum: `switch`'
enum:
- switch
type: string
stats_wireless_client_rssi_zone:
additionalProperties: false
properties:
id:
$ref: '#/components/schemas/id'
since:
type: number
type: object
stats_ap_auto_placement:
additionalProperties: false
properties:
info:
$ref: '#/components/schemas/stats_ap_auto_placement_info'
recommended_anchor:
description: Flag to represent if AP is recommended as an anchor by auto placement service
type: boolean
status:
description: Basic Placement Status
examples:
- localized
type: string
status_detail:
description: Additional info about placement status
examples:
- localized
type: string
x:
description: X Autoplaced Position in pixels
examples:
- 53.5
format: double
type: number
x_m:
description: X Autoplaced Position in meters
examples:
- 5.35
format: double
type: number
y:
description: Y Autoplaced Position in pixels
examples:
- 173.1
format: double
type: number
y_m:
description: X Autoplaced Position in meters
examples:
- 17.31
format: double
type: number
type: object
stats_cluster_config:
additionalProperties: false
properties:
configuration:
type: string
control_link_info:
$ref: '#/components/schemas/stats_cluster_config_control_link_info'
ethernet_connection:
$ref: '#/components/schemas/stats_cluster_config_ethernet_connection'
fabric_link_info:
$ref: '#/components/schemas/stats_cluster_config_fabric_link_info'
last_status_change_reason:
type: string
operational:
type: string
primary_node_health:
type: string
redundancy_group_information:
$ref: '#/components/schemas/stats_cluster_config_redundancy_group_info'
secondary_node_health:
type: string
status:
type: string
type: object
l2tp_state:
description: 'enum: `established`, `established_with_session`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`'
enum:
- established
- established_with_session
- idle
- wait-ctrl-conn
- wait-ctrl-reply
examples:
- established
type: string
mac_table_stats:
additionalProperties: false
properties:
mac_table_count:
type: integer
max_mac_entries_supported:
type: integer
type: object
module_stat_item_psus:
items:
$ref: '#/components/schemas/module_stat_item_psus_item'
type: array
uniqueItems: true
rx_rate:
description: RX Rate, Mbps
format: float
readOnly: true
type:
- number
- 'null'
ibeacon_uuid:
examples:
- f3f17139-704a-f03a-2786-0400279e37c3
format: uuid
type:
- string
- 'null'
ap_stat_mesh_uplink:
additionalProperties: false
properties:
band:
examples:
- '5'
type: string
channel:
examples:
- 36
type: integer
idle_time:
examples:
- 3
type: integer
last_seen:
$ref: '#/components/schemas/last_seen'
proto:
examples:
- n
type: string
rssi:
examples:
- -65
type: integer
rx_bps:
$ref: '#/components/schemas/rx_bps'
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
rx_packets:
$ref: '#/components/schemas/rx_pkts'
rx_rate:
$ref: '#/components/schemas/rx_rate'
rx_retries:
$ref: '#/components/schemas/rx_retries'
site_id:
$ref: '#/components/schemas/site_id'
snr:
examples:
- 31
type: integer
tx_bps:
$ref: '#/components/schemas/tx_bps'
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
tx_packets:
$ref: '#/components/schemas/tx_pkts'
tx_rate:
$ref: '#/components/schemas/tx_rate'
tx_retries:
$ref: '#/components/schemas/tx_retries'
uplink_ap_id:
examples:
- 00000000-0000-0000-1000-5c5b35000010
format: uuid
type: string
type: object
gateway_metrics:
additionalProperties: false
properties:
config_success:
description: Config success score
examples:
- 99.9
type: number
version_compliance:
$ref: '#/components/schemas/gateway_compliance_version'
type: object
fwupdate_stat:
additionalProperties: false
properties:
progress:
examples:
- 10
maximum: 100
minimum: 0
readOnly: true
type:
- integer
- 'null'
status:
$ref: '#/components/schemas/fwupdate_stat_status'
status_id:
examples:
- 5
readOnly: true
type:
- integer
- 'null'
timestamp:
$ref: '#/components/schemas/timestamp'
will_retry:
examples:
- false
readOnly: true
type:
- boolean
- 'null'
type: object
switch_metrics_compliance_major_version:
additionalProperties: false
properties:
major_count:
type: integer
major_version:
type: string
model:
type: string
system_names:
$ref: '#/components/schemas/strings'
type: object
stats_switch_module_stat:
items:
$ref: '#/components/schemas/stats_switch_module_stat_item'
minItems: 1
type: array
uniqueItems: true
stats_gateway_module_stat:
items:
$ref: '#/components/schemas/stats_gateway_module_stat_item'
maxItems: 1
minItems: 0
type: array
response_switch_metrics_version_compliance_details:
additionalProperties: false
properties:
major_versions:
$ref: '#/components/schemas/switch_metrics_compliance_major_versions'
type: object
stats_gateway_wan_tunnels:
description: Only present when `tunnels` in `fields` query parameter. Each port object is same as `GET /api/v1/sites/{site_id}/stats/tunnels/search` result object, except that org_id, site_id, mac, model are removed
items:
$ref: '#/components/schemas/stats_gateway_wan_tunnel'
type: array
stats_ap_l2tp_stat_sessions:
description: List of sessions
items:
$ref: '#/components/schemas/stats_ap_l2tp_stat_session'
type: array
stats_ap_iot_stat:
additionalProperties:
$ref: '#/components/schemas/stats_ap_iot_stat_additional_properties'
examples:
- DI2:
value: 0
type: object
stats_ap_radio_config_band:
additionalProperties: false
properties:
allow_rrm_disable:
readOnly: true
type:
- boolean
- 'null'
bandwidth:
examples:
- 20
readOnly: true
type:
- number
- 'null'
channel:
examples:
- 1
type: integer
disabled:
readOnly: true
type:
- boolean
- 'null'
dynamic_chaining_enabled:
examples:
- false
readOnly: true
type:
- boolean
- 'null'
power:
examples:
- 10
readOnly: true
type:
- number
- 'null'
power_max:
examples:
- 10
readOnly: true
type:
- number
- 'null'
power_min:
examples:
- 10
readOnly: true
type:
- number
- 'null'
rx_chain:
examples:
- 4
readOnly: true
type:
- integer
- 'null'
tx_chain:
examples:
- 4
readOnly: true
type:
- integer
- 'null'
type: object
device_type_with_all:
default: ap
description: ap, switch, gateway, router, all, default is ap. Supports comma-separated values for multiple types (e.g., type=switch,gateway)
type: string
stats_gateway_module_stat_item:
additionalProperties: false
properties:
backup_version:
readOnly: true
type:
- string
- 'null'
bios_version:
readOnly: true
type:
- string
- 'null'
boot_partition:
type: string
cpld_version:
readOnly: true
type:
- string
- 'null'
fans:
$ref: '#/components/schemas/module_stat_item_fans'
fpga_version:
readOnly: true
type:
- string
- 'null'
last_seen:
$ref: '#/components/schemas/last_seen'
locating:
type: boolean
mac:
examples:
- fc3342123456
type: string
memory_stat:
$ref: '#/components/schemas/memory_stat'
model:
examples:
- EX4300-48P
readOnly: true
type:
- string
- 'null'
network_resources:
$ref: '#/components/schemas/module_stat_item_network_resources'
optics_cpld_version:
readOnly: true
type:
- string
- 'null'
pending_version:
readOnly: true
type:
- string
- 'null'
poe:
$ref: '#/components/schemas/module_stat_item_poe'
poe_version:
readOnly: true
type:
- string
- 'null'
power_cpld_version:
readOnly: true
type:
- string
- 'null'
psus:
$ref: '#/components/schemas/module_stat_item_psus'
re_fpga_version:
readOnly: true
type:
- string
- 'null'
recovery_version:
readOnly: true
type:
- string
- 'null'
serial:
examples:
- PX8716230021
readOnly: true
type:
- string
- 'null'
status:
readOnly: true
type:
- string
- 'null'
temperatures:
$ref: '#/components/schemas/module_stat_item_temperatures'
tmc_fpga_version:
readOnly: true
type:
- string
- 'null'
uboot_version:
readOnly: true
type:
- string
- 'null'
uptime:
readOnly: true
type:
- integer
- 'null'
vc_links:
$ref: '#/components/schemas/module_stat_item_vc_links'
vc_mode:
readOnly: true
type:
- string
- 'null'
vc_role:
description: 'enum: `master`, `backup`, `linecard`'
examples:
- master
readOnly: true
type:
- string
- 'null'
vc_state:
readOnly: true
type:
- string
- 'null'
version:
readOnly: true
type:
- string
- 'null'
type: object
stats_wireless_client_zones:
description: List of zone_id’s where client is in and since when (if known)
items:
$ref: '#/components/schemas/stats_wireless_client_zone'
type: array
ip_stat:
additionalProperties: false
properties:
dhcp_server:
examples:
- 192.168.95.1
readOnly: true
type:
- string
- 'null'
dns:
$ref: '#/components/schemas/strings'
dns_suffix:
$ref: '#/components/schemas/strings'
gateway:
readOnly: true
type:
- string
- 'null'
gateway6:
examples:
- fdad:b0bc:f29e::1
readOnly: true
type:
- string
- 'null'
ip:
examples:
- 10.3.3.1
readOnly: true
type:
- string
- 'null'
ip6:
examples:
- fdad:b0bc:f29e::3d16
readOnly: true
type:
- string
- 'null'
ips:
additionalProperties:
$ref: '#/components/schemas/ip_stat_ips'
type: object
netmask:
examples:
- 255.255.255.0
readOnly: true
type:
- string
- 'null'
netmask6:
examples:
- /64
readOnly: true
type:
- string
- 'null'
type: object
stats_wireless_client_wxrule_usages:
description: Current WxlanRule usage per tag_id
items:
$ref: '#/components/schemas/stats_wireless_client_wxrule_usage'
type: array
module_stat_item_vc_links_item:
additionalProperties: false
properties:
neighbor_module_idx:
examples:
- 1
type: integer
neighbor_port_id:
examples:
- vcp-255/1/0
type: string
port_id:
examples:
- vcp-255/1/0
type: string
type: object
tx_bytes:
description: Amount of traffic sent since connection
examples:
- 211217389682
format: int64
readOnly: true
type:
- integer
- 'null'
module_stat_item_network_resource:
additionalProperties: false
properties:
count:
description: current usage of the network resource
examples:
- 17
minimum: 0
type: integer
limit:
description: maximum usage of the network resource
examples:
- 768000
minimum: 0
type: integer
type:
description: type of the network resource (e.g. FIB, FLOW, ...)
examples:
- FIB
type: string
type: object
stats_gateway_service_status:
additionalProperties: false
properties:
appid_install_result:
type: string
appid_install_timestamp:
type: string
appid_status:
type: string
appid_version:
type: integer
ewf_status:
type: string
idp_install_result:
type: string
idp_install_timestamp:
type: string
idp_policy:
type: string
idp_status:
type: string
idp_update_timestamp:
type: string
type: object
stats_switch_port:
additionalProperties: false
description: Switch port statistics
properties:
active:
description: Indicates if interface is active/inactive
readOnly: true
type: boolean
auth_state:
$ref: '#/components/schemas/port_auth_state'
disabled:
description: Indicates if interface is disabled
readOnly: true
type: boolean
for_site:
readOnly: true
type: boolean
full_duplex:
description: Indicates full or half duplex
examples:
- true
type: boolean
jitter:
description: Last sampled jitter of the interface
readOnly: true
type: number
last_flapped:
description: Indicates when the port was last flapped
format: double
readOnly: true
type: number
latency:
description: Last sampled latency of the interface
readOnly: true
type: number
loss:
description: Last sampled loss of the interface
readOnly: true
type: number
lte_iccid:
description: LTE ICCID value, Check for null/empty
type:
- string
- 'null'
lte_imei:
description: LTE IMEI value, Check for null/empty
type:
- string
- 'null'
lte_imsi:
description: LTE IMSI value, Check for null/empty
type:
- string
- 'null'
mac:
examples:
- 5c4527a96580
readOnly: true
type: string
mac_count:
description: Number of mac addresses in the forwarding table
readOnly: true
type: integer
mac_limit:
description: Limit on number of dynamically learned macs
minimum: 0
readOnly: true
type: integer
neighbor_mac:
description: chassis identifier of the chassis type listed
examples:
- 64d814353400
readOnly: true
type: string
neighbor_port_desc:
description: Description supplied by the system on the interface E.g. "GigabitEthernet2/0/39"
examples:
- GigabitEthernet1/0/21
readOnly: true
type: string
neighbor_system_name:
description: Name supplied by the system on the interface E.g. neighbor system name E.g. "Kumar-Acc-SW.mist.local"
examples:
- CORP-D-SW-2
readOnly: true
type: string
org_id:
$ref: '#/components/schemas/org_id'
poe_disabled:
description: Is the POE disabled
readOnly: true
type: boolean
poe_mode:
$ref: '#/components/schemas/stats_switch_port_poe_mode'
poe_on:
description: Is the device attached to POE
readOnly: true
type: boolean
poe_priority:
$ref: '#/components/schemas/poe_priority'
port_id:
examples:
- ge-0/0/0
readOnly: true
type: string
port_mac:
description: Interface MAC address
examples:
- 5c4527a96580
readOnly: true
type: string
port_usage:
examples:
- lan
type: string
power_draw:
description: Amount of power being used by the interface at the time the command is executed. Unit in watts.
readOnly: true
type: number
rx_bcast_pkts:
description: Broadcast input packets
readOnly: true
type: integer
rx_bps:
$ref: '#/components/schemas/rx_bps'
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
rx_errors:
description: Input errors
readOnly: true
type: integer
rx_mcast_pkts:
description: Multicast input packets
readOnly: true
type: integer
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
site_id:
$ref: '#/components/schemas/site_id'
speed:
description: Port speed
examples:
- 1000
readOnly: true
type: integer
stp_role:
$ref: '#/components/schemas/port_stp_role'
stp_state:
$ref: '#/components/schemas/port_stp_state'
tx_bcast_pkts:
description: Broadcast output packets
readOnly: true
type: integer
tx_bps:
$ref: '#/components/schemas/tx_bps'
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
tx_errors:
description: Output errors
readOnly: true
type: integer
tx_mcast_pkts:
description: Multicast output packets
readOnly: true
type: integer
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
type:
$ref: '#/components/schemas/stats_switch_port_type'
unconfigured:
description: Indicates if interface is unconfigured
readOnly: true
type: boolean
up:
description: Indicates if interface is up
readOnly: true
type: boolean
uplink:
description: Indicates if interface is an uplink port
readOnly: true
type: boolean
xcvr_model:
description: Optic Slot ModelName, Check for null/empty
examples:
- SFP+-10G-SR
readOnly: true
type: string
xcvr_part_number:
description: Optic Slot Partnumber, Check for null/empty
examples:
- 740-021487
readOnly: true
type: string
xcvr_serial:
description: Optic Slot SerialNumber, Check for null/empty
examples:
- N6AA9HT
readOnly: true
type: string
required:
- mac
- org_id
- port_id
- site_id
type: object
bgp_stats_state:
description: 'enum: `active`, `connect`, `established`, `idle`, `open_config`, `open_sent`'
enum:
- active
- connect
- established
- idle
- open_config
- open_sent
examples:
- established
type: string
stats_switch_vc_setup_info:
additionalProperties: false
properties:
config_type:
examples:
- nonprovisioned
readOnly: true
type: string
current_stats:
examples:
- VCSETUP_WAITING
readOnly: true
type: string
err_missing_dev_id_fpc:
readOnly: true
type: boolean
last_update:
format: double
readOnly: true
type: number
request_time:
format: double
readOnly: true
type: number
request_type:
examples:
- vc_create
readOnly: true
type: string
type: object
stats_switch_port_type:
description: 'device type. enum: `ap`, `ble`, `gateway`, `mxedge`, `nac`, `switch`'
enum:
- ap
- ble
- gateway
- mxedge
- nac
- switch
examples:
- gateway
type: string
stats_cluster_config_fabric_link_info:
additionalProperties: false
properties:
DataPlaneNotifiedStatus:
type: string
Interface:
$ref: '#/components/schemas/strings'
InternalStatus:
type: string
State:
type: string
Status:
type: string
type: object
ap_led:
additionalProperties: false
description: LED AP settings
properties:
brightness:
default: 255
examples:
- 255
maximum: 255
minimum: 0
type: integer
enabled:
default: true
type: boolean
type: object
stats_gateway:
additionalProperties: false
description: Gateway statistics
properties:
ap_redundancy:
$ref: '#/components/schemas/ap_redundancy'
arp_table_stats:
$ref: '#/components/schemas/arp_table_stats'
auto_upgrade_stat:
$ref: '#/components/schemas/stats_ap_auto_upgrade'
bgp_peers:
$ref: '#/components/schemas/bgp_peers'
cert_expiry:
format: int64
type: integer
cluster_config:
$ref: '#/components/schemas/stats_cluster_config'
cluster_stat:
$ref: '#/components/schemas/stats_gateway_cluster'
conductor_name:
readOnly: true
type: string
config_status:
readOnly: true
type: string
config_timestamp:
type: integer
config_version:
type: integer
cpu2_stat:
$ref: '#/components/schemas/cpu_stat'
cpu_stat:
$ref: '#/components/schemas/cpu_stat'
created_time:
$ref: '#/components/schemas/created_time'
deviceprofile_id:
format: uuid
readOnly: true
type:
- string
- 'null'
deviceprofile_name:
type: string
dhcpd2_stat:
$ref: '#/components/schemas/dhcpd_stat'
dhcpd_stat:
$ref: '#/components/schemas/dhcpd_stat'
evpntopo_id:
format: uuid
readOnly: true
type:
- string
- 'null'
ext_ip:
description: IP address
examples:
- 66.129.234.224
readOnly: true
type:
- string
- 'null'
fwupdate:
$ref: '#/components/schemas/fwupdate_stat'
has_pcap:
readOnly: true
type:
- boolean
- 'null'
hostname:
description: Hostname reported by the device
examples:
- sj1
type: string
id:
$ref: '#/components/schemas/id'
if2_stat:
$ref: '#/components/schemas/if_stat'
if_stat:
$ref: '#/components/schemas/if_stat'
ip:
description: IP address
examples:
- 10.2.11.137
readOnly: true
type:
- string
- 'null'
ip2_stat:
$ref: '#/components/schemas/ip_stat'
ip_stat:
$ref: '#/components/schemas/ip_stat'
is_ha:
readOnly: true
type:
- boolean
- 'null'
last_seen:
$ref: '#/components/schemas/last_seen'
mac:
description: Device mac
examples:
- dc38e1dbf3cd
type: string
mac_table_stats:
$ref: '#/components/schemas/stats_gateway_mac_table_stats'
map_id:
description: Serial Number
format: uuid
readOnly: true
type:
- string
- 'null'
memory2_stat:
$ref: '#/components/schemas/memory_stat'
memory_stat:
$ref: '#/components/schemas/memory_stat'
model:
description: Device model
examples:
- SRX320
type: string
modified_time:
$ref: '#/components/schemas/modified_time'
module2_stat:
$ref: '#/components/schemas/stats_gateway_module_stat'
module_stat:
$ref: '#/components/schemas/stats_gateway_module_stat'
name:
description: Device name if configured
examples:
- sj1
readOnly: true
type: string
node_name:
examples:
- node0
readOnly: true
type: string
org_id:
$ref: '#/components/schemas/org_id'
ports:
$ref: '#/components/schemas/stats_gateway_ports'
route_summary_stats:
$ref: '#/components/schemas/route_summary_stats'
router_name:
description: Device name if configured
examples:
- sj1
readOnly: true
type: string
serial:
description: Serial Number
examples:
- TC3714190003
readOnly: true
type: string
service2_stat:
$ref: '#/components/schemas/service_stat'
service_stat:
$ref: '#/components/schemas/service_stat'
service_status:
$ref: '#/components/schemas/stats_gateway_service_status'
site_id:
$ref: '#/components/schemas/site_id'
spu2_stat:
$ref: '#/components/schemas/stats_gateway_spu'
spu_stat:
$ref: '#/components/schemas/stats_gateway_spu'
status:
examples:
- connected
readOnly: true
type: string
tag_id:
type: integer
tag_uuid:
format: uuid
type: string
tunnels:
$ref: '#/components/schemas/stats_gateway_wan_tunnels'
type:
$ref: '#/components/schemas/const_device_type_gateway'
uptime:
examples:
- 3671219
readOnly: true
type:
- number
- 'null'
version:
examples:
- 18.4R1.8
readOnly: true
type:
- string
- 'null'
vpn_peers:
$ref: '#/components/schemas/stats_gateway_vpn_peers'
required:
- mac
- type
type: object
stats_wireless_clients:
items:
$ref: '#/components/schemas/stats_wireless_client'
type: array
stats_wireless_client_wxrule_usage:
additionalProperties: false
properties:
tag_id:
format: uuid
type: string
usage:
type: integer
type: object
stats_ap_lldp_stat:
additionalProperties: false
description: LLDP neighbor information and power negotiations. For backward compatibility, when multiple neighbors exist, only information from the first neighbor is displayed.
properties:
chassis_id:
readOnly: true
type:
- string
- 'null'
lldp_med_supported:
description: Whether it support LLDP-MED
readOnly: true
type:
- boolean
- 'null'
mgmt_addr:
description: Management IP address of the switch
readOnly: true
type:
- string
- 'null'
mgmt_addrs:
$ref: '#/components/schemas/stats_ap_lldp_stat_mgmt_addrs'
port_desc:
description: Port description, e.g. “2/20”, “Port 2 on Switch0”
examples:
- 2/20
readOnly: true
type:
- string
- 'null'
port_id:
description: Port identifier
examples:
- ge-0/0/4
readOnly: true
type:
- string
- 'null'
power_allocated:
description: In mW, power allocated by PSE
readOnly: true
type:
- number
- 'null'
power_avail:
description: In mW, total Power Avail at AP from pwr source
type: integer
power_budget:
description: In mW, surplus if positive or deficit if negative
type: integer
power_constrained:
description: Whether power is insufficient
type: boolean
power_draw:
description: In mW, total power needed by PD
readOnly: true
type:
- number
- 'null'
power_needed:
description: In mW, total Power needed incl Peripherals
type: integer
power_opmode:
description: Constrained mode
type: string
power_request_count:
description: Number of negotiations, if it keeps increasing, we don’ t have a stable power
readOnly: true
type:
- integer
- 'null'
power_requested:
description: In mW, power requested by PD
readOnly: true
type:
- number
- 'null'
power_src:
$ref: '#/components/schemas/stats_ap_lldp_stat_power_src'
power_srcs:
$ref: '#/components/schemas/stats_ap_lldp_stat_power_srcs'
system_desc:
description: Description provided by switch
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.'
readOnly: true
type:
- string
- 'null'
system_name:
description: Name of the switch
examples:
- Core-AE23
readOnly: true
type:
- string
- 'null'
type: object
stats_ap_lldp_stat_mgmt_addrs:
description: List of management IP addresses (IPv4 and IPv6)
items:
type: string
type: array
ibeacon_minor:
description: Minor number for iBeacon
examples:
- 1234
maximum: 65535
minimum: 1
type:
- integer
- 'null'
route_summary_stats:
additionalProperties: false
properties:
fib_routes:
type: integer
max_unicast_routes_supported:
type: integer
rib_routes:
type: integer
total_routes:
type: integer
type: object
stats_cluster_config_redundancy_group_info_item:
additionalProperties: false
properties:
Id:
type: integer
MonitoringFailure:
type: string
Threshold:
type: integer
type: object
cpu_stat_load_avg:
description: Load averages for the last 1, 5, and 15 minutes
items:
type: number
type: array
tx_rate:
description: TX Rate, Mbps
format: float
readOnly: true
type:
- number
- 'null'
stats_ap_l2tp_stat_session:
additionalProperties: false
properties:
local_sid:
description: Remote sessions id (dynamically unless Tunnel is said to be static)
examples:
- 31
readOnly: true
type:
- integer
- 'null'
remote_id:
description: WxlanTunnel Remote ID (user-configured)
examples:
- vpn1
readOnly: true
type:
- string
- 'null'
remote_sid:
description: Remote sessions id (dynamically unless Tunnel is said to be static)
examples:
- 13
readOnly: true
type:
- integer
- 'null'
state:
$ref: '#/components/schemas/l2tp_state'
type: object
created_time:
description: When the object has been created, in epoch
format: double
readOnly: true
type: number
module_stat_item_temperatures_item:
additionalProperties: false
properties:
celsius:
examples:
- 45
type: number
name:
examples:
- CPU
type: string
status:
examples:
- ok
type: string
type: object
stats_switch_ap_redundancy_module:
additionalProperties: false
properties:
num_aps:
examples:
- 15
type: integer
num_aps_with_switch_redundancy:
examples:
- 8
type: integer
type: object
stats_ap_ble:
additionalProperties: false
properties:
beacon_enabled:
readOnly: true
type:
- boolean
- 'null'
beacon_rate:
examples:
- 3
readOnly: true
type:
- integer
- 'null'
eddystone_uid_enabled:
examples:
- false
readOnly: true
type:
- boolean
- 'null'
eddystone_uid_freq_msec:
examples:
- 2000
readOnly: true
type:
- integer
- 'null'
eddystone_uid_instance:
examples:
- 5c5b35000001
readOnly: true
type:
- string
- 'null'
eddystone_uid_namespace:
examples:
- 2818e3868dec25629ede
readOnly: true
type:
- string
- 'null'
eddystone_url_enabled:
examples:
- true
readOnly: true
type:
- boolean
- 'null'
eddystone_url_freq_msec:
description: Frequency (msec) of data emit by Eddystone-UID beacon
examples:
- 100
readOnly: true
type:
- integer
- 'null'
eddystone_url_url:
examples:
- https://www.abc.com
readOnly: true
type:
- string
- 'null'
ibeacon_enabled:
examples:
- true
readOnly: true
type:
- boolean
- 'null'
ibeacon_freq_msec:
examples:
- 2000
readOnly: true
type:
- integer
- 'null'
ibeacon_major:
$ref: '#/components/schemas/ibeacon_major'
ibeacon_minor:
$ref: '#/components/schemas/ibeacon_minor'
ibeacon_uuid:
$ref: '#/components/schemas/ibeacon_uuid'
major:
examples:
- 12345
readOnly: true
type:
- integer
- 'null'
minors:
$ref: '#/components/schemas/integers'
power:
examples:
- 10
readOnly: true
type:
- integer
- 'null'
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
tx_resets:
description: Resets due to tx hung
examples:
- 0
readOnly: true
type:
- integer
- 'null'
uuid:
examples:
- ada72f8f-1643-e5c6-94db-f2a5636f1a64
format: uuid
readOnly: true
type:
- string
- 'null'
type: object
stats_switch_clients_stats_total_total_num_aps:
items:
type: integer
type: array
ap_ip_config_dns:
description: If `type`==`static`
examples:
- - 8.8.8.8
- 4.4.4.4
items:
type: string
type: array
stats_switch_clients_stats:
additionalProperties: false
properties:
total:
$ref: '#/components/schemas/stats_switch_clients_stats_total'
type: object
ap_ip_config:
additionalProperties: false
description: IP AP settings
properties:
dns:
$ref: '#/components/schemas/ap_ip_config_dns'
dns_suffix:
$ref: '#/components/schemas/ap_ip_config_dns_suffix'
gateway:
description: Required if `type`==`static`
examples:
- 10.2.1.254
format: ipv4
type: string
gateway6:
examples:
- 2607:f8b0:4005:808::1
format: ipv6
type: string
ip:
description: Required if `type`==`static`
examples:
- 10.2.1.1
format: ipv4
type: string
ip6:
examples:
- 2607:f8b0:4005:808::2004
format: ipv6
type: string
mtu:
examples:
- 0
type: integer
netmask:
description: Required if `type`==`static`
examples:
- 255.255.255.0
type: string
netmask6:
examples:
- /32
type: string
type:
$ref: '#/components/schemas/ip_type'
type6:
$ref: '#/components/schemas/ip_type6'
vlan_id:
default: 1
description: Management VLAN id, default is 1 (untagged)
examples:
- 1
type: integer
type: object
module_stat_item_network_resources:
items:
$ref: '#/components/schemas/module_stat_item_network_resource'
type: array
stats_gateway_wan_tunnel:
additionalProperties: false
properties:
auth_algo:
description: Authentication algorithm
type: string
encrypt_algo:
description: Encryption algorithm
type: string
ike_version:
description: IKE version
type: string
ip:
description: IP Address
type: string
last_event:
description: Reason of why the tunnel is down
type: string
last_flapped:
description: Indicates when the port was last flapped
format: double
type: number
node:
description: Node0/node1
type: string
peer_host:
description: Peer host
type: string
peer_ip:
description: Peer ip address
type: string
priority:
$ref: '#/components/schemas/tunnel_priority'
protocol:
$ref: '#/components/schemas/wan_tunnel_protocol'
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
tunnel_name:
description: Mist Tunnel Name
type: string
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
up:
type: boolean
uptime:
description: Duration from first (or last) SA was established
type: integer
wan_name:
description: WAN interface name
examples:
- wan
type: string
type: object
tx_bps:
description: Rate of transmitting traffic, bits/seconds, last known
examples:
- 634301
format: int64
readOnly: true
type:
- integer
- 'null'
tx_retries:
description: Amount of tx retries
readOnly: true
type:
- integer
- 'null'
ap_ip_config_dns_suffix:
description: Required if `type`==`static`
examples:
- - .mist.local
- .mist.com
items:
type: string
type: array
response_switch_metrics_config_success_details:
additionalProperties: false
properties:
config_success_count:
type: integer
type: object
stats_wireless_client_rssi_zones:
description: List of rssizone_id’s where client is in and since when (if known)
items:
$ref: '#/components/schemas/stats_wireless_client_rssi_zone'
type: array
stats_switch_port_poe_mode:
description: 'enum: `802.3af`, `802.3at`, `802.3bt`'
enum:
- 802.3af
- 802.3at
- 802.3bt
type: string
antenna_select:
description: 'Antenna Mode for AP which supports selectable antennas. enum: `""` (default), `external`, `internal`'
enum:
- ''
- external
- internal
examples:
- external
type: string
bgp_as:
anyOf:
- type: string
- maximum: 4294967294
minimum: 1
type: integer
description: BGP AS, value in range 1-4294967294. Can be a Variable (e.g. `{{bgp_as}}` )
examples:
- 65000
tunnel_priority:
description: 'enum: `primary`, `secondary`'
enum:
- primary
- secondary
type: string
dhcpd_stat:
additionalProperties:
$ref: '#/components/schemas/dhcpd_stat_lan'
description: Property key is the network name
type: object
stats_ap_gps_stat:
additionalProperties: false
properties:
accuracy:
description: The estimated accuracy or accuracy of the GPS coordinates, measured in meters.
examples:
- 12.5
type: number
altitude:
description: The elevation of the AP above sea level, measured in meters.
examples:
- 99.939
type: number
latitude:
description: The geographic latitude of the AP, measured in degrees.
examples:
- 37.29548
type: number
longitude:
description: The geographic longitude of the AP, measured in degrees.
examples:
- -122.03304
type: number
src:
$ref: '#/components/schemas/stats_ap_gps_stat_src'
timestamp:
$ref: '#/components/schemas/timestamp'
type: object
stats_switch:
additionalProperties: false
description: Switch statistics
properties:
ap_redundancy:
$ref: '#/components/schemas/stats_switch_ap_redundancy'
arp_table_stats:
$ref: '#/components/schemas/arp_table_stats'
auto_upgrade_stat:
$ref: '#/components/schemas/stats_ap_auto_upgrade'
cert_expiry:
format: int64
type: integer
clients:
$ref: '#/components/schemas/stats_switch_clients'
clients_stats:
$ref: '#/components/schemas/stats_switch_clients_stats'
config_status:
readOnly: true
type: string
config_timestamp:
type: integer
config_version:
type: integer
cpu_stat:
$ref: '#/components/schemas/cpu_stat'
created_time:
$ref: '#/components/schemas/created_time'
deviceprofile_id:
format: uuid
readOnly: true
type:
- string
- 'null'
dhcpd_stat:
$ref: '#/components/schemas/dhcpd_stat'
evpntopo_id:
format: uuid
readOnly: true
type:
- string
- 'null'
ext_ip:
type: string
fw_versions_outofsync:
readOnly: true
type: boolean
fwupdate:
$ref: '#/components/schemas/fwupdate_stat'
has_pcap:
description: Whether the switch supports packet capture
examples:
- false
readOnly: true
type: boolean
hostname:
description: Hostname reported by the device
examples:
- sj-sw1
readOnly: true
type: string
hw_rev:
description: Device hardware revision number
type: string
id:
$ref: '#/components/schemas/id'
if_stat:
$ref: '#/components/schemas/if_stat'
ip:
examples:
- 10.2.11.137
readOnly: true
type: string
ip_stat:
$ref: '#/components/schemas/ip_stat'
last_seen:
$ref: '#/components/schemas/last_seen'
last_trouble:
$ref: '#/components/schemas/last_trouble'
mac:
readOnly: true
type: string
mac_table_stats:
$ref: '#/components/schemas/mac_table_stats'
map_id:
format: uuid
readOnly: true
type:
- string
- 'null'
memory_stat:
$ref: '#/components/schemas/memory_stat'
model:
examples:
- EX4600
readOnly: true
type: string
modified_time:
$ref: '#/components/schemas/modified_time'
module_stat:
$ref: '#/components/schemas/stats_switch_module_stat'
name:
description: Device name if configured
examples:
- sj-sw1
readOnly: true
type: string
org_id:
$ref: '#/components/schemas/org_id'
ports:
$ref: '#/components/schemas/stats_switch_ports'
route_summary_stats:
$ref: '#/components/schemas/route_summary_stats'
serial:
examples:
- TC3714190003
readOnly: true
type: string
service_stat:
$ref: '#/components/schemas/service_stat'
site_id:
$ref: '#/components/schemas/site_id'
status:
examples:
- connected
readOnly: true
type: string
tag_id:
type: integer
tag_uuid:
format: uuid
type: string
type:
$ref: '#/components/schemas/device_type_switch'
uptime:
examples:
- 13501
readOnly: true
type:
- number
- 'null'
vc_mac:
readOnly: true
type:
- string
- 'null'
vc_setup_info:
$ref: '#/components/schemas/stats_switch_vc_setup_info'
version:
examples:
- 18.4R1.8
readOnly: true
type:
- string
- 'null'
required:
- type
type: object
stats_wireless_client_airwatch:
additionalProperties: false
description: Information if airwatch enabled
properties:
authorized:
type: boolean
required:
- authorized
type: object
rx_bps:
description: Rate of receiving traffic, bits/seconds, last known
examples:
- 60003
format: int64
readOnly: true
type:
- integer
- 'null'
guest:
description: Guest
properties:
access_code_email:
description: If `auth_method`==`email`, the email address where the authorization code has been sent to
readOnly: true
type: string
ap_mac:
description: MAC Address of the AP the guest was connected to during the registration process
readOnly: true
type: string
auth_method:
description: Type of guest authorization
readOnly: true
type: string
authorized:
default: true
description: Whether the guest is current authorized
type: boolean
authorized_expiring_time:
description: When the authorization would expire
examples:
- 1480704955
readOnly: true
type: number
authorized_time:
description: When the guest was authorized
examples:
- 1480704355
readOnly: true
type: number
company:
description: Optional, the info provided by user
examples:
- abc
type: string
email:
description: Optional, the info provided by user
examples:
- john@abc.com
format: email
type: string
field1:
description: Optional, the info provided by user
type: string
field2:
type: string
field3:
type: string
field4:
type: string
mac:
description: MAC Address
readOnly: true
type: string
minutes:
default: 1440
description: Authorization duration, in minutes. Default is 1440 minutes (1 day), maximum is 259200 (180 days)
maximum: 259200
minimum: 0
type: integer
name:
description: Optional, the info provided by user
examples:
- John Smith
readOnly: true
type: string
random_mac:
description: If the client is using a randomized MAC Address to connect the SSID
readOnly: true
type: boolean
ssid:
description: Name of the SSID
examples:
- Guest-SSID
readOnly: true
type: string
wlan_id:
description: ID of the SSID
examples:
- 6748cfa6-4e12-11e6-9188-0242ac110007
format: uuid
readOnly: true
type: string
type: object
gateway_compliance_major_version_properties:
additionalProperties: false
properties:
major_count:
type: integer
major_version:
examples:
- 19.4R2-S1.2
type: string
type: object
cpu_stat:
additionalProperties: false
properties:
idle:
description: Percentage of CPU time that is idle
readOnly: true
type:
- number
- 'null'
interrupt:
description: Percentage of CPU time being used by interrupts
readOnly: true
type:
- number
- 'null'
load_avg:
$ref: '#/components/schemas/cpu_stat_load_avg'
system:
description: Percentage of CPU time being used by system processes
readOnly: true
type:
- number
- 'null'
usage:
description: CPU usage
readOnly: true
type:
- number
- 'null'
user:
description: Percentage of CPU time being used by user processes
readOnly: true
type:
- number
- 'null'
type: object
stats_wireless_client_vbeacons:
description: List of beacon_id’s where the client is in and since when (if known)
items:
$ref: '#/components/schemas/stats_wireless_client_vbeacon'
type: array
stats_switch_clients:
items:
$ref: '#/components/schemas/stats_switch_client_item'
type: array
response_http429:
additionalProperties: false
properties:
detail:
examples:
- Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
type: string
type: object
stats_ap_gps_stat_src:
description: 'The origin of the GPS data. enum: `gps`: from this device GPS estimates, `other_ap` from neighboring device GPS estimates. Note: API responses may return `other_aps` which should be treated as `other_ap`'
enum:
- gps
- other_ap
- other_aps
type: string
gateway_compliance_major_version:
additionalProperties:
$ref: '#/components/schemas/gateway_compliance_major_version_properties'
type: object
rx_retries:
description: Amount of rx retries
readOnly: true
type:
- integer
- 'null'
if_stat_property_servp_info:
additionalProperties: false
properties:
asn:
type: string
city:
type: string
country_code:
type: string
latitude:
type: number
longitude:
type: number
org:
type: string
region_code:
type: string
type: object
module_stat_item_fans:
items:
$ref: '#/components/schemas/module_stat_item_fans_items'
type: array
uniqueItems: true
stats_gateway_spu_item:
additionalProperties: false
properties:
spu_cpu:
examples:
- 3670632
type: integer
spu_current_session:
examples:
- 215
type: integer
spu_max_session:
examples:
- 131072
type: integer
spu_memory:
examples:
- 46
type: integer
spu_pending_session:
examples:
- 0
type: integer
spu_uptime:
examples:
- 0
type: integer
spu_valid_session:
type: integer
memory_stat:
additionalProperties: false
description: Memory usage stat (for virtual chassis, memory usage of master RE)
properties:
usage:
type: number
required:
- usage
type: object
port_auth_state:
description: 'enum: `authenticated`, `authenticating`, `held`, `init`'
enum:
- ''
- authenticated
- authenticating
- held
- init
type: string
bgp_peers:
description: Only present when `bgp_peers` in `fields` query parameter. Each port object is same as `GET /api/v1/sites/{site_id}/stats/bgp_peers/search` result object, except that org_id, site_id, mac, model are removed
items:
$ref: '#/components/schemas/bgp_peer'
type: array
module_stat_item_temperatures:
items:
$ref: '#/components/schemas/module_stat_item_temperatures_item'
type: array
uniqueItems: true
module_stat_item_errors_items:
additionalProperties: false
properties:
feature:
examples:
- Mist-Management
type: string
minimum_version:
examples:
- 128T-6.0.0-1
type: string
reason:
type: string
since:
examples:
- 1657497600
type: integer
type:
examples:
- FW_UPGRADE_REQUIRED_BY_FEATURE
type: string
required:
- since
- type
type: object
const_device_type_gateway:
description: 'Device Type. enum: `gateway`'
enum:
- gateway
readOnly: true
type: string
org_id:
examples:
- a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
format: uuid
readOnly: true
type: string
ip_type6:
default: disabled
description: 'enum: `autoconf`, `dhcp`, `disabled`, `static`'
enum:
- autoconf
- dhcp
- disabled
- static
examples:
- static
type: string
last_trouble:
additionalProperties: false
description: Last trouble code of switch
properties:
code:
description: Code definitions list at [List Ap Led Definition](/#operations/listApLedDefinition)
examples:
- '03'
type: string
timestamp:
$ref: '#/components/schemas/timestamp'
type: object
stats_ap_radio_stat:
additionalProperties: false
properties:
band_24:
$ref: '#/components/schemas/ap_radio_stat'
band_5:
$ref: '#/components/schemas/ap_radio_stat'
band_6:
$ref: '#/components/schemas/ap_radio_stat'
type: object
id:
description: Unique ID of the object instance in the Mist Organization
examples:
- 53f10664-3ce8-4c27-b382-0ef66432349f
format: uuid
readOnly: true
type: string
stats_ap_lldp_stats:
additionalProperties:
$ref: '#/components/schemas/stats_ap_lldp_stat'
description: Property key is the port name (e.g. "eth0", "eth1", ...). Map of ethernet ports to their respective LLDP neighbor information and power negotiations. Only present when multiple neighbors exist.
type: object
stats_devices:
items:
$ref: '#/components/schemas/stats_device'
type: array
stats_wireless_client_zone:
additionalProperties: false
properties:
id:
$ref: '#/components/schemas/id'
since:
type: number
type: object
stats_gateway_ports:
description: Only present when `ports` in `fields` query parameter. Each port object is same as `GET /api/v1/sites/{site_id}/stats/ports/search` result object, except that org_id, site_id, mac, model are removed
items:
$ref: '#/components/schemas/stats_gateway_port'
type: array
gateway_compliance_version:
additionalProperties: false
description: Version compliance score, major version for gateway, type
properties:
major_version:
$ref: '#/components/schemas/gateway_compliance_major_version'
score:
examples:
- 99.9
type: number
type:
examples:
- gateway
type: string
type: object
response_http403:
additionalProperties: false
properties:
detail:
examples:
- You do not have permission to perform this action.
type: string
type: object
stats_gateway_port:
additionalProperties: false
description: Port statistics
properties:
active:
description: Indicates if interface is active/inactive
readOnly: true
type: boolean
auth_state:
$ref: '#/components/schemas/port_auth_state'
disabled:
description: Indicates if interface is disabled
readOnly: true
type: boolean
for_site:
readOnly: true
type: boolean
full_duplex:
description: Indicates full or half duplex
examples:
- true
type: boolean
jitter:
description: Last sampled jitter of the interface
readOnly: true
type: number
latency:
description: Last sampled latency of the interface
readOnly: true
type: number
loss:
description: Last sampled loss of the interface
readOnly: true
type: number
lte_iccid:
description: LTE ICCID value, Check for null/empty
type:
- string
- 'null'
lte_imei:
description: LTE IMEI value, Check for null/empty
type:
- string
- 'null'
lte_imsi:
description: LTE IMSI value, Check for null/empty
type:
- string
- 'null'
mac_count:
description: Number of mac addresses in the forwarding table
readOnly: true
type: integer
mac_limit:
description: Limit on number of dynamically learned macs
minimum: 0
readOnly: true
type: integer
neighbor_mac:
description: chassis identifier of the chassis type listed
examples:
- 64d814353400
readOnly: true
type: string
neighbor_port_desc:
description: Description supplied by the system on the interface E.g. "GigabitEthernet2/0/39"
examples:
- GigabitEthernet1/0/21
readOnly: true
type: string
neighbor_system_name:
description: Name supplied by the system on the interface E.g. neighbor system name E.g. "Kumar-Acc-SW.mist.local"
examples:
- CORP-D-SW-2
readOnly: true
type: string
poe_disabled:
description: Is the POE configured not be disabled.
readOnly: true
type: boolean
poe_mode:
$ref: '#/components/schemas/stats_switch_port_poe_mode'
poe_on:
description: Is the device attached to POE
readOnly: true
type: boolean
port_id:
examples:
- ge-0/0/0
readOnly: true
type: string
port_mac:
description: Interface mac address
examples:
- 5c4527a96580
readOnly: true
type: string
port_usage:
examples:
- lan
type: string
power_draw:
description: Amount of power being used by the interface at the time the command is executed. Unit in watts.
readOnly: true
type: number
rx_bcast_pkts:
description: Broadcast input packets
readOnly: true
type: integer
rx_bps:
$ref: '#/components/schemas/rx_bps'
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
rx_errors:
description: Input errors
readOnly: true
type: integer
rx_mcast_pkts:
description: Multicast input packets
readOnly: true
type: integer
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
speed:
description: Port speed
examples:
- 1000
readOnly: true
type: integer
stp_role:
$ref: '#/components/schemas/port_stp_role'
stp_state:
$ref: '#/components/schemas/port_stp_state'
tx_bcast_pkts:
description: Broadcast output packets
readOnly: true
type: integer
tx_bps:
$ref: '#/components/schemas/tx_bps'
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
tx_errors:
description: Output errors
readOnly: true
type: integer
tx_mcast_pkts:
description: Multicast output packets
readOnly: true
type: integer
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
type:
$ref: '#/components/schemas/stats_switch_port_type'
unconfigured:
description: Indicates if interface is unconfigured
readOnly: true
type: boolean
up:
description: Indicates if interface is up
readOnly: true
type: boolean
xcvr_model:
description: Optic Slot ModelName, Check for null/empty
examples:
- SFP+-10G-SR
readOnly: true
type: string
xcvr_part_number:
description: Optic Slot Partnumber, Check for null/empty
examples:
- 740-021487
readOnly: true
type: string
xcvr_serial:
description: Optic Slot SerialNumber, Check for null/empty
examples:
- N6AA9HT
readOnly: true
type: string
required:
- neighbor_mac
- port_id
- port_mac
type: object
wan_tunnel_protocol:
description: 'enum: `gre`, `ipsec`'
enum:
- gre
- ipsec
type: string
stats_wireless_client_vbeacon:
additionalProperties: false
properties:
id:
$ref: '#/components/schemas/id'
since:
type: number
type: object
stats_ap_lldp_stat_power_src:
description: Single power source (DC Input / PoE 802.3at / PoE 802.3af / PoE 802.3bt / MULTI-PD / LLDP / ? (unknown)).
type: string
response_switch_metrics_active_ports_summary:
additionalProperties: false
properties:
details:
$ref: '#/components/schemas/switch_metrics_active_ports_summary_details'
score:
type: integer
total_switch_count:
type: integer
type: object
stats_switch_client_item:
additionalProperties: false
properties:
device_mac:
type: string
hostname:
type: string
mac:
type: string
port_id:
type: string
type: object
ip_type:
default: dhcp
description: 'enum: `dhcp`, `static`'
enum:
- dhcp
- static
examples:
- static
type: string
tx_pkts:
description: Amount of packets sent since connection
examples:
- 812204062
format: int64
readOnly: true
type:
- integer
- 'null'
site_id:
examples:
- 441a1214-6928-442a-8e92-e1d34b8ec6a6
format: uuid
readOnly: true
type: string
stats_switch_module_stat_item:
additionalProperties: false
properties:
backup_version:
readOnly: true
type:
- string
- 'null'
bios_version:
readOnly: true
type:
- string
- 'null'
boot_partition:
type: string
cpld_version:
readOnly: true
type:
- string
- 'null'
cpu_stat:
$ref: '#/components/schemas/cpu_stat'
errors:
$ref: '#/components/schemas/module_stat_item_errors'
fans:
$ref: '#/components/schemas/module_stat_item_fans'
fpc_idx:
readOnly: true
type: integer
fpga_version:
readOnly: true
type:
- string
- 'null'
last_seen:
$ref: '#/components/schemas/last_seen'
locating:
type: boolean
mac:
examples:
- fc3342123456
type: string
memory_stat:
$ref: '#/components/schemas/memory_stat'
model:
examples:
- EX4300-48P
readOnly: true
type:
- string
- 'null'
optics_cpld_version:
readOnly: true
type:
- string
- 'null'
pending_version:
readOnly: true
type:
- string
- 'null'
pics:
$ref: '#/components/schemas/module_stat_item_pics'
poe:
$ref: '#/components/schemas/module_stat_item_poe'
poe_version:
readOnly: true
type:
- string
- 'null'
power_cpld_version:
readOnly: true
type:
- string
- 'null'
psus:
$ref: '#/components/schemas/module_stat_item_psus'
re_fpga_version:
readOnly: true
type:
- string
- 'null'
recovery_version:
readOnly: true
type:
- string
- 'null'
serial:
examples:
- PX8716230021
readOnly: true
type:
- string
- 'null'
status:
readOnly: true
type:
- string
- 'null'
temperatures:
$ref: '#/components/schemas/module_stat_item_temperatures'
tmc_fpga_version:
readOnly: true
type:
- string
- 'null'
type:
readOnly: true
type:
- string
- 'null'
uboot_version:
readOnly: true
type:
- string
- 'null'
uptime:
readOnly: true
type:
- integer
- 'null'
vc_links:
$ref: '#/components/schemas/module_stat_item_vc_links'
vc_mode:
readOnly: true
type:
- string
- 'null'
vc_role:
description: 'enum: `master`, `backup`, `linecard`'
examples:
- master
readOnly: true
type:
- string
- 'null'
vc_state:
readOnly: true
type:
- string
- 'null'
version:
readOnly: true
type:
- string
- 'null'
type: object
last_seen:
description: Last seen timestamp
examples:
- 1470417522
format: double
readOnly: true
type:
- number
- 'null'
response_http404:
additionalProperties: false
properties:
id:
type: string
type: object
const_device_type_ap:
description: 'Device Type. enum: `ap`'
enum:
- ap
readOnly: true
type: string
response_switch_metrics:
additionalProperties: false
properties:
active_ports_summary:
$ref: '#/components/schemas/response_switch_metrics_active_ports_summary'
config_success:
$ref: '#/components/schemas/response_switch_metrics_config_success'
version_compliance:
$ref: '#/components/schemas/response_switch_metrics_version_compliance'
type: object
response_switch_metrics_version_compliance:
additionalProperties: false
properties:
details:
$ref: '#/components/schemas/response_switch_metrics_version_compliance_details'
score:
type: integer
total_switch_count:
type: integer
type: object
ap_redundancy_module:
additionalProperties: false
properties:
num_aps:
examples:
- 15
type: integer
num_aps_with_switch_redundancy:
examples:
- 8
type: integer
type: object
switch_metric_scope:
description: 'enum: `site`, `switch`'
enum:
- site
- switch
type: string
stats_cluster_config_ethernet_connection_item:
additionalProperties: false
properties:
name:
type: string
status:
type: string
type: object
bgp_peer:
additionalProperties: false
description: Only present when `bgp_peers` in `fields` query parameter
properties:
evpn_overlay:
description: If this is created for evpn overlay
type: boolean
for_overlay:
description: If this is created for overlay
type: boolean
local_as:
$ref: '#/components/schemas/bgp_as'
neighbor:
examples:
- 15.8.3.5
type: string
neighbor_as:
$ref: '#/components/schemas/bgp_as'
neighbor_mac:
description: If it's another device in the same org
examples:
- 020001c04600
type: string
node:
description: Node0/node1
examples:
- node0
type: string
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
rx_routes:
description: Number of received routes
examples:
- 60
type: integer
state:
$ref: '#/components/schemas/bgp_stats_state'
timestamp:
$ref: '#/components/schemas/timestamp'
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
tx_routes:
examples:
- 60
type: integer
up:
type: boolean
uptime:
examples:
- 31355
type: integer
vrf_name:
examples:
- default
type: string
type: object
service_stat_property:
additionalProperties: false
properties:
ash_version:
type: string
cia_version:
type: string
ember_version:
type: string
ipsec_client_version:
type: string
mist_agent_version:
type: string
package_version:
type: string
testing_tools_version:
type: string
wheeljack_version:
type: string
type: object
response_http400:
additionalProperties: false
properties:
detail:
examples:
- 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
type: string
type: object
ap_stat_mesh_downlink:
additionalProperties: false
properties:
band:
examples:
- '5'
type: string
channel:
examples:
- 36
type: integer
idle_time:
examples:
- 3
type: integer
last_seen:
$ref: '#/components/schemas/last_seen'
proto:
examples:
- n
type: string
rssi:
examples:
- -65
type: integer
rx_bps:
$ref: '#/components/schemas/rx_bps'
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
rx_packets:
$ref: '#/components/schemas/rx_pkts'
rx_rate:
$ref: '#/components/schemas/rx_rate'
rx_retries:
$ref: '#/components/schemas/rx_retries'
site_id:
$ref: '#/components/schemas/site_id'
snr:
examples:
- 31
type: integer
tx_bps:
$ref: '#/components/schemas/tx_bps'
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
tx_packets:
$ref: '#/components/schemas/tx_pkts'
tx_rate:
$ref: '#/components/schemas/tx_rate'
tx_retries:
$ref: '#/components/schemas/tx_retries'
type: object
stats_ap:
additionalProperties: false
description: AP statistics
properties:
antenna_select:
$ref: '#/components/schemas/antenna_select'
auto_placement:
$ref: '#/components/schemas/stats_ap_auto_placement'
auto_upgrade_stat:
$ref: '#/components/schemas/stats_ap_auto_upgrade'
ble_stat:
$ref: '#/components/schemas/stats_ap_ble'
cert_expiry:
examples:
- 1534534392
readOnly: true
type:
- number
- 'null'
config_reverted:
readOnly: true
type:
- boolean
- 'null'
cpu_system:
format: int64
readOnly: true
type:
- integer
- 'null'
cpu_user:
format: int32
readOnly: true
type:
- integer
- 'null'
cpu_util:
format: int32
readOnly: true
type:
- integer
- 'null'
created_time:
$ref: '#/components/schemas/created_time'
deviceprofile_id:
format: uuid
readOnly: true
type:
- string
- 'null'
env_stat:
$ref: '#/components/schemas/stats_ap_env_stat'
esl_stat:
$ref: '#/components/schemas/stats_ap_esl_stat'
evpntopo_id:
format: uuid
readOnly: true
type:
- string
- 'null'
expiring_certs:
$ref: '#/components/schemas/stats_ap_expiring_certs'
ext_ip:
examples:
- 73.92.124.103
readOnly: true
type:
- string
- 'null'
fwupdate:
$ref: '#/components/schemas/fwupdate_stat'
gps_stat:
$ref: '#/components/schemas/stats_ap_gps_stat'
hw_rev:
readOnly: true
type:
- string
- 'null'
id:
$ref: '#/components/schemas/id'
inactive_wired_vlans:
$ref: '#/components/schemas/integers'
iot_stat:
$ref: '#/components/schemas/stats_ap_iot_stat'
ip:
examples:
- 10.2.9.159
readOnly: true
type:
- string
- 'null'
ip_config:
$ref: '#/components/schemas/ap_ip_config'
ip_stat:
$ref: '#/components/schemas/ip_stat'
l2tp_stat:
additionalProperties:
$ref: '#/components/schemas/stats_ap_l2tp_stat'
description: L2TP tunnel status (key is the wxtunnel_id)
type: object
last_seen:
$ref: '#/components/schemas/last_seen'
last_trouble:
$ref: '#/components/schemas/last_trouble'
led:
$ref: '#/components/schemas/ap_led'
lldp_stat:
$ref: '#/components/schemas/stats_ap_lldp_stat'
lldp_stats:
$ref: '#/components/schemas/stats_ap_lldp_stats'
locating:
examples:
- false
readOnly: true
type:
- boolean
- 'null'
locked:
description: Whether this AP is considered locked (placement / orientation has been vetted)
examples:
- true
readOnly: true
type:
- boolean
- 'null'
mac:
description: Device mac
examples:
- 5c5b35000010
readOnly: true
type:
- string
- 'null'
map_id:
examples:
- 63eda950-c6da-11e4-a628-60f81dd250cc
format: uuid
readOnly: true
type:
- string
- 'null'
mem_total_kb:
format: int64
readOnly: true
type:
- integer
- 'null'
mem_used_kb:
format: int64
readOnly: true
type:
- integer
- 'null'
mesh_downlinks:
additionalProperties:
$ref: '#/components/schemas/ap_stat_mesh_downlink'
description: Property key is the mesh downlink id (e.g. `00000000-0000-0000-1000-5c5b35000010`)
type: object
mesh_uplink:
$ref: '#/components/schemas/ap_stat_mesh_uplink'
model:
description: Device model
examples:
- AP200
readOnly: true
type:
- string
- 'null'
modified_time:
$ref: '#/components/schemas/modified_time'
mount:
examples:
- faceup
readOnly: true
type:
- string
- 'null'
name:
examples:
- conference room
readOnly: true
type:
- string
- 'null'
notes:
readOnly: true
type:
- string
- 'null'
num_clients:
description: How many wireless clients are currently connected
readOnly: true
type:
- integer
- 'null'
num_wlans:
description: How many WLANs are applied to the device
type: integer
org_id:
$ref: '#/components/schemas/org_id'
port_stat:
additionalProperties:
$ref: '#/components/schemas/stats_ap_port_stat'
description: Property key is the port name (e.g. `eth0`)
readOnly: true
type:
- object
- 'null'
power_budget:
description: In mW, surplus if positive or deficit if negative
examples:
- 1000
format: int32
readOnly: true
type:
- integer
- 'null'
power_constrained:
description: Whether insufficient power
examples:
- false
readOnly: true
type:
- boolean
- 'null'
power_opmode:
description: Constrained mode
examples:
- '[20] 6GHz(2x2) 5GHz(4x4) 2.4GHz(2x2).'
readOnly: true
type:
- string
- 'null'
power_src:
description: DC Input / PoE 802.3at / PoE 802.3af / LLDP / ? (unknown)
examples:
- PoE 802.3af
readOnly: true
type:
- string
- 'null'
radio_config:
$ref: '#/components/schemas/stats_ap_radio_config'
radio_stat:
$ref: '#/components/schemas/stats_ap_radio_stat'
rx_bps:
$ref: '#/components/schemas/rx_bps'
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
serial:
description: Serial Number
examples:
- FXLH2015170017
readOnly: true
type:
- string
- 'null'
site_id:
$ref: '#/components/schemas/site_id'
status:
readOnly: true
type:
- string
- 'null'
switch_redundancy:
$ref: '#/components/schemas/stats_ap_switch_redundancy'
tx_bps:
$ref: '#/components/schemas/tx_bps'
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
type:
$ref: '#/components/schemas/const_device_type_ap'
uptime:
description: How long, in seconds, has the device been up (or rebooted)
examples:
- 13500
readOnly: true
type:
- number
- 'null'
usb_stat:
$ref: '#/components/schemas/stats_ap_usb_stat'
version:
examples:
- 0.14.12345
readOnly: true
type:
- string
- 'null'
x:
examples:
- 53.5
format: double
readOnly: true
type:
- number
- 'null'
y:
examples:
- 173.1
format: double
readOnly: true
type:
- number
- 'null'
required:
- type
title: stats_ap
type: object
integers:
items:
type: integer
type: array
stats_device:
discriminator:
mapping:
ap: '#/components/schemas/stats_ap'
gateway: '#/components/schemas/stats_gateway'
switch: '#/components/schemas/stats_switch'
propertyName: type
oneOf:
- $ref: '#/components/schemas/stats_ap'
- $ref: '#/components/schemas/stats_switch'
- $ref: '#/components/schemas/stats_gateway'
poe_priority:
description: 'PoE priority. enum: `low`, `high`'
enum:
- low
- high
type: string
module_stat_item_psus_item:
additionalProperties: false
properties:
name:
examples:
- Power Supply 0
type: string
status:
examples:
- ok
type: string
type: object
fwupdate_stat_status:
description: 'enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`'
enum:
- inprogress
- failed
- upgraded
- success
- scheduled
- error
readOnly: true
type:
- string
- 'null'
module_stat_item_pics:
items:
$ref: '#/components/schemas/module_stat_item_pics_item'
type: array
module_stat_item_fans_items:
additionalProperties: false
properties:
airflow:
examples:
- out
type: string
name:
examples:
- Fan 0
type: string
rpm:
type: integer
status:
examples:
- ok
type: string
type: object
dot11_band:
description: 'enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
enum:
- '24'
- '5'
- 5-dedicated
- 5-selectable
- '6'
- 6-dedicated
- 6-selectable
type: string
switch_metric_type:
description: 'enum: `active_ports_summary`'
enum:
- active_ports_summary
type: string
ibeacon_major:
description: Major number for iBeacon
examples:
- 1234
maximum: 65535
minimum: 1
type:
- integer
- 'null'
stats_wireless_client:
additionalProperties: false
properties:
accuracy:
description: Estimated client location accuracy, in meter
type: integer
airespace_ifname:
type: string
airwatch:
$ref: '#/components/schemas/stats_wireless_client_airwatch'
annotation:
type: string
ap_id:
description: AP ID the client is connected to
format: uuid
type: string
ap_mac:
description: AP the client is connected to
type: string
assoc_time:
type: integer
band:
$ref: '#/components/schemas/dot11_band'
bssid:
type: string
channel:
description: Current channel
type: integer
dual_band:
description: Whether the client is dual_band capable (determined by whether we’ve seen probe requests from both bands)
type: boolean
family:
description: Device family, through fingerprinting. iPod / Nexus Galaxy / Windows Mobile or CE …
type: string
group:
type: string
guest:
$ref: '#/components/schemas/guest'
hostname:
description: Hostname that we learned from sniffing DHCP
type: string
idle_time:
description: How long, in seconds, has the client been idle (since the last RX packet)
type: number
ip:
type: string
is_guest:
default: false
description: Whether this is a guest
type: boolean
key_mgmt:
description: E.g. WPA2-PSK/CCMP
type: string
last_seen:
$ref: '#/components/schemas/last_seen'
mac:
description: Client mac
type: string
manufacture:
description: Device manufacture, through fingerprinting or OUI
type: string
map_id:
description: Estimated client location - map_id
format: uuid
type: string
model:
description: Device model, may be available if we can identify them
type: string
num_locating_aps:
description: Number of APs used to locate this client
type: integer
os:
description: Device os, through fingerprinting
type: string
power_saving:
description: If it’s currently in power-save mode
type: boolean
proto:
$ref: '#/components/schemas/dot11_proto'
psk_id:
description: PSK id (if multi-psk is used)
format: uuid
type: string
rssi:
description: Signal strength
type: number
rssizones:
$ref: '#/components/schemas/stats_wireless_client_rssi_zones'
rx_bps:
$ref: '#/components/schemas/rx_bps'
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
rx_rate:
$ref: '#/components/schemas/rx_rate'
rx_retries:
$ref: '#/components/schemas/rx_retries'
site_id:
$ref: '#/components/schemas/site_id'
snr:
description: Signal over noise
type: number
ssid:
description: SSID the client is connected to
type: string
tx_bps:
$ref: '#/components/schemas/tx_bps'
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
tx_rate:
$ref: '#/components/schemas/tx_rate'
tx_retries:
$ref: '#/components/schemas/tx_retries'
type:
description: Client’s type, regular / vip / resource / blocked (if client object is created)
type: string
uptime:
description: How long, in seconds, has the client been connected
type: number
username:
description: Username that we learned from 802.1X exchange or Per_user PSK or User Portal
type: string
vbeacons:
$ref: '#/components/schemas/stats_wireless_client_vbeacons'
vlan_id:
description: VLAN id, could be empty (from older AP)
type: string
wlan_id:
description: WLAN ID the client is connected to
format: uuid
type: string
wxrule_id:
description: Current WxlanRule using for a Client or an authorized Guest (portal user). null if default rule is matched.
format: uuid
type: string
wxrule_usage:
$ref: '#/components/schemas/stats_wireless_client_wxrule_usages'
x:
description: Estimated client location in pixels
format: double
type: number
x_m:
description: Estimated client location in meter
format: double
type: number
y:
description: Estimated client location in pixels
format: double
type: number
y_m:
description: Estimated client location in meter
format: double
type: number
zones:
$ref: '#/components/schemas/stats_wireless_client_zones'
required:
- ap_id
- ap_mac
- band
- channel
- is_guest
- key_mgmt
- mac
- proto
- rssi
- snr
- ssid
- wlan_id
type: object
dot11_bandwidth:
description: 'channel width for the band.enum: `0`(disabled, response only), `20`, `40`, `80` (only applicable for band_5 and band_6), `160` (only for band_6)'
enum:
- 0
- 20
- 40
- 80
- 160
examples:
- 20
type: integer
rx_bytes:
description: Amount of traffic received since connection
examples:
- 8515104416
format: int64
readOnly: true
type:
- integer
- 'null'
rx_pkts:
description: Amount of packets received since connection
examples:
- 57770567
format: int64
readOnly: true
type:
- integer
- 'null'
modified_time:
description: When the object has been modified for the last time, in epoch
format: double
readOnly: true
type: number
stats_cluster_config_control_link_info:
additionalProperties: false
properties:
name:
type: string
status:
type: string
type: object
stats_cluster_config_redundancy_group_info:
items:
$ref: '#/components/schemas/stats_cluster_config_redundancy_group_info_item'
type: array
parameters:
device_id:
in: path
name: device_id
required: true
schema:
examples:
- 000000ab-00ab-00ab-00ab-0000000000ab
format: uuid
type: string
page:
in: query
name: page
schema:
default: 1
minimum: 1
type: integer
site_id:
in: path
name: site_id
required: true
schema:
examples:
- 000000ab-00ab-00ab-00ab-0000000000ab
format: uuid
type: string
fields:
description: List of additional fields requests, comma separated, or `fields=*` for all of them
in: query
name: fields
schema:
examples:
- field1,field2
type: string
limit:
in: query
name: limit
schema:
default: 100
minimum: 0
type: integer
responses:
SwitchMetrics:
content:
application/json:
examples:
Site Scoped:
$ref: '#/components/examples/SwitchMetricsSiteScoped'
Switch Scoped:
$ref: '#/components/examples/SwitchMetricsSwitchScoped'
schema:
$ref: '#/components/schemas/response_switch_metrics'
application/vnd.api+json:
examples:
Site Scoped:
$ref: '#/components/examples/SwitchMetricsSiteScoped'
Switch Scoped:
$ref: '#/components/examples/SwitchMetricsSwitchScoped'
schema:
$ref: '#/components/schemas/response_switch_metrics'
description: OK
HTTP403:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP403Example'
schema:
$ref: '#/components/schemas/response_http403'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP403Example'
schema:
$ref: '#/components/schemas/response_http403'
description: Permission Denied
HTTP401:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP401Example'
schema:
$ref: '#/components/schemas/response_http401'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP401Example'
schema:
$ref: '#/components/schemas/response_http401'
description: Unauthorized
DeviceStats:
content:
application/json:
examples:
Access Point Stats:
$ref: '#/components/examples/DeviceStatsAccessPointStats'
Gateway Stats:
$ref: '#/components/examples/DeviceStatsGatewayStats'
Switch Stats:
$ref: '#/components/examples/DeviceStatsSwitchStats'
schema:
$ref: '#/components/schemas/stats_device'
application/vnd.api+json:
examples:
Access Point Stats:
$ref: '#/components/examples/DeviceStatsAccessPointStats'
Gateway Stats:
$ref: '#/components/examples/DeviceStatsGatewayStats'
Switch Stats:
$ref: '#/components/examples/DeviceStatsSwitchStats'
schema:
$ref: '#/components/schemas/stats_device'
description: OK
HTTP404:
content:
application/json:
schema:
$ref: '#/components/schemas/response_http404'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/response_http404'
description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
GatewayMetrics:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/GatewayMetricsExample'
schema:
$ref: '#/components/schemas/gateway_metrics'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/GatewayMetricsExample'
schema:
$ref: '#/components/schemas/gateway_metrics'
description: OK
DevicesArrayStatsSite:
content:
application/json:
examples:
Access Point Stats:
$ref: '#/components/examples/DevicesArrayStatsSiteAccessPointStats'
Gateway Stats:
$ref: '#/components/examples/DevicesArrayStatsSiteGatewayStats'
Switch:
$ref: '#/components/examples/DevicesArrayStatsSiteSwitch'
schema:
$ref: '#/components/schemas/stats_devices'
application/vnd.api+json:
examples:
Access Point Stats:
$ref: '#/components/examples/DevicesArrayStatsSiteAccessPointStats'
Gateway Stats:
$ref: '#/components/examples/DevicesArrayStatsSiteGatewayStats'
Switch:
$ref: '#/components/examples/DevicesArrayStatsSiteSwitch'
schema:
$ref: '#/components/schemas/stats_devices'
description: OK
HTTP429:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP429Example'
schema:
$ref: '#/components/schemas/response_http429'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP429Example'
schema:
$ref: '#/components/schemas/response_http429'
description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
HTTP400:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP400Example'
schema:
$ref: '#/components/schemas/response_http400'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP400Example'
schema:
$ref: '#/components/schemas/response_http400'
description: Bad Syntax
securitySchemes:
apiToken:
description: "Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equal or less privileges.\n\n**Format**:\n API Token value format is `Token {apitoken}`\n\n**Notes**:\n* an API token generated for a specific admin has the same privilege as the user\n* an API token will be automatically removed if not used for > 90 days\n* SSO admins cannot generate these API tokens. Refer Org level API tokens which can have privileges of a specific Org/Site for more information."
in: header
name: Authorization
type: apiKey
basicAuth:
description: While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
scheme: basic
type: http
csrfToken:
description: "This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-site_request_forgery), all the POST / PUT / DELETE APIs needs to have CSRF token in the AJAX Request header when using Login/Password authentication (with or without MFA)\n\n\nThe CSRF Token is sent back by Mist in the Cookies from the Login Response API Call:\n`cookies[csrftoken]` \n\nThe CSRF Token must be added in the HTTP Request Headers:\n```\nX-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx\n```"
in: header
name: X-CSRFToken
type: apiKey