UAPI Functions - Ftp::set_quota - Knowledgebase

Description

This function changes an FTP account's quota.

Examples

cPanel or Webmail Session URL

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

 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',
         )
);

 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',
    }
);

cPanel Template Toolkit

[% execute( 'Ftp', 'set_quota', { user => 'ftpaccount', quota => '500' } ); %]

Command Line

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

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

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

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
user	string	Required The FTP account username.	The username of an FTP account on the cPanel account.	ftpaccount
quota	integer	Required The new quota.	An integer that represents the new quota, in Megabytes (MB). 0 — Grants the account unlimited disk space.	500
kill	Boolean	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
domain	string	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.

Knowledgebase

Categories

Categories