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
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/DNS/parse_zone
Request samples
uapi --output=jsonpretty \
  --user=username \
  DNS \
  parse_zone \
  zone='example.com'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "parse_zone",
  • "module": "DNS",
  • "result": {
    • "data": [
      • {
        • "line_index": 22,
        • "type": "record",
        • "data_b64": [
          • "dGV4YXMuY29tLg=="
          ],
        • "dname_b64": "dGV4YXMuY29tLg==",
        • "record_type": "MX",
        • "ttl": 14400
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}