API Guide

RESPONSE
STATUS CODE - 200: Response to get single backup job by id.
RESPONSE MODEL - application/json
{
Backup job to take backup of SFD data periodically
id string
Unique identier of the Backup Job
status enum ALLOWED:ACTIVE, EXPIRED
Backup job status. If it is expired it will stop generating backup instances.
user_info {
This object describes the user information with respect to object like who created or updated the object
created_by string
Name of the user who created the object.
created_at integer
creation date of this object
last_updated_by string
Name of the user who last updated this object
last_updated_at integer
last update date of this object
}
name* string
Denes the prex of the SFD backup tar
location* string
Congured backup location unique identier
content* [enum] ALLOWED:CONFIG_DATA, EVENTS_AND_LOGS_DATA,
MONITORING_DATA
The type of SFD data being backed up.
description string
Schedule backup job description
frequency* enum ALLOWED:DOES_NOT_REPEAT, HOURLY, DAILY, WEEKLY, MONTHLY
The frequency at which SFD data will be backed up.
end_recurrence_type enum ALLOWED:NEVER, NUMBER_OF_BACKUPS, END_TIME
The type of end recurrence for a backup job
start_time* integer
Time at which rst backup will be taken. The timestamp is dened in epoch milliseconds.
end_time integer
Time at which backup job will stop taking further backups. The timestamp is dened in epoch
milliseconds. This eld is needed if the recurrence type is END_TIME
backup_instances integer
Denes the number of instances after which backup job will stop taking further backups. This
eld is needed if the recurrence type is NUMBER_OF_BACKUPS.
}
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.
55 of 340