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

Get a CoreCluster's snapshot settings

Answers the default frequency the CoreCluster's sites follow, its snapshot quota and retention, and how much of the quota is used.

GET/api/corestack/clusters/{cluster}/snapshot-settings

Path parameters

clusterintegerRequired

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

Returns

200 The CoreCluster's snapshot settings.

Fields of the 200 answer
can_change_frequencybooleanRequired

False when the CoreCluster's package sets its snapshot settings.

can_change_limitsbooleanRequired

Always false for you. The quota and the retention are set by Corefinity.

enabledbooleanRequired
frequencystringRequired

How often scheduled snapshots are taken.

1h2h3h4h6h12hdailyweeklymonthlyoff
frequency_labelstringRequired
frequency_optionsarray of objectsRequired
Fields of each item
labelstringRequired
valuestringRequired

How often scheduled snapshots are taken.

1h2h3h4h6h12hdailyweeklymonthlyoff
over_quotabooleanRequired
protect_cap_bytesinteger or nullRequired
protected_bytesintegerRequired
pruned_recentlybooleanRequired
quota_bytesinteger or nullRequired
retention_daysinteger or nullRequired
usage_bytesinteger or nullRequired
usage_synced_atstring or nullRequired

Format: date-time.

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/clusters/1017/snapshot-settings \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "can_change_frequency": true,
  "can_change_limits": false,
  "enabled": true,
  "frequency": "daily",
  "frequency_label": "Daily",
  "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"
    }
  ],
  "over_quota": false,
  "protect_cap_bytes": 53687091200,
  "protected_bytes": 6442450944,
  "pruned_recently": false,
  "quota_bytes": 107374182400,
  "retention_days": 30,
  "usage_bytes": 21474836480,
  "usage_synced_at": "2026-11-03T18:00:00Z"
}
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