Child pages
  • WHM API 1 Functions - start_autossl_check_for_one_user
Skip to end of metadata
Go to start of metadata

 

Description

This function performs an AutoSSL certificate check in the background for a cPanel user.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/start_autossl_check_for_one_user?api.version=1&username=example
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/start_autossl_check_for_one_user?api.version=1&username=example
 Command Line
whmapi1 start_autossl_check_for_one_user username=example


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{ 
   "metadata":{ 
      "version":1,
      "reason":"OK",
      "command":"start_autossl_check_for_one_user",
      "result":1
   },
   "data":{ 
      "pid":29189
   }
}
 Output (XML)
<result>
    <metadata>
        <command>start_autossl_check_for_one_user</command>
        <version>1</version>
        <result>1</result>
        <reason>OK</reason>
    </metadata>
    <data>
        <pid>29193</pid>
    </data>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

     

Parameters

ParameterTypeDescriptionPossible valuesExample
usernamestring

Required

The cPanel username.

A valid cPanel username on the server.

example

Returns

ReturnTypeDescriptionPossible valuesExample
pidinteger

The process ID of the script.

A valid integer.
29193