List rules

GET {{baseUrl}}/api/v2/security_monitoring/rules?page[size]=10&page[number]=0

List rules.

Request Params

KeyDatatypeRequiredDescription
page[size]numberSize for a given page. The maximum allowed value is 100.
page[number]numberSpecific page number to return.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"data":[{"cases":[{"condition":"\u003cstring\u003e","name":"\u003cstring\u003e","notifications":["\u003cstring\u003e","\u003cstring\u003e"],"status":"high"},{"condition":"\u003cstring\u003e","name":"\u003cstring\u003e","notifications":["\u003cstring\u003e","\u003cstring\u003e"],"status":"medium"}],"complianceSignalOptions":{"defaultActivationStatus":"\u003cboolean\u003e","defaultGroupByFields":["\u003cstring\u003e","\u003cstring\u003e"],"userActivationStatus":"\u003cboolean\u003e","userGroupByFields":["\u003cstring\u003e","\u003cstring\u003e"]},"createdAt":"\u003clong\u003e","creationAuthorId":"\u003clong\u003e","deprecationDate":"\u003clong\u003e","filters":[{"action":"require","query":"\u003cstring\u003e"},{"action":"require","query":"\u003cstring\u003e"}],"hasExtendedTitle":"\u003cboolean\u003e","id":"\u003cstring\u003e","isDefault":"\u003cboolean\u003e","isDeleted":"\u003cboolean\u003e","isEnabled":"\u003cboolean\u003e","message":"\u003cstring\u003e","name":"\u003cstring\u003e","options":{"complianceRuleOptions":{"complexRule":"\u003cboolean\u003e","regoRule":{"policy":"\u003cstring\u003e","resourceTypes":["\u003cstring\u003e","\u003cstring\u003e"]},"resourceType":"\u003cstring\u003e"},"decreaseCriticalityBasedOnEnv":"\u003cboolean\u003e","detectionMethod":"anomaly_detection","evaluationWindow":300,"hardcodedEvaluatorType":"log4shell","impossibleTravelOptions":{"baselineUserLocations":"\u003cboolean\u003e"},"keepAlive":10800,"maxSignalDuration":60,"newValueOptions":{"forgetAfter":28,"learningDuration":0,"learningMethod":"duration","learningThreshold":0},"thirdPartyRuleOptions":{"defaultNotifications":["\u003cstring\u003e","\u003cstring\u003e"],"defaultStatus":"low","rootQueries":[{"groupByFields":["\u003cstring\u003e","\u003cstring\u003e"],"query":"\u003cstring\u003e"},{"groupByFields":["\u003cstring\u003e","\u003cstring\u003e"],"query":"\u003cstring\u003e"}],"signalTitleTemplate":"\u003cstring\u003e"}},"queries":[{"aggregation":"none","distinctFields":["\u003cstring\u003e","\u003cstring\u003e"],"groupByFields":["\u003cstring\u003e","\u003cstring\u003e"],"hasOptionalGroupByFields":"\u003cboolean\u003e","metric":"\u003cstring\u003e","metrics":["\u003cstring\u003e","\u003cstring\u003e"],"name":"\u003cstring\u003e","query":"\u003cstring\u003e"},{"aggregation":"cardinality","distinctFields":["\u003cstring\u003e","\u003cstring\u003e"],"groupByFields":["\u003cstring\u003e","\u003cstring\u003e"],"hasOptionalGroupByFields":"\u003cboolean\u003e","metric":"\u003cstring\u003e","metrics":["\u003cstring\u003e","\u003cstring\u003e"],"name":"\u003cstring\u003e","query":"\u003cstring\u003e"}],"tags":["\u003cstring\u003e","\u003cstring\u003e"],"thirdPartyCases":[{"name":"\u003cstring\u003e","notifications":["\u003cstring\u003e","\u003cstring\u003e"],"query":"\u003cstring\u003e","status":"high"},{"name":"\u003cstring\u003e","notifications":["\u003cstring\u003e","\u003cstring\u003e"],"query":"\u003cstring\u003e","status":"high"}],"type":"workload_security","updateAuthorId":"\u003clong\u003e","version":"\u003clong\u003e"},{"cases":[{"condition":"\u003cstring\u003e","name":"\u003cstring\u003e","notifications":["\u003cstring\u003e","\u003cstring\u003e"],"status":"critical"},{"condition":"\u003cstring\u003e","name":"\u003cstring\u003e","notifications":["\u003cstring\u003e","\u003cstring\u003e"],"status":"high"}],"complianceSignalOptions":{"defaultActivationStatus":"\u003cboolean\u003e","defaultGroupByFields":["\u003cstring\u003e","\u003cstring\u003e"],"userActivationStatus":"\u003cboolean\u003e","userGroupByFields":["\u003cstring\u003e","\u003cstring\u003e"]},"createdAt":"\u003clong\u003e","creationAuthorId":"\u003clong\u003e","deprecationDate":"\u003clong\u003e","filters":[{"action":"require","query":"\u003cstring\u003e"},{"action":"require","query":"\u003cstring\u003e"}],"hasExtendedTitle":"\u003cboolean\u003e","id":"\u003cstring\u003e","isDefault":"\u003cboolean\u003e","isDeleted":"\u003cboolean\u003e","isEnabled":"\u003cboolean\u003e","message":"\u003cstring\u003e","name":"\u003cstring\u003e","options":{"complianceRuleOptions":{"complexRule":"\u003cboolean\u003e","regoRule":{"policy":"\u003cstring\u003e","resourceTypes":["\u003cstring\u003e","\u003cstring\u003e"]},"resourceType":"\u003cstring\u003e"},"decreaseCriticalityBasedOnEnv":"\u003cboolean\u003e","detectionMethod":"hardcoded","evaluationWindow":900,"hardcodedEvaluatorType":"log4shell","impossibleTravelOptions":{"baselineUserLocations":"\u003cboolean\u003e"},"keepAlive":7200,"maxSignalDuration":43200,"newValueOptions":{"forgetAfter":21,"learningDuration":0,"learningMethod":"duration","learningThreshold":0},"thirdPartyRuleOptions":{"defaultNotifications":["\u003cstring\u003e","\u003cstring\u003e"],"defaultStatus":"low","rootQueries":[{"groupByFields":["\u003cstring\u003e","\u003cstring\u003e"],"query":"\u003cstring\u003e"},{"groupByFields":["\u003cstring\u003e","\u003cstring\u003e"],"query":"\u003cstring\u003e"}],"signalTitleTemplate":"\u003cstring\u003e"}},"queries":[{"aggregation":"count","distinctFields":["\u003cstring\u003e","\u003cstring\u003e"],"groupByFields":["\u003cstring\u003e","\u003cstring\u003e"],"hasOptionalGroupByFields":"\u003cboolean\u003e","metric":"\u003cstring\u003e","metrics":["\u003cstring\u003e","\u003cstring\u003e"],"name":"\u003cstring\u003e","query":"\u003cstring\u003e"},{"aggregation":"count","distinctFields":["\u003cstring\u003e","\u003cstring\u003e"],"groupByFields":["\u003cstring\u003e","\u003cstring\u003e"],"hasOptionalGroupByFields":"\u003cboolean\u003e","metric":"\u003cstring\u003e","metrics":["\u003cstring\u003e","\u003cstring\u003e"],"name":"\u003cstring\u003e","query":"\u003cstring\u003e"}],"tags":["\u003cstring\u003e","\u003cstring\u003e"],"thirdPartyCases":[{"name":"\u003cstring\u003e","notifications":["\u003cstring\u003e","\u003cstring\u003e"],"query":"\u003cstring\u003e","status":"medium"},{"name":"\u003cstring\u003e","notifications":["\u003cstring\u003e","\u003cstring\u003e"],"query":"\u003cstring\u003e","status":"high"}],"type":"workload_security","updateAuthorId":"\u003clong\u003e","version":"\u003clong\u003e"}],"meta":{"page":{"total_count":"\u003clong\u003e","total_filtered_count":"\u003clong\u003e"}}}