API Guide

ANOTHER_BACKUP_IN_PROGRESS, NOT_SET
the current status of this backup instance.
size integer
Size of the backup tar le in KB.
version string
SFD Version
content [enum] ALLOWED:CONFIG_DATA, EVENTS_AND_LOGS_DATA,
MONITORING_DATA
The type of SFD data being backed up.
location string
Path on Remote location at which backup tar is uploaded
start_time integer
Time in seconds since epoch at which backup was taken.
completed_time integer
Time at which backup instance will complete Backup. The timestamp is dened in epoch
milliseconds.
job_name string
The name of backup job this instance belongs to.
description string
the description for this backup job.
additional_information string
Additional information about this back up instance.
}
STATUS CODE - 401: You are not authorized to perform this operation.
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 - 404: Requested entity does not exist.
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.
62 of 340