CorefinityCorefinityDocs
Open the Control PanelControl Panel
Database · 4 of 11

Create a database user

Adds a database user to the environment: an internal user connects from inside the site only, an external user through external access only. A generated password is never in the answer: once the operation completes, reveal it once with the reveal endpoint. Try-it is off because the request creates a login.

POST/api/corestack/sites/{site}/database/users

Path parameters

siteintegerRequired

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

confirm_read_writestring

Sent with scope: read_write.

kindstringRequired

internal connects from inside the site only. external connects through external access only, which must be on.

internalexternal
max_statement_timeinteger or null

The longest statement, in seconds, from 1 to 86400. Null or absent for no limit. External users only.

max_user_connectionsinteger or null

The most connections at once, from 1 to 1000. Null or absent for no limit. External users only.

passwordobjectRequired
Fields
modestringRequired

generate: a 24-character password, revealed once. set: your own, in value.

generateset
valuestring

Your own password, with mode: set. 12 to 64 printable characters, without spaces, quotes, backticks or backslashes.

require_tlsboolean

Refuse connections that are not encrypted. External users only.

scopestringRequired

read_only: SELECT and SHOW VIEW. read_write: also changing and deleting data.

read_onlyread_write
usernamestringRequired

3 to 32 lower-case letters, digits and underscores, starting with a letter. Some names are kept for the platform.

Returns

202 The user is being added. Follow operation.id until it completes. Poll the operation until it finishes.

Fields of the 202 answer
operationobjectRequired

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 /corestack/operations/{operation} until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.

Fields
applied_atstring or null
can_retryboolean or null
clusterobject or any or null

The cluster the operation runs on.

committed_atstring or null
completed_atstring or nullRequired
created_atstring or nullRequired
environmentobject or any or null
errorstring or nullRequired

Why the operation failed, in plain words. Null unless status is failed.

failure_reasonstring or null

A stable code for the failure.

from_versionstring or null
hotboolean or null

True when the change applies without a maintenance window.

idintegerRequired
installobject or null
labelstring or null
notesarray of objects

What the operation did differently on purpose. Empty when nothing.

Fields of each item
codestringRequired
textstringRequired
parent_operation_idinteger or null
requested_byany

Who asked for the change.

reset_targetany

Present on some site creations and copies.

resultany

Always null here. A one-time result is read once with the reveal endpoint.

result_statestring
nonependingavailableviewed
retried_by_operation_idinteger or null
retries_operation_idinteger or null
retry_requiresany

What a retry needs first, if anything.

revealedany

Who revealed a one-time result and when, when there was one.

scopestringRequired
siteclusterbatch
siteobject or any or null

The website the operation belongs to. Null for a cluster's own operation.

statusstringRequired

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_outexecutingcompletedfailed
status_labelstringRequired
stepstring or null

The key of the step the operation is at. Null once it has completed.

stepsarray of objectsRequired
Fields of each item
keystring
labelstring
statestring

One of done, current, todo, failed or skipped.

subjectobject or null
summarystring or null
to_versionstring or null
typestringRequired

The kind of change, such as crons_change or redirects_change.

type_labelstringRequired

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.
409busyAnother operation is running on the site. Wait for it to finish.
409deletedThe site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored.
409managed_elsewhereThis site is read-only here. Change it in the control panel that manages it.
409provisioningThe site is still being created. Try again in a few minutes.
422invalidFix the field named in field; errors says why.
422external_offExternal access is off, and external users connect through it. Turn external access on first.
422user_capThe environment holds as many database users as it can. Delete one you no longer need, or ask support.
429rate_limitedWait for the seconds in Retry-After.
503switched_offCorefinity has switched this action off for the moment. Try again later.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/database/users \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "confirm_read_write": "read-write",
    "kind": "external",
    "max_statement_time": 30,
    "max_user_connections": 5,
    "password": {
      "mode": "set",
      "value": "example-password-not-a-secret"
    },
    "require_tls": true,
    "scope": "read_write",
    "username": "erp_sync"
  }'
{
  "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": 5120,
    "install": null,
    "label": "Saved",
    "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": "Saving the change",
    "step": "saved",
    "steps": [
      {
        "key": "saved",
        "label": "Saved",
        "state": "current"
      },
      {
        "key": "applied",
        "label": "Applied in the database",
        "state": "todo"
      }
    ],
    "subject": null,
    "summary": "User reports_ro added (internal, read-only)",
    "to_version": null,
    "type": "db_user_change",
    "type_label": "Database users"
  }
}
Try it

Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT