Rule Instance - List | Flagright

1 curl https://sandbox.api.flagright.com/management/rule-instances \ 2 -H "x-api-key: <apiKey>"

1 [ 2 { 3 "id": "id", 4 "type": "TRANSACTION", 5 "ruleId": "ruleId", 6 "checksFor": [ 7 "checksFor" 8 ], 9 "runCount": 1.1, 10 "hitCount": 1, 11 "createdAt": 1.1, 12 "updatedAt": 1.1, 13 "alertCreationOnHit": true, 14 "filters": { 15 "key": "value" 16 }, 17 "parameters": { 18 "key": "value" 19 }, 20 "ruleNameAlias": "ruleNameAlias", 21 "riskLevelParameters": { 22 "VERY_HIGH": { 23 "key": "value" 24 }, 25 "HIGH": { 26 "key": "value" 27 }, 28 "MEDIUM": { 29 "key": "value" 30 }, 31 "LOW": { 32 "key": "value" 33 }, 34 "VERY_LOW": { 35 "key": "value" 36 } 37 }, 38 "action": "ALLOW", 39 "riskLevelActions": { 40 "VERY_HIGH": "ALLOW", 41 "HIGH": "ALLOW", 42 "MEDIUM": "ALLOW", 43 "LOW": "ALLOW", 44 "VERY_LOW": "ALLOW" 45 }, 46 "triggersOnHit": { 47 "usersToCheck": "ALL", 48 "userStateDetails": { 49 "reason": "reason", 50 "state": "UNACCEPTABLE" 51 }, 52 "kycStatusDetails": { 53 "reason": "reason" 54 }, 55 "pepStatus": { 56 "isPepHit": true 57 } 58 }, 59 "riskLevelsTriggersOnHit": { 60 "VERY_HIGH": {}, 61 "HIGH": {}, 62 "MEDIUM": {}, 63 "LOW": {}, 64 "VERY_LOW": {} 65 }, 66 "status": "ACTIVE", 67 "casePriority": "P1" 68 } 69 ]

Retrieve Rule Instances

GET /rule-instances endpoint returns a list of all rule instances created by your account on flagright.

Response

idstring

typeenum

Allowed values:

ruleIdstring

checksForlist of strings

runCountdoubleOptional

hitCountintegerOptional

createdAtdoubleOptional

updatedAtdoubleOptional

alertCreationOnHitbooleanOptional

filtersmap from strings to anyOptional

Rule filters. A key-value json object corresponding to the json schema returned by /rule-filters-schema endpoint.

parametersmap from strings to anyOptional

ruleNameAliasstringOptional

riskLevelParametersobjectOptional

actionenumOptional

Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst

Allowed values:

riskLevelActionsobjectOptional

triggersOnHitobjectOptional

riskLevelsTriggersOnHitobjectOptional

statusenumOptional

Allowed values:

casePriorityenumOptional

Allowed values:

Retrieve Rule Instances

Headers

Response