CorefinityCorefinityDocs
Open the Control PanelControl Panel
Packages and capacity · 4 of 12

Get a CoreCluster's upgrade options

Answers what a CoreCluster can change to and what each choice costs a month: the CoreCluster packages, its add-ons with their unit prices and ceilings, the server types, and whether you may pay for a change (rights.can_pay). uat and pending are null for a CoreCluster, and one with no billing contract is offered the same changes without prices (not_billed).

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

Path parameters

clusterintegerRequired

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

Returns

200 The upgrade options.

Fields of the 200 answer
addonsobjectRequired
Fields
availableobjectRequired

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

Fields
availablebooleanRequired
reasonstring or nullRequired
currentobjectRequired

The add-ons the subject holds now.

Fields
coresintegerRequired
disk_gbintegerRequired
log_storage_gbintegerRequired
memory_gbintegerRequired
maxobjectRequired

The most of each add-on a change takes.

Fields
coresintegerRequired
disk_gbintegerRequired
log_storage_gbintegerRequired
memory_gbintegerRequired
unitarray of objectsRequired

Each add-on with the monthly price of one unit, its ceiling and its step.

Fields of each item
keystringRequired
labelstringRequired
maxintegerRequired
monthlyobject or any or nullRequired
stepintegerRequired
unitstringRequired
apply_defaultstringRequired
can_apply_tonightbooleanRequired

Whether a change can wait for tonight.

contractobject or any or nullRequired

The billing contract a change is priced against, or null.

currencystringRequired
familyarray of objectsRequired

The server types.

Fields of each item
availablebooleanRequired
currentbooleanRequired
keystringRequired
generaloptimised
labelstringRequired
monthly_deltaobject or any or nullRequired

What moving to it adds a month. null when it is not priced.

notestring or nullRequired
provisionedbooleanRequired

Whether servers of this type are running where the subject is. When they are not, the first move to it takes longer.

reasonstring or nullRequired

first when no server of this type is running there yet.

not_billedobject or any or nullRequired

For a subject with no billing contract, why its changes carry no price. null otherwise.

packagesarray of objectsRequired
Fields of each item
availableobjectRequired

Whether the package can be chosen, and why not when it cannot.

Fields
availablebooleanRequired
reasonstring or nullRequired
changeobject or any or nullRequired

What moving to the package would be. null for the package the subject is on.

codestringRequired
coresnumberRequired
disk_gbnumberRequired
keystringRequired
memory_gibnumberRequired
monthlyobject or any or nullRequired

The package's monthly price for this subject's server type and platform. null when it is not priced.

namestringRequired
pendingobject or any or nullRequired

For a site, the changes waiting for the night. null for a CoreCluster and for a site inside one.

rightsobjectRequired

What you may do with the account.

Fields
can_editbooleanRequired
can_paybooleanRequired

Whether you may pay an invoice. Paying is done in the Control Panel.

can_viewbooleanRequired
reasonstring or nullRequired

billing_forbidden when you may not read the account, else null.

subjectobjectRequired

The site or CoreCluster, with what it runs on now.

Fields
familystringRequired
generaloptimised
monthlyobject or any or nullRequired

What the subject's package and add-ons cost a month now. null without a contract.

packageobject or any or nullRequired
refobjectRequired

The site's id and domain, or the CoreCluster's id and name.

Fields
domainstring
idintegerRequired

At least 1.

namestring
regionobject or any or nullRequired

The region the contract is priced in. null without a contract.

typestringRequired
sitecluster
uatarray of objects or any or nullRequired

For a site, each staging environment with every size it can take. null for a CoreCluster and for a site inside one.

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/upgrade-options \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "addons": {
    "available": {
      "available": true,
      "reason": null
    },
    "current": {
      "cores": 0,
      "disk_gb": 0,
      "log_storage_gb": 0,
      "memory_gb": 0
    },
    "max": {
      "cores": 16,
      "disk_gb": 102400,
      "log_storage_gb": 1000,
      "memory_gb": 64
    },
    "unit": [
      {
        "key": "core",
        "label": "Extra core",
        "max": 16,
        "monthly": {
          "amount": "45.00",
          "currency": "GBP"
        },
        "step": 1,
        "unit": "core"
      },
      {
        "key": "memory_gb",
        "label": "Extra memory",
        "max": 64,
        "monthly": {
          "amount": "5.00",
          "currency": "GBP"
        },
        "step": 1,
        "unit": "GB"
      },
      {
        "key": "disk_gb",
        "label": "Extra disk",
        "max": 102400,
        "monthly": {
          "amount": "0.20",
          "currency": "GBP"
        },
        "step": 10,
        "unit": "GB"
      },
      {
        "key": "log_storage_gb",
        "label": "Extra log storage",
        "max": 1000,
        "monthly": {
          "amount": "0.10",
          "currency": "GBP"
        },
        "step": 1,
        "unit": "GB"
      }
    ]
  },
  "apply_default": "now",
  "can_apply_tonight": true,
  "contract": {
    "id": 8169,
    "reference": "MC-2-2"
  },
  "currency": "GBP",
  "family": [
    {
      "available": true,
      "current": true,
      "key": "general",
      "label": "Standard",
      "monthly_delta": {
        "amount": "0.00",
        "currency": "GBP"
      },
      "note": null,
      "provisioned": false,
      "reason": "first"
    },
    {
      "available": true,
      "current": false,
      "key": "optimised",
      "label": "Performance",
      "monthly_delta": {
        "amount": "120.00",
        "currency": "GBP"
      },
      "note": null,
      "provisioned": false,
      "reason": "first"
    }
  ],
  "not_billed": null,
  "packages": [
    {
      "available": {
        "available": false,
        "reason": "Ask us to move to a smaller package"
      },
      "change": {
        "direction": "downgrade",
        "notes": []
      },
      "code": "CC4",
      "cores": 4,
      "disk_gb": 200,
      "key": "cc4",
      "memory_gib": 16,
      "monthly": {
        "amount": "300.00",
        "currency": "GBP"
      },
      "name": "CoreCluster CC4"
    },
    {
      "available": {
        "available": false,
        "reason": "Ask us to move to a smaller package"
      },
      "change": {
        "direction": "downgrade",
        "notes": []
      },
      "code": "CC6",
      "cores": 6,
      "disk_gb": 300,
      "key": "cc6",
      "memory_gib": 24,
      "monthly": {
        "amount": "450.00",
        "currency": "GBP"
      },
      "name": "CoreCluster CC6"
    },
    {
      "available": {
        "available": true,
        "reason": null
      },
      "change": null,
      "code": "CC8",
      "cores": 8,
      "disk_gb": 400,
      "key": "cc8",
      "memory_gib": 32,
      "monthly": {
        "amount": "600.00",
        "currency": "GBP"
      },
      "name": "CoreCluster CC8"
    }
  ],
  "pending": null,
  "rights": {
    "can_edit": true,
    "can_pay": false,
    "can_view": true,
    "reason": null
  },
  "subject": {
    "family": "general",
    "monthly": {
      "amount": "600.00",
      "currency": "GBP"
    },
    "package": {
      "code": "CC8",
      "key": "cc8"
    },
    "ref": {
      "id": 1017,
      "name": "Northwind UK 1"
    },
    "region": {
      "key": "uk",
      "label": "United Kingdom"
    },
    "type": "cluster"
  },
  "uat": null
}
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