List policy sets in a zone

GET/zones/{zone_id}/policy-sets

Path ParametersExpand Collapse

zone_id: string

Query ParametersExpand Collapse

after: optional string

Return items after this cursor (forward pagination). Use after_cursor from a previous response. Mutually exclusive with before.

before: optional string

Return items before this cursor (backward pagination). Use before_cursor from a previous response. Mutually exclusive with after.

expand: optional array of "total_count"

Opt-in to additional response fields

limit: optional number

Maximum number of items to return

maximum100

minimum1

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 PolicySetWithBinding { active, active_version, active_version_id, 2 more }

active: optional boolean

Whether this policy set is currently bound to a scope

active_version: optional number

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

active_version_id: optional string

Public ID of the currently active (bound) version

mode: optional "active" or "shadow"

Accepts one of the following:

"active"

"shadow"

scope_target_id: optional string

pagination: object { after_cursor, before_cursor, total_count }

after_cursor: string

Cursor of the last item on the current page. Pass to after for the next page. Null when there is no next page.

before_cursor: string

Cursor of the first item on the current page. Pass to before for the previous page. Null when there is no previous page.

total_count: optional number

Total number of items matching the current filters. Only included when expand=total_count is requested.

List policy sets in a zone

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

{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "name": "name",
      "owner_type": "platform",
      "scope_type": "zone",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "zone_id": "zone_id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "latest_version": 0,
      "latest_version_id": "latest_version_id",
      "updated_by": "updated_by",
      "active": true,
      "active_version": 0,
      "active_version_id": "active_version_id",
      "mode": "active",
      "scope_target_id": "scope_target_id"
    }
  ],
  "pagination": {
    "after_cursor": "after_cursor",
    "before_cursor": "before_cursor",
    "total_count": 0
  }
}

Returns Examples

{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "name": "name",
      "owner_type": "platform",
      "scope_type": "zone",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "zone_id": "zone_id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "latest_version": 0,
      "latest_version_id": "latest_version_id",
      "updated_by": "updated_by",
      "active": true,
      "active_version": 0,
      "active_version_id": "active_version_id",
      "mode": "active",
      "scope_target_id": "scope_target_id"
    }
  ],
  "pagination": {
    "after_cursor": "after_cursor",
    "before_cursor": "before_cursor",
    "total_count": 0
  }
}