Child pages
  • UAPI Functions - Ftp::set_quota
Skip to end of metadata
Go to start of metadata

Description

This function changes an FTP account's quota.

Important:

In cPanel & WHM version 76 and later, when you disable the FTP role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


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


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$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',
         )
);


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.
 
# Set the new quota for the ftpaccount FTP user.
my $new_quota = $cpliveapi->uapi(
    'Ftp', 'set_quota',
    {
        'user'    => 'ftpaccount',
        'quota'   => '500',
    }
);


Note:

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

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


Note:

For more information, read our Guide to Template Toolkit documentation. 

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



Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

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.

Note:

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.

Note:

We introduced this parameter in cPanel & WHM version 54.

A domain that the cPanel account owns.example.com

Returns

This function returns only metadata.