Documentation menu

List domain records

GEThttps://api.instacloud.com/orgs/{orgId}/domains/{domainName}/records

Token scope: account · org — read-only tokens allowed.

The DNS records in a bought domain's zone, as the registrar holds them. A record InstaCloud published is managed: read-only while the attached hostname in hostname claims it; with no hostname, a leftover that may be deleted.

Parameters

NameInTypeRequiredDescription
orgIdpathstringyes
domainNamepathstringyes

Responses

200

Default Response

FieldTypeRequiredDescription
itemsobject[]yes
items.idintegeryesthe registrar's id for the record; the handle every write takes
items.type"A" | "AAAA" | "ANAME" | "CNAME" | "MX" | "NS" | "SRV" | "TXT"yes
items.hoststringyesrelative to the domain: "@" is the domain itself, "api" is api.<domain>
items.fqdnstringyes
items.answerstringyes
items.ttlintegeryesseconds
items.priorityintegernoMX and SRV only
items.managedbooleanyespublished by InstaCloud: read-only while `hostname` names the attached hostname it serves; without one, a leftover no hostname claims, which may be deleted
items.hostnamestringnothe attached hostname a managed record serves

404

Default Response

FieldTypeRequiredDescription
errorstringyes

502

Default Response

FieldTypeRequiredDescription
errorstringyes

503

Default Response

FieldTypeRequiredDescription
errorstringyes

View as Markdown