Skip to content

dns_tsig_key

Manage DNS TSIG key transfers

Create

Path
POST /v7.0/dns_tsig_keys
Description
Create a DNS TSIG key
Authentication required
yes
Scope
dns_tsig_key#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
dns_tsig_key
ParameterTypeRequiredDetails
user
User
 Resource no
name
Name
 String no

Default: null

Validation rules
RuleDetails
Format

Must match this regular expression:

\A[a-zA-Z0-9\-.]+\z

null

Validation error message: %{value} is not a valid TSIG key name
algorithm
Algorithm
 String no

Default: hmac-sha256

Validation rules
RuleDetails
Include

Allowed values:

  • hmac-sha224
  • hmac-sha256
  • hmac-sha384
  • hmac-sha512

Validation error message: %{value} is not a valid TSIG algorithm

Output parameters

Layout
object
Namespace
dns_tsig_key
ParameterTypeDescription
id
ID
 Integer
user
User
 Resource
name
Name
 String
algorithm
Algorithm
 String
secret
Secret
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/dns_tsig_keys/{dns_tsig_key_id}
Description
Delete DNS TSIG key
Authentication required
yes
Scope
dns_tsig_key#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/dns_tsig_keys
Description
List DNS TSIG key
Authentication required
yes
Scope
dns_tsig_key#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
dns_tsig_key
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
algorithm
Algorithm
 String no

Default: hmac-256

Validation rules
RuleDetails
Include

Allowed values:

  • hmac-sha224
  • hmac-sha256
  • hmac-sha384
  • hmac-sha512

Validation error message: %{value} is not a valid TSIG algorithm

Output parameters

Layout
object_list
Namespace
dns_tsig_keys
ParameterTypeDescription
id
ID
 Integer
user
User
 Resource
name
Name
 String
algorithm
Algorithm
 String
secret
Secret
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/dns_tsig_keys/{dns_tsig_key_id}
Description
Show DNS TSIG key
Authentication required
yes
Scope
dns_tsig_key#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
dns_tsig_key
ParameterTypeDescription
id
ID
 Integer
user
User
 Resource
name
Name
 String
algorithm
Algorithm
 String
secret
Secret
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime