CorefinityCorefinityDocs
Open the Control PanelControl Panel
Backups and restores · 6 of 8

Get a snapshot

Answers one snapshot. While it is being taken or deleted, a read checks its progress first when the last check is more than a few seconds old, so polling this endpoint follows it to ready, failed or deleted.

GET/api/corestack/snapshots/{snapshot}

Path parameters

snapshotintegerRequired

The id of a snapshot. Digits only. At least 1.

Returns

200 The snapshot.

Fields of the 200 answer
archivedbooleanRequired

True for a snapshot kept from before the site moved storage. Only Corefinity support can restore it.

availableboolean

Whether it can be used as a source now. Sent only while restoring to another environment is on for your company.

can_deletebooleanRequired

Whether you can delete it now.

can_protectbooleanRequired

Whether you can keep it, or stop keeping it, now.

created_atstring or nullRequired

Format: date-time.

delete_reasonstring or any or nullRequired

Why the snapshot was deleted. Null until a delete is asked for.

delete_reason_labelstring or nullRequired
deleted_atstring or nullRequired

Format: date-time.

errorstring or nullRequired

Why the snapshot failed, in plain words.

expires_atstring or nullRequired

When retention removes the snapshot. Null while it is kept or no retention is set. Format: date-time.

idintegerRequired

At least 1.

in_useboolean

Whether a restore or a copy is reading it. Sent only while restoring to another environment is on for your company.

keptboolean

The same as protected. Sent only while restoring to another environment is on for your company.

kindstringRequired

Why the snapshot was taken.

scheduledmanualpre_restorefinalclonepre_deploy
kind_labelstringRequired
mariadb_versionstring or nullRequired
notestring or nullRequired
php_versionstring or nullRequired
protectedbooleanRequired

True while the snapshot is kept.

ready_atstring or nullRequired

Format: date-time.

requested_byobject or any or nullRequired
restorableobjectRequired

What the snapshot can be restored as now, and why not when it cannot.

Fields
databasebooleanRequired
everythingbooleanRequired
filesbooleanRequired
reasonstring or null

Why something cannot be restored, in plain words.

restore_size_bytesinteger or nullRequired

The size of the site the snapshot restores to. Null until it is known.

statusstringRequired

retrying is a scheduled snapshot that failed and will be tried again; retried is a failed attempt that a later one replaced.

pendingcreatingreadyfaileddeletingdeletedretryingretried
status_labelstringRequired
stored_bytesinteger or nullRequired

The space the snapshot uses. Null until it is measured.

unavailable_reasonstring

Why it cannot be used as a source. Sent only when available is false.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404noneCheck the id. You see only what your account can reach.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/corestack/snapshots/3301 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "archived": false,
  "can_delete": true,
  "can_protect": true,
  "created_at": "2026-11-03T15:12:40Z",
  "delete_reason": null,
  "delete_reason_label": null,
  "deleted_at": null,
  "error": null,
  "expires_at": "2026-12-03T15:12:40Z",
  "id": 3301,
  "kind": "manual",
  "kind_label": "One-off",
  "mariadb_version": "11.8",
  "note": "Before the PHP 8.4 move",
  "php_version": "8.3",
  "protected": false,
  "ready_at": "2026-11-03T15:14:02Z",
  "requested_by": {
    "id": 2041,
    "name": "Eleanor Finch"
  },
  "restorable": {
    "database": true,
    "everything": true,
    "files": true,
    "reason": null
  },
  "restore_size_bytes": 6442450944,
  "status": "ready",
  "status_label": "Ready",
  "stored_bytes": 1288490188
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT