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

Response

OK

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:

Errors