curl --request GET \
--url https://console.advinservers.com/api/v1/client/servers/{server}/details \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/servers/{server}/details"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://console.advinservers.com/api/v1/client/servers/{server}/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://console.advinservers.com/api/v1/client/servers/{server}/details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://console.advinservers.com/api/v1/client/servers/{server}/details"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.advinservers.com/api/v1/client/servers/{server}/details")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/servers/{server}/details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "ecc6f4f1",
"uuid": "ecc6f4f1-c89b-4dce-a20b-a330641c5b0b",
"state": "running",
"locked": false,
"config": {
"mac_address": "52:54:00:3a:7c:91",
"boot_order": [
{
"interface": "scsi0",
"is_primary_disk": true,
"is_media": false,
"media_name": null,
"size": 85899345920,
"storage": "local-zfs"
}
],
"disks": [
{
"interface": "scsi0",
"is_primary_disk": true,
"is_media": false,
"media_name": null,
"size": 85899345920,
"storage": "local-zfs"
},
{
"interface": "ide3",
"is_primary_disk": false,
"is_media": true,
"media_name": "Ubuntu 24.04.1 Live Server",
"size": 2773874688,
"storage": "iso"
}
]
},
"internal_id": 4821
}{
"message": "Unauthenticated."
}{
"message": "This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."
}{
"message": "Not found."
}{
"message": "Too Many Attempts."
}{
"message": "The request could not be carried out."
}Get a server's live configuration
Overview
Returns the server’s live disks, boot order, network adapter and operation lock. This request may be slower than reading saved server details. Returns 503 with a message if the configuration cannot be read; retry later.
Permissions
Requires the server.read (View servers) permission for the selected team. Resources outside that team return 404.
curl --request GET \
--url https://console.advinservers.com/api/v1/client/servers/{server}/details \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/servers/{server}/details"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://console.advinservers.com/api/v1/client/servers/{server}/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://console.advinservers.com/api/v1/client/servers/{server}/details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://console.advinservers.com/api/v1/client/servers/{server}/details"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.advinservers.com/api/v1/client/servers/{server}/details")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/servers/{server}/details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "ecc6f4f1",
"uuid": "ecc6f4f1-c89b-4dce-a20b-a330641c5b0b",
"state": "running",
"locked": false,
"config": {
"mac_address": "52:54:00:3a:7c:91",
"boot_order": [
{
"interface": "scsi0",
"is_primary_disk": true,
"is_media": false,
"media_name": null,
"size": 85899345920,
"storage": "local-zfs"
}
],
"disks": [
{
"interface": "scsi0",
"is_primary_disk": true,
"is_media": false,
"media_name": null,
"size": 85899345920,
"storage": "local-zfs"
},
{
"interface": "ide3",
"is_primary_disk": false,
"is_media": true,
"media_name": "Ubuntu 24.04.1 Live Server",
"size": 2773874688,
"storage": "iso"
}
]
},
"internal_id": 4821
}{
"message": "Unauthenticated."
}{
"message": "This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."
}{
"message": "Not found."
}{
"message": "Too Many Attempts."
}{
"message": "The request could not be carried out."
}Authorizations
Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.
Path Parameters
The server UUID
"ecc6f4f1"
Response
The record, as a JSON object. There is no envelope.
The short uuid, as everywhere else in the customer's payloads.
"ecc6f4f1"
The uuid UUID.
"ecc6f4f1-c89b-4dce-a20b-a330641c5b0b"
The billing state, province, or region, or null or an empty string to clear it.
"running"
The value of locked.
false
The value of config.
Show child attributes
Show child attributes
{
"mac_address": "52:54:00:3a:7c:91",
"boot_order": [
{
"interface": "scsi0",
"is_primary_disk": true,
"is_media": false,
"media_name": null,
"size": 85899345920,
"storage": "local-zfs"
}
],
"disks": [
{
"interface": "scsi0",
"is_primary_disk": true,
"is_media": false,
"media_name": null,
"size": 85899345920,
"storage": "local-zfs"
},
{
"interface": "ide3",
"is_primary_disk": false,
"is_media": true,
"media_name": "Ubuntu 24.04.1 Live Server",
"size": 2773874688,
"storage": "iso"
}
]
}
The primary key. See the note on id.
4821