Lock, download, cancel and delete snapshots

The Snapshots page lists every snapshot on your account, from every server you have had, as cards (Find your snapshots). The ... menu on each card, or at the end of its row in the table, locks the snapshot, downloads its archive, cancels it while it is still being taken, or deletes it. A server's own Snapshots tab has the same menu for the snapshots in its list.

• Only the account that holds a snapshot can lock, download, cancel or delete it. Someone you share a server with cannot, even with the Snapshots permission (Share a server with other users).
• You can download a snapshot once its status is Completed.

1. In the dashboard, select Snapshots in the sidebar.
2. To see one group, open Show and choose Ready, In progress, Failed, Locked, Deleted servers or Needs attention. All snapshots shows every snapshot again. The Ready and Needs attention tiles filter the list too.
3. To search, type part of a snapshot's name, its server, its software, its status or its location in the search box, "Search by snapshot, server or software".
4. To sort the list, open Sort by. The list starts with the newest snapshot first. In the table, you can also select a column heading.

When nothing matches, the page shows No matches. Select Reset filters to clear the search and the filter. Clear filters in the toolbar does the same.

When a snapshot failed, took too long or is on hold, the strip under the tiles names it with a button. A failed snapshot of a server that is gone has Delete snapshot… there, and a snapshot that is taking too long has Cancel snapshot…. Both ask the same question as the card's menu, described below.

Open the snapshot's ... menu and select Lock. A Locked badge shows beside the snapshot's name. To remove the lock, select Unlock in the same menu.

While a snapshot is locked:

• Nobody can delete it from the dashboard or the API.
• A schedule never deletes it to make room for a new snapshot.
• If we took it before suspending a server, we keep it when the server is unsuspended (Snapshots and backups compared).

Lock and Unlock are greyed out while the snapshot is being taken, restored or deleted.

1. Open the snapshot's ... menu and select Download. It is greyed out until the snapshot is Completed.
2. The download opens in a new browser tab. The file is a .tar.gz archive named after the snapshot's ID.

The link works for 6 hours by default. To download the snapshot again later, select Download again for a new link. You can download a snapshot while an invoice is unpaid.

While a snapshot's status is Pending or Creating, Cancel snapshot… takes the place of Delete snapshot… in the menu at the end of its row.

1. Open the snapshot's ... menu and select Cancel snapshot….
2. Select Cancel snapshot to confirm. Keep going closes the dialog and lets the snapshot carry on.

We stop the snapshot, discard what it saved so far, and remove it from the list. The server keeps running, and you can take a new snapshot of it straight away. You can cancel a locked snapshot. You cannot cancel one we put on hold.

If the snapshot finished before you confirmed, we leave it alone and it shows as Completed. Delete it if you do not want it.

You do not have to cancel a snapshot that is stuck. When one stops making progress, we stop it on our own after an hour, or longer on a server with a lot on disk, and 12 hours after it started at most. It then shows as Failed, with This snapshot stopped making progress, so we stopped it after … under its name.

1. Open the snapshot's ... menu and select Delete snapshot…. It is greyed out while the snapshot is locked, and while its status is Restoring or Deleting. While the snapshot is still being taken, the menu offers Cancel snapshot… instead.
2. Type the snapshot's name to confirm, then select Delete snapshot.

You can delete a failed snapshot. A snapshot we put on hold shows an On hold badge, with the reason on its card or in its row, and you cannot delete it until we lift the hold.

• A locked snapshot shows the Locked badge, and the Locked filter lists it.
• A download starts in a new tab.
• A cancelled snapshot leaves the list, and a message confirms it, such as before-1.21-update cancelled.
• A deleted snapshot leaves the list, and a message confirms it, such as before-1.21-update deleted. The space it used is free again at once, and the Storage used tile shows it.

When an action fails, the page shows Could not get a download link, Could not change the lock, Could not cancel the snapshot or Could not delete the snapshot, with one of these messages:

That snapshot is not finished yet

Wait until the snapshot's status is Completed. A failed snapshot has no archive to download.

Object storage did not return a download URL for this snapshot.

The storage that holds the snapshot did not answer. Try again in a few minutes, or contact support.

Cannot delete a locked snapshot

Select Unlock first, then delete the snapshot.

Cannot delete a snapshot while it is being restored

Wait until the restore ends and the snapshot's status is Completed again.

This snapshot is on hold and cannot be deleted.

We put the snapshot on hold, and the badge says On hold and the reason shows with it. Contact support about it.

This snapshot finished before it could be cancelled. Delete it if you do not want to keep it.

The snapshot completed before your cancel reached it, so we kept it. Delete it if you do not want it.

Only a snapshot that is still being taken can be cancelled. This one is …

The message names the snapshot's status, such as failed or restoring. A failed snapshot can be deleted instead.

This snapshot is on hold and cannot be cancelled.

We put the snapshot on hold. Contact support about it.

We could not reach storage to cancel this snapshot. Try again in a minute.

Nothing changed, and the snapshot is still being taken. Try again in a minute.

Cannot change the lock while the snapshot is creating

The message names pending, creating, restoring or deleting. Wait until that finishes, then try again.

Snapshot … not found

The snapshot is gone, or another account holds it. On a server someone shared with you, the snapshots belong to the owner, so only the owner can lock, download or delete them.

• Snapshots
• Restore a snapshot onto a server
• How snapshot storage works
• Take a server snapshot

Each request takes a snapshot's uuid from GET /api/v1/client/snapshots and works only on your own account's snapshots. Another account's snapshot answers 404 with Snapshot … not found.

Lock a snapshot, or unlock a locked one:

curl -X POST https://api.coritan.com/api/v1/client/snapshots/$SNAPSHOT/lock \
  -H "Authorization: Bearer $CORITAN_TOKEN"

The request turns the lock on when it is off, and off when it is on. It returns the snapshot with its new is_locked. A snapshot that is being taken, restored or deleted answers 409.

Get a download link:

curl https://api.coritan.com/api/v1/client/snapshots/$SNAPSHOT/download \
  -H "Authorization: Bearer $CORITAN_TOKEN"

The response is {"url": "…"}, a signed link to the archive that works for 6 hours by default. Fetch the link as it is, with no Authorization header:

curl -o before-1.21-update.tar.gz "$URL"

A snapshot that is not completed answers 409, and 503 means the storage did not return a link. A snapshot of a free server that a brand sells answers 403 while that server is on the free plan (How free servers work).

Delete a snapshot:

curl -X DELETE https://api.coritan.com/api/v1/client/snapshots/$SNAPSHOT \
  -H "Authorization: Bearer $CORITAN_TOKEN"

The response is {"message": "Snapshot deleted"}. A locked snapshot answers 400, one on hold answers 403, and one that is being restored answers 409.

Cancel a snapshot whose status is still pending or creating:

curl -X POST https://api.coritan.com/api/v1/client/snapshots/$SNAPSHOT/cancel \
  -H "Authorization: Bearer $CORITAN_TOKEN"

The response is {"message": "Snapshot cancelled"}, and the snapshot is gone from GET /api/v1/client/snapshots. A locked snapshot can be cancelled. One that has already finished or failed answers 409 (delete it instead), one on hold answers 403, and 503 means we could not reach storage: nothing changed, so try again.