- Home
- API reference
- API documentation (JSON/XML)
- Objects
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 | Additional name server check is performed. | |
| allowTransfer | allow_transfer | 0 - 1 | boolean | Allow AXFR
Default = false 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. 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 | 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 | 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 | Owner of the zone object. |
| resourceRecords | rr | 0 - n | object | ResourceRecord | Resource record |
| soa | soa | 1 | object | SOA | 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 | User who last updated the zone. |
| wwwInclude | www_include | 0 - 1 | boolean | Create a www A-record automatically?
Default = true 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.
Default values: 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 | 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.