v44

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-192301780.0 KB
Database

Get connection string

Retrieves the PostgreSQL connection URI for a database project. Supports selecting specific branches and pooled vs direct connections. Connection strings include credentials and should be stored securely. Use for configuring applications and deployment environments.

get/database/v1/projects/{id}/connection

Path parameters

idstring required

Database project ID

Query parameters

branchstring

Branch name (defaults to 'main')

pooledboolean

Use pooled connection (PgBouncer)

Response

Connection string retrieved successfully

connectionUristring uri required

PostgreSQL connection string (includes credentials)

branchstring required

Branch name for this connection

pooledboolean required

Whether this is a pooled connection