getSiteAllUpgrades
GET https://{{host}}/api/v1/sites/:site_id/devices/upgrade
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 |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
status | null | created/downloading/downloaded/upgrading/completed/cancelled/failed |
RESPONSES
status: OK
[{"id":"e110e3ef-5ce9-4c7c-a056-714f154f354f","target_version":"apfw-0.7.20216-gilly-d4fc","status":"downloading","strategy":"big_bang","enable_p2p":false,"force":true,"start_time":1624499588,"reboot_at":1624499588,"max_failure_percentage":5,"counts":{"download_requested":1,"downloaded":2,"total":3}},{"id":"57bf9d30-bd30-48e6-bb76-43c2efa375dc","target_version":"apfw-0.7.20216-gilly-d4fc","status":"completed","strategy":"serial","enable_p2p":false,"force":false,"start_time":1624499588,"reboot_at":1624499588,"max_failure_percentage":5,"counts":{"upgraded":2,"failed":1,"total":3}}]