Skip to content

dns_server_zone

Manage authoritative DNS zones on servers

Create

Path
POST /v7.0/dns_server_zones
Description
Add DNS zone to a server
Authentication required
yes
Scope
dns_server_zone#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
dns_server_zone
ParameterTypeRequiredDetails
dns_server
DnsServer
 Resource yes
dns_zone
DnsZone
 Resource yes
type
Type
 String no

node, storage or mailer

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_zone
ParameterTypeDescription
id
ID
 Integer
dns_server
DnsServer
 Resource
dns_zone
DnsZone
 Resource
type
Type
 String node, storage or mailer
serial
Serial
 Integer
loaded_at
Loaded_at
 Datetime
expires_at
Expires_at
 Datetime
refresh_at
Refresh_at
 Datetime
last_check_at
Last_check_at
 Datetime
last_transfer_at
Last_transfer_at
 Datetime
last_transfer_status
Last_transfer_status
 String
last_transfer_reason_code
Last_transfer_reason_code
 String
last_transfer_reason
Last_transfer_reason
 String
last_transfer_primary_addr
Last_transfer_primary_addr
 String
last_transfer_serial
Last_transfer_serial
 Integer
last_transfer_log_id
Last_transfer_log_id
 Integer
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/dns_server_zones/{dns_server_zone_id}
Description
Delete DNS zone from server
Authentication required
yes
Scope
dns_server_zone#delete
Aliases
destroy
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/dns_server_zones
Description
List DNS zones on servers
Authentication required
yes
Scope
dns_server_zone#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
dns_server_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
dns_server
DnsServer
 Resource no
dns_zone
DnsZone
 Resource no
type
Type
 String no

node, storage or mailer

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • primary_type
  • secondary_type

Validation error message: %{value} cannot be used

Output parameters

Layout
object_list
Namespace
dns_server_zones
ParameterTypeDescription
id
ID
 Integer
dns_server
DnsServer
 Resource
dns_zone
DnsZone
 Resource
type
Type
 String node, storage or mailer
serial
Serial
 Integer
loaded_at
Loaded_at
 Datetime
expires_at
Expires_at
 Datetime
refresh_at
Refresh_at
 Datetime
last_check_at
Last_check_at
 Datetime
last_transfer_at
Last_transfer_at
 Datetime
last_transfer_status
Last_transfer_status
 String
last_transfer_reason_code
Last_transfer_reason_code
 String
last_transfer_reason
Last_transfer_reason
 String
last_transfer_primary_addr
Last_transfer_primary_addr
 String
last_transfer_serial
Last_transfer_serial
 Integer
last_transfer_log_id
Last_transfer_log_id
 Integer
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/dns_server_zones/{dns_server_zone_id}
Description
Show DNS zone on server
Authentication required
yes
Scope
dns_server_zone#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
dns_server_zone
ParameterTypeDescription
id
ID
 Integer
dns_server
DnsServer
 Resource
dns_zone
DnsZone
 Resource
type
Type
 String node, storage or mailer
serial
Serial
 Integer
loaded_at
Loaded_at
 Datetime
expires_at
Expires_at
 Datetime
refresh_at
Refresh_at
 Datetime
last_check_at
Last_check_at
 Datetime
last_transfer_at
Last_transfer_at
 Datetime
last_transfer_status
Last_transfer_status
 String
last_transfer_reason_code
Last_transfer_reason_code
 String
last_transfer_reason
Last_transfer_reason
 String
last_transfer_primary_addr
Last_transfer_primary_addr
 String
last_transfer_serial
Last_transfer_serial
 Integer
last_transfer_log_id
Last_transfer_log_id
 Integer
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime