How snapshot storage works

Your account has one snapshot allowance: the most that all your snapshots together may take up. The snapshots of every server count against it, including servers you have deleted. The Storage used tile on the Snapshots page shows how much your snapshots take and how much is left. The Snapshot storage card on each server's Snapshots tab shows how much is Used and how much is left.

The allowance is the sum of what your services and your account plan include:

• Each server plan includes an allowance. A plan with no figure of its own includes twice its disk by default. The order page does not show a plan's allowance, but breakdown in the API's answer lists what each of your services adds (With the API).
• Each snapshot storage service adds its size (Order more snapshot storage).
• Your account plan adds 100 GB on Pro and 500 GB on Business. On Enterprise, your agreement sets what it adds. A free trial adds what its plan adds. Free adds nothing, and so does Pro or Business while it is suspended (How account plans work). While account plans do not apply to your account, the plan adds nothing.
• We can add a bonus to your account. The card then says so under its title, such as Includes a 10.0 GB bonus.

On the Snapshots page, the Where your storage comes from card, under the list, lists what each service and the plan add. The plan's line reads such as Pro plan: 100.0 GB, or Pro trial: 100.0 GB during a trial.

A service counts while it is active, while it is suspended and while we remove it. It stops counting when it ends. An order that waits for its first payment adds nothing yet. Other products, such as Cloud Compute instances, add nothing.

The allowance belongs to the account, so it changes with your services and your account plan. Moving a server to a smaller plan lowers it, and so does an account plan that adds less. Ordering a server or storage raises it, and so does a larger account plan.

Each snapshot counts at its size once it is Completed, and keeps counting until it is deleted. The size is the compressed archive, which is usually smaller than the server's disk usage. A snapshot counts the same whoever took it: you, a schedule or us. A failed snapshot counts nothing, and a deleted one stops counting at once.

We check that a new snapshot fits before we take it. The check uses the server's current disk usage, which is usually more than the finished archive needs. When we cannot measure the disk, the check uses the plan's full disk.

The Take a snapshot page shows the estimate against what is left, and Not enough snapshot storage when it does not fit. The API answers 402 with a message such as This snapshot needs 3.2 GiB and your plan includes 20 GiB, of which 18.5 GiB is already in use. Delete an older snapshot or add snapshot storage. (Take a server snapshot).

We check once more when the archive is ready, with its real size. If it no longer fits, because the allowance shrank or another snapshot finished first, the snapshot fails.

A schedule makes room for its next snapshot by deleting the oldest snapshots it took of the same server. It never deletes a locked snapshot, or one that you, another schedule or we took (Schedule server tasks).

Snapshots we take for you before we remove a server skip the check, so that we can save the server even when the account is full. They count against the allowance once they complete (Snapshots we take for you).

The account can go over when the allowance shrinks, or when a snapshot we take for you does not fit. The allowance shrinks when you move a server to a smaller plan, and when a server or a snapshot storage service ends. It also shrinks when your account plan adds less: you move to a smaller plan, a plan you cancelled ends, a trial ends, or Pro or Business is suspended for an unpaid invoice. From then on:

• The Storage used tile turns red, and its footer reads "Over by" and the amount. The strip on the Snapshots page says "Over the allowance. We delete the oldest unlocked snapshots from" and the cleanup date and time. A server's Snapshot storage card shows Over the allowance, with the same date.
• New snapshots are refused until the account fits again, and so are a schedule's, unless it can make room from its own snapshots.
• The cleanup date is 30 days after the account went over, by default. For an account that has no allowance left and has never paid us, it is 14 days. The page shows the date as soon as the account is over. Our daily check records the date for good, and it can move later by up to a day, never earlier.

We email you before the cleanup date:

Each email names the snapshots we would delete if nothing changes.

From the cleanup date, our daily check deletes Completed snapshots until the rest fit, and no more. It takes the oldest first, and every unlocked snapshot before a locked one, so a lock does not keep a snapshot past the cleanup. It never deletes a snapshot that we put on hold. We then email you with the subject 2 older snapshots removed, with the number we deleted, and the names of the snapshots.

As soon as the account fits again, we cancel the cleanup date. Delete snapshots you no longer need, order snapshot storage, move to a larger plan or order a server. If the account goes over again later, a new full grace period starts. To keep your snapshots for longer, contact support: we can pause the cleanup for your account, and we send no reminders while it is paused.

GET /api/v1/client/snapshots/allowance returns the figures the Snapshot storage card shows, worked out at the moment you ask.

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

{
  "allowance_bytes": 246960619520,
  "used_bytes": 1932735283,
  "available_bytes": 245027884237,
  "bonus_bytes": 0,
  "over": false,
  "cleanup_at": null,
  "over_since": null,
  "breakdown": [
    {"service_id": 1042, "status": "active", "product": "CX4", "label": "CX4", "allowance_bytes": 85899345920},
    {"service_id": 1077, "status": "active", "product": "Snapshot Storage 50 GB", "label": "Snapshot Storage 50 GB", "allowance_bytes": 53687091200},
    {"service_id": 1203, "status": "active", "product": "Pro", "label": "Pro plan", "allowance_bytes": 107374182400}
  ]
}

allowance_bytes

The whole allowance: what your services and your account plan include, plus bonus_bytes.

used_bytes and available_bytes

What your snapshots take up, and what is left. available_bytes is never below 0.

over

true while your snapshots take more than the allowance.

over_since and cleanup_at

When the account went over, and when the cleanup starts, in UTC. Both are null while the account fits.

breakdown

One entry for each service that is active, suspended or being removed, with its service_id, status, product name, a label to show and the allowance_bytes it adds. A service that includes no snapshot storage adds 0. While your account plan adds storage, the last entry is the plan's: product is the plan's name, and label reads such as Pro plan, or Pro trial during a trial. Its service_id is the plan's service ID, and null during a trial, when status is trialing.