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

Get the automatic upgrades setting

Answers whether the company lets its CoreClusters grow automatically when a new site or environment would not fit, the monthly limit on what that may add to the bill, and this month's upgrades, newest first (20 at most). A company you may not manage answers the same 404 as one that does not exist.

GET/api/corestack/companies/{company}/auto-upgrades

Path parameters

companyintegerRequired

The id of a company you belong to or manage. Digits only. At least 1.

Returns

200 The setting.

Fields of the 200 answer
activebooleanRequired

Whether they are on and can buy now.

availablebooleanRequired

Whether automatic upgrades can be turned on now.

can_changebooleanRequired

Whether you may turn them on or raise the limit.

can_turn_offbooleanRequired

Whether you may turn them off.

company_idintegerRequired

At least 1.

consented_atstring or nullRequired

When they were turned on, or the limit last raised. null while they are off. Format: date-time.

currencystringRequired

The company's billing currency.

enabledbooleanRequired

Whether they are on.

max_monthly_limitobjectRequired

The highest limit that can be set now.

Fields
amountstringRequired
currencystringRequired
max_purchases_per_monthintegerRequired

The most automatic upgrades that can be made in a month.

monthstringRequired

The calendar month (UTC) the limit counts in, as YYYY-MM.

monthly_limitobject or any or nullRequired

The limit on what new upgrades may add each month. null until a limit is set.

purchases_this_monthintegerRequired

How many automatic upgrades were made this month.

recentarray of objectsRequired

This month's automatic upgrades, newest first, 20 at most.

Fields of each item
atstring or nullRequired

Format: date-time.

cluster_idinteger or nullRequired

At least 1.

kindstringRequired

What was bought, such as cluster_addons, cluster_package or target_disk.

monthly_deltaobjectRequired
Fields
amountstringRequired
currencystringRequired
operation_idinteger or nullRequired

The operation that made the upgrade, to follow with GET /corestack/operations/{operation}. At least 1.

statestringRequired

pending while the upgrade is being made, bought once it is.

pendingbought
summarystringRequired

What was bought, in a sentence.

remaining_this_monthobject or any or nullRequired

What is left of the limit this month. null while they cannot buy.

spent_this_monthobjectRequired

What this month's new upgrades have added.

Fields
amountstringRequired
currencystringRequired
unavailable_reasonstring or nullRequired

Why they cannot be turned on, in a sentence. null when they can.

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/companies/1204/auto-upgrades \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "active": true,
  "available": true,
  "can_change": true,
  "can_turn_off": true,
  "company_id": 1180,
  "consented_at": "2026-11-02T09:12:44Z",
  "currency": "GBP",
  "enabled": true,
  "max_monthly_limit": {
    "amount": "100000.00",
    "currency": "GBP"
  },
  "max_purchases_per_month": 20,
  "month": "2026-11",
  "monthly_limit": {
    "amount": "250.00",
    "currency": "GBP"
  },
  "purchases_this_month": 1,
  "recent": [
    {
      "at": "2026-11-09T14:03:27Z",
      "cluster_id": 1017,
      "kind": "cluster_addons",
      "monthly_delta": {
        "amount": "18.00",
        "currency": "GBP"
      },
      "operation_id": 5120,
      "state": "bought",
      "summary": "1 core and 2 GB of RAM added"
    }
  ],
  "remaining_this_month": {
    "amount": "232.00",
    "currency": "GBP"
  },
  "spent_this_month": {
    "amount": "18.00",
    "currency": "GBP"
  },
  "unavailable_reason": 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