PgBeam Docs
Projects

Get a project

GET
/v1/projects/{project_id}

Returns a single project by ID.

Authorization

AuthorizationBearer <token>

JWT issued by Better Auth. Verified via JWKS.

In: header

Path Parameters

project_id*string

Unique project identifier (prefixed, e.g. prj_xxx).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/projects/string"
{  "id": "prj_01h455vb4pex5vsknk084sn02q",  "org_id": "org_abc123",  "name": "my-app",  "description": "Production database proxy",  "tags": [    "production",    "us-east-1"  ],  "cloud": "aws",  "proxy_host": "string",  "queries_per_second": 1000,  "burst_size": 200,  "max_connections": 500,  "allowed_cidrs": [    {      "cidr": "10.0.0.0/8",      "label": "VPC"    },    {      "cidr": "2001:db8::/32",      "label": "IPv6 range"    }  ],  "default_policy_profile_id": "pol_01h455vb4pex5vsknk084sn02q",  "agents_disabled": false,  "database_count": 0,  "active_connections": 0,  "status": "active",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}