Switch a rule on or off
PUT
/v1/rules/{id}/enabled
const url = 'http://localhost:8080/v1/rules/example/enabled';const options = { method: 'PUT', headers: {'Content-Type': 'application/json'}, body: '{"enabled":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url http://localhost:8080/v1/rules/example/enabled \ --header 'Content-Type: application/json' \ --data '{ "enabled": true }'Bank policy: a disabled rule is skipped by every subsequent reconciliation run, and the skip is recorded on the run and in the evidence chain; never silent. Works for shipped and custom rules. Administrators only. 404 for an unknown rule id.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
enabled
boolean
Examplegenerated
{ "enabled": true}Responses
Section titled “Responses”OK
Media typeapplication/json
object
rulesetVersion
required
string
rules
required
Array<object>
One row of the Rules page: a shipped or bank-authored rule with its policy state.
object
id
required
string
version
required
string
severity
required
string
title
required
string
fields
required
Array<string>
enabled
required
boolean
isCustom
required
boolean
spec
required
One of:
null
One bank-authored rule, declaratively: a canonical field and one of three comparisons. Evaluated by CustomRule; the same deterministic engine path as the shipped catalog, so custom rules are configuration, never code, and runtime behaviour stays explainable line by line.
object
id
required
string
title
required
string
severity
required
string
field
required
string
comparison
required
string
kind
null | string
docType
null | string
Examplegenerated
{ "rulesetVersion": "example", "rules": [ { "id": "example", "version": "example", "severity": "example", "title": "example", "fields": [ "example" ], "enabled": true, "isCustom": true, "spec": { "id": "example", "title": "example", "severity": "example", "field": "example", "comparison": "example", "kind": "example", "docType": "example" } } ]}