API Reference

Rule Instance - Update

Update Rule Instance

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

Path parameters

ruleInstanceIdstringRequired

Headers

x-api-keystringRequired

Request

This endpoint expects an object.
ruleIdstringOptional
alertCreationOnHitbooleanOptional
filtersobjectOptional

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

parametersobjectOptional
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:

Response

OK
idstring
typeenum
Allowed values:
ruleIdstring
checksForlist of strings
runCountdouble or null
hitCountinteger or null
createdAtdouble or null
updatedAtdouble or null
alertCreationOnHitboolean or null
filtersobject or null

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

parametersobject or null
ruleNameAliasstring or null
riskLevelParametersobject or null
actionenum or null
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:
riskLevelActionsobject or null
triggersOnHitobject or null
riskLevelsTriggersOnHitobject or null
statusenum or null
Allowed values:
casePriorityenum or null
Allowed values:

Errors