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

In the dashboard

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).

The Snapshots page in the dashboard lists every snapshot on your account, from every server you have had. You take a snapshot on the server's own Snapshots tab (Take a server snapshot).

  • The Snapshot storage card shows how much of the account's allowance is Used, how much is left, and how much each service adds. When the account holds more than its allowance, the card shows Over the allowance with the date we start deleting snapshots.
  • All, Ready, In progress, Failed, Locked and Deleted servers filter the list. Search snapshots matches a snapshot's name, server, software, status or location.
  • The table shows each Snapshot, the Server it came from, its Status, its Size and when it was Taken, newest first. Select a column heading to sort by it.
  • The menu at the end of each row restores, downloads, locks and deletes the snapshot.

Under a snapshot's name, the row can show the software it was taken on, a Locked badge, and the error of a failed snapshot. Under the date, it says who took it when you did not: a schedule's name, By the platform or By support. A snapshot of a server that is gone carries a Deleted server badge. The page refreshes by itself while a snapshot is being taken, restored or deleted.

Take and restore:

Look after them:

Each server plan includes snapshot storage, and the plans on your account add up to one allowance. Extra storage is a service of its own with its own price and billing cycle (Order more snapshot storage). 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.
  • A free server includes enough storage for one snapshot, and you cannot download a snapshot of a free server.
  • 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 took before removing a server. On those, reason is safety_cancel, safety_unpaid or safety_reclaim.
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