CorefinityCorefinityDocs
Open the Control PanelControl Panel
Sites · 6 of 18

Get the create options

Answers what a new site of your company can be: where a CoreStack site can be placed, the packages and staging sizes on offer, and whether you can add a CoreCluster. Answered with Cache-Control: no-store.

GET/api/corestack/create-options

Returns

200 The options.

Fields of the 200 answer
app_versionsobject

The application versions on offer, by platform. Only while application versions are on for your company.

coreclusterobjectRequired
Fields
availableobjectRequired

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

Fields
availablebooleanRequired
reasonstring or nullRequired
hrefstring or nullRequired
corestackobjectRequired
Fields
availableobjectRequired

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

Fields
availablebooleanRequired
reasonstring or nullRequired
new_cluster_hrefstring or nullRequired

Where a new CoreCluster is ordered in the Control Panel.

packagesarray of stringsRequired

The key of each package on offer.

placementsarray of objectsRequired

Where a new CoreStack site can be placed: a region of the platform (kind platform), or one of your CoreClusters with its room (kind cluster).

Fields of each item
availableobjectRequired

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

Fields
availablebooleanRequired
reasonstring or nullRequired
capacityobject

cluster: how much of its package the CoreCluster uses.

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
clusterobject

cluster: the CoreCluster.

Fields
idintegerRequired
namestringRequired
familyarray of objectsRequired

The compute families on offer there.

Fields of each item
availablebooleanRequired
keystringRequired

general or optimised: the value to send as compute_family.

labelstringRequired
notestring or nullRequired
provisionedbooleanRequired

False when the first site of this family waits for its servers.

reasonstring or nullRequired
growsboolean

cluster: true when the CoreCluster grows by itself when a site needs more room.

kindstringRequired
platformcluster
labelstring

platform: the region's name.

regionstringRequired

The region code, such as uk. Empty for a CoreCluster whose region is not known.

statestring

platform: coming_soon while the region takes no CoreStack site yet.

readycoming_soon
uat_sizesarray of stringsRequired

The key of each staging size on offer.

enterpriseobjectRequired
Fields
availableobjectRequired

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

Fields
availablebooleanRequired
reasonstring or nullRequired
hrefstring or nullRequired
ownerobject or any or nullRequired

The company the site would belong to. Null when you have no company.

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/create-options \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "corecluster": {
    "available": {
      "available": true,
      "reason": null
    },
    "href": "https://manage.corefinity.com/managed-clusters/new"
  },
  "corestack": {
    "available": {
      "available": true,
      "reason": null
    },
    "new_cluster_href": "https://manage.corefinity.com/managed-clusters/new",
    "packages": [
      "cs4"
    ],
    "placements": [
      {
        "available": {
          "available": false,
          "reason": "United Kingdom is not set up for CoreStack yet. Choose another region"
        },
        "family": [],
        "kind": "platform",
        "label": "United Kingdom",
        "region": "uk",
        "state": "coming_soon"
      },
      {
        "available": {
          "available": true,
          "reason": null
        },
        "capacity": {
          "basis": "estimate",
          "cpu": {
            "capacity_millicores": 8000,
            "level": "ok",
            "percent": 3,
            "used_p95_millicores": 300
          },
          "evaluated_at": "2026-11-10T00:59:45Z",
          "level": "ok",
          "memory": {
            "capacity_bytes": 34359738368,
            "level": "ok",
            "percent": 4,
            "used_p95_bytes": 1610612736
          },
          "package": null,
          "sites": {
            "count": 1,
            "environments": 1
          },
          "storage": {
            "capacity_bytes": 0,
            "level": "ok",
            "percent": 0,
            "provisioned_bytes": 21474836480
          }
        },
        "cluster": {
          "id": 1017,
          "name": "Northwind UK 1"
        },
        "family": [
          {
            "available": true,
            "first_node_shape": null,
            "key": "general",
            "label": "Standard",
            "note": null,
            "provisioned": true,
            "reason": null
          }
        ],
        "grows": false,
        "kind": "cluster",
        "region": ""
      }
    ],
    "uat_sizes": [
      "xsmall",
      "small",
      "medium",
      "large"
    ]
  },
  "enterprise": {
    "available": {
      "available": false,
      "reason": "Ask us about CoreStack Enterprise"
    },
    "href": null
  },
  "owner": {
    "host_slug": "example",
    "id": 1204,
    "name": "Harbour & Finch"
  }
}
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