openapi: 3.1.0
info:
  contact:
    email: tmunzer@juniper.net
    name: Thomas Munzer
  description: '> Version: **2604.1.1**

    >

    > Date: **May 13, 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 Stats - MxEdges API
  version: 2604.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: []
- basicAuth: []
- basicAuth: []
  csrfToken: []
tags:
- description: API Calls to retrieve statistics about the Mist Edges at the Site level
  name: Sites Stats - MxEdges
paths:
  /api/v1/sites/{site_id}/stats/mxedges:
    parameters:
    - $ref: '#/components/parameters/site_id'
    get:
      description: Get List of Site MxEdges Stats
      operationId: listSiteMxEdgesStats
      parameters:
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      - $ref: '#/components/parameters/duration'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          $ref: '#/components/responses/MxedgeStatsArray'
        '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: listSiteMxEdgesStats
      tags:
      - Sites Stats - MxEdges
  /api/v1/sites/{site_id}/stats/mxedges/{mxedge_id}:
    parameters:
    - $ref: '#/components/parameters/site_id'
    - $ref: '#/components/parameters/mxedge_id'
    get:
      description: Get One Site MxEdge Stats
      operationId: getSiteMxEdgeStats
      parameters:
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/end'
      - $ref: '#/components/parameters/duration'
      responses:
        '200':
          $ref: '#/components/responses/MxedgeStats'
        '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: getSiteMxEdgeStats
      tags:
      - Sites Stats - MxEdges
components:
  schemas:
    stats_mxedge_service_stat:
      additionalProperties: false
      properties:
        ext_ip:
          description: External IP from ep-terminator’s point of view. valid only for service having its own cloud connection
          type: string
        last_seen:
          description: Timestamp when the last stats is seen (cloud unix time, in second). valid only for service having its own stats or whole system (last among last_seen of all services)
          type: number
        package_state:
          description: Package/service installation state.
          type: string
        package_version:
          description: Package/service installation state.
          type: string
        running_state:
          description: Service running state.
          type: string
        uptime:
          description: Service uptime.
          type: integer
      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
    strings:
      items:
        type: string
      type: array
      uniqueItems: true
    mxedge_mgmt_oob_ip_type:
      default: dhcp
      description: 'enum: `dhcp`, `disabled`, `static`'
      enum:
      - dhcp
      - disabled
      - static
      type: string
    stats_mxedge_tunterm_port_config_downstream_ports:
      examples:
      - - '0'
        - '1'
      items:
        type: string
      type: array
    response_http403:
      additionalProperties: false
      properties:
        detail:
          examples:
          - You do not have permission to perform this action.
          type: string
      type: object
    stats_mxedge_tunterm_port_config_upstream_ports:
      examples:
      - - '0'
        - '1'
      items:
        type: string
      type: array
    stats_mxedge_tunterm_port_config:
      additionalProperties: false
      properties:
        downstream_ports:
          $ref: '#/components/schemas/stats_mxedge_tunterm_port_config_downstream_ports'
        separate_upstream_downstream:
          examples:
          - false
          type: boolean
        upstream_ports:
          $ref: '#/components/schemas/stats_mxedge_tunterm_port_config_upstream_ports'
      type: object
    stats_mxedge_oob_ip_stat:
      additionalProperties: false
      properties:
        dns:
          $ref: '#/components/schemas/strings'
        gateway:
          type: string
        gateway6:
          type: string
        ip:
          type: string
        ip6:
          type: string
        netmask:
          type: string
        netmask6:
          type: string
        type:
          $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type'
        type8:
          $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type6'
      type: object
    stats_mxedge_memory_stat:
      additionalProperties: false
      description: Memory usage
      properties:
        active:
          description: The amount of memory, in kilobytes, that has been used more recently and is usually not reclaimed unless absolutely necessary.
          examples:
          - 394936320
          type: integer
        available:
          description: An estimate of how much memory is available for starting new applications, without swapping.
          examples:
          - 4699291648
          type: integer
        buffers:
          description: The amount, in kilobytes, of temporary storage for raw disk blocks.
          examples:
          - 107646976
          type: integer
        cached:
          description: The amount of physical RAM, in kilobytes, used as cache memory.
          examples:
          - 478060544
          type: integer
        free:
          description: The amount of physical RAM, in kilobytes, left unused by the system
          examples:
          - 4330659840
          type: integer
        inactive:
          description: The amount of memory, in kilobytes, that has been used less recently and is more eligible to be reclaimed for other purposes.
          examples:
          - 211980288
          type: integer
        swap_cached:
          description: The amount of memory, in kilobytes, that has once been moved into swap, then back into the main memory, but still also remains in the swapfile.
          examples:
          - 0
          type: integer
        swap_free:
          description: The total amount of swap free, in kilobytes.
          examples:
          - 1022357504
          type: integer
        swap_total:
          description: The total amount of swap available, in kilobytes.
          examples:
          - 1022357504
          type: integer
        total:
          description: Total amount of usable RAM, in kilobytes, which is physical RAM minus a number of reserved bits and the kernel binary code
          examples:
          - 8365957120
          type: integer
        usage:
          examples:
          - 48
          type: integer
      type: object
    mxedge_oob_ip_config_dns:
      default:
      - 8.8.8.8
      - 8.8.4.4
      - 2001:4860:4860::8888
      - 2001:4860:4860::8844
      description: IPv4 ignored if `type`!=`static`, IPv6 ignored if `type6`!=`static`
      examples:
      - - 8.8.8.8
        - 4.4.4.4
        - 2001:4860:4860::8888
        - 2001:4860:4860::8844
      items:
        type: string
      type: array
    ip_type:
      default: dhcp
      description: 'enum: `dhcp`, `static`'
      enum:
      - dhcp
      - static
      examples:
      - static
      type: string
    stats_mxedge_port_stats:
      additionalProperties:
        $ref: '#/components/schemas/stats_mxedge_port_stat'
      examples:
      - port0:
          full_duplex: true
          mac: 9e294e49091d
          rx_bytes: 646898375700
          rx_errors: 0
          rx_pkts: 8784449574
          speed: 10000
          state: forwarding
          tx_bytes: 647200748038
          tx_errors: 0
          tx_pkts: 8788647466
          up: true
        port1:
          full_duplex: true
          mac: a270fe53437e
          rx_bytes: 647200437652
          rx_errors: 0
          rx_pkts: 8788644886
          speed: 10000
          state: forwarding
          tx_bytes: 646898681650
          tx_errors: 0
          tx_pkts: 8784452092
          up: true
      type: object
    stats_mxedge_lag_stat:
      additionalProperties: false
      properties:
        active_ports:
          $ref: '#/components/schemas/stats_mxedge__active_ports'
      type: object
    tx_pkts:
      description: Amount of packets sent since connection
      examples:
      - 812204062
      format: int64
      readOnly: true
      type:
      - integer
      - 'null'
    stats_mxedge__active_ports:
      description: List of ports active on the LAG defined by the LACP
      items:
        type: string
      type: array
    fwupdate_stat:
      additionalProperties: false
      properties:
        progress:
          examples:
          - 10
          maximum: 100
          minimum: 0
          readOnly: true
          type:
          - integer
          - 'null'
        status:
          $ref: '#/components/schemas/fwupdate_stat_status'
        status_id:
          examples:
          - 5
          readOnly: true
          type:
          - integer
          - 'null'
        timestamp:
          $ref: '#/components/schemas/timestamp'
        will_retry:
          examples:
          - false
          readOnly: true
          type:
          - boolean
          - 'null'
      type: object
    site_id:
      examples:
      - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      format: uuid
      readOnly: true
      type: string
    last_seen:
      description: Last seen timestamp
      examples:
      - 1470417522
      format: double
      readOnly: true
      type:
      - number
      - 'null'
    response_http404:
      additionalProperties: false
      properties:
        id:
          type: string
      type: object
    timestamp:
      description: Epoch (seconds)
      format: double
      readOnly: true
      type: number
    stats_mxedge_tunterm_ip_config:
      additionalProperties: false
      properties:
        gateway:
          examples:
          - 192.168.11.1
          type: string
        ip:
          examples:
          - 192.168.11.91
          type: string
        netmask:
          examples:
          - 255.255.255.0
          type: string
      type: object
    stats_mxedge_cpu_stat_cpus:
      additionalProperties:
        $ref: '#/components/schemas/cpu_stat'
      examples:
      - cpu0:
          idle: 89
          interrupt: 0
          system: 8
          usage: 10
          user: 1
        cpu1:
          idle: 81
          interrupt: 0
          system: 4
          usage: 18
          user: 13
        cpu2:
          idle: 81
          interrupt: 0
          system: 4
          usage: 18
          user: 13
        cpu3:
          idle: 2
          interrupt: 0
          system: 50
          usage: 97
          user: 46
      type: object
    stats_mxedge_ip_stat:
      additionalProperties: false
      description: IP stats
      properties:
        ip:
          examples:
          - 192.168.1.244
          type: string
        ip6:
          examples:
          - fd4e:c615:b27d:5555::45
          type: string
        ips:
          additionalProperties:
            type: string
          description: Property key is the interface name. IPs for each net interface
          examples:
          - ens18: 92.168.1.244/24,fd4e:c615:b27d:5555::45/128,fd4e:c615:b27d:5555:20c:29ff:fe44:af25/64,fe80::104c:ffff:fee0:caf8/64
          type: object
        macs:
          additionalProperties:
            description: MAC addresses for each net interface
            type: string
          description: Property key is the interface name. MAC for each net interface
          examples:
          - ens18: e4434b217044
          type: object
        netmask:
          examples:
          - 255.255.255.0
          type: string
        netmask6:
          examples:
          - /128
          type: string
      type: object
    stats_mxedge:
      additionalProperties: false
      properties:
        cpu_stat:
          $ref: '#/components/schemas/stats_mxedge_cpu_stat'
        created_time:
          $ref: '#/components/schemas/created_time'
        fips_enabled:
          description: Indicate fips configuration on the device
          type: boolean
        for_site:
          examples:
          - false
          type: boolean
        fwupdate:
          $ref: '#/components/schemas/fwupdate_stat'
        id:
          $ref: '#/components/schemas/id'
        idrac_version:
          description: IDRAC version of the mist edge device
          examples:
          - 7.00.00.00
          type: string
        inactive_vlan_strs:
          $ref: '#/components/schemas/stats_mxedge_inactive_vlan_strs'
        ip_stat:
          $ref: '#/components/schemas/stats_mxedge_ip_stat'
        lag_stat:
          $ref: '#/components/schemas/stats_mxedge_lag_stats'
        last_seen:
          $ref: '#/components/schemas/last_seen'
        mac:
          examples:
          - 020000a80cb4
          type: string
        magic:
          type: string
        memory_stat:
          $ref: '#/components/schemas/stats_mxedge_memory_stat'
        model:
          examples:
          - ME-VM
          type: string
        modified_time:
          $ref: '#/components/schemas/modified_time'
        mxagent_registered:
          examples:
          - true
          type: boolean
        mxcluster_id:
          examples:
          - 678bc339-7635-4556-bbc0-e77ad493ef8b
          format: uuid
          type: string
        name:
          description: The name of the tunnel
          examples:
          - me-vm-1
          type: string
        num_tunnels:
          examples:
          - 0
          type: integer
        oob_ip_config:
          $ref: '#/components/schemas/mxedge_oob_ip_config'
        oob_ip_stat:
          $ref: '#/components/schemas/stats_mxedge_oob_ip_stat'
        org_id:
          $ref: '#/components/schemas/org_id'
        port_stat:
          $ref: '#/components/schemas/stats_mxedge_port_stats'
        serial:
          type:
          - string
          - 'null'
        service_stat:
          $ref: '#/components/schemas/stats_mxedge_service_stats'
        services:
          $ref: '#/components/schemas/stats_mxedge_services'
        site_id:
          $ref: '#/components/schemas/site_id'
        status:
          examples:
          - connected
          type: string
        tunterm_ip_config:
          $ref: '#/components/schemas/stats_mxedge_tunterm_ip_config'
        tunterm_port_config:
          $ref: '#/components/schemas/stats_mxedge_tunterm_port_config'
        tunterm_registered:
          examples:
          - true
          type: boolean
        tunterm_stat:
          $ref: '#/components/schemas/stats_mxedge_tunterm_stat'
        uptime:
          examples:
          - 76281
          type: integer
        virtualization_type:
          description: Virtualization environment
          examples:
          - KVM
          type: string
      type: object
    stats_mxedge_lag_stats:
      additionalProperties:
        $ref: '#/components/schemas/stats_mxedge_lag_stat'
      description: Stat for LAG (Link Aggregation Group). Property key is the LAG name
      examples:
      - lacp0:
          active_ports:
          - port0
          - port1
      type: object
    stats_mxedge_services:
      examples:
      - - tunterm
      items:
        type: string
      type: array
    tx_bytes:
      description: Amount of traffic sent since connection
      examples:
      - 211217389682
      format: int64
      readOnly: true
      type:
      - integer
      - 'null'
    response_http400:
      additionalProperties: false
      properties:
        detail:
          examples:
          - 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
          type: string
      type: object
    stats_mxedge_cpu_stat:
      additionalProperties: false
      description: CPU/core stats list
      properties:
        cpus:
          $ref: '#/components/schemas/stats_mxedge_cpu_stat_cpus'
        idle:
          description: Percentage of Idle, Idle/(Idle + Busy) since last sampling
          examples:
          - 62
          type: integer
        interrupt:
          description: Percentage of Interrupt, (Irq + SoftIrq)/(Idle + Busy) since last sampling
          examples:
          - 0
          type: integer
        system:
          description: Percentage of System, System/(Idle + Busy) since last sampling
          examples:
          - 17
          type: integer
        usage:
          description: Percentage of load, Busy/(Idle + Busy) since last sampling
          examples:
          - 37
          type: integer
        user:
          description: Percentage of User, User/(Idle + Busy) since last sampling
          examples:
          - 19
          type: integer
      type: object
    cpu_stat:
      additionalProperties: false
      properties:
        idle:
          description: Percentage of CPU time that is idle
          readOnly: true
          type:
          - number
          - 'null'
        interrupt:
          description: Percentage of CPU time being used by interrupts
          readOnly: true
          type:
          - number
          - 'null'
        load_avg:
          $ref: '#/components/schemas/cpu_stat_load_avg'
        system:
          description: Percentage of CPU time being used by system processes
          readOnly: true
          type:
          - number
          - 'null'
        usage:
          description: CPU usage
          readOnly: true
          type:
          - number
          - 'null'
        user:
          description: Percentage of CPU time being used by user processes
          readOnly: true
          type:
          - number
          - 'null'
      type: object
    mxedge_oob_ip_config:
      additionalProperties: false
      description: IPconfiguration of the Mist Edge out-of_band management interface
      properties:
        autoconf6:
          default: true
          type: boolean
        dhcp6:
          default: true
          type: boolean
        dns:
          $ref: '#/components/schemas/mxedge_oob_ip_config_dns'
        gateway:
          description: If `type`=`static`
          examples:
          - 10.2.1.254
          type: string
        gateway6:
          examples:
          - 2601:1700:43c0:dc0::1
          type: string
        ip:
          description: If `type`=`static`
          examples:
          - 10.2.1.2
          type: string
        ip6:
          examples:
          - 2601:1700:43c0:dc0:20c:29ff:fea7:93bc
          type: string
        netmask:
          description: If `type`=`static`
          examples:
          - 255.255.255.0
          type: string
        netmask6:
          examples:
          - /64
          type: string
        type:
          $ref: '#/components/schemas/ip_type'
        type6:
          $ref: '#/components/schemas/ip_type'
      type: object
    stats_mxedge_port_stat_lldp_stats:
      additionalProperties: false
      properties:
        chassis_id:
          type: string
        mgmt_addr:
          type: string
        port_desc:
          type: string
        port_id:
          type: string
        system_desc:
          type: string
        system_name:
          type: string
      type: object
    stats_mxedge_service_stats:
      additionalProperties:
        $ref: '#/components/schemas/stats_mxedge_service_stat'
      description: Stat for each services
      examples:
      - mxagent:
          ext_ip: 99.0.86.164
          last_seen: 1633721215
          package_state: Installed
          package_version: 3.1.1037-1
          running_state: Running
          uptime: 21240
        tunterm:
          ext_ip: 99.0.86.164
          last_seen: 1633721203
          package_state: Installed
          package_version: 0.1.2449+deb10
          running_state: Running
          uptime: 76261
      type: object
    response_http429:
      additionalProperties: false
      properties:
        detail:
          examples:
          - Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          type: string
      type: object
    fwupdate_stat_status:
      description: 'enum: `inprogress`, `failed`, `upgraded`, `success`, `scheduled`, `error`'
      enum:
      - inprogress
      - failed
      - upgraded
      - success
      - scheduled
      - error
      readOnly: true
      type:
      - string
      - 'null'
    stats_mxedge_port_stat:
      additionalProperties: false
      properties:
        full_duplex:
          type: boolean
        lacp:
          $ref: '#/components/schemas/stats_mxedge_port_stat_lacp'
        lldp_stats:
          $ref: '#/components/schemas/stats_mxedge_port_stat_lldp_stats'
        mac:
          type: string
        rx_bytes:
          $ref: '#/components/schemas/rx_bytes'
        rx_errors:
          type: integer
        rx_pkts:
          $ref: '#/components/schemas/rx_pkts'
        sfp:
          $ref: '#/components/schemas/stats_mxedge_port_stat_sfp'
        speed:
          type: integer
        state:
          type: string
        tx_bytes:
          $ref: '#/components/schemas/tx_bytes'
        tx_errors:
          type: integer
        tx_pkts:
          $ref: '#/components/schemas/tx_pkts'
        up:
          type: boolean
      type: object
    mxedge_mgmt_oob_ip_type6:
      default: autoconf
      description: 'enum: `autoconf`, `dhcp`, `disabled`, `static`'
      enum:
      - autoconf
      - dhcp
      - disabled
      - static
      type: string
    stats_mxedge_port_stat_lacp:
      additionalProperties: false
      properties:
        mux_state:
          type: string
        rx_lacpdu:
          type: integer
        rx_state:
          type: string
        tx_lacpdu:
          type: integer
      type: object
    stats_mxedge_port_stat_sfp:
      additionalProperties: false
      properties:
        codes:
          type: string
        mbps:
          type: integer
        part_no:
          type: string
        serial_no:
          type: string
        type:
          type: integer
        vendor:
          type: string
      type: object
    stats_mxedge_tunterm_stat:
      additionalProperties: false
      properties:
        monitoring_failed:
          examples:
          - false
          type: boolean
      type: object
    stats_mxedges:
      items:
        $ref: '#/components/schemas/stats_mxedge'
      type: array
    stats_mxedge_inactive_vlan_strs:
      additionalProperties: false
      description: Inactive wired/L2TP VLANs. Entries can be individual VLANs or ranges.
      properties:
        l2tp:
          description: Inactive L2TP VLANs. Entries can be individual VLANs or ranges.
          items:
            type: string
          type: array
        wired:
          description: Inactive wired VLANs. Entries can be individual VLANs or ranges.
          examples:
          - - '100'
            - 102-106
          items:
            type: string
          type: array
      type: object
    org_id:
      examples:
      - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
      format: uuid
      readOnly: true
      type: string
    cpu_stat_load_avg:
      description: Load averages for the last 1, 5, and 15 minutes
      items:
        type: number
      type: array
    rx_bytes:
      description: Amount of traffic received since connection
      examples:
      - 8515104416
      format: int64
      readOnly: true
      type:
      - integer
      - 'null'
    rx_pkts:
      description: Amount of packets received since connection
      examples:
      - 57770567
      format: int64
      readOnly: true
      type:
      - integer
      - 'null'
    modified_time:
      description: When the object has been modified for the last time, in epoch
      format: double
      readOnly: true
      type: number
    created_time:
      description: When the object has been created, in epoch
      format: double
      readOnly: true
      type: number
    response_http401:
      additionalProperties: false
      properties:
        detail:
          examples:
          - Authentication credentials were not provided.
          type: string
      type: object
  parameters:
    mxedge_id:
      in: path
      name: mxedge_id
      required: true
      schema:
        examples:
        - 000000ab-00ab-00ab-00ab-0000000000ab
        format: uuid
        type: string
    start:
      description: Start time (epoch timestamp in seconds, or relative string like "-1d", "-1w")
      in: query
      name: start
      schema:
        type: string
    duration:
      description: Duration like 7d, 2w
      in: query
      name: duration
      schema:
        default: 1d
        examples:
        - 10m
        type: string
    end:
      description: End time (epoch timestamp in seconds, or relative string like "-1d", "-2h", "now")
      in: query
      name: end
      schema:
        type: string
    page:
      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
    limit:
      in: query
      name: limit
      schema:
        default: 100
        minimum: 0
        type: integer
  examples:
    MxedgeStatsExample:
      value:
        cpu_stat:
          cpus:
            cpu0:
              idle: 89
              interrupt: 0
              system: 8
              usage: 10
              user: 1
            cpu1:
              idle: 81
              interrupt: 0
              system: 4
              usage: 18
              user: 13
            cpu2:
              idle: 81
              interrupt: 0
              system: 4
              usage: 18
              user: 13
            cpu3:
              idle: 2
              interrupt: 0
              system: 50
              usage: 97
              user: 46
          idle: 62
          interrupt: 0
          system: 17
          usage: 37
          user: 19
        created_time: 1632684398
        for_site: false
        id: 00000000-0000-0000-1000-020000a80cb4
        inactive_vlan_strs:
          wired:
          - '100'
          - 102-106
        ip_stat:
          ip: 192.168.1.244
          ips:
            ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
          macs:
            ens18: e4434b217044
        lag_stat:
          lacp0:
            active_ports:
            - port0
            - port1
        last_seen: 1633721215
        mac: 020000a80cb4
        memory_stat:
          active: 394936320
          available: 4699291648
          buffers: 107646976
          cached: 478060544
          free: 4330659840
          inactive: 211980288
          swap_cached: 0
          swap_free: 1022357504
          swap_total: 1022357504
          total: 8365957120
          usage: 48
        model: ME-VM
        modified_time: 1633643629
        mxagent_registered: true
        mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
        name: me-vm-1
        num_tunnels: 0
        oob_ip_config:
          dns:
          - 8.8.8.8
          - 1.1.1.1
          gateway: 10.0.0.1
          ip: 10.0.0.10
          netmask: 255.255.255.0
          type: static
        org_id: 11b08247-b1ee-4152-9b25-312b323ce480
        port_stat:
          port0:
            full_duplex: true
            mac: 9e294e49091d
            rx_bytes: 646898375700
            rx_errors: 0
            rx_pkts: 8784449574
            speed: 10000
            state: forwarding
            tx_bytes: 647200748038
            tx_errors: 0
            tx_pkts: 8788647466
            up: true
          port1:
            full_duplex: true
            mac: a270fe53437e
            rx_bytes: 647200437652
            rx_errors: 0
            rx_pkts: 8788644886
            speed: 10000
            state: forwarding
            tx_bytes: 646898681650
            tx_errors: 0
            tx_pkts: 8784452092
            up: true
        serial: string
        service_stat:
          mxagent:
            ext_ip: 99.0.86.164
            last_seen: 1633721215
            package_state: Installed
            package_version: 3.1.1037-1
            running_state: Running
            uptime: 21240
          tunterm:
            ext_ip: 99.0.86.164
            last_seen: 1633721203
            package_state: Installed
            package_version: 0.1.2449+deb10
            running_state: Running
            uptime: 76261
        services:
        - tunterm
        site_id: 00000000-0000-0000-0000-000000000000
        status: connected
        tunterm_ip_config:
          gateway: 192.168.11.1
          ip: 192.168.11.91
          netmask: 255.255.255.0
        tunterm_port_config:
          downstream_ports:
          - '0'
          - '1'
          separate_upstream_downstream: false
          upstream_ports:
          - '0'
          - '1'
        tunterm_registered: true
        tunterm_stat:
          monitoring_failed: false
        uptime: 76281
        virtualization_type: KVM
    HTTP400Example:
      value:
        detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
    HTTP403Example:
      value:
        detail: You do not have permission to perform this action.
    HTTP429Example:
      value:
        detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
    HTTP401Example:
      value:
        detail: Authentication credentials were not provided.
    MxedgeStatsArrayExample:
      value:
      - cpu_stat:
          cpus:
            cpu0:
              idle: 89
              interrupt: 0
              system: 8
              usage: 10
              user: 1
            cpu1:
              idle: 81
              interrupt: 0
              system: 4
              usage: 18
              user: 13
            cpu2:
              idle: 81
              interrupt: 0
              system: 4
              usage: 18
              user: 13
            cpu3:
              idle: 2
              interrupt: 0
              system: 50
              usage: 97
              user: 46
          idle: 62
          interrupt: 0
          system: 17
          usage: 37
          user: 19
        created_time: 1632684398
        for_site: false
        id: 00000000-0000-0000-1000-020000a80cb4
        ip_stat:
          ip: 192.168.1.244
          ips:
            ens18: 192.168.1.244/24,fe80::104c:ffff:fee0:caf8/64
          macs:
            ens18: e4434b217044
        lag_stat:
          lacp0:
            active_ports:
            - port0
            - port1
        last_seen: 1633721215
        mac: 020000a80cb4
        memory_stat:
          active: 394936320
          available: 4699291648
          buffers: 107646976
          cached: 478060544
          free: 4330659840
          inactive: 211980288
          swap_cached: 0
          swap_free: 1022357504
          swap_total: 1022357504
          total: 8365957120
          usage: 48
        model: ME-VM
        modified_time: 1633643629
        mxagent_registered: true
        mxcluster_id: 678bc339-7635-4556-bbc0-e77ad493ef8b
        name: me-vm-1
        num_tunnels: 0
        oob_ip_config:
          dns:
          - 8.8.8.8
          - 1.1.1.1
          gateway: 10.0.0.1
          ip: 10.0.0.10
          netmask: 255.255.255.0
          type: static
        org_id: 11b08247-b1ee-4152-9b25-312b323ce480
        port_stat:
          port0:
            full_duplex: true
            mac: 9e294e49091d
            rx_bytes: 646898375700
            rx_errors: 0
            rx_pkts: 8784449574
            speed: 10000
            state: forwarding
            tx_bytes: 647200748038
            tx_errors: 0
            tx_pkts: 8788647466
            up: true
          port1:
            full_duplex: true
            mac: a270fe53437e
            rx_bytes: 647200437652
            rx_errors: 0
            rx_pkts: 8788644886
            speed: 10000
            state: forwarding
            tx_bytes: 646898681650
            tx_errors: 0
            tx_pkts: 8784452092
            up: true
        serial: string
        service_stat:
          mxagent:
            ext_ip: 99.0.86.164
            last_seen: 1633721215
            package_state: Installed
            package_version: 3.1.1037-1
            running_state: Running
            uptime: 21240
          tunterm:
            ext_ip: 99.0.86.164
            last_seen: 1633721203
            package_state: Installed
            package_version: 0.1.2449+deb10
            running_state: Running
            uptime: 76261
        services:
        - tunterm
        site_id: 00000000-0000-0000-0000-000000000000
        status: connected
        tunterm_ip_config:
          gateway: 192.168.11.1
          ip: 192.168.11.91
          netmask: 255.255.255.0
        tunterm_port_config:
          downstream_ports:
          - '0'
          - '1'
          separate_upstream_downstream: false
          upstream_ports:
          - '0'
          - '1'
        tunterm_registered: true
        tunterm_stat:
          monitoring_failed: false
        uptime: 76281
        virtualization_type: KVM
  responses:
    HTTP404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/response_http404'
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/response_http404'
      description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
    HTTP429:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP429Example'
          schema:
            $ref: '#/components/schemas/response_http429'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP429Example'
          schema:
            $ref: '#/components/schemas/response_http429'
      description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
    HTTP403:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP403Example'
          schema:
            $ref: '#/components/schemas/response_http403'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP403Example'
          schema:
            $ref: '#/components/schemas/response_http403'
      description: Permission Denied
    MxedgeStats:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/MxedgeStatsExample'
          schema:
            $ref: '#/components/schemas/stats_mxedge'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/MxedgeStatsExample'
          schema:
            $ref: '#/components/schemas/stats_mxedge'
      description: MxEdge Stats
    HTTP400:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP400Example'
          schema:
            $ref: '#/components/schemas/response_http400'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP400Example'
          schema:
            $ref: '#/components/schemas/response_http400'
      description: Bad Syntax
    HTTP401:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP401Example'
          schema:
            $ref: '#/components/schemas/response_http401'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP401Example'
          schema:
            $ref: '#/components/schemas/response_http401'
      description: Unauthorized
    MxedgeStatsArray:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/MxedgeStatsArrayExample'
          schema:
            $ref: '#/components/schemas/stats_mxedges'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/MxedgeStatsArrayExample'
          schema:
            $ref: '#/components/schemas/stats_mxedges'
      description: List of MxEdge Stats
  securitySchemes:
    apiToken:
      description: "Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equal or less privileges.\n\n**Format**:\n  API Token value format is `Token {apitoken}`\n\n**Notes**:\n* an API token generated for a specific admin has the same privilege as the user\n* an API token will be automatically removed if not used for > 90 days\n* SSO admins cannot generate these API tokens. Refer Org level API tokens which can have privileges of a specific Org/Site for more information."
      in: header
      name: Authorization
      type: apiKey
    basicAuth:
      description: While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
      scheme: basic
      type: http
    csrfToken:
      description: "This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-site_request_forgery), all the POST / PUT / DELETE APIs needs to have CSRF token in the AJAX Request header when using Login/Password authentication (with or without MFA)\n\n\nThe CSRF Token is sent back by Mist in the Cookies from the Login Response API Call:\n`cookies[csrftoken]` \n\nThe CSRF Token must be added in the HTTP Request Headers:\n```\nX-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx\n```"
      in: header
      name: X-CSRFToken
      type: apiKey