PgBeam Docs
Databases

Test database connection

POST
/v1/projects/{project_id}/databases/{database_id}/test-connection

Attempts to connect to the upstream database using the stored credentials and returns the result.

Authorization

AuthorizationBearer <token>

JWT issued by Better Auth. Verified via JWKS.

In: header

Path Parameters

project_id*string

Unique project identifier (prefixed, e.g. prj_xxx).

database_id*string

Unique database identifier (prefixed, e.g. db_xxx).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/projects/string/databases/string/test-connection"
{  "ok": true,  "latency_ms": 0,  "error": "string",  "server_version": "string"}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}