Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsMxEdges

searchOrgMxEdges

GET
/api/v1/orgs/{org_id}/mxedges/search

Search organization Mist Edge records with filters for hostname, Mist Edge, cluster, site, model, distro, tunnel termination version, and time range.

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

org_id*string
Formatuuid

Query Parameters

hostname?string

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.

mxedge_id?string

Filter results by Mist Edge identifier. Accepts multiple comma-separated values.

mxcluster_id?string

Mist edge cluster id. Accepts multiple comma-separated values.

model?string

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.

distro?string

Debian code name (buster, bullseye)

tunterm_version?string

Filter results by tunnel termination version

site_id?string

Mist edge site id

stats?boolean

Whether to return device stats, default is false

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
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"
sort?string

On which field the list should be sorted, -prefix represents DESC order

Default"timestamp"
search_after?string

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.

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/mxedges/search"
{  "end": 1694708579,  "limit": 10,  "results": [    {      "distro": "buster",      "last_seen": 1695151551.833,      "model": "ME-X5",      "mxedge_id": "00000000-0000-0000-1000-d420b0f0025d",      "org_id": "35d96b1a-1a13-4ba8-90f5-1e78dd2a10c5",      "tunterm_version": "0.1.2813",      "uptime": 5662632    }  ],  "start": 1694622179,  "total": 2}

searchOrgMistEdgeEvents GET

Search Mist Edge event records across the organization with filters for Mist Edge, cluster, event type, service, component, and time range.

unassignOrgMxEdgeFromSite POST

Unassign one or more Mist Edge appliances from their current site while keeping them in the organization.