ReplayPolicy

Replays the project's recorded agent audit traffic against a candidate policy (either a draft supplied inline or an existing policy referenced by id) and reports what would change: which queries that ran would now be blocked, which blocked queries would now be permitted, and which results would be masked or row-filtered. Traffic is deduplicated by normalized query shape, newest first, and every statement is evaluated through the data plane's own policy engine, so the verdicts match real enforcement. Stateful checks (budgets, approvals, write-mode routing) are reported as informational notes on each result, not verdicts. This endpoint reads only the audit log; it never connects to the upstream database and persists nothing.

Usage

result, err := client.Policies.ReplayPolicy(ctx, "prj_xxx", pgbeam.PolicyReplayInput{

  })

Parameters

Parameter	Type	Required	Description
ctx	`context.Context`	Yes	Request context
projectID	`string`	Yes	Unique project identifier (prefixed, e.g. prj_xxx).
req	`pgbeam.PolicyReplayInput`	Yes	Request body
req.PolicyID	`*string`	No	ID of an existing saved policy profile to replay against.
req.Policy	`*pgbeam.PolicyProfileInput`	No
req.CredentialID	`*string`	No	Restrict the replay to traffic recorded for one agent credential.
req.StartTs	`*string`	No	Start of the traffic window (inclusive). Defaults to 7 days before end_ts.
req.EndTs	`*string`	No	End of the traffic window (exclusive). Defaults to now.
req.Limit	`*int`	No	Maximum number of distinct queries to replay, newest first. Traffic is deduplicated by normalized query hash before evaluation.

Response

(*pgbeam.PolicyReplayResult, error): the replay summary and per-query decisions.

Example

import pgbeam "go.pgbeam.com/sdk"

client := pgbeam.NewClient(&pgbeam.ClientOptions{
  APIKey: "pgb_your_api_key",
})

result, err := client.Policies.ReplayPolicy(ctx, "prj_xxx", pgbeam.PolicyReplayInput{
    PolicyID: "pol_01h455vb4pex5vsknk084sn02q",
    Policy: pgbeam.PolicyProfileInput{ /* ... */ },
    CredentialID: "cred_01h455vb4pex5vsknk084sn02q",
    StartTs: "...",
    EndTs: "...",
    Limit: 200,
  })
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)

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.