Get the live status of a VPS
GET /api/v2/vps/{id}/status
Returns the power state of a VPS right now, with its CPU, memory, disk and network figures. pendingTasks lists the background jobs queued or running for the VPS, such as a restart or a snapshot. A task’s status is always pending, whether the job waits or runs. Poll GET /api/jobs/{jobId} with the task’s id for its real state. type names common jobs, such as vps.restart or vps.backup.create. Other jobs, such as a reinstall, show unknown. When the guest agent reports the filesystems, storage.usedGb is the use of the root filesystem and storage.totalGb is the size of the VPS disk. network counts traffic since the VPS last started. It is not the month’s bandwidth use. A VPS that is not set up yet has powerState provisioning. A cancelled or terminated VPS has stopped. Its figures are then 0 or null. Check the service status on GET /api/v2/vps/{id}. Use GET /api/v2/vps/{id}/storage for each disk and mount. Use GET /api/v2/vps/{id}/metrics for figures over time.
Authentication: An API key with the scope read:vm. About keys and scopes
Request
Path parameters
idstringrequiredvps_…).Example
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/status" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 The live status of the VPS.
{ "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": [ { "id": "job_01hxa3b4c5d6e7f8g9h0j1k2m3", "type": "vps.backup.create", "status": "pending", "createdAt": "2026-11-02T10:15:02.000Z", "progress": 40 } ]}Response fields
idstringpowerStatestringrunning, stopped, starting, stopping, paused, provisioning, error, unknown.uptimeSecondsnumber or nullcpuUsagePercentnumbercpuCoresnumber or nullmemoryobjectusedGbnumbertotalGbnumberusagePercentnumberstorageobjectusedGb comes from the platform and can be 0.usedGbnumbertotalGbnumberusagePercentnumbernetworkobjectinboundGbnumberoutboundGbnumbertotalGbnumberpendingTasksarray of objectidstring or nulltypestringvps.restart or vps.backup.create. unknown for other jobs, such as a reinstall.statusstringpending for now: the job is queued or running. Poll GET /api/jobs/{jobId} with id for its real state. One of pending, queued, in_progress, completed, failed.createdAtstring or nullprogressnumberErrors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | Invalid request. The response body is an RFC 7807 Problem Details document. |
| 401 | Unauthorized. Authentication is required. |
| 403 | Forbidden. The caller lacks a required scope or does not own the resource. |
| 404 | Not found. The resource does not exist or is not owned by the caller; code is vps_not_found. |
| 429 | Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. |
| 500 | Internal error. Retry later or contact support if the issue persists. |