Manage server backups

Snapshots have replaced backups. You cannot create a new backup, so take a snapshot instead: it saves the same files, and you can restore it onto a different server too. The backups a server already has keep working. The Backups tab lists them, and from it you can restore, download, lock and delete them.

• Only servers that took backups before snapshots replaced them have any. Free servers never had backups.
• On a server someone shared with you, the owner must have given you the Backups permission.

1. In the dashboard, go to Container Apps and open the server, then the Backups tab.
2. Open the menu at the end of the backup's row and select Restore…. Only a finished backup offers it.
3. Type the backup's name to confirm, then select Restore backup.

We stop the server, delete its current files and put the backup's files in their place. You lose every change made since the backup. A backup holds the server's files only, so its databases stay as they are.

Open the menu at the end of the backup's row and select Download. The download opens in a new browser tab. The file is a .tar.gz archive named after the backup's ID, and the link works for 10 minutes.

Open the menu at the end of the backup's row and select Lock. A Locked badge shows beside its name, and nobody can delete it until someone selects Unlock.

1. Open the menu at the end of the backup's row and select Delete backup…. It is greyed out while the backup is locked.
2. Type the backup's name to confirm, then select Delete backup.

We delete the archive from storage, and you cannot undo it.

A message confirms each action, such as Restore started., Backup locked. or Backup deleted. The Status column shows each backup's state, and a failed backup shows its error under its name.

Backups have been replaced by snapshots. …

New backup… still shows on the tab, but it cannot create a backup. Take a snapshot instead.

A backup or restore is already in progress on this server; wait for it to finish before you restore.

Wait until the other restore finishes, then try again.

Only a finished backup can be restored

The backup failed or never finished. Restore another backup, or a snapshot.

Cannot restore while the server is installing

Wait until the server has finished installing or being moved, then try again.

This backup failed, so there is nothing to download

A failed backup has no archive. Download another backup.

Cannot delete locked backup

Select Unlock first, then delete it.

Too many requests for this action. Please wait and try again.

You started more than 8 restores on this server in 5 minutes. Wait a few minutes and try again.

• Take a server snapshot
• Snapshots and backups compared
• Restore a snapshot onto a server

GET /api/v1/client/servers/{uuid}/backups lists the server's backups. Each has uuid, name, status, size_bytes, is_locked, ignored_files and created_at. status is completed for a backup you can restore or download, failed, or pending, creating, restoring or deleting while work is under way.

POST /api/v1/client/servers/{uuid}/backups answers 410 with reason set to replaced_by_snapshots and replacement set to snapshots. Create a snapshot with POST /api/v1/client/servers/{uuid}/snapshots instead.

Restore a backup:

curl -X POST https://api.coritan.com/api/v1/client/servers/$SERVER/backups/$BACKUP/restore \
  -H "Authorization: Bearer $CORITAN_TOKEN"

The response is {"message": "Restore initiated", "status": "restoring"}.

GET /api/v1/client/servers/{uuid}/backups/{backup_uuid}/download returns a signed url to fetch the archive from, valid for expires_in seconds (600), with the backup's name, its size in bytes, and a filename.

POST /api/v1/client/servers/{uuid}/backups/{backup_uuid}/lock locks an unlocked backup or unlocks a locked one, and returns the backup with its new is_locked. DELETE /api/v1/client/servers/{uuid}/backups/{backup_uuid} deletes an unlocked backup.

On a server shared with you, listing needs backup.read, restoring needs backup.restore, downloading needs backup.download, and locking or deleting needs backup.delete. The Backups permission in the dashboard grants all of them.