Replace virtual machine VNC configuration

PUT

/vm/{rid}/hardware/vnc

curl --request PUT \
  --url https://sylve.lan:8181/api/vm/1/hardware/vnc \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "vncBind": "example", "vncEnabled": true, "vncPassword": "example", "vncPort": 1, "vncResolution": "example", "vncWait": true }'

Replace the VNC configuration of a shut-off virtual machine; an empty password clears VNC authentication

Authorizations

• BearerAuth

Parameters

Path Parameters

rid

required

integer

>= 1

Virtual Machine RID

Request Body

VNC configuration

Media typeapplication/json

object

vncBind

string

vncEnabled

required

boolean

vncPassword

string

vncPort

integer

vncResolution

required

string

vncWait

required

boolean

Example^generated

{
  "vncBind": "example",
  "vncEnabled": true,
  "vncPassword": "example",
  "vncPort": 1,
  "vncResolution": "example",
  "vncWait": true
}

Responses

200

Success

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}