Skip to content

dns_server

Manage authoritative DNS servers

Create

Path
POST /v7.0/dns_servers
Description
Create an authoritative DNS server
Authentication required
yes
Scope
dns_server#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
dns_server
ParameterTypeRequiredDetails
node
Node
 Resource yes
name
Name
 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
ipv4_addr
Ipv4_addr
 String no

Default: null
ipv6_addr
Ipv6_addr
 String no

Default: null
hidden
Hidden
 Boolean no

Default: null
enable_user_dns_zones
Enable_user_dns_zones
 Boolean no

Default: null
user_dns_zone_type
User_dns_zone_type
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • primary_type
  • secondary_type

Validation error message: %{value} cannot be used

Output parameters

Layout
object
Namespace
dns_server
ParameterTypeDescription
id
ID
 Integer
node
Node
 Resource
name
Name
 String
ipv4_addr
Ipv4_addr
 String
ipv6_addr
Ipv6_addr
 String
hidden
Hidden
 Boolean
enable_user_dns_zones
Enable_user_dns_zones
 Boolean
user_dns_zone_type
User_dns_zone_type
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/dns_servers/{dns_server_id}
Description
Delete authoritative DNS server
Authentication required
yes
Scope
dns_server#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/dns_servers
Description
List authoritative DNS servers
Authentication required
yes
Scope
dns_server#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
dns_server
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

Output parameters

Layout
object_list
Namespace
dns_servers
ParameterTypeDescription
id
ID
 Integer
node
Node
 Resource
name
Name
 String
ipv4_addr
Ipv4_addr
 String
ipv6_addr
Ipv6_addr
 String
hidden
Hidden
 Boolean
enable_user_dns_zones
Enable_user_dns_zones
 Boolean
user_dns_zone_type
User_dns_zone_type
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/dns_servers/{dns_server_id}
Description
Show authoritative DNS server
Authentication required
yes
Scope
dns_server#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
dns_server
ParameterTypeDescription
id
ID
 Integer
node
Node
 Resource
name
Name
 String
ipv4_addr
Ipv4_addr
 String
ipv6_addr
Ipv6_addr
 String
hidden
Hidden
 Boolean
enable_user_dns_zones
Enable_user_dns_zones
 Boolean
user_dns_zone_type
User_dns_zone_type
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/dns_servers/{dns_server_id}
Description
Update authoritative DNS server
Authentication required
yes
Scope
dns_server#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
dns_server
ParameterTypeRequiredDetails
node
Node
 Resource no
name
Name
 String no

Default: null
ipv4_addr
Ipv4_addr
 String no

Default: null
ipv6_addr
Ipv6_addr
 String no

Default: null
hidden
Hidden
 Boolean no

Default: null
enable_user_dns_zones
Enable_user_dns_zones
 Boolean no

Default: null
user_dns_zone_type
User_dns_zone_type
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • primary_type
  • secondary_type

Validation error message: %{value} cannot be used

Output parameters

Layout
object
Namespace
dns_server
ParameterTypeDescription
id
ID
 Integer
node
Node
 Resource
name
Name
 String
ipv4_addr
Ipv4_addr
 String
ipv6_addr
Ipv6_addr
 String
hidden
Hidden
 Boolean
enable_user_dns_zones
Enable_user_dns_zones
 Boolean
user_dns_zone_type
User_dns_zone_type
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime