Turn external database access off
Removes the environment's external users at once, stops the charge, and releases the fixed address: turning access on again later gives a new address under the same host name. It needs a person who can change the site's billing, and confirm_environment, the environment's name as the Control Panel shows it.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Body
The environment's name, such as Production, in any letter case.
Returns
202 Access is being turned off. Follow operation.id until it completes. Poll the operation until it finishes.
Fields of the 202 answer
A change the Control Panel is making or has made. A save or an action that starts work answers one in operation; read it again by id with GET / until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.
Fields
The cluster the operation runs on.
Why the operation failed, in plain words. Null unless status is failed.
A stable code for the failure.
True when the change applies without a maintenance window.
What the operation did differently on purpose. Empty when nothing.
Fields of each item
Who asked for the change.
Present on some site creations and copies.
Always null here. A one-time result is read once with the reveal endpoint.
nonependingavailableviewedWhat a retry needs first, if anything.
Who revealed a one-time result and when, when there was one.
siteclusterbatchThe website the operation belongs to. Null for a cluster's own operation.
Where a change is. completed and failed are final; every other status means the change is still running and blocks another change to the same site.
pendingcommittedrolling_outexecutingcompletedfailedThe key of the step the operation is at. Null once it has completed.
Fields of each item
One of done, current, todo, failed or skipped.
The kind of change, such as crons_change or redirects_change.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | billing_forbidden | Billing is for the organisation's owner and billing contacts. Ask one of them to do this. |
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. |
409 | busy | Another operation is running on the site. Wait for it to finish. |
409 | external_db_already_off | External access is already off. Nothing to do. |
422 | invalid | Fix the field named in field; errors says why. |
422 | confirm_mismatch | Send the confirmation exactly as the field named in field asks for it. |
429 | rate_limited | Wait 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/sites/1042/external-db/disable \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"confirm_environment": "Production"
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/corestack/sites/1042/external-db/disable', [
'confirm_environment' => 'Production',
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/external-db/disable', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
confirm_environment: 'Production',
}),
});
// 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.post(
"https://manage.corefinity.com/api/corestack/sites/1042/external-db/disable",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"confirm_environment": "Production",
},
)
data = res.json() if res.content else None{
"operation": {
"applied_at": "2026-11-03T09:16:40Z",
"can_retry": false,
"cluster": {
"id": 1017,
"name": "Northwind UK 1"
},
"committed_at": null,
"completed_at": null,
"created_at": "2026-11-03T09:16:40Z",
"environment": {
"env_id": "rs-northwind-harbourandfinch-example-com",
"hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1042,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
},
"error": null,
"failure_reason": null,
"from_version": null,
"hot": false,
"id": 5121,
"install": null,
"label": "External users deleted",
"notes": [],
"parent_operation_id": null,
"requested_by": {
"id": 2012,
"name": "Daniel Reyes"
},
"reset_target": null,
"result": null,
"result_state": "none",
"retried_by_operation_id": null,
"retries_operation_id": null,
"retry_requires": null,
"revealed": null,
"scope": "site",
"site": {
"domain": "harbourandfinch.example.com",
"id": 1042
},
"status": "executing",
"status_label": "Deleting the external users",
"step": "users_dropped",
"steps": [
{
"key": "users_dropped",
"label": "External users deleted",
"state": "current"
},
{
"key": "billing_ended",
"label": "Charge stopped",
"state": "todo"
},
{
"key": "drained",
"label": "Outside access closed",
"state": "todo"
},
{
"key": "service_gone",
"label": "Endpoint removed",
"state": "todo"
},
{
"key": "dns_deleted",
"label": "Host name removed",
"state": "todo"
},
{
"key": "address_released",
"label": "Fixed address released",
"state": "todo"
},
{
"key": "off",
"label": "Off",
"state": "todo"
}
],
"subject": null,
"summary": "External database access turned off",
"to_version": null,
"type": "external_db_change",
"type_label": "External database access"
}
}{
"message": "Unauthenticated."
}{
"code": "billing_forbidden",
"message": "Billing for this site is Harbour & Finch's.",
"reason": "billing_forbidden"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "busy",
"message": "A change to external access is already in progress on this environment.",
"reason": "busy"
}{
"code": "invalid",
"errors": {
"confirm_environment": [
"Type Production to confirm."
]
},
"field": "confirm_environment",
"message": "Type Production to confirm.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it is off for this endpointIt deletes data that cannot be brought back. Copy the request and run it yourself when you are sure.