## GET /api/v2/private-networks

**List Cloud VPS 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.

### Related Endpoints

- `POST /api/v2/private-networks`: Create Cloud VPS private network
- `GET /api/v2/vps/payg/deployments`: Get Cloud VPS PAYG deployment options
- `GET /api/v2/vps/payg/limits`: Get Cloud VPS PAYG resource limits

### Headers

- `Accept`: application/json
- `Authorization`: Bearer YOUR_API_KEY
- Required API scope: `read:network`

### Parameters

- `limit` (query, integer) [min: 1, max: 100]: Maximum number of items to return. Defaults to 20 and is capped at 100. Example: `20`
- `cursor` (query, string): Opaque cursor returned as `nextCursor` from the previous page.
- `region` (query, string): Filter private networks by public region slug such as `stockholm`.

### Request Example

```bash
curl -X GET "https://cloud.hostup.se/api/v2/private-networks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

### Response Schema

- `data` (array<object>, required)
- `data[].id` (string, required) Example: `pnet_01hxa3b4c5d6e7f8g9h0j1k2m3`
- `data[].name` (string, required) Example: `production-private`
- `data[].parentCidr` (string, required) Example: `10.42.0.0/21`
- `data[].region` (string,null, required) Example: `stockholm`
- `data[].status` (string, required) Example: `active`
  Allowed values: 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,null, required) Example: `null`
- `data[].actions.canAddSubnet` (object, required)
- `data[].actions.canAddSubnet.allowed` (boolean, required) Example: `false`
- `data[].actions.canAddSubnet.reason` (string,null, required) Example: `Private network limit reached.`
- `data[].createdAt` (string, required) Example: `2026-04-27T12:00:00.000Z`
- `hasMore` (boolean, required) Example: `false`
- `nextCursor` (string,null, required) Example: `null`

### Responses

#### 200 - Private-network page.
```json
{
  "data": [
    {
      "id": "pnet_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "name": "production-private",
      "parentCidr": "10.42.0.0/21",
      "region": "stockholm",
      "status": "active",
      "subnetCount": 1,
      "attachedVpsCount": 1,
      "actions": {
        "canDelete": {
          "allowed": false,
          "reason": "Detach all VPS interfaces before deleting this private network."
        },
        "canAddSubnet": {
          "allowed": false,
          "reason": "Private network limit reached."
        }
      },
      "createdAt": "2026-04-27T12:00:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request body failed validation.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "errors": [
    {
      "pointer": "/items/0/domainName",
      "detail": "`domainName` is required.",
      "code": "invalid_request"
    }
  ]
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Too many requests. Retry after the limit resets.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```