Open a VM VNC WebSocket

GET

/vnc/{port}

const url = 'https://sylve.lan:8181/api/vnc/1?auth=example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://sylve.lan:8181/api/vnc/1?auth=example'

Validate the requested VM-owned VNC port and upgrade to the existing authenticated WebSocket relay. This documents the HTTP handshake, not WebSocket frames.

Parameters

Path Parameters

port

required

integer

>= 1 <= 65535

VM-owned VNC port

Query Parameters

auth

required

string

Opaque hex-encoded WebSocket authentication payload

overtake

boolean

Take over an existing VNC session

Responses

101

Switching Protocols

string

400

Bad Request

object

data

error

string

message

string

status

string

401

Unauthorized

object

data

error

string

message

string

status

string

403

Forbidden

object

data

error

string

message

string

status

string

404

VNC Port Not Found

object

data

error

string

message

string

status

string

500

Internal Server Error

object

data

error

string

message

string

status

string

502

Bad Gateway

object

data

error

string

message

string

status

string

503

Service Unavailable

object

data

error

string

message

string

status

string