Rule Instance - Create

Create Rule Instance

POST /rule-instances endpoint is used to create a new rule instance. A rule instance can be thought of as a live entity, that runs checks for for transactions. Rule instances use Rule templates as the blueprint.

Every rule instance has an associated ruleId of the rule from which it is derived. The details of the rule and the required parameters is found by GET /rules endpoint.

Once a rule instance is created, flagright generates an ID for the rule instance and also stores related metadata like:

  • id - unique identifier for the rule instance
  • runCount - how many times the rule instance was run
  • hitCount - how many times a rule was hit
  • createdAt & updatedAt - timestamps

They are generated and maintained by the flagright system and are not updatable by the API.

post/rule-instances

Request

  • Base URL: https://sandbox.api.flagright.com/management
  • URL: https://sandbox.api.flagright.com/management/rule-instances
  • Auth: API key in header x-api-key

Request body

ruleIdstring
alertCreationOnHitboolean
filtersRuleInstanceUpdatableFilters

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

parametersRuleInstanceUpdatableParameters
ruleNameAliasstring
action'ALLOW' | 'FLAG' | 'BLOCK' | 'SUSPEND'

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

status'ACTIVE' | 'INACTIVE'
casePriority'P1' | 'P2' | 'P3' | 'P4'

Response

OK

idstring required
type'TRANSACTION' | 'USER' | 'USER_ONGOING_SCREENING' | 'TRANSACTION_SCREENING' | 'CONSUMER_USER_SCREENING' | 'BUSINESS_USER_SCREENING' | 'CRM_USER' | 'CRM_TICKET' required
ruleIdstring required
runCountnumber double
hitCountinteger
createdAtnumber double
updatedAtnumber double
checksForstring[] required
alertCreationOnHitboolean
filtersRuleInstanceFilters

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

parametersRuleInstanceParameters
ruleNameAliasstring
action'ALLOW' | 'FLAG' | 'BLOCK' | 'SUSPEND'

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

status'ACTIVE' | 'INACTIVE' | 'DEPLOYING'
casePriority'P1' | 'P2' | 'P3' | 'P4'

Changes

No recorded changes to this operation across all 1 revision of this API.