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 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
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
removezonerecord \
zone='example.com' \
line='4'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
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
update_reverse_dns_cacheResponse
application/json
{ "metadata": { "command": "update_reverse_dns_cache", "reason": "OK", "result": 1, "version": 1 } }
Request
This function returns a domain's DNS zone configuration.
Important:
- This function is deprecated. Use WHM's
parse_dns_zonefunction. - You must include either the
domainor thezoneparameters. - When you disable the DNS role, the system disables this function.
Note:
On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.
- This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
- Red Hat 7.1 and CentOS 7.1 both contain
bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the Red Hat Bugzilla case about SPF record errors.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/dumpzone
- A server running WHM.
https://whm-server.tld:2087/json-api/dumpzone
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
dumpzone \
domain='example.com'Response
application/json
{ "data": { "zone": [ … ] }, "metadata": { "command": "dumpzone", "reason": "Zone Serialized", "result": 1, "version": 1 } }