Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
UtilitiesUpgrade

getOrgMxEdgeUpgrade

GET
/api/v1/orgs/{org_id}/mxedges/upgrade/{upgrade_id}

Retrieve status, rollout strategy, target versions, and target counts for a specific Mist Edge upgrade request.

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
upgrade_id*string
Formatuuid

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/mxedges/upgrade/000000ab-00ab-00ab-00ab-0000000000ab"
{  "channel": "string",  "counts": {    "failed": 0,    "queued": 0,    "success": 0,    "upgrading": 0  },  "id": "53f10664-3ce8-4c27-b382-0ef66432349f",  "status": "string",  "strategy": "string",  "versions": {}}

getOrgDeviceUpgrade GET

Retrieve details for an organization-level device upgrade job, including per-site upgrade status and device targets.

updateOrgMxEdgeUpgrade PUT

Update a queued Mist Edge upgrade request, such as target versions, rollout strategy, start time, or target Mist Edge IDs. Only upgrades in `queued` state can be updated.