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/get_nameserver_config
- A server running WHM.
https://whm-server.tld:2087/json-api/get_nameserver_config
- 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/get_nameserver_configResponse
application/json
{ "data": { "nameservers": [ … ] }, "metadata": { "command": "get_nameserver_config", "reason": "OK", "result": 1, "version": 1 } }
Request
This function returns whether ALIAS and ANAME records are available and the value of the running PowerDNS (PDNS) resolver setting, if any exists. For more information, read our ALIAS documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/is_alias_available
- A server running WHM.
https://whm-server.tld:2087/json-api/is_alias_available
- 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/is_alias_availableResponse
application/json
{ "data": { "alias": 1, "aname": 0, "resolver": "8.8.8.8" }, "metadata": { "command": "is_alias_available", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/lookupnsip
- A server running WHM.
https://whm-server.tld:2087/json-api/lookupnsip
- 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/lookupnsip?host=ns1.example.com'Response
application/json
{ "data": { "ip": "192.168.0.20" }, "metadata": { "command": "lookupnsip", "reason": "OK", "result": 1, "version": 1 } }