CorefinityCorefinityDocs
Open the Control PanelControl Panel
CoreCluster · 7 of 10

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.

POST/api/corestack/clusters/{cluster}/capacity/check

Path parameters

clusterintegerRequired

The id of a CoreCluster. Digits only. At least 1.

Body

environmentsarray of objects

Environments to add. Up to 50 items.

Fields of each item
platformstringRequired

A platform, such as wordpress, laravel or magento2.

tierstringRequired

A size the platform has, such as S, M or L.

packagestring or null

The key of another package to measure against. Leave it out to use the CoreCluster's own.

removearray of integers

The site row ids of sites and environments of the CoreCluster to take away first, as numbers. At most 50.

sitesarray of objects

Sites to add. Up to 50 items.

Fields of each item
platformstringRequired

A platform, such as wordpress, laravel or magento2.

tierstringRequired

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
addedobjectRequired

What the proposed sites and environments would add.

Fields
cpu_millicoresintegerRequired
disk_bytesintegerRequired
environmentsintegerRequired
memory_bytesintegerRequired
sitesintegerRequired
blockingarray of objectsRequired

Why the proposal would be refused now. Empty when it would not.

Fields of each item
dimensionstring

The meter that would be over, for capacity_blocked.

messagestringRequired
reasonstringRequired

A stable code, such as capacity_blocked, package_restricted, cluster_not_ready or region_unavailable.

clusterobject or any or nullRequired

The CoreCluster that was checked. Null for a check before the CoreCluster exists.

currentobjectRequired

The capacity as it is now. How much of the package the CoreCluster's sites use.

Fields
basisstringRequired

What the usage figures are: measured (p95), estimated from the sizes of the sites (estimate), or both (mixed).

p95mixedestimate
cpuobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_millicoresinteger
used_p95_millicoresnumber or null
evaluated_atstring or nullRequired

Format: date-time.

levelstringRequired

The worst level of the meters.

okwarningblocked
memoryobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_bytesinteger
used_p95_bytesnumber or null
packageobject or nullRequired

The package the figures are measured against. Null for a CoreCluster with no package.

Fields
coresinteger
keystring
memory_bytesinteger
namestring
sitesobjectRequired
Fields
countintegerRequired
environmentsintegerRequired
storageobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_bytesinteger
provisioned_bytesnumber or null
evaluated_atstringRequired

Format: date-time.

growsboolean

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.

okbooleanRequired

True when blocking is empty.

packageobject or nullRequired

The package the proposal was measured against.

Fields
keystring
namestring
projectedobjectRequired

The capacity with the proposal. How much of the package the CoreCluster's sites use.

Fields
basisstringRequired

What the usage figures are: measured (p95), estimated from the sizes of the sites (estimate), or both (mixed).

p95mixedestimate
cpuobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_millicoresinteger
used_p95_millicoresnumber or null
evaluated_atstring or nullRequired

Format: date-time.

levelstringRequired

The worst level of the meters.

okwarningblocked
memoryobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_bytesinteger
used_p95_bytesnumber or null
packageobject or nullRequired

The package the figures are measured against. Null for a CoreCluster with no package.

Fields
coresinteger
keystring
memory_bytesinteger
namestring
sitesobjectRequired
Fields
countintegerRequired
environmentsintegerRequired
storageobjectRequired

One meter. The figures are in the unit its field names say; percent is what is used of the capacity.

Fields
levelstringRequired

ok under 75 per cent, warning from 75 and blocked from 90.

okwarningblocked
percentintegerRequired
capacity_bytesinteger
provisioned_bytesnumber or null
warningsarray of stringsRequired

Sentences about a meter the proposal would leave nearly full.

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.
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 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"
      }
    ]
  }'
{
  "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": []
}
Try it
Held in this tab's memory only. Never stored or sent to us.

This sends a real POST request and changes your account.

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

Was this helpful?
Open in ClaudeOpen in ChatGPT