UtilitiesUpgrade

listSiteDeviceUpgrades

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

List device upgrade operations for a site, optionally filtered by upgrade status. Use List Org Device Upgrades to retrieve device upgrade operations across the organization.

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

Query Parameters

status?string

Filter results by status. enum: cancelled, completed, created, downloaded, downloading, failed, queued, upgrading

Value in

  • "cancelled"
  • "completed"
  • "created"
  • "downloaded"
  • "downloading"
  • "failed"
  • "queued"
  • "upgrading"

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/upgrade"
[  {    "counts": {      "download_requested": 0,      "downloaded": 0,      "failed": 0,      "reboot_in_progress": 0,      "rebooted": 0,      "skipped": 0,      "total": 0    },    "enable_p2p": true,    "force": true,    "id": "472f6eca-6276-4993-bfeb-53cbbbba6f28",    "start_time": 0,    "status": "created",    "strategy": "big_bang",    "target_version": "string"  }]