List restore source backups

GET /api/v2/vps/{id}/backups/restore-sources

Lists owned source servers and retained source backups that can be restored onto the active target VPS.

Retained backups from terminated services are returned only when saved ownership metadata ties the backup to the authenticated client/account.

Use a returned sources[].id as sourceVpsId and a nested sources[].backups[].id as backupId when calling POST /api/v2/vps/{id}/backups/actions/restore-from-vps.

VPS Services Backups

Authentication

Required API scope: backup:vm

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

Context

Related endpoints

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

Path Parameters

id string required Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3

Public target VPS 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 Restore sources available to the authenticated client. 1 field

sources array<object> required

sources[].id string required

Public source VPS ID.

sources[].name string required

sources[].serviceStatus string required · Example: terminated

sources[].sourceType string · enum required

server

retained

sources[].backups array<object> required

sources[].backups[].id string required · Example: bkp_01hxa3b4c5d6e7f8g9h0j1k2m3

sources[].backups[].displayId string required · Example: 2026-04-27T10:00:00.000Z (vzdump-qemu-101.vma.zst)

sources[].backups[].storageKey string required · Example: vzdump-qemu-101.vma.zst

sources[].backups[].createdAt string · nullable required · Example: 2026-04-27T10:00:00.000Z

Nullable: may be null when not applicable.

sources[].backups[].sizeGb integer required · Example: 12

sources[].backups[].backupType string required · Example: manual

sources[].backups[].note string · nullable required · Example: Before upgrade

Nullable: may be null when not applicable.

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

GET https://cloud.hostup.se/api/v2/vps/{id}/backups/restore-sources

For AI assistants

View as Markdown

cURL

curl -X GET "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/backups/restore-sources" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "sources": [
    {
      "id": "vps_01j0b3c4d5e6f7g8h9j0k1m2n3",
      "name": "old-server.local",
      "serviceStatus": "terminated",
      "sourceType": "retained",
      "backups": [
        {
          "id": "bkp_01hxa3b4c5d6e7f8g9h0j1k2m3",
          "displayId": "2026-05-24T02:54:03.000Z (2026-05-24T02:54:03Z)",
          "storageKey": "2026-05-24T02:54:03Z",
          "createdAt": "2026-05-24T02:54:03.000Z",
          "sizeGb": 100,
          "minimumRestoreStorageGb": 100,
          "backupType": "scheduled",
          "note": null
        }
      ]
    }
  ]
}

{
  "type": "object",
  "properties": {
    "sources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Public source VPS ID."
          },
          "name": {
            "type": "string"
          },
          "serviceStatus": {
            "type": "string"
          },
          "sourceType": {
            "type": "string",
            "enum": [
              "server",
              "retained"
            ]
          },
          "backups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "displayId": {
                  "type": "string"
                },
                "storageKey": {
                  "type": "string"
                },
                "createdAt": {
                  "type": "string",
                  "nullable": true
                },
                "sizeGb": {
                  "type": "integer"
                },
                "backupType": {
                  "type": "string"
                },
                "note": {
                  "type": "string",
                  "nullable": true
                }
              }
            }
          }
        }
      }
    }
  }
}