curl --request GET \
--url https://console.advinservers.com/api/v1/client/bandwidth-blocks/{bandwidthBlock}/servers \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/bandwidth-blocks/{bandwidthBlock}/servers"
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/bandwidth-blocks/{bandwidthBlock}/servers', 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/bandwidth-blocks/{bandwidthBlock}/servers",
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/bandwidth-blocks/{bandwidthBlock}/servers"
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/bandwidth-blocks/{bandwidthBlock}/servers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/bandwidth-blocks/{bandwidthBlock}/servers")
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",
"name": "lambda-core",
"hostname": "lambda-core.blackmesa.example.com",
"template_name": "Ubuntu 24.04",
"template_icon_url": "https://img.icons8.com/color/48/ubuntu.png",
"windows": false,
"address": "203.0.113.24",
"location": "Kansas City, MO",
"bandwidth_limit": 5497558138880,
"bandwidth_usage": 500000000000,
"exhausted": false
}
]{
"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."
}List servers a bandwidth block can be assigned to
Overview
Lists servers eligible to use the block, including their plan allowances, current usage and bandwidth throttling status.
Permissions
Requires the network.read (View networking) permission for the selected team. Resources outside that team return 404.
curl --request GET \
--url https://console.advinservers.com/api/v1/client/bandwidth-blocks/{bandwidthBlock}/servers \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/bandwidth-blocks/{bandwidthBlock}/servers"
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/bandwidth-blocks/{bandwidthBlock}/servers', 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/bandwidth-blocks/{bandwidthBlock}/servers",
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/bandwidth-blocks/{bandwidthBlock}/servers"
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/bandwidth-blocks/{bandwidthBlock}/servers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/bandwidth-blocks/{bandwidthBlock}/servers")
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",
"name": "lambda-core",
"hostname": "lambda-core.blackmesa.example.com",
"template_name": "Ubuntu 24.04",
"template_icon_url": "https://img.icons8.com/color/48/ubuntu.png",
"windows": false,
"address": "203.0.113.24",
"location": "Kansas City, MO",
"bandwidth_limit": 5497558138880,
"bandwidth_usage": 500000000000,
"exhausted": false
}
]{
"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 bandwidth block UUID
"23653478-238e-4db3-b263-91a221b5e7c2"
Response
The whole set, as a JSON array. There is no envelope and no paging.
The short uuid, which is what an attach names the machine by.
"ecc6f4f1"
The uuid UUID.
"ecc6f4f1-c89b-4dce-a20b-a330641c5b0b"
The name shown to customers.
"lambda-core"
The fully qualified hostname.
"lambda-core.blackmesa.example.com"
What the picker paints the machine with, the same as the dashboard.
"Ubuntu 24.04"
The value of template_icon_url.
"https://img.icons8.com/color/48/ubuntu.png"
The value of windows.
false
The machine's primary IPv4, so the picker names it the way a customer does.
"203.0.113.24"
The city, by display name.
"Kansas City, MO"
The value of bandwidth_limit.
5497558138880
The value of bandwidth_usage.
500000000000
The value of exhausted.
false
[
{
"id": "ecc6f4f1",
"uuid": "ecc6f4f1-c89b-4dce-a20b-a330641c5b0b",
"name": "lambda-core",
"hostname": "lambda-core.blackmesa.example.com",
"template_name": "Ubuntu 24.04",
"template_icon_url": "https://img.icons8.com/color/48/ubuntu.png",
"windows": false,
"address": "203.0.113.24",
"location": "Kansas City, MO",
"bandwidth_limit": 5497558138880,
"bandwidth_usage": 500000000000,
"exhausted": false
}
]