Restore backup to a new Cloud VM

POST /api/v2/vps/{id}/backups/{backupId}/actions/restore-to-payg

Create a new pay-as-you-go Cloud VM from one existing VPS backup.

The original VPS is used only to confirm ownership and locate the backup; the restore writes to a newly provisioned Cloud VM.

Get {id} from GET /api/v2/vps data[].id, get {backupId} from GET /api/v2/vps/{id}/backups backups[].id, and check the backup restore action gate before calling.

If the account cannot use Cloud VM yet, the response explains the blocker.

Optional request fields let the caller choose the new VM name, region, CPU, memory, and storage.

If omitted, the API chooses safe defaults from the source VPS and backup size.

VPS Services Backups

Authentication

Required API scopes: backup:vmwrite:billing

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

Context

Related endpoints

POST /api/v2/vps/{id}/backups/{backupId}/actions/restore Restore VPS backup DELETE /api/v2/vps/{id}/backups/{backupId} Delete VPS backup GET /api/v2/vps/{id}/backups List VPS backups

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.

backupId string required Example: bkp_01hxa3b4c5d6e7f8g9h0j1k2m3

Public backup ID from GET /api/v2/vps/{id}/backups backups[].id. Do not invent this value; use the exact ID returned by the referenced API response.

Headers

Authorization Bearer <token>

Accept application/json

Content-Type application/json

Body

optional

application/json

name string · Example: restore-web-01

DNS-safe hostname for the new Cloud VM. Use only letters, numbers, hyphens, and dots; each label must start and end with a letter or number. Underscores are not allowed. Omit it to let the API generate one.

region string · Example: stockholm

Deployment region for the new Cloud VM. Omit it to use the default region.

cpuCores integer · min: 1 · max: 32 · Example: 2

CPU cores for the new Cloud VM. Omit it to mirror the source VPS within supported limits.

memoryGb integer · min: 1 · max: 256 · Example: 4

Memory in GB for the new Cloud VM. Omit it to mirror the source VPS within supported limits.

storageGb integer · min: 1 · max: 2000 · Example: 80

Storage in GB for the new Cloud VM. Must be at least the larger of the source VPS storage and backup size. Omit it to let the API choose the required size.

Responses

202 Restore to a new Cloud VM was queued. 1 field

operation object

operation.status string · enum required · Example: queued

Operation status. 202 Accepted responses only carry pending, queued, or in_progress; the terminal completed and failed values appear only in 200 OK responses for operations that finished within the request, or when polling pollUrl.

pending

queued

in_progress

completed

failed

operation.jobId string required · Example: job_01hxa3b4c5d6e7f8g9h0j1k2m3

operation.pollUrl string · nullable required · Example: /api/jobs/job_01hxa3b4c5d6e7f8g9h0j1k2m3

URL to poll for progress while the operation is in flight. null when status is already terminal (completed or failed), so there is nothing left to poll.

400 Invalid request. The response body is an RFC 7807 Problem Details document. 10 fields

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. 10 fields

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. 10 fields

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. 10 fields

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. 10 fields

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. 10 fields

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}/backups/{backupId}/actions/restore-to-payg

For AI assistants

View as Markdown

cURL

curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/backups/bkp_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/restore-to-payg" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "operation": {
    "status": "queued",
    "jobId": "job_01hxa3b4c5d6e7f8g9h0j1k2m3",
    "pollUrl": "/api/jobs/job_01hxa3b4c5d6e7f8g9h0j1k2m3"
  }
}

{
  "type": "object",
  "properties": {
    "operation": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "description": "Operation status. `202 Accepted` responses only carry `pending`, `queued`, or `in_progress`; the terminal `completed` and `failed` values appear only in `200 OK` responses for operations that finished within the request, or when polling `pollUrl`.",
          "enum": [
            "pending",
            "queued",
            "in_progress",
            "completed",
            "failed"
          ]
        },
        "jobId": {
          "type": "string"
        },
        "pollUrl": {
          "type": "string",
          "description": "URL to poll for progress while the operation is in flight. `null` when `status` is already terminal (`completed` or `failed`), so there is nothing left to poll.",
          "nullable": true
        }
      }
    }
  }
}

Request Body Restore with API-selected defaults