Database

Fields

Field	Type	Description
id *	string
project_id	string
environment_id *	string
name *	string
engine *	DatabaseEngine
version *	string
plan *	DatabasePlanId
status *	DatabaseStatus
storage_gb	integer
used_bytes	integer or null
pitr_days	integer
extensions	array of string
maintenance_window	string
masking	MaskingRules
pooling	boolean
public_access	object
internal_host	string
branch_of	object or null
backups	object
deletion	object or null	Set while soft-deleted (7 days). Restore is possible until purge_after.
managed_by_manifest	boolean
created_at *	string (date-time)
updated_at	string (date-time)

* always present

Example

{
  "id": "db_01jbx2m9k7q4r8t5v6w3y0z1db",
  "project_id": "prj_01jbx2m9k7q4r8t5v6w3y0z1pr",
  "environment_id": "env_01jbx2m9k7q4r8t5v6w3y0z1en",
  "name": "main",
  "engine": "postgres",
  "version": "18",
  "plan": "ha",
  "status": "available",
  "storage_gb": 50,
  "used_bytes": 1288490188,
  "pitr_days": 30,
  "extensions": [
    "pgvector",
    "pg_trgm"
  ],
  "maintenance_window": "Sun 02:00-04:00",
  "pooling": true,
  "public_access": {
    "enabled": false,
    "host": null,
    "port": null,
    "allow_ips": []
  },
  "internal_host": "main.db.guv.internal",
  "branch_of": null,
  "backups": {
    "last_backup_at": "2026-10-23T02:00:00Z",
    "last_restore_test_at": "2026-10-23T11:00:00Z",
    "last_restore_test_passed": true,
    "summary": "Backups on. Last restore test passed 3 h ago."
  },
  "deletion": null,
  "managed_by_manifest": true,
  "created_at": "2026-10-22T09:30:00Z",
  "updated_at": "2026-10-23T02:00:00Z"
}

Used by

• Get a database