cPanel API Documentation
Overview
Dashboard
fileManager
getConfigurations
getInfo
listPermissions
Accounts
manageAccount
getAccountDetails
Backups
manageBackup
listBackups
Downloads
listDownloads
deleteDownload
Queues
addQueueDownload
addQueueRestore
addQueueSnapshot
listQueueItems
Encrypted Backups
manageGDPR
getGDPR
Objects
Account Object
Backup Object
Backup Status Object
cPanel Permissions Object
Download Object
File Object
GDPR Object
Returned cPanel Permissions Object
Monitor Object
Performance Object
Queue Object
Restore Conditions Object
Schedule Object
Suspend Object
Parameters Dictionary
Accounts
Backup Types
Directories
Filter Accounts type
Replicate
Schedule Type
Type Data
WHM User Documentation
cPanel User Documentation
WHM API Documentation
cPanel API Documentation
WARNING:
JetBackup 4 is set to reach its End-of-Life (EOL) on July 1st, 2024. For More Information, please visit:
JetBackup 4 EOL Announcement
.
NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our
Jetbackup 5 Documentation
.
Backup Types
Backup type represented as int that evaluated from a binary operation.
For example:
Full backup accounts will be the value of 127 which is 1+2+4+8+16+32+64(for all available backup options) (or 1|2|4|8|16|32|64 in binary operation).
Backup accounts with cPanel Configurations, Cron Jobs, DNS Zones, will be the value of 49 which is 1+16+32 (or 1|16|32 in binary operation).
Value Name
Value
Accounts
To view the possible values click on
Accounts
Directories
To view the possible values click on
Directories
Replicate
512
Disaster Recovery
1024
WHM User Documentation
cPanel User Documentation
WHM API Documentation
cPanel API Documentation