curl --request POST \
--url https://{api_host}/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=1737476000import requests
url = "https://{api_host}/kvm/v2/get/vnc/status"
payload = {
"signature": "session_signature_12345",
"kvm_id": "kvm_123456_789012",
"valid_until": "1737476000"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/x-www-form-urlencoded'},
body: new URLSearchParams({
signature: 'session_signature_12345',
kvm_id: 'kvm_123456_789012',
valid_until: '1737476000'
})
};
fetch('https://{api_host}/kvm/v2/get/vnc/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_host}/kvm/v2/get/vnc/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "signature=session_signature_12345&kvm_id=kvm_123456_789012&valid_until=1737476000",
CURLOPT_HTTPHEADER => [
"Content-Type: application/x-www-form-urlencoded"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{api_host}/kvm/v2/get/vnc/status"
payload := strings.NewReader("signature=session_signature_12345&kvm_id=kvm_123456_789012&valid_until=1737476000")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{api_host}/kvm/v2/get/vnc/status")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("signature=session_signature_12345&kvm_id=kvm_123456_789012&valid_until=1737476000")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_host}/kvm/v2/get/vnc/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "signature=session_signature_12345&kvm_id=kvm_123456_789012&valid_until=1737476000"
response = http.request(request)
puts response.read_body{
"status": "success",
"vnc_status": "enabled",
"novnc_port": 6080,
"vnc_port": "5901",
"vnc_host": "example.edis.at"
}{
"status": "error",
"error": "Missing required field: kvm_id"
}{
"status": "error",
"error": "Session signature has expired"
}{
"status": "error",
"error": "You do not have permission to perform this operation"
}{
"status": "error",
"error": "An unexpected error occurred, please try again later"
}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.
curl --request POST \
--url https://{api_host}/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=1737476000import requests
url = "https://{api_host}/kvm/v2/get/vnc/status"
payload = {
"signature": "session_signature_12345",
"kvm_id": "kvm_123456_789012",
"valid_until": "1737476000"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/x-www-form-urlencoded'},
body: new URLSearchParams({
signature: 'session_signature_12345',
kvm_id: 'kvm_123456_789012',
valid_until: '1737476000'
})
};
fetch('https://{api_host}/kvm/v2/get/vnc/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_host}/kvm/v2/get/vnc/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "signature=session_signature_12345&kvm_id=kvm_123456_789012&valid_until=1737476000",
CURLOPT_HTTPHEADER => [
"Content-Type: application/x-www-form-urlencoded"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{api_host}/kvm/v2/get/vnc/status"
payload := strings.NewReader("signature=session_signature_12345&kvm_id=kvm_123456_789012&valid_until=1737476000")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{api_host}/kvm/v2/get/vnc/status")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("signature=session_signature_12345&kvm_id=kvm_123456_789012&valid_until=1737476000")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_host}/kvm/v2/get/vnc/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "signature=session_signature_12345&kvm_id=kvm_123456_789012&valid_until=1737476000"
response = http.request(request)
puts response.read_body{
"status": "success",
"vnc_status": "enabled",
"novnc_port": 6080,
"vnc_port": "5901",
"vnc_host": "example.edis.at"
}{
"status": "error",
"error": "Missing required field: kvm_id"
}{
"status": "error",
"error": "Session signature has expired"
}{
"status": "error",
"error": "You do not have permission to perform this operation"
}{
"status": "error",
"error": "An unexpected error occurred, please try again later"
}Body
Required parameters to retrieve the VNC session status.
All parameters must be passed in the request body as application/x-www-form-urlencoded.
The session signature obtained from the "Create AUTH-session" call.
"session_signature_12345"
The unique identifier of the KVM VPS to check the VNC status.
This value is specific to your VPS.
"kvm_123456_789012"
The expiration timestamp for the session, as obtained from the "Create AUTH-session" call.
Ensure that the session is valid and has not expired.
"1737476000"
Response
VNC status retrieved successfully.
The status of the operation.
"success"
The current VNC status (e.g., enabled, disabled).
"enabled"
The noVNC port for web-based access.
6080
The port used for VNC connections.
"5901"
The VNC host address.
"example.edis.at"
Was this page helpful?