Projects
listCacheRules
List cache rules
Returns the cache rules for a database, showing all observed query shapes with their stats and cache recommendations.
Usage
const result = await api.projects.listCacheRules();Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| 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<ListCacheRulesResponse> — cache rule entries.
Example
import { PgBeamClient } from "pgbeam";
const client = new PgBeamClient({
token: "pbk_...",
baseUrl: "https://api.pgbeam.com",
});
const result = await client.api.projects.listCacheRules({
queryParams: { 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. |