## GET /api/v2/vps/{id}/snapshot-schedules

**Get VPS snapshot schedule**

Return the singleton snapshot schedule for a VPS, including plan availability and the `actions.canEnable` gate. Get `{id}` from `GET /api/v2/vps`. There is no per-schedule ID; POST replaces the singleton and DELETE removes it. Snapshots are short-lived local block-on-write restore points for fast rollback, not offsite backups; snapshot items expose `expiresAt` and 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}/snapshot-schedules`: Set VPS snapshot schedule
- `DELETE /api/v2/vps/{id}/snapshot-schedules`: Delete VPS snapshot schedule
- `GET /api/v2/vps/{id}`: Get VPS details

### 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/snapshot-schedules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

### Response Schema

- `schedule` (object,null, required) Example: `null`
- `limits` (object, required)
- `limits.totalSnapshots` (integer, required): Snapshot slots included with the current plan/configuration. `0` means snapshot scheduling cannot be enabled until snapshot capacity is added through the VPS upgrade/config flow. Example: `0`
- `available` (boolean, required): True when the current plan/configuration includes at least one snapshot slot. Example: `false`
- `reason` (string,null, required): Human-readable explanation when snapshots are unavailable, for example when the plan has no snapshot slots. Example: `Snapshots are not available on your current plan.`
- `actions` (object, required)
- `actions.canEnable` (object, required)
- `actions.canEnable.allowed` (boolean, required) Example: `true`
- `actions.canEnable.reason` (string,null, required) Example: `null`
- `actions.canEnable.code` (string,null, optional): Machine-readable reason code when an action is blocked. Example: `pending_order`

### Responses

#### 200 - VPS snapshot schedule state.
```json
{
  "schedule": null,
  "limits": {
    "totalSnapshots": 0
  },
  "available": false,
  "reason": "Snapshots are not available on your current plan.",
  "actions": {
    "canEnable": {
      "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"
}
```