Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsMxEdges

countOrgMxEdges

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

Count organization Mist Edge records, optionally grouped by distinct and filtered by 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

distinct?string

Field used to group this count response. enum: distro, model, mxcluster_id, site_id, tunterm_version

Default"model"

Value in

  • "distro"
  • "model"
  • "mxcluster_id"
  • "site_id"
  • "tunterm_version"
mxedge_id?string

Filter results by Mist Edge identifier

site_id?string

Mist edge site id

mxcluster_id?string

Mist edge cluster id

model?string

Filter results by device model

distro?string

Debian code name (buster, bullseye)

tunterm_version?string

Filter results by tunnel termination version

sort?string

Field used to sort results

stats?boolean

Whether to return device stats, default is false

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

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/mxedges/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}

controlOrgMxEdgeServices POST

Start, stop, or restart a named Mist Edge service such as `tunterm`, `mxagent`, or `radsecproxy`.

countOrgSiteMxEdgeEvents GET

Count Mist Edge event records across the organization, optionally grouped by `distinct` and filtered by Mist Edge, cluster, event type, service, and time range.