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

**List VPS backup schedules**

Return scheduled-backup configuration, retention settings, recent schedule history, limits, and action gates. Get `{id}` from `GET /api/v2/vps`. Use `schedules[].id` as `{scheduleId}` for deletion. Only one schedule can be active per VPS; POST updates an existing schedule with the same frequency. Scheduled backups create offsite, longer-term recovery images and can take longer to create or restore than snapshots. Use snapshot schedules only for short-lived local block-on-write rollback points.

### Related Endpoints

- `POST /api/v2/vps/{id}/backup-schedules`: Create or replace VPS backup schedule
- `PATCH /api/v2/vps/{id}/backup-schedules`: Update VPS backup settings
- `DELETE /api/v2/vps/{id}/backup-schedules/{scheduleId}`: Delete VPS backup schedule

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

### Response Schema

- `schedules` (array<object>, required)
- `schedules[].id` (string, required) Example: `bks_01hxa3b4c5d6e7f8g9h0j1k2m3`
- `schedules[].name` (string, required) Example: `Nightly backup`
- `schedules[].frequency` (string, required) Example: `daily`
  Allowed values: daily, weekly, monthly
- `schedules[].time` (string,null, required) Example: `02:00`
- `schedules[].daySpecifier` (string,null, required) Example: `1`
- `schedules[].retentionCount` (integer, required) Example: `3`
- `schedules[].enabled` (boolean, required) Example: `true`
- `schedules[].lastRun` (string,null, required) Example: `2026-04-27T02:00:00.000Z`
- `schedules[].nextRun` (string,null, required) Example: `2026-04-28T02:00:00.000Z`
- `schedules[].status` (string,null, required) Example: `null`
  Allowed values: completed, running, queued, failed, cancelled, unknown, 
- `settings` (object, required) Example: `null`
- `settings.totalBackupLimit` (integer, required) Example: `5`
- `settings.manualBackupsActive` (integer, required) Example: `1`
- `settings.scheduledBackupsActive` (integer, required) Example: `2`
- `settings.availableScheduledSlots` (integer, required) Example: `2`
- `settings.autoDeleteOldest` (boolean, required) Example: `true`
- `history` (array<object>, required)
- `history[].backupType` (string,null, required) Example: `scheduled`
- `history[].status` (string, required) Example: `running`
  Allowed values: completed, running, queued, failed, cancelled, unknown
- `history[].createdAt` (string,null, required) Example: `2026-04-27T02:00:00.000Z`
- `history[].updatedAt` (string,null, required) Example: `null`
- `history[].note` (string,null, required) Example: `Nightly backup`
- `limits` (object, required)
- `limits.maxSchedules` (integer, required) Example: `1`
- `limits.totalBackups` (integer, required) Example: `5`
- `limits.maxRetention` (integer, required) Example: `5`
- `limits.currentSchedules` (integer, required) Example: `1`
- `limits.manualBackupsActive` (integer, required) Example: `1`
- `limits.scheduledBackupsActive` (integer, required) Example: `2`
- `limits.availableScheduledSlots` (integer, required) Example: `2`
- `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.canUpdateSettings` (object, required)
- `actions.canUpdateSettings.allowed` (boolean, required) Example: `true`
- `actions.canUpdateSettings.reason` (string,null, required) Example: `null`
- `actions.canUpdateSettings.code` (string,null, optional): Machine-readable reason code when an action is blocked. Example: `pending_order`
- `actions.canDelete` (object, required)
- `actions.canDelete.allowed` (boolean, required) Example: `true`
- `actions.canDelete.reason` (string,null, required) Example: `null`
- `actions.canDelete.code` (string,null, optional): Machine-readable reason code when an action is blocked. Example: `pending_order`

### Responses

#### 200 - VPS backup schedules, settings, history, and gates.
```json
{
  "schedules": [
    {
      "id": "bks_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "name": "Nightly backup",
      "frequency": "weekly",
      "time": "02:00",
      "daySpecifier": "1",
      "retentionCount": 7,
      "enabled": true,
      "lastRun": "2026-04-27T02:00:00.000Z",
      "nextRun": "2026-05-04T02:00:00.000Z",
      "status": null
    }
  ],
  "settings": {
    "totalBackupLimit": 5,
    "manualBackupsActive": 1,
    "scheduledBackupsActive": 2,
    "availableScheduledSlots": 2,
    "autoDeleteOldest": true
  },
  "history": [
    {
      "backupType": "scheduled",
      "status": "running",
      "createdAt": "2026-04-27T02:00:00.000Z",
      "updatedAt": null,
      "note": "Nightly backup"
    }
  ],
  "limits": {
    "maxSchedules": 1,
    "totalBackups": 5,
    "maxRetention": 5,
    "currentSchedules": 1,
    "manualBackupsActive": 1,
    "scheduledBackupsActive": 2,
    "availableScheduledSlots": 2
  },
  "actions": {
    "canCreate": {
      "allowed": false,
      "reason": "A backup schedule already exists. Update or delete it before creating another."
    },
    "canUpdateSettings": {
      "allowed": true,
      "reason": null
    },
    "canDelete": {
      "allowed": true,
      "reason": 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"
}
```