List Cloud VPS private networks

GET /api/v2/private-networks

List private networks used by Cloud VPS workflows with cursor pagination. Use returned data[].id as {id} for GET /api/v2/private-networks/{id} and delete calls; use actions.canDelete and attachedVpsCount before attempting deletion.

Cloud VPS Private Networks

Authentication

Required API scope: read:network

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

Context

Query Parameters

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

Page size from 1 to 100. Defaults to 20. Values above 100 are rejected with 400 invalid_pagination_limit.

cursor string

Opaque cursor from nextCursor for the next page.

region string

Deprecated internal parameter — omit it. Private networks span the entire HostUp network and the default listing returns all of them.

Headers

Authorization Bearer <token>
Accept application/json

Responses

200 Private-network page.
data array<object> required
data[].id string required · Example: pnet_01hxa3b4c5d6e7f8g9h0j1k2m3
data[].name string required · Example: production-private
data[].parentCidr string required · Example: 10.201.40.0/21
data[].region string deprecated required · Example: dc1r28

Internal placement identifier; safe to ignore. Private networks span the entire HostUp network.

data[].status string · enum required · Example: active
provisioning
active
deprovisioning
retired
unknown
data[].subnetCount integer required · Example: 1
data[].attachedVpsCount integer required · Example: 1
data[].actions object required
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[].actions.canAddSubnet object required
data[].actions.canAddSubnet.allowed boolean required · Example: false
data[].actions.canAddSubnet.reason string · nullable required · Example: Private network limit reached.

Nullable: may be null when not applicable.

data[].createdAt string required · Example: 2026-04-27T12:00:00.000Z
hasMore boolean required · Example: false
nextCursor string · nullable required · Example: null

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/private-networks
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/private-networks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "data": [
    {
      "id": "pnet_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "name": "production-private",
      "parentCidr": "10.201.40.0/21",
      "region": "dc1r28",
      "status": "active",
      "subnetCount": 1,
      "attachedVpsCount": 1,
      "actions": {
        "canDelete": {
          "allowed": false,
          "reason": "Retire all child subnets before deleting."
        },
        "canAddSubnet": {
          "allowed": false,
          "reason": "Private network limit reached."
        }
      },
      "createdAt": "2026-04-27T12:00:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null
}