Description

This function sets an account's FTP quota.

Examples


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

 

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.

 

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

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

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.

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.