API Guide

RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
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
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.
}]
}
STATUS CODE - default: success or error response
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
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
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.2 POST /upgrades/remote-file
Upload upgrade le from remote server.
REQUEST
REQUEST BODY - application/json
{
Remote location where the upgrade bundle le is located.
bundle_location* string
The location of the upgrade bundle.
username* string
Username of the remote server
password* string
Password of the remote server
hostname* string
Hostname of the remote server
port* integer
Port of the remote server
protocol* enum ALLOWED:FTP, SFTP
supported protocols to access the image server
}
RESPONSE
STATUS CODE - 201: success or error response
RESPONSE MODEL - application/json
312 of 340