Branches
DiscardDatabaseBranch
Discard a sandbox branch
Marks an ephemeral sandbox branch as discarded for teardown.
Usage
err := client.Branches.DiscardDatabaseBranch(ctx, "prj_xxx", "brn_xxx")Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| ctx | context.Context | Yes | Request context |
| projectID | string | Yes | Unique project identifier (prefixed, e.g. prj_xxx). |
| branchID | string | Yes | Unique sandbox branch identifier (prefixed, e.g. brn_xxx). |
Response
error — returns nil on success.
Example
import pgbeam "go.pgbeam.com/sdk"
client := pgbeam.NewClient(&pgbeam.ClientOptions{
APIKey: "pgb_your_api_key",
})
err := client.Branches.DiscardDatabaseBranch(ctx, "prj_xxx", "brn_xxx")
if err != nil {
log.Fatal(err)
}Errors
| Status | Description |
|---|---|
| 400 | Invalid request parameters. |
| 401 | Missing or invalid authentication. |
| 403 | Operation not allowed by current plan limits. |
| 404 | Resource not found. |