UAPI Functions - Ftp::get_quota - Knowledgebase

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

 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',
    )
);

 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',
    }
);

cPanel Template Toolkit

[% execute( 'Ftp', 'get_quota', { 'user' => 'weeones' } ); %]

Command Line

uapi --user=username Ftp get_quota user=weeones

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

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

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	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
user	string	Required The FTP account's username.	A valid FTP username on the cPanel account.	weeones

Parameter

Type

Description

Possible values

Example

domain

string

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

user

string

Required

The FTP account's username.

A valid FTP username on the cPanel account.

weeones

Returns

Return	Type	Description	Possible values	Example
data	string	The 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

Knowledgebase

Categories

Categories