---
title: "Zone object"
url: "https://help.internetx.com/en/api/core-zone-object/"
lang: "en"
section: "API reference — API reference (XML/JSON)"
breadcrumb: "API documentation (JSON/XML) > Objects"
updated: "2023-09-25"
---

# Zone object

## Description

The _Zone_ object defines the DNS information stored on name servers for a domain.

## Structure

| Keyword JSON | Keyword XML | Occurs | Type | Format | Description |
| --- | --- | --- | --- | --- | --- |
| action | ns\_action | 0 - 1 | enum | [NameServerActionConstants](/en/api/core-name-server-action-constants/) | Additional name server check is performed. |
| allowTransfer | allow\_transfer | 0 - 1 | boolean |  | Allow AXFR<br>• false = no<br>• true = yes<br>Default = false<br>For XML, 0 (false) and 1 (true) can also be used. |
| comment | comment | 0 - 1 | string |  | A custom field. Can only be updated via PUT /zone/{name}/{nameserver}/\_comment. Requires appropriate ACLs. |
| created | created | 0 - 1 | string | date-time | Date the zone was created on. |
| updated | updated | 0 -1 | string | date-time | The date of the last update. |
| dnssec | dnssec | 0 - 1 | boolean |  | Enables DNSSEC for the zone. |
| domainsafe | domainsafe | 0 - 1 | boolean |  | Denotes of the zone is present in the DomainSafe service. |
| freeText | free | 0 - n | string |  | Freely definable resource records to be entered in BIND Syntax.<br>Use this option only if you are familiar with the Domain Name System. Otherwise, your domain may be unreachable. |
| grants | allow\_transfer\_from | 0 - 1 | string | ip | A list of IP addresses from which a zone transfer (AXFR) by be started from for this zone. |
| idn | idn | 0 - 1 | string |  | Punycode version of the origin. |
| main | main | 0 - 1 | object | [MainIp](/en/api/core-main-ip-object/) | Main IP address of the zone. Required for ns\_action "primary" and "complete". |
| nameServerGroup | ns\_group | 0 -1 | string |  | Name of the name server group. |
| nameServers | nserver | 1 - 7\*) | object | [NameServer](/en/api/core-name-server-object/) | List of hostnames to be used as name severs. |
| origin | name | 1 | string | domain | Zone name |
|  | nscheck | 0 - 1 | enum | DNSCheckConstants | Additional name server checks are performed |
| owner | owner | 0 - 1 | object | [BasicUser](/en/api/core-basic-user-object/) | Owner of the zone object. |
| resourceRecords | rr | 0 - n | object | [ResourceRecord](/en/api/core-resource-record-object/) | Resource record |
| soa | soa | 1 | object | [SOA](/en/api/core-soa-object/) | Information on the management of the zone. |
| source | source | 1 | string | hostname | Name server from which a zone is copied via AXFR (with zone\_import). |
| virtualNameServer | system\_ns | 0 - 1 | string | hostname | The first name server managed by the system. |
| updater | updater | 0 - 1 | object | [BasicUser](/en/api/core-basic-user-object/) | User who last updated the zone. |
| wwwInclude | www\_include | 0 - 1 | boolean |  | Create a www A-record automatically?<br>• false = no<br>• true = yes<br>Default = true<br>For XML, 0 (false) and 1 (true) can also be used. |
|  | force\_unused | 0 - 1 | boolean |  | When deleting zones, keep zones that are still in use.<br>• false = no<br>• true  = yes<br>Default values: Without default-block: Default value = true With default-block: Default value = false<br>For XML, 0 (false) and 1 (true) can also be used. |
| purgeDate | purge\_date | 0 - 1 | string | date | Date on which the zone is purged (removed) from the system. |
| purgeType | purge\_type | 0 - 1 | enum | [PurgeType](/en/api/core-purge-type-enum/) | Setting for automatic zone deletion |
| logId |  | 0-1 | number | long | The id of the related log-entry. |
| roid |  | 0-1 | Integer | int32 | The resource object identifier of the zone. |

\*) Depends on the respective registry.