Get Upgrade Manager Status

Get Upgrade Manager Status
Retrieve Upgrade Manager upgrade status and progress

Retrieves real-time status and detailed progress information for the Upgrade Manager upgrade operation. This endpoint provides visibility into upgrade execution with granular reporting for each upgrade step and an overall progress percentage.

Poll this endpoint at regular intervals while upgrade is in progress.

Upon completion, verify that overall_status is SUCCESS before proceeding with appliance upgrade (POST /upgrade). If status is FAILED, examine the upgrade_steps array for the failed step to identify root cause.

If no Upgrade Manager upgrade has been initiated, the response indicates NOT_STARTED status with progress_percentage of 0.

Request
URI
GET
https://{api_host}/https://{api_host}:{port}/lh-appliance/upgrade/manager/status
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Upgrade Manager status retrieved successfully. The response contains the overall upgrade status, progress percentage, and detailed progress information for each upgrade step.

Returns UpgradeManagerStatus of type(s) application/json 
{
    "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
        }
    ],
    "progress_percentage": 0,
    "current_step": "string"
}
string
overall_status
Required

Execution state of an operation.

Enumeration: NOT_STARTED, IN_PROGRESS, SUCCESS, SUCCESS_WITH_WARNINGS, FAILED, SKIPPED, PAUSED
array of upgrade_steps
upgrade_steps
Required

Ordered sequence of all Upgrade Manager upgrade steps with their individual execution status and messages. Steps are listed in the order they are executed.

integer As int32 As int32
progress_percentage
Required
Constraints: minimum: 0 maximum: 100

Overall progress of the Upgrade Manager upgrade as a percentage (0-100). This is calculated based on the number of completed steps.

string
current_step
Optional

Name of the upgrade step currently being executed. This field is only present when the upgrade is in progress (overall_status is IN_PROGRESS).


400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


default

Unexpected error occurred while retrieving upgrade status. Consult the error response details and system logs for diagnostic information.

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/https://{api_host}:{port}/lh-appliance/upgrade/manager/status
On This Page
Sspi Upgrade Operations
GET
Get Version Summary
GET
Get Upgrade Packages
GET
Get Sspi Upgrade History
GET
List Upgrade Manager Steps
POST
Trigger Upgrade Manager Upgrade
GET
Get Upgrade Manager Status
GET
List Sspi Upgrade Steps
POST
Trigger Sspi Upgrade
GET
Get Sspi Upgrade Status