API Guide

4. BACKUP
Backup APIs related to backup and restore of SFD database.
4.1 GET /backups/locations
Get list of all congured backup location. All the SFD backup data will get uploaded to the backup location.
Get list of all congured backup location
REQUEST
No request parameters
RESPONSE
STATUS CODE - 200: Response to get all the congured backup location
RESPONSE MODEL - application/json
{
Lists all the backup locations congured for SFD backups
data [{
Array of object: Remote location to backup SFD data. It can be either FTP or SFTP server.
id string
Unique identier of the remote backup location
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
}
host* string
IP or FQDN of backup location server. 1. IP address and port (x.x.x.x:<port_number>) 2. FQDN
(domain.com) 3. If the port is not provided then default port for specied protocol will be considered.
(FTP:21, SFTP:22)
username* string
Username of the backup location.
password string
Password of the backup location. During add cases, password is required. Password is optional in edit
and list cases.
backup_path* string
The location on the backup location at which SFD backup tars will be uploaded. This is path of the base
directory setup in the server(/sfdBackup).
protocol* enum ALLOWED:FTP, SFTP
The protocol used to upload backup les on remote location
description string
Add backup location description
}]
}
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
45 of 340