---
title: "Get a site's database details"
url: https://docs.corefinity.com/api/reference/database/get-site-database
type: endpoint
last_updated: 2026-11-13
feature: database
related:
  - https://docs.corefinity.com/guides/sites/database/database-users.md
  - https://docs.corefinity.com/mcp/tools/corestack_external_db_get.md
---
# 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.

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

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 120 a minute
- Try it in the console: on

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/sites/1042/database \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
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();
```

### Node

```javascript
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);
```

### Python

```python
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
```

## Responses

### 200 The database details.

```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 web@ssh-northwind.example.net",
    "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"
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | 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`. |

## The same task elsewhere

- Guide: [Database users](https://docs.corefinity.com/guides/sites/database/database-users.md)
- MCP tool: [`corestack_external_db_get`](https://docs.corefinity.com/mcp/tools/corestack_external_db_get.md)
