Get a cloud server
curl --request GET \
--url https://my.server.express/api/v1/cloud/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.server.express/api/v1/cloud/{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/cloud/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"hostname": "<string>",
"billingStatus": "ACTIVE",
"vmStatus": "<string>",
"ip": "<string>",
"cores": 123,
"ramMb": 123,
"diskGb": 123,
"location": "<string>",
"activeTask": {
"id": "<string>",
"kind": "<string>",
"label": "<string>",
"progress": 50,
"step": "<string>"
},
"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": "<string>"
}
],
"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": "<string>",
"renewal": {
"nextDueDate": "2023-11-07T05:31:56Z",
"cycle": "<string>",
"amountMinor": 123,
"currency": "<string>"
},
"activeTask": {
"id": "<string>",
"kind": "<string>",
"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>"
}Cloud
Get a cloud server
Header info for one VDS: the legacy flat fields, any long-running task in flight (so a reloaded page picks its progress
back up), the shared machine shape, and your role on it. Power in machine is the poller’s reading, not a live call.
Owners and team members with any role can read it.
GET
/
v1
/
cloud
/
{id}
Get a cloud server
curl --request GET \
--url https://my.server.express/api/v1/cloud/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.server.express/api/v1/cloud/{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/cloud/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"hostname": "<string>",
"billingStatus": "ACTIVE",
"vmStatus": "<string>",
"ip": "<string>",
"cores": 123,
"ramMb": 123,
"diskGb": 123,
"location": "<string>",
"activeTask": {
"id": "<string>",
"kind": "<string>",
"label": "<string>",
"progress": 50,
"step": "<string>"
},
"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": "<string>"
}
],
"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": "<string>",
"renewal": {
"nextDueDate": "2023-11-07T05:31:56Z",
"cycle": "<string>",
"amountMinor": 123,
"currency": "<string>"
},
"activeTask": {
"id": "<string>",
"kind": "<string>",
"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
Service id of the cloud server.