cPanel API 2 Functions - Cron::add_line

Warning:

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

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=*

Note:

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

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'        => '*',
    )
);

Note:

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

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'        => '*',
    }
);

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

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.
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:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

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

Note:

Use cPanel's API Shell interface (cPanel >> 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 or `7` — 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` and `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. `1,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. `*/6` — Every six months.	`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.	`1727752715`
`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. This function only returns a `reason` 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.	`1`