v1

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

Return FTP account's quota

This function checks an FTP account's quota.

Important:

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

get/Ftp/get_quota

Query parameters

accountstring required
Example:user1

The FTP account's username.

domainstring domain
Example:example.com

The user's associated domain.

Note:

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

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": "get_quota",
  "module": "Ftp",
  "result": {
    "data": "unlimited",
    "status": 1
  }
}