Rule Instance - Create | Flagright

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.

### 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.

Authentication

x-api-keystring

API keys are used to authenticate the requests.

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

riskLevelActionsobjectOptional

triggersOnHitobjectOptional

riskLevelsTriggersOnHitobjectOptional

statusenumOptional

casePriorityenumOptional

Response

idstring

typeenum

ruleIdstring

checksForlist of strings

runCountdouble

hitCountinteger

createdAtdouble

updatedAtdouble

alertCreationOnHitboolean

filtersobject

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

parametersobject

ruleNameAliasstring

riskLevelParametersobject

actionenum

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

riskLevelActionsobject

triggersOnHitobject

riskLevelsTriggersOnHitobject

statusenum

casePriorityenum

Errors

400

Bad Request Error

Create Rule Instance

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.

$	curl -X POST https://sandbox.api.flagright.com/management/rule-instances \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "string",
3	"type": "TRANSACTION",
4	"ruleId": "string",
5	"checksFor": [
6	"string"
7	],
8	"runCount": 0,
9	"hitCount": 0,
10	"createdAt": 0,
11	"updatedAt": 0,
12	"parameters": {},
13	"action": "FLAG",
14	"status": "ACTIVE",
15	"casePriority": "P1"
16	}