v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Ftp
FTP Accounts

Update FTP account's quota

This function changes an FTP account's quota.

Important:

When you disable the FTP role, the system disables this function.

get/Ftp/set_quota

Query parameters

userstring required
Example:ftpaccount

The FTP account username.

domainstring domain
Example:example.com

The user's associated domain.

Note:

The default value is the cPanel account's primary domain.

kill0 | 1

Whether to disable quotas for the FTP account.

  • 1 - Disable quotas.
  • 0 - Enable quotas.

Note:

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

quotainteger
Example:500

The new quota, in megabytes.

Note:

Setting this parameter to 0 grants the account unlimited disk space.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "set_quota",
  "module": "Ftp",
  "result": {
    "status": 1
  }
}