Skip to content
digizeDocs

List a domain's DNS records

GET
/api/v1/domains/{hostname}/dns
curl --request GET \
  --url https://digize.com/api/v1/domains/example/dns \
  --header 'x-api-key: <x-api-key>'

A full-setup domain’s DNS records, which Cloudflare answers for. Empty when the platform can’t reach its account.

Needs the sites:read permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
hostname
required
string
>= 3 characters <= 253 characters

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
Array<object>
object
id
required
string
type
required
string
name
required
string
content
required
string
priority
required
number | null
ttl
required
number
proxied
required
boolean
comment
required
string | null
modifiedAt
required
string format: date-time
readOnly
required
boolean

Example generated

[
  {
    "id": "example",
    "type": "example",
    "name": "example",
    "content": "example",
    "priority": 1,
    "ttl": 1,
    "proxied": true,
    "comment": "example",
    "modifiedAt": "2026-04-15T12:00:00Z",
    "readOnly": true
  }
]

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}