Skip to main content
GET
List records
Requires the IAM action dns:ListRecords. See DNS permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

zone_id
string<uuid>
required

DNS Zone ID

Query Parameters

type
string

Exact record type to filter by (e.g. A, MX).

Example:

"A"

name
string

Exact record name, lowercased with an optional trailing dot removed.

Example:

"www.example.com"

crn
string

Exact nested record CRN. Foreign or mismatched CRNs return an empty page; combined with name before pagination.

include_managed
boolean
default:false

Include the platform-stamped rows (SOA, apex NS, and the DNSSEC set) alongside your own. Off by default — they cannot be edited or deleted, and on a signed zone there are more of them than there are of yours.

Example:

false

limit
integer
default:50
Required range: 1 <= x <= 500
Example:

50

marker
string<uuid>

Resume token — the last record id from the previous page.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

List of records

records
object[]
required
meta
object
required