WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
Request
This function lists the server's Access Control Lists (ACLs) and each list's privileges.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/listacls
- A server running WHM.
https://whm-server.tld:2087/json-api/listacls
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/listaclsResponse
application/json
{ "data": { "acl": [ … ] }, "metadata": { "command": "listacls", "reason": "OK", "result": 1, "version": 1 } }
Request
This function creates or modifies an Access Control List (ACL).
Note:
For each acl-* parameter, a value of 1 adds that privilege to the ACL list and a value of 0 removes that privilege from the ACL list.
Warning:
We strongly recommend that WHM users create and edit ACLs and ACL privileges through WHM's Edit Reseller Nameservers and Privileges interface ( WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges ).
Security
BasicAuth
Query
The ACL to assign to the reseller.
Note:
To modify an existing ACL, set this value to that ACL's name.
Example: acllist=my_acl_list
Whether to allow the reseller to view an account summary.
Default 0
Enum01
Example: acl-acct-summary=1
Whether to allow the reseller to add and remove hosting plans (packages).
Default 0
Enum01
Example: acl-add-pkg=1
Whether to allow the reseller to create packages with a dedicated IP address.
Default 0
Enum01
Example: acl-add-pkg-ip=1
Whether to allow the reseller to create packages with shell access.
Default 0
Enum01
Example: acl-add-pkg-shell=1
Whether to grant the reseller all privileges.
Warning:
A value of 1 grants root-level privileges to the reseller.
Default 0
Enum01
Example: acl-all=1
Whether to allow the reseller to create packages with addon domains.
Default 0
Enum01
Example: acl-allow-addoncreate=1
Whether to allow the reseller to create packages with custom email quotas.
Default 0
Enum01
Example: acl-allow-emaillimits-pkgs=1
Whether to allow the reseller to create packages with parked domains (aliases).
Default 0
Enum01
Example: acl-allow-parkedcreate=1
Whether to allow the reseller to create accounts with shell access.
Default 0
Enum01
Example: acl-allow-shell=1
Whether to allow the reseller to create packages with unlimited bandwidth.
Default 0
Enum01
Example: acl-allow-unlimited-bw-pkgs=1
Whether to allow the reseller to create packages with unlimited disk space.
Default 0
Enum01
Example: acl-allow-unlimited-disk-pkgs=1
Whether to allow the reseller to create packages with unlimited features.
Default 0
Enum01
Example: acl-allow-unlimited-pkgs=1
Whether to allow the reseller to retrieve basic system information.
Default 0
Enum01
Example: acl-basic-system-info=1
Whether to allow the reseller to access basic cPanel & WHM options.
Default 0
Enum01
Example: acl-basic-whm-functions=1
Whether to allow the reseller to use DNS clusters.
Default 0
Enum01
Example: acl-clustering=1
Whether to allow the reseller to perform Cross-Origin Resource Sharing (CORS) HTTP requests.
Default 0
Enum01
Example: acl-cors-proxy-get=1
Whether to allow the reseller to execute cPanel API 1, cPanel API 2 and UAPI functions via WHM.
Default 0
Enum01
Example: acl-cpanel-api=1
Whether to allow the reseller to manage how their server and its services connect to other servers and services.
Default 0
Enum01
Example: acl-cpanel-integration=1
Whether to allow the reseller to create accounts.
Default 0
Enum01
Example: acl-create-acct=1
Whether to allow the reseller to add DNS zones.
Default 0
Enum01
Example: acl-create-dns=1
Whether to allow the reseller to create a temporary user session for a specified service.
Notes:
This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our Manage API Tokens documentation.
Default 0
Enum01
Example: acl-create-user-session=1
Whether to allow the reseller to enable demo mode for accounts.
Default 0
Enum01
Example: acl-demo-setup=1
Whether to allow the reseller to manage Digest Authentication support.
Default 0
Enum01
Example: acl-digest-auth=1
Whether to allow the reseller to edit accounts.
Default 0
Enum01
Example: acl-edit-account=1
Whether to allow the reseller to edit DNS zones.
Default 0
Enum01
Example: acl-edit-dns=1
Whether to allow the reseller to edit MX entries.
Default 0
Enum01
Example: acl-edit-mx=1
Whether to allow the reseller to edit hosting plans (packages).
Default 0
Enum01
Example: acl-edit-pkg=1
Whether to allow the reseller to generate a mobile configuration profile for an email account.
Default 0
Enum01
Example: acl-generate-email-config=1
Whether to allow the reseller to terminate accounts.
Default 0
Enum01
Example: acl-kill-acct=1
Whether to allow the reseller to remove DNS zones.
Default 0
Enum01
Example: acl-kill-dns=1
Whether to allow the reseller to modify bandwidth limits (quotas).
Warning:
If you do not use resource limits, a value of 1 allows resellers to circumvent package limits for disk space.
Default 0
Enum01
Example: acl-limit-bandwidth=1
Whether to allow the reseller to view the list of accounts.
Default 0
Enum01
Example: acl-list-accts=1
Whether to allow the reseller to view existing hosting plans (packages).
Default 0
Enum01
Example: acl-list-pkgs=1
Whether to allow the reseller to create and modify locales on the server.
Default 0
Enum01
Example: acl-locale-edit=1
Whether to allow the reseller to troubleshoot mail delivery.
Default 0
Enum01
Example: acl-mailcheck=1
Whether to allow the reseller to manage API tokens.
Notes:
This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our Manage API Tokens documentation.
Default 0
Enum01
Example: acl-manage-api-tokens=1
Whether to allow the reseller to manage DNS records.
Default 0
Enum01
Example: acl-manage-dns-records=1
Whether to allow the reseller to manage external authentication for their accounts.
Default 0
Enum01
Example: acl-manage-oidc=1
Whether to allow the reseller to manage their server's cPanel styles.
Default 0
Enum01
Example: acl-manage-styles=1
Whether to allow the reseller to retrieve MySQL® database and user data.
Default 0
Enum01
Example: acl-mysql-info=1
Whether to allow the reseller to modify the server's news.
Default 0
Enum01
Example: acl-news=1
Whether to allow the reseller to manage nameservers.
Default 0
Enum01
Example: acl-ns-config=1
Whether to allow the reseller to park DNS zones.
Default 0
Enum01
Example: acl-park-dns=1
Whether to allow the reseller to change passwords.
Note:
This privilege allows an API token user to change account passwords and log in with a new password. For more information, read our Manage API Tokens documentation.
Default 0
Enum01
Example: acl-passwd=1
Whether to allow the reseller to modify quotas.
Warning:
If you do not use resource limits, this privilege allows resellers to circumvent package limits for disk space.
Default 0
Enum01
Example: acl-quota=1
Whether to allow the reseller to rearrange accounts.
Default 0
Enum01
Example: acl-rearrange-accts=1
Whether to allow the reseller to resync FTP passwords.
Default 0
Enum01
Example: acl-resftp=1
Whether to allow the reseller to restart services.
Default 0
Enum01
Example: acl-restart=1
Whether to allow the reseller to view account bandwidth usage.
Default 0
Enum01
Example: acl-show-bandwidth=1
Whether to allow the reseller to perform SSL site management.
Default 0
Enum01
Example: acl-ssl=1
Whether to allow the reseller to purchase SSL certificates.
Default 0
Enum01
Example: acl-ssl-buy=1
Whether to allow the reseller to generate SSL certificates.
Default 0
Enum01
Example: acl-ssl-gencrt=1
Whether to allow the reseller to view their server's SSL information.
Default 0
Enum01
Example: acl-ssl-info=1
Whether to allow the reseller to view server information.
Default 0
Enum01
Example: acl-stats=1
Whether to allow the reseller to view the server's status.
Default 0
Enum01
Example: acl-status=1
Whether to allow the reseller to suspend or unsuspend accounts.
Default 0
Enum01
Example: acl-suspend-acct=1
Whether to allow the reseller to manage third-party services.
Default 0
Enum01
Example: acl-thirdparty=1
Whether to allow the reseller to view reports about email message delivery attempts from their account.
Default 0
Enum01
Example: acl-track-email=1
Whether to allow the reseller to upgrade or downgrade accounts.
Default 0
Enum01
Example: acl-upgrade-account=1
Whether to allow the reseller to use all global packages. For more information, read our reseller packages documentation.
Default 0
Enum01
Example: acl-viewglobalpackages=1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/saveacllist
- A server running WHM.
https://whm-server.tld:2087/json-api/saveacllist
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/saveacllist?acllist=my_acl_list&acl-acct-summary=1&acl-add-pkg=1&acl-add-pkg-ip=1&acl-add-pkg-shell=1&acl-all=1&acl-allow-addoncreate=1&acl-allow-emaillimits-pkgs=1&acl-allow-parkedcreate=1&acl-allow-shell=1&acl-allow-unlimited-bw-pkgs=1&acl-allow-unlimited-disk-pkgs=1&acl-allow-unlimited-pkgs=1&acl-basic-system-info=1&acl-basic-whm-functions=1&acl-clustering=1&acl-cors-proxy-get=1&acl-cpanel-api=1&acl-cpanel-integration=1&acl-create-acct=1&acl-create-dns=1&acl-create-user-session=1&acl-demo-setup=1&acl-digest-auth=1&acl-edit-account=1&acl-edit-dns=1&acl-edit-mx=1&acl-edit-pkg=1&acl-generate-email-config=1&acl-kill-acct=1&acl-kill-dns=1&acl-limit-bandwidth=1&acl-list-accts=1&acl-list-pkgs=1&acl-locale-edit=1&acl-mailcheck=1&acl-manage-api-tokens=1&acl-manage-dns-records=1&acl-manage-oidc=1&acl-manage-styles=1&acl-mysql-info=1&acl-news=1&acl-ns-config=1&acl-park-dns=1&acl-passwd=1&acl-quota=1&acl-rearrange-accts=1&acl-resftp=1&acl-restart=1&acl-show-bandwidth=1&acl-ssl=1&acl-ssl-buy=1&acl-ssl-gencrt=1&acl-ssl-info=1&acl-stats=1&acl-status=1&acl-suspend-acct=1&acl-thirdparty=1&acl-track-email=1&acl-upgrade-account=1&acl-viewglobalpackages=1'Response
application/json
{ "metadata": { "command": "saveacllist", "reason": "ACL List my_acl_list saved.", "result": 1, "version": 1 } }
Request
This function creates or modifies an Access Control List (ACL).
Note:
For each acl-* parameter, any value adds that privilege to the ACL list and no value removes that privilege from the ACL list.
Warning:
We strongly recommend that WHM users create and edit ACLs and ACL privileges through WHM's Edit Reseller Nameservers and Privileges interface ( WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges ).
Security
BasicAuth
Query
Whether to allow the reseller to view an account summary.
Value1
Example: acl-acct-summary=1
Whether to allow the reseller to add and remove hosting plans (packages).
Value1
Example: acl-add-pkg=1
Whether to allow the reseller to create packages with a dedicated IP address.
Value1
Example: acl-add-pkg-ip=1
Whether to allow the reseller to create packages with shell access.
Value1
Example: acl-add-pkg-shell=1
Whether to grant the reseller all ACL privileges.
Warning:
A value of 1 grants root-level privileges to the reseller.
Value1
Example: acl-all=1
Whether to allow the reseller to create packages with addon domains.
Value1
Example: acl-allow-addoncreate=1
Whether to allow the reseller to create packages with parked domains (aliases).
Value1
Example: acl-allow-parkedcreate=1
Whether to allow the reseller to create packages with unlimited bandwidth.
Value1
Example: acl-allow-unlimited-bw-pkgs=1
Whether to allow the reseller to create packages with unlimited disk space.
Value1
Example: acl-allow-unlimited-disk-pkgs=1
Whether to allow the reseller to create packages with unlimited features.
Value1
Example: acl-allow-unlimited-pkgs=1
Whether to allow the reseller to retrieve basic system information.
Value1
Example: acl-basic-system-info=1
Whether to allow the reseller to access basic cPanel & WHM options.
Value1
Example: acl-basic-whm-functions=1
Whether to allow the reseller to use DNS clusters.
Value1
Example: acl-clustering=1
Whether to allow the reseller to perform Cross-Origin Resource Sharing (CORS) HTTP requests.
Value1
Example: acl-cors-proxy-get=1
Whether to allow the reseller to execute cPanel API 1, cPanel API 2 and UAPI functions via WHM.
Value1
Example: acl-cpanel-api=1
Whether to allow the reseller to manage how their server and its services connect to other servers and services.
Value1
Example: acl-cpanel-integration=1
Whether to allow the reseller to create accounts.
Value1
Example: acl-create-acct=1
Whether to allow the reseller to add DNS zones.
Value1
Example: acl-create-dns=1
Whether to allow the reseller to create a temporary session user for a specified service.
Note:
This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our Manage API Tokens documentation.
Value1
Example: acl-create-user-session=1
Whether to allow the reseller to enable demo mode for accounts.
Value1
Example: acl-demo-setup=1
Whether to allow the reseller to manage Digest Authentication support.
Value1
Example: acl-digest-auth=1
Whether to allow the reseller to create accounts with shell access.
Value1
Example: acl-disallow-shell=1
Whether to allow the reseller to edit accounts.
Value1
Example: acl-edit-account=1
Whether to allow the reseller to edit hosting plans (packages).
Value1
Example: acl-edit-pkg=1
Whether to allow the reseller to generate a mobile configuration profile for an email account.
Value1
Example: acl-generate-email-config=1
Whether to allow the reseller to terminate accounts.
Value1
Example: acl-kill-acct=1
Whether to allow the reseller to remove DNS zones.
Value1
Example: acl-kill-dns=1
Whether to allow the reseller to modify bandwidth limits (quotas).
Warning:
If you do not use resource limits, a value of 1 allows resellers to circumvent package limits for disk space.
Value1
Example: acl-limit-bandwidth=1
Whether to allow the reseller to view the list of accounts.
Value1
Example: acl-list-accts=1
Whether to allow the reseller to view existing hosting plans (packages).
Value1
Example: acl-list-pkgs=1
Whether to allow the reseller to create and modify locales on the server.
Value1
Example: acl-locale-edit=1
Whether to allow the reseller to troubleshoot mail delivery.
Value1
Example: acl-mailcheck=1
Whether to allow the reseller to manage API tokens.
Note:
This privilege allows an API token user to bypass any restrictions that you set on the API token. For more information, read our Manage API Tokens documentation.
Value1
Example: acl-manage-api-tokens=1
Whether to allow the reseller to manage DNS records.
Value1
Example: acl-manage-dns-records=1
Whether to allow the reseller to manage external authentication for their accounts.
Value1
Example: acl-manage-oidc=1
Whether to allow the reseller to manage their server's cPanel styles.
Value1
Example: acl-manage-styles=1
Whether to allow the reseller to retrieve MySQL® database and user data.
Value1
Example: acl-mysql-info=1
Whether to allow the reseller to manage nameservers.
Value1
Example: acl-nameserver-config=1
Whether to allow the reseller to modify the server's news.
Value1
Example: acl-news=1
Whether to allow the reseller to change passwords.
Note:
This privilege allows an API token user to change account passwords and log in with a new password. For more information, read our Manage API Tokens documentation.
Value1
Example: acl-passwd=1
Whether to allow the reseller to modify quotas.
Warning:
If you do not use resource limits, a value of 1 allows resellers to circumvent package limits for disk space.
Value1
Example: acl-quota=1
Whether to allow the reseller to rearrange accounts.
Value1
Example: acl-rearrange-accts=1
Whether to allow the reseller to resync FTP passwords.
Value1
Example: acl-resftp=1
Whether to allow the reseller to view account bandwidth usage.
Value1
Example: acl-show-bandwidth=1
Whether to allow the reseller to perform SSL site management.
Value1
Example: acl-ssl=1
Whether to allow the reseller to purchase SSL certificates.
Value1
Example: acl-ssl-buy=1
Whether to allow the reseller to generate SSL certificates.
Value1
Example: acl-ssl-gencrt=1
Whether to allow the reseller to view their server's SSL information.
Value1
Example: acl-ssl-info=1
Whether to allow the reseller to view server information.
Value1
Example: acl-stats=1
Whether to allow the reseller to view the server's status.
Value1
Example: acl-status=1
Whether to allow the reseller to suspend or unsuspend accounts.
Value1
Example: acl-suspend-acct=1
Whether to allow the reseller to manage third-party services.
Value1
Example: acl-thirdparty=1
Whether to allow the reseller to view reports about email message delivery attempts from their account.
Value1
Example: acl-track-email=1
Whether to allow the reseller to upgrade or downgrade accounts.
Value1
Example: acl-upgrade-account=1
Whether to allow the reseller to use all global packages. For more information, read our reseller packages documentation.
Value1
Example: acl-viewglobalpackages=1
The ACL to assign to the reseller.
Warning:
Functions should either use this parameter, or a combination of the acl-* parameters below. Do not include both in a single function.
Example: acllist=my_acl_list
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/setacls
- A server running WHM.
https://whm-server.tld:2087/json-api/setacls
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/setacls?reseller=username&acl-acct-summary=1&acl-add-pkg=1&acl-add-pkg-ip=1&acl-add-pkg-shell=1&acl-all=1&acl-allow-addoncreate=1&acl-allow-parkedcreate=1&acl-allow-unlimited-bw-pkgs=1&acl-allow-unlimited-disk-pkgs=1&acl-allow-unlimited-pkgs=1&acl-basic-system-info=1&acl-basic-whm-functions=1&acl-clustering=1&acl-cors-proxy-get=1&acl-cpanel-api=1&acl-cpanel-integration=1&acl-create-acct=1&acl-create-dns=1&acl-create-user-session=1&acl-demo-setup=1&acl-digest-auth=1&acl-disallow-shell=1&acl-edit-account=1&acl-edit-dns=1&acl-edit-mx=1&acl-edit-pkg=1&acl-generate-email-config=1&acl-kill-acct=1&acl-kill-dns=1&acl-limit-bandwidth=1&acl-list-accts=1&acl-list-pkgs=1&acl-locale-edit=1&acl-mailcheck=1&acl-manage-api-tokens=1&acl-manage-dns-records=1&acl-manage-oidc=1&acl-manage-styles=1&acl-mysql-info=1&acl-nameserver-config=1&acl-news=1&acl-park-dns=1&acl-passwd=1&acl-quota=1&acl-rearrange-accts=1&acl-resftp=1&acl-restart=1&acl-show-bandwidth=1&acl-ssl=1&acl-ssl-buy=1&acl-ssl-gencrt=1&acl-ssl-info=1&acl-stats=1&acl-status=1&acl-suspend-acct=1&acl-thirdparty=1&acl-track-email=1&acl-upgrade-account=1&acl-viewglobalpackages=1&acllist=my_acl_list&user=username'Response
application/json
{ "data": { "acl": [ … ] }, "metadata": { "command": "setacls", "reason": "OK", "result": 1, "version": 1 } }