Sign in
Agent Environment
policy-rules

Update Rule

Update a rule.

patch/v1/rules/{rule_id}

Path parameters

rule_idstring uuid required

Request body

rule_idstring nullable
rule_type'permission' | 'prohibition' | 'obligation' | 'recommendation'

Type of policy rule (ODRL-inspired).

actionstring nullable
targetstring nullable
assigneestring nullable
conditionsobject[] nullable
constraint_logicstring nullable
natural_languagestring nullable
category'privacy' | 'ethics' | 'security' | 'compliance' | 'operational' | 'brand' | 'custom'

Category of policy document.

status'draft' | 'approved' | 'rejected' | 'modified'

Review status of a policy rule.

tagsstring[] nullable

Response

Successful Response

idstring uuid required
policy_idstring uuid required
rule_idstring required
rule_type'permission' | 'prohibition' | 'obligation' | 'recommendation' required

Type of policy rule (ODRL-inspired).

actionstring required
targetstring nullable
assigneestring nullable
constraint_logicstring
natural_languagestring required
category'privacy' | 'ethics' | 'security' | 'compliance' | 'operational' | 'brand' | 'custom'

Category of policy document.

tagsstring[] nullable
status'draft' | 'approved' | 'rejected' | 'modified'

Review status of a policy rule.

reviewed_bystring uuid nullable
reviewed_atinteger nullable
review_notesstring nullable
created_atinteger required
updated_atinteger required

Changes

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