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/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/cphulk_status
- A server running WHM.
https://whm-server.tld:2087/json-api/cphulk_status
- 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/cphulk_statusResponse
application/json
{ "data": { "is_enabled": 1, "service": "cPHulk" }, "metadata": { "command": "cphulk_status", "reason": "OK", "result": 1, "version": 1 } }
Query Examples:
The record's IP address, if there is only one IP address to add.
Note:
To add multiple IP addresses, increment the parameter name. For example, ip-1, ip-2, and ip-3.
Add multiple IP addresses.
Add a single IP address.
Any of:
- string
- string
- string
- string
- string
- string
string(ipv4)
The cPHulk list's name.
black- Add a new record or records to the blacklist.white- Add a new record or records to the whitelist.
Enum"black""white"
Example: list_name=white
Whether to skip checking if cPHulk runs on the server.
1- Do not check if cPHulk is running.0- Check if cPHulk is running.
Note:
If cPHulk is disabled and you check its status, the function returns the following message: cPHulk is disabled on the server.
Default 0
Enum01
Example: skip_enabled_check=1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/create_cphulk_record
- A server running WHM.
https://whm-server.tld:2087/json-api/create_cphulk_record
- 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/create_cphulk_record?ip=192.168.0.1&list_name=white&comment=George+Wendt+flying+through+the+air.&skip_enabled_check=1'Response
application/json
{ "data": { "comment": "George Wendt flying through the air.", "ip_blocks_removed": 1, "ips_added": [ … ], "ips_failed": { … }, "iptable_bans_removed": 0, "list_name": "white", "requester_ip": "10.1.4.228", "requester_ip_is_whitelisted": 0 }, "metadata": { "command": "create_cphulk_record", "reason": "OK", "result": 1, "version": 1 } }
Query Examples:
The record's IP address.
Note:
To delete multiple IP addresses, increment the parameter name. For example, ip-1, ip-2, ip-3.
Multiple IP addresses.
Single IP address.
Any of:
- string
- string
- string
- string
- string
- string
string(ipv4)
The cPHulk list's name.
whiteblack
Enum"white""black"
Example: list_name=white
Whether to skip checking if cPHulk runs on the server.
1- Don’t check cPHulk’s status.0- Check cPHulk’s status.
Note:
If cPHulk is disabled and you check its status, the function returns the following message: cPHulk is disabled on the server.
Default 0
Enum01
Example: skip_enabled_check=1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/delete_cphulk_record
- A server running WHM.
https://whm-server.tld:2087/json-api/delete_cphulk_record
- 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/delete_cphulk_record?ip=192.168.0.1&list_name=white&skip_enabled_check=1'Response
application/json
{ "data": { "ips_failed": { … }, "ips_removed": [ … ], "list_name": "white", "requester_ip": "192.168.0.1", "requester_ip_is_whitelisted": 1 }, "metadata": { "command": "delete_cphulk_record", "reason": "OK", "result": 1, "version": 1 } }