The dnssec object provides methods to manage DNSSEC for your domains.
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.
Table 2.86. 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 |
Delete all DNSKEY/DS entries for a domain.
Table 2.88. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domainName | Name of the domain to delete all DNSKEY/DS records for. | text255 | true |
Delete one DNSKEY from a specified domain.
Table 2.89. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
key | ID of the DNSKEY to delete. | int | true |
Disable automated DNSSEC management for a domain. This flags the domain for DNSKEY removal - all keys will be destroyed.
Table 2.90. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domainName | Name of the domain to disable DNSSEC for. | text255 | true |
Enable automated DNSSEC management for a domain.
Table 2.91. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domainName | Name of the domain to enable DNSSEC for. | text255 | true |
Get current DNSSEC information.
Table 2.92. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domains | Optionally limit info to given domains. | array_text255 | false |
Table 2.93. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
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 |
Search and list manually managed DNSSEC keys.
Table 2.94. 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 |