Skip to main content
GET
Get database instance

Authorizations

Authorization
string
header
required

Session access JWT or an API token (insta_<prefix>_<secret>).

Path Parameters

projectId
string<uuid>
required

Query Parameters

branch
string

branch name (default branch if omitted)

group
string

postgres service name (default: the sole postgres service)

Response

Default Response

id
string
name
string
state
string
routeKey
string
host
string
port
integer
connectionPooling
boolean
deletionProtection
boolean
scaleToZero
boolean
idleTimeoutSecs
integer
volumeSize
string

the service's volume (block disk) size

Example:

"10Gi"

volumeGib
number
storageSize
string
deprecated

DEPRECATED alias of volumeSize — dropped next release

storageGiB
number
deprecated

DEPRECATED alias of volumeGib — dropped next release

enabledExtensions
string[]
cpuMilli
integer

current cpu ceiling in millicores (2000 = 2 vCPU)

memoryMib
integer

current memory ceiling in MiB

cap
object

this plan's maximum for the ceilings — render sliders with their plan-limit markers. These are the caller's own tier caps and they move with the plan (and with env overrides per deployment), so read them from THIS field rather than assuming a tier's numbers; the parenthetical example that used to live here said 'pro 4 vCPU/4Gi/10Gi' and was stale on all three by the time anyone noticed.