How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mist Utilities LAN API

API Calls to use Devices Troubleshooting tools specific to Wired Assurance

Mist Utilities LAN API is one of 212 APIs that Mist 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.

This API exposes 18 operations across 18 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 2606.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.2.0
API Version
2606.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

Mist Utilities LAN API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…
  • csrfToken — Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…

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_bios_multi (4 properties), upgrade_fpga_multi (4 properties), response_wired_coa (3 properties). Each schema is shown below with its type and property counts.

upgrade_fpga_multi_device_ids
array
Device IDs selected for a multi-device FPGA upgrade
upgrade_bios_multi_device_ids
array
Device IDs selected for a multi-device BIOS upgrade
response_http403
object
Standard HTTP 403 permission error response
1 property
utils_clear_bpdu_ports
array
List of ports on which to clear the detected BPDU error, or all for all ports
upgrade_fpga
object
FPGA upgrade request for a single device
2 properties
utils_show_arp
object
ARP table lookup request for device command output
6 properties
response_http400
object
Standard HTTP 400 bad request error response
1 property
upgrade_bios
object
BIOS upgrade request for a single device
2 properties
devices_ids
object
Request body containing device identifiers
1 property 1 required
clear_dot1x_session
object
Request body for clearing dot1x sessions on switch ports
1 property
response_wired_coa
object
Response returned after triggering wired client CoA reauthentication
3 properties
upgrade_bios_multi_models
array
Device models selected for a multi-device BIOS upgrade
timestamp
number
Epoch timestamp, in seconds
upgrade_fpga_multi
object
FPGA upgrade request for multiple devices
4 properties
utils_clear_macs_ports
array
Device ports on which to clear learned MAC addresses. Must include logical unit number
response_http404
object
Standard HTTP 404 not found error response
1 property
ha_cluster_node_enum
string
HA cluster node selector. enum: node0, node1
response_http401
object
Standard HTTP 401 authentication error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
utils_clear_macs
object
Request to clear learned MAC addresses from device ports
1 property
response_device_bios_upgrade
object
Device BIOS upgrade status response
2 properties
upgrade_bios_multi
object
BIOS upgrade request for multiple devices
4 properties
utils_clear_bpdu
object
Request to clear detected BPDU errors on switch ports
1 property
clear_dot1x_session_ports
array
List of port IDs where the dot1x session must be cleared. Use all to clear sessions on all ports.
upgrade_fpga_multi_models
array
Device models selected for a multi-device FPGA upgrade
utils_cable_tests
object
Request body for running a switch cable test on a port
1 property 1 required
websocket_session
object
Response containing the WebSocket session handle for asynchronous command output
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Mist publishes across the network.

Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
Where this information came from

This is an independent, third-party profile of Mist Utilities LAN API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.