Skip to navigation
Astropods APIDeployments

Open a terminal on a sandbox

View as Markdown
Opens an interactive shell in the sandbox. A sandbox that is still being set up prints a notice and connects once it is ready. When the shell can't open, the server sends the reason as output, then closes the connection. Authenticate with your access token as a bearer token, or from the dashboard with your session.

Handshake

WSS
wss://astropods.com/api/v1/deployments/:id/sandboxes/:name/terminal

Send

sendOpenATerminalOnASandboxstringRequiredformat: "binary"

Keystrokes and pasted text for the shell, as a binary frame of UTF-8 bytes.

OR
sendOpenATerminalOnASandboxobjectRequired
The terminal's size in characters, as a text frame. Send it on open and whenever the size changes.

Receive

receiveOpenATerminalOnASandboxstringRequiredformat: "binary"
Shell output, as a binary frame of raw terminal bytes including escape sequences.