Skip to content
Spinbox is experimental: APIs change and data may be lost. Status lists what is built and what proves it.

SettingsService

View Markdown

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

FieldTypeWhat it is
preferenceslist of NotificationPreferenceOne per event a person may be told of, in the order they are shown: an administrator’s include the installation’s.
emailConfiguredboolean

POST /spin.v1.SettingsService/GetUserSettings

User settings

Request

No fields: {}.

Response

FieldTypeWhat it is
settingsUserSettings

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

FieldTypeWhat it is
notificationslist of Notification
emailConfiguredbooleanWhether the installation can send email at all.

POST /spin.v1.SettingsService/UpdateNotificationPreferences

Request

FieldTypeWhat it is
preferenceslist of NotificationPreferenceEach event named is set; one not named keeps what it was.

Response

FieldTypeWhat it is
preferenceslist of NotificationPreference

POST /spin.v1.SettingsService/UpdateUserSettings

Request

FieldTypeWhat it is
dotfilesDotfilesConfig
startupTaskfilestring
defaultShellstring
editorSettingsmap of string to string
defaultEnvmap of string to string

Response

FieldTypeWhat it is
settingsUserSettings

POST /spin.v1.SettingsService/ValidateTaskfile

Validate Taskfile syntax

Request

FieldTypeWhat it is
taskfileContentstring

Response

FieldTypeWhat it is
validboolean
errorslist of string
taskNameslist of stringList 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.