v22

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

List policy schemas

get/zones/{zone_id}/policy-schemas

Path parameters

zone_idstring required

The zone identifier

Query parameters

afterstring

An opaque cursor used for paginating through a list of results

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

beforestring

An opaque cursor used for paginating through a list of results

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

limitinteger

Maximum number of items to return per page.

expandPdpExpandField[]

Deprecated. Use expand[] instead.

Opt-in to additional response fields. Still honored for backward compatibility; supplying both expand and expand[] with disagreeing values returns 400 Bad Request.

expand[]PdpExpandField[]

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

sort'created_at'

Field to sort by.

order'asc' | 'desc'

Sort direction. Default is desc (newest first).

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.

is_defaultboolean

Deprecated. Use filter[default] instead.

Filter schemas by default status. When true, returns only the zone's default schema. When false, returns only non-default schemas. Omit to return all schemas.

Still honored for backward compatibility. Supplying both is_default and filter[default] with conflicting values returns 400 Bad Request.

filter[default]boolean

Filter schemas by default status. When true, returns only the zone's default schema. When false, returns only non-default schemas. Omit to return all schemas.

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

A paginated list of policy schemas