Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
UtilitiesUpgrade

upgradeDevice

POST
/api/v1/sites/{site_id}/devices/{device_id}/upgrade

Device Upgrade

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

site_id*string
Formatuuid
device_id*string
Formatuuid

Request Body

application/json

Device firmware upgrade request options

reboot?boolean

For Switches and Gateways only (APs are automatically rebooted). Reboot device immediately after upgrade is completed

Defaultfalse
reboot_at?integer

For Switches and Gateways only and if reboot==true. Reboot start time in epoch seconds, default is start_time

snapshot?boolean

For Junos devices only. Perform recovery snapshot after device is rebooted

Defaultfalse
start_time?integer

Firmware download start time in epoch

version*string

Specific version / stable, default is to use the latest

Default"stable"

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/upgrade" \  -H "Content-Type: application/json" \  -d '{    "version": "3.1.5"  }'
{  "status": "inprogress",  "timestamp": 1428949501}

upgradeSiteMxEdges POST

Upgrade Mist Edges in a Site. See [Org Mist Edges](/api/mist/utilities/utilities-upgrade/upgradeOrgMxEdges) for package upgrades See [Org Mist Edges Distro](/api/mist/utilities/utilities-upgrade/upgradeOrgMxEdges) for distro upgrades

upgradeOrgJsiDevice POST

Start a software upgrade for a JSI-connected device identified by MAC address using the requested target version.