EDedisglobal
VNC Management

Enable VNC access

This endpoint enables VNC access for a specified KVM VPS.
The api_host parameter, obtained from the "Create AUTH-session" response,
is dynamically set in the URL.
Provide the signature, kvm_id, valid_until, and vnc_pw parameters to activate VNC.

post/kvm/v2/set/vnc/enable

Request

Request body application/x-www-form-urlencoded

signaturestring

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

kvm_idstring

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

valid_untilstring

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

vnc_pwstring

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 request

{
  "signature": "session_signature_12345",
  "kvm_id": "kvm_123456_789012",
  "valid_until": "1737476000",
  "vnc_pw": "securepassword123"
}

Response

VNC access enabled successfully.

statusstring

The status of the operation.

vnc_statusstring

The new VNC status.

novnc_portinteger

The noVNC web-based access port.

vnc_portinteger

The VNC port for client connections.

vnc_hoststring

The VNC server host address.

Example response

{
  "status": "success",
  "vnc_status": "enabled",
  "novnc_port": 6080,
  "vnc_port": 5901,
  "vnc_host": "example.edis.at"
}

Changes

No recorded changes to this operation across all 1 revision of this API.