- API Reference
- Box API
- Network
Create or change one DDNS provider
Updates the provider named by type; only the fields present (enabled, interval_seconds, ip_source, manual_ip, config) change. Starts or stops the DDNS service to match whether any provider is enabled, and, when the provider is enabled, sends an update right away (a failed update is only logged).
/v2/ddns/providersRequest body application/json · required
cloudflare, noip, duckdns, dnsomatic, dynuAuthentication
Needs a trusted caller (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) or valid dashboard Basic credentials, which are checked only when dashboard authentication is enabled.
Responses
Result.
The caller is not trusted (not loopback, LAN, whitelisted or allowed Tailscale) and sent no valid Basic credentials. The body depends on whether "Basic auth for all API" is on. Routes that also use the panel login can answer a plain-text 401 "Unauthorized Access" instead.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
invalid_payload | The body is not a JSON object. | Send a JSON object. |
invalid_provider_type | type is missing or not cloudflare, noip, duckdns, dnsomatic or dynu. | Send a supported type. |
failed_to_save | Saving failed. | Retry; check the controller log. |