Get database project

Retrieves detailed information about a specific database project including branches, databases, storage/compute metrics, connection host, and linked deployments. Fetches live usage statistics from Neon API.

GET /database/v1/projects/{id}

cURL

cURL

curl -X GET "https://api.case.dev/database/v1/projects/%3Cstring%3E" \ -H "Authorization: Bearer $CASEDEV_API_KEY"

200

{
  "id": "proj_abc123",
  "name": "case-mgmt-db",
  "description": "Production case management database",
  "region": "aws-us-east-1",
  "pgVersion": 17,
  "status": "active",
  "connectionHost": "ep-quiet-meadow-123456.us-east-1.aws.neon.tech",
  "storageSizeBytes": 1073741824,
  "computeTimeSeconds": 3600,
  "branches": [
    {
      "id": "branch_main_789",
      "name": "main",
      "isDefault": true,
      "status": "active",
      "createdAt": "2025-01-10T08:00:00Z"
    },
    {
      "id": "branch_staging_012",
      "name": "staging",
      "isDefault": false,
      "status": "active",
      "createdAt": "2025-01-12T10:00:00Z"
    }
  ],
  "databases": [
    {
      "id": "db_neondb_345",
      "name": "neondb",
      "ownerName": "neondb_owner"
    }
  ],
  "linkedDeployments": [
    {
      "type": "compute",
      "id": "app_xyz789",
      "name": "case-portal",
      "url": "https://case-portal.case.systems",
      "envVarName": "DATABASE_URL"
    }
  ],
  "createdAt": "2025-01-10T08:00:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}

Authorizations

Authorization · string · header · required

API key starting with sk_case_

Path Parameters

id · string · required

Database project ID

Response

200

application/json

Project details retrieved successfully

id · string · required

Project ID

name · string · required

Project name

region · string · required

AWS region

pgVersion · integer · required

PostgreSQL major version

status · enum<string> · required

Project status

Available options: active, suspended, deleted

connectionHost · string · required

Database connection hostname (masked for security)

storageSizeBytes · number · required

Current storage usage in bytes

computeTimeSeconds · number · required

Total compute time consumed in seconds

branches · object[] · required

All branches in this project

Show child attributes

databases · object[] · required

Databases in the default branch

Show child attributes

linkedDeployments · object[] · required

Linked deployments using this database

Show child attributes

createdAt · string<date-time> · required

Project creation timestamp

updatedAt · string<date-time> · required

Project last update timestamp

description · string | null

Project description