UtilitiesUpgrade

getSiteDeviceUpgrade

GET
/api/v1/sites/{site_id}/devices/upgrade/{upgrade_id}

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

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/upgrade/000000ab-00ab-00ab-00ab-0000000000ab"
{  "canary_phases": [    1,    10,    50,    100  ],  "current_phase": 0,  "enable_p2p": true,  "force": false,  "id": "b910de88-0e0e-43a0-b20e-a43aa8788917",  "max_failure_percentage": 5,  "max_failures": [    5,    5,    5,    5  ],  "p2p_cluster_size": 10,  "p2p_parallelism": 2,  "reboot_at": 1738233315,  "start_time": 1738232698,  "status": "created",  "strategy": "canary",  "target_version": "0.14.29633",  "targets": {    "downloaded": [      "30783a619182"    ],    "total": 2,    "upgraded": [      "a8378280da5e"    ]  },  "upgrade_plan": {    "1": [      "30783a619182"    ],    "2": [      "a8378280da5e"    ]  }}