Skip to content

Turn a DynDNS configuration on or off

PATCH /api/v2/domains/{id}/dyndns/{configId}

Turns updates for one DynDNS configuration on or off. With enabled: false the router’s updates are refused with abuse (HTTP 403) and logged as failed with “Configuration disabled”. The token and the current DNS record stay as they are. Send enabled: true to accept updates again.

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

Request

Path parameters

idstringrequired
The domain ID (dom_…).
configIdstringrequired
The DynDNS configuration ID (ddns_…) from configs[].id on GET /api/v2/domains/{id}/dyndns.

Body

enabledbooleanrequired
false pauses updates. true accepts them again.

Example

PATCH /api/v2/domains/{id}/dyndns/{configId}
curl -X PATCH "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/dyndns/ddns_01hxa3b4c5d6e7f8g9h0j1k2m3" \
-H "Authorization: Bearer $HOSTUP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enabled": false
}'

Responses

200 The configuration after the change, with its token.

Response 200
{
"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": false,
"createdAt": "2026-04-20T08:00:00.000Z",
"updatedAt": "2026-04-27T12:00:00.000Z"
}
Response fields
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.
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.

Errors

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

400enabled is missing or not a boolean.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404The domain or the configuration was not found. code is domain_not_found for the domain, dyndns_config_not_found for an unknown configuration ID, and not_found for a configuration that was deleted or is not on this domain.
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.