cPanel API 1 Functions - LeechProtect::setup - Knowledgebase

Description

This function queries values that the system in a directory's .leechprotect configuration file.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — None.
cPanel API 2 — LeechProtect::setup — This function configures Leech Protection on a cPanel account.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$configure_leech = $cpanel->api1('LeechProtect','setup', array('public_html','uri','uri') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $configure_leech = $cpliveapi->api1('LeechProtect','setup', ['public_html','uri','uri']); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="LeechProtect::setup ( $FORM('dir','item','type'))">

Command Line

cpapi1 --user=username LeechProtect setup dir=public_html item=uri type=uri

Notes:

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

Output (HTML)

This function returns output that varies dramatically based on the input parameters that you use.

Parameters

Parameter	Type	Description	Possible values	Example
dir	string	Required The file's directory.	A valid directory path, relative to the user's home directory.	public_html
item	string	Required The item to query in the configuration file.	email kill numhits uri	uri
type	string	Required The function's output format.	html — Return HTML-encoded output. uri — Return URI-encoded output. check — Return checked if the value exists. checkbox — Return checked if the valueexists.	uri

Returns

This function's output varies, based on the type parameter's value.

Knowledgebase

Categories

Categories