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.

Authorizations:
query Parameters
zone
required
string
Example: zone=example.com

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

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 parse_dns_zone zone='example.com'

Response samples

Content type
application/json
{
  • "data": {
    • "payload": [
      • {
        • "line_index": 0,
        • "text_b64": "OyBoZWxsbw==",
        • "type": "comment"
        },
      • {
        • "line_index": 1,
        • "text_b64": "JFRUTCAxMjM0NQ==",
        • "type": "control"
        },
      • {
        • "data_b64": [
          • "MTAuMS4zNC4yMzE="
          ],
        • "dname_b64": "d2ViZGlzaw==",
        • "line_index": 20,
        • "record_type": "A",
        • "ttl": 12345,
        • "type": "record"
        }
      ]
    },
  • "metadata": {
    • "command": "parse_dns_zone",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}