API Reference

Rule - Get

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

OK
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
labelslist of enums
defaultCasePriorityenum
defaultNatureenum
checksForlist of strings
typologieslist of strings
sampleUseCasesstring
parametersSchemaobjectOptional
defaultRiskLevelParametersobjectOptional
defaultRiskLevelActionsobjectOptional

Errors

404
Not Found Error