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.
Path parameters
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
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
The default the site follows, its CoreCluster's or, for a CoreStack site, its package's.
1h2h3h4h6h12hdailyweeklymonthlyoffHow often scheduled snapshots are taken.
1h2h3h4h6h12hdailyweeklymonthlyoffWhether snapshots are enabled for the site.
The site's own frequency. Null while it follows the default.
Fields of each item
How often scheduled snapshots are taken.
1h2h3h4h6h12hdailyweeklymonthlyoffThe latest scheduled snapshot, if it failed and will not be tried again.
How many more one-off snapshots can be taken this hour.
Format: date-time.
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.
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.
The most space kept snapshots may use.
The space kept snapshots use.
True when the quota removed snapshots in the last 24 hours.
How many days a snapshot is kept before retention removes it. Null when no retention is set.
Null until sizes have been measured for the first time.
Format: date-time.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | none | Check the id. You see only what your account can reach. |
409 | managed_elsewhere | This site is read-only here. Change it in the control panel that manages it. |
409 | removed | The site or environment is being removed, or has been. Nothing can be changed on it. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait 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"
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->put('https://manage.corefinity.com/api/corestack/sites/1042/snapshot-frequency', [
'frequency' => '6h',
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/snapshot-frequency', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
frequency: '6h',
}),
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.put(
"https://manage.corefinity.com/api/corestack/sites/1042/snapshot-frequency",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"frequency": "6h",
},
)
data = res.json() if res.content else None{
"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
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"message": "Not found."
}{
"code": "managed_elsewhere",
"message": "This site is managed by another control panel",
"reason": "managed_elsewhere"
}{
"code": "invalid",
"errors": {
"enabled": [
"The enabled field is required."
]
},
"field": "enabled",
"message": "The enabled field is required.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}