List volumes
GET /api/v2/volumes
Lists the block storage volumes on your active Cloud VPS, sorted by name. A volume is an extra disk that you can detach and attach to another Cloud VPS. Detached volumes are listed too, with status available and attachedVpsId null. The boot disk of a VPS is not a volume. actions says whether each volume can be attached, detached or deleted now. The list can be up to 30 seconds old.
Authentication: An API key with the scope read:vm. About keys and scopes
Request
Query parameters
limitintegerPage size, 1 to 100. Default 20. 1 to 100.
cursorstringThe
nextCursor from the previous page.Example
curl "https://cloud.hostup.se/api/v2/volumes" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 One page of volumes.
{ "data": [ { "id": "vol_01hxa3b4c5d6e7f8g9h0j1k2m3", "displayId": "database-data", "name": "database-data", "sizeGb": 100, "status": "attached", "attachedVpsId": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3", "actions": { "canAttach": { "allowed": true, "reason": null }, "canDetach": { "allowed": true, "reason": null }, "canDelete": { "allowed": false, "reason": "Detach this volume before deleting it." } }, "createdAt": "2026-04-27T12:00:00.000Z" } ], "hasMore": false, "nextCursor": null}Response fields
dataarray of objectThe volumes on this page.
idstringThe volume ID (
vol_…).displayIdstringDisplay label. The same as
name.namestringThe volume name. A generated disk name when no name was given at creation.
sizeGbintegerSize in GB.
statusstringattached: on the VPS in attachedVpsId. available: detached, with its data kept. creating and deleting: an operation is running. error: the volume is in an unexpected state. One of available, attached, creating, deleting, error.attachedVpsIdstring or nullThe VPS the volume is attached to (
vps_…). null when it is detached.actionsobjectWhat you can do with the volume right now. A closed gate has a
reason.canAttachobjectAttach the volume to a VPS. Also allowed while it is attached: attaching it to another VPS moves it.
allowedbooleantrue when the action is allowed now.reasonstring or nullWhy the action is not allowed.
null when it is.canDetachobjectDetach the volume from its VPS.
allowedbooleantrue when the action is allowed now.reasonstring or nullWhy the action is not allowed.
null when it is.canDeleteobjectDelete the volume. Closed while it is attached.
allowedbooleantrue when the action is allowed now.reasonstring or nullWhy the action is not allowed.
null when it is.createdAtstring or nullWhen the volume was created (ISO 8601).
null when the creation time is not recorded.hasMorebooleantrue when there is another page.nextCursorstring or nullPass it as
cursor to get the next page. null on the last page.Errors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | invalid_pagination_limit: limit is not a whole number from 1 to 100. invalid_cursor: cursor is malformed. |
| 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. |
| 502 | Upstream failure. A dependent provider request failed; the Problem Details code is upstream_failed. Retry later or contact support if the issue persists. |