Skip to content
handupbeta
Download

ui_settings

View as Markdown
GET
/v1/ui-settings

UI policy: undo window, primary action side, HTML network access, remote mode/warning, relay pairing, calling device, pending config restart and config error. Refetch on config.changed.

Media typeapplication/json

Read-only UI policy derived from daemon config; never includes secrets.

object
undo_window_ms
required

decisions.undo_window in milliseconds (0 = approvals send instantly).

integer format: int64
primary_side
required

decisions.primary_side: right or left, the edge of decision footers that holds the primary (approve) action. Apps may override it per device.

string
html_allow_network
required

previews.html.allow_network.

boolean
keys
required

keys: keyboard shortcut overrides (action id → key, e.g. shift+a, mod+enter); absent actions use their defaults. Changes arrive live as keys.changed events.

object
key
additional properties
string
remote_mode
required

remote.mode: off, tailscale, or direct.

string
remote_warning

Direct-mode risk warning; UIs show it as a persistent banner when set.

string | null
pair_relay
required

remote.relay.url is set, so local callers can pair through the relay (POST /v1/pair {relay: true}). Always false for paired devices.

boolean
device
One of:
null
config_restart_required
required

Config keys saved since the daemon started that apply only after a restart (config.changed restart_required); empty when none.

Array<string>
config_error

The config file’s parse/validation error (path:line: message) while the daemon keeps the previous config; null when the file is valid.

string | null