CorefinityCorefinityDocs
Open the Control PanelControl Panel
Demos · 3 of 3

Keep a demo

Keeps the demo, so it carries on as a paid service billed from the next full hour; only an owner or a billing role of the company may. confirm_keep is the site's domain, or the word cluster for a CoreCluster; a bigger package, add-on units or another server type are applied after the Keep, one at a time, and progress follows them. The API never takes billing or card details: when one is missing, the Keep is refused with a keep_url that opens the Keep page in the Control Panel.

POST/api/corestack/demos/{demo}/keep

Path parameters

demointegerRequired

The id of a demo, as the list gives it. Digits only. At least 1.

Body

accept_privacyboolean

Whether you accept Corefinity's privacy notice. Needed the first time your company keeps anything.

addonsobject or null

Add-on units to keep it with, each a whole number that is the total wanted. A unit you leave out stays as it is. The totals are checked before anything is kept: one outside its range, or a disk total that is not a multiple of 10, refuses the Keep (addon_bounds).

Fields
coresinteger

Extra cores, 0 to 16.

disk_gbinteger

Extra disk in GB, 0 to 102400 in steps of 10.

log_storage_gbinteger

Extra log storage in GB, 0 to 1000.

memory_gbinteger

Extra memory in GB, 0 to 64.

confirm_billing_countrystring

Your billing country as a two-letter code, to confirm a country the demo set for you. Up to 2 characters.

confirm_keepstringRequired

The site's domain, or the word cluster for a CoreCluster demo. Upper or lower case. Up to 253 characters.

familystring or null

The server type to keep it on.

generaloptimisednull
packagestring or null

A bigger package to keep it on, such as CS8. One of the demo's upgrade_options.

Returns

200 The demo is kept, and nothing more has started. upgrade.state is none, queued or refused. A second Keep of a kept demo answers the same, with kept.already true.

202 The demo is kept and its first change has started (upgrade.state is started). Follow upgrade.operation_id, or read the demo's progress. Poll the operation until it finishes.

Fields of the 200 answer
demoobjectRequired
Fields
days_leftinteger or nullRequired

Whole days until the demo ends. null unless the demo is active.

ends_atstring or nullRequired

Format: date-time.

grace_ends_atstring or nullRequired

Until when an ended demo can still be kept. Format: date-time.

idintegerRequired

At least 1.

keepobjectRequired
Fields
allowedbooleanRequired

Whether you could keep it now.

refusalobject or any or nullRequired

Why you cannot keep it now, as Keep would refuse it. null when you can, while it is building, and once it is kept or closed.

urlstringRequired

The Keep page in the Control Panel. Format: uri.

kept_atstring or nullRequired

Format: date-time.

packagestring or nullRequired

The package the demo is on, such as CS4.

price_afterobject or any or nullRequired

What it costs a month once kept as it is. null when it cannot be priced.

product_linestring or nullRequired

CS for a CoreStack site, CC for a CoreCluster.

regionstring or nullRequired

The region's code, such as uk.

starts_atstring or nullRequired

Format: date-time.

statestringRequired

building while it is set up, active while it runs, ended once its time is up and it waits in its grace period, kept, or closed.

buildingactiveendedkeptclosed
targetobjectRequired

What the demo is of.

Fields
idinteger or nullRequired

The site row's id or the CoreCluster's id. At least 1.

namestring or nullRequired

The site's domain or the cluster's name.

typestring or nullRequired
siteclusternull
upgradeobjectRequired
Fields
nextstring or nullRequired

The changes of a Keep that still wait to be applied, as a short token. null when nothing waits.

keptobjectRequired
Fields
alreadybooleanRequired

Whether the demo was kept before this request.

billed_fromstring or nullRequired

When billing starts, the next full hour after the Keep. null when the demo was kept already. Format: date-time.

kept_atstringRequired

Format: date-time.

restoredbooleanRequired

Whether the Keep brought back a site that had been paused when its demo ended.

stagingstringRequired

Whether a restored site's staging environment is being made again.

nonestartedrefused
progressobjectRequired

Where each change a Keep asked for stands. They are applied one at a time, in the order listed. It is not the shared ProgressStage: a change has a plan and a kind in place of a key and a label, and the times of its start and its end.

Fields
changesarray of objectsRequired
Fields of each item
ended_atstring or nullRequired

Format: date-time.

kindstringRequired

A package, a server type, or add-on units.

packagefamilyaddons
operation_idinteger or nullRequired

The operation that applies the change, once it has started. Follow it with GET /corestack/operations/{operation}. A CoreCluster's server type change has none. At least 1.

planstringRequired

The change as a short token, such as cs8 or cores2.

started_atstring or nullRequired

Format: date-time.

statestringRequired
waitingapplyingdonefailedstarted
nextstring or nullRequired

The changes still waiting, as a short token such as cores2. null when nothing waits.

statestringRequired

none when the Keep asked for no change, applying while any change waits or runs, done when every one landed, failed when one did not (the kept price stands), started when a change started and there is nothing to follow it by.

noneapplyingdonefailedstarted
upgradeobjectRequired

The first change the Keep asked for.

Fields
family_changeobject

Only when a CoreCluster's server type change started. It has no operation of its own.

Fields
familystringRequired
generaloptimised
itemsarray of integersRequired

The ids of the queued moves, one for each site of the cluster.

messagestring or nullRequired

Why the change was refused.

nextstring or nullRequired

The changes still waiting, as a short token.

operation_idinteger or nullRequired

The operation that applies the change. Follow it with GET /corestack/operations/{operation}. At least 1.

reasonstring or null

The refusal's code, or why the change is queued. Absent when no change was asked.

statestringRequired

none when no change was asked, started (the answer is 202), queued when it waits because the site or cluster is busy, refused when it could not be applied; the demo is kept either way.

nonestartedqueuedrefused
Fields of the 202 answer
demoobjectRequired
Fields
days_leftinteger or nullRequired

Whole days until the demo ends. null unless the demo is active.

ends_atstring or nullRequired

Format: date-time.

grace_ends_atstring or nullRequired

Until when an ended demo can still be kept. Format: date-time.

idintegerRequired

At least 1.

keepobjectRequired
Fields
allowedbooleanRequired

Whether you could keep it now.

refusalobject or any or nullRequired

Why you cannot keep it now, as Keep would refuse it. null when you can, while it is building, and once it is kept or closed.

urlstringRequired

The Keep page in the Control Panel. Format: uri.

kept_atstring or nullRequired

Format: date-time.

packagestring or nullRequired

The package the demo is on, such as CS4.

price_afterobject or any or nullRequired

What it costs a month once kept as it is. null when it cannot be priced.

product_linestring or nullRequired

CS for a CoreStack site, CC for a CoreCluster.

regionstring or nullRequired

The region's code, such as uk.

starts_atstring or nullRequired

Format: date-time.

statestringRequired

building while it is set up, active while it runs, ended once its time is up and it waits in its grace period, kept, or closed.

buildingactiveendedkeptclosed
targetobjectRequired

What the demo is of.

Fields
idinteger or nullRequired

The site row's id or the CoreCluster's id. At least 1.

namestring or nullRequired

The site's domain or the cluster's name.

typestring or nullRequired
siteclusternull
upgradeobjectRequired
Fields
nextstring or nullRequired

The changes of a Keep that still wait to be applied, as a short token. null when nothing waits.

keptobjectRequired
Fields
alreadybooleanRequired

Whether the demo was kept before this request.

billed_fromstring or nullRequired

When billing starts, the next full hour after the Keep. null when the demo was kept already. Format: date-time.

kept_atstringRequired

Format: date-time.

restoredbooleanRequired

Whether the Keep brought back a site that had been paused when its demo ended.

stagingstringRequired

Whether a restored site's staging environment is being made again.

nonestartedrefused
progressobjectRequired

Where each change a Keep asked for stands. They are applied one at a time, in the order listed. It is not the shared ProgressStage: a change has a plan and a kind in place of a key and a label, and the times of its start and its end.

Fields
changesarray of objectsRequired
Fields of each item
ended_atstring or nullRequired

Format: date-time.

kindstringRequired

A package, a server type, or add-on units.

packagefamilyaddons
operation_idinteger or nullRequired

The operation that applies the change, once it has started. Follow it with GET /corestack/operations/{operation}. A CoreCluster's server type change has none. At least 1.

planstringRequired

The change as a short token, such as cs8 or cores2.

started_atstring or nullRequired

Format: date-time.

statestringRequired
waitingapplyingdonefailedstarted
nextstring or nullRequired

The changes still waiting, as a short token such as cores2. null when nothing waits.

statestringRequired

none when the Keep asked for no change, applying while any change waits or runs, done when every one landed, failed when one did not (the kept price stands), started when a change started and there is nothing to follow it by.

noneapplyingdonefailedstarted
upgradeobjectRequired

The first change the Keep asked for.

Fields
family_changeobject

Only when a CoreCluster's server type change started. It has no operation of its own.

Fields
familystringRequired
generaloptimised
itemsarray of integersRequired

The ids of the queued moves, one for each site of the cluster.

messagestring or nullRequired

Why the change was refused.

nextstring or nullRequired

The changes still waiting, as a short token.

operation_idinteger or nullRequired

The operation that applies the change. Follow it with GET /corestack/operations/{operation}. At least 1.

reasonstring or null

The refusal's code, or why the change is queued. Absent when no change was asked.

statestringRequired

none when no change was asked, started (the answer is 202), queued when it waits because the site or cluster is busy, refused when it could not be applied; the demo is kept either way.

nonestartedqueuedrefused

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403forbidden_roleKeeping a demo needs the organisation's owner or a billing role. Ask the owner to keep it.
403two_factor_requiredTurn on two-factor on your account, then send again.
403scope_requiredUse a token with the scope named in scope.
404feature_offThis feature is not on for your organisation yet.
409already_keptThe demo has already been kept. Nothing to do.
409billing_details_requiredBilling details are needed to keep the demo. Add them, then keep it.
409busyAnother operation is running on the site. Wait for it to finish.
409demo_buildingThe demo is still being set up. Keep it once it is ready.
409demo_closedThe demo has ended and can no longer be kept. Start an order to carry on.
409managed_elsewhereThis site is read-only here. Change it in the control panel that manages it.
409payment_method_requiredA payment method is needed to keep the demo. Add one, then keep it.
422addon_boundsAn add-on quantity is outside what is allowed. Choose a whole number inside the range the message gives.
422confirm_mismatchSend the confirmation exactly as the field named in field asks for it.
422invalidFix the field named in field; errors says why.
422package_not_offeredThe package chosen for the demo is not offered. Choose one that is.
422package_platformThe package is not offered for the site's platform. Choose a package that is.
422privacy_requiredThe privacy notice has not been accepted. Accept it to keep the demo.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl -X POST https://manage.corefinity.com/api/corestack/demos/3310/keep \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "accept_privacy": true,
    "confirm_keep": "journal.harbourandfinch.example.com"
  }'
{
  "demo": {
    "days_left": null,
    "ends_at": "2026-12-06T09:00:00Z",
    "grace_ends_at": null,
    "id": 3310,
    "keep": {
      "allowed": false,
      "refusal": null,
      "url": "https://manage.corefinity.com/billing/keep?demo=3310&plan=keep"
    },
    "kept_at": "2026-11-09T10:15:00Z",
    "package": "CS4",
    "price_after": {
      "amount": "300.00",
      "currency": "GBP"
    },
    "product_line": "CS",
    "region": "uk",
    "starts_at": "2026-11-06T09:00:00Z",
    "state": "kept",
    "target": {
      "id": 1051,
      "name": "journal.harbourandfinch.example.com",
      "type": "site"
    },
    "upgrade": {
      "next": null
    }
  },
  "kept": {
    "already": false,
    "billed_from": "2026-11-09T11:00:00Z",
    "kept_at": "2026-11-09T10:15:00Z",
    "restored": false,
    "staging": "none"
  },
  "progress": {
    "changes": [],
    "next": null,
    "state": "none"
  },
  "upgrade": {
    "message": null,
    "next": null,
    "operation_id": null,
    "state": "none"
  }
}
Try it

Try it is off for this endpointIt can add to your bill. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT