cPanel API 1 Functions - Ftp::getftpquota - Knowledgebase

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 — This function checks an FTP account's quota.
cPanel API 2 — None.

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.

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.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

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=user

Output (plaintext)

unlimited

Parameters

Parameter	Type	Description	Possible values	Example
user	string	Required The FTP username.	A valid FTP username on the account.	user

Parameter

Type

Description

Possible values

Example

user

string

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.

Knowledgebase

Categories

Categories