Get Version Summary

Retrieve version summary

Retrieves the current versions of appliance components and the target upgrade version. The current version reflects the actually installed version on the appliance. After a successful upgrade (e.g., 5.1.1 to 5.2.0), the current version updates to the new version (5.2.0).

The response includes:

Current appliance version
Current Upgrade Manager version
Target appliance version (set when upgrade is initiated)

Request

URI

GET

https://{api_host}/https://{api_host}:{port}/lh-appliance/upgrade/version-summary

COPY

Authentication

This operation uses the following authentication methods.

enterprise_admin

auditor

Responses

200

Version summary retrieved successfully. The response contains current versions and target version if applicable.

Returns VersionSummary of type(s) application/json

{
    "current": {
        "sspi_version": "string",
        "upgrade_manager_version": "string"
    },
    "target": {
        "sspi_version": "string"
    }
}

object

current

Required

Currently installed versions of appliance components.

object

target

Optional

Target version for upgrade. This field is null if no upgrade has been initiated. Once an upgrade is initiated, this field contains the target appliance version.

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 version summary. 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/version-summary

On This Page

Description

Request

Authentication

Response

200 Response Body

Errors

Sspi Upgrade Operations

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