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

Description


This function displays the account's log archival settings.

Warning:

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

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$show_logsettings = $cpanel->api1('LogManager','showsettings'); // Call the function.


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.
my $show_logsettings = $cpliveapi->api1('LogManager','showsettings'); # Call the function.


Note:

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

 cPanel Tag System (deprecated)
<cpanel Module="LogManager::showsettings()">


Warning:

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.

 Command Line
cpapi1 --user=username LogManager showsettings


Notes:

  • 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:

    /usr/local/cpanel/bin/cpapi1

 Output (HTML)
 
<input value=1 type=checkbox name=archivelogs> Archive Logs in your home directory at the end of each month <br />
<input value=1 type=checkbox name=remoldarchivedlogs> Remove the previous month's archived logs from your home directory at the end of each month <br />

Parameters

This function does not accept parameters.

Returns

This function displays a summary of the log archival settings, in HTML format.