Skip to content

Retrieve all firmware upgrade campaigns and their execution status

Request

Requires upgrade-manager::read permission.

Security
JWTAuthorizer
curl -i -X GET \
  https://apidocs.trustgrid.io/_mock/upgrade-manager/api/v1/upgrades \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
Array [
clusterUpgradesArray of objects(ClusterUpgrade)
completedAtstring

Upgrade completion time

dryRunboolean

Whether this was a dry-run

excludeTagsobject

Exclude devices with these tags

failoverApprovedboolean

True once a user has approved cluster failovers

includeTagsobject

Include devices with these tags

manualFailoverboolean

Whether to require approval to failover clusters

namestring

Name of upgrade

Example:"Sep27"
nodeUpgradesArray of objects(NodeUpgrade)
offlineTimeoutnumber

Minutes to wait before failing (timing out) a workflow for a node in the offline state

startedAtstring

Upgrade start time

statusstring

Status of upgrade

Enum:"active""planning""complete"
uidstring

Unique ID of upgrade

Example:"2DqxLdknjWxEkGt474d2Cstsa1O"
upgradeTimeoutnumber

Minutes to wait before failing (timing out) a workflow

]
Response
[
  {
    "clusterUpgrades": [ … ],
    "completedAt": "string",
    "dryRun": true,
    "excludeTags": { … },
    "failoverApproved": true,
    "includeTags": { … },
    "manualFailover": true,
    "name": "Sep27",
    "nodeUpgrades": [ … ],
    "offlineTimeout": 0,
    "startedAt": "string",
    "status": "active",
    "uid": "2DqxLdknjWxEkGt474d2Cstsa1O",
    "upgradeTimeout": 0
  }
]