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

AdminService

View Markdown

AdminService manages installation-wide settings, user management, and resource presets. Only accessible to instance administrators.

POST /spin.v1.AdminService/AcceptThirdPartyTerms

Accept the terms, as the version shown, for the items named: this installation then downloads them - the releases this control plane pins at once, and the newest daily.

Request

FieldTypeWhat it is
termsVersionstringThe version of the text the administrator was shown: one that is not the current one is refused, so nobody accepts a text they did not read.
itemslist of ThirdPartyItem

Response

No fields: {}.

POST /spin.v1.AdminService/AddAllowedEmail

Add allowed email/domain

Request

FieldTypeWhat it is
patternstringEmail address (user@example.com) or domain (example.com)
typeAllowedEmailType
descriptionstringOptional description

Response

FieldTypeWhat it is
entryAllowedEmail

POST /spin.v1.AdminService/ClearUserPasskeys

Clear a person’s passkeys, for one who lost them all: their session registers a first again. Their keys and workspaces stay as they are.

Request

FieldTypeWhat it is
idstring

Response

FieldTypeWhat it is
clearedinteger (int32)cleared is how many passkeys the person had.

POST /spin.v1.AdminService/CreateHostClass

Request

FieldTypeWhat it is
classHostClass

Response

FieldTypeWhat it is
classHostClass

POST /spin.v1.AdminService/CreateNetworkPolicy

Request

FieldTypeWhat it is
policyNetworkPolicyRule

Response

No fields: {}.

POST /spin.v1.AdminService/CreateResourcePreset

Create a resource preset

Request

FieldTypeWhat it is
namestringRequired: display name
descriptionstringOptional: description
cpuCoresinteger (int32)Required: CPU cores
memoryMbinteger (int32)Required: memory in MB
diskGbinteger (int32)Required: disk in GB
burstBurstModeRequired
isDefaultbooleanOptional: make this the default
enabledbooleanOptional: enable the preset (default true)
sortOrderinteger (int32)Optional: display order
burstFloorCpuCoresinteger (int32)Required for a burst mode: what its workspaces start with, at most the preset’s size.
burstFloorMemoryMbinteger (int32)
bandwidthMbpsinteger or null (int32)What a workspace of it may carry each way, in megabits a second. Present, since 0 - unshaped - is an answer; absent, the installation’s default.
rpoSecondsinteger (int32)How far behind the object store a workspace of it may fall, in seconds; 0 is the installation’s.
hostClassstringThe host class its workspaces run on; empty is the default.

Response

FieldTypeWhat it is
presetResourcePreset

POST /spin.v1.AdminService/DecideConfigChange

Apply a change the file proposes, or dismiss it. Either is remembered until the file says something else again. Audited with the admin who decided.

Request

FieldTypeWhat it is
kindConfigItemKind
namestring
saysstringConfigChange.says, as listed.
applybooleanTrue writes what the file says; false keeps what the installation has.

Response

No fields: {}.

POST /spin.v1.AdminService/DeleteHostClass

Request

FieldTypeWhat it is
namestring

Response

No fields: {}.

POST /spin.v1.AdminService/DeleteNetworkPolicy

Refused while a workspace runs under the policy or it is the installation’s default.

Request

FieldTypeWhat it is
namestring

Response

No fields: {}.

POST /spin.v1.AdminService/DeleteResourcePreset

Delete a resource preset

Request

FieldTypeWhat it is
idstringRequired: preset ID to delete

Response

No fields: {}.

POST /spin.v1.AdminService/ExplainStorageKey

What one key in the store is, and whose: a key read off the bucket’s console says nothing a person can act on.

Request

FieldTypeWhat it is
keystring

Response

FieldTypeWhat it is
whatstringWhat the object is, in words.
volumeStoredVolumeWhose it is, when it is a volume’s.

POST /spin.v1.AdminService/GetBill

What the installation cost in a month, as its cloud’s bill says: by day and service, what the month is forecast to end at, and its budget. As the control plane last read the bill - a few times a day (internal/controlplane/domain/bill) - never the cloud itself, where every question to its billing is billed.

Request

FieldTypeWhat it is
monthTimestampThe month, as any instant in it (UTC’s); unset is the month in progress.

Response

FieldTypeWhat it is
monthTimestampThe month’s first instant, UTC.
readAtTimestampWhen the bill was last read; unset where it never was - no scope (bill_scope), or a cloud that sends none - and then nothing below is known.
currencystringISO 4217; every amount here is in millionths of it.
totalMicrosstring (int64)The month so far, every day and service.
forecastMicrosstring or null (int64)What the month is forecast to end at; unset where the cloud has no forecast yet.
budgetLimitMicrosstring or null (int64)The installation’s budget and what the cloud counts against it; unset where it has none.
budgetActualMicrosstring or null (int64)
budgetForecastMicrosstring or null (int64)
dayslist of BillDayOldest first.

POST /spin.v1.AdminService/GetCosts

A month of the bill shared out to the workspaces that caused it: the runners’ by what each workspace held of them, the volumes’ bucket by what its volumes kept. What nobody caused is said apart and never spread: the runners’ capacity nobody held, the bucket’s bytes no workspace keeps, and the platform’s own cost by role and service; and, from those, what the installation costs a day with nobody working (internal/controlplane/domain/finops).

Request

FieldTypeWhat it is
monthTimestampThe month, as any instant in it (UTC’s); unset is the month in progress.

Response

FieldTypeWhat it is
monthTimestampThe month’s first instant, UTC.
currencystringISO 4217; every amount here is in millionths of it.
workspaceslist of WorkspaceCostCostliest first.
idleMicrosstring (int64)What the runners cost that no workspace held.
unstoredMicrosstring (int64)What the volumes’ bucket cost for bytes no workspace keeps: the images, what nothing references any more.
platformlist of PlatformCostEvery other cost - the control plane, the proxy, keys, logs - by role and service, costliest first.
standbyStandbyCostWhat the installation costs a day with nobody working; unset where no day before the reading billed anything.
readAtTimestampWhen the month’s bill was last read; unset where it never was, and then nothing is answered.
trendlist of CostMonthThe year up to this month, oldest first, this month last: each month the bill was read in, shared out as this one is. A month never read is not among them.

POST /spin.v1.AdminService/GetEmailSettings

The SMTP server the installation tells people through. The password is never read back.

Request

No fields: {}.

Response

FieldTypeWhat it is
settingsEmailSettings

POST /spin.v1.AdminService/GetFleetVersions

What is running where: this control plane, each host’s runner and machine, and the extension releases workspaces are on. An installation is updated in halves, and this is the one page that says which halves it is in.

Request

No fields: {}.

Response

FieldTypeWhat it is
controlPlaneVersionstring
machineVersionstringThe spin-machine release this control plane pins, which a host should be running.
hostslist of FleetHostVersion
extensionslist of ExtensionVersion

POST /spin.v1.AdminService/GetInstallationHealth

Whether anything is wrong with the installation, in one answer: each part from what the control plane already knows of it - its database, the database’s archive, the log store, the collector, its jobs, its hosts and the workspaces waiting for one.

Request

No fields: {}.

Response

FieldTypeWhat it is
statusHealthStatusstatus is the worst of the checks’.
checkslist of HealthCheckOne per part the installation has: a part it does not have - a database archive on a development stack, a log store where none is kept, a collector that never reported, jobs on a control plane that does not lead - is left out rather than answered for.

POST /spin.v1.AdminService/GetMonitoring

The Grafana the control plane serves over the installation’s metrics, and the release’s dashboards in it.

Request

No fields: {}.

Response

FieldTypeWhat it is
grafanaGrafanaUnset where the control plane serves none: the installation keeps no metrics, or this machine has no Grafana.

POST /spin.v1.AdminService/GetPlatformImages

Whether the base image and the supervisor this control plane’s image carries are published.

Request

No fields: {}.

Response

FieldTypeWhat it is
imageslist of PlatformImageEmpty until the object store is configured: there is nowhere to publish to.
baseImageslist of BaseImageEvery base image published, one per machine release, newest first.
supervisorReleaseslist of ExtensionReleaseEvery release of the supervisor, newest first.
agentReleaseslist of ExtensionReleaseEvery release of the agents’ programs (Claude Code, Codex and T3 Code, one extension), newest first.

POST /spin.v1.AdminService/GetRunbook

One runbook, its markdown and where its file is at the pinned commit. NOT_FOUND for an id this release’s runbooks do not have.

Request

FieldTypeWhat it is
idstring

Response

FieldTypeWhat it is
runbookRunbook
markdownstringIts body, markdown without the front matter: the app renders it and nothing else (no raw HTML).
sourceUrlstringThe file at the commit this release pins, to propose a change from.

POST /spin.v1.AdminService/GetSettings

Every setting of the installation as it is in force, and what each is: its type, its default, its bounds, what it reaches when saved and who writes it (internal/controlplane/settings, the one registry the file, the dashboard and the CLI are made from).

Request

No fields: {}.

Response

FieldTypeWhat it is
valuesmap of string to stringEvery definition’s value in force, by key, as text of its type: what the installation says, or the default where it says nothing. The control plane’s own are left out.
definitionslist of SettingDefinitionEvery setting an administrator is shown, in the registry’s order.
runningWorkspacesinteger (int32)How many workspaces are running now: what a RUNNING_WORKSPACES setting reaches, and what a NEW_WORKSPACES one leaves as it is.
connectedRunnersinteger or null (int32)How many runners hold their stream to this control plane now: what a NEXT_HEARTBEAT setting reaches. Unset where this control plane cannot tell.
placeInstallationPlaceWhere the installation runs and what it runs, read-only.

POST /spin.v1.AdminService/GetStorageSettings

Where the installation’s object store is. The secret is never read back.

Request

No fields: {}.

Response

FieldTypeWhat it is
settingsStorageSettings
volumesExistbooleanWhether volumes exist, whose history is in this store: it can then be changed, but not for another bucket or directory.

POST /spin.v1.AdminService/GetStorageUsage

What the store holds, by what each object is for: every volume’s objects and the layers its commits name, with the workspace, image or extension release it is. As the storage-gc job last read it - daily, or when an admin runs it - never the bucket itself.

Request

No fields: {}.

Response

FieldTypeWhat it is
volumeslist of StoredVolumeHeaviest first.
unreferencedLayersStorageTallyLayers no commit in the store names: the storage GC’s to collect.
otherStorageTallyEverything outside volumes/ and layers/: the control planes’ claims to lead, the owners’ words kept per workspace, the rosters and keyrings, the writers’ keys and the identity records.
measuredAtTimestamp

POST /spin.v1.AdminService/GetTelemetryStatus

What the collector has sent and failed to send over its last minute, as the watch on its machine read it from the collector itself.

Request

No fields: {}.

Response

FieldTypeWhat it is
reportedAtTimestampUnset: the watch has not reported since this control plane started - no collector, or not yet.
windowSecondsinteger (int32)How long the counts below are over.
spansTelemetryFlowInto the installation’s store, after the traces policy chose which to keep.
samplesTelemetryFlowInto the installation’s store of metrics.
perVolumeHistogramslist of stringThe metrics that cost most to keep, a histogram per volume, which a surface may offer to drop as one (the setting telemetry_metrics_drop).

POST /spin.v1.AdminService/GetThirdPartyTerms

The software this installation downloads from its makers, the terms it is used under, and which of it an administrator accepted the terms for: who, when, and which text. Nothing is downloaded of an item whose terms are not accepted (internal/controlplane/thirdparty).

Request

No fields: {}.

Response

FieldTypeWhat it is
termsVersionstringThe version of the text below, which an acceptance names.
textlist of stringThe terms, a paragraph each.
itemslist of ThirdPartyTermsItem

POST /spin.v1.AdminService/GetUserWorkspaceEgress

Where a workspace sends, as its owner’s GetWorkspaceEgress answers it: the host’s counters by destination, nothing of what was carried. Audited, as a reading of somebody else’s.

Request

FieldTypeWhat it is
workspaceIdstringThe workspace’s id.
reasonstringWhy, kept on the audit entry.

Response

FieldTypeWhat it is
egressGetWorkspaceEgressResponse

POST /spin.v1.AdminService/GetVSCodeServers

The VS Code servers workspaces are given (the vscode-server extension): each release, and the publish this control plane ran since it started, if it ran one.

Request

No fields: {}.

Response

FieldTypeWhat it is
releaseslist of ExtensionReleaseNewest first.
publishVSCodeServerPublish
unavailablestringWhy this control plane cannot publish - no object store, or a build with no machine tools to make the image with - and empty when it can.

POST /spin.v1.AdminService/GetWorkspaceNames

The names of the workspaces ids are, whoever owns them and whatever state they are in, a deleted one among them: a record of the platform’s logs names a workspace by its id, and ListWorkspaces is the caller’s own. An id the installation no longer holds a row for is left out of the answer.

Request

FieldTypeWhat it is
idslist of stringAt most 500: the ids a page of records names.

Response

FieldTypeWhat it is
namesmap of string to stringEach id asked for that the installation holds a row for, to its workspace’s name.

POST /spin.v1.AdminService/ListAlerts

What the release’s alert rules said in the installation’s Grafana, newest first: each firing and each resolution the control plane heard, with its runbook and how many administrators it reached.

Request

No fields: {}.

Response

FieldTypeWhat it is
alertslist of Alert

POST /spin.v1.AdminService/ListAllowedEmails

List allowed emails/domains

Request

FieldTypeWhat it is
pagePageRequest

Response

FieldTypeWhat it is
entrieslist of AllowedEmail
pagePageResponse

POST /spin.v1.AdminService/ListAuditLog

Read the audit log, newest first. There is no RPC that writes one: an entry is written by the operation it records, so a log an API could add to would be one an API could forge.

Request

FieldTypeWhat it is
pagePageRequest
actorIdstringEach filter is optional and they are combined with AND; an empty request is the whole log, newest first.
actionstring
resourceTypestring
sinceTimestampsince bounds the listing at the older end; an audit log is read forward from an incident, and the whole of one is not what a page wants.
excludeActionslist of stringexclude_actions are actions left out: every sign-in of an installation outnumbers what was done on it, and the one action filter can name what to see but not what to look past.

Response

FieldTypeWhat it is
entrieslist of AuditEntry
pagePageResponse
actionslist of stringactions and resource_types are every value this installation can record, so a reader building a filter does not have to know them. They come from the code rather than from a DISTINCT over the log: the log is the one table that only grows, and a vocabulary that is empty until something happens is a filter that is empty when it matters.
resourceTypeslist of string
totalCappedbooleantotal_capped says page.total_count is where counting stopped, not the count: the log is counted up to a bound, since counting all of it is reading all of it on every page.

POST /spin.v1.AdminService/ListConfigChanges

What the config file says now and the installation does not, for an administrator to decide: the file seeds an installation once, and after that its changes are proposals.

Request

No fields: {}.

Response

FieldTypeWhat it is
changeslist of ConfigChange

POST /spin.v1.AdminService/ListHostClasses

Request

No fields: {}.

Response

FieldTypeWhat it is
classeslist of HostClass

POST /spin.v1.AdminService/ListHostProblems

What is wrong with the fleet’s hosts, one problem per host that is not connected or fails a check of its own: the same problems GetInstallationHealth’s HOSTS part lists, for the pages that read one host or the fleet and nothing else of the installation.

Request

FieldTypeWhat it is
hostIdstringThe one host asked about; empty for every host of the fleet.

Response

FieldTypeWhat it is
problemslist of ProblemAt most 20, hosts that are not connected first; problem_count is how many there are.
problemCountinteger (int32)

POST /spin.v1.AdminService/ListJobRuns

One job’s runs, newest first.

Request

FieldTypeWhat it is
jobstring
limitinteger (int32)At most this many, newest first; zero is the default of 50.

Response

FieldTypeWhat it is
runslist of JobRun

POST /spin.v1.AdminService/ListJobs

The control plane’s periodic work - backups, cleanups, the object store’s garbage collection - with how often each runs and how its last run went.

Request

No fields: {}.

Response

FieldTypeWhat it is
jobslist of Job

POST /spin.v1.AdminService/ListRefusedVolumes

The disks a host refuses to serve, each with the workspace it is the disk of and whose that is. Audited.

Request

No fields: {}.

Response

FieldTypeWhat it is
volumeslist of RefusedVolume

POST /spin.v1.AdminService/ListRekeys

The disks being re-keyed, and the ones a revoked host’s keys marked for it.

Request

No fields: {}.

Response

FieldTypeWhat it is
rekeyslist of VolumeRekey

POST /spin.v1.AdminService/ListResourcePresets

List resource presets

Request

FieldTypeWhat it is
includeDisabledbooleanInclude disabled presets (admin only)
pagePageRequest

Response

FieldTypeWhat it is
presetslist of ResourcePreset
pagePageResponse

POST /spin.v1.AdminService/ListRunbooks

What an operator does when an alert fires, a job fails or an owner is told something went wrong: spin-stack/runbooks at the commit this release pins, served so it is read in the app.

Request

No fields: {}.

Response

FieldTypeWhat it is
runbookslist of Runbook

POST /spin.v1.AdminService/ListTimeline

What happened, newest first, between two instants, to one workspace, host, team or project, or to the whole installation: read from the audit log, the workspaces’ events, the jobs’ failed runs and the projects’ prebuilds as they are, never copied. Sign-ins and what is done inside a workspace (a session, a command) are the audit log’s alone: they outnumber everything else.

Request

FieldTypeWhat it is
sinceTimestampInclusive; unset reads from as far back as the records go.
untilTimestampExclusive; unset is now.
pagePageRequestpage_size is at most 200, and zero is 50. total_count is not counted.

Response

FieldTypeWhat it is
eventslist of TimelineEvent
pagePageResponse
keptDaysinteger (int32)kept_days is how long what the timeline reads is kept (ListWorkspaceTimelineResponse).

POST /spin.v1.AdminService/ListUserAPIKeys

List another user’s API keys. The secret is never stored, so this is what an admin can know about a key: what it is called, when it was made, when it was last used.

Request

FieldTypeWhat it is
userIdstring
pagePageRequest

Response

FieldTypeWhat it is
apiKeyslist of APIKey
pagePageResponse

POST /spin.v1.AdminService/ListUsers

List all users

Request

FieldTypeWhat it is
pagePageRequest
querystringOptional: filter by name or email
adminsOnlybooleanOptional: only return admin users

Response

FieldTypeWhat it is
userslist of User
pagePageResponse
holdingsmap of string to UserHoldingsWhat each listed user still holds, by user id: what an administrator asks before taking access away. Kept off User, which other calls return without it.
refusedRemovalsmap of string to stringWhy removing a listed user as an administrator, or disabling them, would be refused, by user id; absent where it would not be. The refusal is the database’s (lockout), so a client that never reads this is refused the same.

POST /spin.v1.AdminService/PublishVSCodeServers

Publish the servers of the newest stable VS Code releases, or of the commits named, as a new release. Answers once the publish has begun - it downloads a gigabyte - and GetVSCodeServers says how it goes.

Request

FieldTypeWhat it is
newestinteger (int32)The newest stable releases to carry: 2 is the current one and the one before it.
commitslist of stringCommits to carry besides, each the second line of code --version.

Response

No fields: {}.

POST /spin.v1.AdminService/RecoverUserWorkspace

Move a workspace off a host that is gone, as its owner’s RecoverWorkspace does, and with the same question first: without accept_data_loss it answers what the move would give up and changes nothing. The work given up is its owner’s, so a reason is required, kept on the audit entry, and written with who asked on the workspace’s history, which its owner reads (WORKSPACE_EVENT_TYPE_RECOVERED_BY_ADMIN). Refused for a workspace held in quarantine.

Request

FieldTypeWhat it is
workspaceIdstringThe workspace’s id.
acceptDataLossbooleanFalse asks what it would cost. True accepts that cost, for its owner, and does it.
reasonstringWhy: required, kept on the audit entry and on the workspace’s history for its owner.

Response

FieldTypeWhat it is
recoveryRecoverWorkspaceResponse

POST /spin.v1.AdminService/RekeyVolume

Re-key a workspace’s disk: copy it whole under a key of its own, point the workspace at the copy, and delete the disk - which shreds the key assumed taken and every snapshot of the disk, since those are what that key opens. The workspace must be stopped or quarantined. Refused for a disk something descends from. Audited.

Request

FieldTypeWhat it is
workspaceIdstring

Response

FieldTypeWhat it is
targetVolumeIdstring

POST /spin.v1.AdminService/RemoveAllowedEmail

Remove allowed email/domain

Request

FieldTypeWhat it is
idstring

Response

No fields: {}.

POST /spin.v1.AdminService/RemoveStoredVolume

Remove an image, an extension release, an unclaimed volume or an orphan from the store: its row, then its volume, whose key is shredded; storage-gc collects its layers on its next run. Refused for one that is kept (StoredVolume.kept_because), one placed on a host, and a workspace’s disk. Audited.

Request

FieldTypeWhat it is
volumeIdstring

Response

No fields: {}.

POST /spin.v1.AdminService/RetryPlatformImages

Look again now rather than when the next retry is due.

Request

No fields: {}.

Response

No fields: {}.

POST /spin.v1.AdminService/RevokeThirdPartyTerms

Take the acceptance back for the items named: nothing more of them is downloaded. What was downloaded already stays until an administrator removes it.

Request

FieldTypeWhat it is
itemslist of ThirdPartyItem

Response

No fields: {}.

POST /spin.v1.AdminService/RevokeUserAPIKey

Revoke another user’s API key - the offboarding an admin cannot do by asking the user, who may already be gone. It is audited with the admin who did it.

Request

FieldTypeWhat it is
userIdstring
idstring

Response

No fields: {}.

POST /spin.v1.AdminService/RunJobNow

Run a job now rather than when it is next due. Refused while it is running: a second run alongside the first would do the same work twice. Audited with the admin who asked.

Request

FieldTypeWhat it is
jobstring

Response

No fields: {}.

POST /spin.v1.AdminService/SendTestAlert

Has Grafana test its contact point, which sends a test alert the whole way an alert goes: Grafana, the control plane, an email to every administrator who has not opted out. FAILED_PRECONDITION where this control plane serves no Grafana, or Grafana could not reach the control plane.

Request

No fields: {}.

Response

No fields: {}.

POST /spin.v1.AdminService/SetSettings

Writes the settings named, each checked by its definition and all of them together before any is written: a refused one writes nothing.

Request

FieldTypeWhat it is
valuesmap of string to stringThe settings to write, by key, as text of each one’s type. Only ADMIN settings are taken.

Response

FieldTypeWhat it is
valuesmap of string to stringEvery value in force once written, as GetSettings answers them.

POST /spin.v1.AdminService/StopUserWorkspace

Stop a workspace, as its owner’s StopWorkspace does: one whose stop could not publish its disk runs on and holds its host until somebody stops it. Audited.

Request

FieldTypeWhat it is
workspaceIdstringThe workspace’s id: an administrator names no workspace of somebody else’s by its name.
forcebooleanGive up what only its host has rather than publish it first, as StopWorkspace’s force does.
reasonstringWhy, kept on the audit entry.

Response

FieldTypeWhat it is
workspaceIdstring
namestring
stateWorkspaceState

POST /spin.v1.AdminService/UntagImage

Take a ref off what it names: no new workspace gets those bytes by it, the disks cloned from them go on reading them, and a later publish under the ref tags the new bytes. Audited.

Request

FieldTypeWhat it is
refstring

Response

No fields: {}.

POST /spin.v1.AdminService/UpdateEmailSettings

Set the SMTP server, checked against it - connected to and signed in to - before it is written. An empty host turns email off.

Request

FieldTypeWhat it is
hoststring
portinteger (int32)
usernamestring
passwordstring or nullAbsent keeps the password there is.
fromstring

Response

FieldTypeWhat it is
settingsEmailSettings

POST /spin.v1.AdminService/UpdateHostClass

Request

FieldTypeWhat it is
classHostClass

Response

FieldTypeWhat it is
classHostClass

POST /spin.v1.AdminService/UpdateNetworkPolicy

Request

FieldTypeWhat it is
policyNetworkPolicyRule

Response

No fields: {}.

POST /spin.v1.AdminService/UpdateResourcePreset

Update a resource preset

Request

FieldTypeWhat it is
idstringRequired: preset ID to update
namestringOptional: new display name
descriptionstringOptional: new description
cpuCoresinteger (int32)Optional: new CPU cores
memoryMbinteger (int32)Optional: new memory
diskGbinteger (int32)Optional: new disk
burstBurstModeOptional: new burst mode
isDefaultbooleanOptional: make this the default
enabledbooleanOptional: enable/disable
sortOrderinteger (int32)Optional: new display order
burstFloorCpuCoresinteger (int32)Optional: new burst floor
burstFloorMemoryMbinteger (int32)Optional: new burst floor
bandwidthMbpsinteger or null (int32)Optional: a new bandwidth. Present, since zero - unshaped - is an answer and not “keep”.
rpoSecondsinteger or null (int32)Optional: a new RPO. Present, since zero - the installation’s - is an answer and not “keep”.
hostClassstringOptional: a new host class; empty keeps it. Its workspaces made before keep theirs.

Response

FieldTypeWhat it is
presetResourcePreset

POST /spin.v1.AdminService/UpdateStorageSettings

Set where the object store is, checked against it before it is written; every control plane restarts within seconds to open it. Another store while volumes exist is refused.

Request

FieldTypeWhat it is
bucketstring
endpointstring
regionstring
accessKeyIdstring
secretAccessKeystring or nullAbsent keeps the secret there is.
dirstring
principalstring

Response

FieldTypeWhat it is
settingsStorageSettings

POST /spin.v1.AdminService/UpdateUser

Update user (can toggle is_instance_admin, disable user)

Request

FieldTypeWhat it is
idstringRequired: user ID
isInstanceAdminboolean or nullToggle admin status
disabledboolean or nullDisable/enable user
disabledReasonstring or nullReason for disabling (shown to user)

Response

FieldTypeWhat it is
userUser

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.