Get a dedicated server's header data
curl --request GET \
--url https://my.server.express/api/v1/dedicated/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.server.express/api/v1/dedicated/{id}', 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}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hostname": "<string>",
"servername": "<string>",
"description": "<string>",
"primaryIp": "<string>",
"status": "on",
"billingStatus": "ACTIVE",
"location": "<string>",
"owners": 123,
"cpu": {
"model": "<string>",
"cores": 123,
"threads": 123,
"mhz": "<string>"
},
"ram": {
"totalGb": 123
},
"storage": {
"totalGb": 123,
"disks": 123
},
"price": 123,
"currency": "GBP",
"billingCycle": "monthly",
"machine": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "vm",
"flavour": "linux",
"label": "<string>",
"hostname": "<string>",
"tags": [
"<string>"
],
"status": "pending",
"power": {
"state": "on",
"at": "2023-11-07T05:31:56Z",
"stale": true,
"verbs": [
"start"
]
},
"specs": {
"cpu": "<string>",
"cores": 123,
"threads": 123,
"ramMb": 123,
"disks": [
{
"sizeGb": 123,
"kind": "NVMe"
}
],
"bandwidthTb": 123,
"portMbps": 123
},
"ips": {
"v4": [
{
"address": "<string>",
"primary": true,
"rdns": "<string>"
}
],
"v6": [
{
"prefix": "2001:db8:1::/64",
"rdns": "<string>"
}
]
},
"location": {
"code": "<string>",
"name": "<string>",
"country": "<string>"
},
"os": {
"name": "<string>",
"family": "<string>"
},
"loginUser": "root",
"renewal": {
"nextDueDate": "2023-11-07T05:31:56Z",
"cycle": "<string>",
"amountMinor": 123,
"currency": "<string>"
},
"activeTask": {
"id": "<string>",
"kind": "reinstall",
"step": "<string>",
"progress": 123,
"startedAt": "2023-11-07T05:31:56Z"
},
"rescueActive": true
},
"role": "OWNER"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Dedicated
Get a dedicated server's header data
Header data for the server page, plus the shared machine shape and your role on it. Built from one cached TenantOS
answer at most 30 seconds old. Readable by the owner and any team member.
GET
/
v1
/
dedicated
/
{id}
Get a dedicated server's header data
curl --request GET \
--url https://my.server.express/api/v1/dedicated/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.server.express/api/v1/dedicated/{id}', 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}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hostname": "<string>",
"servername": "<string>",
"description": "<string>",
"primaryIp": "<string>",
"status": "on",
"billingStatus": "ACTIVE",
"location": "<string>",
"owners": 123,
"cpu": {
"model": "<string>",
"cores": 123,
"threads": 123,
"mhz": "<string>"
},
"ram": {
"totalGb": 123
},
"storage": {
"totalGb": 123,
"disks": 123
},
"price": 123,
"currency": "GBP",
"billingCycle": "monthly",
"machine": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "vm",
"flavour": "linux",
"label": "<string>",
"hostname": "<string>",
"tags": [
"<string>"
],
"status": "pending",
"power": {
"state": "on",
"at": "2023-11-07T05:31:56Z",
"stale": true,
"verbs": [
"start"
]
},
"specs": {
"cpu": "<string>",
"cores": 123,
"threads": 123,
"ramMb": 123,
"disks": [
{
"sizeGb": 123,
"kind": "NVMe"
}
],
"bandwidthTb": 123,
"portMbps": 123
},
"ips": {
"v4": [
{
"address": "<string>",
"primary": true,
"rdns": "<string>"
}
],
"v6": [
{
"prefix": "2001:db8:1::/64",
"rdns": "<string>"
}
]
},
"location": {
"code": "<string>",
"name": "<string>",
"country": "<string>"
},
"os": {
"name": "<string>",
"family": "<string>"
},
"loginUser": "root",
"renewal": {
"nextDueDate": "2023-11-07T05:31:56Z",
"cycle": "<string>",
"amountMinor": 123,
"currency": "<string>"
},
"activeTask": {
"id": "<string>",
"kind": "reinstall",
"step": "<string>",
"progress": 123,
"startedAt": "2023-11-07T05:31:56Z"
},
"rescueActive": true
},
"role": "OWNER"
}
}{
"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.