curl --request GET \
--url https://console.advinservers.com/api/v1/client/teams/{team}/roles/{role} \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/teams/{team}/roles/{role}"
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/teams/{team}/roles/{role}', 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/teams/{team}/roles/{role}",
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/teams/{team}/roles/{role}"
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/teams/{team}/roles/{role}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/teams/{team}/roles/{role}")
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": "18f11680-0831-4d41-9d71-824c99009cbf",
"name": "Research Associate",
"description": "Runs the test chamber servers and takes snapshots before each experiment, but cannot delete, reinstall or spend money.",
"permissions": [
"team.read",
"server.read",
"server.power",
"server.console",
"server.update",
"backup.read",
"backup.create",
"snapshot.read",
"snapshot.create",
"firewall.read",
"firewall.update",
"network.read",
"sshkey.read",
"sshkey.update"
],
"type": "custom",
"system_key": null,
"is_system": false,
"members_count": 1,
"created_at": "2026-01-09T20:14:52+00:00"
}{
"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 role
Overview
Returns a role, its permission keys and its member count. A role belonging to another team returns 404.
Permissions
Requires the account permission teams.read (View teams).
curl --request GET \
--url https://console.advinservers.com/api/v1/client/teams/{team}/roles/{role} \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/teams/{team}/roles/{role}"
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/teams/{team}/roles/{role}', 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/teams/{team}/roles/{role}",
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/teams/{team}/roles/{role}"
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/teams/{team}/roles/{role}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/teams/{team}/roles/{role}")
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": "18f11680-0831-4d41-9d71-824c99009cbf",
"name": "Research Associate",
"description": "Runs the test chamber servers and takes snapshots before each experiment, but cannot delete, reinstall or spend money.",
"permissions": [
"team.read",
"server.read",
"server.power",
"server.console",
"server.update",
"backup.read",
"backup.create",
"snapshot.read",
"snapshot.create",
"firewall.read",
"firewall.update",
"network.read",
"sshkey.read",
"sshkey.update"
],
"type": "custom",
"system_key": null,
"is_system": false,
"members_count": 1,
"created_at": "2026-01-09T20:14:52+00:00"
}{
"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 team UUID
"fbb31f5f-bd6f-4019-a3ed-1062a28f56f7"
The role UUID
"18f11680-0831-4d41-9d71-824c99009cbf"
Response
The record, as a JSON object. There is no envelope.
A named set of permissions in a team.
The id ID.
"18f11680-0831-4d41-9d71-824c99009cbf"
The name shown to customers.
"Research Associate"
An optional description shown to customers.
"Runs the test chamber servers and takes snapshots before each experiment, but cannot delete, reinstall or spend money."
Read through the model rather than off the column: a seeded role resolves its permissions from the catalogue every time, so it picks up anything added in a later release, and a key that no longer exists is dropped instead of being shown.
[ "team.read", "server.read", "server.power", "server.console", "server.update", "backup.read", "backup.create", "snapshot.read", "snapshot.create", "firewall.read", "firewall.update", "network.read", "sshkey.read", "sshkey.update" ]
The role type: system or custom.
system, custom "custom"
The value of system_key.
null
The three seeded roles are readable and assignable but never editable or deletable, so an account always has a working set to hand out.
false
Only present when the listing asked for it; a role fetched on its own does not pay for the count.
1
The date and time for created at, in UTC.
"2026-01-09T20:14:52+00:00"