CPcpanel
Server Administration
Updates

Start cPanel & WHM update

Changed on

This function starts an update of cPanel & WHM.

get/start_cpanel_update

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

mode'force' | 'sync' | 'null' nullable
Example:force

The cPanel & WHM update’s mode of operation.

  • null — Only reinstall cPanel & WHM if a newer version is available.
  • force — Force a reinstall of cPanel & WHM, even if the system is up to date.
  • sync — Update the currently-installed version of cPanel & WHM instead of downloading a newer version. This ensures the current version installed has the correct files.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "is_new": 1,
    "log_path": "/var/cpanel/updatelogs/update.1604521159.log",
    "pid": 23456
  },
  "metadata": {
    "command": "start_cpanel_update",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes