Destinations

manageDestination

This function lets you manage the Destinations settings.

getDestination

This function returns destination by id.

listDestinations

This function returns a list of destinations.


listDestinationTypes

This function returns a list of all supported Destination Types.

validateDestination

This function validates the Destination given a Destination ID.

deleteDestination

This function deletes a Destination given the Destination ID.

reindexDestination

This function resyncs the data from the Destination to JetBackup given the Destination ID.

Parameter Dictionary

Destination Object

Parameter name Type Description Possible Values Example
_id String The Destination ID.   5f8a21545108792bb859b1a3
name String The name assigned to Destination by user.   'Local Destinaion'
owner String ID of the owner of the schedule.   6070a5a3fae2cf5881160c03
owner_name String Name of the owner matching the owner ID.   root
type String The type of Destination. For a list of Supported Destination Types visit Destination Overview Local
count Integer The number of backup jobs this destination is assigned.   4
hidden Boolean Value indicating if the backups on this destination are hidden from users.
True 1
False 0/null
1
readonly        
disabled        
disk_limit        
disk_usage        
update_date        
dr        
reindex        
options Object Unique fields depending on the Destination Type. For a look at options see Options below.  

Destination Options

Destination Type Options
Local
path Absolute path for the desired backup directory.
rsyncbwlimit The bandwidth limit set for the rsync process.
SSH
path Absolute path for the desired backup directory.
username  
password  
privatekey  
host  
port  
timeout  
rsyncpreferip  
rsyncbwlimit The bandwidth limit set for the rsync process.
internalprivatekey The private key created by jetbackup after initial authorization.
freebsd  
S3
path Absolute path for the desired backup directory.
access_key  
secret_key  
region  
bucket  
endpoint  
verifyssl  
extrafields