upgradeSiteMxEdges
Upgrade Mist Edges in a Site.
See Org Mist Edges for package upgrades
See Org Mist Edges Distro for distro upgrades
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
uuidRequest Body
application/json
Request Body
Request to schedule upgrades for one or more Mist Edges
Per-service downgrade permission settings for this upgrade
Canary phase percentages for phased Mist Edge upgrades
Default
[ 1, 10, 50, 100]Upgrade channel to use for qualified versions. enum: alpha, beta, stable.
"stable"Value in
- "alpha"
- "beta"
- "stable"
Linux distribution codename for an optional distro upgrade, such as bullseye or next to upgrade to the next distro version. Uses highest qualified versions
Failure threshold before we stop the upgrade and mark it as failed
5Mist Edge IDs included in the upgrade request
Upgrade start time in epoch seconds, default is now
Upgrade rollout strategy for the selected Mist Edges. enum: canary, big_bang, serial.
"big_bang"Value in
- "canary"
- "big_bang"
- "serial"
Per-service target versions for the upgrade request
Response Body
curl -X POST "https://example.com/api/v1/sites/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" } }'