Help Center
Login Sign up
  1. Home
  2. API reference
  3. API documentation (JSON/XML)
  4. Tasks
  5. Zone tasks

Zone list

API reference (XML/JSON) · Updated 2025-03-10

Function

The ZoneList 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: POST/zone/_search?keys=<key>

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
{
   "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"
   }
}
{
   "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"
      }
   ]
}