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).
Path parameters
The id of a CoreCluster. Digits only. At least 1.
Returns
200 The upgrade options.
Fields of the 200 answer
Fields
Whether something can be done now and, when it cannot, why not.
Fields
The add-ons the subject holds now.
Fields
The most of each add-on a change takes.
Fields
Each add-on with the monthly price of one unit, its ceiling and its step.
Fields of each item
Whether a change can wait for tonight.
The billing contract a change is priced against, or null.
The server types.
Fields of each item
generaloptimisedWhat moving to it adds a month. null when it is not priced.
Whether servers of this type are running where the subject is. When they are not, the first move to it takes longer.
first when no server of this type is running there yet.
For a subject with no billing contract, why its changes carry no price. null otherwise.
Fields of each item
Whether the package can be chosen, and why not when it cannot.
Fields
What moving to the package would be. null for the package the subject is on.
The package's monthly price for this subject's server type and platform. null when it is not priced.
For a site, the changes waiting for the night. null for a CoreCluster and for a site inside one.
What you may do with the account.
Fields
Whether you may pay an invoice. Paying is done in the Control Panel.
billing_forbidden when you may not read the account, else null.
The site or CoreCluster, with what it runs on now.
Fields
generaloptimisedWhat the subject's package and add-ons cost a month now. null without a contract.
The site's id and domain, or the CoreCluster's id and name.
Fields
At least 1.
The region the contract is priced in. null without a contract.
siteclusterFor 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
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
429 | rate_limited | Wait 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"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/clusters/1017/upgrade-options');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/clusters/1017/upgrade-options', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/corestack/clusters/1017/upgrade-options",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"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
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}