Get VPS live status

GET /api/v2/vps/{id}/status

Return live power state, uptime, usage metrics, network counters, and pending platform tasks for a VPS.

Get {id} from GET /api/v2/vps data[].id.

When the QEMU Guest Agent returns filesystem data, storage.usedGb is based on the root filesystem and storage.totalGb remains the provisioned VM disk total; use GET /api/v2/vps/{id}/storage for per-disk and per-mount details.

VPS Services Monitoring & Jobs

Authentication

Required API scope: read:vm

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

Path Parameters

id string required Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3

Public VPS ID from GET /api/v2/vps data[].id. Do not invent this value; use the exact ID returned by the referenced API response.

Headers

Authorization Bearer <token>
Accept application/json

Responses

200 VPS status.
id string · Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3
powerState string · enum · Example: running
running
stopped
starting
stopping
paused
provisioning
error
unknown
uptimeSeconds number · nullable · Example: 197424

VPS uptime in seconds when the virtualization platform reports it.

cpuUsagePercent number · Example: 7.5
cpuCores number · nullable · Example: 2

memory object
memory.usedGb number required · Example: 3.68
memory.totalGb number required · Example: 4
memory.usagePercent number required · Example: 92.08
storage object
storage.usedGb number required · Example: 24.45
storage.totalGb number required · Example: 50
storage.usagePercent number required · Example: 49
network object
network.inboundGb number required · Example: 63.329
network.outboundGb number required · Example: 54.514
network.totalGb number required · Example: 117.843
pendingTasks array<object> · Example: []
pendingTasks[].id string · nullable required · Example: job_01hxa3b4c5d6e7f8g9h0j1k2m3

Nullable: may be null when not applicable.

pendingTasks[].type string required · Example: vps.snapshot.create
pendingTasks[].status string · enum required · Example: in_progress
pending
queued
in_progress
completed
failed
pendingTasks[].createdAt string · nullable required · Example: 2026-04-17T13:00:14.564Z

Nullable: may be null when not applicable.

pendingTasks[].progress number · min: 0 · max: 100 required · Example: 100
400 Invalid request. The response body is an RFC 7807 Problem Details document.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
401 Unauthorized. Authentication is required.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
403 Forbidden. The caller lacks a required scope or does not own the resource.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
404 Not found. The resource does not exist or is not owned by the caller.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
500 Internal error. Retry later or contact support if the issue persists.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
GET https://cloud.hostup.se/api/v2/vps/{id}/status
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "id": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "powerState": "running",
  "uptimeSeconds": 197424,
  "cpuUsagePercent": 7.5,
  "cpuCores": 2,
  "memory": {
    "usedGb": 3.68,
    "totalGb": 4,
    "usagePercent": 92.08
  },
  "storage": {
    "usedGb": 24.45,
    "totalGb": 50,
    "usagePercent": 49
  },
  "network": {
    "inboundGb": 63.329,
    "outboundGb": 54.514,
    "totalGb": 117.843
  },
  "pendingTasks": []
}