Skip to content
Docs
Versions
List

List versions of a policy

API Reference
Zones
Policies
Versions

List versions of a policy

client.zones.policies.versions.list(stringpolicyID, VersionListParams { zone_id, after, before, 7 more } params, RequestOptionsoptions?): VersionListResponse { items, pagination }
GET/zones/{zone_id}/policies/{policy_id}/versions

List versions of a policy

ParametersExpand Collapse
policyID: string
params: VersionListParams { zone_id, after, before, 7 more }
zone_id: string

Path param: The zone identifier

after?: string

Query param: Cursor for forward pagination. Returned in Pagination.after_cursor. Mutually exclusive with before.

minLength1
maxLength255
before?: string

Query param: Cursor for backward pagination. Returned in Pagination.before_cursor. Mutually exclusive with after.

minLength1
maxLength255
expand?: Array<"total_count">

Query param: Opt-in to additional response fields. Repeatable; matches the expand[] convention used across the Keycard API.

format?: "cedar" | "json"

Query param: Narrows which Cedar representation the response includes. When omitted, both cedar_json and cedar_raw are populated. Pass json to receive only cedar_json, or cedar to receive only cedar_raw. Callers that don't care about payload size can skip this parameter.

Accepts one of the following:
"cedar"
"json"
limit?: number

Query param: Maximum number of items to return per page.

minimum1
maximum100
order?: "asc" | "desc"

Query param: Sort direction. Default is desc (newest first).

Accepts one of the following:
"asc"
"desc"
sort?: "created_at"

Query param: Field to sort by.

xAPIVersion?: string

Header param: API version header (date-based, e.g. 2026-02-01)

xClientRequestID?: string

Header param: Unique request identifier specified by the originating caller and passed along by proxies.

formatuuid
ReturnsExpand Collapse
VersionListResponse { items, pagination }
items: Array<PolicyVersion { id, created_at, created_by, 10 more } >
id: string
created_at: string
formatdate-time
created_by: string
owner_type: "platform" | "customer"

Who manages this policy version:

  • "platform" — managed by the Keycard platform (system policy versions).
  • "customer" — managed by the tenant (custom policy versions).
Accepts one of the following:
"platform"
"customer"
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?: string | null
formatdate-time
archived_by?: string | null
cedar_json?: unknown

Cedar policy in JSON representation. Populated by default and when format=json is passed; null when format=cedar narrows the response to the text representation only.

cedar_raw?: string | null

Cedar policy in human-readable syntax. Populated by default and when format=cedar is passed; null when format=json narrows the response to the JSON representation only.

List versions of a policy

import KeycardAPI from '@keycardai/api';

const client = new KeycardAPI();

const versions = await client.zones.policies.versions.list('policy_id', { zone_id: 'zone_id' });

console.log(versions.items);
{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "owner_type": "platform",
      "policy_id": "policy_id",
      "schema_version": "schema_version",
      "sha": "sha",
      "version": 0,
      "zone_id": "zone_id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "archived_by": "archived_by",
      "cedar_json": {},
      "cedar_raw": "cedar_raw"
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "owner_type": "platform",
      "policy_id": "policy_id",
      "schema_version": "schema_version",
      "sha": "sha",
      "version": 0,
      "zone_id": "zone_id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "archived_by": "archived_by",
      "cedar_json": {},
      "cedar_raw": "cedar_raw"
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}