Get VPS storage state

Return VPS disks, filesystem usage, block IO counters, guest-agent availability, and disk action gates. Get {id} from GET /api/v2/vps. Use this endpoint when an agent needs to explain disk usage or whether a disk can be detached, resized, or expanded.

VPS Services Storage

Authentication

Required API scope: read:vm

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

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

Accept Example
Content-Type Example

Responses

200 VPS storage state.
disks array<object> required
disks[].id stringnull required · Example: vpsdisk_01hxa3b4c5d6e7f8g9h0j1k2m3
disks[].name stringnull required · Example: scsi0
disks[].type stringnull required · Example: SCSI
disks[].device stringnull required · Example: /dev/scsi0
disks[].isCdrom boolean required · Example: false
disks[].bootOrder numbernull required · Example: 1
disks[].capacity object required
disks[].capacity.totalGb number required · Example: 80
disks[].capacity.usedGb number required · Example: 24.2
disks[].capacity.freeGb number required · Example: 55.8
disks[].capacity.usagePercent number required · Example: 30.25
disks[].io object required
disks[].io.readGb number required · Example: 120.5
disks[].io.writeGb number required · Example: 64.2
disks[].io.readOperations number required · Example: 102400
disks[].io.writeOperations number required · Example: 51200
disks[].actions object required
disks[].actions.canDetach object required
disks[].actions.canDetach.allowed boolean required · Example: true
disks[].actions.canDetach.reason stringnull required · Example: null
disks[].actions.canDetach.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

disks[].actions.canResize object
disks[].actions.canResize.allowed boolean required · Example: true
disks[].actions.canResize.reason stringnull required · Example: null
disks[].actions.canResize.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

disks[].actions.canExpand object
disks[].actions.canExpand.allowed boolean required · Example: true
disks[].actions.canExpand.reason stringnull required · Example: null
disks[].actions.canExpand.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

filesystems array<object> required
filesystems[].mountpoint stringnull required · Example: /
filesystems[].type stringnull required · Example: ext4
filesystems[].name stringnull required · Example: rootfs
filesystems[].devices array<string> required · Example: ["/dev/sda1"]
filesystems[].capacity object required
filesystems[].capacity.totalGb number required · Example: 78
filesystems[].capacity.usedGb number required · Example: 24.2
filesystems[].capacity.freeGb number required · Example: 53.8
filesystems[].capacity.usagePercent number required · Example: 31.03
blockStats object required
blockStats.totalReadGb number required · Example: 120.5
blockStats.totalWriteGb number required · Example: 64.2
guestAgentAvailable boolean required · Example: true
vmNotRunning boolean required · Example: false
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}/storage
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/storage" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "disks": [
    {
      "id": "vpsdisk_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "name": "scsi0",
      "type": "SCSI",
      "device": "/dev/scsi0",
      "isCdrom": false,
      "bootOrder": 1,
      "capacity": {
        "totalGb": 80,
        "usedGb": 24.2,
        "freeGb": 55.8,
        "usagePercent": 30.25
      },
      "io": {
        "readGb": 120.5,
        "writeGb": 64.2,
        "readOperations": 102400,
        "writeOperations": 51200
      },
      "actions": {
        "canDetach": {
          "allowed": false,
          "reason": "Cannot detach root disk."
        },
        "canResize": {
          "allowed": false,
          "reason": "To expand your main disk, use Billing -> Add Resources."
        },
        "canExpand": {
          "allowed": false,
          "reason": "Guest agent is not installed. Install qemu-guest-agent on the VM to enable disk expansion."
        }
      }
    }
  ],
  "filesystems": [
    {
      "mountpoint": "/",
      "type": "ext4",
      "name": "rootfs",
      "devices": [
        "/dev/sda1"
      ],
      "capacity": {
        "totalGb": 78,
        "usedGb": 24.2,
        "freeGb": 53.8,
        "usagePercent": 31.03
      }
    }
  ],
  "blockStats": {
    "totalReadGb": 120.5,
    "totalWriteGb": 64.2
  },
  "guestAgentAvailable": true,
  "vmNotRunning": false
}