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

HostShellService

View Markdown

HostShellService is a root shell on a host, asked for by an administrator, for a while, with a. reason (spin#712). The host is emptied of its workspaces first - unless the request is an. incident’s, which says so - and retired after, whatever happened in it: once a person has had root. on a host it runs no workspace again. Every session is recorded by the control plane, which. carries it; the terminal itself is a WebSocket at /api/host-shells/<id>/terminal. (internal/hostshell).

POST /spin.v1.HostShellService/ApproveHostShell

Approves a shell another administrator asked for.

Request

FieldTypeWhat it is
idstring

Response

FieldTypeWhat it is
shellHostShell

POST /spin.v1.HostShellService/CloseHostShell

Ends a shell: one not yet approved is refused, any other is ended and its host retired.

Request

FieldTypeWhat it is
idstring

Response

FieldTypeWhat it is
shellHostShell

POST /spin.v1.HostShellService/GetHostShellRecording

What a shell’s sessions recorded, asciicast v2, each session’s in turn.

Request

FieldTypeWhat it is
idstring

Response

FieldTypeWhat it is
sessionslist of string (byte)Each session’s asciicast v2, in the order they were opened.
truncatedbooleanWhether there was more than one answer carries: the rest is in the bucket, under host-shells/<id>/.

POST /spin.v1.HostShellService/ListHostShells

The installation’s host shells, newest first: all of them, or one host’s.

Request

FieldTypeWhat it is
hostIdstringOne host’s; empty for every host’s.

Response

FieldTypeWhat it is
shellslist of HostShell

POST /spin.v1.HostShellService/RequestHostShell

Asks for a shell on a host. Where the installation has a second administrator approve (host_shell_needs_approval), it waits for one; otherwise the host is emptied at once.

Request

FieldTypeWhat it is
hostIdstring
reasonstringWhy: said to whoever approves it, and kept.
minutesinteger (int32)How long it is open once it opens, up to the installation’s host_shell_max_minutes.
incidentbooleanOpens on the host as it is, its workspaces running: for a host that has to be looked at busy.

Response

FieldTypeWhat it is
shellHostShell

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.