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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

 

Description

This function returns the cron entry for the autossl_check.pl AutoSSL certificate check script.

Examples


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


Notes:

  • Unless otherwise noted, 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)
{  
   "data":{  
      "next_time":"2016-06-09T06:00:00Z",
      "cron":[  
         58,
         3,
         "*",
         "*",
         "*"
      ]
   },
   "metadata":{  
      "reason":"OK",
      "command":"get_autossl_check_schedule",
      "result":1,
      "version":1
   }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <reason>OK</reason>
        <command>get_autossl_check_schedule</command>
    </metadata>
    <data>
        <next_time>2016-06-09T06:00:00Z</next_time>
        <cron>54</cron>
        <cron>1</cron>
        <cron>*</cron>
        <cron>*</cron>
        <cron>*</cron>
    </data>
</result>


Note:

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

     

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
next_timestring

The next time that the script will run.

A time value, in ISO-8601 format.

2016-06-09T06:00:00Z

cronarrayA list of the time elements of a cron entry that schedules when the script will run.

An array of cron elements.

For more information about each element in a cron entry, read the Cron Wikipedia article.

54 1 * * *

  • No labels