Skip to content
digizeDocs

Add a DNS record

POST
/api/v1/domains/{hostname}/dns
curl --request POST \
  --url https://digize.com/api/v1/domains/example/dns \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "record": { "type": "A", "name": "example", "content": "example", "ttl": 1, "proxied": true, "priority": 1, "comment": "example" } }'

Adds a DNS record to a full-setup domain: A, AAAA, CNAME, MX, TXT, CAA or NS, named within the domain (@ for the domain itself).

Needs the sites:write permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example 

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
record
required
object
type
required
string
Allowed values: A AAAA CNAME MX TXT CAA NS
name
required
string
<= 253 characters
content
required
string
>= 1 characters <= 4096 characters
ttl
required
integer
>= -9007199254740991 <= 9007199254740991
proxied
boolean
priority
Any of:
integer
<= 65535
comment
Any of:
string
<= 100 characters

Responses

Section titled “Responses”

201

Section titled “201”

Done

Media typeapplication/json
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"
  }
}

409

Section titled “409”

A request with the same Idempotency-Key is still running (conflict).

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"
  }
}

422

Section titled “422”

The Idempotency-Key was used with a different request.

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"
  }
}