WHM API Documentation
Overview
Dashboard
fileManager
listShowcase
Accounts
manageAccount
getAccount
listAccounts
listAccountsOrphans
listAccountsWithoutBackupJob
Destinations
manageDestination
getDestination
listDestinations
validateDestination
deleteDestination
Backup Jobs
manageBackupJob
duplicateBackupJob
getBackupJob
listBackupJobs
calculateBackupJobRating
setBackupJobNextRun
stopBackupJob
deleteBackupJob
Clone Jobs
manageCloneJob
duplicateCloneJob
getCloneJob
listCloneJobs
setCloneJobNextRun
stopCloneJob
deleteCloneJob
Schedules
manageSchedule
getSchedule
listSchedules
deleteSchedule
Account Filters
manageAccountFilter
getAccountFilter
listAccountFilters
deleteAccountFilter
getAccountFilterGroup
listAccountFilterGroups
Backups
manageBackup
getBackupDownloads
getBackup
listBackups
calculateBackupSize
lockLatestSnap
manageBackupLock
Downloads
getDownload
listDownloads
deleteDownload
Alerts
acknowledgeAlerts
listAlerts
Queues
addQueueClone
addQueueDownload
addQueueRestore
addQueueSnapshot
manageQueuePriority
setDefaultQueuePriority
getQueueItem
getQueuePriority
listQueueItems
listQueuePriorities
cancelQueueItem
deleteQueuePriority
Logs
getLog
listLogs
deleteLogs
Permissions
managePermissions
getPermissions
resetPermissions
Hooks
manageHook
getHook
listHooks
deleteHook
Plugins
managePlugin
getPlugins
listPlugins
Encrypted Backups
manageSettingsGdpr
getSettingsGdpr
Settings
manageSettingsGeneral
manageSettingsPerformance
manageSettingsResource
manageSettingsRestore
manageSettingsSnapshots
manageSettingsNotification
manageSettingsBinary
getSettingsGeneral
getSettingsPerformance
getSettingsResource
getSettingsRestore
getSettingsSnapshots
getSettingsNotification
getSettingsBinary
Disaster Recovery
restoreDisasterRecovery
listAccountsDisasterRecovery
exitDisasterRecovery
Restore Conditions
manageRestoreCondition
getRestoreCondition
listRestoreConditions
deleteRestoreCondition
File Permissions
manageFilePermission
getFilePermission
listFilePermissions
deleteFilePermission
Common
Jetapi Parameters
List Parameters
How To Retrieve API Tokens?
Objects
Account Object
Account Filter Group Object
Account Permissions Object
Accounts Filter Object
Alert Object
Destination Amazon Object
Destination BackBlaze Object
Backup Object
Backup Download Object
Backup Job Object
Backup Status Object
Binary Setting Object
Clone Job Object
cPanel Permissions Object
Destination Object
Directory Object
Disaster Recovery Object
Download Object
Destination DropBox Object
Feature Object
File Object
File Permissions Object
Destination FTP/SFTP Object
GDPR Object
General Setting Object
Returned cPanel Permissions Object
Returned WHM Permissions Object
Destination GoogleDrive Object
Hook Object
Job Schedule Object
Log Object
Monitor Object
Notification Setting Object
Orphan Account Object
Package Object
Performance Object
Performance Setting Object
Plugin Object
Progress Object
Queue Object
Queue Priority Object
Rating Object
Resource Setting Object
Restore Conditions Object
Restore Setting Object
Schedule Object
Snapshots Setting Object
Destination SSH/Rsync.net/SSH-cPanel-Clone Object
Statistics Object
Suspend Object
System Object
WHM Permissions Object
Parameters Dictionary
Accounts
Backup Types
Filter Accounts type
Replicate
Schedule Type
Type Data
WHM User Documentation
cPanel User Documentation
WHM API Documentation
cPanel API Documentation
NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our
Jetbackup 5 Documentation
.
Disaster Recovery Object
Parameter name
Type
Description
Possible Values
Example
username
String
The account username.
acct01
WHM User Documentation
cPanel User Documentation
WHM API Documentation
cPanel API Documentation