Child pages
  • WHM API 1 Functions - start_autossl_check_for_all_users

Versions Compared

Key

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

 

Description

Excerpt

This function performs an AutoSSL certificate check in the background for all cPanel users that have the feature enabled.

Panel
bgColor#F2F2F2
borderStylenone

Examples


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

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{  
   "metadata":{  
      "version":1,
      "reason":"OK",
      "command":"start_autossl_check_for_all_users",
      "result":1
   },
   "data":{  
      "pid":29189
   }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <command>start_autossl_check_for_all_users</command>
        <version>1</version>
        <result>1</result>
        <reason>OK</reason>
    </metadata>
    <data>
        <pid>29193</pid>
    </data>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

     

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
pidinteger

The process ID of the script.

A valid integer.
29193