Skip to content

dns_zone

Manage DNS zones

Create

Path
POST /v7.0/dns_zones
Description
Create a DNS zone
Authentication required
yes
Scope
dns_zone#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
dns_zone
ParameterTypeRequiredDetails
name
Name
 String yes

Fully qualified domain name

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

Format

Must match this regular expression:

\A((?!-)[A-Za-z0-9\-_]{1,63}(?<!-)\.)+[A-Za-z]{2,63}\.\z

null

Validation error message: %{value} is not a valid zone name
user
User
 Resource no
reverse_network_address
Reverse_network_address
 String no

Default: null
reverse_network_prefix
Reverse_network_prefix
 String no

Default: null
label
Label
 String no

Default: null
role
Role
 String no

Show only datasets of certain role

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • forward_role
  • reverse_role

Validation error message: %{value} cannot be used
source
Source
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • internal_source
  • external_source

Validation error message: %{value} cannot be used
default_ttl
Default TTL
 Integer no

Default TTL for records, in seconds

Default: null
email
E-mail
 String no

Administrator of this zone

Default: null

Validation rules
RuleDetails
Format

Must match this regular expression:

\A[^@\s]+@[^\s]+\z

null

Validation error message: %{value} is not a valid email address
dnssec_enabled
Enable DNSSEC
 Boolean no

Requires DNSKEY/DS records to be configured in the parent zone

Default: null
enabled
Enabled
 Boolean no

Enable or disable this DNS zone

Default: null
seed_vps
Seed VPS
 Resource no

Seed the zone with basic records pointing to the VPS

Output parameters

Layout
object
Namespace
dns_zone
ParameterTypeDescription
id
ID
 Integer
name
Name
 String Fully qualified domain name
user
User
 Resource
reverse_network_address
Reverse_network_address
 String
reverse_network_prefix
Reverse_network_prefix
 String
label
Label
 String
role
Role
 String Show only datasets of certain role
source
Source
 String
default_ttl
Default TTL
 Integer Default TTL for records, in seconds
email
E-mail
 String Administrator of this zone
dnssec_enabled
Enable DNSSEC
 Boolean Requires DNSKEY/DS records to be configured in the parent zone
enabled
Enabled
 Boolean Enable or disable this DNS zone
serial
Serial
 Integer
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/dns_zones/{dns_zone_id}
Description
Delete DNS zone
Authentication required
yes
Scope
dns_zone#delete
Aliases
destroy
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/dns_zones
Description
List DNS zones
Authentication required
yes
Scope
dns_zone#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
dns_zone
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
user
User
 Resource no
role
Role
 String no

Show only datasets of certain role

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • forward_role
  • reverse_role

Validation error message: %{value} cannot be used
source
Source
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • internal_source
  • external_source

Validation error message: %{value} cannot be used
dnssec_enabled
Enable DNSSEC
 Boolean no

Requires DNSKEY/DS records to be configured in the parent zone

Default: null
enabled
Enabled
 Boolean no

Enable or disable this DNS zone

Default: null

Output parameters

Layout
object_list
Namespace
dns_zones
ParameterTypeDescription
id
ID
 Integer
name
Name
 String Fully qualified domain name
user
User
 Resource
reverse_network_address
Reverse_network_address
 String
reverse_network_prefix
Reverse_network_prefix
 String
label
Label
 String
role
Role
 String Show only datasets of certain role
source
Source
 String
default_ttl
Default TTL
 Integer Default TTL for records, in seconds
email
E-mail
 String Administrator of this zone
dnssec_enabled
Enable DNSSEC
 Boolean Requires DNSKEY/DS records to be configured in the parent zone
enabled
Enabled
 Boolean Enable or disable this DNS zone
serial
Serial
 Integer
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/dns_zones/{dns_zone_id}
Description
Show DNS zone
Authentication required
yes
Scope
dns_zone#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
dns_zone
ParameterTypeDescription
id
ID
 Integer
name
Name
 String Fully qualified domain name
user
User
 Resource
reverse_network_address
Reverse_network_address
 String
reverse_network_prefix
Reverse_network_prefix
 String
label
Label
 String
role
Role
 String Show only datasets of certain role
source
Source
 String
default_ttl
Default TTL
 Integer Default TTL for records, in seconds
email
E-mail
 String Administrator of this zone
dnssec_enabled
Enable DNSSEC
 Boolean Requires DNSKEY/DS records to be configured in the parent zone
enabled
Enabled
 Boolean Enable or disable this DNS zone
serial
Serial
 Integer
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/dns_zones/{dns_zone_id}
Description
Update DNS zone
Authentication required
yes
Scope
dns_zone#update
Aliases
Blocking
yes

Input parameters

Layout
object
Namespace
dns_zone
ParameterTypeRequiredDetails
label
Label
 String no

Default: null
default_ttl
Default TTL
 Integer no

Default TTL for records, in seconds

Default: null
email
E-mail
 String no

Administrator of this zone

Default: null

Validation rules
RuleDetails
Format

Must match this regular expression:

\A[^@\s]+@[^\s]+\z

null

Validation error message: %{value} is not a valid email address
dnssec_enabled
Enable DNSSEC
 Boolean no

Requires DNSKEY/DS records to be configured in the parent zone

Default: null
enabled
Enabled
 Boolean no

Enable or disable this DNS zone

Default: null

Output parameters

Layout
object
Namespace
dns_zone
ParameterTypeDescription
id
ID
 Integer
name
Name
 String Fully qualified domain name
user
User
 Resource
reverse_network_address
Reverse_network_address
 String
reverse_network_prefix
Reverse_network_prefix
 String
label
Label
 String
role
Role
 String Show only datasets of certain role
source
Source
 String
default_ttl
Default TTL
 Integer Default TTL for records, in seconds
email
E-mail
 String Administrator of this zone
dnssec_enabled
Enable DNSSEC
 Boolean Requires DNSKEY/DS records to be configured in the parent zone
enabled
Enabled
 Boolean Enable or disable this DNS zone
serial
Serial
 Integer
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime