Update cPanel account bandwidth quota

This function modifies a cPanel account's bandwidth quota.

Authorizations:
query Parameters
user
required
string

The username of a cPanel account on the server.

Example: user=username
string or integer
Default: "unlimited"

The account's new bandwidth quota, in megabytes (MB).

  • 0 and unlimited - Grant the user unlimited bandwidth
Example: bwlimit=0

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  limitbw \
  user='username'

Response samples

Content type
application/json
{
  • "data": {
    • "bwlimits": [
      • {
        • "bwlimit": 0,
        • "bwlimitenable": 0,
        • "domains": [
          • "example.com",
          • "addondomain.com",
          • "subdomain.example.com"
          ],
        • "human_bwlimit": "500 MB",
        • "human_bwused": "none",
        • "unlimited": 1
        }
      ]
    },
  • "metadata": {
    • "command": "limitbw",
    • "reason": "Bandwidth Limit for username has been set to unlimited megabytes",
    • "result": 1,
    • "version": 1
    }
}