Policies

List policies in a zone

GET/zones/{zone_id}/policies

Create a new policy

POST/zones/{zone_id}/policies

Get a policy by ID

GET/zones/{zone_id}/policies/{policy_id}

Update a policy

PATCH/zones/{zone_id}/policies/{policy_id}

Archive a policy

DELETE/zones/{zone_id}/policies/{policy_id}

ModelsExpand Collapse

Policy = object { id, created_at, created_by, 9 more }

id: string

created_at: string

formatdate-time

created_by: string

name: string

owner_type: "platform" or "customer"

Who manages this policy:

"platform" — managed by the Keycard platform (system policies).
"customer" — managed by the tenant (custom policies).

Accepts one of the following:

"platform"

"customer"

updated_at: string

formatdate-time

zone_id: string

archived_at: optional string

formatdate-time

description: optional string

latest_version: optional number

Human-readable version number of the latest version (e.g., 1, 2, 3)

latest_version_id: optional string

updated_by: optional string

PolicyDraft = object { cedar_json, created_at, policy_id, 3 more }

cedar_json: unknown

Cedar policy in JSON representation

created_at: string

formatdate-time

policy_id: string

schema_version: string

updated_at: string

formatdate-time

updated_by: string

PoliciesVersions

List versions of a policy

GET/zones/{zone_id}/policies/{policy_id}/versions

Create a new immutable policy version

POST/zones/{zone_id}/policies/{policy_id}/versions

Get a specific policy version

GET/zones/{zone_id}/policies/{policy_id}/versions/{version_id}

Archive a policy version

DELETE/zones/{zone_id}/policies/{policy_id}/versions/{version_id}

ModelsExpand Collapse

PolicyVersion = object { id, created_at, created_by, 9 more }

id: string

created_at: string

formatdate-time

created_by: string

policy_id: string

schema_version: string

Schema version this policy was validated against when created.

sha: string

Hex-encoded content hash

version: number

zone_id: string

archived_at: optional string

formatdate-time

archived_by: optional string

cedar_json: optional unknown

Cedar policy in JSON representation. Populated when format=json (default).

cedar_raw: optional string

Cedar policy in human-readable syntax. Populated when format=cedar.