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.
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.
Returns
200 The database details.
Fields of the 200 answer
What you may do on this environment.
Fields
Whether you may turn external access on or off, which needs the right to change the site's billing.
How the site itself, and a client through an SSH tunnel, reach the database. Never a username or a password.
Fields
The database's name.
The database's address as the site itself reaches it. It is not reachable from outside the site.
A command that opens an SSH tunnel to the database from your own computer. Null when the site has no SSH address yet.
The major and minor version, such as 11.4.
Fields
How many of them are external.
The users you added.
The most users one environment can hold.
External access. Null while external access is not on for your company.
The site's own application login first, then the users you added.
Fields of each item
What you may do with the user now: reveal on the application login, edit, rotate and delete on a user you added.
Format: date-time.
The name of the person who added the user.
siteinternalexternalAbsent on the application login. Null on a user that is still being added (pending.action is add), until its operation completes. At least 1.
protected is the site's own application login, which is never changed from here.
protectedinternalexternalThe longest statement, in seconds. Null for no limit. External users only.
The most connections at once. Null for no limit. External users only.
generated, or a password you set yourself.
The change running on this user, or null.
True while a generated password is waiting for you to reveal it.
applicationread_onlyread_writeThe IPv4 address your request came from, or null when it is not IPv4.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
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. |
429 | rate_limited | Wait 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"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/sites/1042/database');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/database', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// 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.get(
"https://manage.corefinity.com/api/corestack/sites/1042/database",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"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"
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}