Skip to content

List DynDNS configurations

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

Lists the dynamic DNS (DynDNS) configurations for the domain. Each one lets a router or DynDNS client keep an A or AAAA record up to date with a changing IP address. DynDNS works only when the domain uses Hostup nameservers. Otherwise available is false and reason says why. Each configuration’s token is the secret the router sends with its updates.

Authentication: An API key with the scope read:domains. Also write:domains: only to see each configuration’s token. Without it token is null and every action gate is denied. About keys and scopes

Request

Path parameters

idstringrequired
The domain ID (dom_…).

Example

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

Responses

200 Whether DynDNS is available, the configurations and the action gates.

Response 200
{
"available": true,
"reason": null,
"configs": [
{
"id": "ddns_01hxa3b4c5d6e7f8g9h0j1k2m3",
"hostname": "home.example.com",
"recordType": "A",
"token": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"lastIp": "198.51.100.45",
"lastUpdatedAt": "2026-04-27T12:00:00.000Z",
"updateCount": 12,
"enabled": true,
"createdAt": "2026-04-20T08:00:00.000Z",
"updatedAt": "2026-04-27T12:00:00.000Z"
}
],
"actions": {
"canManage": {
"allowed": true,
"reason": null
},
"canEnable": {
"allowed": true,
"reason": null
},
"canUpdateToken": {
"allowed": true,
"reason": null
}
}
}
Response fields
availableboolean
True when the domain uses Hostup nameservers.
reasonstring | null
Why DynDNS is not available. Null when available is true.
configsarray of object
The DynDNS configurations.
idstring
The DynDNS configuration ID (ddns_…).
hostnamestring
The full host name the configuration updates, such as home.example.com.
recordTypestring
A for IPv4 or AAAA for IPv6. One of A, AAAA.
tokenstring | null
The secret your router or DynDNS client sends with each update. Null for a key without write:domains.
lastIpstring | null
The address set by the last update. Null before the first update.
lastUpdatedAtstring | null
When the last update was made.
updateCountinteger
How many updates have been made.
enabledboolean
Whether updates are accepted.
createdAtstring | null
When the configuration was created.
updatedAtstring | null
When the configuration was last changed.
actionsobject
Whether the configurations can be changed. Every gate is denied when available is false or the key lacks write:domains; reason says which.
canManageobject
Whether configurations can be created, changed or deleted. Older name for canEnable.
allowedboolean
reasonstring | null
canEnableobject
Whether a configuration can be created or turned on or off.
allowedboolean
reasonstring | null
canUpdateTokenobject
Same value as canEnable. No endpoint changes a token; to replace one, delete the configuration and create it again.
allowedboolean
reasonstring | null

Errors

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

401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404The domain was not found or is not in your account (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.