List Cloud VPS block volumes

GET /api/v2/volumes

List block storage volumes for Cloud VPS workflows with cursor pagination. Use returned data[].id as {id} for attach, detach, detail, and delete operations; use actions to avoid invalid state transitions.

Cloud VPS Block Volumes

Authentication

Required API scope: read:vm

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

Context

Query Parameters

limit integer · min: 1 · max: 100 · Example: 20

Page size from 1 to 100. Defaults to 20. Values outside the range are rejected with 400 invalid_pagination_limit.

cursor string

Opaque cursor from nextCursor for the next page.

Headers

Authorization Bearer <token>
Accept application/json

Responses

200 Volume page.
data array<object> required
data[].id string required · Example: vol_01hxa3b4c5d6e7f8g9h0j1k2m3
data[].displayId string required · Example: database-data

Display label for the volume. Matches name.

data[].name string required · Example: database-data
data[].sizeGb integer required · Example: 100
data[].status string · enum required · Example: attached
available
attached
creating
deleting
error
data[].attachedVpsId string · nullable required · Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3

Nullable: may be null when not applicable.

data[].actions object required
data[].actions.canAttach object required
data[].actions.canAttach.allowed boolean required · Example: true
data[].actions.canAttach.reason string · nullable required · Example: null

Nullable: may be null when not applicable.

data[].actions.canDetach object required
data[].actions.canDetach.allowed boolean required · Example: true
data[].actions.canDetach.reason string · nullable required · Example: null

Nullable: may be null when not applicable.

data[].actions.canDelete object required
data[].actions.canDelete.allowed boolean required · Example: true
data[].actions.canDelete.reason string · nullable required · Example: null

Nullable: may be null when not applicable.

data[].createdAt string · nullable required · Example: 2026-04-27T12:00:00.000Z

When the volume was created (ISO 8601). null when the creation time is not recorded.

hasMore boolean required · Example: false
nextCursor string · nullable required · Example: null

400 Invalid pagination parameters: invalid_pagination_limit when limit is not an integer from 1 to 100, or invalid_cursor when cursor is malformed.
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/volumes
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/volumes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "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
}