Skip to main content
POST
Issue a short-lived ticket for the caller's KasmVNC desktop

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
workspaceId
string
required

Caller's own workspace runtime id (matches agent.workspace.runtime.workspaceId returned by GET /api/user/agents/workspace/me). The endpoint only issues tickets for a workspace owned by req.user._id and in status: 'ready'.

Example:

"pria-ws-7a3f9"

Response

Ticket issued.

success
boolean
Example:

true

workspaceId
string

Echo of the validated workspace id.

vncUrl
string

Fully-qualified WebSocket URL (ws:// or wss://, matching the current request scheme) that the browser opens to reach the KasmVNC desktop. Includes the single-use ticket query param.

Example:

"wss://pria.praxislxp.com/api/agents/workspace/vnc/pria-ws-7a3f9?ticket=eyJhbGciOi..."

vncPassword
string

RFB-protocol password required by KasmVNC during the WebSocket handshake. This is in addition to the HTTP Basic auth handled server-side by the proxy. The browser never persists it — single use per RFB handshake for the lifetime of the ticket.

expiresInSec
integer

Ticket TTL in seconds (currently fixed at 60).

Example:

60