-
Notifications
You must be signed in to change notification settings - Fork 0
REST PUT settings
Timon Home edited this page Mar 19, 2026
·
1 revision
Updates application settings. Replaces the stored settings with the provided object.
PUT /settings
Content-Type: application/json
Complete AppSettings object. All fields are required — send the full object to avoid accidentally resetting fields to defaults.
{
"launchOnStartup": false,
"startMinimized": false,
"minimizeToTray": true,
"consoleFontSize": 14,
"consoleMaxLines": 10000,
"consoleWordWrap": true,
"consoleLineNumbers": false,
"consoleHistorySize": 500,
"theme": "dark"
}200 OK
Returns the saved settings object:
{
"launchOnStartup": false,
"startMinimized": false,
"minimizeToTray": true,
"consoleFontSize": 14,
"consoleMaxLines": 10000,
"consoleWordWrap": true,
"consoleLineNumbers": false,
"consoleHistorySize": 500,
"theme": "dark"
}400 Bad Request — body is missing required fields or contains invalid values.
Settings take effect immediately for most fields. The following require the next relevant action to take effect:
| Field | When it takes effect |
|---|---|
launchOnStartup |
Requires OS registration (currently not auto-wired — see Tray & Window Lifecycle) |
startMinimized |
Next app launch |
minimizeToTray |
Next window close action |
consoleMaxLines |
Next console line appended |
consoleFontSize |
Immediately in open UI |
consoleWordWrap |
Immediately in open UI |
consoleLineNumbers |
Immediately in open UI |
consoleHistorySize |
Next command entered |
The theme field is reserved for future use. "dark" is the only accepted value.
See Settings Reference for valid ranges.