Trigger Upgrade
Executes the SSP upgrade operation asynchronously based on the specified action. Returns immediately with a status URL; use GET /upgrade/status to monitor progress.
Supported actions:
PRECHECKS_ONLY: Runs only pre-upgrade validation checks without performing the upgrade. This operation is idempotent and non-disruptive; it can be safely run on a live production system to assess readiness before a maintenance window. PRECHECKS_ONLY is only allowed when the upgrade status is NOT_STARTED. Only one pre-checks operation can run at a time.
START: Runs pre-checks followed by the full upgrade. This is the standard upgrade flow. START is only allowed when the upgrade status is NOT_STARTED. Requires a scheduled maintenance window as the system may experience downtime during the upgrade. Ensure a backup is taken before initiating. Do not interrupt the upgrade process once initiated.
CONTINUE: Starts the upgrade without running pre-checks. CONTINUE is only allowed when the upgrade status is NOT_STARTED and pre-checks have completed successfully, returns an error for any other state.
RETRY: Resumes the upgrade workflow from the failed step. Already completed upgrade steps are skipped automatically. RETRY is only allowed when the upgrade status is FAILED, which means pre-checks have already passed. If pre-checks failed, use START again.
Recommended workflow:
- Deploy the upgrade coordinator via the LCM feature deploy API (PUT /lcm/features/UPGRADE_COORDINATOR with action DEPLOY).
- Check available versions (GET /upgrade/available-versions).
- Run pre-checks (POST /upgrade?action=PRECHECKS_ONLY) and review results (GET /upgrade/status).
- During a maintenance window, start the upgrade (POST /upgrade?action=START or POST /upgrade?action=CONTINUE if pre-checks already passed), and monitor progress (GET /upgrade/status).
- If upgrade fails, address the issue and retry (POST /upgrade?action=RETRY).
- Review upgrade history (GET /upgrade/history) after completion.
- Undeploy the upgrade coordinator via the LCM feature undeploy API (PUT /lcm/features/UPGRADE_COORDINATOR with action UNDEPLOY).
The upgrade action to perform.
PRECHECKS_ONLY: Runs only pre-upgrade validation checks (idempotent). PRECHECKS_ONLY can only be performed when the upgrade status is NOT_STARTED. Only one pre-checks operation can run at a time. START: Runs pre-checks followed by the full upgrade. START can only be performed when the upgrade status is NOT_STARTED. CONTINUE: Starts the upgrade without pre-checks. CONTINUE can only be used when the upgrade status is NOT_STARTED and pre-checks have completed successfully. RETRY: Resumes the upgrade workflow from the failed step, skipping completed steps. RETRY can only be used when the upgrade status is FAILED.
Operation has been accepted and initiated. The operation is executing asynchronously. Use the status_url in the response to monitor progress and track completion.
{
"id": "b8f47985-22ed-3193-bca8-11c7b025cbce",
"status_url": "/operation/status"
}UUID identifier of the response.
The URL to check the status of the operation.
The system does not meet prerequisites for the requested action. Possible reasons include: the upgrade status does not permit the requested action (e.g., RETRY when upgrade is not FAILED, CONTINUE when pre-checks have not completed successfully), or the action parameter is invalid.
{
"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.
Conflict. An upgrade or pre-checks operation is already in progress. Monitor the current operation using GET /upgrade/status.
{
"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 initiating the operation. Consult the error response details and system logs for diagnostic information.
"Error Object"HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -X POST -H 'Authorization: <value>' https://{api_host}/ssp/upgrade