List VPS backup schedules

GET /api/v2/vps/{id}/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.

VPS Services Backups

Authentication

Required API scope: read:vm

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

Path Parameters

id string required Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3

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.

Headers

Authorization Bearer <token>
Accept application/json

Responses

200 VPS backup schedules, settings, history, and gates.
schedules array<object> required
schedules[].id string required · Example: bks_01hxa3b4c5d6e7f8g9h0j1k2m3
schedules[].name string required · Example: Nightly backup
schedules[].frequency string · enum required · Example: daily
daily
weekly
monthly
schedules[].time string · nullable required · Example: 02:00

Nullable: may be null when not applicable.

schedules[].daySpecifier string · nullable required · Example: 1

Nullable: may be null when not applicable.

schedules[].retentionCount integer required · Example: 3
schedules[].enabled boolean required · Example: true
schedules[].lastRun string · nullable required · Example: 2026-04-27T02:00:00.000Z

Nullable: may be null when not applicable.

schedules[].nextRun string · nullable required · Example: 2026-04-28T02:00:00.000Z

Nullable: may be null when not applicable.

schedules[].status string · nullable · enum required · Example: null

Nullable: may be null when not applicable.

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 · nullable required · Example: scheduled

Nullable: may be null when not applicable.

history[].status string · enum required · Example: running
completed
running
queued
failed
cancelled
unknown
history[].createdAt string · nullable required · Example: 2026-04-27T02:00:00.000Z

Nullable: may be null when not applicable.

history[].updatedAt string · nullable required · Example: null

Nullable: may be null when not applicable.

history[].note string · nullable required · Example: Nightly backup

Nullable: may be null when not applicable.

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 · nullable required · Example: null

Nullable: may be null when not applicable.

actions.canCreate.code string · nullable · Example: pending_order

Machine-readable reason code when an action is blocked.

actions.canUpdateSettings object required
actions.canUpdateSettings.allowed boolean required · Example: true
actions.canUpdateSettings.reason string · nullable required · Example: null

Nullable: may be null when not applicable.

actions.canUpdateSettings.code string · nullable · Example: pending_order

Machine-readable reason code when an action is blocked.

actions.canDelete object required
actions.canDelete.allowed boolean required · Example: true
actions.canDelete.reason string · nullable required · Example: null

Nullable: may be null when not applicable.

actions.canDelete.code string · nullable · Example: pending_order

Machine-readable reason code when an action is blocked.

400 Invalid request. The response body is an RFC 7807 Problem Details document.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
401 Unauthorized. Authentication is required.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
403 Forbidden. The caller lacks a required scope or does not own the resource.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
404 Not found. The resource does not exist or is not owned by the caller.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
500 Internal error. Retry later or contact support if the issue persists.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
GET https://cloud.hostup.se/api/v2/vps/{id}/backup-schedules
For AI assistants
View as Markdown
cURL 
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 
{
  "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
    }
  }
}