Get the status of an Appliance Upgrade.

Published on Oct 27, 2025

1 minute read

Prev Next

Get

/appliances/{id}/upgrade

Get the status of an Appliance Upgrade.

Security

HTTP

Type bearer

Path parameters

string (uuid) Required

ID of the object.

Example12699e27-b584-464a-81ee-5b4784b6d425

Responses

200

Current status of the Appliance Upgrade.

object

Upgrade details.

status

string

Current status of the Appliance Upgrade.

Valid values[ "idle", "started", "downloading", "verifying", "ready", "installing", "success", "failed" ]

details

string

Optional details for the current status.

Examplea reboot is required for the Upgrade to go into effect

401

Token error. Login again.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

404

The requested resource can not be found.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

412

Appliance is not in the right state for this operation.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

500

Unexpected server side error.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

Was this article helpful?