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

  • Destructive · confirm first
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: needs owner approval
  • saveDdnsProvider
POST/v2/ddns/providers

Request body application/json · required

typestringrequired
One of cloudflare, noip, duckdns, dnsomatic, dynu
enabledbooleanoptional
interval_secondsintegeroptional
ip_sourcestringoptional
manual_ipstringoptional
configobjectoptional

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

Result.

statusbooleanoptional
msgstringoptional

Errors returned in msg

msgMeaningWhat to do
invalid_payloadThe body is not a JSON object.Send a JSON object.
invalid_provider_typetype is missing or not cloudflare, noip, duckdns, dnsomatic or dynu.Send a supported type.
failed_to_saveSaving failed.Retry; check the controller log.
Verified against XProxy v21.3.2 on Nov 17, 2026