- API Reference
- Box API
- 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.
GET
/get_system_settingsResponses
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
The 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.