UtilitiesUpgrade
upgradeSsr
Upgrade Site SSR device
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
Format
uuiddevice_id*string
Format
uuidRequest Body
application/json
Request to upgrade a single SSR device
channel?ssr_upgrade_channel
Firmware release channel to use for the SSR upgrade. enum: alpha, beta, stable.
Default
"stable"Value in
- "alpha"
- "beta"
- "stable"
force?boolean
When true, forces the upgrade even when the requested version matches the currently running version; default is false
Default
falsereboot_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
version*string
128T firmware version to upgrade (e.g. 5.3.0-93)
Length
1 <= lengthDefault
"stable"Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/ssr/000000ab-00ab-00ab-00ab-0000000000ab/upgrade" \ -H "Content-Type: application/json" \ -d '{ "channel": "stable", "version": "5.3.1-170-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": {}}