Skip to content
Coritan Docs

Snapshots

Full archives of your servers kept on your account, so you can restore them onto any server after the original is gone.

View as Markdown

A snapshot is a full archive of a server's files, kept in your account's snapshot storage. It belongs to your account rather than to the server it came from, so it stays after the server is gone and you can restore it onto any of your servers. Snapshots have replaced server backups, which belonged to one server (Snapshots and backups compared). This page is about the snapshots of your game servers. A Cloud Compute instance keeps its snapshots and backups on its own page (Take and roll back instance snapshots).

The public Snapshot Storage page describes the extra storage you can order for snapshots, with its prices from the catalogue.

In the dashboard, go to Snapshots. The page lists every snapshot on your account, from every server you have had, and each snapshot is one card. You take a snapshot on the server's own Snapshots tab (Take a server snapshot). Take a snapshot… at the top of the page lists your servers under Which server?, and choosing one opens that server's Take a snapshot page. With one server, the button opens that page at once. With none, the button reads Order a server. Order Snapshot Storage next to it opens the order page. A Cloud Compute instance is not in the list: it keeps its snapshots on its own storage, so you take them on the instance's Snapshots tab (Take and roll back instance snapshots). While a search or filter is on, "N of M" next to the title says how many snapshots match. The page refreshes by itself while a snapshot is being taken, restored or deleted.

Four tiles sit above the list. Snapshots, Ready and Needs attention are also filters: select one to show those snapshots, and select it again to turn the filter off. Storage used is a fact and does nothing when you select it. On a phone, a tile shows only its figure, and the storage meter stays.

  • Snapshots counts every snapshot. Its footer gives the number of servers and their total size, such as "3 servers, 28.2 GB", or "None yet". Selecting it clears every filter and the search.
  • Ready counts the snapshots you can restore, which are the ones with the status Completed. Its footer reads "N in progress", or "All finished".
  • Storage used shows how much of your snapshot allowance the snapshots take, such as "31.0 GB of 150.0 GB", with a meter under it. With no allowance, it reads "31.0 GB used". Its footer reads "119.0 GB left", "Over by 55.5 GB" or "No allowance yet", followed by Order storage, which opens the order page. The tile turns red while the account is over its allowance (How snapshot storage works).
  • Needs attention counts the snapshots with something to fix. Its footer reads "Failed, stuck or on hold", or "Nothing to fix". It turns red while the count is above zero. It counts snapshots only. The account's own problems, listed below, are not in the count.

When something needs attention, a strip under the tiles says "1 snapshot needs attention" or "3 snapshots need attention". While it also lists a problem of the account itself, it says "3 items need attention". It lists up to three rows, or one on a phone, the worst first. Each row has a name, the reason and a button. A snapshot's name opens the list filtered to it. When more are waiting than the strip lists, Show all and a number filters the list to every snapshot that needs attention. That number is the same as the strip's title: the snapshots and the account's own problems together. The strip is hidden while any filter or search is on. While Show is Needs attention, the page shows the snapshots with a problem as cards, and the account's own problems as alerts above them, with the same sentences and buttons, so Show all opens the snapshot cards and the alerts that its number counts.

A snapshot needs attention when:

Reason on the list Button What it means
On hold: and the reason Contact support We put the snapshot on hold. You cannot delete it until we lift the hold.
The snapshot's error, or "This snapshot did not finish." Open server while the server exists, or Delete snapshot… when the server is gone The snapshot failed. A locked snapshot or one on hold has no delete button. Delete snapshot… asks you to type the snapshot's name, as it does on the card.
Taking longer than expected. Cancel snapshot… The snapshot is still Pending or Creating an hour after we started it. A snapshot on hold has no button. Cancel snapshot… asks the same question as the card (Cancel a snapshot in progress).

The strip also lists problems of the account. They are named "Snapshot storage", or by the storage plan, such as "Snapshot Storage 50 GB #1077", and they are not snapshots:

Reason on the strip Button What it means
Over the allowance. We delete the oldest unlocked snapshots from the cleanup date and time. Order Snapshot Storage Your snapshots take more than the allowance. With no cleanup date, it reads "Over the allowance. We stop taking snapshots until the account fits again." (When the account is over).
This plan is suspended. Pay the invoice to turn it back on. Open invoices A snapshot storage service is suspended.
This plan ends on a date. Its space then leaves your allowance. Open billing A snapshot storage service is ending. Without a date, it reads "This plan is ending."
Snapshot storage is 94% full. Order more so new snapshots have room. Order Snapshot Storage Your snapshots take 90% or more of the allowance, and the account is not over.

A snapshot that is being taken, restored or deleted is not a problem. Its card says "We are taking this snapshot. It can take several minutes.", "We are restoring this snapshot onto a server." or "We are deleting this snapshot." A locked snapshot and a snapshot of a deleted server are not problems either.

The toolbar narrows and orders the list:

  • The search box, "Search by snapshot, server or software", finds a snapshot by its name, its server (by the name it has, or the name it had when the server was deleted), its software, its status or its location.
  • The Show menu holds All snapshots, Ready, In progress, Failed, Locked, Deleted servers and Needs attention, each with a count. The options overlap, because a snapshot can be locked and failed at once, so the counts do not add up to the total.
  • The Sort by menu holds Newest first (the default), Oldest first, Name A to Z, Largest first, Problems first and Server A to Z. Problems first uses the same order as the strip. In the table, selecting a column heading sorts by it, and the menu then shows that column, greyed out, when it has no word of its own.
  • Clear filters appears while Show or the search is on, and turns them off.
  • Cards and Table switch how the list looks, and Refresh reads the list again. Your choice of cards or table stays in your browser. A phone always shows cards and has neither control.

The search, Show, the sort and the page stay in the address, so a reload or a shared link brings them back. The address words are q, status (completed, in_progress, failed, locked, orphaned or attention), sort (created_at, name, -size_bytes, attention or source, and none for the default) and page.

The list shows 24 snapshots a page. When there are more, page buttons appear below it. A search or filter that matches nothing says No matches, with Reset filters. When Refresh fails and the list is on screen, a warning reads Could not refresh your snapshots, with Try again. The list stays as it was. When the first load fails, the page says Could not load your snapshots.

A card shows the snapshot's name, a Locked badge while it is locked, and a status badge: Completed, Pending, Creating, Restoring, Deleting or Failed. A snapshot that we put on hold shows On hold in its place, whatever it was doing. Under them, a red or amber line says each problem from the tables above, up to two. Facts follow:

Fact What it says
Server The server the snapshot came from, which opens that server's Snapshots tab, with its location under it. When the server is gone, the name has a Deleted server badge and no link.
Software What the server ran when we took the snapshot, such as "Paper 1.21.1". "(probably)" follows software that we worked out later, such as "Fabric 1.20.1 (probably)".
Size The size of the archive, or — until it is written.
Taken The date, with the schedule's name under it for a snapshot a schedule took, By the platform for one we took for you, or By support.

The footer of a card holds these controls:

  • A button for each problem that has one, two at most. A card with no such button has Restore onto a server… when the snapshot can be restored (Restore a snapshot onto a server).
  • The ... menu, named "Actions for" and the snapshot's name: Restore onto a server…, Start a server from it, Download, Lock or Unlock, "Open server's Snapshots", and Cancel snapshot… while the snapshot is being taken or Delete snapshot… otherwise. Start a server from it opens the order page with the snapshot chosen (Start a new server from a snapshot). Restore onto a server… opens the restore page, and it, Start a server from it and Download need a Completed snapshot. Lock and Unlock wait while the snapshot is being taken, restored or deleted. Delete snapshot… is greyed out with "Unlock first" while the snapshot is locked, and while it is being written, restored or deleted (Lock, download, cancel and delete snapshots).

Table shows one row for each snapshot, with the same figures:

Column What it says
Snapshot The name with a Locked badge, and under it the software, the error of a failed snapshot and any hold.
Server The server it came from, with its location.
Status The status badge, with a second line when the snapshot has a problem: the reason a snapshot failed, "On hold:" and the reason, or "Taking longer than expected."
Size The size of the archive, on one line.
Taken The date, with who took it when you did not.

The last column is the ... menu from the card. Select a column heading to sort by it.

A note under the list reads "Rotation skips locked snapshots, and you cannot delete one until you unlock it. Restoring stops the target server while we write the files."

Two cards follow the note. Where your storage comes from is a short list of what the allowance adds up from, with the source on the left and its size on the right, such as "Pro plan" and 100.0 GB. It says "Includes a 10.0 GB bonus." when we added one (Where the allowance comes from). Storage plans lists each snapshot storage service you pay for, with its Plan, Status, Price and Renews, and a menu to change its billing cycle or cancel it (Change or cancel snapshot storage). It appears once you have a storage service.

An account with no snapshots sees No snapshots yet, with the line "A snapshot archives a whole game server, so you can restore it later onto the same server or a new one." and a second line for Cloud Compute customers: "A Cloud Compute instance keeps its snapshots and backups on the Snapshots and Backups tabs of its own page, under Cloud Compute." (Cloud Compute there is a link to the product, and Take and roll back instance snapshots describes those tabs). Two cards follow. Take a snapshot says "Open a server and its Snapshots tab to archive it. The snapshot stays on your account after the server is gone." and opens App Deployment. Order Snapshot Storage says "Add space for more and larger snapshots." and opens the order page. The Storage plans card still shows below when you have a storage service.

Take and restore:

Look after them:

Each server plan includes snapshot storage, and the plans on your account add up to one allowance. Your account plan adds to it: 100 GB on Pro and 500 GB on Business, and your agreement sets it on Enterprise (Where the allowance comes from). Extra storage is a service of its own with its own price and billing cycle (Order more snapshot storage), which you change or cancel on the Storage plans card. Billing explains invoices and cancellation.

  • A snapshot holds the server's files only. The server's databases are not in it.
  • A server runs one snapshot or restore at a time.
  • You cannot take or restore a snapshot while the server is installing, being moved or suspended.
  • Server limits and rate limits lists the rest.

GET /api/v1/client/snapshots lists every snapshot on your account, the same list the Snapshots page shows.

Shell
curl https://api.coritan.com/api/v1/client/snapshots \
  -H "Authorization: Bearer $CORITAN_TOKEN"
JSON
[
  {
    "id": 3187,
    "uuid": "5f0c9a2e-7b1d-4e8a-9c3f-2a6d8e1b4c70",
    "name": "before-1.21-update",
    "kind": "container",
    "status": "completed",
    "size_bytes": 1932735283,
    "is_locked": true,
    "created_by": "customer",
    "source_uuid": "1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d",
    "source_name": "survival-smp",
    "source_deleted": false,
    "software_label": "Paper 1.21.4",
    "created_at": "2026-09-16T14:30:00",
    "completed_at": "2026-09-16T14:34:12"
  }
]

Each snapshot also carries these fields:

status
pending or creating while we take it, completed when you can restore or download it, restoring or deleting while that work runs, or failed.
created_by
customer for a snapshot you took, schedule for one a schedule took, with its schedule_uuid and schedule_name, or system for one we made for you. On those, reason is safety_cancel, safety_unpaid or safety_reclaim for one we took before removing a server, legacy_move for the files of a server we moved from the old site, or legacy_backup for one of that server's old backups. You can restore, download and delete a moved snapshot like any other.
error and hold_reason
Why a snapshot failed, and why we put it on hold. You cannot delete a snapshot that is on hold.
source_server_name, source_location and source_used_bytes
The server's current name, where it ran and how much disk it used. source_server_name is null once the server is gone, while source_name keeps the name it had.
software, software_slug and software_version
What the server ran when we took the snapshot. software.inferred is true when we recorded it later, from what the server ran afterwards.
region, checksum and checksum_type
Where the archive is stored, and its checksum.

GET /api/v1/client/snapshots/{snapshot_uuid} returns one snapshot with the same fields. A snapshot that is not on your account answers 404 with Snapshot 5f0c9a2e-7b1d-4e8a-9c3f-2a6d8e1b4c70 not found.

API operations on this page

MethodPathWhat it does
GET/api/v1/client/snapshotsEvery snapshot this account holds, across every server it has had
GET/api/v1/client/snapshots/{snapshot_uuid}One snapshot, for the order form that was handed its uuid in a link