Mist Sites MxEdges API

MxEdges (Mist Edges) at the site level are deployed to tunnel traffic at each site due to network constraints or security concerns. They can be assigned to a specific site and configured to provide tunneling and RADIUS proxy services for the access points (APs) in that site. These Mist Edges allow for the extension of user vlans from the corporate network to the aps, and they support features such as auto preemption for failover, dual tunneling to different mist edge clusters, and anchor tunnels for traffic routing to dmz areas.

OpenAPI Specification

mist-sites-mxedges-api-openapi.yml Raw ↑
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 Sites 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: 'MxEdges (Mist Edges) at the site level are deployed to tunnel traffic at each site due to network constraints or security concerns.


    They can be assigned to a specific site and configured to provide tunneling and RADIUS proxy services for the access points (APs) in that site.


    These Mist Edges allow for the extension of user vlans from the corporate network to the aps, and they support features such as auto preemption for failover, dual tunneling to different mist edge clusters, and anchor tunnels for traffic routing to dmz areas.'
  name: Sites MxEdges
paths:
  /api/v1/sites/{site_id}/mxedges:
    parameters:
    - $ref: '#/components/parameters/site_id'
    get:
      description: List Mist Edges for a site. Use [List Org Mist Edges](/#operations/listOrgMxEdges) to retrieve Mist Edges across the organization.
      operationId: listSiteMxEdges
      parameters:
      - $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: listSiteMxEdges
      tags:
      - Sites MxEdges
  /api/v1/sites/{site_id}/mxedges/events/count:
    parameters:
    - $ref: '#/components/parameters/site_id'
    get:
      description: Count by Distinct Attributes of Mist Edge Events
      operationId: countSiteMxEdgeEvents
      parameters:
      - description: 'Field used to group this count response. enum: `mxcluster_id`, `mxedge_id`, `package`, `type`'
        in: query
        name: distinct
        schema:
          $ref: '#/components/schemas/site_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: countSiteMxEdgeEvents
      tags:
      - Sites MxEdges
  /api/v1/sites/{site_id}/mxedges/events/search:
    parameters:
    - $ref: '#/components/parameters/site_id'
    get:
      description: Search Mist Edge events for a site with filters for Mist Edge, Mist Edge cluster, event type, service, component, and time range. Use [Search Org Mist Edge Events](/#operations/searchOrgMistEdgeEvents) to search Mist Edge events across the organization.
      operationId: searchSiteMistEdgeEvents
      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_10'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      - $ref: '#/components/parameters/duration'
      - $ref: '#/components/parameters/sort'
      - $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: searchSiteMistEdgeEvents
      tags:
      - Sites MxEdges
  /api/v1/sites/{site_id}/mxedges/{mxedge_id}:
    parameters:
    - $ref: '#/components/parameters/site_id'
    - $ref: '#/components/parameters/mxedge_id'
    delete:
      description: Delete Site Mist Edge
      operationId: deleteSiteMxEdge
      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: deleteSiteMxEdge
      tags:
      - Sites MxEdges
    get:
      description: Get Site Mist Edge
      operationId: getSiteMxEdge
      responses:
        '200':
          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: getSiteMxEdge
      tags:
      - Sites MxEdges
    put:
      description: Update Site Mist Edge settings
      operationId: updateSiteMxEdge
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mxedge'
      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: updateSiteMxEdge
      tags:
      - Sites MxEdges
  /api/v1/sites/{site_id}/mxedges/{mxedge_id}/support:
    parameters:
    - $ref: '#/components/parameters/site_id'
    - $ref: '#/components/parameters/mxedge_id'
    post:
      description: Support / Upload Mist Edge support files
      operationId: uploadSiteMxEdgeSupportFiles
      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: uploadSiteMxEdgeSupportFiles
      tags:
      - Sites MxEdges
components:
  parameters:
    limit_10:
      description: Maximum number of results to return per page
      in: query
      name: limit
      schema:
        default: 10
        minimum: 0
        type: integer
    sort:
      description: On which field the list should be sorted, -prefix represents DESC order
      in: query
      name: sort
      schema:
        default: timestamp
        examples:
        - -site_id
        type: string
    mxedge_event_type:
      description: See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)
      in: query
      name: type
      schema:
        type: string
    end:
      description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`
      in: query
      name: end
      schema:
        type: string
    mxedge_id:
      in: path
      name: mxedge_id
      required: true
      schema:
        examples:
        - 000000ab-00ab-00ab-00ab-0000000000ab
        format: uuid
        type: string
    duration:
      description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`
      in: query
      name: duration
      schema:
        default: 1d
        examples:
        - 10m
        type: string
    page:
      description: Select the page number to return when using page-based pagination; starts at `1`
      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
    start:
      description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`
      in: query
      name: start
      schema:
        type: string
    limit:
      description: Maximum number of results to return per page
      in: query
      name: limit
      schema:
        default: 100
        minimum: 0
        type: integer
    search_after:
      description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
      in: query
      name: search_after
      schema:
        type: string
  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
    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
    id:
      description: Unique ID of the object instance in the Mist Organization
      examples:
      - 53f10664-3ce8-4c27-b382-0ef66432349f
      format: uuid
      readOnly: true
      type: string
    event_severity:
      description: 'Severity level for an event. enum: `normal`, `critical`, `high`, `warning`'
      enum:
      - normal
      - critical
      - high
      - warning
      type: string
    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
    mxedge_tunterm_extra_route:
      additionalProperties: false
      description: Extra route for Mist Tunnel traffic on a Mist Edge
      properties:
        via:
          description: Next-hop IP address for this Mist Tunnel extra route
          type: string
      type: object
    mxedge_tunterm_igmp_snooping_config:
      additionalProperties: false
      description: IGMP snooping settings for Mist Tunnel VLANs
      properties:
        enabled:
          anyOf:
          - type: boolean
          - type: string
          default: false
          description: Whether IGMP snooping is enabled for the configured VLANs
        querier:
          $ref: '#/components/schemas/mxedge_tunterm_igmp_snooping_querier'
          description: IGMP querier settings used with tunnel termination snooping
        vlan_ids:
          $ref: '#/components/schemas/mxedge_tunterm_igmp_snooping_config_vlan_ids'
          description: List of VLAN IDs where tunnel termination performs IGMP snooping
      type: object
    mxedge_tunterm_dhcpd_config_type:
      default: relay
      description: 'DHCP handling mode for this tunneled VLAN. enum: `relay`'
      enum:
      - relay
      type: string
    mxedge_tunterm_dhcpd_config_property:
      additionalProperties: false
      description: Per-VLAN DHCP relay settings for a Mist Tunneled VLAN
      properties:
        enabled:
          default: false
          description: Whether DHCP relay is enabled for this tunneled VLAN
          type: boolean
        servers:
          $ref: '#/components/schemas/mxedge_tunterm_dhcpd_config_servers'
          description: DHCP relay server addresses used by this tunneled VLAN
        type:
          $ref: '#/components/schemas/mxedge_tunterm_dhcpd_config_type'
          description: DHCP handling mode for this tunneled VLAN
      type: object
    tunterm_port_config:
      additionalProperties: false
      description: Ethernet port configuration for tunnel termination interfaces
      properties:
        downstream_ports:
          $ref: '#/components/schemas/tunterm_port_config_downstream_ports'
          description: Ports connected downstream toward APs for tunnel termination
        separate_upstream_downstream:
          default: false
          description: Whether to separate upstream / downstream ports. default is false where all ports will be used.
          type: boolean
        upstream_port_vlan_id:
          $ref: '#/components/schemas/tunterm_port_config_upstream_port_vlan_id'
          description: Native VLAN ID applied to upstream tunnel termination ports
        upstream_ports:
          $ref: '#/components/schemas/tunterm_port_config_upstream_ports'
          description: Ports connected upstream toward the LAN for tunnel termination
      type: object
    site_id:
      description: Unique identifier of a Mist site
      examples:
      - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      format: uuid
      readOnly: true
      type: string
    mxedge_tunterm_multicast_config:
      additionalProperties: false
      description: Multicast forwarding settings for tunnel termination
      properties:
        mdns:
          $ref: '#/components/schemas/mxedge_tunterm_multicast_mdns'
          description: Settings for mDNS forwarding on tunnel termination VLANs
        ssdp:
          $ref: '#/components/schemas/mxedge_tunterm_multicast_ssdp'
          description: Settings for SSDP forwarding on tunnel termination VLANs
      type: object
    mxedge_mgmt:
      additionalProperties: false
      description: Management settings for a Mist Edge appliance
      properties:
        config_auto_revert:
          default: false
          description: Whether the Mist Edge automatically reverts configuration changes if connectivity is lost
          type: boolean
        fips_enabled:
          default: false
          description: Whether FIPS mode is enabled on the Mist Edge
          type: boolean
        mist_password:
          description: Password for the Mist service account on the Mist Edge
          examples:
          - MIST_PASSWORD
          type: string
        oob_ip_type:
          $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type'
          description: IPv4 address assignment mode for out-of-band management
        oob_ip_type6:
          $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type6'
          description: IPv6 address assignment mode for out-of-band management
        root_password:
          description: Root account password for the Mist Edge
          examples:
          - ROOT_PASSWORD
          format: password
          type: string
      type: object
    ip_type:
      default: dhcp
      description: 'IP address assignment mode, either DHCP or static. enum: `dhcp`, `static`'
      enum:
      - dhcp
      - static
      examples:
      - static
      type: string
    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
    created_time:
      description: When the object has been created, in epoch
      format: double
      readOnly: true
      type: number
    tunterm_port_config_downstream_ports:
      description: List of ports to be used for downstream (to AP) purpose
      examples:
      - - '2'
        - '3'
      items:
        type: string
      type: array
    tunterm_port_config_upstream_ports:
      description: List of ports to be used for upstream purpose (to LAN)
      examples:
      - - '0'
        - '1'
      items:
        type: string
      type: array
    mxedge_mgmt_oob_ip_type6:
      default: autoconf
      description: 'enum: `autoconf`, `dhcp`, `disabled`, `static`'
      enum:
      - autoconf
      - dhcp
      - disabled
      - static
      type: string
    count_result:
      additionalProperties:
        type: string
      description: Count result row with the matching distinct field values
      properties:
        count:
          description: Number of matching items for the distinct value or values in this result
          type: integer
      required:
      - count
      type: object
    mxedge_versions:
      additionalProperties: false
      description: Read-only Mist Edge service versions
      properties:
        mxagent:
          description: Reported version of the mxagent service
          readOnly: true
          type: string
        tunterm:
          description: Reported version of the tunnel termination service
          readOnly: true
          type: string
      readOnly: true
      type: object
    tunterm_monitoring_item:
      additionalProperties: false
      description: Monitoring check for tunnel termination reachability
      properties:
        host:
          description: Can be ip, ipv6, hostname
          examples:
          - 10.2.8.15
          minLength: 1
          type: string
        port:
          description: When `protocol`==`tcp`, TCP port checked by the monitoring probe
          examples:
          - 80
          type: integer
        protocol:
          $ref: '#/components/schemas/tunterm_monitoring_protocol'
          description: Monitoring method used for this tunnel termination check
        src_vlan_id:
          description: Optional source for the monitoring check, vlan_id configured in tunterm_other_ip_configs
          examples:
          - 5
          type: integer
        timeout:
          default: 300
          description: Maximum time for this monitoring check, in seconds
          examples:
          - 300
          type: integer
      type: object
    tunterm_port_config_upstream_port_vlan_id:
      description: Native VLAN ID for upstream ports
      oneOf:
      - type: string
      - maximum: 4094
        minimum: 1
        type: integer
    mxedge:
      description: Mist Edge appliance configuration and registration state
      properties:
        created_time:
          $ref: '#/components/schemas/created_time'
          description: Timestamp when the Mist Edge record was created
        for_site:
          description: Whether this Mist Edge is scoped to a site
          readOnly: true
          type: boolean
        id:
          $ref: '#/components/schemas/id'
          description: Unique identifier of the Mist Edge
        mac:
          description: Mist Edge MAC address
          examples:
          - 0200009fbe65
          readOnly: true
          type: string
        magic:
          description: Registration claim code for the Mist Edge
          examples:
          - L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD
          readOnly: true
          type: string
        model:
          description: Mist Edge hardware or virtual appliance model
          examples:
          - ME-100
          type: string
        modified_time:
          $ref: '#/components/schemas/modified_time'
          description: Timestamp when the Mist Edge record was last modified
        mxagent_registered:
          description: Whether the Mist Edge agent has registered with Mist cloud
          readOnly: true
          type: boolean
        mxcluster_id:
          description: Mist Edge cluster identifier that this appliance belongs to
          examples:
          - 572586b7-f97b-a22b-526c-8b97a3f609c4
          format: uuid
          type:
          - string
          - 'null'
        mxedge_mgmt:
          $ref: '#/components/schemas/mxedge_mgmt'
          description: Management credentials and settings for the Mist Edge
        name:
          description: Display name of the Mist Edge
          examples:
          - Guest
          type: string
        notes:
          description: Free-form notes for the Mist Edge
          examples:
          - note for mxedge
          type: string
        ntp_servers:
          $ref: '#/components/schemas/strings'
          description: Time synchronization servers used by the Mist Edge
        oob_ip_config:
          $ref: '#/components/schemas/mxedge_oob_ip_config'
          description: Out-of-band management IP configuration for the Mist Edge
        org_id:
          $ref: '#/components/schemas/org_id'
          description: Identifier of the org that owns the Mist Edge
        proxy:
          $ref: '#/components/schemas/proxy'
          description: Network proxy settings used by the Mist Edge
        services:
          $ref: '#/components/schemas/mxedge_services'
          description: List of services enabled to run on the Mist Edge
        site_id:
          $ref: '#/components/schemas/site_id'
          description: Identifier of the site when the Mist Edge is site-scoped
        tunterm_dhcpd_config:
          $ref: '#/components/schemas/mxedge_tunterm_dhcpd_config'
          description: DHCP relay or server settings for Mist Tunneled VLANs
        tunterm_extra_routes:
          additionalProperties:
            $ref: '#/components/schemas/mxedge_tunterm_extra_route'
          description: Extra routes for Mist Tunneled VLAN traffic; property key is a CIDR
          type: object
        tunterm_igmp_snooping_config:
          $ref: '#/components/schemas/mxedge_tunterm_igmp_snooping_config'
          description: IGMP snooping settings for Mist Tunneled VLANs
        tunterm_ip_config:
          $ref: '#/components/schemas/mxedge_tunterm_ip_config'
          description: Tunnel termination IP configuration for the Mist Edge
        tunterm_monitoring:
          $ref: '#/components/schemas/mxedge_tunterm_monitoring'
          description: Monitoring checks for tunnel termination reachability
        tunterm_multicast_config:
          $ref: '#/components/schemas/mxedge_tunterm_multicast_config'
          description: Multicast forwarding settings for tunnel termination
        tunterm_other_ip_configs:
          additionalProperties:
            $ref: '#/components/schemas/mxedge_tunterm_other_ip_config'
          description: IPconfigs by VLAN ID. Property key is the VLAN ID
          type: object
        tunterm_port_config:
          $ref: '#/components/schemas/tunterm_port_config'
          description: Port configuration for tunnel termination traffic
        tunterm_registered:
          description: Whether the tunnel termination service has registered with Mist cloud
          readOnly: true
          type: boolean
        tunterm_switch_config:
          $ref: '#/components/schemas/mxedge_tunterm_switch_configs'
          description: Switch VLAN settings for tunnel termination
        versions:
          $ref: '#/components/schemas/mxedge_versions'
          description: Service version information reported by the Mist Edge
      required:
      - model
      - name
      type: object
    mxedge_tunterm_switch_configs:
      additionalProperties:
        $ref: '#/components/schemas/mxedge_tunterm_switch_config'
      description: Custom VLAN settings for tunnel termination switch ports, if desired; property key is the port identifier
      properties:
        enabled:
          description: Whether custom tunnel termination switch VLAN settings are enabled
          type: boolean
      type: object
    mxedge_tunterm_monitoring:
      description: Tunnel termination monitoring checks for a Mist Edge
      items:
        $ref: '#/components/schemas/tunterm_monitoring'
      type: array
    mxedge_tunterm_ip_config:
      additionalProperties: false
      description: IP configuration for the Mist Tunnel interface
      properties:
        gateway:
          description: IPv4 gateway for the Mist Tunnel interface
          examples:
          - 10.2.1.254
          type: string
        gateway6:
          description: IPv6 gateway for the Mist Tunnel interface
          examples:
          - 2001:1010:1010:1010::1
          type: string
        ip:
          description: Address on the untagged Mist Tunnel interface, in IPv4 format
          examples:
          - 10.2.1.1
          type: string
        ip6:
          description: Address on the Mist Tunnel interface, in IPv6 format
          examples:
          - 2001:1010:1010:1010::2
          type: string
        netmask:
          description: Subnet mask for the Mist Tunnel IPv4 address
          examples:
          - 255.255.255.0
          type: string
        netmask6:
          description: Prefix length for the Mist Tunnel IPv6 address
          examples:
          - /64
          type: string
      required:
      - gateway
      - ip
      - netmask
      type: object
    mxedge_services:
      description: List of services to run, tunterm only for now
      items:
        default: tunterm
        type: string
      type: array
    mxedge_tunterm_igmp_snooping_querier:
      additionalProperties: false
      description: IGMP querier settings for tunnel termination
      properties:
        max_response_time:
          description: Querier's query response interval, in tenths-of-seconds
          examples:
          - 10
          type: integer
        mtu:
          description: The MTU we use (needed when forming large IGMPv3 Reports)
          examples:
          - 1500
          type: integer
        query_interval:
          description: Querier's query interval, in seconds
          examples:
          - 125
          type: integer
        robustness:
          description: IGMP querier robustness variable
          maximum: 7
          minimum: 1
          type: integer
        version:
          description: Querier's maximum protocol version
          examples:
          - 3
          type: integer
      type: object
    org_id:
      description: Unique identifier of a Mist organization
      examples:
      - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
      format: uuid
      readOnly: true
      type: string
    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
    mxedge_events:
      description: Mist Edge event records
      items:
        $ref: '#/components/schemas/mxedge_event'
      minItems: 1
      type: array
      uniqueItems: true
    count_results:
      description: List of count result rows
      items:
        $ref: '#/components/schemas/count_result'
      type: array
      uniqueItems: true
    tunterm_monitoring_protocol:
      description: 'enum: `arp`, `ping`, `tcp`'
      enum:
      - arp
      - ping
      - tcp
      examples:
      - tcp
      minLength: 1
      type: string
    response_mxedge_events_search:
      additionalProperties: false
      description: Search response for Mist Edge event records
      properties:
        end:
          description: Epoch timestamp for the end of the Mist Edge event search window
          examples:
          - 1694708579
          type: integer
        limit:
          description: Maximum number of Mist Edge event records returned in this page
          examples:
          - 10
          type: integer
        next:
          description: Pagination cursor or URL for retrieving the next page of Mist Edge event records
          type: string
        page:
          description: Returned page number for Mist Edge event records
          examples:
          - 3
          type: integer
        results:
          $ref: '#/components/schemas/mxedge_events'
          description: Mist 

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mist/refs/heads/main/openapi/mist-sites-mxedges-api-openapi.yml