API Guide

message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
messages [{
Array of object:
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
field_name string
Field name where the error was seen
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
}]
}
29.3 GET /upgrades/{id}
Get current upgrade object by id
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*id string
Unique identier of the upgrade.
RESPONSE
STATUS CODE - 200: Response to upload upgrade le
RESPONSE MODEL - application/json
{
The detailed information of whole upgrade progress.
upgrade_id string
Unique identier of upgrade.
file_info {
The information of upgrade bundle le.
name string
name of upgrade le
size integer
The size of this upgrade le in KB.
}
upgrade_from string
Origin version where SFD upgrade from.
upgrade_to string
Current upgrade version of SFD.
pre_check_ts integer
Time at which last pre-check was done. The timestamp is dened in epoch milliseconds.
state enum ALLOWED:NOT_STARTED, FILE_DOWNLOADING,
FILE_DOWNLOADING_FAILED, FILE_VALIDATION_IN_PROGRESS,
FILE_VALIDATION_FAILED, PRE_CHECK_IN_PROGRESS,
PRE_CHECK_SUCCESS, PRE_CHECK_FAILED, UPGRADE_IN_PROGRESS,
UPGRADE_SUCCESS, UPGRADE_FAILED
Describe the current status of upgrade
pre_check_messages {
List of upgrade pre-check messages along with their severity.
data [{
Array of object: The list of precheck error and warning messages
pre_check_type enum ALLOWED:NOT_SET, MINIMUM_CPU, MINIMUM_MEMORY,
MINIMUM_AVAILABLE_DISK, MINIMUM_SFD_VERSION,
SYSTEM_HEALTH, SWITCH_MANIFEST_SUPPORT,
SCHEDULED_SFD_JOBS
Describe the type of pre-check
severity enum ALLOWED:NOT_SET, INFO, WARNING, ERROR
Describe the severity of message
314 of 340