WHM API 1 Functions - createacct

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/createacct?api.version=1&username=user&domain=example.com&plan=package_name&featurelist=default&quota=0&password=12345luggage&ip=n&cgi=1&hasshell=1&contactemail=user%40seconddomain.com&cpmod=paper_lantern&maxftp=5&maxsql=5&maxpop=10&maxlst=5&maxsub=1&maxpark=1&maxaddon=1&bwlimit=500&language=en&useregns=1&hasuseregns=1&reseller=0&forcedns=1&mailbox_format=mdbox&mxcheck=local&max_email_per_hour=500&max_defer_fail_percentage=80&owner=root

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/createacct?api.version=1&username=user&domain=example.com&plan=package_name&featurelist=default&quota=0&password=12345luggage&ip=n&cgi=1&hasshell=1&contactemail=user%40seconddomain.com&cpmod=paper_lantern&maxftp=5&maxsql=5&maxpop=10&maxlst=5&maxsub=1&maxpark=1&maxaddon=1&bwlimit=500&language=en&useregns=1&hasuseregns=1&reseller=0&forcedns=1&&mailbox_format=mdbox&mxcheck=local&max_email_per_hour=500&max_defer_fail_percentage=80&owner=root

Command Line

whmapi1 createacct username=user domain=example.com plan=package_name featurelist=default quota=0 password=12345luggage ip=n cgi=1 hasshell=1 contactemail=user%40seconddomain.com cpmod=paper_lantern maxftp=5 maxsql=5 maxpop=10 maxlst=5 maxsub=1 maxpark=1 maxaddon=1 bwlimit=500 language=en useregns=1 hasuseregns=1 reseller=0 forcedns=1 mailbox_format=mdbox mxcheck=local max_email_per_hour=500 max_defer_fail_percentage=80 owner=root

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)

{
   "result": [
      {
         "options": {
         "nameserverentry3": null,
         "nameservera": null,
         "nameserver4": "",
         "ip": "192.168.0.1",
         "nameservera4": null,
         "nameserver": "ns1.example-host.com",
         "package": "package_name",
         "nameserver2": "ns2.example-host.com",
         "nameservera2": null,
         "nameserverentry4": null,
         "nameservera3": null,
         "nameserverentry2": null,
         "nameserverentry": null,
         "nameserver3": ""
      },
      "statusmsg": "Account Creation Ok",
      "rawout": "<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Checking input data......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Validating system setup......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Rebuilding IP Pool...System has 0 free ips.\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Validating IP......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Validating Username......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Validating Contact Email......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Checking for database conflicts......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>WWWAcct 12.6.0 (c) 2014 cPanel, Inc....\n\nForced Dns is enabled.\n+===================================+\n| New Account Info                  |\n+===================================+\n| Domain: example.com\n| Ip: 192.168.0.1 (n)\n| HasCgi: y\n| UserName: user\n| PassWord: 12345luggage\n| CpanelMod: paper_lantern\n| HomeRoot: /home\n| Quota: 0 Meg\n| NameServer1: ns1.example-host.com\n| NameServer2: ns2.example-host.com\n| NameServer3: \n| NameServer4: \n| Contact Email: user@seconddomain.com\n| Package: package_name\n| Feature List: default\n| Language: en\n+===================================+\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Running pre creation script (/usr/local/cpanel/scripts/prewwwacct)......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Adding User...Adding Shell Access (y)\nSuccess...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Adding Entries to userdata......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Updating the userdata cache......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting up Mail & Local Domains...locDOComains...valiases ...vdomainaliases...vfilters......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Configuring DNS...Bind reconfiguring on sarah using rndc\nZone example.com has been successfully added\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Updating Authentication Databases......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Adding Entries to httpd.conf......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Restarting apache......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting passwords...Password for "user" has been changed.\nUpdating FTP passwords for user\nFTP password files updated.\nFTP vhost passwords synced\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Updating the dedicated IP address usage cache......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Verifying MX Records and Setting up Databases...Reconfiguring Mail Routing:\n<ul><li>LOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for example.com's mail.:<br /> This configuration has been manually selected.<br /><br /></li></ul>...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting up Proxy Subdomains......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\nBind reloading on sarah using rndc zone: [example.com]\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Sending Account Information......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\nSystem has 0 free ips.\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Running post creation scripts (/usr/local/cpanel/scripts/legacypostwwwacct, /usr/local/cpanel/scripts/postwwwacct, /usr/local/cpanel/scripts/postwwwacctuser)......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\nwwwacct creation finished\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting up Domain Pointers......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting Reseller Privs......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Account Creation Complete!!!...Account Creation Ok...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n",
      "status": 1
      }
   ]
}

Output (XML)

<createacct>
   <result>
      <options>
         <ip>192.168.0.1</ip>
         <nameserver>ns1.example-host.com</nameserver>
         <nameserver2>ns2.example-host.com</nameserver2>
         <nameserver3/>
         <nameserver4/>
         <nameservera/>
         <nameservera2/>
         <nameservera3/>
         <nameservera4/>
         <nameserverentry/>
         <nameserverentry2/>
         <nameserverentry3/>
         <nameserverentry4/>
         <package>package_name</package>
      </options>
      <rawout>
         <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Checking input data......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Validating system setup......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Rebuilding IP Pool...System has 0 free ips. ...Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Validating IP......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Validating Username......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Validating Contact Email......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Checking for database conflicts......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>WWWAcct 12.6.0 (c) 2014 cPanel, Inc.... Forced Dns is enabled. +===================================+ | New Account Info | +===================================+ | Domain: example.com | Ip: 192.168.0.1 (n) | HasCgi: y | UserName: user | PassWord: 12345luggage | CpanelMod: paper_lantern | HomeRoot: /home | Quota: 0 Meg | NameServer1: ns1.example-host.com | NameServer2: ns2.example-host.com | NameServer3: | NameServer4: | Contact Email: user@seconddomain.com | Package: package_name | Feature List: default | Language: en +===================================+ ...Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Running pre creation script (/usr/local/cpanel/scripts/prewwwacct)......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Adding User...Adding Shell Access (y) Success...Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Adding Entries to userdata......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Updating the userdata cache......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Setting up Mail & Local Domains...locDOComains...valiases ...vdomainaliases...vfilters......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Configuring DNS...Bind reconfiguring on sarah using rndc Zone example.com has been successfully added ...Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Updating Authentication Databases......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Adding Entries to httpd.conf......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Restarting apache......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Setting passwords...Password for "user" has been changed. Updating FTP passwords for user FTP password files updated. FTP vhost passwords synced ...Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Updating the dedicated IP address usage cache......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Verifying MX Records and Setting up Databases...Reconfiguring Mail Routing: <ul><li>LOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for example.com's mail.:<br /> This configuration has been manually selected.<br /><br /></li></ul>...Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Setting up Proxy Subdomains......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> Bind reloading on sarah using rndc zone: [example.com] <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Sending Account Information......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> System has 0 free ips. <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Running post creation scripts (/usr/local/cpanel/scripts/legacypostwwwacct, /usr/local/cpanel/scripts/postwwwacct, /usr/local/cpanel/scripts/postwwwacctuser)......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> wwwacct creation finished <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Setting up Domain Pointers......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Setting Reseller Privs......Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table> <table style="border-bottom: 1px #ccc dotted;"><tr><td width="100%"><pre>Account Creation Complete!!!...Account Creation Ok...Done</pre></td><td width="30"><img align=absmiddle src="/cPanel_magic_revision_1370377684/cjt/images/icons/success.png"></td></tr></table>
      </rawout>
      <status>1</status>
      <statusmsg>Account Creation Ok</statusmsg>
   </result>
</createacct>

Note:

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

Parameters

Parameter Type Description Possible values Example

username

string

Required

The new account's username.

A valid cPanel username. cPanel usernames must adhere to the following guidelines:

The first eight characters of usernames must be unique.
Usernames cannot begin with a number, or the string test.

The number of characters that usernames may contain depends on the cPanel & WHM version that the server runs:

Version	Characters
11.38 and earlier	Eight characters or less.
11.40 through 11.42	Eight characters or less with database prefixing. 16 characters or less without database prefixing.
11.44 and later	16 characters or less.

Notes:

You can use the Cpanel::Validate::Username Perl module to validate usernames before you call this function. For more information, read the /usr/local/cpanel/Cpanel/Validate/Username.pod file.
The system automatically converts this value to all lowercase letters.
In cPanel & WHM version 11.56 and newer, MySQL's unique character limit requirement does not exist on servers that use MariaDB.

user

domain

string

Required

The account's main domain.

A valid domain name.

example.com

plan

string

The account's hosting plan.

Important:

If you supply a plan value, we recommend that you do not use the optional quota-related parameters, below. Instead, allow the account's plan to determine these values.

This parameter defaults to the default plan.

A hosting plan (package) name on the server.

package_name

pkgname

string

A new plan name, to save unique account settings as a new plan.

If you do not use this parameter but specify 1 for the savepkg value, the system will generate a plan name.
If you do not use this parameter and specify 0 or do not use the savepkg parameter, the function does not save a new plan.

A valid plan (package) name.

my_new_package

savepkg

Boolean

Whether to save the new account's settings as a new plan.

This parameter defaults to 0.

1 — Save.
0 — Do not save.

1

featurelist

string

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.

feature_list

quota

integer

The account's disk space quota.

This parameter defaults to 0 (unlimited).

A positive integer between one and 999,999 that represents the maximum disk space that the account may use, in Megabytes (MB).
0 — The account's disk space is unlimited.

500

password

string

The account's password.

A secure password.

12345luggage

ip

string

Whether the account has 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

cgi

Boolean

Whether CGI access is enabled for the account.

This parameter defaults to 1.

1 — Enabled.
0 — Disabled.

1

spamassassin

Boolean

Whether Apache SpamAssassin™ is enabled for the account.

This parameter defaults to 1.

Note:

We introduced this parameter in cPanel & WHM version 70.

1 — Enabled.
0 — Disabled.

1

frontpage

Boolean

Whether Microsoft® FrontPage Extensions are enabled for the 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.

1 — Enabled.
0 — Disabled.

0

hasshell

Boolean

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

This parameter defaults to 1.

1 — Enabled.
0 — Disabled.

1

contactemail string The account's contact email address. A valid email address. user@example.com

cpmod

string

The account's cPanel theme.

This parameter defaults to the server's default cPanel theme.

paper_lantern
A valid theme on the server.

paper_lantern

maxftp

string

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 — The account possesses unlimited FTP accounts.

unlimited

maxsql

string

The account's maximum number of each available type of SQL database.

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 unlimited.

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

unlimited

maxpop

string

The account's maximum number of email accounts.

This parameter defaults to unlimited.

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

unlimited

maxlst

string

The account's maximum number of mailing lists.

This parameter defaults to unlimited.

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

unlimited

maxsub

string

The account's maximum number of subdomains.

This parameter defaults to unlimited.

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

unlimited

maxpark

string

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

This parameter defaults to 0.

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

unlimited

maxaddon

string

The account's maximum number of addon domains.

This parameter defaults to 0.

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

unlimited

bwlimit

string

The account's maximum bandwidth use.

This parameter defaults to unlimited.

A positive integer between one and 999,999 that represents the maximum bandwidth use, in Megabytes (MB).
0, unlimited, or null — The account possesses unlimited bandwidth.

unlimited

customip

string

The account's IP address.

If you do not specify a value, the system automatically determines the account's IP address.

A valid IP address.

10.0.0.1

language

string

The account's default locale.

This value defaults to the server's default locale.

A two-letter ISO-3166 code.

en

useregns

Boolean

Whether to use registered nameservers for the domain.

This value defaults to 0.

Important:

If you set this parameter to 1, you must also include the hasuseregns parameter with a value of 1.

1 — Use registered nameservers.
0 — Use the server's default nameservers.

0

hasuseregns

Boolean

A legacy parameter.

Important:

Only include this parameter if you set a useregns value of 1.

1

reseller

Boolean

Whether to grant the account reseller privileges.

This parameter defaults to 0.

1 — Grant reseller privileges.
0 — Do not grant reseller privileges.

0

forcedns

Boolean

Whether to overwrite an existing DNS zone with the new account's information, if a matching DNS zone already exists.

This parameter defaults to 0.

1 — Overwrite.
0 — Do not overwrite.

0

mailbox_format

string

A mailbox format to use, if you do not wish to use the system's default mailbox format.

Notes:

Use this parameter when you transfer between servers that use a different mailbox format on each server.
We introduced this parameter in cPanel & WHM version 62.

This parameter defaults to equal The mailbox storage format for new accounts setting in the Mail section of WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).

mdbox
maildir

mdbox

mxcheck

string

The account's main mail exchanger's type.

Note:

The function does not configure the primary MX entry to point to the appropriate exchanger. You must perform this function separately.

This parameter defaults to local.

local
secondary
remote
auto

auto

max_email_per_hour

string

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

This parameter defaults to unlimited.

Note:

We introduced this parameter in cPanel & WHM version 11.32.

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

unlimited

max_emailacct_quota

string

The maximum size 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_quotaparameter, this function will overwrite the plan's defined value for that cPanel account.
We recommend that you allow the account's plan to determine this value.

Note:

We introduced this parameter in cPanel & WHM version 70.

This parameter defaults to 1024.

A positive integer between one and 4,294,967,296.
unlimited — The account possesses an unlimited quota.

1024

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.

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

unlimited

uid

string

The account's user ID.

Notes:

We introduced this parameter in cPanel & WHM version 11.32.
To use this parameter, the function's caller must authenticate as the root user.

A positive integer that is not already associated with disk usage, and that does not already exist on the server.

123456789

gid

string

The account's group ID.

Notes:

We introduced this parameter in cPanel & WHM version 11.32.
To use this parameter, the function's caller must authenticate as the root user.

A positive integer that is not already associated with disk usage, and that does not already exist on the server.

123456789

homedir

string

The account's home directory.

If you do not specify a value, the system uses the /home/user directory, where user is the account's username.

Notes:

We introduced this parameter in cPanel & WHM version 11.34.
To use this parameter, the function's caller must authenticate as the root user.

The absolute path to a location on the server.

/home/user

dkim

Boolean

Whether DKIM is enabled for the account.

This parameter defaults to the Enable DKIM on domains for newly created accounts setting's value in WHM's Tweak Settings interface (WHM >> Home >> System Configuration >> Tweak Settings).

1 — Enabled.
0 — Disabled.

1

spf

Boolean

Whether SPF is enabled for the account.

This parameter defaults to the Enable SPF on domains for newly created accounts setting's value in WHM's Tweak Settings interface (WHM >> Home >> System Configuration >> Tweak Settings).

1 — Enabled.
0 — Disabled.

1

owner

string

The name of the account owner.

This parameter defaults to the authenticated user.

root
A valid reseller account username on the server.

root

Returns

Return	Type	Description	Possible values	Example
`options`	hash	A hash of account options.	This hash contains the `nameserver`, `nameserver`, `nameservera`, `nameserverentry*`, and `ip` returns.
`nameserver`	string	The account's primary nameserver. The function returns this value in the `options` hash.	A valid nameserver.	`ns1.example-host.com`
`nameserver*`	string	The account's additional nameservers, where `*` is a number that indicates their priority order. The function returns this value in the `options` hash.	A valid nameserver.	`ns2.example-host.com`
`nameservera*`	string	The account's nameservers' IP addresses, where `*` is a number that indicates their priority order. The function returns this value in the `options` hash.	A valid IP address.	`10.0.0.1`
`nameserverentry*`	string	The nameserver's DNS name, where `*` is a number that indicates their priority order. The function returns this value in the `options` hash.	A valid DNS entry name.	`dnsentry1`
`ip`	string	The account's primary nameserver's IP address. The function returns this value in the `options` hash.	A valid IP address.	`10.0.0.1`
`package`	string	The account's plan (package) name. The function returns this value in the `options` hash.	A valid package name.	`package_name`
`rawout`	string	Raw output from the account creation operation.	One or more messages that may contain HTML code.	Click to view... <table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Checking input data......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Validating system setup......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Rebuilding IP Pool...System has 0 free ips.\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Validating IP......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Validating Username......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Validating Contact Email......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Checking for database conflicts......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>WWWAcct 12.6.0 (c) 2014 cPanel, Inc....\n\nForced Dns is enabled.\n+===================================+\n\| New Account Info \|\n+===================================+\n\| Domain: example.com\n\| Ip: 192.168.0.1 (n)\n\| HasCgi: y\n\| UserName: user\n\| PassWord: 12345luggage\n\| CpanelMod: paper_lantern\n\| HomeRoot: /home\n\| Quota: 0 Meg\n\| NameServer1: ns1.example-host.com\n\| NameServer2: ns2.example-host.com\n\| NameServer3: \n\| NameServer4: \n\| Contact Email: user@seconddomain.com\n\| Package: package_name\n\| Feature List: default\n\| Language: en\n+===================================+\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Running pre creation script (/usr/local/cpanel/scripts/prewwwacct)......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Adding User...Adding Shell Access (y)\nSuccess...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Adding Entries to userdata......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Updating the userdata cache......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting up Mail & Local Domains...locDOComains...valiases ...vdomainaliases...vfilters......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Configuring DNS...Bind reconfiguring on sarah using rndc\nZone example.com has been successfully added\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Updating Authentication Databases......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Adding Entries to httpd.conf......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Restarting apache......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting passwords...Password for “user” has been changed.\nUpdating FTP passwords for user\nFTP password files updated.\nFTP vhost passwords synced\n...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Updating the dedicated IP address usage cache......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Verifying MX Records and Setting up Databases...Reconfiguring Mail Routing:\n<ul><li>LOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for example.com's mail.:<br /> This configuration has been manually selected.<br /><br /></li></ul>...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting up Proxy Subdomains......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\nBind reloading on sarah using rndc zone: [example.com]\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Sending Account Information......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\nSystem has 0 free ips.\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Running post creation scripts (/usr/local/cpanel/scripts/legacypostwwwacct, /usr/local/cpanel/scripts/postwwwacct, /usr/local/cpanel/scripts/postwwwacctuser)......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\nwwwacct creation finished\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting up Domain Pointers......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Setting Reseller Privs......Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n<table style=\"border-bottom: 1px #ccc dotted;\"><tr><td width=\"100%\"><pre>Account Creation Complete!!!...Account Creation Ok...Done</pre></td><td width=\"30\"><img align=absmiddle src=\"/cPanel_magic_revision_1370377684/cjt/images/icons/success.png\"></td></tr></table>\n
`status`	Boolean	Whether the function succeeded.	`1` — Success. `0` — Failure.	`1`
`statusmsg`	string	A message of success or a reason for failure.	`Account Creation Ok` An error message.	`Account Creation Ok`

Function information

API Version:

WHM API 1

Available in:

WHM 11.32+

Methods:

GET, POST

Required Parameters:

username, domain

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Functions - myprivs — This function retrieves the current user's privileges.
Page:

WHM API 1 Functions - domainuserdata — This function retrieves domain data.
Page:

WHM API 1 Functions - editquota — This function modifies a user's disk quota.
Page:

WHM API 1 Functions - forcepasswordchange — This function forces a user to change the account password after the next login attempt.
Page:

WHM API 1 Functions - has_digest_auth — This function checks whether Digest Authentication is enabled for a cPanel user.

Child pages

WHM API 1 Functions - createacct

Description

Examples

Parameters

Returns

Function information

About WHM API 1

Find a function

Related functions