Global

Type Definitions

Cryptokey

Source:
Properties:
Name Type Description
keytype 'ksk' | 'zsk' | 'csk' The type of the key possible values are
active boolean Whether or not the key is in active use
published boolean Whether or not the DNSKEY record is published in the zone
dnskey string The DNSKEY record for this key
privateKey string The private key in ISC format
algorithm string The name of the algorithm of the key, should be a mnemonic
Type:
  • object

Record

Source:
Properties:
Name Type Attributes Default Description
name string key name of the record
type string <optional>
'A' type of the record
ttl number <optional>
3600 time to live of the record
content Array value array with content of the record
Type:
  • object
Example
{name: "example.com", type: "A", ttl: 300, content: ['1.1.1.1', '8.8.8.8']}

Records

Source:
Type:
Example
[{
    name: "example.com",
    type: "A",
    ttl: 300,
    content: ['1.1.1.1', '8.8.8.8']
}, {
    name: "*.example.com",
    type: "A",
    ttl: 300,
    content: ['1.1.1.1', '8.8.8.8']
}]
Source:
Properties:
Name Type Attributes Default Description
query string query to search for
max number <optional>
10 limits the ammount of returned values
object_type 'all' | 'zone' | 'record' | 'comment' <optional>
record for what kind of pdns object to search
Type:
  • object
Example
{query: 'example.com', max: 100, object_type: "zone"}