## GET /api/v2/vps/{id}/snapshots

**List VPS snapshots**

Return snapshots for a VPS, snapshot quota, feature availability, and create/restore action gates. Get `{id}` from `GET /api/v2/vps` `data[].id`. Snapshot `{snapshotId}` path parameters use the natural `data[].name` value, not a public ID. Snapshots are short-lived local block-on-write restore points for fast rollback, not offsite backups; each item exposes `expiresAt` and snapshots are automatically retained for about 24 hours. If `available` is false or `limits.totalSnapshots` is 0, snapshots are not included on the current plan. To buy or increase snapshot capacity, call `GET /api/v2/vps/{id}/actions/upgrade`, find `configurableOptions[].key === "snapshotSlots"`, then preview/commit `POST /api/v2/vps/{id}/actions/config` with `resources.snapshotSlots`, or change to a plan that includes snapshots. Use VPS backups for offsite, longer-term recovery; backup create/restore can take longer than snapshot rollback.

### Related Endpoints

- `POST /api/v2/vps/{id}/snapshots`: Create VPS snapshot
- `DELETE /api/v2/vps/{id}/snapshots/{snapshotId}`: Delete VPS snapshot
- `POST /api/v2/vps/{id}/snapshots/{snapshotId}/actions/restore`: Restore VPS snapshot

### Headers

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

### Parameters

- `id` (path, string, required): 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. Example: `vps_01hxa3b4c5d6e7f8g9h0j1k2m3`

### Request Example

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

### Response Schema

- `data` (array<object>, required)
- `data[].displayId` (string, required) Example: `before-upgrade`
- `data[].name` (string, required) Example: `before-upgrade`
- `data[].description` (string,null, required) Example: `Before package upgrade`
- `data[].createdAt` (string,null, required) Example: `2026-04-27T10:00:00.000Z`
- `data[].expiresAt` (string,null, required) Example: `2026-04-28T10:00:00.000Z`
- `data[].includesMemoryState` (boolean, required) Example: `false`
- `data[].parentName` (string,null, required) Example: `null`
- `available` (boolean, required) Example: `false`
- `reason` (string,null, required) Example: `Snapshots are not available on your current plan.`
- `limits` (object, required)
- `limits.totalSnapshots` (integer, required): Snapshot slots included with the current plan/configuration. `0` means snapshots are not available until snapshot capacity is added. Example: `0`
- `limits.usedSnapshots` (integer, required): Stored snapshot count excluding the current live disk state. Example: `0`
- `actions` (object, required)
- `actions.canCreate` (object, required)
- `actions.canCreate.allowed` (boolean, required) Example: `true`
- `actions.canCreate.reason` (string,null, required) Example: `null`
- `actions.canCreate.code` (string,null, optional): Machine-readable reason code when an action is blocked. Example: `pending_order`
- `actions.canRestore` (object, required)
- `actions.canRestore.allowed` (boolean, required) Example: `true`
- `actions.canRestore.reason` (string,null, required) Example: `null`
- `actions.canRestore.code` (string,null, optional): Machine-readable reason code when an action is blocked. Example: `pending_order`

### Responses

#### 200 - VPS snapshots with quota and gates.
```json
{
  "data": [],
  "available": false,
  "reason": "Snapshots are not available on your current plan.",
  "limits": {
    "totalSnapshots": 0,
    "usedSnapshots": 0
  },
  "actions": {
    "canCreate": {
      "allowed": false,
      "reason": "Snapshots are not available on your current plan."
    },
    "canRestore": {
      "allowed": false,
      "reason": "Snapshots are not available on your current plan."
    }
  }
}
```

#### 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"
}
```
