Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsMxEdges

controlOrgMxEdgeServices

POST
/api/v1/orgs/{org_id}/mxedges/{mxedge_id}/services/{name}/{action}

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

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
mxedge_id*string
Formatuuid
name*string

enum: mxagent, mxdas, mxnacedge, mxocproxy, radsecproxy, tunterm

Value in

  • "mxagent"
  • "mxdas"
  • "mxnacedge"
  • "mxocproxy"
  • "radsecproxy"
  • "tunterm"
action*string

Restart or start or stop

Value in

  • "restart"
  • "start"
  • "stop"

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/mxedges/000000ab-00ab-00ab-00ab-0000000000ab/services/mxagent/restart"
Empty

claimOrgMxEdge POST

Claim one or more Mist Edge appliances into the organization using their claim codes.

countOrgMxEdges GET

Count organization Mist Edge records, optionally grouped by `distinct` and filtered by Mist Edge, cluster, site, model, distro, tunnel termination version, and time range.