APIDocumentation

2.8. Dnssec
Prev	Chapter 2. Methods	Next

2.8.1. dnssec.adddnskey

Add one DNSKEY to a specified domain. Currently, only ZONE+SEP keys (flag value 257) are accepted. This does not overwrite or delete existing DNSKEYs to allow for key rollovers.

2.8.1.1. Input

Table 2.87. Parameters

Parameter	Description	Type	Required	Default
domainName	Name of the domain to add the DNSKEY for.	text255	true
dnskey	Presentation value for the DNSKEY to add. Example: domain.tld. IN DNSKEY 257 3 13 ac12c2...	dnskey	false
ds	Optional presentation value for the corresponding DS record (digest information). Example: domain.tld. IN DS 1234 13 2 56DC12...	ds	false
calculateDigest	If TRUE, the digest values for this DNSKEY will be calculated. Overrides ds parameter.	boolean	false	false
digestType	This value determines the type of digest which will be calculated. Defaults to 2 (SHA256).	dnssecDigestType	false	2

2.8.1.2. Output

Table 2.88. Parameters

Parameter	Description	Type	Optional
dnskey	Presentation value for the DNSKEY. Example: domain.tld. IN DNSKEY 257 3 13 ac12c2...	dnskey
ds	Optional presentation value for the corresponding DS record (digest information). Example: domain.tld. IN DS 1234 13 2 56DC12...	ds

2.8.2. dnssec.deleteall

Delete all DNSKEY/DS entries for a domain.

2.8.2.1. Input

Table 2.89. Parameters

Parameter	Description	Type	Required	Default
domainName	Name of the domain to delete all DNSKEY/DS records for.	text255	true

2.8.2.2. Output

No additional return parameters

2.8.3. dnssec.deletednskey

Delete one DNSKEY from a specified domain.

2.8.3.1. Input

Table 2.90. Parameters

Parameter	Description	Type	Required	Default
key	ID of the DNSKEY to delete.	int	true

2.8.3.2. Output

No additional return parameters

2.8.4. dnssec.disablednssec

Disable automated DNSSEC management for a domain. This flags the domain for DNSKEY removal - all keys will be destroyed.

2.8.4.1. Input

Table 2.91. Parameters

Parameter	Description	Type	Required	Default
domainName	Name of the domain to disable DNSSEC for.	text255	true

2.8.4.2. Output

No additional return parameters

2.8.5. dnssec.enablednssec

Enable automated DNSSEC management for a domain.

2.8.5.1. Input

Table 2.92. Parameters

Parameter	Description	Type	Required	Default
domainName	Name of the domain to enable DNSSEC for.	text255	true

2.8.5.2. Output

No additional return parameters

2.8.6. dnssec.info

Get current DNSSEC information.

2.8.6.1. Input

Table 2.93. Parameters

Parameter	Description	Type	Required	Default
domains	Optionally limit info to given domains.	array_text255	false

2.8.6.2. Output

Table 2.94. Parameters

Parameter	Description	Type
data	List of domains and their DNSSEC status	array
... domain	Domain name.	text255
... keyCount	Count of DNSSEC keys for this domain.	int
... dnssecStatus	Domain DNSSEC status.	dnssecDomainStatus

2.8.7. dnssec.listkeys

Search and list manually managed DNSSEC keys.

2.8.7.1. Input

Table 2.95. Parameters

Parameter	Description	Type	Required	Default
domainName	Search for DNSSEC data for the given domain.	text0255	false
domainNameIdn	Search for DNSSEC data for the given ACE domain name.	text0255	false
keyTag	Search for DNSKEY entries with the given key tag.	int	false
flagId	Search for DNSKEY entries with the given flags value.	dnssecFlag	false
algorithmId	Search for DNSKEY entries with the given algorithm.	dnssecAlgorithm	false
publicKey	Search for DNSKEY entries with the given public key.	text	false
digestTypeId	Search DNSKEY entries with the given digest type.	dnssecDigestType	false
digest	Search DNSKEY entries with the given digest.	text0255	false
createdBefore	Search DNSKEY entries created before this time.	dateTime	false
createdAfter	Search DNSKEY entries created after this time.	dateTime	false
status	Search DNSKEY entries with this status.	dnssecKeyStatus	false
active	Search DNSKEY entries which are active (1) or inactive (0).	int	false
page	Page number for paging	int	false	1
pagelimit	Max number of results per page. 0 is no limit	int	false	0

2.8.7.2. Output

Table 2.96. Parameters

Parameter	Description	Type
dnskey
... ownerName	The domain name that owns the DNSSEC key.	text0255
... id	The unique identifier for the DNSSEC key.	int
... domainId	The identifier for the domain associated with the DNSSEC key.	int
... keyTag	The key tag associated with the DNSSEC key.	int
... flagId	The flag ID of the DNSSEC key.	dnssecFlag
... algorithmId	The algorithm ID used by the DNSSEC key.	dnssecAlgorithm
... publicKey	The public key for the DNSSEC key.	text
... digestTypeId	The digest type ID associated with the DNSSEC key.	dnssecDigestType
... digest	The digest associated with the DNSSEC key.	text0255
... created	The date and time when the DNSSEC key was created.	dateTime
... status	The status of the DNSSEC key (e.g., OK, DELETED).	dnssecKeyStatus
... active	Indicates if the DNSSEC key is active (1) or inactive (0).	int