Start Upgrade
Starts the upgrade of the HCX Manager appliance to the target version, using a previously uploaded and
validated upgrade bundle. The upgrade proceeds asynchronously. Poll /api/admin/v2/upgrade/status to
track progress.
Show optional properties
{
"targetVersion": "9.0.0.00000"
}{
"targetVersion": "9.0.0.00000",
"upgradePolicy": {
"skipVmSnapshot": false,
"skipUpgradeValidation": false,
"skipConfigBackup": false
}
}Version of the uploaded upgrade bundle to upgrade to
Options that control optional steps performed during the upgrade
Upgrade request accepted
Invalid request, e.g. target version not eligible for upgrade from the current version
{
"errorCode": "UPGRADE_IN_PROGRESS",
"message": "Another upgrade process for HCX Manager is already in progress.",
"remediation": "Wait for the current upgrade to complete before retrying."
}The error code
The localized error message
Remediation for the error
Not found - no validated upgrade bundle available for the target version
{
"errorCode": "UPGRADE_IN_PROGRESS",
"message": "Another upgrade process for HCX Manager is already in progress.",
"remediation": "Wait for the current upgrade to complete before retrying."
}The error code
The localized error message
Remediation for the error
Conflict - an upload or upgrade is already in progress
"UpgradeErrorResponse Object"The error code
The localized error message
Remediation for the error
Internal server error
"UpgradeErrorResponse Object"The error code
The localized error message
Remediation for the error
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"targetVersion":"string"}' https://{api_host}/api/admin/v2/upgrade/start