Destinations

manageDestination

This function lets you manage the Destinations settings.

Parameter name Type Description Possible values Example

action String REQUIRED Flag to either create or modify the destination. create/modify action=create

_id String REQUIRED for Modify Unique ID given to every Destination upon creation. _id=6140e800c6dcdd436e7cd362

type String REQUIRED on action create. The Destination Type

Local

S3

SSH

Clones

GoogleDrive

DropBox

OneDrive

FTP, SFTP

Localv2

type=SSH

name String REQUIRED on action create. Custom destination name for your convenience. name=MyLocalDestination

owner String Owner(ID) of the Destination. The owner and his parent will have permissions to modify/delete this destination Owner will default to current logged-in user. owner=630e811f4ad52176890b3026

disabled Boolean True if destination is Disabled disabled=0

readonly Boolean Create the destination as a Read-Only Destination. Read Only destinations only allow restore/download of backups already stored on the destination. Existing Destinations cannot be edited to Read-Only.

dr Boolean Value indicating if the Destination is enabled for Export JB Config Backups. dr=1

threads Integer Set the maximum concurrent threads that can be used by the destination for upload/download/get/delete requests. 1-400 threads=100

disk_limit Integer Sets the Disk Limit Percentage for the Destination. 0-100 disk_limit=95

hidden Boolean

options Object REQUIRED on action create. Required options vary depending on destination type. Refer to Destination Options for more information. options[path]=/backups

reindex Boolean

Example Call JETAPI

CALL

RESPONSE
jetbackup5api -F manageDestination -D "action=modify&_id={$DESTINATION_ID}&name={$NEWNAME}&disk_limit={disk_limit}"

jetbackup5api -F manageDestination -D "action=create&type=S3&name={$NAME}&threads=200&options[path]=/test&options[access_key]={$ACESS_KEY}&options[secret_key]={$SECRET_KEY}&options[bucket]={$BUCKET_NAME}&options[endpoint]={$REGION}.amazonaws.com&options[region]=us-west-1"
success: 1
message: Destination Created/Updated Successfully
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  _id:
  name: s3-aws
  owner:
  owner_name: root
  type: S3
  job_type: 1
  count: 0
  hidden:
  readonly:
  disabled:
  disk_limit: 0
  disk_usage:
  threads: 10
  update_date: 2023-09-15T19:52:25+00:00
  dr:
  reindex: 1
  running:
  options:
    path: /test
    access_key:
    secret_key: JB|HIDDEN|********************
    region: us-west-1
    bucket: bucket
    endpoint: s3.us-west-1.amazonaws.com
  legacy:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageDestination&action=modify&_id={$DESTINATION_ID}&name={$NEWNAME}

getDestination

This function returns destination by id.

More Info

**Parameters**
Parameter name	Type	Description	Possible values	Example
_id	String	Required The ID of the destination.		`_id=5f7bdce1ae2dfb28835cb4e2`

This API Call returns a destination object.

To view the parameters returned, click on Destination Object.

Example Call JETAPI

jetbackup5api -F getDestination -D "_id={$DESTINATION_ID}"

success: 1
message:
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
_id: 6503eec8ebbf07708d06f1d2
name: s3
owner: 6503d48bfc45b1addf0a9632
owner_name: root
type: S3
job_type: 1
count: 1
hidden:
readonly:
disabled:
disk_limit: 0
disk_usage:
threads: 10
update_date: 2023-09-15T15:50:36+00:00
dr: 1
reindex:
running:
options:
        path: /test
        access_key:
        secret_key: JB|HIDDEN|********************
        region: us-west-1
        bucket: bucket
        endpoint: s3.us-west-1.amazonaws.com
legacy:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getDestination&_id={$DESTINATION_ID}

listDestinations

This function returns a list of destinations.

More Info

To view available listing parameters, please visit List Parameters.

**Returns**
Parameter name	Value	Description	Possible values	Example
destinations[]	List	Return List of Destination Object.
total	Integer	The total amount of destinations you have.

Example Call JETAPI

jetbackup5api -F listDestinations

success: 1
message:
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
types:
        0:
        key: Localv2
        name: Local
        version: 5.3.3
        experimental:
        type: 1
        1:
        key: Local
        name: Local (Legacy)
        version: 5.3.3
        experimental:
        type: 1
        2:
        key: Clones
        name: SSH
        version: 5.3.3
        experimental:
        type: 2
        3:
        key: S3
        name: S3 Compatible
        version: 1.1.2-8
        experimental:
        type: 1
        4:
        key: SSH
        name: SSH (Legacy)
        version: 1.1.2-1
        experimental:
        type: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listDestinations

listDestinationTypes

This function returns a list of all supported Destination Types.

More Info

To view available listing parameters, please visit List Parameters.

**Returns**
Parameter name	Type	Description	Possible values	Example
types[]	List	Return list of supported Destination Types

Example Call JETAPI

jetbackup5api -F listDestinationTypes

success: 1
message:
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
types:
        0:
        key: Localv2
        name: Local
        version: 5.3.3
        experimental:
        type: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listDestinationTypes

validateDestination

This function validates the Destination given a Destination ID.

More Info

Parameter name	Type	Description	Possible values	Example
_id	String	Required The ID of the destination.		`_id=5f7bdce1ae2dfb28835cb4e2`

Example Call JETAPI

jetbackup5api -F validateDestination -D "_id={$DESTINATION_ID}"

success: 1
message: Destination Validated Successfully
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=validateDestination&_id={$DESTINATION_ID}

deleteDestination

This function deletes a Destination given the Destination ID.

More Info

Parameters

Parameter name Type Description Possible values Example

_id String Required The ID of the destination. _id=5f7bdce1ae2dfb28835cb4e2

Doesn't return any data.

Example Call JETAPI

CALL

RESPONSE
jetbackup5api -F deleteDestination -D "_id={$DESTINATION_ID}"
success: 1
message: Destination Deleted Successfully
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=deleteDestination&_id={$DESTINATION_ID}

reindexDestination

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

More Info

**Parameters**
Parameter name	Value	Description	Example
_id	String	Required The id of the destination.	`_id=5f7bdce1ae2dfb28835cb4e2`
account_id	String	Optional The Account ID of a specific Account you want to reindex. Will only reindex the single account with the specified ID on the destination.	`account_id=5f80d3dabae35a1a133d0662`
account_username	String	Optional The Account Username of a specific Account you want to reindex. Will only reindex the single account on the destination by exact name match. Useful if JetBackup hasn't indexed the account before.	`account_username=account123`
by_snap	Boolean	Optional Allows JetBackup to reindex all snapshots using the jetbackup.index file in each snapshot folder	`by_snap=1`

**Returns**
Parameter name	Value	Description	Possible Values	Example
_id	String	id of the Queue process		`_id=5f80d3dabae35a1a133d0662`

Example Call JETAPI

jetbackup5api -F reindexDestination -D "_id={$DESTINATION_ID}&account_username={$USERNAME}&by_snap=1"

success: 1
message: Destination Reindex added to the queue Successfully
system:
  version: 5.3.3
  version_panel: 5.3.3
  tier: EDGE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
_id: 6504c114f7aa3d46db0c75c4
owner: 6503d48bfc45b1addf0a9632
owner_name: root
created: 2023-09-15T20:39:48+00:00
started:
ended:
type: 8
items: 0
items_completed: 0
finalize:
status: 0
can_rerun:
rerun_failed:
log_id: 6504c114a7a8a66aa50fa3a2
status_time:
progress:
execution_time: 0
actual_time: 0
log_file: /usr/local/jetapps/var/log/jetbackup5/queue/8_6504c114f7aa3d46db0c75c4.log
log_contents:
data:
  id: 6503eec8ebbf07708d06f1d2
  name: s3
  account: user

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=reindexDestination&_id={$DESTINATION_ID}&account_username={$USERNAME}

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 Destination'

owner

String

ID of the Destination's owner.

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

count

Integer

The number of backup jobs this destination is assigned.

hidden

Boolean

Value indicating if the backups on this destination are hidden from users.

True	1
False	0/null

readonly

Boolean

Value indicating if the backups on this destination are hidden from users.

True	1
False	0/null

disabled

Boolean

Value indicating if the backups on this destination are hidden from users.

True	1
False	0/null

disk_limit

Integer

Value indicating the percentage disk limit for Destination.

0 - 100

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

Boolean

Value indicating if the Destination is enabled for Export JB Config Backups.

True	1
False	0/null

reindex

Boolean

Value indicating if the Destination is currently reindexing.

True	1
False	0/null

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, Localv2, SSH, S3, FTP, SFTP, Dropbox, OneDrive, Google Drive	options[path]=/backups
host	REQUIRED on action create. Hostname/IP of the Destination server.	SSH, Clones, FTP, SFTP	options[host]=10.10.10.100
port	REQUIRED on action create. Specify the Port to connect to the destination server.	SSH, Clones, FTP, SFTP	options[port]=22
username	REQUIRED on action create. Specify the login username.	SSH, FTP, SFTP	options[username]=jetbackupuser
password	REQUIRED on action create. Specify the login password.	SSH, Clones, FTP, SFTP	options[password]=
privatekey	Path to the SSH Private Key if enabled.	SSH, Clones, SFTP	options[privatekey]=/root/.ssh/id_rsa
passphrase	The SSH Private Key passphrase. Only supported for SFTP	SFTP	options[passphrase]=password
timeout	Number of seconds before rsync timeout.	SSH, Clones, FTP, SFTP	options[timeout]=30
prefer_ip	The prefered IP route (IPv4, IPv6). Leave blank to choose automatically.	FTP	options[prefer_ip]=4 (IPv4)
rsyncpreferip	The rsync prefered IP route (IPv4, IPv6). Leave blank to choose automatically.	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_code	REQUIRED on action create. The Access code generated for your Google Drive account.	Google Drive	options[access_code]=
authorization_code	REQUIRED on action create. The Access code generated for your OneDrive account.	OneDrive	options[authorization_code]=
code	REQUIRED on action create. The Access code generated for your Dropbox account.	Dropbox	options[code]=
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/disable SSL.	S3	options[verifyssl]=1
retries	The number of HTTP Retries to allow (max 10).	S3, FTP, SFTP, Google Drive, Dropbox, OneDrive	options[retries]=3
chunk_size	Multipart upload chunk size. Minimum 1024MB and Maximum 5120MB.	S3	options[chunk_size]=1024
keepalive_timeout	The time in seconds, that the host will allow an idle connection to remain open before it is closed. [ 0 to disable ]	S3	options[keepalive_timeout]=60
keepalive_requests	The maximum number of requests that can be sent on a single connection before closing it. [ Enter 0 to let remote vendor determine number of keepalive requests. ]	S3	options[keepalive_requests]=100
secure	Boolean value to enable/disable Secure SSL-FTP Connection	FTP	options[secure]=1
passive	Boolean value to enable/disable FTP passive mode.	FTP	options[passive]=1

JETAPI Documentation

On This Page:

Destinations

manageDestination

getDestination

listDestinations

listDestinationTypes

validateDestination

deleteDestination

reindexDestination

Parameter Dictionary

Destination Object

Destination Options

On This Page: