API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Network

Change the DNS servers of the box and the proxies

Saves the proxy DNS list and modem-DNS options, writes the system resolver configuration and reloads every proxy. All four fields are required.

  • Destructive · confirm first
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: needs owner approval
  • updateDnsConfig
POST/update_dns_config

Request body application/json · required

using_modem_dnsbooleanrequired
dns_proxy_liststringrequired

Resolver IPs separated by commas, spaces or new lines.

vpn_force_reload_dns_serverbooleanrequired
dns_system_liststringrequired

Resolver IPs separated by commas, spaces or new lines.

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.

statusbooleanrequired

True when the box accepted the request.

msgstringrequired

Outcome code or message (see the operation's error table).

Errors returned in msg

msgMeaningWhat to do
An error when configuration!A field is missing or writing the resolver settings failed.Send all four fields and retry.
Verified against XProxy v21.3.2 on Nov 17, 2026