Limit Bandwidth Usage (Transfer) — limitbw

To use the XML API to perform the limitbw function from within your custom script:

• Append the /xml-api/limitbw function call name, plus the required variables (see below), to a URL which includes the address of your server.

• For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/xml-api/limitbw

• You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

• You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

To use the JSON API to perform the limitbw function from within your custom script:

• Append the /json-api/limitbw function call name, plus the required variables (see below), to a URL which includes the address of your server.

• For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/json-api/limitbw

• You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

• You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Calling this function in WebHost Manager:

https://example.com:2087/xml-api/limitbw?user=username&bwlimit=5

will produce output similar to:

<limitbw>
    <result>
        <bwlimit>
             <bwlimit>5242880</bwlimit>
             <bwlimitenable>1</bwlimitenable>
             <domains>example.com</domains>
             <domains>example2.com</domains>
             <human_bwlimit>5 MB</human_bwlimit>
             <human_bwused>1.81 KB</human_bwused>
             <unlimited>0</unlimited>
        </bwlimit>
        <status>1</status>
        <statusmsg>Bandwidth Limit for username set to 5</statusmsg>
    </result>
</limitbw>

This will modify the user "username" to have a bandwidth usage limit of 5 MB.

Calling this function in WebHost Manager:

https://example.com:2087/json-api/limitbw?user=joe&bwlimit=5

will produce output similar to:

{
   "result":[
      {
         "status":1,
         "statusmsg":"Bandwidth Limit for joe set to 5",
         "bwlimit":{
            "bwlimitenable":0,
            "human_bwlimit":"5 MB",
            "domains":[
               "example.com"
            ],
            "unlimited":0,
            "bwlimit":5242880,
            "human_bwused":"none"
         }
      }
   ]
}

This will modify the user "joe" to have a bandwidth usage limit of 5 MB.