List VPS backup schedules
GET /api/v2/vps/{id}/backup-schedules
Returns the backup schedule of a VPS with its backup settings, the 20 newest backups, its limits and the actions you can take. A VPS has at most one schedule. Use schedules[].id to delete it. limits.maxRetention is the highest retentionCount a schedule may use. Check actions.canCreate, actions.canUpdateSettings or actions.canDelete before the matching call. Backups are offsite copies kept longer than snapshots. They can take longer to create and restore.
Authentication: An API key with the scope read:vm. About keys and scopes
Request
Path parameters
idstringrequiredThe VPS ID (
vps_…).Example
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/backup-schedules" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 The backup schedule, settings, recent backups, limits and action gates.
{ "schedules": [ { "id": "bks_01hxa3b4c5d6e7f8g9h0j1k2m3", "name": "Weekly backup", "frequency": "weekly", "time": "02:00", "daySpecifier": "1", "retentionCount": 5, "enabled": true, "lastRun": "2026-04-27T00:00:00.000Z", "nextRun": "2026-05-04T00:00:00.000Z", "status": null, "lastRunStatus": "completed", "lastRunAt": "2026-04-27T00:00:00.000Z" } ], "settings": { "totalBackupLimit": 5, "manualBackupsActive": 1, "scheduledBackupsActive": 2, "availableScheduledSlots": 2, "autoDeleteOldest": true }, "history": [ { "backupType": "scheduled", "status": "running", "createdAt": "2026-04-27T00:00:00.000Z", "updatedAt": "2026-04-27T00:41:00.000Z", "note": "Weekly 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 } }}Response fields
schedulesarray of objectidstringSchedule ID (
bks_…).namestringLabel of the schedule.
frequencystringHow often it runs:
daily, weekly or monthly. One of daily, weekly, monthly.timestring or nullTime of day it runs,
HH:MM in Europe/Stockholm time.daySpecifierstring or nullDay of the week (0 is Sunday) for
weekly. Day of the month for monthly. Null for daily.retentionCountintegerHow many scheduled backups it keeps.
enabledbooleanWhether the schedule runs.
lastRunstring or nullWhen it last ran.
nextRunstring or nullWhen it runs next.
statusstring or nullStatus of the schedule, when one is reported. Read
lastRunStatus for the result of its last backup. One of completed, running, queued, failed, cancelled, unknown.lastRunStatusstring or nullResult of the newest backup this schedule made:
completed, failed or queued. Null when it has not run yet. One of completed, running, queued, failed, cancelled, unknown.lastRunAtstring or nullWhen the newest backup of this schedule started. Null when it has not run yet.
settingsobjecttotalBackupLimitintegerMost backups kept for this VPS, manual and scheduled together.
manualBackupsActiveintegerManual backups stored now.
scheduledBackupsActiveintegerScheduled backups stored now.
availableScheduledSlotsintegerBackups the schedule can still keep next to the manual ones.
autoDeleteOldestbooleanWhether the oldest scheduled backups are deleted when a new scheduled backup needs room.
historyarray of objectThe 20 most recent backups of the VPS, manual and scheduled, newest first.
backupTypestring or nullscheduled or manual.statusstringState of the backup. Today a finished backup that is still stored shows
running, not completed. A deleted backup shows unknown. queued is a backup still being made. failed is one that failed. For the result of a scheduled run, read schedules[].lastRunStatus. One of completed, running, queued, failed, cancelled, unknown.createdAtstring or nullupdatedAtstring or nullnotestring or nullLabel stored with the backup.
limitsobjectmaxSchedulesintegerMost schedules a VPS can have. Always 1.
totalBackupsintegerMost backups kept for this VPS.
maxRetentionintegerHighest
retentionCount a schedule may use.currentSchedulesintegerSchedules the VPS has now.
manualBackupsActiveintegerManual backups stored now.
scheduledBackupsActiveintegerScheduled backups stored now.
availableScheduledSlotsintegerBackups the schedule can still keep next to the manual ones.
actionsobjectcanCreateobjectWhether
POST /api/v2/vps/{id}/backup-schedules can create a schedule now.allowedbooleanreasonstring or nullcodestring or nullA machine-readable code for why the action is blocked.
canUpdateSettingsobjectWhether
PATCH /api/v2/vps/{id}/backup-schedules can change the settings now.allowedbooleanreasonstring or nullcodestring or nullA machine-readable code for why the action is blocked.
canDeleteobjectWhether the schedule can be deleted now.
allowedbooleanreasonstring or nullcodestring or nullA machine-readable code for why the action is blocked.
Errors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | Invalid request. The response body is an RFC 7807 Problem Details document. |
| 401 | Unauthorized. Authentication is required. |
| 403 | Forbidden. The caller lacks a required scope or does not own the resource. |
| 404 | Not found. The resource does not exist or is not owned by the caller; code is vps_not_found. |
| 429 | Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. |
| 500 | Internal error. Retry later or contact support if the issue persists. |
| 502 | Upstream failure. A dependent provider request failed; the Problem Details code is upstream_failed. Retry later or contact support if the issue persists. |