Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Juniper Mist AI

Juniper Mist AI Utilities LAN API

API Calls to use Devices Troubleshooting tools specific to Wired Assurance

Documentation Provider Profile APIs.io OpenAPI GitHub

Juniper Mist AI Utilities LAN API is one of 211 APIs that Juniper Mist AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Utilities LAN. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 18 paths, and defines 27 schemas. It is described by OpenAPI 3.1.0, at version 2604.1.1.

Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.

18 operations 18 paths 27 schemas 18 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2604.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, HTTP Basic, API Key
Contact
Thomas Munzer
License
MIT
Resource Areas
1

Authentication & Security 3

Juniper Mist AI Utilities LAN API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…
  • basicAuth — While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
  • csrfToken — This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…

Paths & Operations 18

Across 18 paths, the API surfaces 18 operations — 18 POST. Each is listed below with its method, path, parameters, and response codes.

Utilities LAN 18

API Calls to use Devices Troubleshooting tools specific to Wired Assurance

POST
/api/v1/orgs/{org_id}/wired_clients/{client_mac}/coa
reauthOrgDot1xWiredClient
reauthOrgDot1xWiredClient 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/clear_pending_version
clearSiteMultipleDevicePendingVersion
clearSiteMultipleDevicePendingVersion 1 param body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/restore_backup_version
restoreSiteMultipleDeviceBackupVersion
restoreSiteMultipleDeviceBackupVersion 1 param body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/upgrade_bios
upgradeSiteDevicesBios
upgradeSiteDevicesBios 1 param body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/upgrade_fpga
upgradeSiteDevicesFpga
upgradeSiteDevicesFpga 1 param body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/cable_test
cableTestFromSwitch
cableTestFromSwitch 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/clear_bpdu_error
clearBpduErrorsFromPortsOnSwitch
clearBpduErrorsFromPortsOnSwitch 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/clear_dot1x
clearSiteDeviceDot1xSession
clearSiteDeviceDot1xSession 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/clear_macs
clearAllLearnedMacsFromPortOnSwitch
clearAllLearnedMacsFromPortOnSwitch 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/clear_pending_version
clearSiteDevicePendingVersion
clearSiteDevicePendingVersion 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/poll_stats
pollSiteSwitchStats
pollSiteSwitchStats 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/restore_backup_version
restoreSiteDeviceBackupVersion
restoreSiteDeviceBackupVersion 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/show_arp
showSiteDeviceArpTable
showSiteDeviceArpTable 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/snapshot
createSiteDeviceSnapshot
createSiteDeviceSnapshot 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/upgrade_bios
upgradeDeviceBios
upgradeDeviceBios 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/upgrade_fpga
upgradeDeviceFPGA
upgradeDeviceFPGA 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/vc/switch_master
toogleSiteDeviceVcRoutingEnginesRole
toogleSiteDeviceVcRoutingEnginesRole 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/wired_clients/{client_mac}/coa
reauthSiteDot1xWiredClient
reauthSiteDot1xWiredClient 2 params → 200400401403404429

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are utils_show_arp (6 properties), upgrade_fpga_multi (4 properties), upgrade_bios_multi (4 properties), response_wired_coa (3 properties). Each schema is shown below with its type and property counts.

clear_dot1x_session
object
1 property
upgrade_fpga
object
2 properties
response_wired_coa
object
3 properties
utils_clear_macs_ports
array
List of ports on which to clear mac addresses. must include logical unit number
response_http403
object
1 property
upgrade_fpga_multi
object
4 properties
upgrade_bios_multi
object
4 properties
response_device_bios_upgrade
object
2 properties
upgrade_bios_multi_device_ids
array
List of device id to upgrade bios
response_http404
object
1 property
utils_clear_bpdu
object
1 property
timestamp
number
Epoch (seconds)
upgrade_bios
object
2 properties
utils_show_arp
object
6 properties
utils_cable_tests
object
1 property 1 required
response_http400
object
1 property
upgrade_fpga_multi_models
array
List of device model to upgrade bios
response_http429
object
1 property
upgrade_fpga_multi_device_ids
array
List of device id to upgrade bios
utils_clear_macs
object
1 property
websocket_session
object
1 property 1 required
ha_cluster_node_enum
string
only for HA. enum: node0, node1
utils_clear_bpdu_ports
array
List of ports on which to clear the detected BPDU error, or all for all ports
clear_dot1x_session_ports
array
List of port IDs where the dot1x session must be cleared. Use all to clear sessions on all ports.
response_http401
object
1 property
upgrade_bios_multi_models
array
List of device model to upgrade bios
devices_ids
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-utilities-lan-api-openapi.yml Raw ↑

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API
AE Profile APIs.io
Juniper Mist Webhooks API
AE Profile APIs.io
Juniper Mist AI Admins API
AE Profile APIs.io
Juniper Mist AI Admins Login API
AE Profile APIs.io
Juniper Mist AI Admins Login - OAuth2 API
AE Profile APIs.io
Juniper Mist AI Admins Logout API
AE Profile APIs.io
Juniper Mist AI Admins Lookup API
AE Profile APIs.io
Juniper Mist AI Admins Recover Password API
AE Profile APIs.io
Juniper Mist AI Constants Definitions API
AE Profile APIs.io
Juniper Mist AI Constants Events API
AE Profile APIs.io
Juniper Mist AI Constants Models API
AE Profile APIs.io
Juniper Mist AI Installer API
AE Profile APIs.io
#Utilities LAN
← Back to J APIs
API Details
ID
mist-ai:mist-ai-utilities-lan-api
Base URL
https://api.mist.com/api/v1
Docs
https://www.juniper.net/documentation/us/en/software/mist/api/http/getting-started/how-to-get-started
Provider
Juniper Mist AI
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network