Rule - Get | Flagright | Documentation

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

{
  "id": "string",
  "type": "TRANSACTION",
  "name": "string",
  "types": [
    "string"
  ],
  "description": "string",
  "defaultParameters": {},
  "defaultAction": "ALLOW",
  "labels": [
    "UNEXPECTED_BEHAVIOR"
  ],
  "defaultCasePriority": "P1",
  "defaultNature": "AML",
  "checksFor": [
    "string"
  ],
  "typologies": [
    "string"
  ],
  "sampleUseCases": "string",
  "parametersSchema": {},
  "defaultRiskLevelParameters": {
    "VERY_HIGH": {},
    "HIGH": {},
    "MEDIUM": {},
    "LOW": {},
    "VERY_LOW": {}
  },
  "defaultRiskLevelActions": {
    "VERY_HIGH": "ALLOW",
    "HIGH": "ALLOW",
    "MEDIUM": "ALLOW",
    "LOW": "ALLOW",
    "VERY_LOW": "ALLOW"
  }
}

Retrieve a Rule

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

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Path parameters

ruleIdstringRequired

Response

idstring

typeenum

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

defaultRiskLevelParametersobject

defaultRiskLevelActionsobject

Errors

404

Not Found Error