Rule - Get | Flagright | Documentation

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

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

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

defaultParametersobject

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

parametersSchemaobject or null

defaultRiskLevelParametersobject or null

defaultRiskLevelActionsobject or null

Rule - Get

Retrieve a Rule

Path parameters

Headers

Response

Errors