Delete a bank-authored rule

DELETE

/v1/rules/custom/{id}

const url = 'http://localhost:8080/v1/rules/custom/example';
const options = {method: 'DELETE'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url http://localhost:8080/v1/rules/custom/example

Removes the custom rule (and any disable entry for it). Shipped rules cannot be deleted; switch them off instead. Administrators only. 404 for an unknown custom rule.

Parameters

Path Parameters

required

string

Responses

200

application/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

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
object

null

Example^generated

{
  "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"
      }
    }
  ]
}

Delete a bank-authored rule

Parameters

Path Parameters

Responses

200

Examplegenerated

Example^generated