Return a parsed DNS zone

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.

SecurityBasicAuth
Request
query Parameters
zone
required
string

The name of one of the user’s DNS zones.

Example: zone=example.com
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/parse_dns_zone
Request samples
whmapi1 parse_dns_zone zone='example.com'
Response samples
application/json
{
  • "data": {
    • "payload": [
      • {
        • "line_index": 22,
        • "type": "record",
        • "data_b64": [
          • "dGV4YXMuY29tLg=="
          ],
        • "dname_b64": "dGV4YXMuY29tLg==",
        • "record_type": "MX",
        • "ttl": 14400
        }
      ]
    },
  • "metadata": {
    • "command": "parse_dns_zone",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}