API Guide

}
4.3 PUT /backups/locations/{id}
Modify backup location congurations
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*id string
Unique identier of the backup location to be updated
REQUEST BODY - application/json
{
Remote location to backup SFD data. It can be either FTP or SFTP server.
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
}
RESPONSE
STATUS CODE - 200: 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.
messages [{
48 of 340