Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
UtilitiesUpgrade

upgradeOrgSsrs

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

Create an SSR firmware upgrade job for selected devices, with firmware version or channel, rollout strategy, and optional download or reboot timing.

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 to upgrade multiple SSR devices

channel?ssr_upgrade_channel

Firmware release channel to use for the SSR upgrade. enum: alpha, beta, stable.

Default"stable"

Value in

  • "alpha"
  • "beta"
  • "stable"
device_ids*array<>

List of 128T device IDs to upgrade; currently only one 128T device is allowed

force?boolean

When true, forces the upgrade even when the requested version matches the currently running version; default is false

Defaultfalse
reboot_at?integer

Reboot start time in epoch seconds, default is start_time, -1 disables reboot

start_time?integer

128T firmware download start time in epoch seconds, default is now, -1 disables download

strategy?ssr_upgrade_strategy

Upgrade rollout strategy for the targeted SSR devices. enum: big_bang, serial.

Default"big_bang"

Value in

  • "big_bang"
  • "serial"
version?string

128T firmware version to upgrade (e.g. 5.3.0-93)

Length1 <= length

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/ssr/upgrade" \  -H "Content-Type: application/json" \  -d '{    "channel": "stable",    "device_ids": [      "00000000-0000-0000-1000-5c5b3500001f",      "00000000-0000-0000-1000-5c5b35000020"    ],    "strategy": "big_bang",    "version": "5.3.0-93"  }'
{  "channel": "stable",  "counts": {    "failed": 0,    "queued": 1,    "success": 0,    "upgrading": 1  },  "device_type": "gateway",  "id": "ceef2c8a-e2e6-447a-8b27-cb4f3ec1adae",  "status": "upgrading",  "strategy": "serial",  "versions": {}}

listOrgSsrUpgrades GET

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

listSiteAvailableDeviceVersions GET

List firmware versions available for devices in a site, optionally filtered by device type and model. Use [List Org Available Device Versions](/api/mist/utilities/utilities-upgrade/listOrgAvailableDeviceVersions) to retrieve available device versions across the organization.