You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/python/client/index.html
+4-3Lines changed: 4 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -169,9 +169,10 @@
169
169
</span></code></pre></div><hr><p>Get a detection event rule by id.</p><p><strong>Allowed Roles:</strong></p><ul><li>At least <code>PROJECT_VIEW</code> for that project</li><li><code>COMPANY_OWNER</code></li><li><code>COMPANY_ADMIN</code></li></ul><p><strong>Args</strong></p><ul><li><strong>rule_id</strong> : id of the rule</li></ul><p><strong>Returns</strong></p><ul><li><strong>rule</strong> : <code>DetectionEventRule</code></li></ul><p><strong>Raises</strong></p><p><code>SDKClientException</code></p><h3id=create_detection_event_rule>.create_detection_event_rule<aclass=headerlinkhref=#create_detection_event_ruletitle="Permanent link">¶</a></h3><divclass="language-python highlight"><pre><span></span><code><spanid=__span-49-1><aid=__codelineno-49-1name=__codelineno-49-1href=#__codelineno-49-1></a><spanclass=o>.</span><spanclass=n>create_detection_event_rule</span><spanclass=p>(</span>
</span></code></pre></div><hr><p>Create a detection event rule.</p><p><strong>Allowed Roles:</strong></p><ul><li>At least <code>PROJECT_EDIT</code> for that project</li><li><code>COMPANY_OWNER</code></li><li><code>COMPANY_ADMIN</code></li></ul><p><strong>Args</strong></p><ul><li><strong>name</strong> : the name of the rule</li><li><strong>task_id</strong> : the id of the task to which the rule belongs. The rule will only respond to detection events generated by this task.</li><li><strong>model_name</strong> : the name of the model, only required if monitoring_target is set to MODEL.</li><li><strong>detection_event_type</strong> : the type of detection event that this rule should respond to.</li><li><strong>monitoring_target</strong> : the type of monitoring target that this rule should respond to.</li><li><strong>severity</strong> : the level of severity of the detection event that this rule should respond to.</li><li><strong>actions</strong> : the list of actions to execute, in order, when the conditions of the rule are matched.</li></ul><p><strong>Returns</strong></p><ul><li><strong>rule_id</strong> : <code>str</code></li></ul><p><strong>Raises</strong></p><p><code>CreateDetectionEventRuleException</code></p><h3id=update_detection_event_rule>.update_detection_event_rule<aclass=headerlinkhref=#update_detection_event_ruletitle="Permanent link">¶</a></h3><divclass="language-python highlight"><pre><span></span><code><spanid=__span-50-1><aid=__codelineno-50-1name=__codelineno-50-1href=#__codelineno-50-1></a><spanclass=o>.</span><spanclass=n>update_detection_event_rule</span><spanclass=p>(</span>
</span></code></pre></div><hr><p>Create a detection event rule.</p><p><strong>Allowed Roles:</strong></p><ul><li>At least <code>PROJECT_EDIT</code> for that project</li><li><code>COMPANY_OWNER</code></li><li><code>COMPANY_ADMIN</code></li></ul><p><strong>Args</strong></p><ul><li><strong>name</strong> : the name of the rule</li><li><strong>task_id</strong> : the id of the task to which the rule belongs. The rule will only respond to detection events generated by this task.</li><li><strong>model_name</strong> : the name of the model, only required if monitoring_target is set to MODEL.</li><li><strong>detection_event_type</strong> : the type of detection event that this rule should respond to.</li><li><strong>monitoring_target</strong> : the type of monitoring target that this rule should respond to.</li><li><strong>monitoring_metric</strong> : additional metric extracted from monitoring target that is monitored</li><li><strong>severity</strong> : the level of severity of the detection event that this rule should respond to.</li><li><strong>actions</strong> : the list of actions to execute, in order, when the conditions of the rule are matched.</li></ul><p><strong>Returns</strong></p><ul><li><strong>rule_id</strong> : <code>str</code></li></ul><p><strong>Raises</strong></p><p><code>CreateDetectionEventRuleException</code></p><h3id=update_detection_event_rule>.update_detection_event_rule<aclass=headerlinkhref=#update_detection_event_ruletitle="Permanent link">¶</a></h3><divclass="language-python highlight"><pre><span></span><code><spanid=__span-50-1><aid=__codelineno-50-1name=__codelineno-50-1href=#__codelineno-50-1></a><spanclass=o>.</span><spanclass=n>update_detection_event_rule</span><spanclass=p>(</span>
0 commit comments