Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesMxEdges

listSiteMxEdges

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

List Mist Edges for a site. Use List Org Mist Edges to retrieve Mist Edges 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

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/mxedges"
[  {    "cpu_stat": {      "cpus": {        "cpu0": {          "idle": 79,          "interrupt": 0,          "system": 4,          "usage": 20,          "user": 16        },        "cpu1": {          "idle": 93,          "interrupt": 0,          "system": 4,          "usage": 6,          "user": 1        }      },      "idle": 87,      "interrupt": 0,      "system": 5,      "usage": 12,      "user": 7    },    "ext_ip": "116.187.144.16",    "id": "387804a7-3474-85ce-15a2-f9a9684c9c90",    "ip_stat": {      "ip": "172.16.5.3",      "ips": {        "ens192": "172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64"      }    },    "lag_stat": {      "lag0": {        "active_ports": [          "0",          "1"        ]      }    },    "last_seen": 1547437078,    "magic": "ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD",    "memory_stats": {      "active": 1061085184,      "available": 4124860416,      "buffers": 789495808,      "cached": 718016512,      "free": 2818838528,      "inactive": 458158080,      "swap_cached": 0,      "swap_free": 8161062912,      "swap_total": 8161062912,      "total": 7947616256,      "usage": 65    },    "model": "ME-S2019",    "mxagent_registered": false,    "mxcluster_id": "572586b7-f97b-a22b-526c-8b97a3f609c4",    "name": "Guest",    "num_tunnels": 31,    "port_stat": {      "eth0": {        "full_duplex": true,        "lldp_stats": {          "mgmt_addr": "122.16.3.11",          "port_desc": "GigabitEthernet4/0/16",          "port_id": "\u0005Gi4/0/16",          "system_desc": "Cisco IOS Software",          "system_name": "ME-DC2-DIS-SW"        },        "rx_bytes": 2056,        "rx_errors": 0,        "rx_pkts": 670,        "speed": 1000,        "tx_bytes": 2056,        "tx_pkts": 670,        "up": true      },      "eth1": {        "up": false      },      "module": {        "up": false      }    },    "status": "connected",    "tunterm_registered": false,    "tunterm_stat": {      "monitoring_failed": false    },    "uptime": 884221,    "version": "0.1.2",    "virtualization_type": "VirtualizationVMware"  }]

updateSiteMxEdge PUT

Update Site Mist Edge settings

searchSiteMistEdgeEvents GET

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](/api/mist/orgs/orgs-mxedges/searchOrgMistEdgeEvents) to search Mist Edge events across the organization.