Description

This function creates or modifies an Access Control List (ACL).


We strongly recommend that WHM users create and edit ACLs and privileges in WHM's Edit Reseller Nameservers and Privileges interface (WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges). 


Examples




https://hostname.example.com:2087/cpsess##########/json-api/setacls?api.version=1&reseller=username&acl-kill-dns=1&acl-edit-dns=1&acl-edit-mx=1&acl-add-pkg=1&acl-suspend-acct=1&acl-ssl=1&manage-api-tokens=1&cpanel-integration=1




https://hostname.example.com:2087/cpsess##########/xml-api/setacls?api.version=1&reseller=username&acl-kill-dns=1&acl-edit-dns=1&acl-edit-mx=1&acl-add-pkg=1&acl-suspend-acct=1&acl-ssl=1&manage-api-tokens=1&cpanel-integration=1




whmapi1 setacls reseller=username acl-kill-dns=1 acl-edit-dns=1 acl-edit-mx=1 acl-add-pkg=1 acl-suspend-acct=1 acl-ssl=1 manage-api-tokens=1 cpanel-integration=1



{  
   "data":{  
      "acl":[  
         "kill-dns",
         "ssl",
         "edit-mx",
         "suspend-acct",
         "edit-dns",
         "add-pkg-1"
		 "manage-api-tokens"
		 "cpanel-integration"
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":1,
      "command":"setacls"
   }
}




<result>
    <data>
        <acl>kill-dns</acl>
        <acl>ssl</acl>
        <acl>edit-mx</acl>
        <acl>suspend-acct</acl>
        <acl>edit-dns</acl>
        <acl>add-pkg-1</acl>
		<acl>manage-api-tokens</acl>
		<acl>cpanel-integration</acl>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>setacls</command>
    </metadata>
</result>



Parameters

This function's Boolean parameters do not perform like most other cPanel & WHM API parameters. The function interprets any value of a parameter as a true value, and it interprets the lack of a parameter as a false value.


ParameterTypeDescriptionPossible valuesExample
resellerstring

Required

The reseller's username.

A valid username on the server.username

acllist

string

The ACL to assign to the reseller.

Functions should either use this parameter, or a combination of the acl-* parameters below. Do not include both in a single function. 


An ACL on the server.

my_acl_list

acl-edit-pkg

Boolean

Whether to allow the reseller to edit hosting plans (packages).

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-add-pkg

Boolean

Whether to allow the reseller to add and remove hosting plans (packages).

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1
acl-list-pkgsBoolean

Whether to allow the reseller to view existing hosting plans (packages).

This parameter defaults to undef .

We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
1

acl-mailcheck

Boolean

Whether to allow the reseller to troubleshoot mail delivery.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-generate-email-config

Boolean

Whether to allow the reseller to generate a mobile configuration profile for an email account.

This parameter defaults to undef.

We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
1

acl-show-bandwidth

Boolean

Whether to allow the reseller to view account bandwidth usage.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-list-accts

Boolean

Whether to allow the reseller to view the list of accounts.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1
acl-acct-summaryBoolean

Whether to allow the reseller to view an account summary.

This parameter defaults to undef.

We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
1

acl-clustering

Boolean

Whether to allow the reseller to use DNS clusters.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-news

Boolean

Whether to allow the reseller to modify the server's news.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-thirdparty

Boolean

Whether to allow the reseller to manage third-party services.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-kill-dns

Boolean

Whether to allow the reseller to remove DNS zones.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-edit-dns

Boolean

Whether to allow the reseller to edit DNS zones.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1
acl-cpanel-apiBoolean

Whether to allow the reseller to execute cPanel API 1 cPanel API 2  and  UAPI  functions via WHM.

This parameter defaults to undef.

 We added this parameter in cPanel & WHM version 68.


  • Any value — Allow.
  • undef — Do not allow.
1

acl-park-dns

Boolean

Whether to allow the reseller to park DNS zones.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-create-dns

Boolean

Whether to allow the reseller to add DNS zones.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1
acl-manage-api-tokensBoolean

Whether to allow the reseller to manage API tokens.

This parameter defaults to undef.

  • 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 72Docsumentation.
  • We added this parameter in cPanel & WHM version 68.


  • Any value — Allow.
  • undef — Do not allow.
1
acl-manage-oidcBoolean

Whether to allow the reseller to manage external authentication for their accounts.

This parameter defaults to undef.

We added this parameter in cPanel & WHM version 68.


  • Any value — Allow.
  • undef — Do not allow.
1
acl-manage-dns-recordsBoolean

Whether to allow the reseller to manage DNS records.

This parameter defaults to undef .


We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
1
acl-manage-stylesBoolean

Whether to allow the reseller to manage their server's cPanel styles.

This parameter defaults to undef .

We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
 1
acl-nameserver-configBoolean

Whether to allow the reseller to manage nameservers.

This parameter defaults to undef.

We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
1

acl-ssl

Boolean

Whether to allow the reseller to perform SSL site management.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1
acl-ssl-infoBoolean

Whether to allow the reseller to view their server's SSL information.

This parameter defaults to undef.

We added this parameter in cPanel & WHM version 68.


  • Any value — Allow.
  • undef — Do not allow.
1
acl-mysql-infoBoolean

Whether to allow the reseller to retrieve MySQL® database and user data.

This parameter defaults to undef .

We added this parameter in cPanel & WHM version 68. 


  •  Any value — Allow.
  • undef — Do not allow.

1

acl-create-acct

Boolean

Whether to allow the reseller to create accounts.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-suspend-acct

Boolean

Whether to allow the reseller to suspend or unsuspend accounts.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1
acl-basic-system-infoBoolean

Whether to allow the reseller to retrieve basic system information.

This parameter defaults to undef .


We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
1
acl-basic-whm-functionsBoolean

Whether to allow the reseller to access basic cPanel & WHM options.

This parameter defaults to undef.

We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
1

acl-res-cart

Boolean

Whether to allow the reseller to reset the Interchange shopping cart.

This parameter defaults to undef.

  • We removed this return in cPanel & WHM version 11.46.
  • Do not use this privilege in cPanel & WHM version 11.38 or later.


  • Any value — Allow.
  • undef — Do not allow.
1

acl-passwd

Boolean

Whether to allow the reseller to change passwords.

This parameter defaults to undef.

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 72Docsumentation.


  • Any value — Allow.
  • undef — Do not allow.
1

acl-ssl-buy

Boolean

Whether to allow the reseller to purchase SSL certificates.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1
acl-cpanel-integrationBoolean

Whether to allow the reseller to manage how their server and its services connect to other servers and services.

This parameter defaults to undef.

We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
1

acl-frontpage

Boolean

Whether to allow the reseller to manage Microsoft® FrontPage® Extensions.

This parameter defaults to undef.

cPanel & WHM will ignore all Microsoft FrontPage settings and parameters if either of the following statements are true:

  • Your server runs cPanel & WHM version 11.44 and FrontPage extensions are not installed on your server.
  • Your server runs cPanel & WHM version 11.46 or later.


  • Any value — Allow.
  • undef — Do not allow.
1
acl-cors-proxy-getBoolean

Whether to allow the reseller to perform Cross-Origin Resource Sharing (CORS) HTTP requests.

This parameter defaults to undef.

We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
1

acl-upgrade-account

Boolean

Whether to allow the reseller to upgrade or downgrade accounts.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-ssl-gencrt

Boolean

Whether to allow the reseller to generate SSL certificates.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1
acl-create-user-sessionBoolean

Whether to allow the reseller to create a temporary session user for a specified service.

This parameter defaults to undef.

  • 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 72Docsumentation.
  • We added this parameter in cPanel & WHM version 68.


  • Any value — Allow.
  • undef — Do not allow.
1

acl-edit-mx

Boolean

Whether to allow the reseller to edit MX entries.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1
acl-digest-authBoolean

Whether to allow the reseller to manage Digest Authentication support.

This parameter defaults to undef.

We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
1

acl-kill-acct

Boolean

Whether to allow the reseller to terminate accounts.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-viewglobalpackages

Boolean

Whether to allow the reseller to use all global packages. For more information, read our reseller packages documentation.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-disallow-shell

Boolean

Whether to allow the reseller to create accounts with shell access.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-add-pkg-shell

Boolean

Whether to allow the reseller to create packages with shell access.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-allow-addoncreate

Boolean

Whether to allow the reseller to create packages with addon domains.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-allow-parkedcreate

Boolean

Whether to allow the reseller to create packages with parked domains (aliases).

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-allow-unlimited-disk-pkgs

Boolean

Whether to allow the reseller to create packages with unlimited disk space.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-allow-unlimited-pkgs

Boolean

Whether to allow the reseller to create packages with unlimited features.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-allow-unlimited-bw-pkgs

Boolean

Whether to allow the reseller to create packages with unlimited bandwidth.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-add-pkg-ip

Boolean

Whether to allow the reseller to create packages with a dedicated IP address.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1
acl-locale-editBoolean

Whether to allow the reseller to create and modify locales on the server.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-resftp

Boolean

Whether to allow the reseller to resync FTP passwords.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-restart

Boolean

Whether to allow the reseller to restart services.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-status

Boolean

Whether to allow the reseller to view the server's status.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-stats

Boolean

Whether to allow the reseller to view server information.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-quota

Boolean

Whether to allow the reseller to modify quotas.

This parameter defaults to undef.

If you do not use resource limits, this ACL allows resellers to circumvent package limits for disk space. 


  • Any value — Allow.
  • undef — Do not allow.
1

acl-demo-setup

Boolean

Whether to allow the reseller to enable demo mode for accounts.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-edit-account

Boolean

Whether to allow the reseller to edit accounts.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1

acl-limit-bandwidth

Boolean

Whether to allow the reseller to modify bandwidth limits (quotas).

This parameter defaults to undef.

If you do not use resource limits, a value of 1 allows resellers to circumvent package limits for disk space.


  • Any value — Allow.
  • undef — Do not allow.
1

acl-rearrange-accts

Boolean

Whether to allow the reseller to rearrange accounts.

This parameter defaults to undef.

  • Any value — Allow.
  • undef — Do not allow.
1
acl-track-emailBoolean

Whether to allow the reseller to view reports about email message delivery attempts from their account.

This parameter defaults to undef.

We added this parameter in cPanel & WHM version 68. 


  • Any value — Allow.
  • undef — Do not allow.
1

acl-all

Boolean

Whether to grant the reseller all ACL privileges.

This parameter defaults to undef.

A value of 1 grants root-level privileges to the reseller.


  • Any value — Allow.
  • undef — Do not allow.
1

Returns

ReturnTypeDescriptionPossible valuesExample
aclarrayAn array of the reseller's privileges.An array that contains the names of one or more privileges.all