API reference · Schema
TerminalTicket
objectstringrequiredAlways `terminal_ticket`: the type of this object
One of
terminal_ticketticketstringrequiredSingle-use credential for one terminal; already in `websocket_path`
expires_atstring (date-time)requiredWhen it expires (null: never) (ISO 8601, UTC)
websocket_pathstringrequiredOpen a WebSocket to this path on the API origin within the expiry. Single use. From a browser the connection must come from the console origin. Binary frames: stdin (client → server) and terminal output; text frames: JSON control messages — client → {"type":"resize","rows","cols"}, {"type":"signal","signal":"SIGINT"}, {"type":"eof"}; server → {"type":"started"} and finally {"type":"exit","exit_code","error"}.
Example
{
"object": "terminal_ticket",
"ticket": "string",
"expires_at": "2026-01-01T00:00:00.000Z",
"websocket_path": "/v1/pods/pod_01jc5zq4m8k3v6x9t2w7r0b1e4/terminal?ticket=ttk_…"
}Used by
- A single-use ticket (valid for seconds) to open the pod’s terminal WebSocket
POST /v1/pods/{pod_id}/terminal-tickets