curl --request GET \
--url https://console.advinservers.com/api/v1/client/servers/{server} \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/servers/{server}"
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}', 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}",
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}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/servers/{server}")
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",
"hostname": "lambda-core.blackmesa.example.com",
"name": "lambda-core",
"description": "Lambda Complex test chamber telemetry",
"status": null,
"suspension_reason": null,
"power_state": "running",
"windows": false,
"template_name": "Ubuntu 24.04",
"template_icon_url": "https://img.icons8.com/color/48/ubuntu.png",
"custom_icon_url": null,
"default_icon_url": "https://img.icons8.com/color/48/ubuntu.png",
"created_at": "2026-03-02T19:14:36.000000Z",
"usages": {
"bandwidth": 500000000000,
"actual_bandwidth": 500000000000,
"rx": 200000000000,
"tx": 300000000000
},
"limits": {
"cpu": 4,
"memory": 4294967296,
"disk": 85899345920,
"hdd_disk": null,
"snapshots": 2,
"backups": 2,
"bandwidth": 5497558138880,
"addresses": {
"ipv4": [
{
"id": 58213,
"address_pool_id": 4,
"server_id": 4821,
"user_id": null,
"type": "ipv4",
"is_primary": true,
"address": "203.0.113.24",
"cidr": 24,
"gateway": "203.0.113.1",
"mac_address": "52:54:00:3a:7c:91",
"onlink": null,
"floating_ip_uuid": null
},
{
"id": 58391,
"address_pool_id": 4,
"server_id": 4821,
"user_id": null,
"type": "ipv4",
"is_primary": false,
"address": "203.0.113.88",
"cidr": 24,
"gateway": "203.0.113.1",
"mac_address": "52:54:00:3a:7c:91",
"onlink": null,
"floating_ip_uuid": null
}
],
"ipv6": [
{
"id": 58214,
"address_pool_id": 5,
"server_id": 4821,
"user_id": null,
"type": "ipv6",
"is_primary": false,
"address": "2001:db8:4b2:18::1",
"cidr": 64,
"gateway": "2001:db8:4b2::1",
"mac_address": "52:54:00:3a:7c:91",
"onlink": "2001:db8:4b2::18",
"floating_ip_uuid": null
}
]
},
"mac_address": "52:54:00:3a:7c:91",
"effective_bandwidth": 5497558138880,
"bandwidth_blocks": 0,
"plan_bandwidth": 5497558138880
},
"internal_id": 4821,
"restoration_progress": null,
"installation_progress": null,
"install_failed_at": null,
"cpu_throttle": null,
"bandwidth": null,
"provisioning_scripts_supported": true,
"snapshots_supported": true,
"maintenance": null,
"maintenance_events": [],
"location": "Kansas City, MO",
"product_group_name": "Standard VPS"
}{
"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."
}Get a server
Overview
Returns a server’s name, plan, usage, limits, location and last known power state. These saved details may be a few seconds old. Add ?include=user to include the account that owns it.
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} \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/servers/{server}"
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}', 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}",
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}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/servers/{server}")
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",
"hostname": "lambda-core.blackmesa.example.com",
"name": "lambda-core",
"description": "Lambda Complex test chamber telemetry",
"status": null,
"suspension_reason": null,
"power_state": "running",
"windows": false,
"template_name": "Ubuntu 24.04",
"template_icon_url": "https://img.icons8.com/color/48/ubuntu.png",
"custom_icon_url": null,
"default_icon_url": "https://img.icons8.com/color/48/ubuntu.png",
"created_at": "2026-03-02T19:14:36.000000Z",
"usages": {
"bandwidth": 500000000000,
"actual_bandwidth": 500000000000,
"rx": 200000000000,
"tx": 300000000000
},
"limits": {
"cpu": 4,
"memory": 4294967296,
"disk": 85899345920,
"hdd_disk": null,
"snapshots": 2,
"backups": 2,
"bandwidth": 5497558138880,
"addresses": {
"ipv4": [
{
"id": 58213,
"address_pool_id": 4,
"server_id": 4821,
"user_id": null,
"type": "ipv4",
"is_primary": true,
"address": "203.0.113.24",
"cidr": 24,
"gateway": "203.0.113.1",
"mac_address": "52:54:00:3a:7c:91",
"onlink": null,
"floating_ip_uuid": null
},
{
"id": 58391,
"address_pool_id": 4,
"server_id": 4821,
"user_id": null,
"type": "ipv4",
"is_primary": false,
"address": "203.0.113.88",
"cidr": 24,
"gateway": "203.0.113.1",
"mac_address": "52:54:00:3a:7c:91",
"onlink": null,
"floating_ip_uuid": null
}
],
"ipv6": [
{
"id": 58214,
"address_pool_id": 5,
"server_id": 4821,
"user_id": null,
"type": "ipv6",
"is_primary": false,
"address": "2001:db8:4b2:18::1",
"cidr": 64,
"gateway": "2001:db8:4b2::1",
"mac_address": "52:54:00:3a:7c:91",
"onlink": "2001:db8:4b2::18",
"floating_ip_uuid": null
}
]
},
"mac_address": "52:54:00:3a:7c:91",
"effective_bandwidth": 5497558138880,
"bandwidth_blocks": 0,
"plan_bandwidth": 5497558138880
},
"internal_id": 4821,
"restoration_progress": null,
"installation_progress": null,
"install_failed_at": null,
"cpu_throttle": null,
"bandwidth": null,
"provisioning_scripts_supported": true,
"snapshots_supported": true,
"maintenance": null,
"maintenance_events": [],
"location": "Kansas City, MO",
"product_group_name": "Standard VPS"
}{
"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."
}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"
Query Parameters
Related records to include, with multiple values separated by commas.
"user"
Response
The record, as a JSON object. There is no envelope.
A server and its current configuration and status.
The short uuid. This is what every customer-facing URL is keyed by.
"ecc6f4f1"
The uuid UUID.
"ecc6f4f1-c89b-4dce-a20b-a330641c5b0b"
The fully qualified hostname.
"lambda-core.blackmesa.example.com"
The name shown to customers.
"lambda-core"
An optional description shown to customers.
"Lambda Complex test chamber telemetry"
A pending server operation, or null when there is none. starting and stopping clear when the power command finishes.
installing, install_failed, suspended, restoring_backup, restoring_snapshot, snapshotting, deleting, deletion_failed, upgrading, migrating, starting, stopping, null null
Why the hold above is on, in the words of whoever put it on, or null where no reason was given. Only ever set alongside suspended: it is cleared when the suspension is lifted. Show it to the customer - it is written for them, and it is the difference between a machine that says it is suspended and one that says what to do about it.
null
The value of power_state.
running, stopped, paused, null "running"
The value of windows.
false
The value of template_name.
"Ubuntu 24.04"
The icon actually in force: the customer's own pick where they have made one, otherwise the artwork snapshotted from the template.
"https://img.icons8.com/color/48/ubuntu.png"
The raw override, so a form can tell a pick from a default.
null
What the icon falls back to if that override is cleared.
"https://img.icons8.com/color/48/ubuntu.png"
The date and time for created at, in UTC.
"2026-03-02T19:14:36.000000Z"
The value of usages.
Show child attributes
Show child attributes
{
"bandwidth": 500000000000,
"actual_bandwidth": 500000000000,
"rx": 200000000000,
"tx": 300000000000
}
The value of limits.
Show child attributes
Show child attributes
{
"cpu": 4,
"memory": 4294967296,
"disk": 85899345920,
"hdd_disk": null,
"snapshots": 2,
"backups": 2,
"bandwidth": 5497558138880,
"addresses": {
"ipv4": [
{
"id": 58213,
"address_pool_id": 4,
"server_id": 4821,
"user_id": null,
"type": "ipv4",
"is_primary": true,
"address": "203.0.113.24",
"cidr": 24,
"gateway": "203.0.113.1",
"mac_address": "52:54:00:3a:7c:91",
"onlink": null,
"floating_ip_uuid": null
},
{
"id": 58391,
"address_pool_id": 4,
"server_id": 4821,
"user_id": null,
"type": "ipv4",
"is_primary": false,
"address": "203.0.113.88",
"cidr": 24,
"gateway": "203.0.113.1",
"mac_address": "52:54:00:3a:7c:91",
"onlink": null,
"floating_ip_uuid": null
}
],
"ipv6": [
{
"id": 58214,
"address_pool_id": 5,
"server_id": 4821,
"user_id": null,
"type": "ipv6",
"is_primary": false,
"address": "2001:db8:4b2:18::1",
"cidr": 64,
"gateway": "2001:db8:4b2::1",
"mac_address": "52:54:00:3a:7c:91",
"onlink": "2001:db8:4b2::18",
"floating_ip_uuid": null
}
]
},
"mac_address": "52:54:00:3a:7c:91",
"effective_bandwidth": 5497558138880,
"bandwidth_blocks": 0,
"plan_bandwidth": 5497558138880
}
The primary key. See the note on id above.
4821
The value of restoration_progress.
null
The value of installation_progress.
null
Set only while the last install or rebuild is still an unread failure: cleared by the next attempt, and by the customer dismissing the notice it draws.
null
The value of cpu_throttle.
Show child attributes
Show child attributes
null
What the server's transfer really looks like once purchased blocks and pooling exist. Null, like cpu_throttle above it, whenever the plan's own allowance is the whole story.
Show child attributes
Show child attributes
null
The value of provisioning_scripts_supported.
true
Whether snapshot storage is available in this server's location.
true
Null unless maintenance that affects this server is planned or under way.
Show child attributes
Show child attributes
null
Every maintenance or incident that affects this server, most pressing first. maintenance is the first of these.
Show child attributes
Show child attributes
[]
The city the server stands in, e.g. "Nuremberg, DE". A location is a city now; displayName() also reads back the older codes that carried the product alongside it in brackets.
"Kansas City, MO"
The product the server was sold as, such as Standard VPS, or null when no product is linked.
"Standard VPS"
The account the server belongs to, present only when a caller asked for it by name.
Show child attributes
Show child attributes
{
"name": "Gordon Freeman",
"email": "gordon.freeman@blackmesa.example.com"
}