List backups to restore from other VPS
GET /api/v2/vps/{id}/backups/restore-sources
Lists the backups on your account that can be restored onto this VPS with POST /api/v2/vps/{id}/backups/actions/restore-from-vps. A source is one of your other servers (server) or backups kept from a server that no longer exists (retained). A retained source can carry this VPS’s own ID. It then holds backups of the server this VPS had before it was deleted and set up again. Each backup has a targetFit for this VPS: fits, grow_required (send growTargetStorage: true with the restore), too_small (choose a bigger target or restore to a new server) or unconfirmed (a size could not be confirmed now; the restore checks again). The VPS must be active.
Authentication: An API key with the scope backup:vm. About keys and scopes
Request
Path parameters
idstringrequiredvps_…).Example
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/backups/restore-sources" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 Backups you can restore onto this VPS.
{ "target": { "storageGb": 50, "actions": { "canGrowStorage": { "allowed": true, "reason": null } } }, "sources": [ { "id": "vps_01j0b3c4d5e6f7g8h9j0k1m2n3", "name": "web01.example.com", "serviceStatus": "active", "sourceType": "server", "backups": [ { "id": "bkp_01hxa3b4c5d6e7f8g9h0j1k2m3", "displayId": "2026-08-15T03:19:03.000Z (2026-08-15T03:19:03Z)", "storageKey": "2026-08-15T03:19:03Z", "createdAt": "2026-08-15T03:19:03.000Z", "sizeGb": 100, "minimumRestoreStorageGb": 100, "backupType": "scheduled", "note": null, "targetFit": { "status": "grow_required", "reason": "This backup needs 100 GB of storage. The target server has 50 GB; its storage grows to 100 GB as part of the restore.", "code": null, "requiredStorageGb": 100, "targetStorageGb": 50 } } ] } ]}Response fields
targetobjectstorageGbinteger or nullactionsobjectcanGrowStorageobjectallowedbooleanreasonstring or nullcodestring or nullsourcesarray of objectidstringvps_…). It equals the target’s ID only for a retained source with backups of the server this VPS had before.namestringserviceStatusstringactive or terminated.sourceTypestringserver for a server you have now. retained for backups kept from a server that no longer exists. One of server, retained.backupsarray of objectidstringdisplayIdstringstorageKey together, for display. Use id to refer to the backup.storageKeystringcreatedAtstring or nullsizeGbintegerminimumRestoreStorageGb.minimumRestoreStorageGbintegerminimumRestoreStorageSourcestringbackup: read from the backup itself. estimate: worked out from the VPS disk size or the backup size. An estimate can be off when the disk was resized after the backup. The restore checks again before it writes anything. One of backup, estimate.backupTypestringscheduled: made by a backup schedule. manual: any other backup, such as one started through the API or the client area. One of manual, scheduled.notestring or nullManual backup. Null when there is none.actionsobjectcanRestore.allowed: false, even when the VPS allows restores.canRestoreobjectallowedbooleanreasonstring or nullcodestring or nulldiskImageInventoryobjectsource is pbs_manifest when the list is complete, partial when disks may be missing from it and unavailable when it could not be read. The current disks of the VPS say nothing about what an older backup holds. A disk missing from a partial or unavailable list may still be in the backup.sourcestringpbs_manifest, partial, unavailable.disksarray of objectslotstringsizeGbnumber or nulltargetFitobjectstatus. reason is text to show when it is not fits.statusstringfits, grow_required, too_small, unconfirmed.reasonstring or nullcodestring or nulltoo_small and unconfirmed. Null for fits and grow_required. One of plan_fixed, no_permission, owner_unconfirmed, allowance_exceeded, allowance_check_failed, target_storage_unconfirmed, backup_size_estimated.requiredStorageGbintegertargetStorageGbinteger or nullErrors
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. |