Child pages
  • UAPI Functions - Ftp::get_quota

Versions Compared

Key

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

Description

Excerpt
This function checks an FTP account's quota.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledFTPRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Ftp/get_quota?user=weeones

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
    )
);

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.
 
# Check the FTP account's quota.
my $check_ftp_quota = $cpliveapi->uapi(
    'Ftp', 'get_quota',
    {
        'user'    => 'weeones',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Template Toolkit


Code Block
languagexml
linenumberstrue
<!-- Check the FTP account's quota. -->
[% execute( 'Ftp', 'get_quota', { 'user' => 'weeones' } ); %]

Include Page
LIB:_TTLink
LIB:_TTLink

 


Expand
titleCommand Line


Code Block
languagexml
uapi --user=username Ftp get_quota user=weeones

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": "unlimited"
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

The user's associated domain.

This parameter defaults to the cPanel account's primary domain.

Note
titleNote:

We introduced this parameter in cPanel & WHM version 54.


A domain that the cPanel account owns. example.com
userstring

Required

The FTP account's username.

A valid FTP username on the cPanel account.

weeones

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