cPanel API 2 Functions - Cron::listcron - Knowledgebase

Description

This function lists all cron jobs.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Cron&cpanel_jsonapi_func=listcron

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List all cron jobs.

$list_cron = $cpanel->api2(

'Cron', 'listcron'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List all cron jobs.

my $list_cron = $cpliveapi->api2(

'Cron', 'listcron',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username Cron listcron

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listcron",
    "data": [
      {
        "hour": "0",
        "weekday": "*",
        "count": 1,
        "month": "*",
        "command_htmlsafe": "echo",
        "linekey": "f32e3d460c179443e5f772359c7954ec",
        "minute": "0",
        "day": "*",
        "command": "echo"
      },
      {
        "hour": "0",
        "weekday": "*",
        "count": 2,
        "month": "*",
        "command_htmlsafe": "ls",
        "linekey": "cf31628c697d5f9866b6226610bdba0c",
        "minute": "0",
        "day": "1",
        "command": "ls"
      },
      {
        "count": 3
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Cron"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
weekday	string	The day of the week on which the cron job runs.	0 — Sunday. 1 — Monday. 2 — Tuesday. 3 — Wednesday. 4 — Thursday. 5 — Friday. 6 — Saturday. * — Every day.	0
minute	string	The minute of the hour on which the cron job runs.	An integer between 0 and 59. * — Once per minute. /2 — Every other minute. /10 — Every 10 minutes. 0,30 — Every 30 minutes.	0
hour	string	The hour of the day on which the cron job runs.	An integer between 0 and 23. * — Every hour. */2 — Every other hour. 0,12 — Every 12 hours.	1
day	string	The day of the month on which the cron job runs.	An integer between 1 and 31. * — Every day. */2 — Every other day. 0,15 — On the 1st and 15th of the month.	1
month	string	The month of the year on which the cron job runs.	An integer between 1 and 12. * — Every month. */2 — Every other month. 0,6 — Every 6 hours.	1
count	integer	The sequence of the cron job.	An integer.	1
command	string	The command to run.	A valid string.	echo
command_htmlsafe	string	An HTML-safe version of the command to run.	A valid string.	echo
reason	string	A reason for failure. Note: This function only returns areason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.

Knowledgebase

Categories

Categories