You can find our user documentation at

Check out our new API beta site!

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


This function generates HTML links to BoxTrapper logs.


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 Receive Mail role, the system disables this function.


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$boxtrapper_logs = $cpanel->api1('BoxTrapper', 'logcontrols') ); // 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 $boxtrapper_logs = $cpliveapi->api1('BoxTrapper', 'logcontrols'); # 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="BoxTrapper::logcontrols()">
 Command Line
cpapi1 --user=username BoxTrapper logcontrols


  • 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)
<td align="left"><a href="/frontend/x3/test.html?bxaction=&">&lt;&lt; 02-18-2010</a>
<td align="center">02-19-2010</td>
<td align="right"><a href="/frontend/x3/test.html?bxaction=&">02-20-2010 &gt;&gt;</a></td>


This function does not accept parameters.


This function returns HTML that displays links to BoxTrapper's log files. These links are relative to the page that called the function.