Description

This function retrieves an account's FTP quota.

Examples


$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_ftpquota = $cpanel->api1('Ftp','getftpquota', array('user') ); // Call the function.

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $get_ftpquota = $cpliveapi->api1('Ftp','getftpquota', ['user'] ); # Call the function.

 

<cpanel Module="Ftp::getftpquota( $FORM('user'))">
cpapi1 --user=username Ftp getftpquota user

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

unlimited

 

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The FTP username. 

A valid FTP username on the account.

user

Returns

This function returns an integer that measures the quota in Megabytes (MB), or the string unlimited if the FTP account does not have a quota.