Open a VM serial console WebSocket

GET

/vm/{rid}/console

const url = 'https://sylve.lan:8181/api/vm/1/console?baudrate=115200&auth=example';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

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/vm/1/console?baudrate=115200&auth=example' \
  --header 'Authorization: <Authorization>'

Validate the VM serial console and upgrade to an authenticated interactive WebSocket session

Authorizations

BearerAuth

Parameters

Path Parameters

rid

required

integer

Virtual Machine RID

Query Parameters

baudrate

integer

default: 115200

Serial baud rate

auth

required

string

Hex-encoded WebSocket authentication payload

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

VM Not Found

object

data

error

string

message

string

status

string

409

Conflict

object

data

error

string

message

string

status

string

500

Internal Server Error

object

data

error

string

message

string

status

string

503

Service Unavailable

object

data

error

string

message

string

status

string