– Destinations

Jb5: manageDestination

Mon, 01 Jan 0001 00:00:00 +0000

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 JetStorage 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.		`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

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}

Jb5: getDestination

Mon, 01 Jan 0001 00:00:00 +0000

**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}

Jb5: listDestinations

Mon, 01 Jan 0001 00:00:00 +0000

To view available listing parameters, please visit List Parameters.

**Returns**
Parameter name	Type	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

Jb5: listDestinationsTypes

Mon, 01 Jan 0001 00:00:00 +0000

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

Jb5: validateDestination

Mon, 01 Jan 0001 00:00:00 +0000

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}

Jb5: deleteDestination

Mon, 01 Jan 0001 00:00:00 +0000

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

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}

Jb5: reindexDestination

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Example
_id	String	Required The id of the destination.	`_id=5f7bdce1ae2dfb2 8835cb4e2`
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=5f80d3dabae 35a1a133d0662>`
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	Type	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}

Jb5: runIntegrityCheck

Mon, 01 Jan 0001 00:00:00 +0000

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	The destination Object ID.	For a list of Destination IDs, please use listDestinations	`_id=6169fde7916d0366563db4b2`
user_id	String	Optional The account user ID. Runs the Integrity Check only on the specified account. This option does NOT require the user_name.	For a list of user IDs, please use listAccounts	`user_id=9879fde8573d0125563dc4b2`
user_name	String	Optional The username of the account. Will run the Integrity Check on ALL accounts with the username (including orphan accounts). This option should NOT be included if using the `user_id`.	For a list of account usernames, please use listAccounts	`user_name=exampleUser`
job_id	String	Optional The backup job ID. Runs the Integrity Check only for the specified backup job.	For a list of backup job IDs, please use listBackupJobs	`job_id=608b1c5f160247613b11dc02`
rebuild	Boolean	Optional Force a full database rebuild for JetIndex Destinations	0 1	`rebuild=1`

Example Call JETAPI

jetbackup5api -F runIntegrityCheck -D "_id={$DESTINATION_ID}&user_id=9879fde8573d0125563dc4b2"

success: 1
message: Integrity check Added To The Queue
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=runIntegrityCheck&id={$DESTINATION_ID}