WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
Query
The reseller's maximum total number of accounts.
Important:
The system only enforces this maximum if you set the enable_account_limit value to 1.
Example: account_limit=10
The reseller's total bandwidth limit.
Important:
The system only enforces this limit if you set the enable_resource_limits value to 1.
Example: bandwidth_limit=1073741824
The reseller's total disk space usage limit.
Important:
The system only enforces this limit if you set the enable_resource_limits value to 1.
Example: diskspace_limit=1073741824
Whether to limit the reseller's total number of accounts.
1— Limit.0— Do not limit.
Note:
Use this parameter with the account_limit parameter.
Default 0
Enum10
Example: enable_account_limit=0
Whether the reseller can oversell accounts.
1— The reseller can oversell accounts.0— The reseller cannot oversell accounts.
Important:
The system only enforces this limit if you set the enable_resource_limits value to 1.
Enum10
Example: enable_overselling=1
Whether the reseller can oversell bandwidth.
1— The reseller can oversell bandwidth.0— The reseller cannot oversell bandwidth.
Important:
The system only enforces this limit if you set the enable_resource_limits and the enable_overselling values to 1.
Enum10
Example: enable_overselling_bandwidth=1
Whether the reseller can oversell disk space.
1— The reseller can oversell disk space.0— The reseller cannot oversell disk space.
Important:
The system only enforces this limit if you set the enable_resource_limits and the enable_oversellng values to 1.
Enum10
Example: enable_overselling_diskspace=1
Whether to apply package limit numbers to the reseller.
1— Enable package limit numbers.0— Disable package limit numbers.
Enum10
Example: enable_package_limit_numbers=0
Whether to apply package limits to the reseller.
1— Enable package limits.0— Disable package limits.
Enum10
Example: enable_package_limits=0
Whether to limit the reseller's resources.
1— Limit resources.0— Do not limit resources.
Note:
Use this parameter with the bandwidthlimit, diskspace_limit, enable_overselling, enable_overselling_bandwidth, enable_overselling_diskspace, enable_overselling, enable_package_limits, and enable_package_limit_numbers parameters.
Default 0
Enum10
Example: enable_resource_limits=1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/setresellerlimits
- A server running WHM.
https://whm-server.tld:2087/json-api/setresellerlimits
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/setresellerlimits?user=username&account_limit=10&bandwidth_limit=1073741824&diskspace_limit=1073741824&enable_account_limit=0&enable_overselling=1&enable_overselling_bandwidth=1&enable_overselling_diskspace=1&enable_package_limit_numbers=0&enable_package_limits=0&enable_resource_limits=1'Response
application/json
{ "metadata": { "command": "setresellerlimits", "reason": "OK", "result": 1, "version": 1 } }
Query
Whether the reseller can access the package hosting plan.
1— Enable access.0— Disable access
Note:
If you use this parameter, you must also include the package parameter.
Enum01
Example: allowed=1
Whether to grant the reseller unlimited package use.
1— Grant the reseller unlimited package use.0— Use package limits.
Default 0
Enum01
Example: no_limit=0
The maximum number of accounts to which the reseller can assign the package hosting plan.
Note:
- If you use this parameter, you must also include the
packageparameter. - If you set a value for this parameter and set the
allowedparameter to0, the reseller cannot use the hosting plan.
Example: number=5
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/setresellerpackagelimit
- A server running WHM.
https://whm-server.tld:2087/json-api/setresellerpackagelimit
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/setresellerpackagelimit?user=username&allowed=1&no_limit=0&number=5&package=package1'Response
application/json
{ "metadata": { "command": "setresellerpackagelimit", "reason": "OK", "result": 1, "version": 1 } }