Description
This function lists all of the account's cron jobs.
Warning:
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
Examples
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Cron&cpanel_jsonapi_func=fetchcron
$cpanel = new CPANEL(); // Connect to cPanel - only do this once. // List all cron jobs.$list_cron = $cpanel->api2( 'Cron', 'fetchcron');my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once. # List all cron jobs.my $list_cron = $cpliveapi->api2( 'Cron', 'fetchcron',);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.
cpapi2 --user=username Cron fetchcron |
Notes:
- You must URI-encode values.
- username represents your account-level username.
{ "cpanelresult": { "apiversion": 2, "func": "fetchcron", "data": [ { "linekey": "a8728e6f20fade892367809a7b1d551b", "value": "user@example.com", "type": "variable", "line": 1, "key": "MAILTO" }, { "hour": "0", "weekday": "*", "commandnumber": 1, "month": "*", "linekey": "f32e3d460c179443e5f772359c7954ec", "minute": "0", "day": "*", "type": "command", "command": "echo", "line": 2 }, { "hour": "0", "weekday": "*", "commandnumber": 2, "month": "*", "linekey": "cf31628c697d5f9866b6226610bdba0c", "minute": "0", "day": "1", "type": "command", "command": "ls", "line": 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 |
|
linekey |
string |
An ID for the line. |
A valid string. |
f32e3d460c179443e5f772359c7954ec |
|
value |
string |
The notification email address. |
A valid email address. |
user@example.com |
|
type |
string |
The type of crontab entry. |
|
command |
|
line |
string |
The line of the crontab file. |
A positive integer. |
1 |
|
key |
string |
A key=value data pair. |
A pair of strings with an equals sign (=) between them. |
MAILTO=user@example.com |
|
weekday |
string |
The day of the week on which the cron job runs. |
|
0 |
|
minute |
string |
The minute of the hour on which the cron job runs. |
An integer between 0 and 59.
|
0 |
|
hour |
string |
The hour of the day on which the cron job runs. |
An integer between 0 and 23.
|
1 |
|
day |
string |
The day of the month on which the cron job runs. |
An integer between 1 and 31.
|
1 |
|
month |
string |
The month of the year on which the cron job runs. |
An integer between 1 and 12.
|
1 |
|
command |
string |
The command to run. |
A valid string. |
echo |
|
commandnumber |
integer |
The sequence in which this cron job will run. |
A positive integer. |
1 |
|
minute |
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. |
|
|