Branches
listDatabaseBranches
List sandbox branches
Lists ephemeral sandbox branches for the project's databases.
Usage
const result = await api.branches.listDatabaseBranches({
pathParams: { project_id: "prj_xxx" },
});Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| pathParams.project_id | string | Yes | Unique project identifier (prefixed, e.g. prj_xxx). |
| queryParams.status | "pending" | "ready" | "error" | "discarded" | No | Filter to a single status. |
| queryParams.page_size | number | No | Maximum number of items to return (1-100, default 20). |
| queryParams.page_token | string | No | Opaque token for cursor-based pagination. |
Response
Promise<ListDatabaseBranchesResponse> — page of sandbox branches.
Example
import { PgBeamClient } from "pgbeam";
const client = new PgBeamClient({
token: "pbk_...",
baseUrl: "https://api.pgbeam.com",
});
const result = await client.api.branches.listDatabaseBranches({
pathParams: { project_id: "prj_xxx" },
queryParams: { status: "open", page_size: 20, page_token: "..." },
});Errors
| Status | Description |
|---|---|
| 400 | Invalid request parameters. |
| 401 | Missing or invalid authentication. |
| 403 | Operation not allowed by current plan limits. |
| 404 | Resource not found. |
| 429 | Rate limited. Try again later. |