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.

Authorizations:
query Parameters
account
required
string

The FTP account's username.

Example: account=user1
domain
string <domain>

The user's associated domain.

Note:

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

Example: domain=example.com

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username Ftp get_quota account='user1'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_quota",
  • "module": "Ftp",
  • "result": {
    • "data": "unlimited",
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}