Sign in

v22

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-01140308542.4 KB
PolicySchemas

Get a policy schema by version

get/zones/{zone_id}/policy-schemas/{version}

Path parameters

zone_idstring required

The zone identifier

versionstring required

The schema version string

Query parameters

format'cedar' | 'json'

Schema representation format. cedar returns human-readable Cedar syntax in cedar_schema, json returns Cedar JSON schema object in cedar_schema_json.

Headers

X-API-Versionstring

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

X-Client-Request-IDstring uuid

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

Response

The requested policy schema

versionstring required
status'active' | 'deprecated' | 'archived' required

Controls what can be done with this schema version:

  • "active" - new policy versions can be created and validated against it.
  • "deprecated" - superseded by a newer version but still accepts new policy versions.
  • "archived" - closed to new policy versions. Existing policy set versions pinned to this schema still evaluate normally.
cedar_schemastring nullable

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

cedar_schema_jsonobject nullable

Cedar schema as JSON object. Populated when format=json (default).

deprecated_atstring date-time nullable
archived_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required
is_defaultboolean required

Whether this is the zone's default schema. Clients use this to pre-select which schema to write policies against. Has no effect on evaluation.