Rule - Get | Flagright | Documentation

1 curl https://sandbox.api.flagright.com/management/rules/ruleId \ 2 -H "x-api-key: <apiKey>"

1 { 2 "id": "id", 3 "type": "TRANSACTION", 4 "name": "name", 5 "types": [ 6 "types" 7 ], 8 "description": "description", 9 "defaultParameters": { 10 "key": "value" 11 }, 12 "defaultAction": "ALLOW", 13 "labels": [ 14 "UNEXPECTED_BEHAVIOR" 15 ], 16 "defaultCasePriority": "P1", 17 "defaultNature": "AML", 18 "checksFor": [ 19 "checksFor" 20 ], 21 "typologies": [ 22 "typologies" 23 ], 24 "sampleUseCases": "sampleUseCases", 25 "parametersSchema": { 26 "key": "value" 27 }, 28 "defaultRiskLevelParameters": { 29 "VERY_HIGH": { 30 "key": "value" 31 }, 32 "HIGH": { 33 "key": "value" 34 }, 35 "MEDIUM": { 36 "key": "value" 37 }, 38 "LOW": { 39 "key": "value" 40 }, 41 "VERY_LOW": { 42 "key": "value" 43 } 44 }, 45 "defaultRiskLevelActions": { 46 "VERY_HIGH": "ALLOW", 47 "HIGH": "ALLOW", 48 "MEDIUM": "ALLOW", 49 "LOW": "ALLOW", 50 "VERY_LOW": "ALLOW" 51 } 52 }

Retrieve a Rule

GET /rules/{ruleId} endpoint returns a rule template supported by flagright.

Path parameters

ruleIdstringRequired

Response

idstring

typeenum

Allowed values:

namestring

typeslist of strings

descriptionstring

defaultParametersmap from strings to any

defaultActionenum

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:

labelslist of enums

defaultCasePriorityenum

Allowed values:

defaultNatureenum

Allowed values:

checksForlist of strings

typologieslist of strings

sampleUseCasesstring

parametersSchemamap from strings to anyOptional

defaultRiskLevelParametersobjectOptional

defaultRiskLevelActionsobjectOptional

Rule - Get

Retrieve a Rule

Path parameters

Headers

Response

Errors