getSiteUpgrade
GET https://{{host}}/api/v1/sites/:site_id/devices/upgrade/:upgrade_id
Response Parameters
| Name | Type | Description |
|---|---|---|
id | uuid | unique id for the upgrade |
target_version | string | version to upgrade to |
status | string | status upgrade is in (created/downloading/downloaded/upgrading/completed/cancelled/failed) |
strategy | string | upgrade strategy |
enable_p2p | bool | whether to allow local AP-to-AP FW upgrade, default False |
p2p_cluster_size | int | size to split the devices for p2p, default 10 |
force | bool | whether to force upgrade when requested version is same as running version |
start_time | int | firmware download start time in epoch |
reboot_at | int | reboot start time in epoch |
max_failure_percentage | int | percentage of failures allowed |
max_failures | array of ints | number of failures allowed within a canary phase or serial rollout |
current_phase | int | current canary/rrm phase in progress |
upgrade_plan | object | a dictionary of canary/rrm phase number to devices part of that phase |
download_time | string | time taken to download firmware on all devices |
upgrade_time | string | time taken to upgrade firmware all devices |
counts.total | int | count of devices part of this upgrade |
counts.scheduled | int | count of devices which cloud has scheduled an upgrade for |
counts.download_requested | int | count of devices which cloud has requested to download firmware |
counts.downloaded | int | count of devices which have the firmware downloaded |
counts.reboot_in_progress | int | count of devices which are rebooting |
counts.rebooted | int | count of devices which have rebooted successfully |
counts.upgraded | int | count of devices which have upgraded successfully |
counts.skipped | int | count of devices which skipped upgrade since requested version was same as running version. Use force to always upgrade |
counts.failed | int | count of devices which have failed to upgrade |
RESPONSES
status: OK
{"id":"b040efc5-6bb0-423e-8f7d-66d80176aa71","target_version":"apfw-0.11.25907-kedge-9019","status":"completed","strategy":"big_bang","enable_p2p":true,"force":true,"start_time":1648752756,"reboot_at":0,"targets":{"scheduled":[],"download_requested":[],"downloaded":[],"reboot_in_progress":[],"rebooted":[],"upgraded":["5c5b354e35f7","5c5b353e537a"],"skipped":[],"failed":["5c5b353e190a"],"total":3}}