– Accounts

Jb5: manageAccount

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

Parameters

Parameter name	Type	Description	Example
_id	String	REQUIRED The Account ID.	`_id=6126745fb3086938ff643643`
email	String	The email used to notify the user after each user-initiated processes.
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}

Jb5: manageTag

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

Parameters

Parameter name	Type	Description	Possible values	Example
action	String	REQUIRED Flag to either create or modify the tag.	`create/modify`	`action=create`
_id	String	The tag ID. REQUIRED when modifying the tag.		`_id=6126745fb3086938ff643643`
type	boolean	The tag type. REQUIRED when creating the tag.	`1`	`type=1`
name	boolean	The tag name. REQUIRED when creating the tag.		`name=example1`
color	boolean	The tag color. REQUIRED when creating the tag.	Hexadecimal color value: `#RRGGBB`	`color=#7e2572`

Returns standard API Response data.

Example Call JETAPI

jetbackup5api -F manageTag -D "action=modify&_id={$TAG_ID}&name={$NAME}&color={$COLOR}"
jetbackup5api -F manageTag -D "action=create&name={$NAME}&color={$COLOR}&type=1"

success: 1
message: Tag Created/Updated Successfully
system:
  version: 5.3.14.4
  version_panel: 5.3.14.4
  tier: RELEASE
  type: cPanel
  retry_ms: 0
  disableui:
  dr:
  agreement_panel:
  agreement:
  licenseIssue:
data:
  _id: 67758a1170af6de0e006a8d2
  name: example1
  type: 1
  color: #7e2572
  owner: 675233ebeecc0e19bb0f5412
  owner_name: root

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageTag&action=modify&_id={$TAG_ID}&name={$NAME}&color={$COLOR}
https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageTag&action=create&name={$NAME}&color={$COLOR}&type=1

Jb5: getAccount

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

Parameter name	Type	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={$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:
        _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={$ACCOUNT_ID}

Jb5: listAccounts

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

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

Parameter name	Type	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.

Jb5: listTags

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

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

Jb5: reassignAccount

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

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}

Jb5: reassignAccountMulti

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

Example Call JETAPI

jetbackup5api -F reassignAccountMulti

success: 1
message: Accounts assigned successfully
system:
version: 5.4.0.0
version_panel: 5.4.0.0
tier: ALPHA
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=reassignAccountMulti

Jb5: listAssignableAccounts

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

**Parameters**
Parameter name	Type	Description	Possible values	Examples
accounts	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.

Jb5: createBackupOnDemand

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

Backup on Demand settings

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

Example Call JETAPI

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}

Jb5: manageAccountExecludeList

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

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

Jb5: getAccountExcludeList

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

Parameter name	Type	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}

Jb5: listAccountPackages

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

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

Jb5: deleteAccountSnapshots

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

**Parameters**
Parameter name	Type	Description	Example
approve	Boolean	Gives permission for the API command to delete snapshots	`approve=1`
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}