CorefinityCorefinityDocs
Open the Control PanelControl Panel
Sites · 4 of 18

Check whether a new site fits

Checks whether a new CoreStack site with this package would fit in a region, without creating or reserving anything. ok is false when the create would be refused, and blocking says why.

POST/api/corestack/capacity/check

Body

companyinteger

Your own company. Any other company is refused 422 on company.

compute_familystring

The server type. One is accepted only while it is offered to your company and in the region. Defaults to general.

generaloptimised
environmentsarray of objects

One entry for each staging environment to create with the site.

Fields of each item
uat_sizestringRequired

A staging size key, such as xsmall.

packagestringRequired

The key of an active CoreStack package, such as cs4.

regionstringRequired

A region key of two to four lower-case letters, such as uk.

Returns

200 The result of the check.

Fields of the 200 answer
addedobjectRequired

What the site and its environments would add.

Fields
cpu_millicoresintegerRequired
disk_bytesintegerRequired
environmentsintegerRequired
memory_bytesintegerRequired
sitesintegerRequired
blockingarray of objectsRequired

Why the create would be refused. Empty when it would not.

Fields of each item
dimensionstring
messagestringRequired
reasonstringRequired

A stable code, such as no_platform_cluster, package_restricted or compute_blocked.

clusterobject or any or nullRequired

Where the site would be placed. Null when the region is not set up.

currentobject or null
evaluated_atstringRequired

Format: date-time.

node_pendingstring or nullRequired

Set when the create would wait for capacity to be added instead of starting at once.

okbooleanRequired
packageobjectRequired
Fields
keystringRequired
namestringRequired
projectedobject or null
rowsarray of objectsRequired

Each row the create would make, the production row first.

Fields of each item
node_pendingstring or nullRequired
rolestringRequired
productionstaging
tierstring or nullRequired
uat_sizestring or nullRequired
storage_pendingboolean
warningsarray of stringsRequired

Sentences to know about, such as a create that would wait for capacity to be added. They never make ok false.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403forbiddenThe person is not allowed to do this.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
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/capacity/check \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "package": "cs4",
    "region": "uk"
  }'
{
  "added": {
    "cpu_millicores": 4500,
    "disk_bytes": 236223201280,
    "environments": 1,
    "memory_bytes": 19327352832,
    "sites": 1
  },
  "blocking": [],
  "cluster": {
    "id": 1009,
    "name": "CoreStack"
  },
  "current": null,
  "evaluated_at": "2026-11-04T11:32:06Z",
  "node_pending": null,
  "ok": true,
  "package": {
    "key": "cs4",
    "name": "CS4"
  },
  "projected": null,
  "rows": [
    {
      "node_pending": null,
      "role": "production",
      "tier": "shared",
      "uat_size": null
    },
    {
      "node_pending": null,
      "role": "staging",
      "tier": "shared",
      "uat_size": "xsmall"
    }
  ],
  "storage_pending": false,
  "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