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.

Authorizations:
query Parameters
user
required
string

The FTP account username.

Example: user=ftpaccount
domain
string <domain>

The user's associated domain.

Note:

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

Example: domain=example.com
kill
integer
Default: 0

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.

Enum: 0 1
Example: kill=0
quota
integer >= 0
Default: 0

The new quota, in megabytes.

Note:

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

Example: quota=500

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 set_quota user='ftpaccount'

Response samples

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