SettingsService
GetNotificationPreferences
Section titled “GetNotificationPreferences”POST /spin.v1.SettingsService/GetNotificationPreferences
Which of those the caller is emailed about, and for an administrator which of the installation’s events besides.
Request
No fields: {}.
Response
| Field | Type | What it is |
|---|---|---|
preferences | list of NotificationPreference | One per event a person may be told of, in the order they are shown: an administrator’s include the installation’s. |
emailConfigured | boolean |
GetUserSettings
Section titled “GetUserSettings”POST /spin.v1.SettingsService/GetUserSettings
User settings
Request
No fields: {}.
Response
| Field | Type | What it is |
|---|---|---|
settings | UserSettings |
ListNotifications
Section titled “ListNotifications”POST /spin.v1.SettingsService/ListNotifications
What happened to the caller’s workspaces that they are told of, newest first, with whether each was sent and how. Recorded whether or not the installation can send email.
Request
No fields: {}.
Response
| Field | Type | What it is |
|---|---|---|
notifications | list of Notification | |
emailConfigured | boolean | Whether the installation can send email at all. |
UpdateNotificationPreferences
Section titled “UpdateNotificationPreferences”POST /spin.v1.SettingsService/UpdateNotificationPreferences
Request
| Field | Type | What it is |
|---|---|---|
preferences | list of NotificationPreference | Each event named is set; one not named keeps what it was. |
Response
| Field | Type | What it is |
|---|---|---|
preferences | list of NotificationPreference |
UpdateUserSettings
Section titled “UpdateUserSettings”POST /spin.v1.SettingsService/UpdateUserSettings
Request
| Field | Type | What it is |
|---|---|---|
dotfiles | DotfilesConfig | |
startupTaskfile | string | |
defaultShell | string | |
editorSettings | map of string to string | |
defaultEnv | map of string to string |
Response
| Field | Type | What it is |
|---|---|---|
settings | UserSettings |
ValidateTaskfile
Section titled “ValidateTaskfile”POST /spin.v1.SettingsService/ValidateTaskfile
Validate Taskfile syntax
Request
| Field | Type | What it is |
|---|---|---|
taskfileContent | string |
Response
| Field | Type | What it is |
|---|---|---|
valid | boolean | |
errors | list of string | |
taskNames | list of string | List of defined tasks |
Generated by task reference from spin/internal/controlplane/apidocs/spin.v1.openapi.json at 51f7e0dea.
Installations run Spinbox v20261027.01; the reference is generated from spin v20261114.01 (51f7e0dea). This page as Markdown, for a model or a terminal.

