API Reference
Dashboard
  1. API Reference
  2. Box API
  3. System settings

Read every system setting of the box (timezone, network, login, DDNS, telemetry, recovery)

Use this to show or back up the system settings page. Returns secrets: the dashboard password, the DuckDNS token and the SigNoz ingestion key, in clear text. Only trusted tools should call it; never log or display the response. timezones lists every timezone name the box accepts.

  • Read only
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • getSystemSettings
GET/get_system_settings

Responses

All system settings (hand-written example; the timezone list is shortened).

statusbooleanoptional
dataobjectoptional
data.timezonesstring[]optional
data.current_timezonestringoptional
data.static_ipobjectoptional
data.static_ip.ipstringoptional
data.static_ip.netmaskstringoptional
data.static_ip.gatewaystringoptional
data.dashboard_authobjectoptional
data.duckdnsobjectoptional
data.duckdns.ddns_tokenstringoptional
data.duckdns.ddns_hostnamestringoptional
data.duckdns.ddns_logstringoptional
data.defaultDashboardPortintegeroptional
data.forceDHCPEnablebooleanoptional
data.controller_log_retention_daysintegeroptional
data.controller_log_max_mbintegeroptional
data.watch_dogobjectoptional
data.watch_dog.enablebooleanoptional
data.watch_dog.timeinteger | nulloptional
data.bridgingServiceConfigstringoptional

Bridged services one per line.

data.ttlobjectoptional
data.ttl.enablebooleanoptional
data.ttl.numberinteger | nulloptional
data.telemetryobjectoptional
data.system_recoveryobjectoptional
Verified against XProxy v21.3.2 on Nov 17, 2026