Table of contents

Function

The ZoneInfo task displays the zone data of multiple zones on the name servers managed by the system.

You can find more information about list queries here.

Description

Route: GET /zone/{name}/{nameserver} or : GET /zone/{name}

No body has to be sent with the request.

Request

GET/zone/{example.com}/{ns1.example.com}
or GET/zone/{example.com}

Response

{
  "status" : {
    "code" : "S0205",
    "text" : "Zone information was inquired successfully.",
    "type" : "SUCCESS"
  },
  "object" : {
    "type" : "Zone",
    "value" : "jsontest.test"
  },
  "data" : [ {
    "created" : "2017-11-07T12:55:38.000+0100",
    "updated" : "2022-04-19T11:28:20.000+0200",
    "origin" : "jsontest.test",
    "soa" : {
      "refresh" : 39940,
      "retry" : 7200,
      "expire" : 604800,
      "ttl" : 86400,
      "email" : "customer@example.com"
    },
    "owner" : {
      "context" : 4,
      "user" : "customer"
    },
    "updater" : {
      "context" : 4,
      "user" : "customer"
    },
    "purgeDate" : "2022-04-19T00:00:00.000+0200",
    "purgeType" : "DISABLED",
    "nameServers" : [ {
      "name" : "ns1.example.com",
      "ttl" : 8600
    }, {
      "name" : "ns2.example.com",
      "ttl" : 8600
    } ],
    "main" : {
      "address" : "198.51.100.0",
      "ttl" : 8600
    },
    "wwwInclude" : false,
    "virtualNameServer" : "ns1.example.com",
    "action" : "COMPLETE",
    "grants" : [ "198.51.100.0" ],
    "resourceRecords" : [ {
      "name" : "",
      "ttl" : 200,
      "type" : "MX",
      "value" : "mx.example.com",
      "pref" : 10
    } ],
    "roid" : 3172243
  } ]
}

Task code: 0205
Uses Zone object

Request

<request>
	<auth>
		<user>customer</user>
		<password>PASSWORD</password>
		<context>4</context>
	</auth>
	<task>
		<code>0205</code>
		<zone>
			<name>customer.test</name>
			<system_ns>testsys.example.com</system_ns>
		</zone>

	</task>
</request>

Response

<response>
    <result>
       <data>
            <zone>
                <changed>2010-06-24 12:17:25</changed>
                <created>2010-04-19 12:40:33</created>
                <name>customer.test</name>
                <main>
                    <value>198.51.100.0</value>
                    <ttl>8600</ttl>
                </main>
                <ns_action>complete</ns_action>
                <www_include>0</www_include>
                <allow_transfer_from>198.51.100.0</allow_transfer_from>
                <soa>
                    <refresh>1000</refresh>
                    <retry>2000</retry>
                    <expire>3000</expire>
                    <ttl>4000</ttl>
                    <email>customer@example.com</email>
                    <default>4000</default>
                </soa>
                <nserver>
                    <name>testsys.example.com</name>
                    <ttl>8600</ttl>
                </nserver>
                <nserver>
                    <name>testsys.example.com</name>
                    <ttl>8600</ttl>
                </nserver>
                <rr>
                    <name />
                    <ttl>200</ttl>
                    <type>MX</type>
                    <pref>10</pref>
                    <value>mx.example.com.</value>
                </rr>
                <system_ns>testsys.example.com</system_ns>
                <domainsafe>0</domainsafe>
                <owner>
                    <user>customer</user>
                    <context>4</context>
                </owner>
                <updated_by>
                    <user>customer</user>
                    <context>4</context>
                </updated_by>
                <purge_date>2023-05-25 00:00:00</purge_date>
                <purge_type>AUTO</purge_type>
            </zone>
        </data>
        <status><code>S0205</code>
            <type>success</type><object>
                <type>zone</type>
                <value>customer.test</value>
            </object>
        </status>
    </result>
</response>