CorefinityCorefinityDocs
Open the Control PanelControl Panel
Sites · 5 of 18

Get what a new site can be

What a new site in this CoreCluster can be: each platform with its versions and sizes, whether each size is available and fits, and the CoreCluster's remaining capacity.

GET/api/corestack/clusters/{cluster}/provisioning-options

Path parameters

clusterintegerRequired

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

Returns

200 The options.

Fields of the 200 answer
can_createobjectRequired

Whether something can be done now and, when it cannot, why not.

Fields
availablebooleanRequired
reasonstring or nullRequired
capacityobject or null

What the CoreCluster has and uses.

clusterobjectRequired

A cluster by its id and name. A standalone CoreStack site reads CoreStack as the name.

Fields
idintegerRequired
namestringRequired
limitsobject or null
magento_keysobject or null
next_portinteger or null

The SSH port the next site is likely to get. For information only.

platformsarray of objectsRequired
Fields of each item
availablebooleanRequired
contentobject

Whether a new install (fresh) and an empty site (empty) are available.

default_tierstring or null
fresh_install_inputsarray of objects

The fields a new install takes.

Fields of each item
defaultstring or null
labelstringRequired
namestringRequired
optionsarray of strings
requiredbooleanRequired
keystringRequired
labelstringRequired
mariadb_versionsarray of objects
Fields of each item
defaultbooleanRequired
labelstringRequired
versionstringRequired
php_versionsarray of objects
Fields of each item
defaultbooleanRequired
eol_datestring or null
labelstringRequired
statusstring or null
versionstringRequired
reasonstring or nullRequired
tiersarray of objectsRequired
Fields of each item
availablebooleanRequired
disk_bytesinteger
estimateobject or null
fitsbooleanRequired

Whether a site of this size fits in what the CoreCluster has left.

fits_reasonstring or nullRequired
keystringRequired
labelstringRequired
limitsobject
plainstring

The size in plain words.

reasonstring or nullRequired
requestsobject
preview_suffixstring or null
ssh_hoststring or null

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.
404feature_offThis feature is not on for your organisation yet.
429rate_limitedWait 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/provisioning-options \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "can_create": {
    "available": true,
    "reason": null
  },
  "capacity": {
    "basis": "estimate",
    "cpu": {
      "capacity_millicores": 8000,
      "level": "ok",
      "percent": 0,
      "used_p95_millicores": 0
    },
    "evaluated_at": "2026-11-14T09:00:00Z",
    "level": "ok",
    "memory": {
      "capacity_bytes": 34359738368,
      "level": "ok",
      "percent": 0,
      "used_p95_bytes": 0
    },
    "package": null,
    "sites": {
      "count": 0,
      "environments": 0
    },
    "storage": {
      "capacity_bytes": 0,
      "level": "ok",
      "percent": 0,
      "provisioned_bytes": 0
    }
  },
  "cluster": {
    "id": 1017,
    "name": "Northwind UK 1"
  },
  "limits": {
    "domain_max": 253
  },
  "magento_keys": {
    "source": "none",
    "updated_at": null
  },
  "next_port": 20033,
  "platforms": [
    {
      "available": true,
      "content": {
        "empty": {
          "available": true,
          "reason": null
        },
        "fresh": {
          "available": true,
          "reason": null
        }
      },
      "default_tier": "S",
      "fresh_install_inputs": [
        {
          "default": "[email protected]",
          "label": "Admin email",
          "name": "admin_email",
          "required": false
        },
        {
          "default": "en_GB",
          "label": "Language",
          "name": "locale",
          "options": [
            "en_GB",
            "en_US"
          ],
          "required": false
        }
      ],
      "key": "wordpress",
      "label": "WordPress",
      "mariadb_versions": [
        {
          "default": true,
          "label": "MariaDB 11.8",
          "version": "11.8"
        }
      ],
      "php_versions": [
        {
          "default": true,
          "eol_date": "2027-12-31",
          "label": "PHP 8.3",
          "status": "supported",
          "version": "8.3"
        }
      ],
      "reason": null,
      "tiers": [
        {
          "available": true,
          "disk_bytes": 10737418240,
          "estimate": {
            "cpu_millicores": 150,
            "disk_bytes": 10737418240,
            "memory_bytes": 805306368
          },
          "fits": true,
          "fits_reason": null,
          "key": "S",
          "label": "Small",
          "limits": {
            "cpu_millicores": 2000,
            "memory_bytes": 4294967296
          },
          "plain": "0.1 vCPU guaranteed, up to 2 vCPU · 512 MB guaranteed, up to 4 GB · 10 GB disk",
          "reason": null,
          "requests": {
            "cpu_millicores": 100,
            "memory_bytes": 536870912
          }
        }
      ]
    }
  ],
  "preview_suffix": ".example.net"
}
Try it
Held in this tab's memory only. Never stored or sent to us.

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

Was this helpful?
Open in ClaudeOpen in ChatGPT