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

List a site's snapshots

Answers the site's snapshots, newest first, with its snapshot settings and any restore still running. The list is not paged; a snapshot deleted in the last day is still listed.

GET/api/corestack/sites/{site}/snapshots

Path parameters

siteintegerRequired

The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.

Returns

200 The snapshots, the settings and the running restore, if any.

Fields of the 200 answer
restoreobject or any or nullRequired

The restore still running on the site, as GET /corestack/restores/{restore} answers it, or null.

settingsobjectRequired

One site's snapshot settings.

Fields
cluster_frequencystringRequired

The default the site follows, its CoreCluster's or, for a CoreStack site, its package's.

1h2h3h4h6h12hdailyweeklymonthlyoff
cluster_labelstringRequired
effective_frequencystringRequired

How often scheduled snapshots are taken.

1h2h3h4h6h12hdailyweeklymonthlyoff
effective_labelstringRequired
enabledbooleanRequired

Whether snapshots are enabled for the site.

frequencystring or any or nullRequired

The site's own frequency. Null while it follows the default.

frequency_optionsarray of objectsRequired
Fields of each item
labelstringRequired
valuestringRequired

How often scheduled snapshots are taken.

1h2h3h4h6h12hdailyweeklymonthlyoff
last_scheduled_failedobject or any or nullRequired

The latest scheduled snapshot, if it failed and will not be tried again.

manual_remaining_this_hourintegerRequired

How many more one-off snapshots can be taken this hour.

next_scheduled_atstring or nullRequired

Format: date-time.

over_quotabooleanRequired
per_sitebooleanRequired

True for a CoreStack site, whose quota figures below are its own package's, measured over the site and its environments. False for a site on a CoreCluster, where the figures below are null, 0 or false and the CoreCluster's snapshot settings carry them.

policy_sourcestring or any or null

Where the schedule and the retention come from: the site's package, its CoreCluster (cluster), or the schedule kept for a site moved from CoreStack Enterprise (cse_move). Null when the site has none.

protect_cap_bytesinteger or nullRequired

The most space kept snapshots may use.

protected_bytesintegerRequired

The space kept snapshots use.

pruned_recentlybooleanRequired

True when the quota removed snapshots in the last 24 hours.

quota_bytesinteger or nullRequired
retention_daysinteger or null

How many days a snapshot is kept before retention removes it. Null when no retention is set.

usage_bytesinteger or nullRequired

Null until sizes have been measured for the first time.

usage_synced_atstring or nullRequired

Format: date-time.

snapshotsarray of objectsRequired
Fields of each item
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/sites/1042/snapshots \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "restore": null,
  "settings": {
    "cluster_frequency": "6h",
    "cluster_label": "Every 6 hours",
    "effective_frequency": "6h",
    "effective_label": "Every 6 hours",
    "enabled": true,
    "frequency": null,
    "frequency_options": [
      {
        "label": "Every hour",
        "value": "1h"
      },
      {
        "label": "Every 2 hours",
        "value": "2h"
      },
      {
        "label": "Every 3 hours",
        "value": "3h"
      },
      {
        "label": "Every 4 hours",
        "value": "4h"
      },
      {
        "label": "Every 6 hours",
        "value": "6h"
      },
      {
        "label": "Every 12 hours",
        "value": "12h"
      },
      {
        "label": "Daily",
        "value": "daily"
      },
      {
        "label": "Weekly",
        "value": "weekly"
      },
      {
        "label": "Monthly",
        "value": "monthly"
      },
      {
        "label": "Off",
        "value": "off"
      }
    ],
    "last_scheduled_failed": null,
    "manual_remaining_this_hour": 19,
    "next_scheduled_at": "2026-11-03T17:23:00Z",
    "over_quota": false,
    "per_site": false,
    "policy_source": "cluster",
    "protect_cap_bytes": null,
    "protected_bytes": 0,
    "pruned_recently": false,
    "quota_bytes": null,
    "retention_days": 30,
    "usage_bytes": null,
    "usage_synced_at": null
  },
  "snapshots": [
    {
      "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