Instance settings are singleton, host-level configuration records. Both routes require board access, and the handlers only allow updates from the local implicit board actor or an instance admin.

​
General Settings

GET /api/instance/settings/general
PATCH /api/instance/settings/general
General settings cover the stable host-level toggles.

​
Current Fields

FieldTypeMeaning
censorUsernameInLogsbooleanRedacts usernames from logs when enabled

​
Response Semantics

  • GET returns the current general settings object.
  • PATCH accepts a partial general-settings patch and returns the saved general settings object.
  • Updates are merged into the existing settings and then normalized back to the supported schema.
  • General-setting changes are logged as activity for every company in the instance.

​
Experimental Settings

GET /api/instance/settings/experimental
PATCH /api/instance/settings/experimental
Experimental settings cover host-level feature toggles that can change runtime behavior.

​
Current Fields

FieldTypeMeaning
enableIsolatedWorkspacesbooleanEnables isolated workspace behavior
autoRestartDevServerWhenIdlebooleanAllows the dev server to restart automatically when idle

​
Response Semantics

  • GET returns the current experimental settings object.
  • PATCH accepts a partial experimental-settings patch and returns the saved experimental settings object.
  • Updates are merged into the existing settings and normalized back to the supported schema.
  • Experimental-setting changes are logged as activity for every company in the instance.