Skip to main content
POST
db.postgres.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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.

eraseAt
string<date-time>

Data is retained until this time, seven days after deletion, then erased.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
issuedCredentialDisabled
boolean

The credential issued by the platform no longer works during the hold.

additionalLoginsDisabled
boolean

False beside sign-in: additional database logins you created are not disabled. True when the hold stops the project compute.

signInKept
boolean

Whether sign-in is kept running during this hold.

pausedBy
enum<string>

Who paused the shared project: you, its credit stop, or its limit.

Available options:
you,
credit,
limit