Child pages
  • cPanel API 1 Functions - Ftp::ftpquota
Skip to end of metadata
Go to start of metadata

 

Description

This function sets 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:

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$set_ftpquota = $cpanel->api1('Ftp', 'ftpquota', array('username','100000000','0') ); // Call the function.


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.
my $set_ftpquota = $cpliveapi->api1('Ftp','getftpquota', ['user','100000000','0'] ); # Call the function.


Note:

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

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Ftp::ftpquota( $FORM('user','quota','kill'))">
 Command Line
cpapi1 --user=username Ftp ftpquota user

Note:

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

 Output (none)
This function does not return output.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The FTP username.

A valid FTP username on the account.

user
quotainteger

The new FTP account quota.

This value defaults to 0.

  • A valid integer which measures the quota, in Megabytes (MB).
  • 0 — Unlimited quota.
100000000
killBoolean

Whether to remove the quota.

Note:

This parameter overrides the quota parameter.

This value defaults to 0.

  • 1 — Remove the quota and set it to unlimited.
  • 0 — Do not remove the quota. 
0

Returns

This function does not return output.