We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description


This function retrieves an account's FTP quota.

Warning:

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

  • UAPI (recommended)Ftp::get_quota

    Error rendering macro 'excerpt-include'

    No link could be created for 'UAPI Functions - Ftp::get_quota'.

  • cPanel API 2None.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_ftpquota = $cpanel->api1('Ftp','getftpquota', array('user') ); // 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 $get_ftpquota = $cpliveapi->api1('Ftp','getftpquota', ['user'] ); # 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::getftpquota( $FORM('user'))">
 Command Line
cpapi1 --user=username Ftp getftpquota user

Note:

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

 Output (plaintext)
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.