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
Do not display the reseller's deleted cPanel accounts in the function's acct return. This parameter modifies the data output in the acct return.
1— Do not display.0— Display.
Default 0
Enum01
Example: filter_deleted=0
Do not display the reseller's suspended cPanel accounts in the function's acct return. This parameter modifies the data output in the acct return.
1— Do not display.0— Display.
Default 0
Enum01
Example: filter_suspended=0
The month to query, in numeric format.
This parameter defaults to the current month.
Example: month=2
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/resellerstats
- A server running WHM.
https://whm-server.tld:2087/json-api/resellerstats
- 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/resellerstats?user=username&filter_deleted=0&filter_suspended=0&month=2&year=2019'Response
application/json
{ "data": { "reseller": { … } }, "metadata": { "command": "resellerstats", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_public_contact
- A server running WHM.
https://whm-server.tld:2087/json-api/set_public_contact
- 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/set_public_contact?name=Bob%27s+Hosting&url=https%3A%2F%2Fbobshosting.net'Response
application/json
{ "metadata": { "command": "set_public_contact", "reason": "OK", "result": 1, "version": 1 } }
Request
This function adds IP addresses to a reseller's account.
Note:
To assign a main IP address to a reseller's account, call the WHM API 1 setresellermainip function.
For more information, read our Manage Reseller's IP Delegation documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/setresellerips
- A server running WHM.
https://whm-server.tld:2087/json-api/setresellerips
- 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/setresellerips?user=username&delegate=1&ips=192.168.0.20'Response
application/json
{ "data": { "all": 1, "ip": [ … ] }, "metadata": { "command": "setresellerips", "reason": "OK", "result": 1, "version": 1 } }