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

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 the branch and every change made on it are deleted.

Response

The result

deleted
boolean
required

The branch is gone, or there was no branch of this name. main is never touched.