Return all privilege lists and settings

This function lists the server's Access Control Lists (ACLs) and each list's privileges.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  listacls

Response samples

Content type
application/json
{
  • "data": {
    • "acl": [
      • {
        • "name": "acl1",
        • "privileges": {
          • "acct-summary": 1,
          • "add-pkg": 1,
          • "add-pkg-ip": 1,
          • "add-pkg-shell": 1,
          • "all": 1,
          • "allow-addoncreate": 1,
          • "allow-emaillimits-pkgs": 1,
          • "allow-parkedcreate": 1,
          • "allow-shell": 1,
          • "allow-unlimited-bw-pkgs": 1,
          • "allow-unlimited-disk-pkgs": 1,
          • "allow-unlimited-pkgs": 1,
          • "basic-system-info": 1,
          • "basic-whm-functions": 1,
          • "clustering": 1,
          • "cors-proxy-get": 1,
          • "cpanel-api": 1,
          • "cpanel-integration": 1,
          • "create-acct": 1,
          • "create-dns": 1,
          • "create-user-session": 1,
          • "demo-setup": 1,
          • "digest-auth": 1,
          • "edit-account": 1,
          • "edit-dns": 1,
          • "edit-mx": 1,
          • "edit-pkg": 1,
          • "frontpage": 1,
          • "generate-email-config": 1,
          • "kill-acct": 1,
          • "kill-dns": 1,
          • "limit-bandwidth": 1,
          • "list-accts": 1,
          • "list-pkgs": 1,
          • "locale-edit": 1,
          • "mailcheck": 1,
          • "manage-api-tokens": 1,
          • "manage-dns-records": 1,
          • "manage-oidc": 1,
          • "manage-styles": 1,
          • "mysql-info": 1,
          • "news": 1,
          • "ns-config": 1,
          • "park-dns": 1,
          • "passwd": 1,
          • "quota": 1,
          • "rearrange-accts": 1,
          • "resftp": 1,
          • "restart": 1,
          • "show-bandwidth": 1,
          • "ssl": 1,
          • "ssl-buy": 1,
          • "ssl-gencrt": 1,
          • "ssl-info": 1,
          • "stats": 1,
          • "status": 1,
          • "suspend-acct": 1,
          • "thirdparty": 1,
          • "track-email": 1,
          • "upgrade-account": 1,
          • "viewglobalpackages": 1
          }
        }
      ]
    },
  • "metadata": {
    • "command": "listacls",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}