API Reference
Dashboard
  1. API Reference
  2. Box API
  3. 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.

  • Read only
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • getDdnsProviders
GET/v2/ddns/providers

Authentication

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.

statusbooleanoptional
msgstringoptional
dataobject[]optional
data[].idstringoptional

Same as type.

data[].typestringoptional
One of cloudflare, noip, duckdns, dnsomatic, dynu
data[].enabledbooleanoptional
data[].interval_secondsintegeroptional

Seconds between updates (300 when unset).

data[].ip_sourcestringoptional

Where the IP to publish comes from.

data[].manual_ipstringoptional

IP to publish when ip_source is manual.

data[].configobjectoptional

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.

data[].last_ipstring | nulloptional
data[].last_statusstring | nulloptional

Result of the latest update, e.g. updated.

data[].last_run_atinteger | nulloptional
data[].next_run_atinteger | nulloptional
data[].error_countinteger | nulloptional
data[].healthstringoptional

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".

One of inactive, ok, warn, error, unknown

Errors returned in msg

msgMeaningWhat to do
failed_to_loadThe saved provider settings could not be read.Retry; save the provider again if it persists.
Verified against XProxy v21.3.2 on Nov 17, 2026