Check what fits a CoreCluster
Answers whether new sites and environments, the removal of others, or another package would fit the CoreCluster, without creating or reserving anything. A proposal that would not fit still answers 200, with the reasons in blocking; an empty body answers the CoreCluster as it is now.
Path parameters
The id of a CoreCluster. Digits only. At least 1.
Body
Environments to add. Up to 50 items.
Fields of each item
A platform, such as wordpress, laravel or magento2.
A size the platform has, such as S, M or L.
The key of another package to measure against. Leave it out to use the CoreCluster's own.
The site row ids of sites and environments of the CoreCluster to take away first, as numbers. At most 50.
Sites to add. Up to 50 items.
Fields of each item
A platform, such as wordpress, laravel or magento2.
A size the platform has, such as S, M or L.
Returns
200 The capacity of the CoreCluster now and with the proposal.
Fields of the 200 answer
What the proposed sites and environments would add.
Fields
Why the proposal would be refused now. Empty when it would not.
Fields of each item
The meter that would be over, for capacity_blocked.
A stable code, such as capacity_blocked, package_restricted, cluster_not_ready or region_unavailable.
The CoreCluster that was checked. Null for a check before the CoreCluster exists.
The capacity as it is now. How much of the package the CoreCluster's sites use.
Fields
What the usage figures are: measured (p95), estimated from the sizes of the sites (estimate), or both (mixed).
p95mixedestimateOne meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedFormat: date-time.
The worst level of the meters.
okwarningblockedOne meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedThe package the figures are measured against. Null for a CoreCluster with no package.
Fields
Fields
One meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedFormat: date-time.
Sent, as true, only when the proposal needs more room than the package has and your company has automatic upgrades on, so the CoreCluster would grow first. warnings says so.
True when blocking is empty.
The package the proposal was measured against.
Fields
The capacity with the proposal. How much of the package the CoreCluster's sites use.
Fields
What the usage figures are: measured (p95), estimated from the sizes of the sites (estimate), or both (mixed).
p95mixedestimateOne meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedFormat: date-time.
The worst level of the meters.
okwarningblockedOne meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedThe package the figures are measured against. Null for a CoreCluster with no package.
Fields
Fields
One meter. The figures are in the unit its field names say; percent is what is used of the capacity.
Fields
ok under 75 per cent, warning from 75 and blocked from 90.
okwarningblockedSentences about a meter the proposal would leave nearly full.
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. |
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 POST https://manage.corefinity.com/api/corestack/clusters/1017/capacity/check \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"sites": [
{
"platform": "wordpress",
"tier": "S"
}
]
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/corestack/clusters/1017/capacity/check', [
'sites' => [
[
'platform' => 'wordpress',
'tier' => 'S',
],
],
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/clusters/1017/capacity/check', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
sites: [
{
platform: 'wordpress',
tier: 'S',
},
],
}),
});
// 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.post(
"https://manage.corefinity.com/api/corestack/clusters/1017/capacity/check",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"sites": [
{
"platform": "wordpress",
"tier": "S",
},
],
},
)
data = res.json() if res.content else None{
"added": {
"cpu_millicores": 150,
"disk_bytes": 10737418240,
"environments": 0,
"memory_bytes": 805306368,
"sites": 1
},
"blocking": [],
"cluster": {
"id": 1017,
"name": "Northwind UK 1"
},
"current": {
"basis": "p95",
"cpu": {
"capacity_millicores": 4000,
"level": "ok",
"percent": 6,
"used_p95_millicores": 240
},
"evaluated_at": "2026-11-14T09:50:00Z",
"level": "ok",
"memory": {
"capacity_bytes": 17179869184,
"level": "ok",
"percent": 6,
"used_p95_bytes": 1073741824
},
"package": {
"cores": 4,
"key": "xsmall",
"memory_bytes": 17179869184,
"name": "Extra small"
},
"sites": {
"count": 1,
"environments": 0
},
"storage": {
"capacity_bytes": 214748364800,
"level": "ok",
"percent": 5,
"provisioned_bytes": 10737418240
}
},
"evaluated_at": "2026-11-14T09:50:00Z",
"ok": true,
"package": {
"key": "xsmall",
"name": "Extra small"
},
"projected": {
"basis": "mixed",
"cpu": {
"capacity_millicores": 4000,
"level": "ok",
"percent": 9,
"used_p95_millicores": 390
},
"evaluated_at": "2026-11-14T09:50:00Z",
"level": "ok",
"memory": {
"capacity_bytes": 17179869184,
"level": "ok",
"percent": 10,
"used_p95_bytes": 1879048192
},
"package": {
"cores": 4,
"key": "xsmall",
"memory_bytes": 17179869184,
"name": "Extra small"
},
"sites": {
"count": 2,
"environments": 0
},
"storage": {
"capacity_bytes": 214748364800,
"level": "ok",
"percent": 10,
"provisioned_bytes": 21474836480
}
},
"warnings": []
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"message": "Not found."
}{
"code": "invalid",
"errors": {
"remove.0": [
"That site or environment is not on this cluster"
]
},
"field": "remove.0",
"message": "That site or environment is not on this cluster",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}