DNS Record Type

A Record Parameters

Parameter
Type
Description
Possible values
Example
addressstringThe zone record's IPv4 address.A valid IPv4 address.192.168.0.20

 A6 Record Parameters

Parameter
Type
Description
Possible values
Example
prefixstringThe record's prefix length.A positive integer.48
referstringThe record's address suffix.

A valid IPv6 address suffix.

Note

You must uuencode the colons (:) in IPv6 addresses in your function calls.
0::0

 AAAA Record Parameters

Parameter
Type
Description
Possible values
Example
addressstringThe zone record's IPv6 address.

A valid IPv6 address.

Note

You must uuencode the colons (:) in IPv6 addresses in your function calls.
2001:1:42:1::2a

 AFSDB Record Parameters

Parameter
Type
Description
Possible values
Example
subtypeintegerThe AFS cell type.

A 16-bit integer that represents the type of AFS cell.

For example, specify 1 to signify an AFS version 3.0 Volume Location Server.

1
hostnamestringThe database servers' hostname.A valid hostname.afs.example.com

CAA Record Parameters

Parameter
Type
Description
Possible values
Example
flaginteger

Required

Whether the Certificate Authority (CA) will issue an SSL certificate if the CAA resource record contains unknown property tags.

For more information about CAA record flags and property tags, read the RFC 6844 documentation.

  • 0 — Non-critical. If the CAA Resource Record contains unknown property tags, the CA will issue an SSL certificate.
  • 1 — Critical. If the CAA Resource Record contains unknown property tags, the CA will not issue an SSL certificate.
0
tagstring

Required

The CAA record's property type.

  • issue — Authorize a CA to issue a certificate for the domain.
  • issuewild — Authorize a CA to issue a wildcard certificate for the domain.
  • iodef — Specify a URL to which a CA may report policy violations.

issue
valuestring

Required

The CA's domain or URL.

Note:

If you use iodef as the tag parameter's value, enter a URL that a CA can use to report issues as this parameter's value i

totallyrealca.tld

 CNAME Record Parameters

Parameter
Type
Description
Possible values
Example
cnamestringThe canonical name (CNAME) alias.A valid alias.sydneybristow.example.com
flattenBoolean

Whether to resolve the specified CNAME value with the record's IP address.

If you do not also set the flatten_to parameter, the system will attempt to resolve the CNAME automatically.

Note:

Only use this parameter when you alter the zone's root record.


  • 1 — Flattened.
  • 0 — Not flattened (the function will fail).
1
flatten_tostring

The IP address that the specified CNAME will resolve to.

You must use the flatten parameter with this parameter.

A valid IPv4 or IPv6 address.192.168.0.20

 DNAME Record Parameters

Parameter
Type
Description
Possible values
Example
dnamestringThe delegation name (DNAME) alias.A valid alias.hostname.dev.example.com

 DS Record Parameters

Parameter
Type
Description
Possible values
Example
keynameintegerThe record's KeyTag value.

An unsigned decimal integer.

2642
algorithmintegerThe record's algorithm number.
  • 1 — RSAMD5
  • 2 — Diffie-Hellman
  • 3 — DSA/SHA-1
  • 4 — Elliptic Curve
  • 5 — RSA/SHA-1
  • 252 — Indirect
  • 253 — Private DNS
  • 254 — Private OID
5
digitypeintegerThe record's digest type.
  • 1 — SHA-1
1

 HINFO Record Parameters

Parameter
Type
Description
Possible values
Example
cpustringThe host's CPU type.

A valid CPU type.

INTEL-386
osstringThe host's operating system.

A valid operating system.

UNIX

 LOC Record Parameters

Parameter
Type
Description
Possible values
Example
versionintegerThe record's version number.

You must set this value to 0.

0
sizeintegerThe diameter of a sphere that encloses the entire location.

A positive integer that represents a diameter, in meters.

10
horiz_preintegerThe location's horizontal precision.A positive integer that represents a distance, in meters.10
vert_preintegerThe location's vertical precision.A positive integer that represents a distance, in meters.10
latitudestringThe location's latitude.A valid latitude.41 51 54.305 N
longitudestringThe location's longitude.A valid longitude.87 36 47.95 W
altitudestringThe location's altitude.

The location's altitude above sea level, in meters.

Note:

Make certain that you append m to the altitude value. 

178m

 MX Record Parameters

Parameter
Type
Description
Possible values
Example
preferenceintegerThe record's preference.

An integer that represents the record's priority order.

Note:

Lower values have a higher priority order. 

10
exchangestringThe server's location's canonical name (CNAME).

A valid CNAME.

mail.example.com

 NS Record Parameters

Parameter
Type
Description
Possible values
Example
nsdnamestringThe domain's authoritative nameserver.

A valid nameserver.

ns1.example.com

 PTR Record Parameters

Parameter
Type
Description
Possible values
Example
ptrdnamestringA pointer to a canonical name (CNAME).

A valid hostname.

Note:

Do not omit any necessary trailing periods. 

hostname.example.com.

 RP Record Parameters

Parameter
Type
Description
Possible values
Example
mboxstringThe Responsible Person's (RP's) email address.

A valid email address.

Note:

  • Replace the @ symbol with a period (.).
  • Do not omit any necessary trailing periods.
user.example.com.
txtdnamestringThe RP's domain name.

A valid hostname.

Note:

Do not omit any necessary trailing periods. 

mx1.host.example.com.

 SOA Record Parameters

Parameter
Type
Description
Possible values
Example
serialintegerThe zone file's revision number.

A valid revision number.

2013122501
mnamestringThe domain's authoritative nameserver.

A valid nameserver.

ns1.example.com
retryintegerThe amount of time to wait before the secondary server retries a failed zone transfer.A positive integer that represents an amount of time, in seconds.1440
refreshstringThe amount of time to wait before the secondary DNS server queries the primary DNS server's SOA records for changes.A positive integer that represents an amount of time, in seconds.1440
LinesstringThe number of lines in the SOA section.A positive integer that represents a number of lines.4
expirestringThe amount of time to wait before the secondary server attempts to complete a zone transfer.A positive integer that represents an amount of time, in seconds.3600000
rnamestringThe Responsible Person's (RP's) email address.

A valid email address.

Note:

  • Replace the @ symbol with a period (.).
  • Do not omit any necessary trailing periods.
user.example.com.

 SRV Record Parameters

Parameter
Type
Description
Possible values
Example
priorityintegerThe target host's preference.

An integer that represents the target host's priority order.

Note:

Lower numbers have a higher priority order. 

0
weightintegerA relative weight. The system uses this value to rank entries with the same priority value.

An integer that represents the target host's weight against other hosts with the same priority value.

2
portintegerThe target host's port.A valid port number.389
targetstringThe service's target host.A valid hostname.service.example.com

 SSHFP Record Parameters

Parameter
Type
Description
Possible values
Example
algorithmstringThe public key's algorithm number.
  • 1 — RSA
  • 2 — DSS
1
fptypestringThe public key's fingerprint type.
  • 1 — SHA-1

 

1

 TXT Record Parameters

Parameter
Type
Description
Possible values
Example
txtdatastringThe TXT record's data.

A valid TXT record.

Note:

  • This value must include beginning and ending quotes (""). Do not URI-encode the quotes.
"v=spf1 a -all"