This function modifies the Bandwidth Usage (transfer) Limit for a specific account.
- user (string)
-
Name of user to modify the bandwidth usage (transfer) limit for.
- bwlimit (string)
-
Bandwidth Usage (Transfer) Limit. (in MB)
- limitbw
-
Edit Bandwidth Limit Container
- result
-
Result of bandwidth modification
- bwlimit (int)
-
Bandwidth Limit (in KB)
- bwlimitenable (boolean)
-
Whether or not the bandwidth limit is enforced. Yes=1, No=0.
- domains (string)
-
Domain owned by the user being modified
- human_bwlimit (string)
-
Human Readable Bandwidth Usage (Transfer) Limit.
- human_bwused (string)
-
Human Readable Current Monthly Bandwidth Usage (Transfer).
- unlimited (boolean)
-
Whether or not the account is permitted unlimited bandwidth usage (transfer). Yes=1, No=0.
- status (boolean)
-
Whether or not the edit was successful. Yes=1, No=0. Format: status=``0|1''
- statusmsg (string)
-
Message as a result of the operation. Format: statusmsg=``message''
Calling this URL in WebHost Manager:
/xml-api/limitbw?user=nick&bwlimit=1
will produce:
<limitbw>
<result>
<bwlimit>
<bwlimit>1048576</bwlimit>
<bwlimitenable>0</bwlimitenable>
<domains>domain.tld</domains>
<domains>domain2.tld</domains>
<humanbw_limit>1 MB</human_bwlimit>
<humanbw_used>none</human_bwused>
<unlimited>0</unlimited>
</bwlimit>
<status>1</status>
<statusmsg>Bandwidth Limit for nick set to 1</statusmsg>
</result>
</limitbw>
This will modify the user nick to have a bandwidth usage limit of 1 MB.
Copyright 2008 cPanel Inc.