Sign in

v1

latestOpenAPI 3.0.02026-07-2248161142.3 KB
VNC Management

Get VNC status

This endpoint retrieves the current status of the VNC session 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, and valid_until parameters to get the VNC session status.

post/kvm/v2/get/vnc/status

Response

VNC status retrieved successfully.

statusstring

The status of the operation.

vnc_statusstring

The current VNC status (e.g., enabled, disabled).

novnc_portinteger

The noVNC port for web-based access.

vnc_portstring

The port used for VNC connections.

vnc_hoststring

The VNC host address.

Example response

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