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
job_type Integer The Job Type the Destination will be used for.
  • Clones - 1
  • Backup - 2
2
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 Boolean Value indicating if the backups on this destination are hidden from users.
True 1
False 0/null
1
disabled Boolean Value indicating if the backups on this destination are hidden from users.
True 1
False 0/null
1
disk_limit Integer Value indicating the percentage disk limit for Destination. 0 - 100 95
disk_usage Object Object containing the three integer values for Usage/Free/Total in Bytes.
  • Usage
  • Free
  • Total
 
update_date String Date indicating the last time disk_usage was updated. YYYY-DD-MMTHH:MM:SS 2021-08-05T19:45:36+00:00
dr Boolean Value indicating if the Destination is enabled for Export JB Config Backups.
True 1
False 0/null
1
reindex Boolean Value indicating if the Destination is currently reindexing.
True 1
False 0/null
1
options Object Unique fields depending on the Destination Type. For a look at options see Options below.  

Destination Options

Option Name Description Destination Type(s) Example
path REQUIRED on action create. Absolute path for the desired backup directory. Local, SSH, S3 options[path]=/backups
host REQUIRED on action create. Hostname/IP of the Destination server. SSH, Clones options[host]=10.10.10.100
port REQUIRED on action create. Specify the Port to connect to the destination server. SSH, Clones options[port]=22
username REQUIRED on action create. Specify the login username. SSH options[username]=jetbackupuser
password REQUIRED on action create. Specify the login password. SSH, Clones options[password]=
privatekey Path to the SSH Private Key if enabled. SSH, Clones options[privatekey]=/root/.ssh/id_rsa
timeout Number of seconds before rsync timeout. SSH, Clones options[timeout]=30
rsyncpreferip The prefered IP version SSH, Clones options[rsyncpreferip]=4 (IPv4)
rsyncbwlimit The bandwidth limit set for the rsync process. Local, SSH, Clones options[rsyncbwlimit]=102400
internalprivatekey The private key created by jetbackup after initial authorization. SSH, Clones N/A
access_key REQUIRED on action create. The Access Key generated for your S3 Bucket. S3 options[access_key]=
secret_key REQUIRED on action create. The Secret Key generated for your S3 Bucket. S3 options[secret_key]=
bucket REQUIRED on action create. The name of your S3 Bucket. S3 options[bucket]=server1
endpoint REQUIRED on action create. The endpoint url for your S3 Bucket. S3 options[endpoint]=s3.{region}.amazonaws.com
region The S3 Region of your S3 Bucket S3 options[region]=us-west-1
verifyssl Boolean value to enable/disbale SSL. S3 options[verifyssl]=1
retries The number of HTTP Retries to allow (max 10). S3 options[retries]=3