v1

latestOpenAPI 3.1.02026-07-2671111437.2 KB

DNS

Get Record

Retrieves details of a specific DNS record.

get/core/v1/domains/{domainName}/records/{id}

Path parameters

domainNamestring required

DomainName is the zone the record exists in.

idinteger required

ID is the server-assigned unique identifier for this record.

Response

A successful response.

answerstring

Answer is either the IP address for A or AAAA records; the target for ANAME, CNAME, MX, or NS records; the text for TXT records. For SRV records, answer has the following format: "{weight} {port} {target}" e.g. "1 5061 sip.example.org".

domainNamestring

DomainName is the zone that the record belongs to.

fqdnstring

FQDN is the Fully Qualified Domain Name. It is the combination of the host and the domain name. It always ends in a ".". FQDN is ignored in CreateRecord, specify via the Host field instead.

hoststring nullable

Host is the hostname relative to the zone: e.g. for a record for blog.example.org, domain would be "example.org" and host would be "blog". An apex record would be specified by either an empty host "" or "@". A SRV record would be specified by "{service}.{protocol}.{host}": e.g. "_sip._tcp.phone" for _sip._tcp.phone.example.org.

idinteger

Unique record id. Value is ignored on Create, and must match the URI on Update.

priorityinteger

Priority is only required for MX and SRV records, it is ignored for all others.

ttlinteger required

TTL is the time this record can be cached for in seconds. name.com allows a minimum TTL of 300, or 5 minutes.

typestring nullable required

Type is one of the following: A, AAAA, ANAME, CNAME, MX, NS, SRV, or TXT.