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

Get connection string

cURL

curl --request GET \
  --url https://api.case.dev/database/v1/projects/{id}/connection \
  --header 'Authorization: Bearer <token>'

200

{
  "connectionUri": "postgresql://user:[e-mail]/neondb?sslmode=require",
  "branch": "main",
  "pooled": false
}

Authorizations

Authorization · string · header · required

API key starting with sk_case_

Path Parameters

id · string · required

Database project ID

Query Parameters

branch · string

Branch name (defaults to 'main')

pooled · boolean

Use pooled connection (PgBouncer)

Response

200

application/json

Connection string retrieved successfully

connectionUri · string<uri> · required

PostgreSQL connection string (includes credentials)

branch · string · required

Branch name for this connection

pooled · boolean · required

Whether this is a pooled connection