List VPS backups
GET /api/v2/vps/{id}/backups
Lists the backups of a VPS with the backup quota and the actions you can take now. Use a backup’s id as {backupId} to restore or delete it. Check actions.canCreateBackup before you create a backup. Check actions.canRestore and the backup’s own actions.canRestore before you restore one. A backup without disk images holds only the server configuration and cannot restore a server. When listing.status is unavailable, the list could not be read right now. It is then empty and the gates are closed. It does not mean the backups are gone. Backups are offsite copies kept longer than snapshots. They can take longer to create and restore.
Authentication: An API key with the scope read:vm. About keys and scopes
Request
Path parameters
idstringrequiredvps_…).Query parameters
includeDiskCoveragebooleantrue to add diskSelection: which of the current disks backups include, read live from the server. Only the exact value true turns it on. Default false. Default false.Example
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/backups" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 The backups, the quota and the action gates.
{ "backups": [ { "id": "bkp_01hxa3b4c5d6e7f8g9h0j1k2m3", "displayId": "2026-10-27T10:00:00.000Z (2026-10-27T10:00:00Z)", "storageKey": "2026-10-27T10:00:00Z", "createdAt": "2026-10-27T10:00:00.000Z", "sizeGb": 12, "minimumRestoreStorageGb": 50, "minimumRestoreStorageSource": "backup", "actions": { "canRestore": { "allowed": true, "reason": null } }, "diskImageInventory": { "source": "pbs_manifest", "disks": [ { "slot": "scsi0", "sizeGb": 50 } ] }, "backupType": "manual", "note": "Before upgrade" } ], "listing": { "status": "complete", "reason": null }, "quotaInfo": { "used": 1, "limit": 3, "remaining": 2 }, "actions": { "canCreateBackup": { "allowed": true, "reason": null }, "canRestore": { "allowed": true, "reason": null }, "canRestoreToNewCloudVm": { "allowed": true, "reason": null }, "canRestoreToNewRegularVps": { "allowed": true, "reason": null }, "canRestoreFromAnotherVps": { "allowed": true, "reason": null } }}Response fields
diskSelectionobjectincludeDiskCoverage=true. Which current disks backups include.statusstringunavailable when the disks could not be read. That is not an empty disk list. One of confirmed, unavailable.disksarray of objectslotstringsizeGbnumber or nullincludedbooleanreasonstringattached, backup_disabled, detached, cdrom.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 nulllistingobjectstatusstringunavailable when the list could not be read right now. backups is then empty. One of complete, unavailable.reasonstring or nullstatus is unavailable.quotaInfoobjectusedinteger or nulllimitinteger or nullremaininginteger or nullactionsobjectcanCreateBackupobjectPOST /api/v2/vps/{id}/backups can start a backup now.allowedbooleanreasonstring or nullcodestring or nullcanRestoreobjectallowedbooleanreasonstring or nullcodestring or nullcanRestoreToNewCloudVmobjectallowedbooleanreasonstring or nullcodestring or nullcanRestoreToNewRegularVpsobjectallowedbooleanreasonstring or nullcodestring or nullcanRestoreFromAnotherVpsobjectallowedbooleanreasonstring or nullcodestring 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. |