WARNING: JetBackup 4 is set to reach its End-of-Life (EOL) on July 1st, 2024. For More Information, please visit: JetBackup 4 EOL Announcement.

NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our Jetbackup 5 Documentation.

manageDestination

Description

With this function, you can create/manage destination.

Parameters

This is the basic parameters for all destination types.

Parameter name	Type	Description	Possible values	Example
_id	String	Required on action modify The ID of the destination.		5b30da08d5ac5e06897b47e2
action	String	Required The action you want to perform.	create modify
name	String	Required on action create Destination name.		local
type	String	Required on action create Destination type.	Local SSH FTP SFTP RsyncNet AmazonS3 Dropbox GoogleDrive Backblaze CloneCpanel
engine	Integer	Backup engine type. Only on action create.	JetBackup - 1 cPanel - 2	1
path	String	Required on action create The path to the folder you want your backup to be restored in.		/localbackup
disabled	Boolean	Whether the destination is disabled.
disasterrecovery	Boolean	Whether the DR is enabled for the destination.
hidden	Boolean	Whether backups are hidden for the destination.
schedules[]	List	Exsist only on engine cPanel. The scheduled reindex assign for the destination. To create schedule click on manageSchedule List of Job Schedule Id.		schedules[][_id]=5b4c9375d5ac5e23e4463042
time	Integer	Exsist only on engine cPanel. The schedule reindex time for the destination.		1200

Local Parameters

Parameter name	Value	Description	Possible values	Example
rsyncbwlimit	Integer	Rsync Bandwidth Limit	Unlimited - 0 256 KB/s - 256 512 KB/s - 512 1 MB/s - 1024 2 MB/s - 2048 3 MB/s - 3072 4 MB/s - 4096 5 MB/s - 5120 6 MB/s - 6144 7 MB/s - 7168 8 MB/s - 8192 9 MB/s - 9216 10 MB/s - 10240 15 MB/s - 15360 20 MB/s - 20480 25 MB/s - 25600 30 MB/s - 30720 35 MB/s - 35840 40 MB/s - 40960 45 MB/s - 46080 50 MB/s - 51200 60 MB/s - 61440 70 MB/s - 71680 80 MB/s - 81920 90 MB/s - 92160 100 MB/s - 102400

SSH/Rsync.net/SSH-cPanel-Clone Parameters

Parameter name	Value	Description	Possible values
host	String	Required on action create A simple hostname or IP address to access the remote backup server.
port	String	Required on action create The remote port.
username	String	Required on action create The remote user to login with. Doesn't exist in SSH cPanel Clone
password	String	Required on action create Password for the provided username.
privatekey	String	The path to the private key.
timeout	Integer	Timeout for the connection.
rsyncbwlimit	Integer	Rsync Bandwidth Limit	Unlimited - 0 256 KB/s - 256 512 KB/s - 512 1 MB/s - 1024 2 MB/s - 2048 3 MB/s - 3072 4 MB/s - 4096 5 MB/s - 5120 6 MB/s - 6144 7 MB/s - 7168 8 MB/s - 8192 9 MB/s - 9216 10 MB/s - 10240 15 MB/s - 15360 20 MB/s - 20480 25 MB/s - 25600 30 MB/s - 30720 35 MB/s - 35840 40 MB/s - 40960 45 MB/s - 46080 50 MB/s - 51200 60 MB/s - 61440 70 MB/s - 71680 80 MB/s - 81920 90 MB/s - 92160 100 MB/s - 102400
rsyncpreferip	Integer	Rsync Prefer IPv4/IPv6	Default Route - 0 IPv4 - 4 IPv6 - 6

FTP/SFTP Parameters

Parameter name	Value	Description	Possible values
host	String	Required on action create A simple hostname or IP address to access the remote backup server.
port	String	Required on action create The remote port.
username	String	Required on action create The remote user to login with.
password	String	Required on action create Password for the provided username.
privatekey	String	The path to the private key.
timeout	Integer	Timeout for the connection.
retries	Integer	The number of failed connection attempts.
connections	Integer	The maximum number of connections at the same time.
ssl	Integer	Explicit SSL-FTP connection. Exists only in FTP destination.	1 - enabled 0 - disabled
passive	Integer	Passive FTP configuration. Exists only in FTP destination.	1 - enabled 0 - disabled

Amazon Parameters

Parameter name	Type	Description	Possible values	Example
accesskey	String	Required on action create The access key ID from the AWS Management Console.		WEVNB6GFDSUYTR12YUIO
secretkey	String	Required on action create The secret access key from the AWS Management Console.		+fgpbSMJ3+CjPfdirqQaN0iR/xr+jvy/X//K1gfd
bucket	String	Required on action create The bucket name that you created in Amazon S3 console.
region	String	Required on action create The region where the bucket actually exists.	us-east-1 - US East (N. Virginia) us-east-2 - US East (Ohio) us-west-2 - US West (Oregon) us-west-1 - US West (N. California) eu-central-1 - EU (Frankfurt) eu-west-1 - EU (Ireland) eu-west-2 - EU (London) eu-west-3 - EU (Paris) ap-southeast-1 - Asia Pacific (Singapore) ap-northeast-1 - Asia Pacific (Tokyo) ap-southeast-2 - Asia Pacific (Sydney) ap-northeast-2 - Asia Pacific (Seoul) ap-south-1 - Asia Pacific (Mumbai) sa-east-1 - South America (São Paulo) ca-central-1 - Canada (Central)	eu-central-1
concurrent	Integer	The maximum number of transfer commands that are allowed at any given time.
bandwidth	Integer	The maximum bandwidth that will be consumed for uploading and downloading data.
chunksize	Integer	The chunk size that the Amazon S3 CLI uses for multipart transfers of each file.

DropBox Parameters

To create the access code paste the app key at the end of the URL, allow access and get the access code
https://dropbox.com/oauth2/authorize?response_type=code&client_id=

Parameter name	Type	Description	Example
appkey	String	Required on action create The app key from the Dropbox app's page.	1jmtepn2sa0c331
secretkey	String	Required on action create The secret key from the Dropbox app's page.	c0y4ujm12345ty0
code	String	Required on action create The authentication popup code.
disklimit	Integer	The disk limitation of destination. The backup job will stop when you reached the limit.

BackBlaze Parameters

Parameter name	Type	Description	Example
accesskey	String	Required on action create The identifier for the account.	a7d952901rw8
secretkey	String	Required on action create The account Application Key.	4512dsa898i8e4735de526ad9fc07b626e705z0fc4
bucket	String	Required on action create The bucket name that you created in Amazon S3 console.
disklimit	Integer	The disk limitation of destination. The backup job will stop when you reached the limit.
retries	Integer	The number of failed connection attempts.
retrytimeout	Integer	Seconds to wait before next retry.

GoogleDrive Parameters

To create the access code get the client_id from the json file and paste it at the end of the URL, allow access and get the access code
https://accounts.google.com/o/oauth2/auth?response_type=code&access_type=offline&redirect_uri=urn:ietf:wg:oauth:2.0:oob&state=state_parameter_passthrough_value&scope=https://www.googleapis.com/auth/drive https://www.googleapis.com/auth/userinfo.email&approval_prompt=auto&client_id=

Parameter name	Type	Description	Possible values
privatekey	String	Required on action create OAuth 2.0 client json file contents.
authtype	Integer	Required on action create Authentication type.	1 - OAuth 2.0 2 - service account
accesscode	String	Required on action create The authentication popup code. Exists only in OAuth 2.0 type.
disklimit	Integer	The disk limitation of destination. The backup job will stop when you reached the limit.

Returns

This API call returns destination object.

To view the parameters returned, click on Destination Object

Example

jetapi backup -F manageDestination -D '_id=5b30da08d5ac5e06897b47e2&action=modify&name=local'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup/api.cgi?function=manageDestination&_id=5b30da08d5ac5e06897b47e2&action=modify&name=local

WHM API Documentation