v4

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-05-09283767.7 KB

console

Mint a console token

Returns a short-lived token and WebSocket path. Open a WebSocket to wss://<host><websocketPath>?session=<token> to attach to the VM's serial console. The WebSocket endpoint itself is intentionally not modeled in this spec because it uses a capability-URL flow (no API key on upgrade) and a custom binary/text protocol. See src/fastvm/lib/console.py in the Python SDK for a reference client.

post/v1/vms/{id}/console-token

Response

Console token

tokenstring required

expiresInSecinteger required

websocketPathstring uri-reference required

Relative WebSocket path; combine with your API host as wss://<host><websocketPath>?session=<token>.