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

 

Description

This function retrieves the account's FTP statistics login information. You can use this information to download server logs.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$retrieve_username = $cpanel->api1('Ftp', 'ftpstatslogin'); // 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 $retrieve_username = $cpliveapi->api1('Ftp', 'ftpstatslogin'); # Call the function.


Note:

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

 

 cPanel Tag System (deprecated)


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.

<cpanel Module="Ftp::ftpstatslogin()">
 Command Line
cpapi1 --user=username Ftp ftpstatslogin

Note:

For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.  

 Output (plaintext)
username_logs

 

Parameters

This function does not accept parameters.

Returns

This function returns a string that contains the username of the cPanel account, appended with _logs.