Skip to main content
POST
Restart database

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.

pending
boolean

true when the provider accepted the change asynchronously and it has not been applied yet — the ceiling/volume fields are then the PRE-change values. Re-read (GET) to see the applied state. Absent when the change was applied synchronously.

publicAccess
boolean

postgres (insta-db) — false: the public endpoint refuses every connection (SQLSTATE 28000) and the database is not reachable from the internet; only the private network lane connects. Change it with PUT .../services/{serviceId}/access. Absent when the provider does not report it.

privateAccess
boolean

postgres (insta-db) — true: the database has a private network connection string (privateConnString, and DATABASE_PRIVATE_URL in the service credentials) for compute services on the insta-compute provider. Change it with PATCH .../database/settings {privateAccess}. Absent when the provider does not report it.

privateConnString
string

the connection string over the private network lane, WITHOUT the password (the full URL is DATABASE_PRIVATE_URL in the service credentials). Present only while privateAccess is on.

privateLane
object

GET .../database/instance only — this deployment's private-lane switches, so a UI can render the toggles without a probing write

warnings
string[]

what this change will break and how to fix it (e.g. compute services bound to DATABASE_PRIVATE_URL when private access is turned off). Advisory: the change was applied.