Get a server's overview tab
curl --request GET \
--url https://my.server.express/api/v1/dedicated/{id}/overview \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.server.express/api/v1/dedicated/{id}/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.server.express/api/v1/dedicated/{id}/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hostname": "<string>",
"status": "on",
"uptime": "—",
"cpu": {
"model": "<string>",
"cores": 123,
"threads": 123
},
"ram": {
"total": "64 GB",
"used": "—"
},
"storage": [
{
"device": "disk1",
"size": "960 GB",
"type": "<string>"
}
],
"network": {
"speed": "<string>",
"inbound": "—",
"outbound": "—"
},
"ipAddresses": [
{
"address": "<string>",
"type": "IPv4",
"rdns": "—"
}
],
"recentEvents": [
"<unknown>"
]
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Dedicated
Get a server's overview tab
Hardware, disks, port speed and IPs from the cached TenantOS answer (refreshed if older than 30 seconds; the last
known answer when TenantOS is down). uptime, ram.used, network.inbound/outbound and every rdns are always
”—”, and recentEvents is always empty. Readable by the owner and any team member.
GET
/
v1
/
dedicated
/
{id}
/
overview
Get a server's overview tab
curl --request GET \
--url https://my.server.express/api/v1/dedicated/{id}/overview \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.server.express/api/v1/dedicated/{id}/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.server.express/api/v1/dedicated/{id}/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hostname": "<string>",
"status": "on",
"uptime": "—",
"cpu": {
"model": "<string>",
"cores": 123,
"threads": 123
},
"ram": {
"total": "64 GB",
"used": "—"
},
"storage": [
{
"device": "disk1",
"size": "960 GB",
"type": "<string>"
}
],
"network": {
"speed": "<string>",
"inbound": "—",
"outbound": "—"
},
"ipAddresses": [
{
"address": "<string>",
"type": "IPv4",
"rdns": "—"
}
],
"recentEvents": [
"<unknown>"
]
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Authorizations
bearerAuthapiToken
Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh. A session satisfies every API scope.
Path Parameters
The dedicated server's service id.