Trigger Upgrade Manager Upgrade

Execute Upgrade Manager upgrade operation

Upgrades the Upgrade Manager service itself to the target version specified in the request body. This is distinct from POST /upgrade which upgrades the entire appliance - this endpoint only upgrades the upgrade orchestration tool.

The Upgrade Manager must be at the target version before it can orchestrate the main appliance upgrade (POST /upgrade).

Prerequisites:

A valid upgrade package must be uploaded to the system
No other upgrade operation should be in progress

The operation executes asynchronously and returns immediately with a status URL. Use GET /upgrade/manager/status to monitor upgrade progress.

Only one Upgrade Manager upgrade operation can execute at a time (returns 409 if upgrade is in progress or already completed).

If the upgrade fails, this endpoint can be called again to retry the upgrade.

Request

URI

POST

https://{api_host}/https://{api_host}:{port}/lh-appliance/upgrade/manager

COPY

Query Parameters

array

action

Required

Action to perform on Upgrade Manager. Must be set to 'upgrade' to trigger upgrade execution.

Enumeration: START

Request Body

UpgradeManagerRequest of type(s) application/json

Required

{
    "target_version": "string"
}

string

target_version

Required

The target appliance version to upgrade to (e.g., "5.1.0.0.0.29219600"). This must match one of the versions available in the upgrade packages.

Authentication

This operation uses the following authentication methods.

enterprise_admin

Responses

202

Upgrade Manager upgrade operation has been accepted and initiated. The upgrade is executing asynchronously. Use the status_url in the response to monitor upgrade progress and track completion.

Returns AsyncApiResponse of type(s) application/json

{
    "id": "b8f47985-22ed-3193-bca8-11c7b025cbce",
    "status_url": "/segmentation/default-ids-profiles/b8f47985-22ed-3193-bca8-11c7b025cbce/status"
}

string

Optional

UUID identifier of the response.

string

status_url

Optional

The URL to check the status of the operation.

400

Bad request. The system does not meet prerequisites for Upgrade Manager upgrade execution, or the request body is invalid.

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.

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.

409

Conflict. An Upgrade Manager upgrade operation is already in progress or already completed successfully. If an upgrade is in progress, monitor it using GET /upgrade/manager/status. If already completed, proceed to appliance upgrade.

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.

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 initiating Upgrade Manager upgrade. Consult the error response details and system logs for diagnostic information.

Returns Error of type(s) application/json

"Error Object"

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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"target_version":"string"}' https://{api_host}/https://{api_host}:{port}/lh-appliance/upgrade/manager

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Sspi Upgrade Operations

GET

Get Version Summary