Skip to main content

Admin endpoints — configuration

Manages the business-rule (BRE) definitions used for rule-driven decisions. The platform holds no rule storage of its own — these routes are a thin proxy onto the rules engine, which owns the rule records. Auth: Entra ID JWT bearer with the ADMIN role. The formal schema is on the API Reference.

MethodPathCodeDoes
GET/v1/admin/clients/{slug}/bre-rules200List the business rules
POST/v1/admin/clients/{slug}/bre-rules201Create a rule
GET/v1/admin/clients/{slug}/bre-rules/{ruleKey}200Read one rule
PUT/v1/admin/clients/{slug}/bre-rules/{ruleKey}200Update one rule
DELETE/v1/admin/clients/{slug}/bre-rules/{ruleKey}200Deactivate one rule

Notes for operators

  • DELETE deactivates, it does not remove. It sets the rule's status to INACTIVE; no record is hard-deleted. (Note the 200 response, not 204.)
  • Rule body carries a ruleKey (create only), a name, an optional description, the JDM decision graph (jdm with nodes/edges), and an optional status. The exact schema is on the API Reference.
  • ruleKey is 1–100 characters.