Rule Instance - Update

Update Rule Instance

Created rule instances can be idempotently updated with the POST /rule-instances/{ruleInstanceId}.

post/rule-instances/{ruleInstanceId}

Request

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

Path parameters

ruleInstanceIdstring required

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.