Child pages
  • cPanel API 1 Functions - Ftp::getftpquota

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function retrieves an account's FTP quota.

Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)Ftp::get_quota
    Excerpt Include
    UAPI Functions - Ftp::get_quota
    UAPI Functions - Ftp::get_quota
    nopaneltrue
  • cPanel API 2None.
Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_ftpquota = $cpanel->api1('Ftp','getftpquota', array('user') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $get_ftpquota = $cpliveapi->api1('Ftp','getftpquota', ['user'] ); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Ftp::getftpquota( $FORM('user'))">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username Ftp getftpquota user
Note
titleNote:

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

Expand
titleOutput (plaintext)
Code Block
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.