Update software update behavior

This function modifies a server's /etc/cpupdate.conf file. This file controls how the server handles software updates and upgrades.

Important:

You must have the root level Access Control List (ACL) privilege to execute this function.

Authorizations:
query Parameters
string or string or string

The cPanel & WHM installation's release tier, or a valid version number.

If you do not use this parameter, the system retains the current setting.

  • A valid cPanel & WHM version number.

  • STABLE - This version has received considerable public exposure, testing, and verification.

  • RELEASE - This version is feature-complete and well-tested. It contains all intended features and functionality.

  • CURRENT - This version is tested and verified, but it may not contain all of the proposed functionality of a release. This tier is similar to the "release candidate" tier that other publication schemes use.

  • EDGE - This version only has rudimentary testing. The features are subject to further modification. This version usually lacks official public documentation.

  • LTS - Some hosting providers do not wish to upgrade cPanel & WHM to newer major versions. This is a single cPanel & WHM version for the year-long period in which cPanel, L.L.C. supports it.

    If you do not set this parameter, the system retains the current setting.

    New installations default to RELEASE.

Example: CPANEL=RELEASE
string or string

The frequency with which the server updates the operating system distribution's RPM packages each time that the /usr/local/cpanel/scripts/upcp script runs.

If you do not set this parameter, the system retains the current setting.

  • daily - Update the RPM packages daily.
  • manual - Update the RPM packages manually.
  • never - If you specify never, the server administrator must run the /usr/local/cpanel/scripts/rpmup2 script when they update the server's RPM packages.
Example: RPMUP=daily
string or string

The frequency with which the server updates Apache SpamAssassin's™ rules when the /usr/local/cpanel/scripts/upcp script runs.

If you do not set this parameter, the system retains the current setting.

  • daily - Update Apache SpamAssassin rules daily.
  • manual - Update Apache SpamAssassin rules manually.
  • never - If you specify never, the server administrator must run the /usr/local/cpanel/scripts/rpmup2 script when they update Apache SpamAssassin's rules.
Example: SARULESUP=daily
STAGING_DIR
string

The absolute directory path to the staging directory for updates.

If you do not set this parameter, the system retains the current setting.

Example: STAGING_DIR=/usr/local/cpanel
string or string

When the system will check for updates.

If you do not set this parameter, the system retains the current setting.

  • daily - Update cPanel & WHM automatically through a cron job once every 24 hours.
  • manual - Update cPanel & WHM manually.
  • never - Do not update cPanel & WHM.
Example: UPDATES=daily

Responses

Response Schema: application/json
object

Request samples

whmapi1 --output=jsonpretty \
  update_updateconf

Response samples

Content type
application/json
{
  • "metadata": {
    • "command": "update_updateconf",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}