A Mist Edge (MxEdge) is a physical or virtual appliance that is deployed in a network to provide centralized data path for user traffic or as a RADIUS Proxy, which was traditionally performed by legacy wireless controllers. It keeps all the control and management functions in the Mist Cloud, offering a microservices architecture to the campus.
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 Orgs MxEdges 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: A Mist Edge (MxEdge) is a physical or virtual appliance that is deployed in a network to provide centralized data path for user traffic or as a RADIUS Proxy, which was traditionally performed by legacy wireless controllers. It keeps all the control and management functions in the Mist Cloud, offering a microservices architecture to the campus.
name: Orgs MxEdges
paths:
/api/v1/orgs/{org_id}/mxedges:
parameters:
- $ref: '#/components/parameters/org_id'
get:
description: List Mist Edge appliances in the organization, optionally filtering for org-level, site-level, or all Mist Edges with `for_site`.
operationId: listOrgMxEdges
parameters:
- description: 'Filter for org/site level Mist Edges. enum: `any`, `false`, `true`'
in: query
name: for_site
schema:
$ref: '#/components/schemas/mxedge_for_site'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/page'
responses:
'200':
$ref: '#/components/responses/MxedgesArray'
'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: listOrgMxEdges
tags:
- Orgs MxEdges
post:
description: Create a Mist Edge appliance configuration in the organization, including cluster assignment, management, services, and tunnel termination settings.
operationId: createOrgMxEdge
requestBody:
content:
application/json:
examples:
Example:
value:
model: ME-100
mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4
mxedge_mgmt: {}
name: Guest
ntp_servers: []
oob_ip_config: {}
services:
- tunterm
tunterm_ip_config:
gateway: 10.2.1.254
ip: 10.2.1.1
netmask: 255.255.255.0
tunterm_port_config:
downstream_ports:
- '0'
- '1'
- '2'
- '3'
separate_upstream_downstream: true
upstream_port_vlan_id: 1
upstream_ports:
- '0'
- '1'
- '2'
- '3'
tunterm_switch_config:
'0':
port_vlan_id: 1
vlan_ids:
- 5
- 2
- 3
enabled: true
schema:
$ref: '#/components/schemas/mxedge'
description: Request Body
responses:
'200':
$ref: '#/components/responses/Mxedge'
'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: createOrgMxEdge
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/assign:
parameters:
- $ref: '#/components/parameters/org_id'
post:
description: Assign one or more Mist Edge appliances from the organization to a site by Mist Edge ID and site ID.
operationId: assignOrgMxEdgeToSite
requestBody:
content:
application/json:
examples:
Example:
value:
mxedge_ids:
- 387804a7-3474-85ce-15a2-f9a9684c9c90
site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b
schema:
$ref: '#/components/schemas/mxedges_assign'
description: Request Body
responses:
'200':
$ref: '#/components/responses/AssignSuccess'
'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: assignOrgMxEdgeToSite
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/claim:
parameters:
- $ref: '#/components/parameters/org_id'
post:
description: Claim one or more Mist Edge appliances into the organization using their claim codes.
operationId: claimOrgMxEdge
requestBody:
content:
application/json:
examples:
Example:
value:
- 6JG8E-PTFV2-A9Z2N
- DVH4V-SNMSZ-PDXBR
schema:
$ref: '#/components/schemas/claim_codes'
description: Request Body
responses:
'200':
$ref: '#/components/responses/ClaimMxedge'
'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: claimOrgMxEdge
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/count:
parameters:
- $ref: '#/components/parameters/org_id'
get:
description: Count organization Mist Edge records, optionally grouped by `distinct` and filtered by Mist Edge, cluster, site, model, distro, tunnel termination version, and time range.
operationId: countOrgMxEdges
parameters:
- description: 'Field used to group this count response. enum: `distro`, `model`, `mxcluster_id`, `site_id`, `tunterm_version`'
in: query
name: distinct
schema:
$ref: '#/components/schemas/org_mxedge_count_distinct'
- description: Filter results by Mist Edge identifier
in: query
name: mxedge_id
schema:
type: string
- description: Mist edge site id
in: query
name: site_id
schema:
type: string
- description: Mist edge cluster id
in: query
name: mxcluster_id
schema:
type: string
- description: Filter results by device model
in: query
name: model
schema:
type: string
- description: Debian code name (buster, bullseye)
in: query
name: distro
schema:
type: string
- description: Filter results by tunnel termination version
in: query
name: tunterm_version
schema:
type: string
- description: Field used to sort results
in: query
name: sort
schema:
type: string
- description: Whether to return device stats, default is false
in: query
name: stats
schema:
type: boolean
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/limit'
responses:
'200':
$ref: '#/components/responses/Count'
'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: countOrgMxEdges
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/events/count:
parameters:
- $ref: '#/components/parameters/org_id'
get:
description: Count Mist Edge event records across the organization, optionally grouped by `distinct` and filtered by Mist Edge, cluster, event type, service, and time range.
operationId: countOrgSiteMxEdgeEvents
parameters:
- description: 'Field used to group this count response. enum: `mxcluster_id`, `mxedge_id`, `package`, `type`'
in: query
name: distinct
schema:
$ref: '#/components/schemas/org_mxedge_events_count_distinct'
- description: Filter results by Mist Edge identifier
in: query
name: mxedge_id
schema:
type: string
- description: Mist edge cluster id
in: query
name: mxcluster_id
schema:
type: string
- $ref: '#/components/parameters/mxedge_event_type'
- description: Filter results by service name
in: query
name: service
schema:
type: string
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/limit'
responses:
'200':
$ref: '#/components/responses/Count'
'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: countOrgSiteMxEdgeEvents
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/events/search:
parameters:
- $ref: '#/components/parameters/org_id'
get:
description: Search Mist Edge event records across the organization with filters for Mist Edge, cluster, event type, service, component, and time range.
operationId: searchOrgMistEdgeEvents
parameters:
- description: Filter results by Mist Edge identifier
in: query
name: mxedge_id
schema:
type: string
- description: Mist edge cluster id
in: query
name: mxcluster_id
schema:
type: string
- $ref: '#/components/parameters/mxedge_event_type'
- description: Filter results by service name
in: query
name: service
schema:
type: string
- description: Filter results by component name
in: query
name: component
schema:
type: string
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/sort_last_seen_reverse'
- $ref: '#/components/parameters/search_after'
responses:
'200':
$ref: '#/components/responses/MxEdgeEventsSearch'
'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: searchOrgMistEdgeEvents
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/search:
parameters:
- $ref: '#/components/parameters/org_id'
get:
description: Search organization Mist Edge records with filters for hostname, Mist Edge, cluster, site, model, distro, tunnel termination version, and time range.
operationId: searchOrgMxEdges
parameters:
- description: Partial / full Device hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-london*` and `*london*` match `my-london-1`). Suffix-only wildcards (e.g. `*london-1`) are not supported. Accepts multiple comma-separated values.
in: query
name: hostname
schema:
examples:
- my-london-1,my-london*
- my-london-1
- my-london*
- '*london*'
type: string
- description: Filter results by Mist Edge identifier. Accepts multiple comma-separated values.
in: query
name: mxedge_id
schema:
examples:
- 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
type: string
- description: Mist edge cluster id. Accepts multiple comma-separated values.
in: query
name: mxcluster_id
schema:
examples:
- 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
type: string
- description: Partial / full Device model. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `AP4*` and `*P4*` match `AP43`). Suffix-only wildcards (e.g. `*43`) are not supported. Accepts multiple comma-separated values.
in: query
name: model
schema:
examples:
- AP43,AP4*
- AP43
- AP4*
- '*P4*'
type: string
- description: Debian code name (buster, bullseye)
in: query
name: distro
schema:
type: string
- description: Filter results by tunnel termination version
in: query
name: tunterm_version
schema:
type: string
- description: Mist edge site id
in: query
name: site_id
schema:
type: string
- description: Whether to return device stats, default is false
in: query
name: stats
schema:
type: boolean
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/sort_last_seen_reverse'
- $ref: '#/components/parameters/search_after'
responses:
'200':
$ref: '#/components/responses/MxEdgeSearch'
'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: searchOrgMxEdges
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/unassign:
parameters:
- $ref: '#/components/parameters/org_id'
post:
description: Unassign one or more Mist Edge appliances from their current site while keeping them in the organization.
operationId: unassignOrgMxEdgeFromSite
requestBody:
content:
application/json:
examples:
Example:
value:
mxedge_ids:
- 387804a7-3474-85ce-15a2-f9a9684c9c90
schema:
$ref: '#/components/schemas/mxedges_unassign'
description: Request Body
responses:
'200':
$ref: '#/components/responses/AssignSuccess'
'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: unassignOrgMxEdgeFromSite
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/versions:
parameters:
- $ref: '#/components/parameters/org_id'
get:
description: Retrieve available Mist Edge package versions by upgrade channel and distro.
operationId: getOrgMxEdgeUpgradeInfo
parameters:
- description: 'Upgrade channel used to filter available versions. enum: `alpha`, `beta`, `stable`'
in: query
name: channel
schema:
$ref: '#/components/schemas/get_org_mxedge_upgrade_info_channel'
- description: Filter results by distro
in: query
name: distro
schema:
type: string
responses:
'200':
$ref: '#/components/responses/MxedgeUpgradeInfo'
'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: getOrgMxEdgeUpgradeInfo
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}:
parameters:
- $ref: '#/components/parameters/org_id'
- $ref: '#/components/parameters/mxedge_id'
delete:
description: Delete a Mist Edge appliance record from the organization by Mist Edge ID.
operationId: deleteOrgMxEdge
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: deleteOrgMxEdge
tags:
- Orgs MxEdges
get:
description: Retrieve configuration and registration details for a specific Mist Edge appliance in the organization.
operationId: getOrgMxEdge
responses:
'200':
$ref: '#/components/responses/Mxedge'
'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: getOrgMxEdge
tags:
- Orgs MxEdges
put:
description: Update a Mist Edge appliance configuration, including model, name, management IP, services, and tunnel termination settings.
operationId: updateOrgMxEdge
requestBody:
content:
application/json:
examples:
Example:
value:
model: ME-X1
name: me-gc1-01
oob_ip_config:
dns:
- 8.8.8.8
- 1.1.1.1
gateway: 10.3.172.9
ip: 10.3.172.201
netmask: /24
type: static
services:
- tunterm
tunterm_ip_config:
gateway: 10.10.172.2
ip: 10.10.172.201
netmask: /24
tunterm_port_config:
downstream_ports:
- '0'
separate_upstream_downstream: true
upstream_port_vlan_id: '1010'
upstream_ports:
- '1'
schema:
$ref: '#/components/schemas/mxedge'
description: Request Body
responses:
'200':
$ref: '#/components/responses/Mxedge'
'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: updateOrgMxEdge
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/image/{image_number}:
parameters:
- $ref: '#/components/parameters/org_id'
- $ref: '#/components/parameters/mxedge_id'
- in: path
name: image_number
required: true
schema:
maximum: 3
minimum: 1
type: integer
delete:
description: Delete a numbered image attachment from a Mist Edge appliance.
operationId: deleteOrgMxEdgeImage
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: deleteOrgMxEdgeImage
tags:
- Orgs MxEdges
post:
description: Upload and attach an image file to a Mist Edge appliance. A Mist Edge can have up to three image attachments.
operationId: addOrgMxEdgeImage
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/image_import'
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: addOrgMxEdgeImage
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/restart:
parameters:
- $ref: '#/components/parameters/org_id'
- $ref: '#/components/parameters/mxedge_id'
post:
description: Restart the registration workflow for a Mist Edge replacement by disconnecting the currently registered appliance so another Mist Edge can register.
operationId: restartOrgMxEdge
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: restartOrgMxEdge
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/services/tunterm/bounce_port:
parameters:
- $ref: '#/components/parameters/org_id'
- $ref: '#/components/parameters/mxedge_id'
post:
description: Bounce one or more TunTerm data ports on a Mist Edge, optionally setting the hold time between port bounces.
operationId: bounceOrgMxEdgeDataPorts
parameters: []
requestBody:
content:
application/json:
examples:
Example:
value:
ports:
- '0'
- '2'
Example2:
value:
hold_time: 0
ports:
- string
schema:
$ref: '#/components/schemas/utils_tunterm_bounce_port'
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: bounceOrgMxEdgeDataPorts
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/services/tunterm/disconnect_aps:
parameters:
- $ref: '#/components/parameters/org_id'
- $ref: '#/components/parameters/mxedge_id'
post:
description: Disconnect specific APs from the Mist Edge TunTerm service by AP MAC address.
operationId: disconnectOrgMxEdgeTuntermAps
parameters: []
requestBody:
content:
application/json:
examples:
Example:
value:
macs:
- 5c5b353e4eb1
- 5c5b353e4eb2
schema:
$ref: '#/components/schemas/mac_addresses'
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: disconnectOrgMxEdgeTuntermAps
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/services/{name}/{action}:
parameters:
- $ref: '#/components/parameters/org_id'
- $ref: '#/components/parameters/mxedge_id'
- description: 'enum: `mxagent`, `mxdas`, `mxnacedge`, `mxocproxy`, `radsecproxy`, `tunterm`'
in: path
name: name
required: true
schema:
$ref: '#/components/schemas/mxedge_service_name'
- description: Restart or start or stop
in: path
name: action
required: true
schema:
$ref: '#/components/schemas/mxedge_service_action'
post:
description: Start, stop, or restart a named Mist Edge service such as `tunterm`, `mxagent`, or `radsecproxy`.
operationId: controlOrgMxEdgeServices
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: controlOrgMxEdgeServices
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/support:
parameters:
- $ref: '#/components/parameters/org_id'
- $ref: '#/components/parameters/mxedge_id'
post:
description: Trigger upload of support files from a Mist Edge for troubleshooting.
operationId: uploadOrgMxEdgeSupportFiles
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: uploadOrgMxEdgeSupportFiles
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/unregister:
parameters:
- $ref: '#/components/parameters/org_id'
- $ref: '#/components/parameters/mxedge_id'
post:
description: Unregister a Mist Edge during a replacement workflow by disconnecting the currently registered appliance so another Mist Edge can register.
operationId: unregisterOrgMxEdge
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: unregisterOrgMxEdge
tags:
- Orgs MxEdges
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/vm_params:
parameters:
- $ref: '#/components/parameters/org_id'
- $ref: '#/components/parameters/mxedge_id'
get:
description: Retrieve VM deployment parameters for a Mist Edge, including model, optional name, and base64 user data.
operationId: getOrgMxEdgeVmParams
responses:
'200':
$ref: '#/components/responses/MxEdgeVmParams'
'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: getOrgMxEdgeVmParams
tags:
- Orgs MxEdges
components:
schemas:
vlan_id_with_variable:
description: VLAN ID, either numeric or expressed as a template variable string
oneOf:
- type: string
- maximum: 4094
minimum: 1
type: integer
timestamp:
description: Epoch timestamp, in seconds
format: double
readOnly: true
type: number
mxedge_tunterm_dhcpd_config:
additionalProperties:
$ref: '#/components/schemas/mxedge_tunterm_dhcpd_config_property'
description: Global and per-VLAN DHCP relay settings for Mist Tunneled VLANs; property key is the VLAN ID
properties:
enabled:
default: false
description: Whether DHCP relay is enabled for Mist Tunneled VLANs
type: boolean
servers:
$ref: '#/components/schemas/mxedge_tunterm_dhcpd_config_servers'
description: DHCP relay server addresses used when `type`==`relay`
type:
$ref: '#/components/schemas/mxedge_tunterm_dhcpd_type'
description: DHCP handling mode for the global tunnel termination config
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
mxedge_tunterm_switch_config_vlan_ids:
description: Tagged VLAN IDs allowed on a tunnel termination switch port
items:
$ref: '#/components/schemas/vlan_id_with_variable'
type: array
event_severity:
description: 'Severity level for an event. enum: `normal`, `critical`, `high`, `warning`'
enum:
- normal
- critical
- high
- warning
type
# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mist/refs/heads/main/openapi/mist-orgs-mxedges-api-openapi.yml