Child pages
  • WHM API 1 Functions - modifyacct
Skip to end of metadata
Go to start of metadata

Description

This function modifies a cPanel account.

  • You must define the user parameter to identify which account to update.
  • All other input parameters are optional, and assign new values to the account. If you specify the current value in one of these parameters, no change will occur. 

Warnings:

  • We strongly recommend that you do not modify a single cPanel account's settings if that account uses a hosting plan (package). If the package values change, the system will overwrite any of your custom values with the package's new values.
  • This function uses case-sensitive parameters. You must enter parameters in the correct case format; otherwise, the function will ignore that parameter.


Note:

On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.

  • This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
  • Red Hat 7.1 and CentOS 7.1 both contain bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the Red Hat Bugzilla case about SPF record errors.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/modifyacct?api.version=1&user=username&QUOTA=unlimited&newuser=newusername
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/modifyacct?api.version=1&user=username&QUOTA=unlimited&newuser=newusername
 Command Line
whmapi1 modifyacct user=username QUOTA=unlimited newuser=newusername


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 

 Output (JSON)
{  
   "data":{  
      "domain":"example.com",
      "user":"newusername",
      "setshell":"unmodified",
      "cpuser":{  
         "DOMAINS":[  
            "addondomain.com",
            "seconddomain.com",
            "seconddomain.example.com",
            "subdomain.example.com",
         ],
         "HASSPF":"1",
         "MAXADDON":"unlimited",
         "MAXSUB":"unlimited",
         "MAX_DEFER_FAIL_PERCENTAGE":"unlimited",
         "MAX_EMAILACCT_QUOTA": "unlimited",
         "DEMO":"0",
         "_PACKAGE_EXTENSIONS":"",
         "BACKUP":"0",
         "RS":"paper_lantern",
         "USER":"username",
         "MAX_EMAIL_PER_HOUR":"unlimited",
         "MAXMONGREL":"4",
         "LOCALE":"en",
         "HOMEDIRLINKS":[  

         ],
         "MAXLST":"unlimited",
         "MAXPARK":"unlimited",
         "IP":"10.215.214.95",
         "MAXSQL":"unlimited",
         "MAXPOP":"unlimited",
         "OWNER":"root",
         "FEATURELIST":"default",
         "HASCGI":"1",
         "DEADDOMAINS":[  
            "example.example.com",
         ],
         "HASDKIM":"1",
         "MTIME":1416590437,
         "MAXFTP":"unlimited",
		 "MAXPASSENGERAPPS":"unlimited",	
         "LEGACY_BACKUP":"0",
         "CONTACTEMAIL2":"",
         "notify_twofactorauth_change_notification_disabled":"0",
         "notify_twofactorauth_change":"0",
         "notification_password_change_notification_disabled":"0",
         "notification_password_change":"0",
         "notify_email_quota_limit":"0",
         "notify_disk_limit":"0",
         "notify_contact_address_change_notification_disabled":"0",
         "notify_contact_address_change":"0",
         "notify_bandwidth_limit":"0",
         "notify_account_login_notification_disabled":"0",
         "notify_account_login_for_known_netblock":"0",
         "notify_account_login":"0",
         "notify_account_authn_link_notification_disabled":"0",
         "notify_account_authn_link":"0",
         "SUSPENDTIME":"0",
         "PUSHBULLET_ACCESS_TOKEN":"1234567890",
         "MXCHECK-DOMAINNAME":"0",
         "MAXPOP":"0",
         "MAILBOX_FORMAT":"maildir",
         "LANG":"english-utf8",
         "IP":"192.168.0.1",
         "DISK_BLOCK_LIMIT":"1000000",
         "DBOWNER":"example",
         "BWLIMIT":"unlimited",
         "STARTDATE":"1369256589",
         "CONTACTEMAIL":"username@example.com",
		 "CONTACTEMAIL2": "username2@example.com",
         "__CACHE_DATA_VERSION":"0.4",
         "DOMAIN":"example.com",
         "PLAN":"extensions_username_username"
      }
   },
   "metadata":{  
      "version":1,
      "reason":"Account Modified",
      "output":{  
         "warnings":[  

         ],
         "messages":[  

         ]
      },
      "result":1,
      "command":"modifyacct"
   }
}
 Output (XML)
<result>
    <data>
        <domain>example.com</domain>
        <user>newusername</user>
        <setshell>unmodified</setshell>
        <cpuser>
            <MAXSUB>unlimited</MAXSUB>
            <MAXADDON>unlimited</MAXADDON>
            <HASSPF>1</HASSPF>
            <DOMAINS>addondomain.com</DOMAINS>
            <DOMAINS>seconddomain.com</DOMAINS>
            <DOMAINS>seconddomain.example.com</DOMAINS>
            <DOMAINS>subdomain.example.com</DOMAINS>
            <MAX_DEFER_FAIL_PERCENTAGE>unlimited</MAX_DEFER_FAIL_PERCENTAGE>
            <MAX_EMAILACCOUT_QUOTA>unlimited</MAX_EMAILACCT_QUOTA>
            <DEMO>0</DEMO>
            <_PACKAGE_EXTENSIONS/>
            <BACKUP>0</BACKUP>
            <RS>paper_lantern</RS>
            <MAX_EMAIL_PER_HOUR>unlimited</MAX_EMAIL_PER_HOUR>
            <USER>username</USER>
            <MAXMONGREL>4</MAXMONGREL>
            <LOCALE>en</LOCALE>
            <MAXLST>unlimited</MAXLST>
			<MAXPASSENGERAPPS>unlimited</MAXPASSENGERAPPS>
            <MAXPARK>unlimited</MAXPARK>
            <IP>10.215.214.95</IP>
            <MAXPOP>unlimited</MAXPOP>
            <MAXSQL>unlimited</MAXSQL>
            <OWNER>root</OWNER>
            <FEATURELIST>default</FEATURELIST>
            <HASCGI>1</HASCGI>
            <DEADDOMAINS>example.example.com</DEADDOMAINS>
            <MTIME>1416590659</MTIME>
            <HASDKIM>1</HASDKIM>
            <MAXFTP>unlimited</MAXFTP>
            <LEGACY_BACKUP>0</LEGACY_BACKUP>
            <CONTACTEMAIL2/>
            <STARTDATE>1369256589</STARTDATE>
            <BWLIMIT>unlimited</BWLIMIT>
            <CONTACTEMAIL>username@example.com</CONTACTEMAIL>
            <__CACHE_DATA_VERSION>0.4</__CACHE_DATA_VERSION>
            <DOMAIN>example.com</DOMAIN>
            <PLAN>extensions_username_username</PLAN>
          <notify_twofactorauth_change_notification_disabled>0</notify_twofactorauth_change_notification_disabled>
          <notify_twofactorauth_change>0</notify_twofactorauth_change>
          <notification_password_change_notification_disabled>0</notification_password_change_notification_disabled>
          <notification_password_change>0</notification_password_change>
          <notify_email_quota_limit>0</notify_email_quota_limit>
          <notify_disk_limit>0</notify_disk_limit>
          <notify_contact_address_change_notification_disabled>0</notify_contact_address_change_notification_disabled>
          <notify_contact_address_change>0</notify_contact_address_change>
          <notify_bandwidth_limit>0</notify_bandwidth_limit>
          <notify_account_login_notification_disabled>0</notify_account_login_notification_disabled>
          <notify_account_login_for_known_netblock>0</notify_account_login_for_known_netblock>
          <notify_account_login>0</notify_account_login>
          <notify_account_authn_link_notification_disabled>0</notify_account_authn_link_notification_disabled>
          <notify_account_authn_link>0</notify_account_authn_link>
          <SUSPENDTIME>0</SUSPENDTIME>
          <PUSHBULLET_ACCESS_TOKEN>1234567890</PUSHBULLET_ACCESS_TOKEN>
          <MXCHECK-DOMAINNAME>0</MXCHECK-DOMAINNAME>
          <MAXPOP>0</MAXPOP>
          <MAILBOX_FORMAT> maildir </MAILBOX_FORMAT>
          <LANG>english-utf8</LANG>
          <IP>192.168.0.1</IP>
          <DISK_BLOCK_LIMIT>1000000</DISK_BLOCK_LIMIT>
          <DBOWNER>example</DBOWNER>
        </cpuser>
    </data>
    <metadata>
        <version>1</version>
        <reason>Account Modified</reason>
        <output/>
        <result>1</result>
        <command>modifyacct</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account's current username.

An existing cPanel account's username.

username
BACKUPBoolean

Whether backups are enabled for the cPanel account.

This parameter defaults to the defined system value.

  • 1 — Enabled.
  • 0 — Disabled.
1
BWLIMITstring

The cPanel account's maximum bandwidth use.

This parameter defaults to the defined system value.

  • A positive integer that represents the maximum bandwidth use, in bytes.
  • 0, unlimited, or null — The account possesses unlimited bandwidth.
unlimited
contactemailstring

The cPanel account's contact email address.

This parameter defaults to the defined system value.

A valid email address.username@example.com
DNSstring

The cPanel account's main domain.

This parameter defaults to the defined system value.

A valid domain name.example.com
HASCGIBoolean

Whether CGI access is enabled for the account.

This parameter defaults to the defined system value.

  • 1 — Enabled.
  • 0 — Disabled.
1
HASDKIMBoolean

Whether DKIM is enabled for the cPanel account.

This parameter defaults to the defined system value.

  • 1 — Enabled.
  • 0 — Disabled.
1
HASSHELLBoolean

Whether shell (SSH) access is enabled for the cPanel account.

Note:

We strongly recommend that you use the shell parameter to specify a shell for SSH access. 

This parameter defaults to the defined system value.

  • 1 — Enabled.
  • 0 — Disabled.
1
HASSPFBoolean

Whether SPF is enabled for the cPanel account.

This parameter defaults to the defined system value.

  • 1 — Enabled.
  • 0 — Disabled.
1
LOCALEstring

The cPanel account's default locale.

This parameter defaults to the defined system value.

A two-letter ISO-3166 code. en
MAXADDONstring

The cPanel account's maximum number of addon domains.

This parameter defaults to the defined system value.

  • An integer between zero and 999,999.
  • 0, unlimited, or null — The account possesses unlimited addon domains.
unlimited
MAXFTPstring

The cPanel account's maximum number of FTP accounts.

This parameter defaults to the defined system value.

  • A positive integer between one and 999,999.
  • unlimited or null — The account possesses unlimited FTP accounts.
unlimited
MAXLSTstring

The cPanel account's maximum number of mailing lists.

This parameter defaults to the defined system value.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited mailing lists.
unlimited
MAXPARKstring

The cPanel account's maximum number of parked domains (aliases).

This parameter defaults to the defined system value.

  • An integer between zero and 999,999.
  • unlimited or null — The account possesses unlimited parked domains.
unlimited
MAXPASSENGERAPPSstring

The cPanel account's maximum number of Ruby applications.

Note:

We added this parameter in cPanel & WHM version 66.

This parameter defaults to the defined system value.

  • An integer between zero and 999,999.
  • unlimited or null — The account possesses unlimited Ruby applications.
unlimited
MAXPOPstring

The maximum number of email accounts for the cPanel account.

This parameter defaults to the defined system value.

  • A positive integer between one and 999,999.
  • unlimited or null — The account possesses unlimited email accounts.
unlimited
MAXSQLstring

The maximum number of each available type of SQL database for the cPanel account.

For example, if you set this value to 5 and the system administrator allows MySQL® and PostgreSQL® databases, users can create up to five MySQL databases and up to five PostgreSQL databases.

This parameter defaults to the defined system value.

  • A positive integer between one and 999,999.
  • unlimited or null — The account possesses unlimited databases.
unlimited
MAXSUBstring

The maximum number of subdomains for the cPanel account.

This parameter defaults to the defined system value.

  • An integer between zero and 999,999.
  • unlimited or null — The account possesses unlimited subdomains.
unlimited
MAX_EMAIL_PER_HOUR string

The maximum number of emails that the account can send in one hour.

Note:

We introduced this parameter in cPanel & WHM version 11.32.

This parameter defaults to the defined system value.

  • A positive integer.
  • 0 or unlimited — The account can send an unlimited number of emails.
unlimited
MAX_EMAILACCT_QUOTAstring

The maximum size, in Megabytes that the account can define when it creates an email account.

Important:

  • This value applies to each email account, not each cPanel account.
  • If you define the MAX_EMAILACCT_QUOTA, this function will overwrite the plan's defined value for that cPanel account.
  • We recommend that you allow the cPanel account's plan to determine this value

Note:

We introduced this parameter in cPanel & WHM version 70.

This parameter defaults to the defined system value.

  • unlimited — The account possesses an unlimited quota.

    Note:

    This parameter defaults to unlimited if you do not define the either the plan or MAX_EMAILACCT_QUOTA parameter.

  • A positive integer between one and 4,294,967,296.
unlimited
MAX_DEFER_FAIL_PERCENTAGE string

The percentage of failed or deferred email messages that the account can send per hour before outgoing mail is rate-limited.

Note:

We introduced this parameter in cPanel & WHM version 11.32.

This parameter defaults to the defined system value.

  • A positive integer.
  • 0 or unlimited — The account can send an unlimited number of failed or deferred messages.
unlimited
newuserstring

The cPanel account's new username.

Note:

If you rename the account, and database prefixing is enabled, you may also use the rename_database_objects parameter. 

This parameter defaults to the defined system value.

A valid cPanel username.


Notes:

  • Usernames cannot begin with a number, or the string test.
  • In cPanel & WHM version 11.38 and older, usernames must contain eight characters or fewer.
  • In cPanel & WHM version 11.40 and later, usernames may contain 16 characters or fewer if database prefixes are disabled.
  • In cPanel & WHM version 11.44 and later, the first eight characters of usernames must be unique. MySQL requires this due to potential conflicts with account transfers.
  • In cPanel & WHM version 11.56 and later, MySQL's unique character limit requirement does not exist on servers that use MariaDB.

newuser
ownerstring

A new owner username, to change the cPanel account's owner.

Notes:

The authenticated user must have root privileges in order to assign the account to a reseller other than that account. 

This parameter defaults to the defined system value.

  • A valid reseller username.
  • root
reseller_name
QUOTA string

The cPanel account's disk space quota.

This parameter defaults to the defined system value.

  • An integer in multiples of 1,048,576 bytes.
  • 0, unlimited, or null — The cPanel account's disk space is unlimited.
unlimited
remove_missing_extensionsstring

A list of removed, missing, or uninstalled extensions.

Warning:

This parameter removes all of the extensions that you list from the _PACKAGE_EXTENSIONS variable in the user file. It will not remove the extensions' variables.

For more information, read our Guide to Package Extensions

Note:

We introduced this parameter in cPanel & WHM version 11.40.

This parameter defaults to the defined system value.

A space-separated list of one or more package extension names.packageext1 packageext2
rename_database_objectsBoolean

Whether to rename the cPanel account's database objects to use a new username's database prefix.

This parameter defaults to 0.

Warning:

  • The account owner must update any applications to use the new database object names.
  • Use this parameter carefully, as it may cause confusion for system administrators. 
  • For a full description of how cPanel & WHM renames databases, read the rename_database_objects parameter section below.

Notes:

  • This parameter only applies to servers that use database prefixing.
  • We introduced this parameter in cPanel & WHM version 11.44.

This parameter defaults to the defined system value.

  • 1 — Rename the cPanel account's database objects.
  • 0 — Do not rename the cPanel account's database objects.
0
shellstring
The absolute filepath to the shell's location.

Note:

We introduced this parameter in cPanel & WHM version 60. 

This parameter defaults to the defined system value.

A valid absolute filepath./bin/bash
spamassassinBoolean

Whether Apache SpamAssassin™ is enabled for the cPanel account.

This parameter defaults to 1.

Note:

We added this parameter in cPanel & WHM version 70.

This parameter defaults to the defined system value.

  • 1 — Enabled.
  • 0 — Disabled.
0
frontpageBoolean

Whether Microsoft® FrontPage Extensions are enabled for the cPanel account.

Note:

cPanel & WHM will ignore all FrontPage settings and parameters if either of the following statements is true:

  • The server runs cPanel & WHM version 11.44 and FrontPage Extensions are not installed.
  • The server runs cPanel & WHM version 11.46 or later.

This parameter defaults to the defined system value.

  • 1 — Enabled.
  • 0 — Disabled.
0
RSstring

The cPanel account's cPanel theme.

This parameter defaults to the defined system value.

  • paper_lantern
  • A valid theme on the server.
paper_lantern
DBOWNERstringThe owner of the account's MySQL databases.A valid cPanel account.example
DISK_BLOCK_LIMITintegerThe number of disk blocks assigned for the account, measured in kilobytes.A positive integer.100000000
IPstringThe account's IP address.A valid IP address.192.168.0.1
LANGstringThe account's display language.A valid language setting.english-utf8
MAILBOX_FORMATstringThe storage format that the account's mailboxes use.
  • maildir
  • mbox
maildir
MXCHECK-DOMAINNAMEstring

The priority of the account's primary mail exchanger.

Note:

The parameter name consists of MXCHECK followed by a hyphen and the primary domain name of the account.

A non-negative integer.0
OUTGOING_EMAIL_SUSPENDEDBooleanWhether to suspend outgoing email on the account.
  • 1 — Suspend outgoing email.
  • 0 — Do not suspend outgoing email.
0
PUSHBULLET_ACCESS_TOKEN

string

An access token for the account's Pushbullet notifications.A valid Pushbullet access token.1234567890
notify_account_authn_linkBooleanWhether to send a notificiation when someone links the cPanel account to an external authentication account.
  • 1 — Enabled.
  • 0 — Disabled.
0
notify_account_authn_link_notification_disabledBooleanWhether to send a notificiation when someone disables notifications for external authentication account links.
  • 1 — Enabled.
  • 0 — Disabled.
0
notify_autossl_expiryBooleanWhether to send a notificiation when an AutoSSL certificate expires.
  • 1 — Enabled.
  • 0 — Disabled.
0
notify_autossl_expiry_coverageBooleanWhether to send a notificiation AutoSSL cannot renew a certificate because domains that fail Domain Control Validation (DCV) exist on the current certificate.
  • 1 — Enabled.
  • 0 — Disabled.
0
notify_autossl_renewalBooleanWhether to send a notificiation when AutoSSL renews a certificate.
  • 1 — Enabled.
  • 0 — Disabled.
0
notify_autossl_renewal_coverageBooleanWhether to send a notificiation when AutoSSL renews a certificate, but the new certificate lacks at least one domain that the previous certificate secured.
  • 1 — Enabled.
  • 0 — Disabled.
0
notify_contact_address_changeBooleanWhether to send a notificiation when someone changes the contact address for the account.
  • 1 — Enabled.
  • 0 — Disabled.
0
notify_contact_address_change_notification_disabledBooleanWhether to send a notificiation when disables the notification for contact address changes.
  • 1 — Enabled.
  • 0 — Disabled.
0
notify_disk_limitBooleanWhether to send a notificiation when the account reaches its disk usage limit.
  • 1 — Enabled.
  • 0 — Disabled.
0
notify_password_changeBooleanWhether to send a notificiation when someone changes the account's password.
  • 1 — Enabled.
  • 0 — Disabled.
0
notify_password_change_notification_disabledBooleanWhether to send a notificiation when someone disables notifications for password changes.
  • 1 — Enabled.
  • 0 — Disabled.
0
notify_ssl_expiryBooleanWhether to send a notificiation when an SSL certificate on the account expires.
  • 1 — Enabled.
  • 0 — Disabled.
0

The rename_database_objects parameter

MySQL does not allow you to rename a database. When cPanel & WHM "renames" a database, the system performs the following steps:
  1. The system creates a new database.
  2. The system moves data from the old database to the new database.
  3. The system recreates grants and stored code in the new database.
  4. The system deletes the old database and its grants.

Warning:

  • If any of the first three steps fail, the system returns an error and attempts to restore the database's original state. If the restoration process fails, the API function's error response describes these additional failures.
  • In rare cases, the system creates the second database successfully, but fails to delete the old database or grants. The system treats the rename action as a success; however, the API function returns warnings that describe the failure to delete the old database or grants.

Returns

ReturnTypeDescriptionPossible valuesExample

domain

string

The cPanel account's main domain.

A valid domain name on the account.example.com

user

string

The cPanel account username.

The cPanel account's username.

Note:

If you changed the cPanel account's username, the function returns the new value. 

newuser

setshell

string

The cPanel account's shell.

The absolute path to a shell location on the server./bin/bash

cpuser

hashA hash of account information.

This function contains one or more of the MAXSUB, MAXADDON, HASSPF, DOMAINS, MAX_DEFER_FAIL_PERCENTAGE, MAX_EMAILACCT_QUOTA, DEMO, _PACKAGE_EXTENSIONS, BACKUP, RS, MAX_EMAIL_PER_HOUR, USER, MAXMONGREL, LOCALE, HOMEDIRLINKS, MAXLST, MAXPARK, MAXSQL, OWNER, FEATURELIST, HASCGI, DEADDOMAINS, MTIME, HASDKIM, MAXFTP, MAXPASSENGERAPPS LEGACY _BACKUP, CONTACTEMAIL2, STARTDATE, BWLIMIT, CONTACTEMAIL, __CACHE_DATA_VERSION, DOMAIN, notify_twofactorauth_change_notification_disabled, notify_twofactorauth_change, notification_password_change_notification_disabled, notification_password_change, notify_email_quota_limit, notify_disk_limit, notify_contact_address_change_notification_disabled, notify_contact_address_change, notify_bandwidth_limit, notify_account_login_notification_disabled, notify_account_login_for_known_netblock, notify_account_login, notify_account_authn_link_notification_disabled, notify_account_authn_link, SUSPENDTIME, PUSHBULLET_ACCESS_TOKEN,MXCHECK-DOMAINNAME, MAXPOP, MAILBOX_FORMAT, LANG, IP, DISK_BLOCK_LIMIT, DBOWNER and PLAN returns.

Note:

If the account or its hosting plan use package extensions, the cpuser hash will also include the extension's variables. 

 

MAXSUB

string

The cPanel account's maximum number of subdomains.

The function returns this value in the cpuser hash.

  • unlimited
  • An integer that represents a number of subdomains.
unlimited  

MAXADDON

string

The cPanel account's maximum number of addon domains.

The function returns this value in the cpuser hash.

  • unlimited
  • An integer that represents a number of addon domains.
unlimited

 HASSPF

Boolean

Whether SPF is enabled for the account.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
1

DOMAINS

array

A list of the cPanel account's domains and subdomains.

The function returns this value in the cpuser hash.

An array of one or more valid domains or subdomains.example.com

MAX_DEFER_FAIL_PERCENTAGE

string

The percentage of failed or deferred email messages that the account can send per hour before outgoing mail is rate-limited.

The function returns this value in the cpuser hash.

  • unlimited
  • An integer that represents a percentage of messages.
unlimited

MAX_EMAILACCT_QUOTA

string

The maximum size that the account can define when it creates an email account.

Note:

We added this return in cPanel & WHM version 70.

This function returns this value in the cpuser hash.

  • unlimited
  • A positive integer that represents the allowable maximum size of an email account, in Megabytes (MB).
unlimited

 DEMO

Boolean

Whether demo mode is enabled for the account.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

_PACKAGE_EXTENSIONS

string

The cPanel account's package extensions.

The function returns this value in the cpuser hash.

A space-separated list of one or more package extension names.ext1 ext2 ext3

BACKUP

Boolean

Whether backups are enabled.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

RS

string

The cPanel account's cPanel interface theme.

The function returns this value in the cpuser hash.

  • paper_lantern
  • A valid theme on the server.
paper_lantern

MAX_EMAIL_PER_HOUR

string

The maximum number of emails that the account can send in one hour.

The function returns this value in the cpuser hash.

  • unlimited
  • An integer that represents a number of sent emails.
unlimited

USER

string

The account username.

The function returns this value in the cpuser hash.

The cPanel account's username.

Note:

If you changed the cPanel account's username, the function returns the new value. 

username

 MAXMONGREL

string

The maximum number of Mongrel instances.

The function returns this value in the cpuser hash.

  • unlimited
  • An integer that represents a number of Mongrel instances.
4

LOCALE

string

The cPanel account's locale.

The function returns this value in the cpuser hash.

A two-letter ISO-3166 code.

en

HOMEDIRLINKS

array

Any symlinks to the cPanel account's home directory.

The function returns this value in the cpuser hash.

An array of one or more home directory symlinks.symlink

MAXLST

string

The cPanel account's maximum number of mailing lists.

The function returns this value in the cpuser hash.

  • unlimited
  • An integer that represents a number of mailing lists.
unlimited

MAXPARK

string

The cPanel account's maximum number of parked domains.

The function returns this value in the cpuser hash.

  • unlimited
  • An integer that represents a number of parked domains.
unlimited  

MAXPASSENGERAPPS

string

The cPanel account's maximum number of Ruby applications.

The function returns this value in the cpuser hash.

Note:

We added this return in cPanel & WHM version 66.

  • unlimited
  • An integer that represents a number of Ruby applications.
unlimited

MAXSQL

string

The cPanel account's maximum number of SQL databases.

The function returns this value in the cpuser hash.

  • unlimited
  • An integer that represents a number of SQL databases.
unlimited  

OWNER

string

The cPanel account's owner.

The function returns this value in the cpuser hash.

  • root
  • A reseller account's username.
  • The cPanel account username.
root

 FEATURELIST

string

The cPanel account's featurelist.

The function returns this value in the cpuser hash.

A valid feature list name.default

HASCGI

Boolean

Whether CGI is enabled for the account.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
1

DEADDOMAINS

array

The cPanel account's inactive domains.

The function returns this value in the cpuser hash.

An array of one or more domains or subdomains.example.example.com

MTIME

string

The time of the function call.

The function returns this value in the cpuser hash.

A time, in Unix time format.1416586493

HASDKIM

Boolean

Whether DKIM is enabled for the account.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
1

MAXFTP

string

The cPanel account's maximum number of FTP accounts.

The function returns this value in the cpuser hash.

  • unlimited
  • An integer that represents a number of FTP accounts.
unlimited

LEGACY_BACKUP

Boolean

Whether legacy backups are enabled.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

CONTACTEMAIL2

string

The cPanel account's secondary contact email address, if one exists.

The function returns this value in the cpuser hash.

A valid email address.email2@example.com

STARTDATE

string

The account creation date.

The function returns this value in the cpuser hash.

The date in YY Mon DD HH:mm human-readable format, where:

  • YY represents the year.
  • Mon represents the month.
  • DD represents the date.
  • HH represents the hour.
  • mm represents the minute.
13 May 22 16:03

 BWLIMIT

string

The cPanel account's bandwidth limit.

The function returns this value in the cpuser hash.

  • unlimited
  • A maximum amount of bandwidth, in Megabytes (MB).
unlimited

CONTACTEMAIL

string

The cPanel account's contact email address.

The function returns this value in the cpuser hash.

A valid email address.username@example.com

__CACHE_DATA_VERSION

string

The cPanel account's cache data's version.

The function returns this value in the cpuser hash.

A numeric value that indicates a version of the cache data.0.4

DOMAIN

string

The cPanel account's main domain.

The function returns this value in the cpuser hash.

A valid domain on the cPanel account.example.com

PLAN

string

The cPanel account's hosting package.

The function returns this value in the cpuser hash.

The name of a package on the server.packagename

DBOWNER

string

The owner of the account's MySQL databases.

The function returns this value in the cpuser hash.

A valid cPanel account.example

DISK_BLOCK_LIMIT

integer

The number of disk blocks assigned for the account, measured in kilobytes.

The function returns this value in the cpuser hash.

A positive integer.100000000

IP

string

The account's IP address.

The function returns this value in the cpuser hash.

A valid IP address.192.168.0.1

LANG

string

The account's display language.

The function returns this value in the cpuser hash.

A valid language setting.english-utf8

MAILBOX_FORMAT

string

The storage format that the account's mailboxes use.

The function returns this value in the cpuser hash.

  • maildir
  • mbox
maildir

MAXPOP

integer

The maximum number of mail accounts that the account may use.

The function returns this value in the cpuser hash.

  • A positive integer.
  • 0 — Represents unlimited.
0

MXCHECK-DOMAINNAME

string

The priority of the account's primary mail exchanger.

Note:

The parameter name consists of MXCHECK followed by a hyphen and the primary domain name of the account.

The function returns this value in the cpuser hash.

A non-negative integer.0

PUSHBULLET_ACCESS_TOKEN

string

The account's Pushbullet access token.

The function returns this value in the cpuser hash.

A valid Pushbullet token ID.1234567890

SUSPENDTIME

integer

When the account was suspended.

The function returns this value in the cpuser hash.

A time, in Unix time format.1459350508

notify_account_authn_link

Boolean

Whether to send a notificiation when someone links the cPanel account to an external authentication account.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notify_account_authn_link_notification_disabled

Boolean

Whether to send a notificiation when someone disables notifications for external authentication account links.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notify_account_login

Boolean

Whether to send a notificiation when someone logs in to the account.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notify_account_login_for_known_netblock

Boolean

Whether to send a notificiation when a user on a known netblock logs in to the account.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notify_account_login_notification_disabled

Boolean

Whether to send a notificiation when someone disables notifications for account logins.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notify_bandwidth_limit

Boolean

Whether to send a notificiation when the account reaches its bandwidth quota.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notify_contact_address_change

Boolean

Whether to send a notificiation when someone changes the contact address for the account.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notify_contact_address_change_notification_disabled

Boolean

Whether to send a notificiation when someone disables the notification for contact address changes.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notify_disk_limit

Boolean

Whether to send a notificiation when the account reaches its disk usage limit.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notify_email_quota_limit

Boolean

Whether to send a notificiation when the account reaches its email quota limit.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notification_password_change

Boolean

Whether to send a notificiation when someone changes the account's password.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notification_password_change_notification_disabled

Boolean

Whether to send a notificiation when someone disables notifications for password changes.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notify_twofactorauth_change

Boolean

Whether to send a notificiation when Two-Factor Authentication credentials change.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0

notify_twofactorauth_change_notification_disabled

Boolean

Whether to send a notificiation when someone disables notifications for Two-Factor Authentication.

The function returns this value in the cpuser hash.

  • 1 — Enabled.
  • 0 — Disabled.
0