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/
Request
This function changes an IPv6 address range's name and/or note.
Notes:
- This function cannot modify the server's shared IPv6 address. To update that address, modify the /etc/wwwacct.conf file, or use WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup).
- For all of cPanel & WHM's features to function properly on IPv6, the
cpsrvddaemon must listen on IPv6 addresses. To enable this functionality, select On for the Listen on IPv6 Addresses setting in the System section of WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ipv6_range_edit
- A server running WHM.
https://whm-server.tld:2087/json-api/ipv6_range_edit
- 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/ipv6_range_edit?name=ExampleRange&new_name=AnotherRange¬e=This+is+an+update+to+the+note.'Response
application/json
{ "metadata": { "command": "ipv6_range_edit", "reason": "OK", "result": 1, "version": 1 } }
Request
This function lists available IPv6 address ranges.
Note:
For all of cPanel & WHM's features to function properly on IPv6, the cpsrvd daemon must listen on IPv6 addresses. To enable this functionality, select On for the Listen on IPv6 Addresses setting in the System section of WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ipv6_range_list
- A server running WHM.
https://whm-server.tld:2087/json-api/ipv6_range_list
- 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/ipv6_range_listResponse
application/json
{ "data": { "range": [ … ] }, "metadata": { "command": "ipv6_range_list", "reason": "OK", "result": 1, "version": 1 } }
Request
This function removes an IPv6 address range from the server.
Note:
- This function cannot modify the server's shared IPv6 address. To update that address, modify the
/etc/wwwacct.conffile, or use WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup). - For all of cPanel & WHM's features to function properly on IPv6, the
cpsrvddaemon must listen on IPv6 addresses. To enable this functionality, select On for the Listen on IPv6 Addresses setting in the System section of WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ipv6_range_remove
- A server running WHM.
https://whm-server.tld:2087/json-api/ipv6_range_remove
- 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/ipv6_range_remove?name=Range1'Response
application/json
{ "metadata": { "command": "ipv6_range_remove", "reason": "OK", "result": 1, "version": 1 } }