Skip to content

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

idstringrequired
The ID of the target VPS (vps_…).

Example

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

Response 200
{
"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
targetobject
The VPS in the path.
storageGbinteger or null
Storage of this VPS in GB. Null when it could not be read.
actionsobject
canGrowStorageobject
Whether this VPS’s storage can grow during a restore. Only a Cloud VPS can grow. A fixed plan keeps its disk.
allowedboolean
reasonstring or null
codestring or null
A machine-readable code for why the action is blocked.
sourcesarray of object
idstring
Source VPS ID (vps_…). It equals the target’s ID only for a retained source with backups of the server this VPS had before.
namestring
Name of the source server.
serviceStatusstring
Status of the source service, for example active or terminated.
sourceTypestring
server for a server you have now. retained for backups kept from a server that no longer exists. One of server, retained.
backupsarray of object
idstring
displayIdstring
Creation time and storageKey together, for display. Use id to refer to the backup.
storageKeystring
The backup’s name in storage, for display.
createdAtstring or null
When the backup was made. Null when not known.
sizeGbinteger
Size of the backup, rounded to whole GB. Do not use it to size a restore target. Use minimumRestoreStorageGb.
minimumRestoreStorageGbinteger
The smallest disk, in GB, a VPS needs to take this backup. Use it when you restore to a new or another VPS. 0 for a backup with no disk data.
minimumRestoreStorageSourcestring
backup: 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.
backupTypestring
scheduled: 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 null
The label stored with the backup. A manual backup made without a note has Manual backup. Null when there is none.
actionsobject
Whether this backup can be restored. A backup with configuration only and no disk data has canRestore.allowed: false, even when the VPS allows restores.
canRestoreobject
allowedboolean
reasonstring or null
codestring or null
A machine-readable code for why the action is blocked.
diskImageInventoryobject
The disk images stored in this backup, read from the backup itself. source 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.
sourcestring
One of pbs_manifest, partial, unavailable.
disksarray of object
slotstring
sizeGbnumber or null
Size of the disk image in GiB, when recorded.
targetFitobject
Whether this backup fits on the VPS in the path. Branch on status. reason is text to show when it is not fits.
statusstring
One of fits, grow_required, too_small, unconfirmed.
reasonstring or null
codestring or null
Machine-readable reason for too_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.
requiredStorageGbinteger
Disk size the restore creates on the target, in GB.
targetStorageGbinteger or null
Storage of the target now, in GB. Null when unconfirmed.

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller; code is vps_not_found.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.