Child pages
  • cPanel API 2 Functions - LeechProtect::setup
Skip to end of metadata
Go to start of metadata

 

Description

This function configures Leech Protection on a cPanel account. 


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=LeechProtect&cpanel_jsonapi_func=setup&dir=%2Fhome%2Fexample%2Fpublic_html%2Fnewdir&item=url&type=html


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.
 
// Checks the Leech Protection status on a directory
$check_leech = $cpanel->api2(
    'LeechProtect', 'setup', 
    array(
        'dir'  => '/home/example/public_html/newdir',
        'item' => 'url',
        'type' => 'html', 
) 
);


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.
 
# Sets the "en" locale for the account
my $check_leech = $cpliveapi->api2(
    'LeechProtect', 'setup',
    { 
        'dir'  => '/home/example/public_html/newdir',
        'item' => 'url',
        'type' => 'html', 
    }
);


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

  • 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. 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 LeechProtect setup dir=%2Fhome%2Fexample%2Fpublic_html%2Fnewdir item=url type=html


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
 This function does not return output.


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The directory to query.

A valid absolute directory path.

/home/example/public_html/newdir
itemstring

Required

The type of item to query.

  • email — The notification email.
  • kill — Disable compromised accounts.
  • numhits — The maximum number of logins per username per two-hour period.
  • url — The URL to redirect leeches to.
url
typestring

Required

The output type.

  • html — Return HTML-formatted output.
  • uri — Return URI-encoded output.
  • check — Return checked if value is present.
uri

Returns

ReturnTypeDescriptionPossible ValuesExample
reasonstring

A reason for failure.

Note:

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