Zones

Zone

A Zone object represents a forward or authoritative DNS Zone.

A Resource Record Set (below as “RRset”) are all records for a given name and type.

Comments are per-RRset.

json Zone : object

Zone

Optional members:
id : string

Opaque zone id (string), assigned by the server, should not be interpreted by the application. Guaranteed to be safe for embedding in URLs.

name : string

Name of the zone (e.g. “example.com.”) MUST have a trailing dot

type : string

Set to “Zone”

url : string

API endpoint for this zone

kind : "Native" | "Forwarded"

Zone kind, one of “Native”, “Forwarded”.

records : array of RecursorRecord

Records in this zone

servers : array of string

For zones of type “Forwarded”, addresses to send the queries to

recursion_desired

For zones of type “Forwarded”, Whether or not the RD bit should be set in the query

notify_allowed

For zones of type “Forwarded”, Whether or not to permit incoming NOTIFY to wipe cache for the domain

To properly process new zones, the following conditions must be true:

  • forward-zones, forward-zones-recurse and/or auth-zones settings must be set (possibly to the empty string) in a configuration file. These settings must not be overridden on the command line. Setting these options on the command line will override what has been set in the dynamically generated configuration files.

  • For configuration changes to work include-dir and api-config-dir should have the same value for old-style settings. When using YAML settings recursor.include_dir and webservice.api_dir must have a different value.

json Record : object

Record

This represents a DNS Record in a zone

Optional members:
name : string

The owner name of the record

type : string

Type of this record (e.g. “A”, “PTR”, “MX”)

ttl : integer

DNS TTL of the record, in seconds

content : string

The content of this record