API Guide

Message in the localized le.
}]
}
4.6 POST /backups/jobs
Add a backup job to backup SFD data periodically or on demand.
REQUEST
REQUEST BODY - application/json
{
Backup job to take backup of SFD data periodically
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.
}
RESPONSE
STATUS CODE - 201: 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.
}]
}
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
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.
53 of 340