- Created by Documentation, last modified on Feb 08, 2019
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function creates a cPanel account. The function also sets up the new account's domain information.
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
https://hostname.example.com:2087/cpsess##########/json-api/createacct?api.version=1&username=user&domain=example.com&plan=package_name&featurelist=default"a=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
https://hostname.example.com:2087/cpsess##########/xml-api/createacct?api.version=1&username=user&domain=example.com&plan=package_name&featurelist=default"a=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
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. If you run CloudLinux™, you must use the full path of the
whmapi1
command:/usr/local/cpanel/bin/whmapi1
{ "data": { "ip": "10.215.218.151", "nameserver": "ns1.dev.cpanel.net", "nameserver2": "ns2.dev.cpanel.net", "nameserver3": "", "nameserver4": "", "nameservera": null, "nameservera2": null, "nameservera3": null, "nameservera4": null, "nameserverentry": null, "nameserverentry2": null, "nameserverentry3": null, "nameserverentry4": null, "package": "default" }, "metadata": { "command": "createacct", "output": { "raw": "Checking input data...Dns Zone check is enabled.\nValidating Username......Done\nValidating IP......Done\nValidating Contact Email......Done\n...Done\nValidating system setup......Done\nChecking for database conflicts......Done\nWWWAcct 12.6.0 (c) 2018 cPanel, Inc....\n\n+===================================+\n| New Account Info |\n+===================================+\n| Domain: mrsloth.com\n| Ip: 10.215.218.151 (n)\n| HasCgi: y\n| UserName: mrsloth\n| PassWord: GXOXeESJSQsDLh\n| CpanelMod: paper_lantern\n| HomeRoot: /home\n| Quota: unlimited\n| NameServer1: ns1.dev.cpanel.net\n| NameServer2: ns2.dev.cpanel.net\n| NameServer3: \n| NameServer4: \n| Contact Email: \n| Package: default\n| Feature List: default\n| Language: en\n+===================================+\n...Done\nCustom Account Data Provided: no\nRunning pre creation script (/usr/local/cpanel/scripts/prewwwacct)......Done\nAdding User...Removing Shell Access (n)\nSuccess...Done\nAdding Entries to userdata......Done\nSetting up Mail & Local Domains...localdomains...valiases ...vdomainaliases ...vfilters ......Done\nConfiguring DNS...Zone mrsloth.com has been successfully added\n...Done\nVerifying MX Records and Setting up Databases...Reconfiguring Mail Routing:\nLOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for mrsloth.com's mail.:\n This configuration has been manually selected.\n\n...Done\nSetting up Service Subdomains......Done\nUpdating Authentication Databases......Done\nSetting passwords......Done\nUpdating the userdata cache......Done\nSetting up Horde database in the background.......Done\nCreating bandwidth datastore......Done\nUpdating user’s Apache jail filesystem......Done\nUpdating the dedicated IP address usage cache......Done\nGenerating and installing DKIM keys......Done\nEnabling Apache SpamAssassin™......Done\nSending Account Information......Done\nRunning post creation scripts (/usr/local/cpanel/scripts/legacypostwwwacct, /usr/local/cpanel/scripts/postwwwacct, /usr/local/cpanel/scripts/postwwwacctuser)......Done\nwwwacct creation finished\nSetting up Domain Pointers......Done\nSetting Reseller Privs......Done\nAccount Creation Complete!!!...Account Creation Ok...Done\n" }, "reason": "Account Creation Ok", "result": 1, "version": 1 } }
<data> <ip>10.215.218.151</ip> <nameserver>ns1.dev.cpanel.net</nameserver> <nameserver2>ns2.dev.cpanel.net</nameserver2> <nameserver3></nameserver3> <nameserver4></nameserver4> <nameservera /> <nameservera2 /> <nameservera3 /> <nameservera4 /> <nameserverentry /> <nameserverentry2 /> <nameserverentry3 /> <nameserverentry4 /> <package>default</package> </data> <metadata> <command>createacct</command> <output> <raw> Checking input data...Dns Zone check is enabled. Validating Username......Done Validating IP......Done Validating Contact Email......Done ...Done Validating system setup......Done Checking for database conflicts......Done WWWAcct 12.6.0 (c) 2018 cPanel, Inc.... +===================================+ | New Account Info | +===================================+ | Domain: mrsloth.com | Ip: 10.215.218.151 (n) | HasCgi: y | UserName: mrsloth | PassWord: GXOXeESJSQsDLh | CpanelMod: paper_lantern | HomeRoot: /home | Quota: unlimited | NameServer1: ns1.dev.cpanel.net | NameServer2: ns2.dev.cpanel.net | NameServer3: | NameServer4: | Contact Email: | Package: default | Feature List: default | Language: en +===================================+ ...Done Custom Account Data Provided: no Running pre creation script (/usr/local/cpanel/scripts/prewwwacct)......Done Adding User...Removing Shell Access (n) Success...Done Adding Entries to userdata......Done Setting up Mail & Local Domains...localdomains...valiases ...vdomainaliases ...vfilters ......Done Configuring DNS...Zone mrsloth.com has been successfully added ...Done Verifying MX Records and Setting up Databases...Reconfiguring Mail Routing: LOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for mrsloth.com's mail.: This configuration has been manually selected. ...Done Setting up Service Subdomains......Done Updating Authentication Databases......Done Setting passwords......Done Updating the userdata cache......Done Setting up Horde database in the background.......Done Creating bandwidth datastore......Done Updating user’s Apache jail filesystem......Done Updating the dedicated IP address usage cache......Done Generating and installing DKIM keys......Done Enabling Apache SpamAssassin™......Done Sending Account Information......Done Running post creation scripts (/usr/local/cpanel/scripts/legacypostwwwacct, /usr/local/cpanel/scripts/postwwwacct, /usr/local/cpanel/scripts/postwwwacctuser)......Done wwwacct creation finished Setting up Domain Pointers......Done Setting Reseller Privs......Done Account Creation Complete!!!...Account Creation Ok...Done </raw> </output> <reason>Account Creation Ok</reason> <result>1</result> <version>1</version> </metadata>
Note:
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 number of characters that usernames may contain depends on the cPanel & WHM version that the server runs:
Notes:
| 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 This parameter defaults to the | 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.
| 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 |
| 1 | ||||||||
featurelist | string | The account's feature list. If you do not use this parameter, the function assigns the | A valid feature list name on the server. | feature_list | ||||||||
quota | integer | The account's disk space quota. This parameter defaults to |
| 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 | ||||||||
cgi | Boolean | Whether CGI access is enabled for the account. This parameter defaults to |
| 1 | ||||||||
spamassassin | Boolean | Whether Apache SpamAssassin™ is enabled for the account. This parameter defaults to Note: We introduced this parameter in cPanel & WHM version 70. |
| 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:
|
| 0 | ||||||||
hasshell | Boolean | Whether shell (SSH) access is enabled for the account. This parameter defaults to |
| 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 | ||||||||
maxftp | string | The account's maximum number of FTP accounts. This parameter defaults to |
| unlimited | ||||||||
maxsql | string | The account's maximum number of each available type of SQL database. For example, if you set this value to This parameter defaults to |
| unlimited | ||||||||
maxpop | string | The account's maximum number of email accounts. This parameter defaults to |
| unlimited | ||||||||
maxlst | string | The account's maximum number of mailing lists. This parameter defaults to |
| unlimited | ||||||||
maxsub | string | The account's maximum number of subdomains. This parameter defaults to |
| unlimited | ||||||||
maxpark | string | The account's maximum number of parked domains (aliases). This parameter defaults to |
| unlimited | ||||||||
maxaddon | string | The account's maximum number of addon domains. This parameter defaults to |
| unlimited | ||||||||
bwlimit | string | The account's maximum bandwidth use. This parameter defaults to |
| 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 valid ISO 639-1 code. Note:
|
| ||||||||
useregns | Boolean | Whether to use registered nameservers for the domain. This value defaults to Important: If you set this parameter to |
| 0 | ||||||||
hasuseregns | Boolean | A legacy parameter. Important: Only include this parameter if you set a | 1 | 1 | ||||||||
reseller | Boolean | Whether to grant the account reseller privileges. This parameter defaults to |
| 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 | ||||||||
mailbox_format | string | A mailbox format to use, if you do not wish to use the system's default mailbox format. Notes:
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 | ||||||||
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 |
| auto | ||||||||
| string | The maximum number of emails that the account can send in one hour. This parameter defaults to Note: We introduced this parameter in cPanel & WHM version 11.32. |
| unlimited | ||||||||
max_emailacct_quota | string | The maximum size that the account can define when it creates an email account. Important:
Note: We introduced this parameter in cPanel & WHM version 70. This parameter defaults to |
| 1024 | ||||||||
| 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. |
| unlimited | ||||||||
uid | string | The account's user ID. Notes:
| 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:
| 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 Notes:
| 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 | ||||||||
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 | ||||||||
owner | string | The name of the account owner. This parameter defaults to the authenticated user. |
| 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. | |
| string | The account's primary nameserver. The function returns this value in the | A valid nameserver. | ns1.example-host.com |
| string | The account's additional nameservers, where The function returns this value in the | A valid nameserver. | ns2.example-host.com |
| string | The account's nameservers' IP addresses, where The function returns this value in the | A valid IP address. | 10.0.0.1 |
| string | The nameserver's DNS name, where The function returns this value in the | A valid DNS entry name. | dnsentry1 |
| string | The account's primary nameserver's IP address. The function returns this value in the | A valid IP address. | 10.0.0.1 |
| string | The account's plan (package) name. The function returns this value in the | 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 |
statusmsg | string | A message of success or a reason for failure. |
| Account Creation Ok |
Function information
API Version:
Available in:
WHM 11.32+
Methods:
GET, POST
Required Parameters:
username
, domain
Return Formats:
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
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 0 Functions - setresellermainip — This function assigns a main IP address to a reseller's account.
-
Page:WHM API 0 Functions - setresellernameservers — This function assigns nameservers to a reseller's account.
-
Page:WHM API 1 Sections - Accounts — Account functions allow you to manage cPanel accounts, WHM accounts, and their settings.
-
Page:WHM API 1 Functions - accountsummary — This function retrieves a summary of a user's account.
-
Page:WHM API 1 Functions - domainuserdata — This function retrieves domain data.