Update multiple cPanel accounts

This function modifies multiple cPanel accounts.

Warning:

  • We strongly recommend that you do not modify a cPanel account's settings if that account uses a hosting plan (package). If the package values change, the system will overwrite any of your custom values with the package's new values.
  • This function uses case-sensitive parameters. You must enter parameters in the correct case format. If you do not, the function will ignore that parameter.

Note:

On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.

  • This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
  • Red Hat 7.1 and CentOS 7.1 both contain bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the Red Hat Bugzilla case about SPF record errors.
Authorizations:
query Parameters
username
required
string <username>

The account's current username.

Note:

To modify multiple users, duplicate or increment the parameter name. For example, the user-1, user-2, and user-3 parameters.

Examples:
username=user-0=username user-1=username1 user-2=username2 user-3=username3
username=user=username user=username1 user=username2 user=username3
username=username
BACKUP
any

Whether backups are enabled for the account.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Note:

This parameter requires root privileges.

Enum: 1 0
Example: BACKUP=1
string or integer (IntPosNullOrUnlimited) Nullable

The account's maximum bandwidth use, in bytes.

  • 0, null or unlimited — The account can use unlimited bandwidth.

This parameter defaults to the defined system value.

Example: BWLIMIT=unlimited
CONTACTEMAIL
string <email>

The account's contact email address.

This parameter defaults to the defined system value.

Example: CONTACTEMAIL=username@example.com
DBOWNER
string <username>

The owner of the account's MySQL® databases.

This parameter defaults to the defined system value.

Example: DBOWNER=example
DISK_BLOCK_LIMIT
integer >= 1

The number of disk blocks for the account, in kilobytes (KB).

This parameter defaults to the defined system value.

Example: DISK_BLOCK_LIMIT=100000000
HASCGI
integer

Whether CGI access is enabled for the account.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Note:

When a server profile disables the Web Server role, you cannot enable CGI access.

Enum: 1 0
Example: HASCGI=1
HASDKIM
integer

Whether DomainKeys Identified Mail (DKIM) is enabled for the account.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
HASSHELL
integer

Whether shell (SSH) access is enabled for the account.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Note:

We strongly recommend that you use the shell parameter to specify a shell for SSH access.

Enum: 1 0
Example: HASSHELL=1
HASSPF
integer

Whether Sender Policy Framework (SPF) is enabled for the account.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: HASSPF=1
IP
string <ipv4>

The account's IP address.

This parameter defaults to the defined system value.

Example: IP=192.168.0.1
LANG
string

The account's display language.

This parameter defaults to the defined system value.

Example: LANG=english-utf8
LOCALE
string <ISO-3166-1 (alpha-2)>

The account's default locale.

This parameter defaults to the defined system value.

Example: LOCALE=en
MAILBOX_FORMAT
any

The storage format that the account's mailboxes use.

  • maildir
  • mbox

This parameter defaults to the defined system value.

Enum: "maildir" "mbox"
string or integer (IntPosOrUnlimited)

The percentage of failed or deferred email messages that the account can send per hour before outgoing mail is rate-limited.

  • 0 or unlimited — The account can send an unlimited number of failed or deferred messages.

This parameter defaults to the defined system value.

Example: MAX_DEFER_FAIL_PERCENTAGE=unlimited
string or integer (IntPosOrUnlimited)

The maximum number of emails that the account can send in one hour.

  • 0 or unlimited — The account can send an unlimited number of emails.

This parameter defaults to the defined system value.

Example: MAX_EMAIL_PER_HOUR=unlimited
string or integer

The maximum size, in megabytes (MB), that the account can define when it creates an email account.

  • unlimited — The account possesses an unlimited quota.

Important:

  • This value applies to each email account, not each cPanel account.
  • If you specify a MAX_EMAILACCT_QUOTA value, the function will overwrite the plan's defined value for that cPanel account.
  • This parameter does not affect any existing email accounts
  • We recommend that you allow the account's plan to determine this value.
  • MAX_EMAIL_PER_HOUR will define to unlimited if you do not define either the plan or MAX_EMAILACCT_QUOTA parameters.

This parameter defaults to the defined system value. It will default to unlimited if you do not define either the plan or MAX_EMAILACCT_QUOTA parameters.

Example: MAX_EMAILACCT_QUOTA=unlimited
string or integer (Int0-999999NullOrUnlimited) Nullable

The account's maximum number of addon domains.

  • 0, null, or unlimited — The account possesses unlimited addon domains.

This parameter defaults to the defined system value.

Example: MAXADDON=unlimited
string or integer (Int0-999999NullOrUnlimited) Nullable

The account's maximum number of FTP accounts.

  • null or unlimited — The account possesses unlimited FTP accounts.

This parameter defaults to the defined system value.

Example: MAXFTP=unlimited
string or integer (Int0-999999NullOrUnlimited) Nullable

The account's maximum number of mailing lists.

  • 0, null, or unlimited — The account possesses unlimited mailing lists.

This parameter defaults to the defined system value.

Example: MAXLST=unlimited
string or integer (Int0-999999NullOrUnlimited) Nullable

The account's maximum number of parked domains (aliases).

  • null or unlimited — The account possesses unlimited mailing lists.

This parameter defaults to the defined system value.

Example: MAXPARK=unlimited
string or integer (Int0-999999NullOrUnlimited) Nullable

The account's maximum number of Ruby applications.

  • null or unlimited — The account possesses unlimited Ruby applications.

This parameter defaults to the defined system value.

Example: MAXPASSENGERAPPS=unlimited
string or integer (Int0-999999NullOrUnlimited) Nullable

The maximum number of email accounts for the account.

  • null or unlimited — The account possesses unlimited email accounts.

This parameter defaults to the defined system value.

Example: MAXPOP=unlimited
string or integer (Int0Max999999NullOrUnlimited) Nullable

The maximum number of each available type of SQL database for the account.

For example, if you set this value to 5 and the system administrator allows MySQL® and PostgreSQL® databases, users can create up to five MySQL databases and up to five PostgreSQL databases.

  • null or unlimited — The account possesses unlimited databases.

This parameter defaults to the defined system value.

Example: MAXSQL=unlimited
string or integer (Int0-999999NullOrUnlimited) Nullable

The maximum number of subdomains for the account.

  • null or unlimited — The account possesses unlimited subdomains.

This parameter defaults to the defined system value.

Example: MAXSUB=unlimited
modify_firewall
integer
Default: 1

Whether to modify the firewall rules as part of the account modification.

  • 1 – Modify the firewall rules.
  • 0 – Do not modify the firewall rules.

NOTE:

If you do not set this parameter, the system will modify the firewall based on the Do not make changes to the firewall during account modification. setting in WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).

Enum: 0 1
Example: modify_firewall=0
MXCHECK-*
integer >= 0

The priority of the account's primary mail exchanger.

Note:

The parameter name consists of MXCHECK, a hyphen, and the primary domain of the account.

Example key and value:

  • MXCHECK-example.com=10

This parameter defaults to the define system value.

Example: MXCHECK-*=1
notify_account_authn_link
integer

Whether to send a notification when someone links the account to an external authentication account.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_account_authn_link=0
notify_account_authn_link_notification_disabled
integer

Whether to send a notification when someone disables notifications for external authentication account links.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_account_authn_link_notification_disabled=0
notify_autossl_expiry
integer

Whether to send a notification when an AutoSSL certificate expires.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_autossl_expiry=0
notify_autossl_expiry_coverage
integer

Whether to send a notification AutoSSL cannot renew a certificate because domains that fail Domain Control Validation (DCV) exist on the current certificate.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_autossl_expiry_coverage=0
notify_autossl_renewal
integer

Whether to send a notification when AutoSSL renews a certificate.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_autossl_renewal=0
notify_autossl_renewal_coverage
integer

Whether to send a notification when AutoSSL renews a certificate but the new certificate lacks at least one domain that the previous certificate secured.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_autossl_renewal_coverage=0
notify_contact_address_change
integer

Whether to send a notification when someone changes the contact address for the account.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_contact_address_change=0
notify_contact_address_change_notification_disabled
integer

Whether to send a notification when disables the notification for contact address changes.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_contact_address_change_notification_disabled=0
notify_disk_limit
integer

Whether to send a notification when the account reaches its disk usage limit.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_disk_limit=0
notify_password_change
integer

Whether to send a notification when someone changes the account's password.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_password_change=0
notify_password_change_notification_disabled
integer

Whether to send a notification when someone disables notifications for password changes.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_password_change_notification_disabled=0
notify_ssl_expiry
integer

Whether to send a notification when an SSL certificate on the account expires.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: notify_ssl_expiry=0
OUTGOING_EMAIL_SUSPENDED
integer

Whether to suspend outgoing email on the account.

  • 1 — Suspend outgoing email.
  • 0 — Do not suspend outgoing email.

This parameter defaults to the defined system value.

Enum: 1 0
Example: OUTGOING_EMAIL_SUSPENDED=0
OWNER
string <username>

A new owner's username or the root user, to change the account's owner.

This parameter defaults to the defined system value.

Note:

The authenticated user must have root privileges in order to assign the account to a reseller other than that account.

Example: OWNER=reseller
PUSHBULLET_ACCESS_TOKEN
string

An access token for the account's Pushbullet™ notifications.

This parameter defaults to the defined system value.

Example: PUSHBULLET_ACCESS_TOKEN=1234567890
string or integer (IntPosNullOrUnlimited) Nullable

The account's disk space quota, in multiples of 1,048,576 bytes.

  • 0, null, or unlimited — The account's disk space is unlimited.

This parameter defaults to the defined system value.

Example: QUOTA=unlimited
remove_missing_extensions
string

A space-separated list of removed, missing, or uninstalled extensions.

This parameter defaults to the defined system value.

Warning:

This parameter removes all of the extensions that you list from the _PACKAGE_EXTENSIONS variable in the user file. It will not remove the extensions' variables. For more information, read our Guide to Package Extensions.

Example: remove_missing_extensions=packageext1 packageext2
rename_database_objects
integer

Whether to rename the cPanel account's database objects to use a new username's database prefix. This parameter only applies to servers that use database prefixing.

  • 1 — Rename the cPanel account's database objects.
  • 0 — Do not rename the cPanel account's database objects.

Warning:

  • The account owner must update any applications to use the new database object names.
  • Use this parameter carefully. It can cause confusion for system administrators.

MySQL does not allow you to rename a database. When cPanel & WHM "renames" a database, the system performs the following steps:

  1. The system creates a new database.
  2. The system moves data from the old database to the new database.
  3. The system recreates grants and stored code in the new database.
  4. The system deletes the old database and its grants.

Warning:

  • If any of the first three steps fail, the system returns an error and attempts to restore the database's original state. If the restoration process fails, the API function's error response describes these additional failures.
  • In rare cases, the system creates the second database successfully, but fails to delete the old database or grants. The system treats the rename action as a success; however, the API function returns warnings that describe the failure to delete the old database or grants.
Enum: 1 0
Example: rename_database_objects=0
reseller
integer
Default: 0

Whether to grant reseller privileges to the account.

  • 1 — Grant reseller privileges.
  • 0 — Do not grant reseller privileges.
Enum: 1 0
Example: reseller=1
RS
string

The account's cPanel interface theme.

This parameter defaults to the defined system value.

Example: RS=paper_lantern
shell
string <path>

The absolute file path to the shell's location.

This parameter defaults to the defined system value.

Example: shell=/bin/bash
spamassassin
integer

Whether Apache SpamAssassin™ is enabled for the account.

  • 1 — Enabled.
  • 0 — Disabled.

This parameter defaults to the defined system value.

Enum: 1 0
Example: spamassassin=1
STARTDATE
integer <unix_timestamp>

A timestamp for which to use as the account's creation date.

This parameter defaults to the defined system value.

Example: STARTDATE=1549471343
STYLE
string

The account's cPanel interface style.

This parameter defaults to the defined system value.

Example: STYLE=Basic

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 massmodifyacct username='username'

Response samples

Content type
application/json
{
  • "data": {
    • "payload": [
      • {
        • "reason": "Unable to fetch the cPanel user file for username",
        • "result": 0,
        • "user": "username"
        },
      • {
        • "extended": {
          • "cpuser": {
            • "BACKUP": "1",
            • "BWLIMIT": "unlimited",
            • "CONTACTEMAIL": "username1@example.com",
            • "CONTACTEMAIL2": "",
            • "DBOWNER": "username1",
            • "DEADDOMAINS": [
              • "example.example1.com"
              ],
            • "DEMO": "0",
            • "DISK_BLOCK_LIMIT": 0,
            • "DOMAIN": "example1.com",
            • "DOMAINS": [ ],
            • "FEATURELIST": "default",
            • "HASCGI": "1",
            • "HASDKIM": "1",
            • "HASSPF": "1",
            • "HOMEDIRLINKS": [ ],
            • "IP": "172.16.1.3",
            • "LANG": "english-utf8",
            • "LEGACY_BACKUP": "0",
            • "LOCALE": "en",
            • "MAILBOX_FORMAT": "maildir",
            • "MAXADDON": "0",
            • "MAXFTP": "234",
            • "MAXLST": "unlimited",
            • "MAXPARK": "0",
            • "MAXPOP": "123",
            • "MAXSQL": "345",
            • "MAXSUB": "unlimited",
            • "MAX_DEFER_FAIL_PERCENTAGE": "unlimited",
            • "MAX_EMAILACCT_QUOTA": "unlimited",
            • "MAX_EMAIL_PER_HOUR": "unlimited",
            • "MTIME": "1584509675",
            • "MXCHECK-example1.com": "remote",
            • "OWNER": "username1",
            • "PLAN": "extended",
            • "RS": "paper_lantern",
            • "STARTDATE": "765435600",
            • "USER": "username1",
            • "UTF8MAILBOX": "1",
            • "WORKER_NODE-Mail": "example1:6L3ZJZ8LPAAOMC8CA31325O8EKGJ5YV5",
            • "_PACKAGE_EXTENSIONS": "custom",
            • "__CACHE_DATA_VERSION": "0.81"
            },
          • "domain": "example1.com",
          • "setshell": "unmodified",
          • "user": "username1"
          },
        • "messages": [ ],
        • "reason": "Account Modified",
        • "result": 1,
        • "user": "username1",
        • "warnings": [ ]
        },
      • {
        • "extended": {
          • "cpuser": {
            • "BACKUP": "1",
            • "BWLIMIT": "unlimited",
            • "CONTACTEMAIL": "",
            • "CONTACTEMAIL2": "",
            • "DBOWNER": "username2",
            • "DEADDOMAINS": [ ],
            • "DEMO": "0",
            • "DISK_BLOCK_LIMIT": 0,
            • "DOMAIN": "example2.com",
            • "DOMAINS": [ ],
            • "FEATURELIST": "default",
            • "HASCGI": "0",
            • "HASDKIM": "1",
            • "HASSPF": "1",
            • "HOMEDIRLINKS": [ ],
            • "IP": "10.0.0.1",
            • "LANG": null,
            • "LEGACY_BACKUP": "0",
            • "LOCALE": "cs",
            • "MAILBOX_FORMAT": "maildir",
            • "MAXADDON": "0",
            • "MAXFTP": "234",
            • "MAXLST": "unlimited",
            • "MAXPARK": "0",
            • "MAXPOP": "123",
            • "MAXSQL": "345",
            • "MAXSUB": "unlimited",
            • "MAX_DEFER_FAIL_PERCENTAGE": "unlimited",
            • "MAX_EMAILACCT_QUOTA": "unlimited",
            • "MAX_EMAIL_PER_HOUR": "unlimited",
            • "MTIME": "1583966719",
            • "MXCHECK-example2.com": "0",
            • "OWNER": "root",
            • "PLAN": "extended",
            • "RS": "paper_lantern",
            • "STARTDATE": "728719200",
            • "USER": "username2",
            • "UTF8MAILBOX": "1",
            • "WORKER_NODE-Mail": "example2:BXE4LIAXF4X9N0B0TG69AAQ64DGR1XPU",
            • "_PACKAGE_EXTENSIONS": "",
            • "__CACHE_DATA_VERSION": "0.81"
            },
          • "domain": "example2.com",
          • "setshell": "unmodified",
          • "user": "username2"
          },
        • "messages": [ ],
        • "proxied_from": [
          • "example.com"
          ],
        • "reason": "Account Modified",
        • "result": 1,
        • "user": "username2",
        • "warnings": [ ]
        },
      • {
        • "extended": {
          • "cpuser": {
            • "BACKUP": "1",
            • "BWLIMIT": "unlimited",
            • "CONTACTEMAIL": "",
            • "CONTACTEMAIL2": "",
            • "DBOWNER": "username2",
            • "DEADDOMAINS": [ ],
            • "DEMO": 0,
            • "DISK_BLOCK_LIMIT": 0,
            • "DOMAIN": "example2.com",
            • "DOMAINS": [ ],
            • "FEATURELIST": "default",
            • "HASCGI": "1",
            • "HASDKIM": "1",
            • "HASSPF": "1",
            • "HOMEDIRLINKS": [ ],
            • "IP": "172.16.1.3",
            • "LANG": "english-utf8",
            • "LEGACY_BACKUP": "0",
            • "LOCALE": "en",
            • "MAILBOX_FORMAT": "maildir",
            • "MAXADDON": "unlimited",
            • "MAXFTP": "234",
            • "MAXLST": "unlimited",
            • "MAXPARK": "unlimited",
            • "MAXPOP": "123",
            • "MAXSQL": "345",
            • "MAXSUB": "unlimited",
            • "MAX_DEFER_FAIL_PERCENTAGE": "unlimited",
            • "MAX_EMAILACCT_QUOTA": "unlimited",
            • "MAX_EMAIL_PER_HOUR": "unlimited",
            • "MTIME": "1584509675",
            • "MXCHECK-example2.com": "remote",
            • "OWNER": "username2",
            • "PLAN": "default",
            • "RS": "paper_lantern",
            • "STARTDATE": "765435600",
            • "USER": "username2",
            • "UTF8MAILBOX": "1",
            • "WORKER_NODE-Mail": "example2:H99IZWY3OH9Q1DQNR58L55WUBXAENPDP",
            • "_PACKAGE_EXTENSIONS": "",
            • "__CACHE_DATA_VERSION": "0.81"
            },
          • "domain": "example2.com",
          • "setshell": "unmodified",
          • "user": "username2"
          },
        • "messages": [ ],
        • "reason": "Account Modified",
        • "result": 1,
        • "user": "username2",
        • "warnings": [ ]
        },
      • {
        • "extended": {
          • "cpuser": {
            • "BACKUP": "1",
            • "BWLIMIT": "unlimited",
            • "CONTACTEMAIL": "",
            • "CONTACTEMAIL2": "",
            • "DBOWNER": "username2",
            • "DEADDOMAINS": [ ],
            • "DEMO": 0,
            • "DISK_BLOCK_LIMIT": 0,
            • "DOMAIN": "example2.com",
            • "DOMAINS": [ ],
            • "FEATURELIST": "default",
            • "HASCGI": "0",
            • "HASDKIM": "1",
            • "HASSPF": "1",
            • "HOMEDIRLINKS": [ ],
            • "IP": "10.0.0.2",
            • "LANG": "english-utf8",
            • "LEGACY_BACKUP": "0",
            • "LOCALE": "en",
            • "MAILBOX_FORMAT": "maildir",
            • "MAXADDON": "unlimited",
            • "MAXFTP": "234",
            • "MAXLST": "unlimited",
            • "MAXPARK": "unlimited",
            • "MAXPOP": "123",
            • "MAXSQL": "345",
            • "MAXSUB": "unlimited",
            • "MAX_DEFER_FAIL_PERCENTAGE": "unlimited",
            • "MAX_EMAILACCT_QUOTA": "unlimited",
            • "MAX_EMAIL_PER_HOUR": "unlimited",
            • "MTIME": "1583966717",
            • "MXCHECK-example2.com": "0",
            • "OWNER": "linked",
            • "PLAN": "default",
            • "RS": "paper_lantern",
            • "STARTDATE": "765435600",
            • "USER": "username2",
            • "UTF8MAILBOX": "1",
            • "_PACKAGE_EXTENSIONS": "",
            • "__CACHE_DATA_VERSION": "0.81"
            },
          • "domain": "example2.com",
          • "setshell": "noshell",
          • "user": "username2"
          },
        • "messages": [
          • "Shell changed"
          ],
        • "proxied_from": [
          • "example.com"
          ],
        • "reason": "Account Modified",
        • "result": 1,
        • "user": "username2",
        • "warnings": [ ]
        }
      ]
    },
  • "metadata": {
    • "command": "massmodifyacct",
    • "messages": [
      • "From example1.com: Restarting apache"
      ],
    • "reason": "Failed to modify one or more users.",
    • "result": 0,
    • "version": 1,
    • "warnings": [ ]
    }
}