Child pages
  • cPanel API 2 Functions - Cron::edit_line

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function edits a crontab entry.

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
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&linekey=c5e242023f60e1bd37110687338e9e8d&command=/usr/bin/perl%20/home/username/happynewyear.pl&day=1&hour=0&minute=0&month=1&weekday=*

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Edit the crontab entry with the "c5e242023f60e1bd37110687338e9e8d" linekey.
$edit_crontab = $cpanel->api2(
    'Cron', 'edit_line',
 array(
        'linekey'        => 'c5e242023f60e1bd37110687338e9e8d',
        'command'        => '/usr/bin/perl/home/username/happynewyear.pl',
        'day'            => '1', 
        'hour'           => '0', 
        'minute'         => '0', 
        'month'          => '1', 
        'weekday'        => '*', 
    ) 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
#  Edit the crontab entry with the "c5e242023f60e1bd37110687338e9e8d" linekey.
my $dick_clark = $cpliveapi->api2(
    'Cron', 'edit_line',    { 
        'linekey'        => 'c5e242023f60e1bd37110687338e9e8d',
        'command'        => '/usr/bin/perl/home/username/happynewyear.pl',
        'day'            => '1', 
        'hour'           => '0', 
        'minute'         => '0', 
        'month'          => '1', 
        'weekday'        => '*', 
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username Cron edit_line linekey=c5e242023f60e1bd37110687338e9e8d command=%2Fusr%2Fbin%2Fperl%2Fhome%2Fusername%2Fhappynewyear.pl day=1 hour=0 minute=0 month=1 weekday=*

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "add_line",
    "data": [
      {
        "linekey": "c5e242023f60e1bd37110687338e9e8d",
        "statusmsg": "crontab installed",
        "status": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Cron"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

Parameters

Warning
titleImportant:

You must specify either the commandlinenumber or the linekey parameter.

ParameterTypeDescriptionPossible valuesExample
commandlinenumberinteger

The line of the cron entry to edit.

Note
titleNote:

Use the cPanel API 2 Cron::listcron function to determine the correct line. 

Any positive integer. 2
linekeystring

The linekey of the cron entry to edit.

Note
titleNote:

Use the cPanel API 2 Cron::listcron function to determine the correct linekey. 

A valid string.
c5e242023f60e1bd37110687338e9e8d
weekdaystring

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
minutestring

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
hourstring

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
daystring

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
monthstring

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
commandstring

Required

The command to run.

A valid string.

/usr/bin/perl/home/username/happynewyear.pl

Returns

ReturnTypeDescriptionPossible valuesExample
linekeystringA unique ID for the line in the crontab file.A random string.c5e242023f60e1bd37110687338e9e8d
statusmsgstringThe status of the crontab fileA valid string.
crontab installed
statusBooleanThe status of the function.
  • 1 — The function succeeded.
  • 0 — The function failed.
1
reasonstring

A reason for failure.

Note
titleNote:

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.
1