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.
1h2h3h4h6h12hdailyweeklymonthlyofffrequency_labelstringRequired
frequency_optionsarray of objectsRequired
Fields of each item
labelstringRequired
valuestringRequired
How often scheduled snapshots are taken.
1h2h3h4h6h12hdailyweeklymonthlyoffover_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
| 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. |
429 | rate_limited | Wait 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"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/clusters/1017/snapshot-settings');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/clusters/1017/snapshot-settings', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// 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.get(
"https://manage.corefinity.com/api/corestack/clusters/1017/snapshot-settings",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"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"
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"message": "Not found."
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it
Was this helpful?