Skip to content
Hayonix

API reference · Schema

TerminalTicket

  • objectstringrequired

    Always `terminal_ticket`: the type of this object

    One ofterminal_ticket

  • ticketstringrequired

    Single-use credential for one terminal; already in `websocket_path`

  • expires_atstring (date-time)required

    When it expires (null: never) (ISO 8601, UTC)

  • websocket_pathstringrequired

    Open 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