Skip to content

dns_zone_transfer

Manage DNS zone transfers

Create

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

Input parameters

Layout
object
Namespace
dns_zone_transfer
ParameterTypeRequiredDetails
dns_zone
DnsZone
 Resource no
host_ip_address
HostIpAddress
 Resource yes

Host address to assign to the interface, defaults to the first address
peer_type
Peer_type
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • primary_type
  • secondary_type

Validation error message: %{value} cannot be used
dns_tsig_key
DnsTsigKey
 Resource no

Output parameters

Layout
object
Namespace
dns_zone_transfer
ParameterTypeDescription
id
ID
 Integer
dns_zone
DnsZone
 Resource
host_ip_address
HostIpAddress
 Resource Host address to assign to the interface, defaults to the first address
peer_type
Peer_type
 String
dns_tsig_key
DnsTsigKey
 Resource
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/dns_zone_transfers/{dns_zone_transfer_id}
Description
Delete DNS zone transfer
Authentication required
yes
Scope
dns_zone_transfer#delete
Aliases
destroy
Blocking
yes

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/dns_zone_transfers
Description
List DNS zone transfers
Authentication required
yes
Scope
dns_zone_transfer#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
dns_zone_transfer
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
host_ip_address
HostIpAddress
 Resource no

Host address to assign to the interface, defaults to the first address
peer_type
Peer_type
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • primary_type
  • secondary_type

Validation error message: %{value} cannot be used
dns_tsig_key
DnsTsigKey
 Resource no

Output parameters

Layout
object_list
Namespace
dns_zone_transfers
ParameterTypeDescription
id
ID
 Integer
dns_zone
DnsZone
 Resource
host_ip_address
HostIpAddress
 Resource Host address to assign to the interface, defaults to the first address
peer_type
Peer_type
 String
dns_tsig_key
DnsTsigKey
 Resource
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/dns_zone_transfers/{dns_zone_transfer_id}
Description
Show DNS zone transfer
Authentication required
yes
Scope
dns_zone_transfer#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
dns_zone_transfer
ParameterTypeDescription
id
ID
 Integer
dns_zone
DnsZone
 Resource
host_ip_address
HostIpAddress
 Resource Host address to assign to the interface, defaults to the first address
peer_type
Peer_type
 String
dns_tsig_key
DnsTsigKey
 Resource
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime