Skip to content

dns_record

Manage DNS records

Create

Path
POST /v7.0/dns_records
Description
Create a DNS record
Authentication required
yes
Scope
dns_record#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
dns_record
ParameterTypeRequiredDetails
dns_zone
DnsZone
 Resource yes
user
User
 Resource no
name
Name
 String no

Domain name, @ as alias to origin, * for wildcards

Default: null
type
Type
 String yes

node, storage or mailer

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • A
  • AAAA
  • CAA
  • CNAME
  • DS
  • MX
  • NS
  • PTR
  • SRV
  • SSHFP
  • TLSA
  • TXT

Validation error message: %{value} cannot be used

Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
content
Content
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
ttl
TTL
 Integer no

Optional TTL in seconds, defaults to zone TTL

Default: null
priority
Priority
 Integer no

Optional priority, used for MX and SRV records

Default: null
comment
Comment
 Text no

Optional comment

Default: null

Validation rules
RuleDetails
Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255
enabled
Enabled
 Boolean no

Enable or disable this DNS record

Default: true
dynamic_update_enabled
Enable dynamic update
 Boolean no

Only for A and AAAA records

Default: false

Output parameters

Layout
object
Namespace
dns_record
ParameterTypeDescription
id
ID
 Integer
dns_zone
DnsZone
 Resource
user
User
 Resource
name
Name
 String Domain name, @ as alias to origin, * for wildcards
type
Type
 String node, storage or mailer
content
Content
 String
ttl
TTL
 Integer Optional TTL in seconds, defaults to zone TTL
priority
Priority
 Integer Optional priority, used for MX and SRV records
comment
Comment
 Text Optional comment
enabled
Enabled
 Boolean Enable or disable this DNS record
dynamic_update_enabled
Enable dynamic update
 Boolean Only for A and AAAA records
managed
Managed
 Boolean
dynamic_update_url
Dynamic update URL
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/dns_records/{dns_record_id}
Description
Delete DNS record
Authentication required
yes
Scope
dns_record#delete
Aliases
destroy
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Dynamic_update

Path
GET /v7.0/dns_records/dynamic_update/{access_token}
Description
Update DNS record with the client's address
Authentication required
no
Scope
dns_record#dynamic_update
Aliases
Blocking
yes

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
dns_record
ParameterTypeDescription
content
Content
 String

Index

Path
GET /v7.0/dns_records
Description
List DNS records
Authentication required
yes
Scope
dns_record#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
dns_record
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
dns_zone
DnsZone
 Resource no
user
User
 Resource no

Output parameters

Layout
object_list
Namespace
dns_records
ParameterTypeDescription
id
ID
 Integer
dns_zone
DnsZone
 Resource
user
User
 Resource
name
Name
 String Domain name, @ as alias to origin, * for wildcards
type
Type
 String node, storage or mailer
content
Content
 String
ttl
TTL
 Integer Optional TTL in seconds, defaults to zone TTL
priority
Priority
 Integer Optional priority, used for MX and SRV records
comment
Comment
 Text Optional comment
enabled
Enabled
 Boolean Enable or disable this DNS record
dynamic_update_enabled
Enable dynamic update
 Boolean Only for A and AAAA records
managed
Managed
 Boolean
dynamic_update_url
Dynamic update URL
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/dns_records/{dns_record_id}
Description
Show DNS record
Authentication required
yes
Scope
dns_record#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
dns_record
ParameterTypeDescription
id
ID
 Integer
dns_zone
DnsZone
 Resource
user
User
 Resource
name
Name
 String Domain name, @ as alias to origin, * for wildcards
type
Type
 String node, storage or mailer
content
Content
 String
ttl
TTL
 Integer Optional TTL in seconds, defaults to zone TTL
priority
Priority
 Integer Optional priority, used for MX and SRV records
comment
Comment
 Text Optional comment
enabled
Enabled
 Boolean Enable or disable this DNS record
dynamic_update_enabled
Enable dynamic update
 Boolean Only for A and AAAA records
managed
Managed
 Boolean
dynamic_update_url
Dynamic update URL
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/dns_records/{dns_record_id}
Description
Update DNS record
Authentication required
yes
Scope
dns_record#update
Aliases
Blocking
yes

Input parameters

Layout
object
Namespace
dns_record
ParameterTypeRequiredDetails
user
User
 Resource no
content
Content
 String no

Default: null
ttl
TTL
 Integer no

Optional TTL in seconds, defaults to zone TTL

Default: null
priority
Priority
 Integer no

Optional priority, used for MX and SRV records

Default: null
comment
Comment
 Text no

Optional comment

Default: null

Validation rules
RuleDetails
Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255
enabled
Enabled
 Boolean no

Enable or disable this DNS record

Default: true
dynamic_update_enabled
Enable dynamic update
 Boolean no

Only for A and AAAA records

Default: false

Output parameters

Layout
object
Namespace
dns_record
ParameterTypeDescription
id
ID
 Integer
dns_zone
DnsZone
 Resource
user
User
 Resource
name
Name
 String Domain name, @ as alias to origin, * for wildcards
type
Type
 String node, storage or mailer
content
Content
 String
ttl
TTL
 Integer Optional TTL in seconds, defaults to zone TTL
priority
Priority
 Integer Optional priority, used for MX and SRV records
comment
Comment
 Text Optional comment
enabled
Enabled
 Boolean Enable or disable this DNS record
dynamic_update_enabled
Enable dynamic update
 Boolean Only for A and AAAA records
managed
Managed
 Boolean
dynamic_update_url
Dynamic update URL
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime