cPanel API 2 Functions - Cron::add_line - Knowledgebase

Description

This function adds a crontab entry.

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=add_line&command=/usr/bin/perl%20/home/username/happynewyear.pl&day=1&hour=0&minute=0&month=1&weekday=*

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Add a crontab entry.
$dick_clark = $cpanel->api2(
    'Cron', 'add_line',
 array(
        'command'        => '/usr/bin/perl/home/username/happynewyear.pl',
        'day'            => '1',
        'hour'           => '0',
        'minute'         => '0',
        'month'          => '1',
        'weekday'        => '*',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Add a crontab entry.
my $dick_clark = $cpliveapi->api2(
    'Cron', 'add_line',    {
        'command'        => '/usr/bin/perl/home/username/happynewyear.pl',
        'day'            => '1',
        'hour'           => '0',
        'minute'         => '0',
        'month'          => '1',
        'weekday'        => '*',
    }
);

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 add_line command=%2Fusr%2Fbin%2Fperl%2Fhome%2Fusername%2Fhappynewyear.pl day=1 hour=0 minute=0 month=1 weekday=*

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "add_line",
    "data": [
      {
        "linekey": "c5e242023f60e1bd37110687338e9e8d",
        "statusmsg": "crontab installed",
        "status": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Cron"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
weekday	string	Required 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	Required The minute of the hour on which the cron job runs.	An integer between 0 ns 59. * — Once per minute. /2 — Every other minute. /10 — Every 10 minutes. 0,30 — Every 30 minutes.	0
hour	string	Required 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	Required 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	Required 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
command	string	Required The command to run.	A valid string.	/usr/bin/perl/home/username/happynewyear.pl

Returns

Return	Type	Description	Possible values	Example
linekey	string	A unique ID for the line in the crontab file.	A valid string.	1
statusmsg	string	The status of the crontab file	A valid string.	crontab installed
status	Boolean	The function call's status.	1 — The function succeeded. 0 — The function failed.	1
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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.	1

Knowledgebase

Categories

Categories