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

Update how often a site takes snapshots

Sets the site's own frequency, or null to follow the default of its CoreCluster or, for a CoreStack site, its package. The next scheduled snapshot moves to the first slot of the new frequency.

PUT/api/corestack/sites/{site}/snapshot-frequency

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.

Body

frequencystring or any or nullRequired

The site's own frequency, or null to follow the default.

Returns

200 The site's snapshot settings as they are now.

Fields of the 200 answer
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.

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.
409managed_elsewhereThis site is read-only here. Change it in the control panel that manages it.
409removedThe site or environment is being removed, or has been. Nothing can be changed on it.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl -X PUT https://manage.corefinity.com/api/corestack/sites/1042/snapshot-frequency \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "frequency": "6h"
  }'
{
  "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
}
Try it
Held in this tab's memory only. Never stored or sent to us.

This sends a real PUT request and changes your account.

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

Was this helpful?
Open in ClaudeOpen in ChatGPT