– JETAPI Documentation

Jb5: System

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

Jb5: Dashboard

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

Jb5: Accounts

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

Parameter Dictionary

**Account Object**
Parameter name	Type	Description	Examples
_id	String	ID of the account.	`_id: 5fb4a0fa08994c637c6ada5b`
UUID	String	Unique ID used for "Reassigning Accounts"	`uuid: 5d2c807e4e878add6c32b6f3f57af220dd1713bf`
username	String	REQUIRED The username of the account.	`username: acct1`
domain	String	Domain assigned to the account.	`domain: www.acctname.com`
owner	String	Name of the owner of the account.	`owner: root/admin/RESELLER`
owner_id	String	Unique ID given to the owner.	`owner_id: 5fb471c95159b9583c1cb913`
homedir	String	Absolute path to account public_html.	`homedir: /home/acctname`
ip	String	IP given to the account.	`ip: 111.111.1.11`
package	String	Name of the package assigned to account.	`package: default`
packages	List []	All packages owned by the account.
root	Boolean	True if account is root.	`root: 1`
reseller	Boolean	True if account is a reseller.	`reseller: 1`
suspended	Boolean	True if account is suspended.	`suspended: 1`
login_only	Boolean	True if acount is login_only.	`login_only: 1`
active	Boolean	True if account is active.	`active: 1`
email	String	The email used to notify the user after each user-initiated processes.	`email: test@email.com`
max_snapshots	Integer	The maximum snapshots allowed to create for the specified account.
tags	List []	List of all tags assigned to account.
backup_type	Integer	Backup type used for Backup on Demand.	`backup_type: 0`
encryption_key_type	Integer	Type used for the encryption backups.	`encryption_key_type: 0`
privacy	Boolean
queue_priority	String	The ID of the queue priority to assign to the specified account.
last_active	String	Date of when account was last active.
secret_key	String	Secret Key is used for unlocking encrypted backups.
assignable_accounts	List []	List of IDs for reassignable accounts.
quota	List []	List of information regarding disk_total, disk_usage, disk_free, and inode_usage.

Jb5: Destinations

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

Parameter Dictionary

Destination Object

Parameter name Type Description Possible Values Example

_id String The Destination ID. _id: 5f8a21545108792bb859b1a3

name String The name assigned to Destination by user. name: Local Destination

owner String ID of the Destination's owner. owner: 6070a5a3fae2cf5881160c03

owner_name String Name of the owner matching the owner ID. owner_name: root

type String The type of Destination. For a list of Supported Destination Types visit Destination Overview type: Local

job_type

Integer

The Job Type the Destination will be used for.

Backup - 1
Clones - 2

job_type: 2

count Integer The number of backup jobs this destination is assigned. count: 4

hidden

Boolean

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

True	1
False	0/null

hidden: 1

immutable

Boolean

Value to enable/disable Immutable Backups (Object Lock). Requires a bucket with Object Lock enabled in Compliance Mode. This setting cannot be changed after the destination is created. S3, JetStorage Only.

True	1
False	0/null

immutable: 1

readonly

Boolean

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

True	1
False	0/null

readonly: 1

disabled

Boolean

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

True	1
False	0/null

disabled: 1

disk_limit Integer Value indicating the percentage disk limit for Destination. 0 - 100 disk_limit: 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 update_date: 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

dr: 1

reindex

Boolean

Value indicating if the Destination is currently reindexing.

True	1
False	0/null

reindex: 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, 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
quick_access_code	REQUIRED on action create. The Quick Access Code generated for your JetBackup Storage destination. See Get Quick Access Code for details.	JetStorage	`options[quick_access_code]=code_here`
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, JetStorage	`options[access_key]=`
secret_key	REQUIRED on action create. The Secret Key generated for your S3 Bucket.	S3, JetStorage	`options[secret_key]=`
bucket	REQUIRED on action create. The name of your S3 Bucket.	S3, JetStorage	`options[bucket]=server1`
endpoint	REQUIRED on action create. The endpoint url for your S3 Bucket.	S3, JetStorage	`options[endpoint]=s3.{region}.amazonaws.com`
region	The S3 Region of your S3 Bucket	S3, JetStorage	`options[region]=us-west-1`
verifyssl	Boolean value to enable/disable SSL.	S3, JetStorage	`options[verifyssl]=1`
retries	The number of HTTP Retries to allow (max 10).	S3, JetStorage, FTP, SFTP, Google Drive, Dropbox, OneDrive	`options[retries]=3`
chunk_size	Multipart upload chunk size. Minimum 1024MB and Maximum 5120MB.	S3, JetStorage	`options[chunk_size]=1024`
keepalive_timeout	The time in seconds, that the host will allow an idle connection to rcodeain open before it is closed. [ 0 to disable ]	S3, JetStorage	`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 rcodeote vendor determine number of keepalive requests. ]	S3, JetStorage	`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`

Jb5: BackupJobs

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

Parameter Dictionary

Backup Job Object

Parameter name Type Description Possible values Example

_id String Unique Backup Job ID N/A _id: 5fcb1df43606876d134aab82

name String Backup Job name used internally for your convenience. N/A name: Full Account Backups

destination List [] List of Destination IDs assigned for this backup job. N/A

destination_name List [] Names of the destinations assigned to this backup job. N/A destination_name: Amazon 3

type

Integer

The integer value for the Backup Type

Accounts	1
Directories	2

type: 1

contains

Integer

The integer value for Contains. Full backup accounts will be the value of 511 which is 1+2+4+8+16+32+64+128+256 (for all available backup options) (or 1|2|4|8|16|32|64|128|256 in binary operation).

Account Config	1
Account Homedir	2
Account Databases	4
Server Backup	7
Account Emails	8
Account Cron Jobs	16
Account Domains	32
Account Certificates	64
Account Database Users	128
Account FTP	256
Full Account	511

contains: 511

options

Integer

Include or Exclude databases/Emails contents

Incude Databases	0
Exclude Emails Contents	1
Include Emails Contents	2
Exclude Databases and Email Junk	4
Include Junk	6

options: 4

structure

Integer

The integer value for Backup Structure.

Incremental	1
Archived	2
Compressed	4

structure: 2

owner String The unique ID given to the owner. N/A owner: 5fc96deeac61ab0bc3020313

owner_name String The name assigned to the owner. N/A owner_name: root

next_run String The date in UTC of the scheduled next run of the Backup Job. N/A next_run: 2020-12-09T03:57:09+00:00

last_run String The date in UTC of the last scheduled run of the Backup Job. N/A last_run: 2020-12-08T12:45:00+00:00

running Boolean Boolean value to determine if a backup job is currently running. null/1 running: 1

disabled Boolean Boolean value to determine if a backup job is disabled. null/1 disabled: 1

include_list List [] List of File/Directory Paths to Include for Directories Backup Types. N/A include_list: 0: /home/docsjetbackup

exclude_list List [] List of File/Directory Paths to Exclude from backup job. N/A exclude_list: 0: /usr/local/tmp

encrypted Boolean Boolean value to determine if a backup job will encrypt the backups. null/1 encrypted: 1

schedules List [] List of Schedule Objects assigned to the Backup Job. N/A schedules: 0: _id: 67883ac75a6ef862b902e2a3 name: JetBackup Config Daily type: 2 next_run: 2025-02-14T08:00:00+00:00 retain: 7

hooks List [] List of Hook Objects IDs assigned to the Backup Job. N/A hooks: 0: _id: 67a694bb96dc4ac9bd0dcd52 name: Pre hook

filters List [] List of Account Filter Object Group IDs assigned to the Backup Job. N/A filters: 0: 0: 670fe55dc367a30323073583

monitor

List []

List of the Job Monitor values in days.

ranfor
notran

monitor:
        ranfor: 2
        notran: 2

object_lock_days Integer Set the Object Lock retention period for the immutable backup job. The backups will be protected from deletion or modification for the number of days specified. This option is only available for the S3-Compatible and JetBackup Storage destinations. object_lock_days: 60

Jb5: CloneJobs

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

Parameter Dictionary

Clone Job Object

Parameter name Type Description Possible values Example

_id String Unique Clone Job ID _id: 5fcb1df43606876d134aab82>

name String Clone Job name used internally for your convenience. name: Full Account Clones

destination List [] List of Destination IDs assigned for this backup job. destination: 0: 6752271df69f23ed310eaba2

destination_details List [] Names of the destinations assigned to this backup job.

type

Integer

The integer value for the Clone Type

Account

type: 1

contains

Integer

The integer value for Contains. Full backup accounts will be the value of 511 which is 1+2+4+8+16+32+64+128+256(for all available backup options) (or 1|2|4|8|16|32|64|128|256 in binary operation).

Account Config	1
Account Homedir	2
Account Databases	4
Account Emails	8
Account Cron Jobs	16
Account Domains	32
Account Certificates	64
Account Database Users	128
Account FTP	256
Full Account	511

contains: 511

owner String The unique ID given to the owner. owner: 5fc96deeac61ab0bc3020313

owner_name String The name assigned to the owner. owner_name: root

next_run String The date in UTC of the scheduled next run of the Clone Job. next_run: 2020-12-09T03:57:09+00:00

last_run String The date in UTC of the last scheduled run of the Clone Job. last_run: 2020-12-08T12:45:00+00:00

running Boolean Boolean value to determine if a backup job is currently running. null/1 running: 1

disabled Boolean Boolean value to determine if a backup job is disabled. null/1 disabled: 1

exclude_list List [] List of the files/directories to exclude from backup job.

encrypted Boolean Boolean value to determine if a backup job will encrypt the backups.

schedules List [] List of Schedule Objects IDs.

hooks List [] List of Hook Objects IDs.

filters List [] List of Account Objects IDs.

monitor

List []

List of of the values set for the Clone Job Monitor.

ranfor: (int) days
notran: (int) days

default_package String The default package assigned to the account on the destination after cloning.

default_owner String The default owner assigned to the account on the destination after cloning.

Jb5: Schedules

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

Parameter Dictionary

Schedule Object

Parameter name Type Description Possible Values Example

_id String The Schedule ID. _id: 5f8a21545108792bb859b1a3

name String The name assigned to Schedule by user. name: Daily Schedule

type

Integer

The type of schedule.

Hourly	1
Daily	2
Weekly	3
Monthly	4
After Backup Done	5
After Clone Done	10
Manual	8

type: 2

type_name String The corresponding name for the schedule type. type_name: Daily

type_data List[]/Integer/String The Type Data for each type of schedule. Can be list of integers for Daily/Monthly, integer for Hourly/Weekly, or string for AfterBackupJob.

delay_type

Integer

The unit for delay. To view all possible types visit Delay Type

Minutes	1
Hours	2
Days	3

delay_amount Integer Amount to delay by. Enter the amount as a positive integer. 0 amount will run the backup job or clone job immediately after the assigned job completes. delay_amount: 0

delay Boolean Value indicating if there is a delay. 1/0

owner String ID of the owner of the schedule.

owner_name String Name of the owner

count Integer Number of jobs schedule is assigned to.

jobs List [] List of Backup Jobs schedule is assigned to.

Type Data

Type Name Description Possible Values Examples

Hourly

Can only assign one value for Hourly Schedules.

Every 1 Hour	1
Every 2 Hours	2
Every 3 Hours	3
Every 4 Hours	4
Every 6 Hours	6
Every 8 Hours	8
Every 12 Hours	12

type_data=4 sets the schedule to run every 4 hours.

Daily

Can assign multiple values for Daily Schedules.

Sunday	1
Monday	2
Tuesday	3
Wednesday	4
Thursday	5
Friday	6
Saturday	7

type_data[0]=1&type_data[1]=5 sets the schedule to run every Sunday and Thursday.

Weekly

Can only assign one value for Weekly Schedules.

Sunday	1
Monday	2
Tuesday	3
Wednesday	4
Thursday	5
Friday	6
Saturday	7

type_data=3 sets the schedule to run every week on Tuesday.

Monthly

Can assign multiple values for Monthly Schedules.

1st of the Month	1
7th of the Month	7
14th of the Month	14
21st of the Month	21
28th of the Month	28

type_data[0]=1&type_data[1]=21 sets the schedule to run every 1st and 21st of the Month.

After Backup Done Can only assign one Backup Job for After BackupJob Done Schedules. Have to assign the Delay Type as well. Backup Job ID type_data=5fd44aebb0d87e31a47cfed2 sets the schedule to run after the Backup Job 5fd44aebb0d87e31a47cfed2 completes.

After Clone Backup Done Can only assign one Clone Job for After Clone Done Schedules. Have to assign the Delay Type as well. Clone Job ID type_data=697bf62bb158a4237b087d32 sets the schedule to run after the Clone Job 697bf62bb158a4237b087d32 completes.

Jb5: AccountFilters

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

Parameter Dictionary

Account Filter Object

Parameter name Type Description Possible Values Example

_id String The Account Filter ID. N/A _id: 5b28f9f4d5ac5e5ed5049f82

group_id String The Account Filter Group ID associated to Backup Jobs. N/A group_id: 5b6a87abd5ac5e655e2018d3

type

Integer (Binary Left Shift)

The type of Account Filter.

Accounts Filter	2
Resellers Filter	4
Suspension Filter	8
Disk Space Usage Filter	16
Inodes Usage Filter	32
Packages Filter	64
Characters Range Filter Usage	128
Regular Expression Filter	256
Account Tags Filter	512
Encryption Filter	1024

type: 2

name String The Account Filter name. N/A name: Test Account Filter

owner String The Account Filter Owner's ID N/A owner: 6070a5a3fae2cf5881160c03

owner_name String The Account Filter Owner's name. N/A owner_name: root

count Integer The Number of Backup Jobs which the Account Filter is assigned to. N/A count: 1

condition

Integer

Whether you want to exclude/include the account in the list.

Include	1
Exclude	2

condition: 2

list

List[] of Strings

List of Filter Type specific objects assigned to the Account Filter. (Only for Filter Types 2 | 4 | 64 | 512)

Type 2	List of Accounts
Type 4	List of Resellers
Type 64	List of Packages
Type 512	List of Packages

list:
  0: acct1

usage

Integer

The Usage Limit for the Filter Type specific parameter assigned to the Account Filter. (Only for Filter Types 16 | 32)

Type 16	Disk Usage Limit in Bytes
Type 32	Inode Usage Limit

usage: 4096

range_start String The starting character for the range you want to filter by. (Only for Filter Type 128) 0-9_a-z range_start: 0

range_end String The ending character for the range you want to filter by. (Only for Filter Type 128) 0-9_a-z range_end: z

regex String The regular expression you want to filter by. (Only for Filter Types 128 | 256*) /^[0-9_a-z]/i regex: /^[1-9_a-z]/i

Jb5: Backups

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

Parameter Dictionary

Backup Object

Key	Type	Description	Example
_id	String	The Backup Object ID.	`_id: 60b164043c2bb904123c2aa5`
parent_id	String	The Backup ID that encompasses multiple Backup Objects.	`parent_id: 67aeab2490def077d10e6a05`
account_id	String	The Account ID that the Backup Object was generated for.	`account_id: 67aea855e6739b9b0e0e6a01`
destination	String	The Destination ID that the Backup Object exists on.	`destination: 670a93d67c53aad9740173f2`
destination_name	String	The name of the Destination matching the Destination ID.	`destination_name: Local`
name	String	The name of the Account matching the Account ID.	`name: Acct1`
created	ISODate	The date the Backup Object was generated.	`created: 2025-02-14T02:32:04+00:00`
path	String	The path where the Backup Item exists.	`path: /local`
backup_type	Integer	The Backup Type this object was given. See below for the full list of types.	`backup_type: 1`
backup_contains	Integer	The Backup Contains value. See below for the full list of contains.	`backup_contains: 511`
account	String	The name of the Account.	`account: Acct1`
account_data	Account Object	Data from the Account Object.
size	Integer	Size of the Backup Object in Bytes.	`size: 30702`
backup_structure	Integer	The value indicating the Backup Object's Backup Structure. See below for the list of Backup Structures.	`backup_structure: 1`
notes	String	Notes added to the Backup Object manually.
lock	Boolean	Value to indicate if the Backup Object is Locked.	`lock: 1`
lock_ttl	Integer	The number of days a Backup Object will be locked.	`lock_ttl: 1`
damaged	Boolean	Value to indicate if the Backup Object is corrupted.	`damaged: 1`
schedules	List []	List of the Schedule Types that generated this Backup Object.
hidden	Boolean	Value to indicate if the Backup Object is hidden from the account.	`hidden: 1`
encrypted	Boolean	Value to indicate if the Backup Object is encrypted.	`encrypted: 1`
encryption_id	String	ID of the encryption key used for this Backup Object.
encryption_key_required	Boolean	Value to determine if an encryption key is needed to restore/download the Backup Object.
encryption_key_exists	Boolean	Value to determine if an encryption key exists for this Backup Object.

Backup Types

Name	Value	Description
Account	1	Account Backup Type.
Directories	2	Directories Backup Type
JB Config	3	JetBackup Configuration Backup Type

Backup Contains

The Backup Contains are represented as an Integer value evaluated from a binary operation.

For Example:

Full Account Backups will have a Backup Contains of 511 which is 1+2+4+8+16+32+64+128+256 (for all available Backup Items) (or 1|2|4|8|16|32|64|128|256 in binary operation).
Account Backups with Panel Configurations, Cron Jobs, DNS Zones, will be the value of 49 which is 1+16+32 (or 1|16|32 in binary operation).

Name	Value
Panel Config	1
Homedir	2
Databases	4
Emails	8
Cron Jobs	16
DNS Zones	32
SSL Certificates	64
Database Users	128
FTP Accounts	256
Full Account Backup	511

Backup Structure

Name	Value	Description
Incremental	1	Incremental Backup Structure.
Archived	2	Archived Backup Structure (.tar).
Compressed	4	Compressed Backup Structure (.tar.gz).

Jb5: Restore

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

addQueueItems

This function lets you Queue Backup Items for restore. For the complete parameters available for this API call, please click HERE.

Parameter name	Type	Description	Possible values	Example
type	Integer	REQUIRED The Queue Group Type.	2: Restore Queue	`type=2`
snapshot_id	String	REQUIRED The Parent ID of the Backup.	Find the Parent ID from the Backup Object.	`snapshot_id=607f602a47fdfc271457147a`
items	List []	REQUIRED When not using the snapshot_id. List of Backup Item Object IDs you would like to add to the restore queue.	The list of Backup Item Objects can be found when using getBackupItems.	`items[]=607f602a47fdfc271457147a`
options	List []	List of options you want to execute with the Restore Queue. For boolean type options, value is set to false by default.	terminate (boolean): true \| false suspend (boolean - False by default; Only neccessary to add if you want to suspend account after restoring): true \| false merge (boolean): true \| false reseller (boolean): true \| false owner (string) package (string)	`options[terminate]=true&options[owner]=reseller1&options[package]=reseller_pkg&options[suspend]=true`
files	List []	List of files/folders paths you want to restore. This parameter is only available for file-based backups(homedir files).	Files - `files[BACKUP_ITEM_OBJECT_ID][PATH]=File` Directories - `files[BACKUP_ITEM_OBJECT_ID][PATH]=Directory`	`files[6824404b35ffe68df40bd6bf][/.ssh/known_hosts]=File` `files[6824404b35ffe68df40bd6bf][/.ssh]=Directory`

This API call returns queue group objects.

To view the parameters returned by this function, click on Queue Group Object.

Example Call JETAPI

jetbackup5api -F addQueueItems -D "type=2&snapshot_id=[$SNAPSHOT_ID]&items[]={$BACKUP_ITEM_OBJECT_ID}&options[owner]=reseller&files[$BACKUP_ITEM_OBJECT_ID][/public_html]=Directory"

success: 1
message: Items 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: 650c9c213dcf1714310f0cbc
  owner: 6503d48bfc45b1addf0a9636
  owner_name: user
  created: 2023-09-21T19:40:17+00:00
  started: 2023-09-21T19:40:17+00:00
  ended:
  type: 2
  items: 1
  items_completed: 0
  finalize:
  status: 1
  can_rerun:
  rerun_failed:
  log_id: 650c9c21fc1f3391ad0c8da2
  status_time: 2023-09-21T19:40:17+00:00
  progress:
    _id: 650c9c213dcf1714310f0cbe
    group_id: 650c9c213dcf1714310f0cbc
    item_id: 650c9c213dcf1714310f0cbd
    name:
    total: 0
    completed: 0
    subtotal: 0
    subcompleted: 0
    name_files:
    total_files: 0
    completed_files: 0
    percentage: 0
    percentage_sub: 0
    percentage_files: 0
  execution_time: 0
  actual_time: 0
  log_file: /usr/local/jetapps/var/log/jetbackup5/queue/2_650c9c213dcf1714310f0cbc.log
  log_contents:
  data:
    account: user
    priority: 100010

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=addQueueItems&type=2&snapshot_id=[$SNAPSHOT_ID]&items[]={$BACKUP_ITEM_OBJECT_ID}&options[owner]=reseller&files[$BACKUP_ITEM_OBJECT_ID][/public_html]=Directory

Jb5: Downloads

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

Parameter Dictionary

Download Object

**Download Object**
Parameter name	Type	Description	Examples
_id	String	Unique ID of the Download Object.	`_id: 60835efa26762d5a3134394e`
path	String	Name of the download file.	`path: download_1622232335_73898.tar.gz`
full_path	String	The full path where the download file is stored on the server.	`full_path: /usr/local/jetapps/usr/jetbackup5/ downloads/download_1622232335_73898.tar.gz`
size	Integer	The total size of the download file in bytes.	`size: 349034`
notes	String	Notes for the download
backup_type	Integer	The Backup Type contained in the download file.	1: Accounts Backup 2: Directory Backup 3: JB Config Backup
account	String	Name of the backup download owner.	`account: user`
account_name	String	Name of the backup download owner.	`account_name: user`
account_id	String	Unique ID of the backup download owner.	`account_id: 6009c86db68d1601154a76ff`
items	List []	List of backup items contained within the download file.	_id: The backup item ID. name: The owner of the backup item. created: The date the backup item was downloaded. backup_type: The Backup Job type. backup_contains: The Backup Item type.

Jb5: Alerts

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

Parameter Dictionary

Alert Object

Parameter name Type Description Possible Values Example

title String The unique title for the alert. Backup job "Local" completed successfully

message String The message that is sent for the alert. The backup job "Local" (#607458c5b743c715d0596752) completed successfully

find[level]

Integer

The type of alert being sent.

Information	1
Warning	2
Critical	4

created Date The corresponding date/time the alert was sent. 2021-04-19T17:17:21+00:00

owner String The owner id for the owner of the alert. 6079ab6b49bdec64d20a3833

owner_name String The name of the owner matching the owner id. root

Jb5: Queues

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

Parameter Dictionary

Queue Group Object

**Queue Group Object**
Parameter name	Type	Description	Examples
_id	String	Unique ID of the Queue Group Object.	`_id: 60835efa26762d5a3134394e`
owner	String	Unique ID of the backup owner.	`owner: 6009c86db68d1601154a76ff`
owner_name	String	Name of the backup owner.	`owner_name: user`
created	String	Date-time when the Queue Group was generated.	`created: 2021-04-23T23:57:46+00:00`
started	String	Date-time when the Queue Group started processing	`started: 2021-04-23T23:57:46+00:00`
ended	String	Date-time when the Queue Group finished processing	`ended: 2021-04-24T01:09:10+00:00`
type	Integer	Queue Type for the Queue Group Object.	1 (backup) 2 (restore) 4 (download) 8 (reindex)
items	Integer	Number of items in the Queue Group.	`type: 5`
items_completed	Integer	Number of items that has completed processing in the Queue Group.	`items_completed: 5`
finalize	boolean flag	Flags if all items in the Queue Group has been completed	1 (true) empty/null (false)
status	Integer	Status of the Queue Group process	1: Pending 2: Processing 100: Completed 101: Partially Completed 102: Failed 103: Aborted 104: Never Finished
log_id	String	Unique ID of the log associated to the Queue Group.	`log_id: 608222b9c268d2175921b412`
status_time	String	Date-time when the status was last updated	`status_time: 2021-04-23T01:28:43+00:00`
execution_time	Integer	Time it took for the Queue Group to be queued until it completes processing, in seconds.	`execution_time: 3685`
actual_time	Integer	Time it took for the Queue Group to complete processing, in seconds.	`actual_time: 3143`
log_file	String	Path of the log associated to the Queue Group.	`log_file: /usr/local/jetapps/var/log /jetbackup5/queue/2_60835e6f26762d5a3134394c.log`
data	List []	A list of corresponding data associated with the Queue Group Type.	Queue Type 1: _id (string): destination ID name (string): destination name snapshot (boolean): Backup on Demand manually (boolean): Manually executed backup Queue Type 2 & 4: account (string): account name priority (integer): account priority level Queue Type 8: _id (string): destination ID name (string): destination name

Queue Item Object

**Queue Item Object**
Parameter name	Type	Description	Possible values	Example
_id	String	Unique identifier of the queue item.		`69389137ce3f17ab4309b532`
owner	String	Owner ID associated with the task.		`693ed97b1aee4ab670057bf4`
owner_name	String	Username of the account associated with the task.		`owner1`
created	Datetime	Timestamp when the queue item was created.		`2025-12-09T21:14:31+00:00`
started	Datetime	Timestamp when the task started.		`2025-12-09T21:14:31+00:00`
ended	Datetime / null	Timestamp when the task completed. Null if still running.		`null/2025-12-09T21:15:00+00:00`
execution_time	Integer	Execution time in seconds.		`18`
type	Integer	Queue task type.	1 (Backup) 2 (Restore) 4 (Download) 8 (Reindex) 16 (Clone) 32 (Security) 64 (Integrity Check) 128 (Snapshot Delete) 256 (Extension Installation) 512 (Extension Queue)	`1`
group_id	String	ID of the queue group this item belongs to.		`64595126ce3f17ab4309b531`
priority	Integer	Queue priority value.		`50`
status	Integer	Current state of the queue item.	1 (Pending) 2 (Processing) 100 (Completed) 101 (Partially Completed) 102 (Failed) 103 (Aborted) 104 (Never Finished)	`31`
message	String	Optional message or error output.
progress_id	String	Associated progress object ID.		`69389137ce3f17ab4309b533`
progress	Object	Progress tracking object containing execution details.		`{...}`
file	String	Path to the queue log file.		`/usr/local/jetapps/var/log/jetbackup5/queue/...`
data	Object	Additional task-specific data (varies by queue type).		`{...}`

Queue Priority Object

**Queue Priority Object**
Parameter name	Type	Description	Possible values	Example
_id	String	The ID of the queue priority group.		`_id=60898b7f2ba85218685acfd9`
name	String	Queue priority group name.		`name=VIP`
tags	List []	List of Account Tag IDs that is associated to the queue priority group.		`tags[]=608b077566c0e32488215a62`
backup_priority	Integer	The backup priority level of the queue priority group.
restore_priority	Integer	The restore priority level of the queue priority group.
download_priority	Integer	The download priority level of the queue priority group.
default	Boolean	Whether the queue priority group is the default group.	1 (true) empty/null (false)

Jb5: Logs

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

Parameter Dictionary

Log Object

Parameter name Type Description Possible Values Example

_id String The Log ID. _id: 5f8a21545108792bb859b1a3

start_time Date The date and time the log was created. start_time: 2021-04-07T14:17:02+00:00

end_time Date The date and time the log was completed. end_time: 2021-04-07T14:17:02+00:00

execution_time Integer Total time (seconds) the process spent executing. 146

actual_time Integer Total time (seconds) the process spent pending in the queue AND executing. 500

info list [] Additional information for the process that was executed. Backup Job ID, Account name, etc.

status

Integer

Status of the process after completion.

Completed	1
Failed	2
Aborted	3
Partially Complete	4
Never Finished	5
Processing	6

status: 1

type

Integer

The type of log.

Backup	1
Download	2
Restore	3
System	4
Reindex	5
Backup on Demand	6

type: 2

file String The corresponding path to the log file. /usr/local/jetapps/var/ log/jetbackup5/queue/ 1_607e54187a5bf71622268560.log

items String The corresponding path to the log items file. /usr/local/jetapps/var/ log/jetbackup5/queue/ 1_607e54187a5bf71622268560.items

Log Item Object

Type Name Type Description Possible Values Examples

_id String The Log Item ID. 607e54197a5bf71622268561

owner String The ID of the owner. 606dbe8b90f1b17d0569b834

owner_name String The name of owner matching the corresponding owner ID. root

created Date The date and time the log item was created. 2021-04-20T04:10:01+00:00

started Date The date and time the log item began processing. 2021-04-20T04:10:01+00:00

ended Date The date and time the log item was completed. 2021-04-20T04:10:08+00:00

execution_time Integer Total amount of time (seconds) the Log Item spent processing. execution_time: 7

type

Integer

The type of log.

Backup	1
Download	2
Restore	3
System	4
Reindex	5
Backup on Demand	6

1

Status

Integer

Status of the process after completion.

Pending	1
Processing	2
Completed	100
Partially Complete	101
Failed	102
Aborted	103
Never Finished	104

1

Jb5: Permissions

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

Parameter Dictionary

Permissions Object

Permission	Index
Has All Privileges	0
Can Manage Accounts	1
Can Restore Backups	2
Can Download Backups	3
Can Manage Full Backups	4
Can Manage File Backups	5
Can Manage Cron Job Backups	6
Can Manage Email Account Backups	7
Can Manage Database Backups	8
Can Manage SSL Certificate Backups	9
Can Manage DNS Zone Backups	10
Can Manage Configuration Backups	11
Can Manage Backup Jobs	12
Can Manage Destinations	13
Can Manage Hooks	14
Can Manage Permissions	15
Can View Logs	16
Can Manage Logs	17
Can View Alerts	18
Can Manage Directory Backups	19
Can Manage FTP Account Backups	20
Can Manage Clone Jobs	21
Can Manage Server Backups (BMR)	22
Can Access Socket API	23

Possible Values

Permission Value	Integer Value
No	0
Yes	1
Inherit	2

Jb5: Hooks

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

Parameter Dictionary

Hook Object

Parameter name	Type	Description	Possible Values	Example
_id	String	The Hook ID.		`_id: 5f8a21545108792bb859b1a3`
name	String	The name assigned to Hook by the user.		`name: Post Backup Job Hook`
owner	String	ID of the owner of the Hook.		`owner: 606dbe8b90f1b17d0569b833`
owner_name	String	Name of the owner matching the owner ID.		`owner_name: root`
position_type	Integer	When the hook should be executed.	1 - pre 2 - post	`position_type: 1`
position	Integer	The type of Hook that will be executed.	1 - Backup 2 - Restore 3 - Restore 4 - Download 5 - Reindex 8 - Backup Account 9 - Clone 10 - Clone Account	`position: 1`
data_list	List []	List of data to pass to hook depending on position_type.	Backup - List of Backup Job IDs Restore - List of boolean value for Accounts Backup Download - List of boolean value for Accounts Backup Type Reindex - List of Destination IDs Backup Account - List of Backup Job IDs
script	String	Path the to script file.		`script: /Path/to/script.sh`
disabled	Boolean	Boolean for is the Hook is disabled.	1 - true 0 - false	`disabled: 1`

Jb5: Plugins

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

Parameter Dictionary

Plugin Object

**Plugin Object**
Parameter name	Type	Description	Examples
_id	String	ID of the Plugin.	`_id: 60903b9f6913fc54281a01`
code	String	Short name for the Plugin.	`code: S3`
name	String	The name of the Plugin.	`name: S3 Compatible`
description	String	Description of the Plugin.	`description: Generic S3 compatible destination`
icon	String	Icon data.
type	String	Type of Plugin	`type: security, notification`
version	Integer	Plugin release version.	`version: 1.0.0`
author	String	Author of the Plugin	`author: JetApps`
experimental	Boolean	True if plugin is experimental.	`experimental: 1`
repo	string	Repository ID	`repo: 608b1c707cf97c14601472e2`
repo_name	String	Repository Name	`repo_name: JetApps Repository`
package_md5sum	String	md5 checksum for the plugin package.	`package_md5sum: 88cccac198f703042502797781b`
package_url	String	Package Zip File	`package_url: jetbackup-plugin-notification-telegram-1.0.0.zip`
created	String	Date-Time the Plugin was fetched from the Repo.	`created: 2021-05-07T18:40:48+00:00`
plugin	List []	A list of corresponding data associated with an installed Plugin Ojbect.	_id (string) code (string) name (string) description (string) version (integer) type (string) author (string) permissions (integer) experimental (boolean) repo (string) options (List []) repo_name (string) disabled (boolean) visible (boolean) available_package (string)
plugin_id	String	ID of the Plugin in JetBackup.	`plugin_id: 60903b9f6913fc54281a01f2`
installed	Boolean	True if plugin is installed.	`installed: 1`
installable	Boolean	True if plugin can be installed.	`installabled: 1`
disabled	Boolean	True if plugin is disabled.	`disabled: 0`
options	List []	Array of Plugin options or settings.
available_package	Boolean	True if plugin is disabled.	`available_package: 0`

Notification Integration Object Options

**Notification Integration Object Options**
More information on installing a Notification Integration
Option Name	Description	Plugin(s)	Examples
recipients	Email addresses that the notifications will be sent to. Please use URL encoding to include special characters in the `recipients` field.	Email	`options[recipients]=example@email.com,example%2B2@email.com`
smtp	Select the Email Server (Local PHP Mailer/SMTP).	Email	`options[smtp]=0`: Local PHP Mailer `options[smtp]=1`: SMTP
smtp_from	Reply-to email address. [Required for SMTP Email Server]	Email	`options[smtp_from]=example@email.com`
smtp_host	SMTP email server hostname. [Required for SMTP Email Server]	Email	`options[smtp_host]=smtp.examplemail.com`
smtp_port	SMTP email server port. [Required for SMTP Email Server]	Email	`options[smtp_port]=25`
smtp_username	SMTP username. [Required for SMTP Email Server]	Email	`options[smtp_username]=exampleUser@email.com`
smtp_password	SMTP password. [Required for SMTP Email Server]	Email	`options[smtp_password]=examplePass`
smtp_secure	SMTP encryption protocol (None/SSL/TLS). [Required for SMTP Email Server]	Email	`options[smtp_secure]=` `options[smtp_secure]=ssl` `options[smtp_secure]=tls`
smtp_verifyssl	SSL verification on SMTP connection (Yes/No). [Required for SMTP Encryption Protocol SSL/TLS]	Email	`options[smtp_verifyssl]=0`: No `options[smtp_verifyssl]=1`: Yes
smtp_timeout	Authentication connection timeout in seconds. [Required for SMTP Email Server]	Email	`options[smtp_timeout]=15`
teams_id	Group ID.	Microsoft Teams	`options[teams_id]=1a2b3c4d-78e9-123d-abc135def123`
client_id	Client ID.	Microsoft Teams	`options[client_id]=1a2b3c4d-78e9-123d-abc135def123`
client_secret	Client secret	Microsoft Teams	`options[client_secret]=1a2b3c4d-78e9-123d-abc135def123`
tenant_id	Tenand ID	Microsoft Teams	`options[tenant_id]=1a2b3c4d-78e9-123d-abc135def123`
authorization_code	Authorization code	Microsoft Teams	`options[authorization_code] =OAAABAAAAiL9Kn2Z27UubvWFPbm0gLWQJ VzCTE9UkP3pSx1aXxUjq3n8b2JRLk4OxVXr`
channel_name	Name of channel to receive notifications on.	Microsoft Teams	`options[channel_name]=JetBackup`
channel_selection	Select channel by Channel Name/Channel ID	Slack	`options[channel_selection]=0`: Channel Name `options[channel_selection]=1`: Channel ID
channel_id	ID of Channel to receive notifications.	Slack	`options[channel_id]=ABC123DEF45`
channel	Name of channel to receive notifications on.	Slack	`options[channel]=JetBackup`
token	Bot User OAuth access token/Bot Token	Slack Telegram	`options[token]=abcd-234052363731-5439195628753-ii4q6IG7hdjN7k43K9OtqfzL`

Jb5: PanelAPI

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

Parameter Dictionary

Token Object

Parameter name	Type	Description	Examples
_id	String	The Token ID.	`_id: 61d49d24857d996e6e4e5912`
created	String	The date/time the token was created.	`created: 2022-01-04T19:16:52+00:00`
last_access	String	The date/time the token was last accessed.	`last_access: 2021-12-31T18:06:51+00:00`
expiry	String	The expiration date set for the token.
description	String	The description for the token for your internal use.	`description: My Access Token`
token	String	The API Access Token for authenticating remote API calls.	`token: Y27fBG91Mjq9rOooVTrcEB68ykksDirF`
ip	Integer	The IP the access token can be used from.	`ip: 10.10.10.10`
username	String	The account the access token can be used for. Can be root.	`username: account123`

Jb5: PluginAPI

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

Jb5: Settings

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

General Settings

getSettingsGeneral

This function prints the objects data given its Settings General Object.

manageSettingsGeneral

This function allows you to create/modify the Settings General Objects.

Performance Settings

getSettingsPerformance

This function prints the objects data given its Settings Performance Object

manageSettingsPerformance

This function allows you to create/modify the Settings Performance Object.

Resource Settings

getSettingsResource

This function prints the objects data given its Settings Resource Object.

manageSettingsResource

This function allows you to create/modify the Settings Resource Object.

Restore Settings

Please see Restore Conditions and File Permissions for their specific API calls.

getSettingsRestore

This function prints the objects data given its Settings Restore Object.

manageSettingsRestore

This function allows you to create/modify the Settings Restore Object.

Security Settings

getSettingsSecurity

This function prints the objects data given its Settings Security Object.

manageSettingsSecurity

This function allows you to create/modify the Settings Security Object.

Privacy Settings

getSettingsPrivacy

This function prints the objects data given its Settings Privacy Object.

manageSettingsPrivacy

This function allows you to create/modify the Settings Privacy Object.

Panel Settings

getSettingsPanel

This function prints the objects data given its Settings Panel Object.

manageSettingsPanel

This function allows you to create/modify the Settings Panel Object.

API Access Tokens for Linux (Panelless) are managed via the PanelAPI function. Please see the PanelAPI documentation for API Access Tokens here.

Backup on Demand Settings

getSettingsSnapshots

This function prints the objects data given its Settings Snapshots Object.

manageSettingsSnapshots

This function allows you to create/modify the Settings Snapshots Object.

Notification Settings

manageNotificationIntegration

This function allows you to create/modify the Notification Integration Object.

listNotificationIntegrationTypes

This function will list all available Notification Integration Types.

listNotificationIntegrations

This function will list all Enabled Notification Integration.

getNotificationIntegration

This function will return the Enabled Notification Integration based on Type.

deleteNotificationIntegration

This function will delete the Enabled Notification Integration based on Type.

Binary Settings

getSettingsBinary

This function prints the objects data given its Settings Binary Object.

manageSettingsBinary

This function allows you to create/modify the Settings Binary Object.

WordPress Extension Settings

getSettingsExtension

This function allows you to view the parameters for the Settings Extension Object.

manageSettingsExtension

This function allows you to create/modify the Settings Extension Object.

runExtensionDeployment

This function allows you to manually run the extension deployment on enabled WordPress Integration vendors.

Jb5: RestoreConditions

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

Parameter Dictionary

Restore Condition Object

Parameter name	Type	Description	Possible Values	Example
_id	String	The Restore Condition ID.		`_id: 5b28f9f4d5ac5e5ed5049f82`
condition	String			`condition: Are you sure?`
disabled	Boolean	Boolean value to determine if the Restore Condition is disabled.	1 - true 0 - false	`disabled: 0`

Jb5: FilePermissions

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

Parameter Dictionary

Account Filter Object

Parameter name Type Description Possible Values Example

_id String The Parameters Filter Object ID. _id: 5b28f9f4d5ac5e5ed5049f82

regex String The regex for the File/Folder name you want the rule to apply to. regex: public_html

Jb5: Common

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

JetBackup API Parameters

jetbackup5api backup -F listBackups -D "type=127" -O json

Part	Description
Function	The JetBackup API function. -F/--func FUNCTION_NAME
Data	The parameters you want to pass to the API call. -D/--data "PARAM_NAME=PARAM_VALUE&...&PARAM_NAME=PARAM_VALUE"
Output format	The output format you want the API call to be returned as. -O/--output json/plain

For more information about jetapi, run the following command:

jetbackup5api --help

List Parameters

These are the available parameters you can pass to all the list API calls.

Parameter name	Type	Description	Possible values	Example
limit	Integer	Limit the specified number of records returned.		10
skip	Integer	Skip the specified number of records returned.		2
sort[]	List	The value you want to sort by.	1 : ascending order -1 : descending order	sort[type]=1

How To Retrieve API Keys/Tokens

cPanel

To create an API token in cPanel, use WHM’s Manage API Tokens interface (WHM > Home > Development > Manage API Tokens).

Click on the ‘Generate Token’ button.
Enter the token name.
Choose the privileges you would like to provision for your script(s).
Make sure to check the ‘Third Party Services Additional Software - JetBackup software-JetBackup’.
Hit the ‘save’ button.
Copy the token generated and store in a safe place.

For more information about cPanel API tokens, click here.

DirectAdmin

To create an API Login Key in DirectAdmin, use WCP’s Login Keys interface (WCP > User Level > Login Keys).

Click on the “CREATE” Login Key button
Enter the Key Name.
Specify a Key Value, or use the random button for a longer value.
Choose the Commands you would like to provision for your script(s).
Hit the ‘CREATE’ button.
Copy the key generated and store in a safe place.

For more information about DirectAdmin API Login Keys, click here.

Once your key/token is generated, include that API key/token in your custom code.

Linux

To create an API Access Token in Linux (Standalone) servers, navigate to JB5 > Settings > Panel:

Click on the “Create new Access Token”
Enter description, IP Address, and assign the Account(s) that will be allowed access to the API. Leaving this field empty will allow all users to access using the access token.
Copy the token generated and store in a safe place.

For more infomration about JetBackup Linux Access Tokens, click here

Plesk

To create an API Key in Plesk, use the secret_key utility.

Run the following command and replace the $IP_ADDRESS field with your server IP address:
- plesk bin secret_key -c -ip-address {$IP_ADDRESS}
You should receive a key in the output:
- 4897e11f-d053-0f83-1ac0-38b3822cfba8
Copy the API key and store it in a safe place.

Alternatively, you may create an API key in Plesk by sending a POST request:

Create an API key. Replace root:password with your user credentials and $IP_ADDRESS with your Plesk server IP address.
- curl -X POST --user root:password -H "Content-Type: application/json" -H "Accept: application/json" -d'{}' "https://{$IP_ADDRESS}:8443/api/v2/auth/keys"
This should output the key.
- {"key":"4897e11f-d053-0f83-1ac0-38b3822cfba8"}
Copy the API key and store it in a safe place.

For more information about Plesk API Keys, click here