Get private network details

Return one private network with subnets, attached VPSes, status, and action gates. Get {id} from GET /api/v2/private-networks data[].id; do not pass a VPS ID here.

Cloud VPS Private Networks

Authentication

Required API scope: read:network

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

Context

Path Parameters

id string required Example: pnet_01hxa3b4c5d6e7f8g9h0j1k2m3

Public private network ID. Get it from GET /api/v2/private-networks `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 Private-network details.
id string required · Example: pnet_01hxa3b4c5d6e7f8g9h0j1k2m3
name string required · Example: production-private
parentCidr string required · Example: 10.42.0.0/21
region stringnull required · Example: stockholm
status string · enum required · Example: active
provisioning
active
deprovisioning
retired
unknown
subnetCount number required · Example: 1
attachedVpsCount number required · Example: 1
subnets array<object> required
subnets[].id string required · Example: subnet_01hxa3b4c5d6e7f8g9h0j1k2m3
subnets[].subnetCidr string required · Example: 10.42.0.0/24
subnets[].vlanTag numbernull required · Example: 214
subnets[].gateway stringnull required · Example: 10.42.0.1
subnets[].status string · enum required · Example: active
provisioning
active
deprovisioning
retired
unknown
attachedVps array<object> required
attachedVps[].id string required · Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3
attachedVps[].name string required · Example: web-01
attachedVps[].primaryIp stringnull required · Example: 10.42.0.10
actions object required
actions.canDelete object required
actions.canDelete.allowed boolean required · Example: true
actions.canDelete.reason stringnull required · Example: null
actions.canAddSubnet object required
actions.canAddSubnet.allowed boolean required · Example: true
actions.canAddSubnet.reason stringnull required · Example: null
createdAt string required · Example: 2026-04-27T12:00:00.000Z
unusedAddressReservationCount number required · Example: 0

Count of stale reserved private addresses that are not attached to an owned VPS.

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/{id}
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/private-networks/pnet_01hxa3b4c5d6e7f8g9h0j1k2m3" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "id": "pnet_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "name": "production-private",
  "parentCidr": "10.201.40.0/21",
  "region": "dc1r28",
  "status": "active",
  "subnetCount": 1,
  "attachedVpsCount": 1,
  "subnets": [
    {
      "id": "subnet_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "subnetCidr": "10.201.40.0/24",
      "vlanTag": 214,
      "gateway": "203.0.113.10",
      "status": "active"
    }
  ],
  "attachedVps": [
    {
      "id": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "name": "web-01",
      "primaryIp": null
    }
  ],
  "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",
  "unusedAddressReservationCount": 0
}