Account Object

Parameter name Type Description Possible Values Example
domain String The account's main domain retrieved from cPanel.    
ip String The account's main domain's IP address retrieved from cPanel.    
owner String The account's owner retrieved from cPanel.   root
package String The partition that contains the account's home directory retrieved from cPanel.   default
username String The account username retrieved from cPanel.   acct01
partition String The partition that contains the account's home directory retrieved from cPanel.   home
disk_space_usage Integer The account's current disk space usage in bytes.   53239808
disk_files_usage Integer The number of files that the account owns.   1650
quota Integer The account's disk space quota retrieved from cPanel.   0
email String This email will be used to notify the user after each process he performs on the account.    
maxsnapshots String The maximum snapshots allowed to create for this account.    
backup_stats Object The number of backups from each backup type. To view the possible values click on Backup Status Object  
backup_quota Boolean Whether the backup quota enabled on this account.    
start_date String The account creation date retrieved from cPanel.   18 Jun 26 15:11
theme String The account's cPanel interface theme.   paper_lantern
homedir String The home directory.   /home
userhome String The partition that contains the account's directory.   /home/acct01
userjbm String The partition that contains the account's jbm directory.   /home/acct01/.jbm
reseller Boolean Whether it's reseller account.    
suspended Object if the account suspend, return suspend object. To view the possible values click on Suspend Object  
encryption_key Boolean Whether the account has GDPR encryption key.    
secret_key Boolean Whether the encryption_key is encrypted.