Rule Instance - List

GET

Retrieve Rule Instances

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

Response

This endpoint returns a list of objects
id
string
type
enum
Allowed values: TRANSACTIONUSERUSER_ONGOING_SCREENING
ruleId
string
checksFor
list of strings
runCount
doubleOptional
hitCount
integerOptional
createdAt
doubleOptional
updatedAt
doubleOptional
filters
map from strings to anyOptional
Rule filters. A key-value json object corresponding to the json schema returned by /rule-filters-schema endpoint.
parameters
map from strings to anyOptional
ruleNameAlias
stringOptional
riskLevelParameters
objectOptional
action
enumOptional
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: ALLOWFLAGBLOCKSUSPEND
riskLevelActions
objectOptional
triggersOnHit
objectOptional
riskLevelsTriggersOnHit
objectOptional
status
enumOptional
Allowed values: ACTIVEINACTIVE
casePriority
enumOptional
Allowed values: P1P2P3P4
Built with