Ludus 2 is in BETA. This API is subject to change until Ludus 2 is released.

Connect to VM Console WebSocket

Cloud Mock

https://mock.apidog.com/m1/1126461-0-default

GET

/vm/console/view

Upgrades the connection to a WebSocket for VNC streaming. Requires a valid ticket obtained from /vm/console/ticket

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

Query Params

⚪101Switching Protocols - Connection upgraded to WebSocket

This response does not have a body.

🟠400Missing ticket

🟠403Invalid or expired ticket

🔴502Failed to connect to Hypervisor VNC stream

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://mock.apidog.com/m1/1126461-0-default/vm/console/view?ticket' \
--header 'X-API-KEY: <api-key>'

Response Example

400 - Example 1

{
    "error": "string"
}

Modified at 2025-12-04 04:59:18