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

ExecService

View Markdown

ExecService runs commands and moves files in a running workspace, as its root, for a caller who. is no terminal: a program or an agent holding a key with workspace:exec. The control plane logs. in over the same session a terminal’s goes over (a host’s stream from the guest’s vsock, met at. the control plane rather than at the relay) with a certificate of its own for five minutes, and. every call is recorded with who made it and on which credential (audit: workspace_exec).

POST /spin.v1.ExecService/Exec

Runs command in the workspace’s login shell and answers once it has exited, or once timeout has passed: stdin is all of it, given at once, and stdout and stderr are kept up to a bound each.

Request

FieldTypeWhat it is
workspaceIdstring
commandstringcommand is a line for the workspace’s shell, as ssh <workspace> <command> takes one.
stdinstring (byte)
timeoutDurationtimeout bounds the command, past which it is ended and answered as timed out; unset is a minute, and more than ten is refused.

Response

FieldTypeWhat it is
exitCodeinteger (int32)exit_code is the command’s exit status; -1 when it ended on a signal or was ended for its timeout.
stdoutstring (byte)
stderrstring (byte)
truncatedbooleantruncated says stdout or stderr ran past the bound kept of each, and the rest is not here.
timedOutbooleantimed_out says the command was ended for its timeout.

POST /spin.v1.ExecService/ReadFile

Reads a file of the workspace’s, whole, up to a bound.

Request

FieldTypeWhat it is
workspaceIdstring
pathstringpath is absolute, or relative to root’s home.

Response

FieldTypeWhat it is
contentstring (byte)

POST /spin.v1.ExecService/WriteFile

Writes a file of the workspace’s, whole, making the directories it is in.

Request

FieldTypeWhat it is
workspaceIdstring
pathstringpath is absolute, or relative to root’s home.
contentstring (byte)

Response

No fields: {}.

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.