Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function sets the frequency of cPanel & WHM updates.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/set_cpanel_updates?api.version=1&updates=daily
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/set_cpanel_updates?api.version=1&updates=daily
Expand
titleCommand Line
Code Block
languagebash
whmapi1 set_cpanel_updates updates=daily

Include Page
_WHMAPI1CLINote
_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{  
   "metadata":{  
      "version":1,
      "result":1,
      "command":"set_cpanel_updates",
      "reason":"Cpanel update frequency set to daily"
   },
   "data":{  
      "updates":"daily"
   }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <data>
        <updates>daily</updates>
    </data>
    <metadata>
        <version>1</version>
        <reason>Cpanel update frequency set to daily</reason>
        <result>1</result>
        <command>set_cpanel_updates</command>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

Parameters

ParameterTypeDescriptionPossible valuesExample
updatesstring

Required

The frequency with which to run cPanel & WHM updates on a server.

  • daily — Run updates daily.

  • manual — Run updates manually.
  • never — Never run updates.
daily

 

Returns

ReturnTypeDescriptionPossible valuesExample
updatesstringThe new frequency of server updates.
  • daily — Run updates daily.

  • manual — Run updates manually.
  • never — Never run updates.
daily