- Created by Documentation, last modified on Apr 09, 2018
Description
This function lists the reseller's Access Control Lists (ACLs) and each list's privileges.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/listacls
https://hostname.example.com:2087/cpsess##########/xml-api/listacls
whmapi0 listacls
Notes:
- You must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 0 documentation or run the
whmapi0 --helpcommand.
{
"acls":{
"acl1":{
"allow-unlimited-disk-pkgs":0,
"list-pkgs":0,
"basic-system-info":0,
"limit-bandwidth":0,
"news":0,
"add-pkg-shell":0,
"allow-unlimited-pkgs":0,
"suspend-acct":0,
"manage-dns-records":0,
"generate-email-config":0,
"mysql-info":0,
"upgrade-account":0,
"allow-shell":0,
"basic-whm-functions":0,
"manage-api-tokens":0,
"acct-summary":0,
"resftp":0,
"digest-auth":0,
"ns-config":0,
"demo-setup":0,
"list-accts":0,
"edit-account":0,
"create-user-session":0,
"clustering":0,
"create-dns":0,
"cpanel-api":0,
"cpanel-integration":0,
"ssl-buy":0,
"passwd":0,
"status":0,
"restart":0,
"ssl":0,
"park-dns":0,
"locale-edit":0,
"all":1,
"mailcheck":0,
"edit-mx":0,
"edit-pkg":0,
"show-bandwidth":0,
"quota":0,
"edit-dns":0,
"create-acct":0,
"ssl-gencrt":0,
"thirdparty":0,
"stats":0,
"allow-parkedcreate":0,
"rearrange-accts":0,
"add-pkg-ip":0,
"kill-dns":0,
"cors-proxy-get":0,
"manage-styles":0,
"kill-acct":0,
"ssl-info":0,
"allow-unlimited-bw-pkgs":0,
"viewglobalpackages":0,
"add-pkg":0,
"manage-oidc":0,
"allow-emaillimits-pkgs":0,
"allow-addoncreate":0,
"track-email":0
}
}
}
<listacls>
<acls>
<suspend-acct>0</suspend-acct>
<list-accts>0</list-accts>
<mailcheck>0</mailcheck>
<resftp>0</resftp>
<kill-dns>0</kill-dns>
<allow-addoncreate>0</allow-addoncreate>
<ssl-gencrt>0</ssl-gencrt>
<allow-unlimited-bw-pkgs>0</allow-unlimited-bw-pkgs>
<create-dns>0</create-dns>
<edit-account>0</edit-account>
<clustering>0</clustering>
<limit-bandwidth>0</limit-bandwidth>
<allow-emaillimits-pkgs>0</allow-emaillimits-pkgs>
<kill-acct>0</kill-acct>
<quota>0</quota>
<add-pkg>0</add-pkg>
<edit-pkg>0</edit-pkg>
<status>0</status>
<create-acct>0</create-acct>
<edit-dns>0</edit-dns>
<allow-unlimited-pkgs>0</allow-unlimited-pkgs>
<all>1</all>
<ssl-buy>0</ssl-buy>
<show-bandwidth>0</show-bandwidth>
<viewglobalpackages>0</viewglobalpackages>
<restart>0</restart>
<rearrange-accts>0</rearrange-accts>
<add-pkg-shell>0</add-pkg-shell>
<ssl>0</ssl>
<allow-parkedcreate>0</allow-parkedcreate>
<stats>0</stats>
<allow-unlimited-disk-pkgs>0</allow-unlimited-disk-pkgs>
<add-pkg-ip>0</add-pkg-ip>
<passwd>0</passwd>
<locale-edit>0</locale-edit>
<demo-setup>0</demo-setup>
<frontpage>0</frontpage>
<thirdparty>0</thirdparty>
<park-dns>0</park-dns>
<cpanel-api>0</cpanel-api>
<upgrade-account>0</upgrade-account>
<news>0</news>
<edit-mx>0</edit-mx>
<allow-shell>0</allow-shell>
<acct-summary>0</acct-summary>
<basic-whm-functions>0</basic-whm-functions>
<create-user-session>0</create-user-session>
<digest-auth>0</digest-auth>
<cors-proxy-get>0</cors-proxy-get>
<generate-email-config>0</generate-email-config>
<manage-oidc>0</manage-oidc>
<cpanel-integration>0</cpanel-integration>
<manage-styles>0</manage-styles>
<basic-system-info>0</basic/system-info>
<list-pkgs>0</list-pkgs>
<track-email>0</track-email>
<mysql-info>0</mysql-info>
<ssl-info>0</ssl-info>
<manage-api-tokens>0</manage-api-tokens>
<manage-dns-records>0</manage-dns-records>
<ns-config>0</ns-config>
</acls>
</listacls>
Parameters
This function does not accept parameters.
Returns
| Return | Type | Description | Possible values | Example |
|---|---|---|---|---|
acls
| hash | A hash of privileges. | In JSON output, this hash includes the In XML output, this hash includes one or more of the following returns:
This hash also includes any third-party ACL privileges that exist for the user. | |
| hash or string | The ACL's name. The function returns this value in the
| In JSON output, this hash includes one or more of the following returns:
This hash also includes any third-party ACL privileges that exist for the user. In XML output, this return's value is a valid string. | acl1 |
| Boolean | Whether to allow the reseller to view an account summary. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to create packages. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to create packages with dedicated IP addresses. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to create packages with shell access. The function returns this value in the |
| 0 |
| Boolean | Whether to provide the reseller all privileges. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to create packages with addon domains. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to create packages with parked domains (aliases). The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to create packages with unlimited bandwidth. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to create packages with unlimited disk space quotas. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to create packages with unlimited values for features (for example, unlimited email accounts). The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to create an account that possesses shell access. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to retrieve basic system information. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to access to basic cPanel & WHM options. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to configure DNS clusters. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to perform Cross-Origin Resource Sharing (CORS) HTTP requests. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to execute cPanel API 1, cPanel API 2 and UAPI functions via WHM. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to manage how their server and its services connect to other servers and services. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to create accounts. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to create DNS zones. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to create a new temporary user session for a specified service. The function returns this value in the Notes:
|
| 0 |
| Boolean | Whether to allow the reseller to enable demo mode on accounts. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to manage Digest Authentication support. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to create accounts that possess shell access. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to modify accounts. The function returns this value in the Warning: This privilege allows circumvention of account creation limits, gives shell access unless explicitly disallowed, and provides access to dedicated IP addresses, among other features. |
| 0 |
| Boolean | Whether to allow the reseller to edit DNS zones. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to edit MX entries. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to create and delete packages. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to manage Microsoft® FrontPage® Extensions for their domains. The function returns this value in the Note: cPanel & WHM will ignore all Microsoft FrontPage settings and parameters if either of the following statements are true:
|
| 0 |
| Boolean | Whether to allow the reseller to generate a mobile configuration profile for an email account. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to delete his or her customers' accounts. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to delete DNS zones. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to modify bandwidth limits on his or her accounts. The function returns this value in the Warning: This will allow circumvention of account package limits if you do not use resource limits. |
| 0 |
| Boolean | Whether to allow the reseller to list owned accounts. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to view existing hosting plans (packages). The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to create and modify locales on the server. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to access WHM's Mail Troubleshooter interface (Home >> Mail >> Mail Troubleshooter). The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to manage API tokens. The function returns this value in the Notes:
|
| 0 |
| Boolean | Whether to allow the reseller to manage DNS records. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to manage external authentication for their accounts. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to manage their server's cPanel styles. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to retrieve MySQL® database and user data. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to send news messages to customers' accounts. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to manage nameservers. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to park domains within WHM. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to modify passwords for customers' accounts. The function returns this value in the Note: This ACL 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. |
| 0 |
| Boolean | Whether to allow the reseller to modify disk space quotas for accounts. The function returns this value in the Warning: This will allow circumvention of account package limits if you do not use resource limits. |
| 0 |
| Boolean | Whether to allow the reseller to rearrange the locations of customer accounts in order to free up disk space. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to reset shopping carts for their domain accounts. The function returns this value in the Note: We removed this return in cPanel & WHM 11.46. |
| 0 |
| Boolean | Whether to allow the reseller to re-sync FTP account passwords. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to restart services on the server, such as Apache or Exim. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to view the bandwidth usage of accounts. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to manage the SSL certificates installed on domains. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to use WHM's Purchase and Install an SSL Certificate interface (Home >> SSL/TLS >> Purchase and Install an SSL Certificate). The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to use the SSL CSR/CRT generator. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to view their server's SSL information. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to view WHM's Server Information interface (Home >> Server Status >> Server Information). The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to view WHM's Service Status interface (Home >> Server Status >> Service Status). The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to suspend customers' accounts. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to manage third-party service offerings. The function returns this value in the |
| 0 |
| Boolean | Whether to allow resellers to view reports about email message delivery attempts from their account. The function returns this value in the Note: We added this return in cPanel & WHM version 68. |
| 0 |
| Boolean | Whether to allow the reseller to upgrade and downgrade customers' domain accounts. The function returns this value in the |
| 0 |
| Boolean | Whether to allow the reseller to access any package on the server that is not specifically assigned to a user. The function returns this value in the Note: This applies to any package except those with an underscore ( |
| 0 |
Function information
API Version:
WHM API 1 Equivalent:
Important:
We strongly recommend that you use WHM API 1. WHM API 0 is deprecated.
Available in:
WHM 11+
Methods:
GET, POST
Required Parameters:
(none)
Return Formats:
About WHM API 0
Warning:
WHM API 0 is deprecated. We strongly recommend that you use the equivalent WHM API 1 function instead.
Notes:
- Some functions and parameters may require that you authenticate as the
rootuser. - You must use the appropriate WHM ports (
2086or2087) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 0 Functions - acctcounts — This function lists a reseller's total accounts, suspended accounts, and account creation limit.
-
Page:WHM API 0 Functions - getresellerips — This function lists a reseller's available IP addresses.
-
Page:WHM API 0 Functions - listacls — This function lists the reseller's Access Control Lists (ACLs) and each list's privileges.
-
Page:WHM API 0 Functions - listresellers — This function lists the reseller accounts on the server.
-
Page:WHM API 0 Functions - resellerstats — This function lists statistics for a reseller's accounts.