Preview a CoreCluster's deletion
What deleting the CoreCluster would take with it: totals, then each site with its environments and snapshots. empty is true when no site, environment, deleted site or snapshot is left. Nothing is deleted.
Path parameters
The id of a CoreCluster. Digits only. At least 1.
Returns
200 What the deletion would take.
Fields of the 200 answer
Fields
At least 1.
The name confirm_name must match.
True when there is no site, environment, deleted site in its grace period or snapshot.
Snapshots the deletion leaves until their retention ends.
Fields
Snapshots of sites that were removed earlier, which the deletion deletes too.
Fields
Up to 1,000 sites, the ones that are not deleted first, then by domain.
Fields of each item
Format: date-time.
Up to 50 of the site's environments.
Fields of each item
At least 1.
How many more environments the site has than are listed.
At least 1.
Fields
livedeletedHow many more sites there are than are listed.
Fields
Sites you deleted that are still in their grace period.
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 | feature_off | This feature is not on for your organisation yet. |
429 | rate_limited | Wait for the seconds in Retry-After. |
503 | switched_off | Corefinity has switched this action off for the moment. Try again later. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/corestack/clusters/1017/deletion \
-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/deletion');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/clusters/1017/deletion', {
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/deletion",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"cluster": {
"id": 1017,
"name": "Northwind UK 1",
"ssh_host": "ssh-northwind.example.net"
},
"empty": false,
"kept_snapshots": {
"bytes": 0,
"count": 0
},
"removed_sites_snapshots": {
"bytes": 0,
"count": 0
},
"sites": [
{
"deleted_at": null,
"domain": "harbourandfinch.example.com",
"environments": [],
"environments_more": 0,
"id": 1042,
"snapshots": {
"bytes": 1288490188,
"count": 2
},
"state": "live"
}
],
"sites_more": 0,
"totals": {
"deleted_sites": 0,
"domains": 1,
"environments": 0,
"mail_domains": 0,
"sites": 1,
"snapshot_bytes": 1288490188,
"snapshots": 2
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}{
"code": "switched_off",
"message": "Deleting is switched off at the moment",
"reason": "switched_off",
"switch": "delete"
}Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.