List policy schemas

GET/zones/{zone_id}/policy-schemas

List policy schemas

Path ParametersExpand Collapse

zone_id: string

Query ParametersExpand Collapse

after: optional string

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

minLength1

maxLength255

before: optional string

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

minLength1

maxLength255

expand: optional array of "total_count"

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

"filter[default]": optional 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.

format: optional "cedar" or "json"

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

Accepts one of the following:

"cedar"

"json"

is_default: optional boolean

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.

limit: optional number

Maximum number of items to return per page.

minimum1

maximum100

order: optional "asc" or "desc"

Sort direction. Default is desc (newest first).

Accepts one of the following:

"asc"

"desc"

sort: optional "created_at"

Field to sort by.

Header ParametersExpand Collapse

"X-API-Version": optional string

"X-Client-Request-ID": optional string

formatuuid

ReturnsExpand Collapse

items: array of SchemaVersionWithZoneInfo { is_default }

is_default: boolean

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.

pagination: object { after_cursor, before_cursor, total_count }

Cursor-based pagination metadata returned alongside a list of results

after_cursor: string

An opaque cursor used for paginating through a list of results

minLength1

maxLength255

before_cursor: string

An opaque cursor used for paginating through a list of results

minLength1

maxLength255

total_count: optional number

Total number of items across all pages. Only present when the request includes ?expand[]=total_count.

List policy schemas

curl https://api.keycard.ai/zones/$ZONE_ID/policy-schemas

{
  "items": [
    {
      "created_at": "2019-12-27T18:11:19.117Z",
      "status": "active",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "version": "version",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "cedar_schema": "cedar_schema",
      "cedar_schema_json": {},
      "deprecated_at": "2019-12-27T18:11:19.117Z",
      "is_default": true
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}

Returns Examples

{
  "items": [
    {
      "created_at": "2019-12-27T18:11:19.117Z",
      "status": "active",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "version": "version",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "cedar_schema": "cedar_schema",
      "cedar_schema_json": {},
      "deprecated_at": "2019-12-27T18:11:19.117Z",
      "is_default": true
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}