policy

Replace correspondent policy

Declaratively set a scope's entire policy in one call — ideal for automated provisioning. Sets the inbound and/or outbound mode and REPLACES the scope's own rules for any direction you include. Rules created here are fail-closed (an empty allowlist denies all). Omitted directions are left untouched. Inbox-scoped keys are rejected. A pod-scoped key may mutate its own pod or an inbox in that pod, never account-wide policy. Pod keys cannot set none or extra allows on a parent allowlist.

put/v1/policy

Request

  • Base URL: https://api.openmail.sh
  • URL: https://api.openmail.sh/v1/policy
  • Auth: HTTP bearer

Query parameters

podIdstring

Confine the operation to one pod's policy. Accepts the pod ID. Mutually exclusive with inboxId.

inboxIdstring

Confine the operation to one inbox's policy. Mutually exclusive with podId.

Request body

Response

The resulting policy for the scope

object required

The resulting policy for the scope

Changes

No recorded changes to this operation across all 1 revision of this API.