CorefinityCorefinityDocs
Open the Control PanelControl Panel
Database · 2 of 11

Get a site's database details

Answers how to connect to the database of a site or one of its environments, its database users with their limits, and external access with its allowed addresses and price. It never answers a password: the site's own login and a generated password each have their own reveal.

GET/api/corestack/sites/{site}/database

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.

Returns

200 The database details.

Fields of the 200 answer
canobjectRequired

What you may do on this environment.

Fields
edit_sourcesbooleanRequired
enable_externalbooleanRequired

Whether you may turn external access on or off, which needs the right to change the site's billing.

manage_usersbooleanRequired
reveal_applicationbooleanRequired
connectionobjectRequired

How the site itself, and a client through an SSH tunnel, reach the database. Never a username or a password.

Fields
databasestringRequired

The database's name.

enginestringRequired
hoststringRequired

The database's address as the site itself reaches it. It is not reachable from outside the site.

portintegerRequired
ssh_tunnelstring or nullRequired

A command that opens an SSH tunnel to the database from your own computer. Null when the site has no SSH address yet.

versionstring or nullRequired

The major and minor version, such as 11.4.

countsobjectRequired
Fields
externalintegerRequired

How many of them are external.

external_capintegerRequired
usersintegerRequired

The users you added.

users_capintegerRequired

The most users one environment can hold.

externalobject or any or nullRequired

External access. Null while external access is not on for your company.

usersarray of objectsRequired

The site's own application login first, then the users you added.

Fields of each item
actionsarray of stringsRequired

What you may do with the user now: reveal on the application login, edit, rotate and delete on a user you added.

added_atstring or null

Format: date-time.

added_bystring or null

The name of the person who added the user.

connects_fromstringRequired
siteinternalexternal
databasestringRequired
idinteger or null

Absent on the application login. Null on a user that is still being added (pending.action is add), until its operation completes. At least 1.

kindstringRequired

protected is the site's own application login, which is never changed from here.

protectedinternalexternal
max_statement_timeinteger or null

The longest statement, in seconds. Null for no limit. External users only.

max_user_connectionsinteger or null

The most connections at once. Null for no limit. External users only.

password_originstring

generated, or a password you set yourself.

pendingobject or any or null

The change running on this user, or null.

require_tlsboolean
reveal_pendingboolean

True while a generated password is waiting for you to reveal it.

scopestringRequired
applicationread_onlyread_write
usernamestringRequired
viewer_ipstring or nullRequired

The IPv4 address your request came from, or null when it is not IPv4.

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/sites/1042/database \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "can": {
    "edit_sources": true,
    "enable_external": true,
    "manage_users": true,
    "reveal_application": true
  },
  "connection": {
    "database": "application",
    "engine": "MariaDB",
    "host": "127.0.0.1",
    "port": 3306,
    "ssh_tunnel": "ssh -N -L 3306:127.0.0.1:3306 -p 30122 [email protected]",
    "version": "11.4"
  },
  "counts": {
    "external": 0,
    "external_cap": 5,
    "users": 1,
    "users_cap": 10
  },
  "external": {
    "address": "203.0.113.40",
    "available": true,
    "database": "application",
    "enabled_at": "2026-11-02T15:41:09+00:00",
    "enabled_by": "Daniel Reyes",
    "host": "harbourandfinch-example-com-db.northwind.cfstack.example.net",
    "moved_at": null,
    "operation": null,
    "port": 3306,
    "price": {
      "amount": "15.00",
      "billed_on": "corestack",
      "currency": "GBP",
      "label": "Dedicated IP address",
      "period": "month"
    },
    "sanitised": false,
    "sources": [
      {
        "added_at": "2026-11-02T15:41:09+00:00",
        "added_by": "Daniel Reyes",
        "cidr": "192.0.2.15/32",
        "label": "Reporting",
        "pending": false
      },
      {
        "added_at": "2026-11-02T15:41:09+00:00",
        "added_by": "Daniel Reyes",
        "cidr": "198.51.100.64/29",
        "label": "Order system",
        "pending": false
      }
    ],
    "sources_cap": 10,
    "status": "on",
    "tls": "optional",
    "window_date": null
  },
  "users": [
    {
      "actions": [
        "reveal"
      ],
      "connects_from": "site",
      "database": "application",
      "kind": "protected",
      "scope": "application",
      "username": "application"
    },
    {
      "actions": [
        "edit",
        "rotate",
        "delete"
      ],
      "added_at": "2026-11-03T09:16:41+00:00",
      "added_by": "Daniel Reyes",
      "connects_from": "internal",
      "database": "application",
      "id": 4112,
      "kind": "internal",
      "max_statement_time": null,
      "max_user_connections": null,
      "password_origin": "generated",
      "pending": null,
      "require_tls": false,
      "reveal_pending": true,
      "scope": "read_only",
      "username": "reporting_ro"
    }
  ],
  "viewer_ip": "198.51.100.24"
}
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