CorefinityCorefinityDocs
Open the Control PanelControl Panel
Snapshots and restores · 4 of 14

corestack_snapshot_list

Snapshots.

Scope readNo secrets returnedCoreCluster
On this page

When to use it

A row's snapshots — scheduled, manual, safety and copy snapshots with their status, size, note and whether each is protected — its snapshot settings, and the restore running on it, if any.

A scheduled snapshot that failed is tried again automatically: until its last attempt it reads retrying, never failed, and the earlier attempts are not listed.

A snapshot deleted in the last day is still listed, with delete_reason and delete_reason_label. The reason can be retention, quota, manual, failed_cleanup, cluster_deleted, clone_cleanup, operator_expired, site_purged, rehome_expired or volume_retired (corestack_snapshot_get says what each means).

While restoring anywhere is switched on, each snapshot also says whether it is kept, in_use (a restore or a copy is reading it) and available (restorable now), with unavailable_reason when it is not.

For a CoreStack site, settings.per_site is true and the snapshot space is the site's own package's, measured over the site and its environments, the same figures as the Snapshots tab's Snapshot space meter: quota_bytes, usage_bytes (null until the platform has measured sizes for the first time, at usage_synced_at), protected_bytes (snapshots marked to keep) and protect_cap_bytes (how much may be kept). over_quota says the usage is above the quota, and pruned_recently that snapshots were deleted early in the last 24 hours to stay within it. A site on your own CoreCluster has per_site: false with these figures null, 0 or false: corecluster_snapshot_settings_get answers that CoreCluster's quota.

These figures measure the whole site, its environments included. A grant pinned to one environment, not to its site, gets usage_bytes, usage_synced_at, protected_bytes, pruned_recently and over_quota as null; the package's quota_bytes and protect_cap_bytes are still given.

Ask for it

Prompt
Using the Corefinity MCP server, call corestack_snapshot_list with site_id 4211. (Snapshots.) Tell me what it returned.

Inputs

site_idintegerRequired

At least 1.

Example call

tools/call
{
  "name": "corestack_snapshot_list",
  "arguments": {
    "site_id": 4211
  }
}

If it is refused

ReasonWhat to do
invalid_argumentsThe arguments do not match the tool's input schema, or the Control Panel refused a field. Fix the fields named in the answer and call again.
tenant_mismatchThe object does not exist or the token may not see it. Check the id.
scope_requiredThe token lacks a scope this call needs. Open the link in the answer to add it, then call again.
pin_refusedThe grant is limited to chosen clusters, sites or environments, and this call is outside them. Open the link in the answer to widen it.
rate_limitedToo many calls. Wait for the number of seconds the answer names.
temporarily_unavailableThe Control Panel could not answer just now. Nothing was started; try again shortly.
internal_errorSomething went wrong on our side. Quote the trace id to support.

The same task elsewhere

Was this helpful?
Open in ClaudeOpen in ChatGPT