cPanel API 2 Functions - Cron::remove_line - Knowledgebase

Description

This function removes 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=remove_line&line=2

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Remove the crontab line "2"
$hotel_california = $cpanel->api2(
    'Cron', 'remove_line',
 array(
        'line'        => '2',
    )
);

LiveAPI Perl Module

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

# Remove the crontab line "2"

my $hotel_california = $cpliveapi->api2(

'Cron', 'remove_line', {

'line' => '2',

}

);

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 remove_line line=2

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "remove_line",
    "data": [
      {
        "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
line	integer	Required The line in the crontab file to remove.	A positive integer.	2

Parameter

Type

Description

Possible values

Example

line

integer

Required

The line in the crontab file to remove.

A positive integer.

Returns

Return	Type	Description	Possible values	Example
statusmsg	string	The crontab file's status.	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