Page tree
Skip to end of metadata
Go to start of metadata

Version 68 and Earlier

ArgumentTypeDescriptionPossible valuesExample
domainstringThe account's main domain name.A valid domain name.example.com
userstringThe account's username.A valid username.user
passstringThe account's password.A secure password.12345luggage
quotaintegerThe account's disk space quota.
  • An integer value between one and 999999 that represents a disk space quota in Megabytes (MB).
  • 0 — The account possesses unlimited disk space.
0
cpmodstringThe account's cPanel theme.
  • paper_lantern
  • Another valid theme on the server.
paper_lantern
ipstring

Whether the account possesses a dedicated IP address.

This parameter defaults to n.

  • y — The account possesses a dedicated IP address.
  • n — The account does not possess a dedicated IP address.
n
cgistringWhether the account has CGI access.
  • y — CGI access.
  • nNo CGI access.
y
frontpagestringWhether Microsoft® FrontPage® Extensions exist on the account.
  • y — Installed.
  • nNot installed.

    Note:

    In cPanel & WHM version 11.46 and later, this value is always n.

n
maxftpstringThe account's maximum number of FTP accounts.
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxsqlstringThe account's maximum number of SQL databases
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxpopstringThe account's maximum number of email addresses.
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxlststringThe account's maximum number of Mailman mailing lists.
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxsubstringThe account's maximum number of subdomains.
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
bwlimitstringThe account's bandwidth quota.
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
hasshellstringWhether the account has shell access.
  • y — Shell access.
  • n — No shell access.
y
ownerstringThe WHM account that owns this account.
  • A valid reseller's username.
  • root
root
planstringThe account's hosting plan (package).A valid package name.default
maxparkstring

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

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited parked domains.
unlimited
maxaddonstring

The account's maximum number of addon domains.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited addon domains.
unlimited
featureliststring

The account's feature list.

If you do not use this parameter, the function assigns the default feature list to the account.

A valid feature list name on the server.default
contactemailstringThe account's contact email address.A valid email address.user@example.com
use_registered_nameserversstringWhether to use the domain's registered nameservers instead of the server's nameservers.
  • y — Use the domain's nameservers.
  • n — Use the server's nameservers.
0
languagestringThe account's locale.A valid locale name.en

Version 70 Only

ArgumentTypeDescriptionPossible valuesExample
domainstringThe account's main domain name.A valid domain name.example.com
userstringThe account's username.A valid username.user
passstringThe account's password.A secure password.12345luggage
quotaintegerThe account's disk space quota.
  • An integer value between one and 999999 that represents a disk space quota in Megabytes (MB).
  • 0 — The account possesses unlimited disk space.
0
cpmodstringThe account's cPanel theme.
  • paper_lantern
  • Another valid theme on the server.
paper_lantern
ipstring

Whether the account possesses a dedicated IP address.

This parameter defaults to n.

  • y — The account possesses a dedicated IP address.
  • n — The account does not possess a dedicated IP address.
n
cgistringWhether the account has CGI access.
  • y — CGI access.
  • nNo CGI access.
y
frontpagestringWhether Microsoft® FrontPage® Extensions exist on the account.
  • y — Installed.
  • nNot installed.

    Note:

    In cPanel & WHM version 11.46 and later, this value is always n.

n
maxftpstringThe account's maximum number of FTP accounts.
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxsqlstringThe account's maximum number of SQL databases
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxpopstringThe account's maximum number of email addresses.
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxlststringThe account's maximum number of Mailman mailing lists.
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxsubstringThe account's maximum number of subdomains.
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
bwlimitstringThe account's bandwidth quota.
  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
hasshellstringWhether the account has shell access.
  • y — Shell access.
  • n — No shell access.
y
ownerstringThe WHM account that owns this account.
  • A valid reseller's username.
  • root
root
planstringThe account's hosting plan (package).A valid package name.default
maxparkstring

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

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited parked domains.
unlimited
maxaddonstring

The account's maximum number of addon domains.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited addon domains.
unlimited
featureliststring

The account's feature list.

If you do not use this parameter, the function assigns the default feature list to the account.

A valid feature list name on the server.default
contactemailstringThe account's contact email address.A valid email address.user@example.com
use_registered_nameserversstringWhether to use the domain's registered nameservers instead of the server's nameservers.
  • y — Use the domain's nameservers.
  • n — Use the server's nameservers.
0
languagestringThe account's locale.A valid locale name.en
spamassassinstring

Whether Apache SpamAssassin™ is enabled on the account.

Note:

We added this parameter in cPanel & WHM version 70.

  • y — Enabled.
  • n — Disabled.
y
max_emailacct_quotastring

The maximum quota for each email address in MB.

Note:

We added this parameter in cPanel & WHM verison 70.

  • A positive integer between one and 4,294,967,296.
  • unlimited — Unlimited.
unlimited

Version 72 and later

ArgumentTypeDescriptionPossible valuesExample
domainstring

Required

The account's main domain name.

A valid domain name.example.com
userstring

Required

The account's username.

A valid username.user
passstring

Required

The account's password.

A secure password.12345luggage
quotainteger

The account's disk space quota.

This parameter defaults to 0. (unlimited)

  • An integer value between one and 999999 that represents a disk space quota in Megabytes (MB).
  • 0 — The account possesses unlimited disk space.
0
cpmodstring

The account's cPanel theme.

This parameter defaults to the default package's Theme setting.

  • paper_lantern
  • Another valid theme on the server.
paper_lantern
ipstring

Whether the account possesses a dedicated IP address.

This parameter defaults to n.

  • y — The account possesses a dedicated IP address.
  • n — The account does not possess a dedicated IP address.
n
cgistring

Whether the account has CGI access.

This parameter defaults to the default package's CGI Access setting.

  • y — CGI access.
  • nNo CGI access.
y
frontpagestringWhether Microsoft® FrontPage® Extensions exist on the account.
  • y — Installed.
  • nNot installed.

    Note:

    In cPanel & WHM version 11.46 and later, this value is always n.

n
maxftpstring

The account's maximum number of FTP accounts.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxsqlstring

The account's maximum number of SQL databases.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxpopstring

The account's maximum number of email addresses.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxlststring

The account's maximum number of Mailman mailing lists.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
maxsubstring

The account's maximum number of subdomains.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
bwlimitstring

The account's bandwidth quota.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — Unlimited.
0
hasshellstring

Whether the account has shell access.

This parameter defaults to the default package's Shell Access value

  • y — Shell access.
  • n — No shell access.
y
ownerstring

The WHM account that owns this account.

This parameter defaults to the user who runs the script.

  • A valid reseller's username.
  • root
root
planstring

The account's hosting plan (package).

This parameter defaults to unlimited.

A valid package name.default
maxparkstring

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

This parameter defaults to the selected package's Maximum Parked Domains value.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited parked domains.
unlimited
maxaddonstring

The account's maximum number of addon domains.

This parameter defaults to the selected package's Maximum Addon Domains value.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited addon domains.
unlimited
featureliststring

The account's feature list.

This parameter defaults to the selected package's Feature List value.

A valid feature list name on the server.default
contactemailstring

The account's contact email address.

This parameter defaults to a null value.

A valid email address.user@example.com
use_registered_nameserversstring

Whether to use the domain's registered nameservers instead of the server's nameservers.

This parameter defaults to n.

  • y — Use the domain's nameservers.
  • n — Use the server's nameservers.
n
languagestring

The account's locale.

This parameter defaults to the selected package's Locale value.

A valid locale name.en
spamassassinstring

Whether Apache SpamAssassin™ is enabled on the account.

Note:

We added this parameter in cPanel & WHM version 70. 

This parameter defaults to y

  • y — Enabled.
  • n — Disabled.
y
spamboxstring

Whether to enable Spam Box on the account.

Note:

  • You must enable Apache SpamAssassin if you call this parameter.
  • We added this parameter in cPanel & WHM version 80.

This parameter defaults to y (enabled).

  • y — Enabled.
  • n — Disabled.
y
max_emailacct_quotastring

The maximum quota for each email address in MB.

Note:

We added this parameter in cPanel & WHM version 70.

This parameter defaults to the selected package's Max Quota per Email Address (MB) value.

  • A positive integer between one and 4,294,967,296.
  • unlimited — Unlimited.
unlimited

  • No labels