Test Rule

post/v1/rules/{rule_id}/test

Dry-run a rule against a real flow. Useful for the rule editor: 'show me whether this would have matched flow X'.

Authentication

Send your tenant secret key as a Bearer token. Keep secret keys on your server; never ship them in browser or mobile code.

Parameters

rule_id

path · required

No additional parameter description.

Request body

JSON · required

flow_id

stringrequired

No additional field description.

Example request

cURL

curl --request POST \
  --url 'https://api.fideralabs.com/v1/rules/{rule_id}/test' \
  --header 'Authorization: Bearer $FIDERA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "flow_id": "00000000-0000-0000-0000-000000000000"
}'

Responses

200Successful Response

context

objectrequired

No additional field description.

decision_if_matched

string | nullrequired

No additional field description.

matched

booleanrequired

No additional field description.

reason_codes_if_matched

string[]required

No additional field description.

application/json

{
  "context": {},
  "decision_if_matched": "string",
  "matched": true,
  "reason_codes_if_matched": [
    "string"
  ]
}

422Validation Error

detail

ValidationError[]

No additional field description.

Operation ID

test_rule_v1_rules__rule_id__test_post