Set VPS snapshot schedule

Read full description Hide full description

Create or replace the singleton snapshot schedule for a VPS. Read GET /api/v2/vps/{id}/snapshot-schedules first; if available is false, limits.totalSnapshots is 0, or actions.canEnable.allowed is false, the POST will be rejected. Snapshot schedules use the same short-lived local block-on-write snapshot slots as manual snapshots; they are for fast rollback and are not offsite backups. Snapshots are automatically retained for about 24 hours. 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. intervalHours is floored and clamped by the route to the supported range 4 through 24 hours.

VPS Services Snapshots

Authentication

Required API scope: write:vm

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

Context

Related endpoints

GET /api/v2/vps/{id}/snapshot-schedules Get VPS snapshot schedule DELETE /api/v2/vps/{id}/snapshot-schedules Delete VPS snapshot schedule GET /api/v2/vps/{id} Get VPS details

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

Accept Example

Content-Type Example

Body

required

application/json

enabled boolean required · Example: true

intervalHours number required · Example: 12

Responses

200 Snapshot schedule saved.

schedule objectnull required · Example: null

limits object required

limits.totalSnapshots integer required · Example: 3

Snapshot slots included with the current plan/configuration. `0` means scheduling cannot be enabled until snapshot capacity is added.

available boolean required · Example: true

True when the current plan/configuration includes at least one snapshot slot.

reason stringnull required · Example: null

actions object required

actions.canEnable object required

actions.canEnable.allowed boolean required · Example: true

actions.canEnable.reason stringnull required · Example: null

actions.canEnable.code stringnull · 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

POST https://cloud.hostup.se/api/v2/vps/{id}/snapshot-schedules

For AI assistants

View as Markdown

cURL

curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/snapshot-schedules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "intervalHours": 12
  }'

Response

{
  "schedule": {
    "enabled": true,
    "intervalHours": 12,
    "lastRun": "2026-04-27T00:00:00.000Z",
    "nextRun": "2026-04-27T12:00:00.000Z"
  },
  "limits": {
    "totalSnapshots": 3
  },
  "available": true,
  "reason": null,
  "actions": {
    "canEnable": {
      "allowed": true,
      "reason": null
    }
  }
}

{
  "type": "object",
  "properties": {
    "schedule": {
      "type": [
        "object",
        "null"
      ]
    },
    "limits": {
      "type": "object",
      "properties": {
        "totalSnapshots": {
          "type": "integer",
          "description": "Snapshot slots included with the current plan/configuration. `0` means scheduling cannot be enabled until snapshot capacity is added."
        }
      }
    },
    "available": {
      "type": "boolean",
      "description": "True when the current plan/configuration includes at least one snapshot slot."
    },
    "reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "actions": {
      "type": "object",
      "properties": {
        "canEnable": {
          "type": "object",
          "properties": {
            "allowed": {
              "type": "boolean"
            },
            "reason": {
              "type": [
                "string",
                "null"
              ]
            },
            "code": {
              "type": [
                "string",
                "null"
              ],
              "description": "Machine-readable reason code when an action is blocked."
            }
          }
        }
      }
    }
  }
}

Request Body Enable snapshot schedule

{
  "enabled": true,
  "intervalHours": 12
}