Backups

listBackups

This function will list all Backups given the Backup Type/Backup Contains/Account ID (optional).

To view available listing parameters, please visit List Parameters.

**Parameters**
Parameter name	Type	Description	Possible Values	Example
type	Integer	REQUIRED The Backup Type.	1 : Accounts 2 : Directories 3 : JB Config	`type=1`
contains	Integer	REQUIRED Integer value indicating the Backup Object Contains.	Please see the Backup Contains below for a all available contains values.	`contains=511`
account_id	String	REQUIRED Only for Backup Type Accounts. The Account ID whose backups you want to list. To list directory backups, you will replace the Account ID with the Backup Job ID.	See listAccounts to find the account_id. See listBackupJobs to find the Backup Job ID.	`account_id=60898b7f0510b07a0833d136`

Example Call JETAPI

jetbackup5api -F listBackups -D "type=1&contains=511&account_id={$ACCOUNT_ID}"
jetbackup5api -F listBackups -D "type=2&contains=3&account_id={$BACKUP_JOB_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:
backups:
        0:
        _id: 6503f05fedc7b9f4520a967a
        parent_id: 6503ef22edc7b9f4520a9643
        account_id: 6503d48bfc45b1addf0a9636
        destination: 6503eec8ebbf07708d06f1d2
        destination_name: s3
        name: user
        created: 2023-09-15T05:44:02+00:00
        path:
        backup_type: 1
        backup_contains: 511
        account: user
        account_data:
                _id: 6503d48bfc45b1addf0a9636
                username: user
                owner: root
                owner_id: 6503d48bfc45b1addf0a9632
                package: default
                suspended:
                reseller:
                root:
        size: 7813234243
        params:
        backup_structure: 1
        notes:
        location:
        safety:
        deleted:
        lock:
        lock_ttl:
        damaged:
        disabled:
        schedules:
                0: 8
        hidden:
        encrypted:
        encryption_id:
        encryption_key_required:
        encryption_key_exists: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listBackups&type=1&contains=511&account_id={$ACCOUNT_ID}

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

listBackupForAccounts

This function will list all Accounts with their most recent Backup based on given filters. See below for the filters you may pass.

More Info

To view available listing parameters, please visit List Parameters.

**Parameters**
Parameter name	Type	Description	Possible Values	Example
type	Integer	REQUIRED The Backup Type.	1 : Accounts 2 : Directories 3 : JB Config	`type=1`
contains	Integer	REQUIRED Integer value indicating the contains.	Please see the Backup Contains below for a all available contains values.	`contains=511`

Returns

Parameter name

Type

Description

Data

accounts

List []

List of all Accounts and their selected backup.

Key	Type	Description
account_id	String	The Account ID of the Account being listed.
account	String	The name matching the Account ID.
backup	Backup Object	The most recent backup object for the given account.
total_backups	Integer	The total number of backups the given account has available.

Example Call JETAPI

jetbackup5api -F listBackupForAccounts -D "type=1&contains=511&account_id={$ACCOUNT_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:
accounts:
0:
        account_id: 6503d48bfc45b1addf0a9636
        account: user
        backup:
                _id: 6504e935bad4bea7340c75ea
                parent_id: 6504e6cabad4bea7340c75d3
                account_id: 6503d48bfc45b1addf0a9636
                destination: 6503eec8ebbf07708d06f1d2
                destination_name: s3
                name: user
                created: 2023-09-15T23:20:42+00:00
                path: config
                backup_type: 1
                backup_contains: 1
                account: user
                account_data:
                _id: 6503d48bfc45b1addf0a9636
                username: user
                owner: root
                owner_id: 6503d48bfc45b1addf0a9632
                package: default
                suspended:
                reseller:
                root:
                size: 81069
                params:
                backup_structure: 1
                notes:
                location:
                safety:
                deleted:
                lock:
                lock_ttl:
                damaged:
                disabled:
                schedules:
                0: 8
                hidden:
                encrypted:
                encryption_id:
                encryption_key_required:
                encryption_key_exists: 1
        total_backups: 3

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listBackupForAccounts&type=1&contains=511&account_id={$ACCOUNT_ID}

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

listBackupForType

This function will list the most recent Backup for an account matching the given Backup Type/Contains.

More Info

To view available listing parameters, please visit List Parameters.

**Parameters**
Parameter name	Type	Description	Possible Values	Example
type	Integer	REQUIRED The Backup Type.	1 : Accounts 2 : Directories 3 : JB Config	`type=1`
contains	Integer	REQUIRED Integer value indicating the contains.	Please see the Backup Contains below for a all available contains values.	`contains=511`
account_id	String	REQUIRED Only for Backup Type Accounts. The Account ID whose backups you want to list.	See listAccounts to find the account_id.	`account_id=60898b7f0510b07a0833d136`

Example Call JETAPI

jetbackup5api -F listBackupForType -D "type=1&contains=511&account_id={$ACCOUNT_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:
accounts:data:
backups:
        0:
        _id: 6504e935bad4bea7340c760a
        parent_id: 6504e6cabad4bea7340c75d3
        account_id: 6503d48bfc45b1addf0a9636
        destination: 6503eec8ebbf07708d06f1d2
        destination_name: s3
        name: user
        created: 2023-09-15T23:20:42+00:00
        path:
        backup_type: 1
        backup_contains: 511
        account: user
        account_data:
                _id: 6503d48bfc45b1addf0a9636
                username: user
                owner: root
                owner_id: 6503d48bfc45b1addf0a9632
                package: default
                suspended:
                reseller:
                root:
        size: 7813234004
        params:
        backup_structure: 1
        notes:
        location:
        safety:
        deleted:
        lock:
        lock_ttl:
        damaged:
        disabled:
        schedules:
                0: 8
        hidden:
        encrypted:
        encryption_id:
        encryption_key_required:
        encryption_key_exists: 1
        total: 3
total: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listBackupForType&type=1&contains=511&account_id={$ACCOUNT_ID}

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

listBackupForTypeName

This function will list all Backups for an account matching the given Backup Type/Contains.

More Info

To view available listing parameters, please visit List Parameters.

**Parameters**
Parameter name	Type	Description	Possible Values	Example
type	Integer	REQUIRED The Backup Type.	1 : Accounts 2 : Directories 3 : JB Config	`type=1`
contains	Integer	REQUIRED Integer value indicating the contains.	Please see the Backup Contains below for a all available contains values.	`contains=511`
account_id	String	REQUIRED Only for Backup Type Accounts. The Account ID whose backups you want to list.	See listAccounts to find the account_id.	`account_id=60898b7f0510b07a0833d136`
name	String	REQUIRED The name of the account matching the Account ID above.		`name=accountName`

**Returns**
Parameter name	Type	Description	Data
Backups	List []	List of all Backup Objects for the given account based on Backup type/contains.	See Backup Object below for see all data.

Example Call JETAPI

jetbackup5api -F listBackupForTypeName -D "type=1&contains=511&account_id={$ACCOUNT_ID}&name={$USERNAME}"

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:
accounts:
backups:
        0:
        _id: 6503f05fedc7b9f4520a967a
        parent_id: 6503ef22edc7b9f4520a9643
        account_id: 6503d48bfc45b1addf0a9636
        destination: 6503eec8ebbf07708d06f1d2
        destination_name: s3
        name: user
        created: 2023-09-15T05:44:02+00:00
        path:
        backup_type: 1
        backup_contains: 511
        account: user
        account_data:
                _id: 6503d48bfc45b1addf0a9636
                username: user
                owner: root
                owner_id: 6503d48bfc45b1addf0a9632
                package: default
                suspended:
                reseller:
                root:
        size: 7813234243
        params:
        backup_structure: 1
        notes:
        location:
        safety:
        deleted:
        lock:
        lock_ttl:
        damaged:
        disabled:
        schedules:
                0: 8
        hidden:
        encrypted:
        encryption_id:
        encryption_key_required:
        encryption_key_exists: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listBackupForTypeName&type=1&contains=511&account_id={$ACCOUNT_ID}&name={$USERNAME}

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

listAccountsByFilters

This function will list a single Backup for account(s) matching the given Filters.

More Info

Parameters

Parameter name Type Description Possible values Example

filters[] Optional Include a Filters list to return account backup matching the specified criteria. Filter Options are detailed below and passed as filters[parameter]=

accounts List [] Return only the specified account(s). filters[accounts][0]=account123&filters[accounts][1]=account234

date_start, date_end String Include Backups after or before the specified date/time in ISO-8601 format. filters[date_start]=2022-07-31T17:00:18.484Z&filters[date_end]=2022-08-16T04:55:18.433Z

destination String Only include Backups on the destination ID specified. filters[destination]=62e968a582ff8e55e86b2642

backup_structure Integer The backup structure. For more information, see Backup Structure 1, 2, 4 filters[backup_structure]=1`

backup_contains Integer The backup contains integer value. For more information, see Backup Contains filters[backup_contains]=511

owned_by String Return accounts owned by the reseller. filters[owned_by]=root

tags String Return accounts with the specified account tag. filters[tags]=Tag1

account_status Integer Filter by the account active status.

0 (Any)

1 (Only Active)

2 (Only Orphan)

filters[account_status]=0

account_suspended Integer Filter by account suspension status.

0 (Any)

1 (Unsuspended)

2 (Suspended)

filters[account_suspended]=0

locked Integer Return locked backups.

0 (Any)

1 (Encrypted)

2 (Unencrypted)

filters[locked]=1

encrypted Integer Return encrypted backups.

0 (Any)

1 (Encrypted)

2 (Unencrypted)

filters[encrypted]=1

show_oldest Boolean Set to true to return the oldest backup. Default is to return the newest backup.

0 (Sort by Newest)

1 (Sort by Oldest)

filters[show_oldest]=0

Parameter name	Type	Description	Possible values	Example
filters[]		Optional Include a Filters list to return account backup matching the specified criteria. Filter Options are detailed below and passed as `filters[parameter]=`
accounts	List []	Return only the specified account(s).		`filters[accounts][0]=account123&filters[accounts][1]=account234`
date_start, date_end	String	Include Backups after or before the specified date/time in ISO-8601 format.		`filters[date_start]=2022-07-31T17:00:18.484Z&filters[date_end]=2022-08-16T04:55:18.433Z`
destination	String	Only include Backups on the destination ID specified.		`filters[destination]=62e968a582ff8e55e86b2642`
backup_structure	Integer	The backup structure. For more information, see Backup Structure	1, 2, 4	filters[backup_structure]=1`
backup_contains	Integer	The backup contains integer value. For more information, see Backup Contains		`filters[backup_contains]=511`
owned_by	String	Return accounts owned by the reseller.		`filters[owned_by]=root`
tags	String	Return accounts with the specified account tag.		`filters[tags]=Tag1`
account_status	Integer	Filter by the account active status.	0 (Any) 1 (Only Active) 2 (Only Orphan)	`filters[account_status]=0`
account_suspended	Integer	Filter by account suspension status.	0 (Any) 1 (Unsuspended) 2 (Suspended)	`filters[account_suspended]=0`
locked	Integer	Return locked backups.	0 (Any) 1 (Encrypted) 2 (Unencrypted)	`filters[locked]=1`
encrypted	Integer	Return encrypted backups.	0 (Any) 1 (Encrypted) 2 (Unencrypted)	`filters[encrypted]=1`
show_oldest	Boolean	Set to true to return the oldest backup. Default is to return the newest backup.	0 (Sort by Newest) 1 (Sort by Oldest)	`filters[show_oldest]=0`

Response

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 listAccountsByFilters -D "filters[account_status]=2&filters[account_suspended]=0&filters[locked]=0&filters[backup_structure]=0&filters[show_oldest]=0"

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:
  accounts:
    0:
      account:
        _id: 6503d48bfc45b1addf0a9636
        uuid: 8525c64376e64e77771c2ffbb103a4fe129a7cc9
        username: user
        nickname:
        created: 2023-09-15T03:50:35+00:00
        domain:
        owner: root
        owner_id: 6503d48bfc45b1addf0a9632
        owner_nickname: root
        owners:
          0: root
        owners_id:
          0: 6503d48bfc45b1addf0a9632
        homedir: /home/user
        ip:
        package: default
        packages:
        root:
        reseller:
        suspended:
        login_only:
        orphan:
        active: 1
        virtual:
        email: [email protected]
        max_snapshots: 5
        backup_quota:
        backup_stats:
          511: 4
          1: 5
          2: 5
          4: 16
          128: 60
          256: 15
          8: 4
          16: 4
          32: 25
          64: 20
        tags:
        backup_type: 0
        encryption_key_type: 0
        privacy: 0
        queue_priority: 6503d489d31a5adeec0952f1
        last_active:
        secret_key:
        assignable_accounts: 0
        quota:
          disk_total: -1
          disk_usage: 7854882816
          disk_free: -1
          inode_usage: 9665
      snapshot:
        name: snap.1
        created: 2023-09-21T19:12:51+00:00
        path: jetbackup_1_1_6504c79fd4b57d536c05bbe2/user_6503d48bfc45b1addf0a9636
        destination: 6503eec8ebbf07708d06f1d2
        backup_type: 1
        backup_contains: 511
        backup_structure: 1
        account: user
        account_id: 6503d48bfc45b1addf0a9636
        account_active: 1
        account_orphan:
        account_data:
          _id: 6503d48bfc45b1addf0a9636
          username: user
          owner: root
          owner_id: 6503d48bfc45b1addf0a9632
          package: default
          suspended:
          reseller:
          root:
        safety:
        location:
        temp_snap:
        deleted:
        damaged:
        lock:
        lock_ttl:
        encrypted:
        hidden:
        notes:
        size: 0
        schedule_type:
          0: 8

Example Call HTTP

https://HOST_NAME:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listAccountsByFilters&filters[account_status]=2&filters[account_suspended]=0&filters[locked]=0&filters[backup_structure]=0&filters[show_oldest]=0

getBackupItems

This function will list all Backup Items that are generated for an Account Backup.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The parent_id of the Backup Items Objects.	Use the listBackup* calls above to see the parent_id.	`_id=60b164043c2bb904123c2aa5`

**Returns**
Parameter name	Type	Description	Data
Backups	List []	List of all Backup Items Objects that belong to the parent_id.	See Backup Object below to see all available data.

Example Call JETAPI

jetbackup5api -F getBackupItems -D "_id={$PARENT_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:
0:
        _id: 6503f05fedc7b9f4520a9679
        parent_id: 6503ef22edc7b9f4520a9643
        account_id: 6503d48bfc45b1addf0a9636
        destination: 6503eec8ebbf07708d06f1d2
        destination_name: s3
        name:
        created: 2023-09-15T05:44:02+00:00
        path:
        backup_type: 1
        backup_contains: 256
        account: user
        account_data:
                _id: 6503d48bfc45b1addf0a9636
                username: user
                owner: root
                owner_id: 6503d48bfc45b1addf0a9632
                package: default
                suspended:
                reseller:
                root:
        size: 186
        params:
        backup_structure: 1
        notes:
        location:
        safety:
        deleted:
        lock:
        lock_ttl:
        damaged:
        disabled:
        schedules:
                0: 8
        hidden:
        encrypted:
        encryption_id:
        encryption_key_required:
        encryption_key_exists: 1

Example Call HTTP

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

getBackupItem

This function will return the specified Backup Item Data.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Backup Item ID.	Use the getBackupItems calls above to see the Backup Item ID.	`_id=60b164083c2bb904123c2aa6`

**Returns**
Parameter name	Type	Description	Data
data	Backup Object	The Backup Object corresponding to the given Backup Item ID.	See Backup Object below to see all available data.

Example Call JETAPI

jetbackup5api -F getBackupItem -D "_id={$BACKUP_ITEM_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: 6503f05fedc7b9f4520a9679
parent_id: 6503ef22edc7b9f4520a9643
account_id: 6503d48bfc45b1addf0a9636
destination: 6503eec8ebbf07708d06f1d2
destination_name: s3
name:
created: 2023-09-15T05:44:02+00:00
path:
backup_type: 1
backup_contains: 256
account: user
account_data:
        _id: 6503d48bfc45b1addf0a9636
        username: user
        owner: root
        owner_id: 6503d48bfc45b1addf0a9632
        package: default
        suspended:
        reseller:
        root:
size: 186
params:
backup_structure: 1
notes:
location:
safety:
deleted:
lock:
lock_ttl:
damaged:
disabled:
schedules:
        0: 8
hidden:
encrypted:
encryption_id:
encryption_key_required:
encryption_key_exists: 1

Example Call HTTP

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

manageBackupLock

This function allows you to modify the Backup Lock Status

More Info

**parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Backup Parent ID.	N/A	`_id=64b057bfafcd2a57410d4d2b`
locked	String	Integer value indicating lock status	Empty or 0: unlocked 1: locked	locked="" locked=1
lock_ttl	String	The Locked Backup TTL	Empty or 0: Unlimited	`lock_ttl=10`

Example Call JETAPI

jetbackup5api -F manageBackupLock -D "_id={$PARENT_ID}&locked=1&lock_ttl=10"

success: 1
message: Backup locked 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=manageBackupLock&_id={$PARENT_ID}&locked=1&lock_ttl=10

Parameter Dictionary

Backup Object

Key	Type	Description
_id	String	The Backup Object ID.
parent_id	String	The Backup ID that encompasses multiple Backup Objects.
account_id	String	The Account ID that the Backup Object was generated for.
destination	String	The Destination ID that the Backup Object exists on.
destination_name	String	The name of the Destination matching the Destination ID.
name	String	The name of the Account matching the Account ID.
created	ISODate	The date the Backup Object was generated.
path	String	The path where the Backup Item exists.
backup_type	Integer	The Backup Type this object was given. See below for the full list of types.
backup_contains	Integer	The Backup Contains value. See below for the full list of contains.
account	String	The name of the Account.
account_data	Account Object	Data from the Account Object.
size	Integer	Size of the Backup Object in Bytes.
backup_structure	Integer	The value indicating the Backup Object's Backup Structure. See below for the list of Backup Structures.
notes	String	Notes added to the Backup Object manually.
lock	Boolean	Value to indicate if the Backup Object is Locked.
lock_ttl	Integer	The number of days a Backup Object will be locked.
damaged	Boolean	Value to indicate if the Backup Object is corrupted.
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.
encrypted	Boolean	Value to indicate if the Backup Object is encrypted.
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).

JETAPI Documentation

On This Page:

Backups

listBackups

listBackupForAccounts

listBackupForType

listBackupForTypeName

listAccountsByFilters

getBackupItems

getBackupItem

manageBackupLock

Parameter Dictionary

Backup Object

Backup Types

Backup Contains

Backup Structure

On This Page: