Accounts

manageAccount

This function lets you manage the account's JetBackup settings.

**Parameters**
Parameter name	Type	Description	Example
_id	String	REQUIRED ID of the account	`_id=6126745fb3086938ff643643`
email	String	The email used to notify the user after each user-initiated processes.
backup_quota	Boolean	Whether backup quota is enabled on the specified account.	`email=user@email.com`
max_snapshots	Integer	The maximum snapshots allowed to create for the specified account.	`max_snapshots=5`
queue_priority	String	The ID of the queue priority to assign to the specified account.	`queue_priority=1`
tags	List []	List of Tag IDs to assign to the account	tags[0]=64ee8eda75b29219cf697a82&tags[0]=64ee8ee3a4a9571ea9256162 (Remove Tags): tags=

Returns standard API Response data.

Example Call JETAPI

jetbackup5api -F manageAccount -D "_id={$ACCOUNT_ID}&email={$EMAIL}&max_snapshots={$VALUE}"

success: 1
message: Account 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:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageAccount&_id={$ACCOUNT_ID}&email={$EMAIL}&max_snapshots={$VALUE}

getAccount

This function returns account settings and information by account ID.

More Info

Parameter name	Value	Description	Possible values	Example
_id	String	REQUIRED The Account ID.		`_id=6126745fb3086938ff643643`

This API call returns account object.

To view the parameters returned by this function, click on Account Object

Example Call JETAPI

jetbackup5api -F getAccount -D "_id={$ACOUNT_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: 6503e4ac6ea9d447360a963c
        uuid: 6fa109eba9dae3a36094e44674053f541bf9d89d
        username: user
        nickname:
        created: 2023-09-15T04:59:24+00:00
        domain: user.com
        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:
        max_snapshots: -1
        backup_quota:
        backup_stats:
                511: 0
                1: 0
                2: 0
                4: 0
                128: 0
                256: 0
                8: 0
                16: 0
                32: 0
                64: 0
        tags:
        backup_type: 0
        encryption_key_type: 0
        privacy: 0
        queue_priority:
        last_active:
        secret_key:
        assignable_accounts: 1
        quota:
                disk_total: -1
                disk_usage: 1048576
                disk_free: -1
                inode_usage: 78

Example Call HTTP

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

listAccounts

This function returns list of all accounts.

More Info

**Parameters**
Parameter name	Value	Description	Possible values	Example
orphan	Boolean	Whether to list orphan accounts (account backups with no associated active accounts)		`orphan=1`

**Returns**
Parameter name	Value	Description	Possible values	Example
accounts[]	List	Return List of account objects.	To view the parameters returned by this function, click on Account Object
total	Integer	The total amount of accounts you have.

Example Call JETAPI

jetbackup5api -F listAccounts -D "orphan=1"

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:
        _id: 6503d48bfc45b1addf0a9633
        uuid: a0e78ee09b83e4d9b4c85a17e00b9150fe492cf7
        username: user
        nickname:
        created: 2023-09-15T03:50:35+00:00
        domain: user.com
        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:
        max_snapshots: -1
        backup_quota:
        backup_stats:
                511: 0
                1: 0
                2: 0
                4: 0
                128: 0
                256: 0
                8: 0
                16: 0
                32: 0
                64: 0
        tags:
        backup_type: 0
        encryption_key_type: 0
        privacy: 0
        queue_priority:
        last_active:
        secret_key:
        assignable_accounts: 0
        quota:
                disk_total: -1
                disk_usage: 83886080
                disk_free: -1
                inode_usage: 3834

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listAccounts&orphan=1

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

listTags

This function returns list of all tags.

More Info

**Returns**
Parameter name	Value	Description	Possible values	Example
tags[]	List	Return List of tag objects.	Object index position: _id name type color owner owner_name
total	Integer	The total amount of tags you have.

Example Call JETAPI

jetbackup5api -F listTags

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:
tags:
        0:
        _id: 650a20777ec4f15894071cb2
        name: tag
        type: 1
        color: #3e3c3e
        owner: 6503d48bfc45b1addf0a9632
        owner_name: root

Example Call HTTP

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

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

reassignAccount

This functions reassigns the account given the Assignable ID.

More Info

**Parameters**
Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED: The _id found from Assignable Accounts.		`_id=5fb471c95159b9583c1cb914`

Example Call JETAPI

jetbackup5api -F reassignAccount -D "_id={$ASSIGNABLE_ACCOUNT_ID}"

success: 1
message: Account assigned 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:
accounts:

Example Call HTTP

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

listAssignableAccounts

This function returns the list of Assignable IDs for a given username.

More Info

To view available listing parameters, please visit List Parameters.

**Parameters**
Parameter name	Type	Description	Possible values	Example
account	String	REQUIRED: Username of the account you wish to reassign.		`account=username`

**Returns**
Parameter name	Type	Description	Possible values	Examples
accounts	List []	The list of assignable accounts to the given username.
total	Integer	Total number of assignable accounts for the given username.		3

Example Call JETAPI

jetbackup5api -F listAssignableAccounts -D "account={$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:
data:
accounts:
        0:
        _id: 6503d48bfc45b1addf0a9634
        uuid: 0d04a5eaa0253ec3c2f6f3c09593a326ff4cc468
        active:
        last_active: 2023-09-15T05:02:30+00:00
        created: 2023-09-15T03:50:35+00:00
        total_backups: 0

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listAssignableAccounts&account=username

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

createBackupOnDemand

This function allows you to manually create a backup to the destination assigned in Backup on Demand settings.

More Info

**Parameters**
Parameter name	Type	Description	Possible values	Example
account_id	String	REQUIRED: ID of the account you wish to backup on demand.		`_id=5fc96deeac61ab0bc3020323`

Returns standard API Response data.

jetbackup5api -F createBackupOnDemand -D "account_id={$ACCOUNT_ID}"

success: 1
message: Backup on demand 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=createBackupOnDemand&account_id={$ACCOUNT_ID}

manageAccountExcludeList

This function allows you to set Account Specific Exclude Lists for All/Specific Backup Jobs.

More Info

**Parameters**
Parameter name	Type	Description	Possible values	Example
_id	String	REQUIRED ID of the account.		`_id=5fc96deeac61ab0bc3020323`
excludes	List []	REQUIRED List of all Backup Job IDs to apply an exclude list.	Every account has a 'global' id that will apply the exclude list to all Backup Jobs.	excludes[global][]=trash/&excludes[60898b7f0510b07a0833d138][]=public_html/

Example Call JETAPI

jetbackup5api -F manageAccountExcludeList -D "_id={$ACCOUNT_ID}&excludes[global][]=trash/*&excludes[$BACKUP_JOB_ID][]=public_html/*"

success: 1
message: Account Backup Jobs Exclude List updated/created successfully
system:
version: 5.3.4
version_panel: 5.3.4
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
global:
        0: trash/*
6503e8275054a26ac301ef02:
        0: public_html/*
6504c79fd4b57d536c05bbe2:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageAccountExcludeList&_id={$ACCOUNT_ID}&excludes[global][]=trash/*&excludes[$BACKUP_JOB_ID][]=public_html/*

getAccountExcludeList

This function returns the Account Specific Exclude Lists.

More Info

Parameter name	Value	Description	Possible values	Example
_id	String	REQUIRED The Account ID.		`_id=5fc96deeac61ab0bc3020323`

This API call returns the Account Exclude List Object

Example Call JETAPI

jetbackup5api -F getAccountExcludeList -D "_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:
global:
        0: trash/*
6503e8275054a26ac301ef02:
        0: public_html/*
6504c79fd4b57d536c05bbe2:

Example Call HTTP

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

listAccountPackages

This function returns a list of User or Reseller Packages on the Panel.

More Info

To view available listing parameters, please visit List Parameters.

**Parameters**
Parameter name	Type	Description	Possible values	Example
type	Integer	List User Packages or Reseller Packages. NOTE: Implementation varies by Panel.	1 (User Packages), 2 (Reseller Packages)	`type=1`
all	Boolean	List all package types when true.	1, 0	`all=1`

**Returns**
Parameter name	Type	Description	Possible values	Examples
items	List []	The list of user and/or reseller packages.
total	Integer	Total number of user and/or reseller packages.		20

Example Call JETAPI

jetbackup5api -F listAccountPackages -D 'type=1&all=1'

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:
packages:
        0:
        name: Default Domain
        type: 1

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listAccountPackages&all=1

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

deleteAccountSnapshots

This function allows you to delete all snapshots from the specified user.

More Info

Parameters

Parameter name Type Description Example

approve Boolean Gives permission for the API command to delete snapshots approve=true

user String REQUIRED: ID of the user to delete their snapshots. If no other parameters are set, then all the user's snapshots are removed. user=6503d48bfc45b1addf0a9635

range_start (v5.3.10+) String - Format: 20yy-mm-ddThh:mm Removes snapshots generated on the set date/time and after range_start=2024-01-01T13:00

range_end (v5.3.10+) String - Format: 20yy-mm-ddThh:mm Removes snapshots generated on the set date/time and before range_end=2024-01-01T13:00

job (v5.3.12+) String Removes snapshots generated by the specified backup job job=663161b82b562fb74905b922

destination (v5.3.12+) String Removes snapshots generated on the specified destination destination=664a4a343068fb2dd6053582

**Parameters**
Parameter name	Type	Description	Example
approve	Boolean	Gives permission for the API command to delete snapshots	`approve=true`
user	String	REQUIRED: ID of the user to delete their snapshots. If no other parameters are set, then all the user's snapshots are removed.	`user=6503d48bfc45b1addf0a9635`
range_start (v5.3.10+)	String - Format: 20yy-mm-ddThh:mm	Removes snapshots generated on the set date/time and after	`range_start=2024-01-01T13:00`
range_end (v5.3.10+)	String - Format: 20yy-mm-ddThh:mm	Removes snapshots generated on the set date/time and before	`range_end=2024-01-01T13:00`
job (v5.3.12+)	String	Removes snapshots generated by the specified backup job	`job=663161b82b562fb74905b922`
destination (v5.3.12+)	String	Removes snapshots generated on the specified destination	`destination=664a4a343068fb2dd6053582`

Doesn't return any data.

Example Call JETAPI

jetbackup5api -F deleteAccountSnapshots -D "user={$ACCOUNT_ID}&range_start=2024-01-01T13:00&range_end=2024-01-20T18:00&destination={$DESTINAION_ID}&job={$BACKUP_JOB_ID}&approve=true"

success: 1
message: User snapshots marked for delete 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=deleteAccountSnapshots&_id={$ACCOUNT_ID}&range_start=2024-01-01T13:00&range_end=2024-01-20T18:00&destination={$DESTINAION_ID}&job={$BACKUP_JOB_ID}&aprrove=yes}

Parameter Dictionary

Account Object

**Account Object**
Parameter name	Type	Description	Examples
_id	String	ID of the account.	5fb4a0fa08994c637c6ada5b
UUID	String	Unique ID used for "Reassigning Accounts"	5d2c807e4e878add6c32b6f3f57af220dd1713bf
username	String	REQUIRED The username of the account.	user
domain	String	Domain assigned to the account.	www.acctname.com
owner	String	Name of the owner of the account.	root/admin/RESELLER
owner_id	String	Unique ID given to the owner.	5fb471c95159b9583c1cb913
homedir	String	Absolute path to account public_html.	/home/acctname
ip	String	IP given to the account.	111.111.1.11
package	String	Name of the package assigned to account.	default
packages	List []	All packages owned by the account.
root	Boolean	True if account is root.	1
reseller	Boolean	True if account is a reseller.	1
suspended	Boolean	True if account is suspended.	1
login_only	Boolean	True if acount is login_only.	1
active	Boolean	True if account is active.	1
email	String	The email used to notify the user after each user-initiated processes.
backup_quota	Boolean	Whether backup quota is enabled on the specified account.
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.	0
encryption_key_type	Integer	Type used for the encryption backups.	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.

JETAPI Documentation

On This Page:

Accounts

manageAccount

getAccount

listAccounts

reassignAccount

listAssignableAccounts

createBackupOnDemand

manageAccountExcludeList

getAccountExcludeList

listAccountPackages

deleteAccountSnapshots

Parameter Dictionary

Account Object

On This Page: