Mist Utilities LAN API
API Calls to use Devices Troubleshooting tools specific to Wired Assurance
OpenAPI Specification
openapi: 3.1.0
info:
contact:
email: tmunzer@juniper.net
name: Thomas Munzer
description: '> Version: **2606.1.1**
>
> Date: **July 10, 2026**
<div class="notification"> NOTE:<br>Some important API changes will be introduced. Please make sure to read the <a href="https://www.juniper.net/documentation/us/en/software/mist/api/http/guides/important-api-changes">announcements</a> </div>
---
## 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 Utilities LAN API
version: 2606.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: []
- csrfToken: []
tags:
- description: API Calls to use Devices Troubleshooting tools specific to Wired Assurance
name: Utilities LAN
paths:
/api/v1/orgs/{org_id}/wired_clients/{client_mac}/coa:
parameters:
- $ref: '#/components/parameters/org_id'
- $ref: '#/components/parameters/client_mac'
post:
description: Trigger a CoA (change of authorization) against a Wired client
operationId: reauthOrgDot1xWiredClient
responses:
'200':
$ref: '#/components/responses/ReauthWiredClient'
'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: reauthOrgDot1xWiredClient
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/clear_pending_version:
parameters:
- $ref: '#/components/parameters/site_id'
post:
description: Clear device pending fw version (Available on Junos OS EX2300-, EX3400-, EX4000-, EX4100-, EX4400- devices)
operationId: clearSiteMultipleDevicePendingVersion
requestBody:
content:
application/json:
examples:
Example:
value:
device_ids:
- 00000000-0000-0000-1000-5c5b35584a6f
- 00000000-0000-0000-1000-5c5b350ea3b3
schema:
$ref: '#/components/schemas/devices_ids'
description: Request Body
responses:
'200':
$ref: '#/components/responses/OK'
'400':
content:
application/json:
examples:
cannot-clear-pending-version-on-an-offline-device:
value: cannot clear pending version on an offline device
clear-pending-version-not-supported:
value: clear-pending-fw-version not supported
schema:
type: string
description: Bad Request
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: clearSiteMultipleDevicePendingVersion
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/restore_backup_version:
parameters:
- $ref: '#/components/parameters/site_id'
post:
description: Restore device backup fw version (Available on Junos OS EX4000-, EX4100-, EX4400- devices)
operationId: restoreSiteMultipleDeviceBackupVersion
requestBody:
content:
application/json:
examples:
Example:
value:
device_ids:
- 00000000-0000-0000-1000-5c5b35584a6f
- 00000000-0000-0000-1000-5c5b350ea3b3
schema:
$ref: '#/components/schemas/devices_ids'
description: Request Body
responses:
'200':
$ref: '#/components/responses/OK'
'400':
content:
application/json:
examples:
cannot-restore-backup-version-on-an-offline-device:
value: snapshot not supported
restore-backup-fw-version-not-supported:
value: cannot snapshot an offline device
schema:
type: string
description: Bad Request
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: restoreSiteMultipleDeviceBackupVersion
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/upgrade_bios:
parameters:
- $ref: '#/components/parameters/site_id'
post:
description: Upgrade Bios on Multiple Device
operationId: upgradeSiteDevicesBios
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/upgrade_bios_multi'
responses:
'200':
$ref: '#/components/responses/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: upgradeSiteDevicesBios
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/upgrade_fpga:
parameters:
- $ref: '#/components/parameters/site_id'
post:
description: Upgrade Bios on Multiple Device
operationId: upgradeSiteDevicesFpga
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/upgrade_fpga_multi'
responses:
'200':
$ref: '#/components/responses/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: upgradeSiteDevicesFpga
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/cable_test:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: "TDR can be performed from the Switch. The output will be available through websocket. As there can be multiple commands issued against the same Switch at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```json\n{\n \"event\": \"data\",\n \"channel\": \"/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd\",\n \"data\": {\n \"session\": \"session_id\",\n \"raw\": \"Interface TDR detail:\\nTest status : Test successfully executed ge-0/0/0\\n\"\n }\n}\n```"
operationId: cableTestFromSwitch
requestBody:
content:
application/json:
examples:
Example:
value:
port: ge-0/0/0
schema:
$ref: '#/components/schemas/utils_cable_tests'
responses:
'200':
$ref: '#/components/responses/WebsocketSession'
'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: cableTestFromSwitch
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/clear_bpdu_error:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: Clear bridge protocol data unit (BPDU) error condition caused by the detection of a possible bridging loop from Spanning Tree Protocol (STP) operation that renders the port unoperational.
operationId: clearBpduErrorsFromPortsOnSwitch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/utils_clear_bpdu'
responses:
'200':
$ref: '#/components/responses/OK'
'400':
description: Ports not specified
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: clearBpduErrorsFromPortsOnSwitch
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/clear_dot1x:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: Clear Dot1x Session. The output will be available through websocket.
operationId: clearSiteDeviceDot1xSession
requestBody:
content:
application/json:
examples:
Example:
value:
ports:
- ge-0/0/0
schema:
$ref: '#/components/schemas/clear_dot1x_session'
description: Request Body
responses:
'200':
$ref: '#/components/responses/WebsocketSession'
'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: clearSiteDeviceDot1xSession
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/clear_macs:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: Clear all learned MAC addresses, including persistent MAC addresses, on a port.
operationId: clearAllLearnedMacsFromPortOnSwitch
requestBody:
content:
application/json:
examples:
Example:
value:
ports:
- ge-0/0/0.0
schema:
$ref: '#/components/schemas/utils_clear_macs'
responses:
'200':
$ref: '#/components/responses/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: clearAllLearnedMacsFromPortOnSwitch
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/clear_pending_version:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: Clear device pending fw version (Available on Junos OS EX2300-, EX3400-, EX4000-, EX4100-, EX4400- devices)
operationId: clearSiteDevicePendingVersion
responses:
'200':
$ref: '#/components/responses/OK'
'400':
content:
application/json:
examples:
cannot-clear-pending-version-on-an-offline-device:
value: cannot clear pending version on an offline device
clear-pending-version-not-supported:
value: clear-pending-fw-version not supported
schema:
type: string
description: Bad Request
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: clearSiteDevicePendingVersion
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/poll_stats:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: This API can be used to poll statistics from the Switch proactively once. After it is called, the statistics will be pushed back to the cloud within the statistics interval.
operationId: pollSiteSwitchStats
responses:
'200':
$ref: '#/components/responses/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: pollSiteSwitchStats
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/restore_backup_version:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: Restore device backup fw version (Available on Junos OS EX4000-, EX4100-, EX4400- devices)
operationId: restoreSiteDeviceBackupVersion
responses:
'200':
$ref: '#/components/responses/OK'
'400':
content:
application/json:
examples:
cannot-restore-backup-version-on-an-offline-device:
value: cannot restore backup version on an offline device
restore-backup-fw-version-not-supported:
value: restore-backup-fw-version not supported
schema:
type: string
description: Bad Request
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: restoreSiteDeviceBackupVersion
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/show_arp:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: "Get ARP Table from the Device.\n\nThe output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n"
operationId: showSiteDeviceArpTable
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/utils_show_arp'
description: All attributes are optional
responses:
'200':
$ref: '#/components/responses/WebsocketSession'
'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: showSiteDeviceArpTable
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/snapshot:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: Create recovery device snapshot (Available on Junos OS EX2300-, EX3400-, EX4400- devices)
operationId: createSiteDeviceSnapshot
responses:
'200':
$ref: '#/components/responses/OK'
'400':
content:
application/json:
examples:
cannot-snapshot-an-offline-device:
value: cannot snapshot an offline device
snapshot-not-supported:
value: snapshot not supported
schema:
type: string
description: Bad Request
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: createSiteDeviceSnapshot
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/upgrade_bios:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: Upgrade device bios
operationId: upgradeDeviceBios
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/upgrade_bios'
responses:
'200':
$ref: '#/components/responses/DeviceBiosUpgrade'
'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: upgradeDeviceBios
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/upgrade_fpga:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: Upgrade device fpga
operationId: upgradeDeviceFPGA
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/upgrade_fpga'
responses:
'200':
$ref: '#/components/responses/DeviceBiosUpgrade'
'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: upgradeDeviceFPGA
tags:
- Utilities LAN
/api/v1/sites/{site_id}/devices/{device_id}/vc/switch_master:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
post:
description: In a pre-provisioned VC, mastership is system-determined. This command allows manual toggling between primary and backup Routing Engines.
operationId: toogleSiteDeviceVcRoutingEnginesRole
responses:
'200':
$ref: '#/components/responses/OK'
'400':
content:
application/json:
examples:
backup-re-not-present:
value: backup routing engine is not present
device-is-not-an-oc-device:
value: The device is not an OC device
non-provisioned-vc-not-supported:
value: Non-provisioned VC is not supported currently
vc-is-currently-disconnected:
value: VC is currently disconnected
schema:
type: string
description: Bad Request
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: toogleSiteDeviceVcRoutingEnginesRole
tags:
- Utilities LAN
/api/v1/sites/{site_id}/wired_clients/{client_mac}/coa:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/client_mac'
post:
description: Trigger a CoA (change of authorization) against a Wired client
operationId: reauthSiteDot1xWiredClient
responses:
'200':
$ref: '#/components/responses/ReauthWiredClient'
'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: reauthSiteDot1xWiredClient
tags:
- Utilities LAN
components:
schemas:
upgrade_bios_multi:
description: BIOS upgrade request for multiple devices
properties:
device_ids:
$ref: '#/components/schemas/upgrade_bios_multi_device_ids'
description: Specific device IDs to include in the BIOS upgrade
models:
$ref: '#/components/schemas/upgrade_bios_multi_models'
description: Device models to include in the BIOS upgrade
reboot:
default: false
description: Whether to restart the selected devices immediately after the upgrade completes
type: boolean
version:
description: BIOS version to install on the selected devices
examples:
- CDEN_P_EX1_00.15.01.00
type: string
type: object
websocket_session:
additionalProperties: false
description: Response containing the WebSocket session handle for asynchronous command output
properties:
session:
description: Identifier used to correlate output on the WebSocket stream
examples:
- 19e73828-937f-05e6-f709-e29efdb0a82b
type: string
required:
- session
type: object
timestamp:
description: Epoch timestamp, in seconds
format: double
readOnly: true
type: number
upgrade_fpga:
description: FPGA upgrade request for a single device
properties:
reboot:
default: false
description: Whether to restart the device immediately after the upgrade completes
type: boolean
version:
description: FPGA version to install on the device
examples:
- REV37
type: string
type: object
utils_show_arp:
description: ARP table lookup request for device command output
properties:
duration:
default: 0
description: Refresh duration in seconds; set only when `interval` is nonzero
maximum: 300
minimum: 0
type: integer
interval:
default: 0
description: Refresh interval in seconds for repeated command output
maximum: 10
minimum: 0
type: integer
ip:
description: Address filter for the ARP table lookup
examples:
- 192.168.30.7
type: string
node:
$ref: '#/components/schemas/ha_cluster_node_enum'
description: HA cluster node to run the command on, required for Gateways
port_id:
description: Device port identifier filter for the ARP table lookup
examples:
- ge-0/0/0.0
type: string
vrf:
description: Routing instance or VRF filter for the ARP table lookup
examples:
- guest
type: string
type: object
response_http429:
additionalProperties: false
description: Standard HTTP 429 rate limit error response
properties:
detail:
description: Human-readable explanation of the rate limit error
examples:
- Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
type: string
type: object
response_http401:
additionalProperties: false
description: Standard HTTP 401 authentication error response
properties:
detail:
description: Human-readable explanation of the authentication error
examples:
- Authentication credentials were not provided.
type: string
type: object
response_device_bios_upgrade:
additionalProperties: false
description: Device BIOS upgrade status response
properties:
status:
description: Current BIOS upgrade status for the device
type: string
timestamp:
$ref: '#/components/schemas/timestamp'
description: Epoch timestamp when the BIOS upgrade status was reported
type: object
response_http403:
additionalProperties: false
description: Standard HTTP 403 permission error response
properties:
detail:
description: Human-readable explanation of the permission error
examples:
- You do not have permission to perform this action.
type: string
type: object
utils_clear_bpdu:
description: Request to clear detected BPDU errors on switch ports
properties:
ports:
$ref: '#/components/schemas/utils_clear_bpdu_ports'
description: Switch ports on which to clear detected BPDU errors
type: object
ha_cluster_node_enum:
description: 'HA cluster node selector. enum: `node0`, `node1`'
enum:
- node0
- node1
type: string
clear_dot1x_session:
description: Request body for clearing dot1x sessions on switch ports
properties:
ports:
$ref: '#/components/schemas/clear_dot1x_session_ports'
description: Port IDs whose dot1x sessions should be cleared
type: object
devices_ids:
description: Request body containing device identifiers
properties:
device_ids:
description: Device identifiers to operate on in the request
items:
format: uuid
type: string
type: array
required:
- device_ids
type: object
utils_clear_macs:
description: Request to clear learned MAC addresses from device ports
properties:
ports:
$ref: '#/components/schemas/utils_clear_macs_ports'
description: Switch ports on which to clear learned MAC addresses
type: object
response_http400:
additionalProperties: false
description: Standard HTTP 400 bad request error response
properties:
detail:
description: Human-readable explanation of the bad request error
examples:
- 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
type: string
type: object
utils_clear_bpdu_ports:
description: List of ports on which to clear the detected BPDU error, or `all` for all ports
items:
type: string
type: array
upgrade_bios_multi_device_ids:
description: Device IDs selected for a multi-device BIOS upgrade
items:
examples:
- 00000000-0000-0000-1000-5c5b35584a6f
format: uuid
type: string
type: array
upgrade_bios:
description: BIOS upgrade request for a single device
properties:
reboot:
default: false
description: Whether to restart the device immediately after the upgrade completes
type: boolean
version:
description: BIOS version to install on the device
examples:
- CDEN_P_EX1_00.20.01.00
type: string
type: object
upgrade_fpga_multi:
description: FPGA upgrade request for multiple devices
properties:
device_ids:
$ref: '#/components/schemas/upgrade_fpga_multi_device_ids'
description: Specific device IDs to include in the FPGA upgrade
models:
$ref: '#/components/schemas/upgrade_fpga_multi_models'
description: Device models to include in the FPGA upgrade
reboot:
default: false
description: Whether to restart the selected devices immediately after the upgrade completes
type: boolean
version:
description: FPGA version to install on the selected devices
examples:
- REV37
type: string
type: object
utils_cable_tests:
description: Request body for running a switch cable test on a port
properties:
port:
description: The port to run the cable test
type: string
required:
- port
type: object
response_wired_coa:
additionalProperties: false
description: Response returned after triggering wired client CoA reauthentication
properties:
device_mac:
description: MAC address of the switch or gateway hosting the wired client session
examples:
- 5c5b35000002
type: string
port_id:
description: Interface identifier for the wired client session
examples:
- ge-0/0/0
type: string
session:
description: RADIUS session identifier used for the CoA request
examples:
- 0a2a11b8-4b30-40d8-a6d1-e91ea540d86f
format: uuid
type: string
type: object
clear_dot1x_session_ports:
description: List of port IDs where the dot1x session must be cleared. Use `all` to clear sessions on all ports.
examples:
- - ge-0/0/0
- ge-0/0/1
items:
type: string
type: array
upgrade_bios_multi_models:
description: Device models selected for a multi-device BIOS upgrade
items:
examples:
- EX4400-48T
type: string
type: array
upgrade_fpga_multi_device_ids:
description: Device IDs selected for a multi-device FPGA upgrade
items:
examples:
- 00000000-0000-0000-1000-5c5b35584a6f
format: uuid
type: string
type: array
upgrade_fpga_multi_models:
description: Device models selected for a multi-device FPGA upgrade
items:
examples:
- EX4400-48T
type: string
type: array
response_http404:
additionalProperties: false
description: Standard HTTP 404 not found error response
properties:
id:
description: Missing resource identifier, when the API includes one
type: string
type: object
utils_clear_macs_p
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mist/refs/heads/main/openapi/mist-utilities-lan-api-openapi.yml