POST
/
kvm
/
v2
/
get
/
vnc
/
status
curl --request POST \
  --url https://{api_host}.edisglobal.com/kvm/v2/get/vnc/status \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=session_signature_12345 \
  --data kvm_id=kvm_123456_789012 \
  --data valid_until=2025-01-12T15:30:00Z
{
  "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 retrieve the VNC session status. 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 check the VNC status.
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:

"2025-01-12T15:30:00Z"

Response

200
application/json
VNC status retrieved successfully.
​
status
string

The status of the operation.

Example:

"success"

​
vnc_status
string

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

Example:

"enabled"

​
novnc_port
integer

The noVNC port for web-based access.

Example:

6080

​
vnc_port
string

The port used for VNC connections.

Example:

"5901"

​
vnc_host
string

The VNC host address.

Example:

"example.edis.at"

Was this page helpful?