API ReferenceDomainDomain LifecycleDomains & DNSv1 (Legacy)Manage DNSList DNS records for a domain GET
List DNS records for a domain
View as MarkdownReturns DNS records for the domain.
Full description
Returns DNS records for the domain. Optionally filter by record type and name. Returns an array of DNSRecord objects.
Authorization
bearerAuth AuthorizationBearer <token>
Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .
In: header
Path Parameters
domain*string
Domain whose DNS Records are to be retrieved
type*string
DNS Record Type for which DNS Records are to be retrieved
Value in
- "A"
- "AAAA"
- "CAA"
- "CNAME"
- "MX"
- "NS"
- "SOA"
- "SRV"
- "TXT"
name*string
DNS Record Name for which DNS Records are to be retrieved
Query Parameters
offset?integer
Number of results to skip for pagination
limit?integer
Maximum number of items to return
Header Parameters
X-Shopper-Id?string
Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.
Response Body
curl -X GET "https://example.com/v1/domains/string/records/A/string"[ { "data": "string", "name": "string", "port": 1, "priority": 0, "protocol": "string", "service": "string", "ttl": 0, "type": "A", "weight": 0 }]Agent & Automation Notes
Scopes
domains.domain:read, domains.domain:create, domains.domain:delete, domains.domain:update, domains.contact:update, domains.dns:update, domains.transfer:executeRate limit60 req/min per credential
On failureGET operations are safe to retry. PUT/PATCH DNS are idempotent by shape. POST purchase is NOT idempotent — verify state before retrying.
Related
Last updated on
How is this guide?