Upgrading the appliance or OS by using the REST API
You can upgrade the appliance version or apply an operating system upgrade (OSU) package, or a TKU by using the /admin/upgrade endpoint. The equivalent manual procedure is described in Performing-the-upgrade, though you should be sure to read the Upgrading and Preparing-for-upgrade sections first.
To check the upgrade status of the appliance
Check the upgrade status of the appliance by using the GET /admin/upgrade endpoint.
The endpoint returns the following status messages:
- UPGRADE_IDLE
- UPGRADE_PREPARE
- UPGRADE_START
- UPGRADE_ERROR
The 200 OK return code reflects the request's status, not the upgrade progress.
To check which upgrades, TKUs, or OSU packages have been uploaded to the appliance
Get the list of uploaded upgrade archives. Use the GET /admin/upgrade/uploads endpoint.
The endpoint returns JSON formatted data in the following form:
"version": "string",
"revision": "string",
"upgrade_type": "OS upgrade"
}
To remove an unwanted upgrade, TKU, or OSU package
To remove an existing package listed by the GET /admin/upgrade/uploads endpoint, use the DELETE /admin/upgrade/uploads/{filename} endpoint.
The endpoint returns:
- 204 successful delete
- 404 file does not exist
To upload an upgrade or an OSU
Upload an upgrade or OSU file. Use the POST /admin/upgrade/uploads {filename} endpoint.
The endpoint returns:
- 201 uploaded
- 400 incorrect upgrade file
To start the upgrade
Start the upgrade by using the POST /admin/upgrade endpoint.
The endpoint returns:
- 202 Accepted for background processing
- 400 No upgrade archives uploaded
You can periodically check the progress of the upgrade by using the GET /admin/upgrade endpoint.