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
  • UAPI Functions - Ftp::get_quota
Skip to end of metadata
Go to start of metadata

Description

This function checks an FTP account's quota.

Important:

In cPanel & WHM version 76 and later, when you disable the FTP role, the system disables this function.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Ftp/get_quota?account=user1&domain=example.com


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(
        'account'    => 'user1',
        'domain'     => 'example.com',
    )
);


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',
    {
        'account'    => 'user1',
        'domain'     => 'example.com',
    }
);


Note:

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


 Command Line
uapi --user=username Ftp get_quota account=user1 domain=example.com


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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
	"metadata": {},
	"warnings": null,
	"status": 1,
	"messages": null,
	"data": 12345,
	"errors": null
}


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
accountstring

Required

The FTP account's username.

A valid FTP username on the cPanel account.

user1

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