---
title: "Return domain's DNS zone configuration"
method: GET
path: "/dumpzone"
tags: ["DNS", "DNS Zones"]
deprecated: true
---

# Return domain's DNS zone configuration

`GET /dumpzone`

> **Deprecated.**

This function returns a domain's DNS zone configuration.

**Important:**

* This function is **deprecated**. Use WHM's `parse_dns_zone` function.
* You **must** include either the `domain` or the `zone` parameters.
* When you disable the [DNS role](https://go.cpanel.net/serverroles), 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](https://tools.ietf.org/html/rfc7208). 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](https://bugzilla.redhat.com/show_bug.cgi?id=1215164).

## Query parameters

- `domain` string, domain, required
- `zone` string

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `zone` union[] — An array of objects of zone information. This array contains the `record` array of objects.
      - union
        - A — An object representing A record data. **Note:** For more information about A records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
          - `address` string — The zone record's IPv4 address.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `A` — A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - A6 — An object representing A6 record data. **Important:** A6 records are **deprecated**. We strongly **recommend** that you use [AAAA](http://tools.ietf.org/html/rfc3596) records to store IPv6 addresses.
          - `prefix` integer — The record's prefix length.
          - `refer` string — The record's address suffix.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `A6` — A6 records store IPv6 addresses. **Important:** A6 records are **deprecated**. We strongly **recommend** that you use [AAAA](http://tools.ietf.org/html/rfc3596) records to store IPv6 addresses.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Aaaa — An object representing AAAA record data. **Note:** For more information about AAAA records, read [RFC 3596 at IANA](http://tools.ietf.org/html/rfc3596).
          - `address` string — The zone record's IPv6 address.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `AAAA` — AAAA records store IPv6 addresses. **Important:** A6 records are **deprecated**. We strongly **recommend** that you use [AAAA](http://tools.ietf.org/html/rfc3596) records to store IPv6 addresses.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Asfdb — An object representing AFSDB record data. **Note:** For more information about AFSDB records, read [RFC 1183 at IANA](http://tools.ietf.org/html/rfc1183).
          - `hostname` string — The database servers' hostname.
          - `subtype` integer — The AFS cell type. A 16-bit integer that represents the type of AFS cell. For example, a value of 1 indicates an AFS version 3.0 Volume Location Server.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `AFSDB` — AFSDB records store the location of an AFS cell's database servers.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Caa — An object representing CAA record data. **Note:** For more information about CAA record flags and property tags, read the [RFC 6844](https://tools.ietf.org/html/rfc6844#section-3) documentation.
          - `flag` integer — Whether the CA will issue an SSL certificate if the CAA resource record contains unknown property tags. * `0` - Non-critical. The CAA Resource Record contains unknown property tags, and the CA issued an SSL certificate. * `1` - Critical. The CAA Resource Record contains unknown property tags, and the CA did **not** issue an SSL certificate.
          - `tag` string — The CAA record's property type. * `issue` - A CA issued a certificate for the domain. * `issuewild` - A CA issued a wildcard certificate for the domain. * `iodef` - The user specified a URL to which a CA may report policy violations.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `CAA` — CAA records control which certificate authorities can issue SSL certificates for a domain.
          - `value` string — The CA's domain or URL. * A valid [SSL provider](https://sslmate.com/labs/caa/). * A mailto URL or a standard URL.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Cname — An object representing CNAME record data. **Note:** For more information about CNAME records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
          - `cname` string — The canonical name (CNAME) alias.
          - `flatten` integer — Whether the specified CNAME value resolves with the record's IP address. * `1` - Resolves. * `0` - Does **not** resolve.
          - `flatten_to` string — The IP address to which the specified CNAME resolves.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `CNAME` — CNAME records create an alias to another hostname.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Dname — An object representing DNAME record data. **Note:** For more information about DNAME records, read [RFC 2672 at IANA](http://tools.ietf.org/html/rfc2672).
          - `dname` string — The delegation name (DNAME) alias.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `DNAME` — DNAME records create an alias for a hostname and its subnames.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Ds — An object representing DS record data. **Note:** For more information about DS records, read [RFC 4034 at IANA](http://tools.ietf.org/html/rfc4034).
          - `algorithm` integer — The record's algorithm number. * `1` — RSAMD5 * `2` — Diffie-Hellman * `3` — DSA/SHA-1 * `4` — Elliptic Curve * `5` — RSA/SHA-1 * `7` - RSASHA1-NSEC3-SHA1 * `8` - RSA/SHA-256 * `10` - RSA/SHA-512 * `13` - ECDSA Curve P-256 with SHA-256 * `14` - ECDSA Curve P-384 with SHA-384 * `252` — Indirect * `253` — Private DNS * `254` — Private OID
          - `digtype` integer — The record's digest type. * `1` — SHA-1 * `2` — SHA-256 * `4` — SHA-384
          - `keyname` integer — The record's KeyTag value.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `DS` — DS records specify a record's delegation signer.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Hinfo — An object representing HINFO record data. **Note:** For more information about HINFO records, read [RFC 1700 at IANA](http://tools.ietf.org/html/rfc1700.txt).
          - `cpu` string — The host's CPU type.
          - `os` string — The host's operating system.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `HINFO` — HINFO records specify a host's CPU and OS types.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Loc — An object representing LOC record data. **Note:** For more information about LOC records, read [RFC 1876 at IANA](http://tools.ietf.org/html/rfc1876).
          - `altitude` string — The location's altitude. The location's altitude above sea level, in meters, and the m character.
          - `horiz_pre` integer — The location's horizontal precision, in meters.
          - `latitude` string — The location's latitude.
          - `longitude` string — The location's longitude.
          - `size` integer — The diameter of a sphere that encloses the entire location, in meters.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `LOC` — LOC records store a hostname's geographical location.
          - `version` integer — The record's version number. You **must** set this value to `0`.
          - `vert_pre` integer — The location's vertical precision, in meters.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Mx — An object representing MX record data. **Note:** For more information about MX records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
          - `exchange` string — The server's location's canonical name (CNAME).
          - `preference` integer — The record's preference. An integer that represents the record's priority order. **Note:** Lower values have a higher priority order.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `MX` — MX records point a domain name to its MTAs.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Ns — An object representing NS record data. **Note:** For more information about NS records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
          - `nsdname` string — The domain's authoritative nameserver.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `NS` — NS records store a domain's authoritative nameservers.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Ptr — An object representing PTR record data. **Note:** For more information about PTR records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
          - `ptrdname` string — A pointer to a canonical name (CNAME).
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `PTR` — PTR records point to a CNAME.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Rp — An object representing RP record data. **Note:** For more information about RP records, read [RFC 1183 at IANA](https://tools.ietf.org/html/rfc1183).
          - `mbox` string — The Responsible Person's (RP's) email address.
          - `txtdname` string — The RP's domain name.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `RP` — RP records store a domain's Responsible Person's information.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Soa — An object representing SOA record data. **Note:** For more information about SOA records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
          - `Lines` integer — The number of lines in the SOA section.
          - `expire` integer — The amount of time to wait before the secondary server attempts to complete a zone transfer, in seconds.
          - `mname` string — The domain's authoritative nameserver.
          - `refresh` integer — The amount of time to wait before the secondary DNS server queries the primary DNS server's SOA records for changes, in seconds.
          - `retry` integer — The amount of time to wait before the secondary server retries a failed zone transfer, in seconds.
          - `rname` string — The Responsible Person's (RP's) email address.
          - `serial` integer — The zone file's revision number.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `SOA` — SOA records designate the beginning of a zone of authority.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Srv — An object representing SRV record data. **Note:** For more information about SRV records, read [RFC 2782 at IANA](http://tools.ietf.org/html/rfc2782).
          - `port` integer — The target host's port.
          - `priority` integer — The target host's preference. An integer that represents the target host's priority order. **Note:** Lower numbers have a higher priority order.
          - `target` string, domain — The service's target host.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `SRV` — SRV records store the service location records for newer protocols (for example, Autodiscover).
          - `weight` integer — A relative weight. The system uses this value to rank entries with the same `priority` value. An integer that represents the target host's weight against other hosts with the same `priority` value.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Sshfp — An object representing SSHFP record data. **Warning:** We do **not** currently support this DNS record type. **Note:** For more information about SSHFP records, read [RFC 4255 at IANA](http://tools.ietf.org/html/rfc4255).
          - `algorithm` integer — The public key's algorithm number. * `1` — RSA * `2` — DSS
          - `fptype` integer — The public key's fingerprint type. * `1` — SHA-1
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `SSHFP` — SSHFP records store a domain's SSH public host key's fingerprint. **Warning:** We do **not** currently support the SSHFP DNS record type.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
        - Txt — An object representing TXT record data. **Note:** For more information about TXT records, read [RFC 1464 at IANA](http://tools.ietf.org/html/rfc1464).
          - `txtdata` string — The TXT record's data.
          - `type` string — The [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). * `TXT` — TXT records store descriptive text or useful records (for example, SPF or DKIM records).
          - `unencoded` integer — Whether the TXT record's data is encoded. * `1` — Encoded. * `0` — **Not** encoded.
          - `Line` integer — The zone record's line number.
          - `class` string — The record's class. - IN - Very rarely, another valid DNS record class.
          - `name` string — The record's name.
          - `ttl` integer — The record's Time To Live (TTL).
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)
