Get Sspi Upgrade Status
Retrieves real-time status and detailed progress information for the upgrade operation. This endpoint provides visibility into upgrade execution with granular reporting for each upgrade phase.
Poll this endpoint at regular intervals while upgrade is in progress.
Upon completion, verify that overall_status is SUCCESS. If status is FAILED, examine the upgrade_steps array for the failed step to identify root cause or connect with VMware Support for assistance.
If no upgrade has been initiated, the response indicates NOT_STARTED status.
Note: During the appliance VM upgrade phase, the system will reboot and this endpoint may be temporarily unavailable. Resume polling after the system comes back online.
Upgrade status retrieved successfully. The response contains the overall upgrade status, current and target versions, and detailed progress information for each upgrade step.
{
"current_version": "string",
"target_version": "string",
"overall_status": "string",
"upgrade_steps": [
{
"_create_time": 0,
"_last_modified_time": 0,
"id": "string",
"display_name": "string",
"description": "string",
"activity_status_msg": "string",
"_completed_at": 0,
"status": "string",
"messages": [
{
"severity": "string",
"message": "string"
}
],
"last_run_time": 0
}
],
"pre_checks_status": {
"overall_status": "string",
"pre_checks": [
{
"_create_time": 0,
"_last_modified_time": 0,
"id": "string",
"display_name": "string",
"description": "string",
"activity_status_msg": "string",
"_completed_at": 0,
"status": "string",
"messages": [
{
"severity": "string",
"message": "string"
}
],
"last_run_time": 0
}
]
}
}Current version of the appliance before upgrade. This field indicates the version from which the system is being upgraded.
This field is always present and populated, even when upgrade status is NOT_STARTED, indicating the currently running system version.
Target version of the appliance after upgrade completion. This field indicates the version to which the system will be upgraded.
This field is always present and populated, indicating the version that will be installed when the upgrade completes successfully.
Execution state of an operation.
Ordered sequence of all upgrade steps with their individual execution status and messages. Each entry combines the step definition with real-time execution state. Steps are listed in the order they are executed.
Monitor individual steps to track upgrade progress, identify which step is currently executing, determine which step failed if upgrade fails, and review progress messages for long-running steps.
Aggregated status of all pre-checks validations, providing a complete view of system readiness for appliance upgrade along with detailed execution status for each individual pre-check.
Bad Request
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unauthorized
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Forbidden
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Failed
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Required
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Too Many Requests
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unexpected error occurred while retrieving upgrade status. Consult the error response details and system logs for diagnostic information.
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -H 'Authorization: <value>' https://{api_host}/sspi/upgrade/status