UtilitiesUpgrade

getOrgDeviceUpgrade

GET
/api/v1/orgs/{org_id}/devices/upgrade/{upgrade_id}

Retrieve details for an organization-level device upgrade job, including per-site upgrade status and device targets.

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
upgrade_id*string
Formatuuid

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/devices/upgrade/000000ab-00ab-00ab-00ab-0000000000ab"
{  "enable_p2p": true,  "force": true,  "id": "31223085-405d-4b64-8aea-9c5b98098b4b",  "strategy": "big_bang",  "target_version": "0.14.29411",  "upgrades": [    {      "site_id": "1bbe6e79-2583-403c-be1a-9881b4691ab6",      "upgrade": {        "id": "473f6eca-6276-4993-bfeb-53cbbbba6f18",        "start_time": 1717658765,        "status": "upgrading",        "targets": {          "download_requested": [            "5c5b3550bd2e"          ],          "downloaded": [            "003e7316ff9e"          ],          "total": 4,          "upgraded": [            "5c5b3550bd2e",            "003e7316ff9e"          ]        }      }    }  ]}