DNS—Zone Record Management API Data

This section provides details on the API’s data members. The API supports the following record types:

The API also supports the following record types for customers who have enabled DNSSEC support:

A

Address record. Represents a 32-bit IPv4 address.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
target String An IPv4 address, for example, 1.2.3.4.

AAAA

IPv6 address record. Represents a 128-bit IPv6 address.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
target String An IPv4 address, for example, 2001:0db8::ff00:0042:8329.

AFSDB

AFS database record. Represents the location of database servers of an AFS cell. This record is commonly used by AFS clients to contact AFS cells outside their local domain. A subtype of this record is used by the obsolete DCE/DFS file system.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
target String A domain name of a host that has a server for the cell named by the owner name of the resource record.
subtype Number An integer between 0 and 65535, indicating the type of service provided by the host.

CNAME

Canonical name record. Represents an alias of one name to another: the DNS lookup will continue by retrying the lookup with the new name.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
target String A domain name that specifies the canonical or primary name for the owner. The owner name is an alias.

DNSKEY

DNS Key record, the key record used in DNSSEC. Uses the same format as the KEY record. It requires DNSSEC.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
flags Number flags.
protocol Number Must have the value 3. The DNSKEY resource record must be treated as invalid during signature verification if it contains a value other than 3.
algorithm Number The public key’s cryptographic algorithm and determine the format of the public key field.
key String Base 64 encoded value representing the public key, the format of which depends on the algorithm being used.

DS

Delegation signer record. The record used to identify the DNSSEC signing key of a delegated zone. It requires DNSSEC.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
keytag Number The key tag of the DNSKEY resource record referred to by the DS record, in network byte order.
algorithm Number The algorithm number of the DNSKEY resource record referred to by the DS record.
digest_type Number Identifies the algorithm used to construct the digest.
digest String The base 16 encoded DS record refers to a DNSKEY RR by including a digest of that DNSKEY RR. The digest is calculated by concatenating the canonical form of the fully qualified owner name of the DNSKEY RR with the DNSKEY RDATA, and then applying the digest algorithm.

HINFO

Host Information record. Describes the CPU and OS of a host.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
hardware String Type of hardware the host uses. A machine name or CPU type may be up to 40 characters taken from the set of uppercase letters, digits, and the two punctuation characters hyphen and slash. It must start with a letter, and end with a letter.
software String Type of software the host uses. A system name may be up to 40 characters taken from the set of uppercase letters, digits, and the two punctuation characters hyphen and slash. It must start with a letter, and end with a letter or digit.

LOC

Location record. Specifies a geographical location associated with a domain name.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
target String A geographical location associated with a domain name.

MX

Mail exchange record. Maps a domain name to a list of message transfer agents for that domain.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
target String A domain name that specifies a host willing to act as a mail exchange for the owner name.
priority String The preference value given to the MX record among MX records. When a mailer needs to send mail to a certain DNS domain, it first contacts a DNS server for that domain and retrieves all the MX records. It then contacts the mailer with the lowest preference value.

NAPTR

Naming Authority Pointer. Allows regular expression based rewriting of domain names which can then be used as URIs, further domain names to lookups, etc.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
order Number A 16-bit unsigned integer specifying the order in which the NAPTR records MUST be processed to ensure the correct ordering ofrules. Low numbers are processed before high numbers, and once a NAPTR is found whose rule “matches” the target, the client MUST NOT consider any NAPTRs with a higher value for order (except as noted below for the Flags field).
preference Number A 16-bit unsigned integer that specifies the order in which NAPTR records with equal order values should be processed, low numbers being processed before high numbers.
flags String A <character-string> containing flags to control aspects of the rewriting and interpretation of the fields in the record. Flags are single characters from the set [A-Z0-9]. The case of the alphabetic characters is not significant.
service String Specifies the services available down this rewrite path.
regexp String A String containing a substitution expression that is applied to the original string held by the client in order to construct the next domain name to lookup.
replacement String The next NAME to query for NAPTR, SRV, or address records depending on the value of the flags field. This MUST be a fully qualified domain-name.

NS

Name server record. Delegates a DNS zone to use the given authoritative name servers.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
target String A domain name that specifies an authoritative host for the specified class and domain.

NSEC3

NSEC record version 3. An extension to DNSSEC that allows proof of nonexistence for a name without permitting zonewalking. It requires DNSSEC.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
algorithm Number The cryptographic hash algorithm used to construct the hash-value.
flags Number The 8 one-bit flags that can be used to indicate different processing. All undefined flags must be zero.
iterations Number The number of additional times the hash function has been performed.
salt String The base 16 encoded salt value, which is appended to the original owner name before hashing in order to defend against pre-calculated dictionary attacks.
next_hashed_owner_name String Base 32 encoded. The next hashed owner name in hash order. This value is in binary format. Given the ordered set of all hashed owner names, the Next Hashed Owner Name field contains the hash of an owner name that immediately follows the owner name of the given NSEC3 RR.
type_bitmaps String The resource record set types that exist at the original owner name of the NSEC3 RR.

NSEC3PARAM

NSEC3 members, for for use with NSEC3. It requires DNSSEC.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
algorithm Number The cryptographic hash algorithm used to construct the hash-value.
flags Number The 8 one-bit flags that can be used to indicate different processing. All undefined flags must be zero.
iterations Number The number of additional times the hash function has been performed.
salt String The base 16 encoded salt value, which is appended to the original owner name before hashing in order to defend against pre-calculated dictionary attacks.

PTR

Pointer to a canonical name. Unlike a CNAME, DNS processing does NOT proceed, just the name is returned. The most common use is for implementing reverse DNS lookups.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
target String A domain name that points to some location in the domain name space.

RP

Responsible person. Information about people responsible for the domain. Usually an email address with the @ replaced by a .

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
mailbox String A domain name that specifies the mailbox for the responsible person.
txt String A domain name for which TXT resource records exist.

RRSIG

DNSSEC signature. Signature for a DNSSEC-secured record set. Uses the same format as the SIG record. It requires DNSSEC.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
type_covered String The resource record set type covered by this signature.
algorithm Number The Algorithm Number field identifies the cryptographic algorithm used to create the signature.
original_ttl Number The TTL of the covered record set as it appears in the authoritative zone.
expiration String The end point of this signature’s validity. The signature cannot be used for authentication past this point.
inception String The start point of this signature’s validity. The signature cannot be used for authentication prior to this point.
keytag Number The Key Tag field contains the key tag value of the DNSKEY RR that validates this signature, in network byte order.
signer String The owner of the DSNKEY resource record who validates this signature.
signature String The base 64 encoded cryptographic signature that covers the RRSIG RDATA and covered record set. Format depends on the TSIG algorithm in use.
labels Number The Labels field specifies the number of labels in the original RRSIG RR owner name. The significance of this field is that a validator uses it to determine whether the answer was synthesized from a wildcard. If so, it can be used to determine what owner name was used in generating the signature.

SOA

Start of a zone of authority record. Specifies authoritative information about a DNS zone, including the primary name server, the email of the domain administrator, the domain serial number, and several timers relating to refreshing the zone.

Member Type Description
ttl Number A signed integer between 0 and 214748364 that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for a transaction in progress, and should not be cached. For example, SOA records are always distributed with a zero TTL to prohibit caching. Zero vlaues can also be used for extremely volatile data.
originserver String The domain name of the name server that was the original or primary source of data for this zone.
contact String A domain name that specifies the mailbox of this person responsible for this zone.
serial Number The unsigned version number between 0 and 214748364 of the original copy of the zone.
refresh Number A time interval between 0 and 214748364 before the zone should be refreshed.
retry Number A time interval between 0 and 214748364 that should elapse before a failed refresh should be retried.
expire Number A time value between 0 and 214748364 that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative.
minimum Number The unsigned minimum TTL between 0 and 214748364 that should be exported with any resource record from this zone.

SPF

Sender Policy Framework. Specified as part of the SPF protocol as an alternative to of storing SPF data in TXT records. Uses the same format as the earlier TXT record.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
target String Indicates which hosts are, and are not, authorized to use a domain name for the “HELO” and “MAIL FROM” identities.

SRV

Service locator. Generalized service location record, used for newer protocols instead of creating protocol-specific records such as MX.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
target String The domain name of the target host.
priority Number A 16-bit integer that specifies the preference given to this resource record among others at the same owner. Lower values are preferred.
weight Number A server selection mechanism, specifying a relative weight for entries with the same priority. Larger weights should be given a proportionately higher probability of being selected. The range of this number is 0–65535, a 16-bit unsigned integer in network byte order. Domain administrators should use Weight 0 when there isn’t any server selection to do, to make the RR easier to read for humans. In the presence of records containing weights greater than 0, records with weight 0 should have a very small chance of being selected.
port Number he port on this target of this service. The range of this number is 0–65535, a 16-bit unsigned integer in network byte order.

SSHFP

SSH Public Key Fingerprint. Resource record for publishing SSH public host key fingerprints in the DNS System, in order to aid in verifying the authenticity of the host.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
algorithm Number Describes the algorithm of the public key. The following values are assigned: 0 = reserved; 1 = RSA; 2 = DSS, 3 = ECDSA
fingerprint_type Number Describes the message-digest algorithm used to calculate the fingerprint of the public key. The following values are assigned: 0 = reserved, 1 = SHA-1, 2 = SHA-256
fingerprint String The base 16 encoded fingerprint as calculated over the public key blob. The message-digest algorithm is presumed to produce an opaque octet string output, which is placed as-is in the RDATA fingerprint field.

TXT

Text record. Originally for arbitrary human-readable text in a DNS record. Since the early 1990s, however, this record more often carries machine-readable data.

Member Type Description
name String The name of the record. The name is an owner name, that is, the name of the node to which this resource record pertains.
ttl Number The TTL is a 32-bit signed integer that specifies the time interval that the resource record may be cached before the source of the information should be consulted again. Zero values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached. Zero values can also be used for extremely volatile data.
active Boolean Setting the state to inactive omits the record from DNS query results, and might be useful, for example, during maintenance.
target String One or more character strings. TXT RRs are used to hold descriptive text. The semantics of the text depends on the domain where it is found.

Last modified: 12/12/2016