List correspondent policy audit events
Read the append-only audit trail for correspondent policy, newest first. Two kinds of event share one stream: rule_added, rule_removed, mode_changed, and scope_deleted record who moved the boundary and how (scope_deleted covers a pod or inbox being deleted, which cascade-deletes its policy — the row carries the modes and rules that were removed, so lifting a restriction by deleting its scope is not a silent operation). send_rejected and inbound_rejected record what the boundary refused: a send the outbound policy would not make, and inbound mail it would not accept. Both are deduped to one row per inbox + correspondent per hour, so neither a looping agent nor an outside sender can flood the trail. Rows are never updated or deleted. Inbox-scoped keys are rejected. A pod-scoped key may read the trail for its own pod or an inbox in that pod (?podId= / ?inboxId=), never the unfiltered account-wide trail.
Request
- Base URL: https://api.openmail.sh
- URL: https://api.openmail.sh/v1/policy/audit
- Auth: HTTP bearer
Query parameters
Confine the operation to one pod's policy. Accepts the pod ID. Mutually exclusive with inboxId.
Confine the operation to one inbox's policy. Mutually exclusive with podId.
Comma-separated actions to include: rule_added, rule_removed, mode_changed, scope_deleted, send_rejected, inbound_rejected. Omit for all.
inbound governs who may send to the inbox; outbound governs who the inbox may send to (enforced across To, Cc, Bcc, and Reply-To on every send path).
ISO-8601 timestamp. Only events at or after this time (inclusive).
ISO-8601 timestamp. Only events strictly before this time.
Page size, 1–100. Defaults to 50.
Rows to skip. Defaults to 0.
Response
A page of audit events plus the unpaginated total. Each event carries its scope (with the pod name / inbox address resolved at read time, or null if since deleted), the acting console user where there was one, and an action-specific detail object: type/valueType/value for rule events, from/to for mode changes, and rejectedRecipient/reason/matchedScope for rejected sends.
A page of audit events plus the unpaginated total. Each event carries its scope (with the pod name / inbox address resolved at read time, or null if since deleted), the acting console user where there was one, and an action-specific detail object: type/valueType/value for rule events, from/to for mode changes, and rejectedRecipient/reason/matchedScope for rejected sends.
Changes
No recorded changes to this operation across all 1 revision of this API.