Skip to main content
POST
db.postgres.provision

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json

No fields. Uses your own project and environment.

Response

The result

status
enum<string>
required

Ready to connect, paused, or now managed in your own account.

Available options:
ready,
paused,
transferred,
held
database
string
required

The fixed app database name; never an internal resource id.

Allowed value: "app"
role
string
required

The fixed app role name; never an internal resource id.

Allowed value: "app_owner"
limits
object
required

Your project's configured limits, shared with its sign-in backend.

created
boolean
required

True only when this call creates or restores the database and returns new connection addresses.

connectionString
string

Private pooled Postgres connection address for your app. Put it straight into your app's secret store; shown once.

Required string length: 1 - 16384
directConnectionString
string

Private direct Postgres connection address for migrations. Put it straight into your app's secret store; shown once.

Required string length: 1 - 16384