List Sspi Upgrade Steps
Retrieves the list of all pre-checks and upgrade step definitions. This endpoint provides visibility into the upgrade workflow phases and pre-checks validations that will be executed, enabling the UI to display the upgrade process to the user before execution.
The steps are listed in the order they will be executed during the upgrade process. This endpoint returns step definitions only, not execution status. To retrieve execution status and progress, use GET /upgrade/status.
Upgrade step definitions retrieved successfully. The response contains a list of all upgrade step definitions in the order they will execute.
{
"offset": 0,
"number_of_results": 0,
"total_result_count": 0,
"total_pages": 0,
"sort_ascending": false,
"sort_by": "string",
"results": [
{
"_create_time": 0,
"_last_modified_time": 0,
"id": "string",
"display_name": "string",
"description": "string",
"activity_status_msg": "string",
"_completed_at": 0
}
],
"pre_checks": [
{
"_create_time": 0,
"_last_modified_time": 0,
"id": "string",
"display_name": "string",
"description": "string",
"activity_status_msg": "string",
"_completed_at": 0
}
]
}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 step definitions. 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