Start cPanel & WHM update

This function starts an update of cPanel & WHM.

SecurityBasicAuth

Request

query Parameters

mode

string or null

Default: null

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.

Enum: "force" "sync"

Example: mode=force

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/start_cpanel_update

Request samples

whmapi1 start_cpanel_update

Response samples

application/json

{"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
}
}