Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titleColor#FFFFFF
titleBGColor#E44313
titleTable of Contents

Table of Contents
outlinetrue
stylenone

Function

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

Note

You can find more information about list queries here

Description

SP Tabs group
dispositionhorizontal
SP Tab pane
anchor2286824
nameJSON

Route: POST/zone/_search

Query Parameter

The data of the following keywords can be queried with the query parameter ?keys[]=:

  • action
  • changed
  • comment
  • created
  • domainsafe
  • mainip
  • name
  • primary
  • secondary1
  • secondary2
  • secondary3
  • secondary4
  • secondary5
  • secondary6
  • secondary7
  • updated
  • virtualNameServer
  • dnssec
Code Block
languagejs
titleRequest
linenumberstrue
collapsetrue
{
   "filters": [
      {
         "key": "name",
         "value": "example*",
         "operator": "LIKE",
         "link": "AND",
         "filters": []
      }
   ],
   "view": {
      "limit": 10,
      "offset": 0,
      "children": true,
      "from": "2019-01-13T12:31:33.6306444Z",
      "to": "2019-05-13T12:31:33.6306444Z"
   }
}

Code Block
titleResponse
linenumberstrue
collapsetrue
{
   "stid": "20190701-app2-dev-15785",
   "status": {
      "code": "S0205",
      "text": "Zone information was inquired successfully",
      "type": "SUCCESS"
   },
   "object": {
      "type": "Zone",
      "summary": 3
   },
   "data": [
      {
         "created": "2014-10-24T09:42:57.000+0200",
         "updated": "2017-11-17T17:35:40.000+0100",
         "origin": "example.com",
         "owner": {
            "context": 4,
            "user": "customer"
         },
         "updater": {
            "context": 1,
            "user": "customer"
         },
         "virtualNameServer": "ns1.nameserver.com"
      },
      {
         "created": "2019-05-13T11:26:36.000+0200",
         "updated": "2019-05-13T13:51:20.000+0200",
         "origin": "example2.org",
         "dnssec": false,
         "owner": {
            "context": 4,
            "user": "customer"
         },
         "updater": {
            "context": 4,
            "user": "customer"
         },
         "virtualNameServer": "ns2.nameserver.com"
      },
      {
         "created": "2019-05-13T11:26:36.000+0200",
         "updated": "2019-05-17T13:33:02.000+0200",
         "origin": "example3.com",
         "dnssec": false,
         "owner": {
            "context": 4,
            "user": "customer"
         },
         "updater": {
            "context": 4,
            "user": "customer"
         },
         "virtualNameServer": "ns3.nameserver.com"
      }
   ]
}
SP Tab pane
anchor87031
nameXML

Task code: 0205
Uses Zone object

Keywords

The following keywords are returned by default:

  • domainsafe
  • name
  • system_ns

The data of the following keywords can be queried with the <key> keyword:

  • primary
  • secondary1
  • secondary2
  • secondary3
  • secondary4
  • secondary5
  • secondary6
  • secondary7
  • main
  • dnssec
  • updated_by
  • comment
Code Block
languagexml
titleRequest
linenumberstrue
collapsetrue
<request>
	<auth>
		<user>customer</user>
		<password>password</password>
		<context></context>
	</auth>
	<task>
		<code>0205</code>
		<view>
			<offset>0</offset>
			<limit>4</limit>
			<children>1</children>
		</view>
		<key>created</key>
		<key>primary</key>
		<key>system_ns</key>
		<key>secondary2</key>
		<key>mainip</key>
		<key>changed</key>
		<where>
			<key>name</key>
			<operator>like</operator>
			<value>*</value>
		</where>
		<order>
			<key>changed</key>
			<mode>DESC</mode>
		</order>
		<order>
			<key>changed</key>
			<mode>DESC</mode>
		</order>
	</task>
</request>
Code Block
languagexml
titleResponse
linenumberstrue
collapsetrue
<response>
	<result>
		<data>
			<summary>1</summary>
			<zone>
				<changed>2014-12-02 09:49:20</changed>
				<created>2013-11-12 13:37:04</created>
				<name>example.com</name>
				<primary>ns1.example.com</primary>
				<domainsafe>0</domainsafe>
				<owner>
					<user>customer</user>
					<context></context>
				</owner>
				<updated_by>
					<user>customer</user>
					<context>1018945</context>
				</updated_by>
				<system_ns>ns1.example.com</system_ns>
			</zone>
		</data>
		<status>
			<code>S0205</code>
			<text>Zone information was inquired successfully.</text>
			<type>success</type>
		</status>
	</result>
	<stid>20160218-app2-dev-2603</stid>
</response>