Skip to main content
POST
/
kvm
/
v2
/
set
/
vnc
/
enable
Enable VNC access
curl --request POST \
  --url https://{api_host}/kvm/v2/set/vnc/enable \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=session_signature_12345 \
  --data kvm_id=kvm_123456_789012 \
  --data valid_until=1737476000 \
  --data vnc_pw=securepassword123
{
  "status": "success",
  "vnc_status": "enabled",
  "novnc_port": 6080,
  "vnc_port": 5901,
  "vnc_host": "example.edis.at"
}

Body

application/x-www-form-urlencoded

Required parameters to enable VNC access.
All parameters must be passed in the request body as application/x-www-form-urlencoded.

​
signature
string

The session signature obtained from the "Create AUTH-session" call.

Example:

"session_signature_12345"

​
kvm_id
string

The unique identifier of the KVM VPS to enable VNC access for.
This value is specific to your VPS.

Example:

"kvm_123456_789012"

​
valid_until
string

The expiration timestamp for the session, as obtained from the "Create AUTH-session" call.
Ensure that the session is valid and has not expired.

Example:

"1737476000"

​
vnc_pw
string

The password to set for the VNC connection.
This password will be required to access the VNC session.

VNC password requirements:

  • Exactly 8 characters long.
  • Only letters (A-Z, a-z) and numbers (0-9).
  • No symbols allowed.
Example:

"securepassword123"

Response

VNC access enabled successfully.

​
status
string

The status of the operation.

Example:

"success"

​
vnc_status
string

The new VNC status.

Example:

"enabled"

​
novnc_port
integer

The noVNC web-based access port.

Example:

6080

​
vnc_port
integer

The VNC port for client connections.

Example:

5901

​
vnc_host
string

The VNC server host address.

Example:

"example.edis.at"