- API Reference
- Box API
- Network
List the DDNS providers and whether their updates are healthy
Returns every saved DDNS provider with its settings, last result and a computed health. This response returns secrets: each provider's config holds its API token or password.
/v2/ddns/providersAuthentication
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
Providers, or a load failure.
Same as type.
cloudflare, noip, duckdns, dnsomatic, dynuSeconds between updates (300 when unset).
Where the IP to publish comes from.
IP to publish when ip_source is manual.
Provider credentials. cloudflare: api_token, zone_id, record_name, proxied, ttl. noip: hostname, username, password. duckdns: domain, token. dnsomatic: username, password, hostname. dynu: hostname, username, password_or_key.
Result of the latest update, e.g. updated.
Computed by the box. A provider whose next run is overdue is reported as warn or error with last_status "Service not running - check DDNS service".
inactive, ok, warn, error, unknownThe 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 |
|---|---|---|
failed_to_load | The saved provider settings could not be read. | Retry; save the provider again if it persists. |