Skip to content

List DNSSEC records

GET /api/v2/domains/{id}/dnssec

Lists the DNSSEC records the registry holds for the domain. The response also shows the record type the registry takes (recordType), the algorithms and digest types it accepts and whether records can be added or removed (actions). Use it to manage manual DS/KEY records, for a domain whose DNS is signed by another provider. Domains on Hostup nameservers normally get their DS record from automatic DNSSEC (GET /api/v2/domains/{id}/dnssec-auto). When the registry holds no DNSSEC record but the zone is already signed, detectedRecords holds the record that completes the chain. Send its values to POST /api/v2/domains/{id}/dnssec to turn DNSSEC on. While a .se or .nu registry lock is on, actions denies both changes and gives the reason.

Authentication: An API key with the scope read:domains. About keys and scopes

Request

Path parameters

idstringrequired
The domain ID (dom_…).

Example

GET /api/v2/domains/{id}/dnssec
curl "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/dnssec" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 The domain’s DNSSEC records, the accepted formats and the action gates.

Response 200
{
"domainName": "example.se",
"recordType": "DS",
"dsRecords": [
{
"id": "dsr_01hxa3b4c5d6e7f8g9h0j1k2m3",
"keyTag": "2371",
"algorithm": "13",
"digestType": "2",
"digest": "5A1D7C1B9E7F4E6A8C2B0D5F9A3E6C7D8B1A2C3D4E5F60718293A4B5C6D7E8F9"
}
],
"keyRecords": [],
"allowedAlgorithms": [
8,
10,
12,
13,
14
],
"allowedDigestTypes": [
2,
3,
4
],
"algorithmNames": {
"1": "RSA/MD5",
"2": "Diffie-Hellman",
"3": "DSA/SHA-1",
"5": "RSA/SHA-1",
"6": "DSA-NSEC3-SHA1",
"7": "RSASHA1-NSEC3-SHA1",
"8": "RSA/SHA-256",
"10": "RSA/SHA-512",
"12": "GOST R 34.10-2001",
"13": "ECDSA Curve P-256 with SHA-256",
"14": "ECDSA Curve P-384 with SHA-384",
"15": "Ed25519",
"16": "Ed448"
},
"digestTypeNames": {
"1": "SHA-1",
"2": "SHA-256",
"3": "GOST R 34.11-94",
"4": "SHA-384"
},
"status": "active",
"reason": null,
"actions": {
"canAdd": {
"allowed": true,
"reason": null
},
"canRemove": {
"allowed": true,
"reason": null
}
},
"detectedRecords": []
}
Response fields
domainNamestring | null
The domain name.
recordTypestring
The record type the registry takes for this domain: DS or KEY. One of DS, KEY.
dsRecordsarray of object
DS records at the registry.
idstring | null
The record ID (dsr_…). Use it to delete the record.
keyTagstring | null
Key tag of the key the record points to.
algorithmstring | null
DNSSEC algorithm number.
digestTypestring | null
Digest type number.
digeststring | null
The digest in hexadecimal.
keyRecordsarray of object
KEY records at the registry.
idstring | null
The record ID (dsr_…). Use it to delete the record.
flagstring | null
Key flags. 257 is a key-signing key.
protocolstring | null
Protocol number. Always 3 for DNSSEC.
algorithmstring | null
DNSSEC algorithm number.
publicKeystring | null
The public key in base64.
allowedAlgorithmsarray of integer
Algorithm numbers the registry accepts.
allowedDigestTypesarray of integer
Digest type numbers the registry accepts.
algorithmNamesobject
Names of the algorithms, keyed by number.
digestTypeNamesobject
Names of the digest types, keyed by number.
statusstring
active (records can be managed), unsupported (DNSSEC is not available for this domain, see reason) or error (the registry data could not be read, try again later). One of active, unsupported, error.
reasonstring | null
Why status is unsupported or error. Null when active.
actionsobject
Whether records can be added or removed now. A denied gate carries the reason.
canAddobject
Whether a record can be added.
allowedboolean
reasonstring | null
canRemoveobject
Whether a record can be removed.
allowedboolean
reasonstring | null
detectedRecordsarray of object
Records that would complete the DNSSEC chain, read from the zone’s own key-signing key. Filled only when the registry holds no DNSSEC record and the zone is signed. Each entry has the shape POST /api/v2/domains/{id}/dnssec returns.
recordTypestring
DS or KEY, matching recordType. One of DS, KEY.
dsobject | null
The DS record. Null for a KEY record.
idstring | null
The record ID (dsr_…). Null until the record is at the registry.
keyTagstring | null
Key tag of the key the record points to.
algorithmstring | null
DNSSEC algorithm number.
digestTypestring | null
Digest type number.
digeststring | null
The digest in hexadecimal.
keyobject | null
The KEY record. Null for a DS record.
idstring | null
The record ID (dsr_…). Null until the record is at the registry.
flagstring | null
Key flags. 257 is a key-signing key.
protocolstring | null
Protocol number. Always 3 for DNSSEC.
algorithmstring | null
DNSSEC algorithm number.
publicKeystring | null
The public key in base64.

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller; code is domain_not_found.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.
502Upstream failure. A dependent provider request failed; the Problem Details code is upstream_failed. Retry later or contact support if the issue persists.