Skip to main content
PUT
/
v1
/
policies
/
{policy_id}
Update a policy's identity fields
curl --request PUT \
  --url https://api-sandbox.featherhq.com/v1/policies/{policy_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "enabled": true,
  "metadata": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "enabled": true,
  "scope": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "active_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active_revision": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "check_type": "<string>",
    "enforcement_point": "<string>",
    "action": "<string>",
    "mode": "<string>",
    "on_error": "<string>",
    "strictness": "<string>",
    "priority": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "check_config": {},
    "action_config": {},
    "tool_target": "<string>",
    "timeout_ms": 123,
    "created_by": "<string>"
  },
  "metadata": {}
}

Authorizations

x-api-key
string
header
required

Path Parameters

policy_id
string<uuid>
required

Body

application/json

Patch a policy's identity fields (NOT its config — that's a new revision).

scope is intentionally NOT here: it is an identity-level fact set ONCE at create (spec §2 — moved off the revision to Policy, server_default='attachable', with no update path). Allowing it on PUT would advertise a mutable field the service silently drops; organization-vs-attachable is decided at authoring time, so it stays immutable post-create.

name
string | null
Required string length: 1 - 255
description
string | null
enabled
boolean | null
metadata
Metadata · object

Response

Successful Response

id
string<uuid>
required
organization_id
string<uuid>
required
name
string
required
enabled
boolean
required
scope
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
active_revision_id
string<uuid> | null
active_revision
PolicyRevisionResponse · object
metadata
Metadata · object