Description

This function changes an FTP account's quota.

Examples 




https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_quota?user=ftpaccount&quota=500



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Set the new quota for the ftpaccount FTP user.
$new_quota = $cpanel->uapi(
    'Ftp', 'set_quota',
    array(
        'user'    => 'ftpaccount',
        'quota'   => '500',
         )
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Set the new quota for the ftpaccount FTP user.
my $new_quota = $cpliveapi->uapi(
    'Ftp', 'set_quota',
    {
        'user'    => 'ftpaccount',
        'quota'   => '500',
    }
);



<!-- Set the new quota for the ftpaccount FTP user. -->
[% execute( 'Ftp', 'set_quota', { user => 'ftpaccount', quota => '500' } ); %]



uapi --user=username Ftp set_quota user=ftpaccount quota=500




{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The FTP account username.

The username of an FTP account on the cPanel account.

ftpaccount
quotainteger

Required

The new quota.

  • An integer that represents the new quota, in Megabytes (MB).
  • 0 — Grants the account unlimited disk space.
500
killBoolean

Whether to disable quotas for the FTP account.

This parameter defaults to 0.

If you disable quotas for an FTP account, you grant that account unlimited disk space. 


  • 1 — Disable quotas.
  • 0 — Enable quotas.
0
domainstring

The user's associated domain.

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

We introduced this parameter in cPanel & WHM version 54.


A domain that the cPanel account owns.example.com

Returns

This function returns only metadata.