API Guide

29.6 POST /upgrades/latest
Perform specied action on latest upgrade
REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION
*actio
n
enum
ALLOWED:
PRE_CHECK, INIT,
ACK
Action to perform on the upgrade. pre-check, init and ack operations needs to be
performed in-order. ACK will fail if called before INIT and INIT will fail if called before
PRE-CHECK.
RESPONSE
STATUS CODE - 201: 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
requirement string
Describes the upgrade requirement
error_message string
Detailed message describing pre-check failure
}]
}
message string
Current status information or error message of upgrade progress.
acknowledged_by string
User id of NFC operator who previously have acknowledged this upgrade.
acknowledged_at integer
The time in seconds since epoch at which this upgrade was acknowledged by NFC operator. This
eld is empty if the acknowledge is in FALSE state.
initiated_by string
name of user who initiated this upgrade.
start_at integer
Time of upgrade start. The timestamp is dened in epoch milliseconds.
completed_at integer
Time of upgrade completion. The timestamp is dened in epoch milliseconds.
320 of 340