Projects
updateCacheRule
Update cache rule
Enable or disable caching for a specific query shape, with optional TTL and SWR overrides. Requires the query to exist in the cache rules.
Usage
const result = await api.projects.updateCacheRule({
pathParams: {
project_id: "prj_xxx",
database_id: "db_xxx",
query_hash: "...",
},
body: {
cache_enabled: true,
},
});Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| pathParams.project_id | string | Yes | Unique project identifier (prefixed, e.g. prj_xxx). |
| pathParams.database_id | string | Yes | Unique database identifier (prefixed, e.g. db_xxx). |
| pathParams.query_hash | string | Yes | xxhash64 hex of the normalized SQL. |
| body.cache_enabled | boolean | Yes | Whether to enable caching for this query shape. |
| body.cache_ttl_seconds | number | No | TTL override in seconds. Null to use project default. |
| body.cache_swr_seconds | number | No | SWR override in seconds. Null to use project default. |
Response
Promise<UpdateCacheRuleResponse> — cache rule updated.
Example
import { PgBeamClient } from "pgbeam";
const client = new PgBeamClient({
token: "pbk_...",
baseUrl: "https://api.pgbeam.com",
});
const result = await client.api.projects.updateCacheRule({
pathParams: {
project_id: "prj_xxx",
database_id: "db_xxx",
query_hash: "...",
},
body: {
cache_enabled: true,
},
});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. |