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 parses a given DNS zone.
Important:
Most DNS zones contain only 7-bit ASCII. However, it is possible for DNS zones to contain any binary sequence. An application that decodes this function's base64 output must be able to handle cases where the decoded octets do not match any specific character encoding.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/parse_dns_zone
- A server running WHM.
https://whm-server.tld:2087/json-api/parse_dns_zone
- 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/parse_dns_zone?zone=example.com'Response
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "parse_dns_zone", "reason": "OK", "result": 1, "version": 1 } }
Request
This function deletes a DNS zone record.
Warning:
Incorrect use of this function could cause domains to resolve incorrectly. Exercise extreme caution when you remove DNS zone records.
To effectively use this function, use the following workflow:
- Run the
dumpzonefunction. - Locate the
Linevalue that corresponds to the zone record to delete. - Use the values from that zone record to formulate the appropriate
removezonerecordparameters.
Important:
- When you disable the DNS role, the system disables this function.
- You cannot use this function to modify temporary domains.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/removezonerecord
- A server running WHM.
https://whm-server.tld:2087/json-api/removezonerecord
- 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/removezonerecord?line=4&zone=example.com&serialnum=2013122501'Response
application/json
{ "metadata": { "command": "removezonerecord", "reason": "Bind reloading on hostname using rndc zone: [example.com]\n", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/update_reverse_dns_cache
- A server running WHM.
https://whm-server.tld:2087/json-api/update_reverse_dns_cache
- 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/update_reverse_dns_cacheResponse
application/json
{ "metadata": { "command": "update_reverse_dns_cache", "reason": "OK", "result": 1, "version": 1 } }