You can find our user documentation at

Check out our new API beta site!

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


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


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


In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.


 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.


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.
my $configure_leech = $cpliveapi->api1('LeechProtect','setup', ['public_html','uri','uri']); # Call the function.


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

 cPanel Tag System (deprecated)


In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. 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 public_html uri uri


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


 Output (HTML)
This function returns output that varies dramatically based on the input parameters that you use.


ParameterTypeDescriptionPossible valuesExample


The file's directory.

A valid directory path, relative to the user's home directory.public_html
item string


The item to query in the configuration file.

  • email
  • kill
  • numhits
  • uri
type string


The function's output format.

  • raw — Return non-formatted output.
  • html — Return HTML-encoded output.
  • uri — Return URI-encoded output.
  • check — Return checked if the value exists.
  • checkbox — Return checked if the value exists.


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