Skip to content
Last updated

Development Guides Home >> Guide to WHM Plugins

Guide to WHM Plugins - ACL Reference Chart

Introduction

cPanel & WHM ships with a default list of Access Control Lists (ACLs) and privileges. You can assign ACLs and privileges to WHM users in WHM's Edit Reseller Nameservers and Privileges interface (WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges).

Available ACLs

Note:

In the tables below, the Feature limit column lists the privilege's name in WHM's Edit Reseller Nameservers and Privileges interface (WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges).

Basic privileges

The following table lists the ACLs for basic privileges and the API functions that use these ACLs:

ACLPrivilege typeFeature limitAssociated WHM API 1 functionsDescription
acct-summaryInitial PrivilegesAccount SummaryView an account's summary.
basic-system-infoInitial PrivilegesBasic System InformationRetrieve basic system information.
basic-whm-functionsInitial PrivilegesBasic WHM FunctionsAccess basic cPanel & WHM options.
connected-applicationsInitial PrivilegesConfigure connected external applicationsManage connections to external applications.
cors-proxy-getThird-Party ServicesAllow CORS HTTP Requestscors_proxy_getPerform Cross-Origin Resource Sharing (CORS) HTTP requests.
cpanel-apiInitial PrivilegesPerform cPanel API and UAPI functions through the WHM APIN/AExecute cPanel API 1, cPanel API 2, and UAPI functions via WHM.
cpanel-integrationManage cPanel Integration LinkscPanel IntegrationManage how a server and its services connect to other servers and services.
create-user-sessionInitial PrivilegesCreate User SessionCreate a new temporary user session for a specified service.
Note: This privilege allows an API token user to bypass any restrictions on the API token.
digest-authInitial PrivilegesDigest AuthenticationManage Digest Authentication support.
generate-email-configInitial PrivilegesGenerate Mobile Email Configurationsgenerate_mobileconfigGenerate a mobile configuration profile for an email account.
list-pkgsInitial PrivilegesList PackagesView existing hosting plans (packages).
manage-api-tokensInitial PrivilegesManage API TokensManage API tokens.
Note: This privilege allows an API token user to bypass any restrictions on the API token.
manage-dns-recordsInitial PrivilegesManage DNS RecordsManage DNS records.
manage-oidcInitial PrivilegesManage OpenID ConnectManage external authentication for accounts.
mysql-infoAccount ManagementMySQL InformationRetrieve MySQL® database and user data.
ns-configInitial PrivilegesNameserver ConfigurationManage nameserver records.
public-contactInitial PrivilegesPublic Contact InformationRetrieve or set the public contact information for cPanel accounts.
ssl-infoInitial PrivilegesSSL InformationView SSL information.
track-emailInitial PrivilegesTrack EmailRetrieve email delivery records.

Standard privileges

The following table lists the ACLs for standard privileges and the API functions that use these ACLs:

ACLPrivilege typeFeature limitAssociated WHM API 1 functionsDescription
list-acctsAccount InformationList AccountsView the list of accounts on a server.
show-bandwidthAccount InformationView Account Bandwidth UsageshowbwView bandwidth usage statistics.
create-acctAccount ManagementCreate AccountsCreate cPanel accounts and set up 2FA (Two-Factor Authentication) on them.
kill-acctAccount ManagementTerminate AccountsremoveacctDelete cPanel accounts.
suspend-acctAccount ManagementSuspend/Unsuspend AccountsSuspend and unsuspend cPanel accounts.
upgrade-accountAccount ManagementUpgrade/Downgrade AccountschangepackageModify an account's hosting plan (package).
sslAccount ManagementSSL Site ManagementModify SSL information for cPanel accounts.
ssl-buyAccount ManagementPurchase SSL CertificatesN/APurchase SSL certificates.
ssl-gencrtAccount ManagementSSL CSR/Certificate GeneratorgeneratesslGenerate CSRs and SSL certificates.
edit-mxAccount ManagementEdit MX EntriesModify MX entries.
passwdAccount ManagementChange PasswordsThis privilege allows a reseller to change account passwords and allow users to log in without an API token.
file-restoreAccount ManagementFile and Directory RestorationN/ARestore items from local backup sources.
create-dnsDNSAdd DNS ZonesadddnsAdd DNS zones.
kill-dnsDNSRemove DNS ZoneskilldnsDelete DNS zones.
park-dnsDNSPark DNS Zonescreate_parked_domain_for_userPark DNS zones.
edit-dnsDNSEdit DNS Zonesmass_edit_dns_zoneEdit DNS zones.
add-pkgPackagesAdd/Remove PackagesCreate or delete hosting plans (packages).
edit-pkgPackagesEdit PackagesModify existing hosting plans (packages).
thirdpartyThird-Party ServicesManage Third-Party ServicesN/AManage third-party services (for example, plugins or cPAddons).
mailcheckTroubleshootingTroubleshoot Mail DeliveryN/AAccess WHM's Mail Troubleshooter interface (WHM >> Home >> Email >> Mail Troubleshooter).
newscPanel ManagementNews ModificationN/AModify news in WHM's Modify cPanel & WHM News interface (WHM >> Home >> cPanel >> Modify cPanel & WHM News).
assign-root-account-enhancementsPackage AccessUse Root Account EnhancementsAllow the reseller to assign, list, or unassign Account Enhancements on their cPanel account.

Package privileges

The following table lists the ACLs for package privileges and the API functions that use these ACLs:

ACL namePrivilege typeFeature limitAssociated WHM API 1 functionsDescription
allow-shellAccountsAllow Creation of Accounts with Shell AccessN/AAllow account creation with shell access.
viewglobalpackagesPackage AccessUse Root PackagesAllow the reseller to use all global packages. For more information, read our reseller packages documentation.
allow-addoncreatePackage CreationCreate Packages with Addon DomainsCreate hosting plans (packages) that include addon domains.
allow-parkedcreatePackage CreationCreate Packages with Parked (Alias) DomainsCreate hosting plans (packages) that include parked domains (aliases).
add-pkg-ipPackage CreationCreate Packages with a Dedicated IP AddressCreate hosting plans (packages) that include a dedicated IP address.
add-pkg-shellPackage CreationCreate Packages with Shell AccessCreate hosting plans (packages) that grant shell access.
allow-unlimited-pkgsPackage CreationCreate Packages with Unlimited FeaturesSet an unlimited quota on one or more package settings.
allow-emaillimits-pkgsPackage CreationCreate Packages with Custom Email LimitsCreate hosting plans (packages) with email quotas that are not the default quotas.
allow-unlimited-disk-pkgsPackage CreationCreate Packages with Unlimited Disk UsageCreate packages with an unlimited disk quota.
allow-unlimited-bw-pkgsPackage CreationCreate Packages with Unlimited BandwidthCreate packages with unlimited bandwidth.

Additional software

The following table lists the ACLs for additional software and the API functions that use these ACLs:

ACL namePrivilege typeFeature limitAssociated API functionsDescription
software-imunify360Additional SoftwareThird-Party ServicesN/AAccess Imunify360 plugin.
wp-toolkitAdditional SoftwareWP ToolkitN/AAccess WP Toolkit.

Global privileges

The following table lists the ACLs for global privileges and the API functions that use these ACLs:

ACL namePrivilege typeFeature limitAssociated API functionsDescription
statusServer InformationView Server StatusservicestatusView the interfaces in WHM's Server Status section (WHM >> Home >> Server Status).
statsServer InformationView Server Informationinstalled_versionsView WHM's Server Information interface (WHM >> Home >> Server Status >> Server Information).
restartServicesRestart ServicesrestartserviceRestart services on the server.
resftpTroubleshootingResynchronize FTP PasswordsN/AAccess WHM's Synchronize FTP Passwords interface (WHM >> Home >> cPanel >> Synchronize FTP Passwords).

Super privileges

The following table lists the ACLs for super privileges and the API functions that use these ACLs:

ACL namePrivilege typeFeature limitAssociated WHM API 1 functionsDescription
edit-accountAccount ManagementAccount ModificationModify accounts.
limit-bandwidthAccount ManagementBandwidth Limit ModificationlimitbwModify account bandwidth limits.
quotaAccount ManagementQuota ModificationeditquotaModify account quotas.
demo-setupAccount ManagementSet an Account to be a Demo AccountN/AEnable demo mode for an account.
rearrange-acctsAdvanced Account ManagementRearrange AccountsRearrange accounts on the server to increase available disk space.
clusteringClusteringDNS ClusteringConfigure DNS clusters.
locale-editLocalesModify & Create LocalesN/ACreate and modify locales on the server.

root privileges

The following table lists the ACLs for root privileges and the API functions that use these ACLs:

ACLPrivilege typeFeature limitAssociated WHM API 1 functionsDescription
allEverythingAll FeaturesAll WHM API 1 functions.The reseller possesses root-level privileges on the server and can execute all WHM API 1 functions.