Projects
updateProject
Update a project
Partially updates a project. Only provided fields are modified.
Usage
const result = await api.projects.updateProject({
pathParams: { project_id: "prj_xxx" },
body: {
,
},
});Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| pathParams.project_id | string | Yes | Unique project identifier (prefixed, e.g. prj_xxx). |
| body.name | string | No | Updated project name. |
| body.description | string | No | Updated project description. |
| body.tags | string[] | No | Replacement set of user-defined project labels. |
| body.status | ProjectStatus | No | |
| body.allowed_cidrs | CidrEntry[] | No | IP filtering rules as CIDR ranges with optional labels. Empty array means allow all. Both IPv4 and IPv6 CIDR notation are supported. |
Response
Promise<Project> — project updated.
Example
import { PgBeamClient } from "pgbeam";
const client = new PgBeamClient({
token: "pbk_...",
baseUrl: "https://api.pgbeam.com",
});
const result = await client.api.projects.updateProject({
pathParams: { project_id: "prj_xxx" },
body: {
,
},
});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. |