System Policies

Toggle policy enabled status

Toggles the enabled status of a policy.

Restrictions:

  • System-tier policies cannot be disabled via this endpoint (use overrides)

v11: on a deployment whose database connection cannot write static_policies (migrations/core/172), this route answers 409 LEGACY_POLICY_WRITE_FROZEN before the request body is read and before the policy is looked up, whatever it contains, naming the typed authoring route. An owner-role deployment still toggles.

patch/api/v1/system-policies/{id}

Request

Path parameters

idstring uuid required

Static policy UUID

Headers

X-User-IDstring

User ID for audit trail

Request body

enabledboolean required

New enabled status

Response

Policy updated successfully

idstring uuid required

Unique policy UUID

policy_idstring required

Human-readable policy identifier (e.g., sys_sqli_union_select)

namestring required

Display name of the policy

descriptionstring

Detailed policy description

category'security-sqli' | 'security-admin' | 'pii-global' | 'pii-us' | 'pii-eu' | 'pii-india' | 'custom' required

Policy category (v2.0.0 semantic naming)

tier'system' | 'organization' | 'tenant'

Policy tier in the hierarchy

patternstring required

Regex pattern for detection

severity'critical' | 'high' | 'medium' | 'low' required

Policy severity level

action'block' | 'require_approval' | 'redact' | 'warn' | 'log' required

Action to take when pattern matches. require_approval triggers HITL queue for human oversight.

enabledboolean required

Whether policy is active

priorityinteger

Evaluation priority (higher = evaluated first)

versioninteger

Policy version number

has_overrideboolean

Whether this policy has an override (Enterprise only)

tenant_idstring required

Tenant ID (for tenant-tier policies)

created_atstring date-time required

When policy was created

updated_atstring date-time required

When policy was last modified

Example response

{
  "policy_id": "sys_sqli_union_select",
  "name": "UNION SELECT Detection",
  "description": "Detects SQL injection attempts using UNION SELECT",
  "tier": "system",
  "pattern": "(?i)\\bUNION\\s+(ALL\\s+)?SELECT\\b",
  "priority": 1000,
  "version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.