Update a policy set

PATCH/zones/{zone_id}/policy-sets/{policy_set_id}

Update metadata or manage binding. Set active=true to bind, active=false to unbind.

Path ParametersExpand Collapse

zone_id: string

policy_set_id: string

Header ParametersExpand Collapse

"If-Match": optional string

"X-API-Version": optional string

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

formatuuid

Body ParametersJSONExpand Collapse

name: optional string

ReturnsExpand Collapse

PolicySetWithBinding = PolicySet { id, created_at, created_by, 9 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

Update a policy set

curl https://api.keycard.ai/zones/$ZONE_ID/policy-sets/$POLICY_SET_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{}'

{
  "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"
}

Returns Examples

{
  "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"
}