Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function checks an FTP account's quota.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Ftp/get_quota?user=weeones

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$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',
    )
);

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.
 
# Check the FTP account's quota.
my $check_ftp_quota = $cpliveapi->uapi(
    'Ftp', 'get_quota',
    {
        'user'    => 'weeones',
    }
);

Note:

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

 

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

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Ftp get_quota user=weeones

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": "unlimited"
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

The user's associated domain.

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

Note:

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