Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
UtilitiesUpgrade

upgradeOrgMxEdges

POST
/api/v1/orgs/{org_id}/mxedges/upgrade

Schedule a Mist Edge upgrade for selected Mist Edges, using service target versions or an optional Linux distro upgrade with rollout strategy and canary settings.

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

Request Body

application/json

Request Body

Request to schedule upgrades for one or more Mist Edges

allow_downgrades?

Per-service downgrade permission settings for this upgrade

canary_phases?array<integer>

Canary phase percentages for phased Mist Edge upgrades

Default

[  1,  10,  50,  100]
channel?mxedge_upgrade_channel

Upgrade channel to use for qualified versions. enum: alpha, beta, stable.

Default"stable"

Value in

  • "alpha"
  • "beta"
  • "stable"
distro?string

Linux distribution codename for an optional distro upgrade, such as bullseye or next to upgrade to the next distro version. Uses highest qualified versions

max_failure_percentage?integer

Failure threshold before we stop the upgrade and mark it as failed

Default5
mxedge_ids*array<>

Mist Edge IDs included in the upgrade request

start_time?integer

Upgrade start time in epoch seconds, default is now

strategy?mxedge_upgrade_strategy

Upgrade rollout strategy for the selected Mist Edges. enum: canary, big_bang, serial.

Default"big_bang"

Value in

  • "canary"
  • "big_bang"
  • "serial"
versions?

Per-service target versions for the upgrade request

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/mxedges/upgrade" \  -H "Content-Type: application/json" \  -d '{    "allow_downgrades": {      "mxagent": false,      "tunterm": true    },    "canary_phases": [      5,      25,      50,      100    ],    "channel": "stable",    "max_failure_percentage": 5,    "max_failures": [      1,      1,      5,      5    ],    "mxedge_ids": [      "387804a7-3474-85ce-15a2-f9a9684c9c90"    ],    "start_time": 1624399840,    "strategy": "serial",    "versions": {      "mxagent": "latest",      "radsecproxy": "<version>",      "tunterm": "default"    }  }'
Empty

listOrgMxEdgeUpgrades GET

List Mist Edge upgrade requests for the organization, including status, rollout strategy, target versions, and per-status target counts.

listOrgSsrUpgrades GET

List SSR firmware upgrade jobs for the organization, including status, rollout strategy, target versions, release channel, and device counts.