curl --request POST \
--url https://{api_host}/kvm/v2/get/details \
--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/details"
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/details', 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/details",
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/details"
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/details")
.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/details")
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",
"data": {
"hw": {
"ram": "5120",
"disk": "46080",
"cpu_set_cores": "socket",
"drive_boost": "102400"
},
"suspended": "n",
"ip": {
"ipv4": [
"192.168.0.101/255.255.255.0",
"192.168.0.102/255.255.255.0"
],
"ipv4_gw": "192.168.0.1",
"ipv4_nm": "255.255.255.0",
"ipv6_gw": "fe80::1",
"ipv6_64": "fe80::/64"
},
"hostname": "example-host"
}
}{
"status": "error",
"error": "Missing required parameter: kvm_id"
}{
"status": "error",
"error": "Invalid session signature"
}{
"status": "error",
"error": "Access to this resource is denied"
}{
"status": "error",
"error": "An unexpected error occurred. Please try again later"
}Basic Details
This endpoint retrieves a few basic details about the 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 obtained
from the same response to access the VPS details.
curl --request POST \
--url https://{api_host}/kvm/v2/get/details \
--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/details"
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/details', 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/details",
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/details"
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/details")
.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/details")
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",
"data": {
"hw": {
"ram": "5120",
"disk": "46080",
"cpu_set_cores": "socket",
"drive_boost": "102400"
},
"suspended": "n",
"ip": {
"ipv4": [
"192.168.0.101/255.255.255.0",
"192.168.0.102/255.255.255.0"
],
"ipv4_gw": "192.168.0.1",
"ipv4_nm": "255.255.255.0",
"ipv6_gw": "fe80::1",
"ipv6_64": "fe80::/64"
},
"hostname": "example-host"
}
}{
"status": "error",
"error": "Missing required parameter: kvm_id"
}{
"status": "error",
"error": "Invalid session signature"
}{
"status": "error",
"error": "Access to this resource is denied"
}{
"status": "error",
"error": "An unexpected error occurred. Please try again later"
}Body
Required parameters to fetch basic details about the KVM VPS.
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 retrieve details for.
This value is specific to your VPS.
"kvm_123456_789012"
The expiration timestamp for the session, obtained from the "Create AUTH-session" call.
Ensure that the session is valid and has not expired.
"1737476000"
Response
Basic details about the KVM VPS retrieved successfully.
"success"
Basic details about the KVM VPS.
{ "hw": { "ram": "5120", "disk": "46080", "cpu_set_cores": "socket", "drive_boost": "102400" }, "suspended": "n", "ip": { "ipv4": [ "192.168.0.101/255.255.255.0", "192.168.0.102/255.255.255.0" ], "ipv4_gw": "192.168.0.1", "ipv4_nm": "255.255.255.0", "ipv6_gw": "fe80::1", "ipv6_64": "fe80::/64" }, "hostname": "example-host" }
Was this page helpful?