Shell Access

Runsite provides interactive shell access to running web service containers via WebSocket. Use it for debugging, inspecting logs, or running one-off commands.

Connecting

WS /api/shell/{web_service_id}?token=<access_token>

Authentication is required via the token query parameter.

Limits

Limit	Value
Session timeout	10 minutes of inactivity
Concurrent sessions	3 per web service

Message Protocol

Client → Server

Type	Description	Payload
input	Terminal input	{ "type": "input", "data": "ls -la\n" }
resize	Terminal resize	{ "type": "resize", "cols": 80, "rows": 24 }
ping	Keep-alive	{ "type": "ping" }

Server → Client

Type	Description	Payload
connected	Session established	{ "type": "connected" }
output	Terminal output	{ "type": "output", "data": "..." }
error	Error message	{ "type": "error", "message": "..." }
pong	Heartbeat response	{ "type": "pong" }

Usage Notes

• The shell connects to the running container of the web service
• Commands execute with the same permissions as the service process
• The session automatically closes after 10 minutes of inactivity
• Send ping messages periodically to keep the connection alive