Skip to content
cPanel API 2 Modules
/
cPanel API 2 Modules - Cron
/
cPanel API 2 Functions - Cron::listcron
Last updated

cPanel API 2 Functions - Cron::listcron

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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)

syntaxhighlighter-pre
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
Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

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

// List all cron jobs.
$list_cron = $cpanel->api2(
    'Cron', 'listcron'
);
Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

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

# List all cron jobs.
my $list_cron = $cpliveapi->api2(
    'Cron', 'listcron',
);
Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:
  • cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

syntaxhighlighter-pre
cpapi2 --user=username Cron listcron
Notes:

  • You must URI-encode values.

  • username represents your account-level username.

  • You must include the --user=username option.

  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.

  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    syntaxhighlighter-pre
    /usr/local/cpanel/bin/cpapi2

Output (JSON)

syntaxhighlighter-pre
{
  "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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
weekdaystringThe day of the week on which the cron job runs.
  • 0or7 — Sunday.
  • 1 — Monday.
  • 2 — Tuesday.
  • 3 — Wednesday.
  • 4 — Thursday.
  • 5 — Friday.
  • 6 — Saturday.
  • * — Every day.
0
minutestringThe 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
hourstring

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
daystringThe day of the month on which the cron job runs.

An integer between 1 and 31.

  • * — Every day.
  • */2 — Every other day.
  • */15 — On the 1st and 15th of the month.
1
monthstringThe month of the year on which the cron job runs.

An integer between 1 and 12.

  • * — Every month.
  • */2 — Every other month.
  • */6 — Every six months.
1
countintegerThe sequence of the cron job.An integer.1
commandstringThe command to run.A valid string.echo
command_htmlsafestringAn HTML-safe version of the command to run.A valid string.echo
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.

Previous page
Next page