Description

This function checks an FTP account's quota.

Examples 




https://hostname.example.com:2083/cpsess##########/execute/Ftp/get_quota?user=weeones



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Check the FTP account's quota.
$check_ftp_quota = $cpanel->uapi(
    'Ftp', 'get_quota',
    array(
        'user'    => 'weeones',
    )
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Check the FTP account's quota.
my $check_ftp_quota = $cpliveapi->uapi(
    'Ftp', 'get_quota',
    {
        'user'    => 'weeones',
    }
);

 



<!-- Check the FTP account's quota. -->
[% execute( 'Ftp', 'get_quota', { 'user' => 'weeones' } ); %]

 



uapi --user=username Ftp get_quota user=weeones



{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": "unlimited"
}



Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

The user's associated domain.

This parameter defaults to the cPanel account's primary domain.

We introduced this parameter in cPanel & WHM version 54.


A domain that the cPanel account owns. example.com
userstring

Required

The FTP account's username.

A valid FTP username on the cPanel account.

weeones

Returns

ReturnTypeDescriptionPossible valuesExample
datastringThe FTP account's quota.
  • unlimited
  • A positive integer that represents the maximum amount of disk space that the FTP account can use, in Megabytes (MB).
unlimited