Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesStatsMxEdges

listSiteMxEdgesStats

GET
/api/v1/sites/{site_id}/stats/mxedges

List Mist Edge statistics for a site over the requested time range. Use List Org Mist Edge Stats to retrieve Mist Edge statistics across the organization.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

site_id*string
Formatuuid

Query Parameters

start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/stats/mxedges"
[  {    "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"  }]

getSiteMxEdgeStats GET

Get One Site MxEdge Stats

countOrgOspfStats GET

Count OSPF peer statistics for a site, optionally grouped by the `distinct` field and filtered by time range. Use [Count Org OSPF Stats](/api/mist/orgs/orgs-stats/orgs-stats---ospf/countOrgOspfStats) to count OSPF peer statistics across the organization.