- Created by Documentation, last modified on Mar 27, 2020
Description
This function sets cPanel & WHM's update frequency.
Examples
JSON API
https://hostname.example.com:2087/cpsess##########/json-api/set_cpanel_updates?updates=manual
XML API
https://hostname.example.com:2087/cpsess##########/xml-api/set_cpanel_updates?updates=manual
Command Line
whmapi0 set_cpanel_updates updates=manual
Notes:
- You must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 0 documentation or run the
whmapi0 --helpcommand. If you run CloudLinux™, you must use the full path of the
whmapi0command:/usr/local/cpanel/bin/whmapi0
Output (JSON)
{
"statusmsg": "Cpanel update frequency set to daily",
"status": 1,
"updates": "daily"
}
Output (XML)
<set_cpanel_updates>
<status>1</status>
<statusmsg>Cpanel update frequency set to manual</statusmsg>
<updates>manual</updates>
</set_cpanel_updates>
Parameters
| Parameter | Type | Description | Possible values | Example |
|---|---|---|---|---|
updates | string | Required The frequency with which to run cPanel & WHM updates on a server. |
| daily |
Returns
| Return | Type | Description | Possible values | Example |
|---|---|---|---|---|
updates | string | The new frequency of server updates. |
| daily |
| Boolean | Whether the system successfully called the function. |
| 1 |
statusmsg | string | The result of the function. |
| Cpanel update frequency set to daily |
Function information
API Version:
WHM API 1 Equivalent:
Important:
We strongly recommend that you use WHM API 1. WHM API 0 is deprecated.
Available in:
WHM 11.32+
Methods:
GET, POST
Required Parameters:
updates
Return Formats:
About WHM API 0
WHM API 0 performs functions and accesses data in WHM.
Warning:
WHM API 0 is deprecated. We strongly recommend that you use the equivalent WHM API 1 function instead.
Notes:
- Some functions and parameters may require that you authenticate as the
rootuser. - You must use the appropriate WHM ports (
2086or2087) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 0 Sections - Accounts — Account functions allow you to manage cPanel accounts, WHM accounts, and their settings.
-
Page:WHM API 0 Functions - listaccts — This function queries the accounts on the server.
-
Page:WHM API 0 Functions - listsuspended — This function lists suspended accounts on the server.
-
Page:WHM API 0 Functions - passwd — This function modifies a cPanel or reseller account's password.
-
Page:WHM API 0 Functions - removeacct — This function deletes a cPanel or WHM account.