• cPanel XMLAPI - dumpzone
• DESCRIPTION
• VARIABLES
• INPUT
• OUTPUT
• EXAMPLES
• COPYRIGHT

cPanel XMLAPI - dumpzone

DESCRIPTION

This displays the DNS zone for a specific domain.

VARIABLES

INPUT

domain

Domain name to show the DNS zone for.

OUTPUT

dumpzone

DNS zone dump information container.

result

DNS zone output result.

status

Status of the display/dump request. (1 = success, 0 = failure)

statusmsg

Information about the status of the request.

record

Representative of a single record in the DNS zone.

name

Domain name

line

Line number in zone file.

lines

Number of lines (if more than 1).

address

IP address

class

RFC class of record (typically IN for internet).

expire

A 32 bit time value that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative.

minimum

The unsigned 32 bit minimum TTL field that should be exported with any RR from this zone.

mname

The domain name of the name server that was the original or primary source of data for this zone.

nsdname

A domain name which specifies a host which should be authoritative for the specified class and domain.

raw

Raw line output

refresh

A 32 bit time interval before the zone should be refreshed.

retry

A 32 bit time interval that should elapse before a failed refresh should be retried.

rname

A domain name which specifies the mailbox of the person responsible for this zone. [instead of x@domain.com, listed as x.domain.com]

serial

The unsigned 32 bit version number of the original copy of the zone.

ttl

Time to Live

type

Zone Record Type (NS, SOA, A, etc)

txtdata

Text Record Data

EXAMPLES

Calling this URL in WebHost Manager:

/xml-api/dumpzone?domain=domain.com

will produce something similar to:

	<dumpzone>

		<result>

			<status>1</status>

			<statusmsg>Zone Serialized</statusmsg>

			<record>
			<name/>
		      <Line>1</Line>
		      <raw>; cPanel first:11.17.0-BETA_19364 latest:11.23.1-UNKNOWN_24255 Cpanel::ZoneFile::VERSION:1.2 mtime:1212701156</raw>
		      <ttl>86400</ttl>
		      <type>:RAW</type>
		    </record>
		    <record>
		      <name/>
		      <Line>2</Line>
		      <raw>; Zone file for domain.com</raw>
		      <ttl>86400</ttl>
		      <type>:RAW</type>
		    </record>
		    <record>
		      <name/>
		      <Line>3</Line>
		      <ttl>14400</ttl>
		      <type>$TTL</type>
		    </record>
		    <record>
		      <name>domain.com.</name>
		      <Line>4</Line>
		      <Lines>7</Lines>
		      <class>IN</class>
		      <expire>3600000</expire>
		      <minimum>86400</minimum>
		      <mname>ns1.build.cpanel.net</mname>
		      <refresh>86400</refresh>
		      <retry>7200</retry>
		      <rname>webmaster.domain.com</rname>
		      <serial>2008060510</serial>
		      <ttl>86400</ttl>
		      <type>SOA</type>
		    </record>
		    <record>
		      <name>domain.com.</name>
		      <Line>11</Line>
		      <class>IN</class>
		      <nsdname>ns1.domain.com</nsdname>
		      <ttl>86400</ttl>
		      <type>NS</type>
		    </record>
		    <record>
		      <name>domain.com.</name>
		      <Line>12</Line>
		      <class>IN</class>
		      <nsdname>ns2.domain.com</nsdname>
		      <ttl>86400</ttl>
		      <type>NS</type>
		    </record>
		    <record>
		      <name>domain.com.</name>
		      <Line>13</Line>
		      <address>10.215.215.13</address>
		      <class>IN</class>
		      <ttl>14400</ttl>
		      <type>A</type>
		    </record>
		    <record>
		      <name>localhost.domain.com.</name>
		      <Line>14</Line>
		      <address>127.0.0.1</address>
		      <class>IN</class>
		      <ttl>14400</ttl>
		      <type>A</type>
		    </record>
		    <record>
		      <name>domain.com.</name>
		      <Line>15</Line>
		      <class>IN</class>
		      <exchange>domain.com</exchange>
		      <preference>0</preference>
		      <ttl>14400</ttl>
		      <type>MX</type>
		    </record>
		    <record>
		      <name>mail.domain.com.</name>
		      <Line>16</Line>
		      <class>IN</class>
		      <cname>domain.com</cname>
		      <ttl>14400</ttl>
		      <type>CNAME</type>
		    </record>
		    <record>
		      <name>www.domain.com.</name>
		      <Line>17</Line>
		      <class>IN</class>
		      <cname>domain.com</cname>
		      <ttl>14400</ttl>
		      <type>CNAME</type>
		    </record>
		    <record>
		      <name>ftp.domain.com.</name>
		      <Line>18</Line>
		      <class>IN</class>
		      <cname>domain.com</cname>
		      <ttl>14400</ttl>
		      <type>CNAME</type>
		    </record>
		

		</result>

	</dumpzone>

COPYRIGHT

Copyright 2008 cPanel Inc.