Get VPS storage quota

Read full description Hide full description

Return storage allowance for attachable disks and the main disk. Get {id} from GET /api/v2/vps. attachable is the purchased Attachable Block Storage pool used by POST /api/v2/vps/{id}/actions/add-disk and non-root disk growth; attachable.availableGb is the remaining capacity an agent can spend before buying more. If a requested new disk or resize exceeds attachable.availableGb, do not retry the disk action with a larger body; first use GET /api/v2/vps/{id}/actions/upgrade and POST /api/v2/vps/{id}/actions/config with resources.additionalStorageGb, then re-read this endpoint. mainDisk.purchasedGb is the root/main disk allocation; increase it with the storageGb configurable option, not with additionalStorageGb. Use attachable.upgradeAvailable before offering extra disk/storage purchase flows; disk-resize writes use the VPS action endpoints, not this read endpoint.

VPS Services Storage

Authentication

Required API scope: read:vm

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

Context

Related endpoints

GET /api/v2/vps/{id} Get VPS details GET /api/v2/vps/{id}/iso List VPS ISO media GET /api/v2/vps/{id}/disks List VPS disks

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 quota.

attachable object required

attachable.purchasedGb number required · Example: 0

Total purchased Attachable Block Storage for extra/non-root disks. This is controlled by the `additionalStorageGb` configurable option.

attachable.usedGb number required · Example: 0

Attachable Block Storage already consumed by extra/non-root disks.

attachable.availableGb number required · Example: 0

Attachable Block Storage still available for add-disk or non-root disk growth before buying more `additionalStorageGb`.

attachable.upgradeAvailable object required

attachable.upgradeAvailable.allowed boolean required · Example: true

attachable.upgradeAvailable.reason stringnull required · Example: null

attachable.upgradeAvailable.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

mainDisk object required

mainDisk.purchasedGb number required · Example: 50

Purchased main/root disk allocation. Increase this with the `storageGb` configurable option.

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-quota

For AI assistants

View as Markdown

cURL

curl -X GET "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/storage-quota" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "attachable": {
    "purchasedGb": 0,
    "usedGb": 0,
    "availableGb": 0,
    "upgradeAvailable": {
      "allowed": false,
      "reason": "Storage upgrades are not available on your current plan."
    }
  },
  "mainDisk": {
    "purchasedGb": 50
  }
}

{
  "type": "object",
  "properties": {
    "attachable": {
      "type": "object",
      "properties": {
        "purchasedGb": {
          "type": "number",
          "description": "Total purchased Attachable Block Storage for extra/non-root disks. This is controlled by the `additionalStorageGb` configurable option."
        },
        "usedGb": {
          "type": "number",
          "description": "Attachable Block Storage already consumed by extra/non-root disks."
        },
        "availableGb": {
          "type": "number",
          "description": "Attachable Block Storage still available for add-disk or non-root disk growth before buying more `additionalStorageGb`."
        },
        "upgradeAvailable": {
          "type": "object",
          "properties": {
            "allowed": {
              "type": "boolean"
            },
            "reason": {
              "type": [
                "string",
                "null"
              ]
            },
            "code": {
              "type": [
                "string",
                "null"
              ],
              "description": "Machine-readable reason code when an action is blocked."
            }
          }
        }
      }
    },
    "mainDisk": {
      "type": "object",
      "properties": {
        "purchasedGb": {
          "type": "number",
          "description": "Purchased main/root disk allocation. Increase this with the `storageGb` configurable option."
        }
      }
    }
  }
}