View Source

Description

This function returns a domain's DNS zone configuration.

Examples

https://hostname.example.com:2087/cpsess##########/json-api/dumpzone?api.version=1&domain=example.com

https://hostname.example.com:2087/cpsess##########/xml-api/dumpzone?api.version=1&domain=example.com

whmapi1 dumpzone domain=example.com

{
  "data": {
    "zone": [
      {
        "record": [
          {
            "Line": 1,
            "ttl": "86400",
            "type": ":RAW",
            "raw": "; cPanel first:11.38.0.9999 (update_time):1369075671 11.38.0.9999: Cpanel::ZoneFile::VERSION:1.3 hostname:laurence.dev.cpanel.net latest:11.38.0.9999"
          },
          {
            "Line": 2,
            "ttl": "86400",
            "type": ":RAW",
            "raw": "; Zone file for example.com"
          },
          {
            "Line": 3,
            "ttl": "14400",
            "type": "$TTL"
          },
          {
            "minimum": "86400",
            "ttl": "86400",
            "serial": "2013052008",
            "name": "example.com.",
            "mname": "ns1.dev.cpanel.net",
            "retry": "7200",
            "refresh": "86400",
            "Line": 4,
            "Lines": 6,
            "class": "IN",
            "type": "SOA",
            "rname": "hostname.example.com",
            "expire": "3600000"
          },
          {
            "Line": 10,
            "ttl": "86400",
            "type": ":RAW",
            "raw": ""
          },
          {
            "nsdname": "ns1.dev.cpanel.net",
            "Line": 11,
            "ttl": "86400",
            "name": "example.com.",
            "type": "NS",
            "class": "IN"
          },
          {
            "nsdname": "ns2.dev.cpanel.net",
            "Line": 12,
            "ttl": "86400",
            "name": "example.com.",
            "type": "NS",
            "class": "IN"
          },
          {
            "Line": 13,
            "ttl": "86400",
            "type": ":RAW",
            "raw": ""
          },
          {
            "Line": 14,
            "ttl": "86400",
            "type": ":RAW",
            "raw": ""
          },
          {
            "Line": 15,
            "ttl": "14400",
            "name": "example.com.",
            "type": "A",
            "class": "IN",
            "address": "192.168.0.20"
          },
          {
            "Line": 16,
            "ttl": "86400",
            "type": ":RAW",
            "raw": ""
          },
          {
            "Line": 17,
            "ttl": "14400",
            "name": "localhost.example.com.",
            "type": "A",
            "class": "IN",
            "address": "127.0.0.1"
          },
          {
            "Line": 18,
            "ttl": "86400",
            "type": ":RAW",
            "raw": ""
          },
          {
            "preference": "0",
            "Line": 19,
            "ttl": "14400",
            "name": "example.com.",
            "type": "MX",
            "class": "IN",
            "exchange": "example.com"
          },
          {
            "Line": 20,
            "ttl": "86400",
            "type": ":RAW",
            "raw": ""
          },
          {
            "Line": 21,
            "ttl": "14400",
            "name": "mail.example.com.",
            "type": "CNAME",
            "class": "IN",
            "cname": "example.com"
          },
          {
            "Line": 22,
            "ttl": "14400",
            "name": "www.example.com.",
            "type": "CNAME",
            "class": "IN",
            "cname": "example.com"
          },
          {
            "Line": 23,
            "ttl": "14400",
            "name": "ftp.example.com.",
            "type": "A",
            "class": "IN",
            "address": "192.168.0.20"
          },
          {
            "unencoded": 1,
            "Line": 24,
            "ttl": "14400",
            "name": "default._domainkey.example.com.",
            "txtdata": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDKe3qub4v3KSHu+FCo0x+e2uxkq\/XjINrJg3pRqdQheAEKCnZpjnygHTuWTltg1Lw7xznB6kmNizf9xwFkRUdfxFW5W9Htbja\/WKJ+DC49QzSsYAc7zH199bOcHnXjno6SHVbu+7B+cFNfaKwgmHL4rE+3PO5\/rsSHER2BKtk9yQIDAQAB;",
            "type": "TXT",
            "class": "IN"
          },
          {
            "Line": 25,
            "ttl": "14400",
            "name": "test.example.com.",
            "type": "A",
            "class": "IN",
            "address": "192.168.0.20"
          },
          {
            "Line": 26,
            "ttl": "14400",
            "name": "www.test.example.com.",
            "type": "A",
            "class": "IN",
            "address": "192.168.0.20"
          },
          {
            "Line": 27,
            "ttl": "14400",
            "name": "webdisk.test.example.com.",
            "type": "A",
            "class": "IN",
            "address": "192.168.0.20"
          },
          {
            "unencoded": 1,
            "Line": 28,
            "ttl": "14400",
            "name": "default._domainkey.test.example.com.",
            "txtdata": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDVe258EBqvMuPkbhl5CSrrTS6hJpwOs6BAJntSkY+w+ZJ6cRcuTf8YdK+zcQJmv0nY0Ypd2irt\/vxqZbV+DomIjGFxVepRlQW3+2yqUY7wGCnqPOo5JMJ8M75vi\/tCwA\/5Xtwwc50uV6X06t2GedqVcB1l3PR7G3rSXW6HRrQT2wIDAQAB;",
            "type": "TXT",
            "class": "IN"
          },
          {
            "Line": 29,
            "ttl": "14400",
            "name": "doggy.example.com.",
            "type": "A",
            "class": "IN",
            "address": "192.168.0.20"
          },
          {
            "Line": 30,
            "ttl": "14400",
            "name": "www.doggy.example.com.",
            "type": "A",
            "class": "IN",
            "address": "192.168.0.20"
          },
          {
            "Line": 31,
            "ttl": "14400",
            "name": "webdisk.doggy.example.com.",
            "type": "A",
            "class": "IN",
            "address": "192.168.0.20"
          },
          {
            "unencoded": 1,
            "Line": 32,
            "ttl": "14400",
            "name": "default._domainkey.doggy.example.com.",
            "txtdata": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCfD29kZETQCd8YhNCP\/6ifAo4V7cuT2OfPkT8W3WbhQXg3I9owjmqjfK7DxjcT3QHs6eBiGw4D5r3Bmk3vyyHooThH2Z5rq\/lf4jdjHV65\/6lqs+nt3mR\/JHLKBM9UZuxwLhvH2ftzSLLwCEHlWuFk+Xyi514ZZ1TTvRSnfVedHQIDAQAB;",
            "type": "TXT",
            "class": "IN"
          },
          {
            "Line": 33,
            "ttl": "14400",
            "name": "fred.example.com.",
            "type": "A",
            "class": "IN",
            "address": "192.168.0.20"
          },
          {
            "Line": 34,
            "ttl": "14400",
            "name": "www.fred.example.com.",
            "type": "A",
            "class": "IN",
            "address": "192.168.0.20"
          },
          {
            "Line": 35,
            "ttl": "14400",
            "name": "webdisk.fred.example.com.",
            "type": "A",
            "class": "IN",
            "address": "192.168.0.20"
          },
          {
            "unencoded": 1,
            "Line": 36,
            "ttl": "14400",
            "name": "default._domainkey.fred.example.com.",
            "txtdata": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+KCIYzo+HlGcTMEGXD1xYGya9KuUjcrA4dsEND0FeWXg9d1ebiS6hSLXuE2Z2BmZ98QA49wBC1S8v4OYACx1gTGxxUfToVUZICW36pOncQEeUukhs8vDJK9\/OqP7F23g7fOTjIdzcJC9pQP8jsc1j+b+4hXjPtKtaWHhTjl9E8wIDAQAB;",
            "type": "TXT",
            "class": "IN"
          },
		  {
			"Line" : 37,
			"ttl": "14400",
			"name": "www.example.com"
			"flag": "1"
			"tag": "issue"
			"value": "totallyrealca.tld"
			"type": "CAA"
			"Class": "IN"
		 }
        ]
      }
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "Zone Serialized",
    "result": 1,
    "command": "dumpzone"
  }
}

<result>
    <data>
        <zone>
            <record>
                <Line>1</Line>
                <ttl>86400</ttl>
                <type>:RAW</type>
                <raw>
                    ; cPanel first:11.38.0.9999 (update_time):1369075671 11.38.0.9999: Cpanel::ZoneFile::VERSION:1.3 hostname:hostname.example.com latest:11.38.0.9999
                </raw>
            </record>
            <record>
                <Line>2</Line>
                <ttl>86400</ttl>
                <type>:RAW</type>
                <raw>; Zone file for example.com</raw>
            </record>
            <record>
                <Line>3</Line>
                <ttl>14400</ttl>
                <type>$TTL</type>
            </record>
            <record>
                <minimum>86400</minimum>
                <ttl>86400</ttl>
                <serial>2013052008</serial>
                <name>example.com.</name>
                <mname>ns1.dev.cpanel.net</mname>
                <retry>7200</retry>
                <refresh>86400</refresh>
                <Line>4</Line>
                <Lines>6</Lines>
                <class>IN</class>
                <type>SOA</type>
                <rname>hostname.example.com</rname>
                <expire>3600000</expire>
            </record>
            <record>
                <Line>10</Line>
                <ttl>86400</ttl>
                <type>:RAW</type>
                <raw/>
            </record>
            <record>
                <nsdname>ns1.dev.cpanel.net</nsdname>
                <Line>11</Line>
                <ttl>86400</ttl>
                <name>example.com.</name>
                <type>NS</type>
                <class>IN</class>
            </record>
            <record>
                <nsdname>ns2.dev.cpanel.net</nsdname>
                <Line>12</Line>
                <ttl>86400</ttl>
                <name>example.com.</name>
                <type>NS</type>
                <class>IN</class>
            </record>
            <record>
                <Line>13</Line>
                <ttl>86400</ttl>
                <type>:RAW</type>
                <raw/>
            </record>
            <record>
                <Line>14</Line>
                <ttl>86400</ttl>
                <type>:RAW</type>
                <raw/>
            </record>
            <record>
                <Line>15</Line>
                <ttl>14400</ttl>
                <name>example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>192.168.0.20</address>
            </record>
            <record>
                <Line>16</Line>
                <ttl>86400</ttl>
                <type>:RAW</type>
                <raw/>
            </record>
            <record>
                <Line>17</Line>
                <ttl>14400</ttl>
                <name>localhost.example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>127.0.0.1</address>
            </record>
            <record>
                <Line>18</Line>
                <ttl>86400</ttl>
                <type>:RAW</type>
                <raw/>
            </record>
            <record>
                <preference>0</preference>
                <Line>19</Line>
                <ttl>14400</ttl>
                <name>example.com.</name>
                <type>MX</type>
                <class>IN</class>
                <exchange>example.com</exchange>
            </record>
            <record>
                <Line>20</Line>
                <ttl>86400</ttl>
                <type>:RAW</type>
                <raw/>
            </record>
            <record>
                <Line>21</Line>
                <ttl>14400</ttl>
                <name>mail.example.com.</name>
                <type>CNAME</type>
                <class>IN</class>
                <cname>example.com</cname>
            </record>
            <record>
                <Line>22</Line>
                <ttl>14400</ttl>
                <name>www.example.com.</name>
                <type>CNAME</type>
                <class>IN</class>
                <cname>example.com</cname>
            </record>
            <record>
                <Line>23</Line>
                <ttl>14400</ttl>
                <name>ftp.example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>192.168.0.20</address>
            </record>
            <record>
                <unencoded>1</unencoded>
                <Line>24</Line>
                <ttl>14400</ttl>
                <name>default._domainkey.example.com.</name>
                <txtdata>
                    v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDKe3qub4v3KSHu+FCo0x+e2uxkq/XjINrJg3pRqdQheAEKCnZpjnygHTuWTltg1Lw7xznB6kmNizf9xwFkRUdfxFW5W9Htbja/WKJ+DC49QzSsYAc7zH199bOcHnXjno6SHVbu+7B+cFNfaKwgmHL4rE+3PO5/rsSHER2BKtk9yQIDAQAB;
                </txtdata>
                <type>TXT</type>
                <class>IN</class>
            </record>
            <record>
                <Line>25</Line>
                <ttl>14400</ttl>
                <name>test.example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>192.168.0.20</address>
            </record>
            <record>
                <Line>26</Line>
                <ttl>14400</ttl>
                <name>www.test.example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>192.168.0.20</address>
            </record>
            <record>
                <Line>27</Line>
                <ttl>14400</ttl>
                <name>webdisk.test.example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>192.168.0.20</address>
            </record>
            <record>
                <unencoded>1</unencoded>
                <Line>28</Line>
                <ttl>14400</ttl>
                <name>default._domainkey.test.example.com.</name>
                <txtdata>
                    v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDVe258EBqvMuPkbhl5CSrrTS6hJpwOs6BAJntSkY+w+ZJ6cRcuTf8YdK+zcQJmv0nY0Ypd2irt/vxqZbV+DomIjGFxVepRlQW3+2yqUY7wGCnqPOo5JMJ8M75vi/tCwA/5Xtwwc50uV6X06t2GedqVcB1l3PR7G3rSXW6HRrQT2wIDAQAB;
                </txtdata>
                <type>TXT</type>
                <class>IN</class>
            </record>
            <record>
                <Line>29</Line>
                <ttl>14400</ttl>
                <name>doggy.example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>192.168.0.20</address>
            </record>
            <record>
                <Line>30</Line>
                <ttl>14400</ttl>
                <name>www.doggy.example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>192.168.0.20</address>
            </record>
            <record>
                <Line>31</Line>
                <ttl>14400</ttl>
                <name>webdisk.doggy.example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>192.168.0.20</address>
            </record>
            <record>
                <unencoded>1</unencoded>
                <Line>32</Line>
                <ttl>14400</ttl>
                <name>default._domainkey.doggy.example.com.</name>
                <txtdata>
                    v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCfD29kZETQCd8YhNCP/6ifAo4V7cuT2OfPkT8W3WbhQXg3I9owjmqjfK7DxjcT3QHs6eBiGw4D5r3Bmk3vyyHooThH2Z5rq/lf4jdjHV65/6lqs+nt3mR/JHLKBM9UZuxwLhvH2ftzSLLwCEHlWuFk+Xyi514ZZ1TTvRSnfVedHQIDAQAB;
                </txtdata>
                <type>TXT</type>
                <class>IN</class>
            </record>
            <record>
                <Line>33</Line>
                <ttl>14400</ttl>
                <name>fred.example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>192.168.0.20</address>
            </record>
            <record>
                <Line>34</Line>
                <ttl>14400</ttl>
                <name>www.fred.example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>192.168.0.20</address>
            </record>
            <record>
                <Line>35</Line>
                <ttl>14400</ttl>
                <name>webdisk.fred.example.com.</name>
                <type>A</type>
                <class>IN</class>
                <address>192.168.0.20</address>
            </record>
            <record>
                <unencoded>1</unencoded>
                <Line>36</Line>
                <ttl>14400</ttl>
                <name>default._domainkey.fred.example.com.</name>
                <txtdata>
                    v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+KCIYzo+HlGcTMEGXD1xYGya9KuUjcrA4dsEND0FeWXg9d1ebiS6hSLXuE2Z2BmZ98QA49wBC1S8v4OYACx1gTGxxUfToVUZICW36pOncQEeUukhs8vDJK9/OqP7F23g7fOTjIdzcJC9pQP8jsc1j+b+4hXjPtKtaWHhTjl9E8wIDAQAB;
                </txtdata>
                <type>TXT</type>
                <class>IN</class>
            </record>
            <record>
                <Line>37</Line>
                <ttl>14400</ttl>
                <name>www.example.com.</name>
                <flag>0</flag>
				<tag>issue</tag>
				<value>totallyrealca.tld</value>
                <type>CAA</type>
                <class>IN</class>
            </record>
        </zone>
    </data>
    <metadata>
        <version>1</version>
        <reason>Zone Serialized</reason>
        <result>1</result>
        <command>dumpzone</command>
    </metadata>
</result>

Parameters

Parameter Type Description Possible values Example

domain

string

Required

The zone record's domain.

A valid domain name on the server.

example.com

Returns

Return Type Description Possible values Example

record

array of hashes

An array of hashes of zone record data.

The hashes in this array contain the name, Line, class, ttl, and type returns, with additional returns that the DNS zone's type determines.

name

string

The record's name.

The function returns this value in the record hash.

A valid domain name or hostname.

hostname.example.com

Line

integer

The zone record's line number.

The function returns this value in the record hash

A positive integer.

1

class

string

The record's class.

The function returns this value in the record hash.

IN
Very rarely, another valid DNS record class.

IN

ttl

integer

The record's Time To Live (TTL).

The function returns this value in the record hash.

A positive integer that represents the TTL, in seconds.

86400

type

string

The DNS record type.

The function returns this value in the record hash.

A — A records store IPv4 addresses. Use them to map a hostname to an IPv4 address.
A6 — A6 records store IPv6 addresses.
AAAA — AAAA records store IPv6 addresses.
ASFDB — ASFDB records store the location of an AFS cell's database servers.
CAA — CAA records control which certificate authorities can issue SSL certificates for a domain.
We added this DNS record type in cPanel & WHM version 66.
CNAME — CNAME records create an alias to another hostname.
DNAME — DNAME records create an alias for a hostname and its subnames.
DS — DS records specify a record's delegation signer.
HINFO — HINFO records specify a host's CPU and OS types.
LOC — LOC records store a hostname's geographical location.
MX — MX records point a domain name to its MTAs.
NS — NS records store a domain's authoritative nameservers.
PTR — PTR records point to a CNAME.
RP — RP records store a domain's Responsible Person's information.
SOA — SOA records designate the beginning of a zone of authority.
SRV — SRV records store the service location records for newer protocols (for example, Autodiscover).
SSHFP — SSHFP records store a domain's SSH public host key's fingerprint.
We do not currently support this DNS record type.
TXT — TXT records store descriptive text or useful records (for example, SPF or DKIM records).

A

Function information

API Version:

WHM API 1

Available in:

WHM 11+

Methods:

GET, POST

Required Parameters:

domain

Return Formats:

JSON, XML

Description

Examples

Parameters

Returns

Function information

About WHM API 1

Find a function

Related functions