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.
}]
}
4.12 GET /backups/remote-files
Get list of backup les to restore from
Get backups from remote server. If user provides a directory, then return list of backups under this dir. If user provides a le
name, then return a single le.
REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION
*file_path string
the path where backups are stored in remote server.
*username string
Username of remote server
*password string
Password of remote server.
RESPONSE
STATUS CODE - 200: Response to get backups list from remote server
RESPONSE MODEL - application/json
{
List of backups from remote server
data [{
Array of object: Information about the backup le.
file_id string
Unique identier of the backup le
backup_file_name string
File name of the backup including extension
content [enum] ALLOWED:CONFIG_DATA, EVENTS_AND_LOGS_DATA,
MONITORING_DATA
The type of SFD data being backed up.
size integer
The size of this backup le in KB.
backup_time integer
Time at which the backup was taken. The timestamp is dened in epoch milliseconds.
version string
Version of SFD. This eld is needed for getting restore status. It is not needed when retrieving
backups.
}]
}
STATUS CODE - 400: Invalid request.
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
Params array to substitute in the message. This will be used by UI to substitue the params in the
63 of 340