Skip to main content
POST
db.postgres.branch.reset

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
name
string
required

The name the branch was created with.

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
confirm
boolean
required

Required confirmation that every change made on the branch is discarded.

Response

The result

name
string
required

Your name for the branch, unique within this database: lower-case letters, digits and hyphens, at most 63 characters, for example draft-42.

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$
parent
string
required

The database the branch copies: main, your project's own database.

Allowed value: "main"
purpose
enum<string>
required

What the branch is for: a draft of the app, a check run against it, or an agent run.

Available options:
draft,
check,
run
expiresAt
string<date-time>
required

When the branch and its data are deleted automatically.

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))$
status
enum<string>
required
Available options:
ready
database
string
required

The fixed app database name, as in main.

Allowed value: "app"
role
string
required

The fixed app role name. Its new login works on this branch only.

Allowed value: "app_owner"
connectionString
string
required

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
required

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

Required string length: 1 - 16384