PgBeam Docs
Agents

verifyAuditChain

Verify the tamper-evident audit chain

Recomputes the project's audit hash chain over an optional time range and reports whether it is intact. Each audit entry is linked to its predecessor with a SHA-256 hash, so editing or deleting any row breaks the chain. On a break, the response reports the first sequence number where a tampered or deleted entry was detected. Requires the same audit:read permission as the list and export endpoints.

Usage

const result = await api.agents.verifyAuditChain({
  pathParams: { project_id: "prj_xxx" },
});

Parameters

ParameterTypeRequiredDescription
pathParams.project_idstringYesUnique project identifier (prefixed, e.g. prj_xxx).
queryParams.startstringNoReturn entries at or after this timestamp (inclusive lower bound).
queryParams.endstringNoReturn entries strictly older than this timestamp (cursor / upper bound).

Response

Promise<AuditChainVerification>: chain verification result.

Example

import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbk_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.agents.verifyAuditChain({
  pathParams: { project_id: "prj_xxx" },
  queryParams: { start: "...", end: "..." },
});

Errors

StatusDescription
400Invalid request parameters.
401Missing or invalid authentication.
403Operation not allowed by current plan limits.
404Resource not found.
429Rate limited. Try again later.

On this page