A Record Returns


ReturnTypeDescriptionPossible valuesExample
addressstringThe zone record's IPv4 address.A valid IPv4 address.192.168.0.20


For more information about A records, read RFC 1035 at IANA.


 A6 Record Returns


A6 records are deprecated. We strongly recommend that you use AAAA records to store IPv6 addresses. 


ReturnTypeDescriptionPossible valuesExample
prefixstringThe record's prefix length.A positive integer.48
referstringThe record's address suffix.

A valid IPv6 address suffix.

0::0


 AAAA Record Returns


ReturnTypeDescriptionPossible valuesExample
addressstringThe zone record's IPv6 address.

A valid IPv6 address.

2001:1:42:1::2a


For more information about AAAA records, read RFC 3596 at IANA .


 AFSDB Record Returns


ReturnTypeDescriptionPossible valuesExample
subtypeintegerThe AFS cell type.

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

For example, a value of 1 indicates an AFS version 3.0 Volume Location Server.

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


For more information about ASFDB records, read RFC 1183 at IANA.


CAA Record Returns


We added these returns in cPanel & WHM version 66.


ParameterTypeDescriptionPossible valuesExample
flaginteger

Whether the 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. The CAA Resource Record contains unknown property tags, and the CA issued an SSL certificate.
  • 1 — Critical. The CAA Resource Record contains unknown property tags, and the CA did not issue an SSL certificate.
0
tagstring

The CAA record's property type.

  • issue — A CA issued a certificate for the domain.
  • issuewild — A CA issued a wildcard certificate for the domain.
  • iodef — The user specified a URL to which a CA may report policy violations.

issue
valuestring

The CA's domain or URL.

totallyrealca.tld


 CNAME Record Returns


ReturnTypeDescriptionPossible valuesExample
cnamestringThe canonical name (CNAME) alias.A valid alias.sydneybristow.example.com
flattenBoolean

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

  • 1 — Resolves.
  • 0 — Does not resolve.
1
flatten_tostring

The IP address to which the specified CNAME resolves.

A valid IPv4 or IPv6 address.192.168.0.20


For more information about CNAME records, read RFC 1035 at IANA .


 DNAME Record Returns


ReturnTypeDescriptionPossible valuesExample
dnamestringThe delegation name (DNAME) alias.A valid alias.hostname.dev.example.com


For more information about DNAME records, read RFC 2672 at IANA.


 DS Record Returns


ReturnTypeDescriptionPossible valuesExample
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


For more information about DS records, read RFC 4034 at IANA.


 HINFO Record Returns


ReturnTypeDescriptionPossible valuesExample
cpustringThe host's CPU type.

A valid CPU type.

INTEL-386
osstringThe host's operating system.

A valid operating system.

UNIX


For more information about HINFO records, read RFC 1700 at IANA.


 LOC Record Returns


ReturnTypeDescriptionPossible valuesExample
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, and the m character.

178m


For more information about LOC records, read RFC 1876 at IANA .


 MX Record Returns


ReturnTypeDescriptionPossible valuesExample
preferenceintegerThe record's preference.

An integer that represents the record's priority order.

Lower values have a higher priority order. 


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

A valid CNAME.

mail.example.com


For more information about MX records, read RFC 1035 at IANA.


 NS Record Returns


ReturnTypeDescriptionPossible valuesExample
nsdnamestringThe domain's authoritative nameserver.

A valid nameserver.

ns1.example.com


For more information about NS records, read RFC 1035 at IANA.


 PTR Record Returns


ReturnTypeDescriptionPossible valuesExample
ptrdnamestringA pointer to a canonical name (CNAME).

A valid hostname.

hostname.example.com.


For more information about PTR records, read RFC 1035 at IANA.


 RP Record Returns


ReturnTypeDescriptionPossible valuesExample
mboxstringThe Responsible Person's (RP's) email address.

A valid email address.

user.example.com.
txtdnamestringThe RP's domain name.

A valid hostname.

mx1.host.example.com.


For more information about RP records, read RFC 1183 at IANA.


 SOA Record Returns


ReturnTypeDescriptionPossible valuesExample
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.

user.example.com.


For more information about SOA records, read RFC 1035 at IANA.


 SRV Record Returns


ReturnTypeDescriptionPossible valuesExample
priorityintegerThe target host's preference.

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

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


For more information about SRV records, read RFC 2782 at IANA.


 SSHFP Record Returns


We do not currently support this DNS record type. 


ReturnTypeDescriptionPossible valuesExample
algorithmstringThe public key's algorithm number.
  • 1 — RSA
  • 2 — DSS
1
fptypestringThe public key's fingerprint type.
  • 1 — SHA-1
1


For more information about SSHFP records, read RFC 4255 at IANA.


 TXT Record Returns


ReturnTypeDescriptionPossible valuesExample
txtdatastringThe TXT record's data.

A valid TXT record.

"v=spf1 a -all"
unencodedBooleanWhether the TXT record's data is encoded.
  • 1 — Encoded.
  • 0Not encoded.
1


For more information about TXT records, read RFC 1464 at IANA.