Add Security Monitoring rule test endpoint (#1983)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> 854ffa2

Author: api-clients-generation-pipeline[bot]

_sources/datadog_api_client.v2.model.rst.txt

@@ -7862,6 +7862,20 @@ security\_monitoring\_rule\_query\_aggregation
    :members:
    :show-inheritance:
 
+security\_monitoring\_rule\_query\_payload
+------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_rule_query_payload
+   :members:
+   :show-inheritance:
+
+security\_monitoring\_rule\_query\_payload\_data
+------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_rule_query_payload_data
+   :members:
+   :show-inheritance:
+
 security\_monitoring\_rule\_response
 ------------------------------------
 
@@ -7876,6 +7890,20 @@ security\_monitoring\_rule\_severity
    :members:
    :show-inheritance:
 
+security\_monitoring\_rule\_test\_request
+-----------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_rule_test_request
+   :members:
+   :show-inheritance:
+
+security\_monitoring\_rule\_test\_response
+------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_rule_test_response
+   :members:
+   :show-inheritance:
+
 security\_monitoring\_rule\_third\_party\_options
 -------------------------------------------------
 

datadog_api_client.html

@@ -9646,6 +9646,14 @@ <h1 id="datadog-api-client--page-root">datadog_api_client<a class="headerlink" h
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_query_aggregation.SecurityMonitoringRuleQueryAggregation"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringRuleQueryAggregation</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.security_monitoring_rule_query_payload">security_monitoring_rule_query_payload</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_query_payload.SecurityMonitoringRuleQueryPayload"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringRuleQueryPayload</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.security_monitoring_rule_query_payload_data">security_monitoring_rule_query_payload_data</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_query_payload_data.SecurityMonitoringRuleQueryPayloadData"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringRuleQueryPayloadData</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.security_monitoring_rule_response">security_monitoring_rule_response</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_response.SecurityMonitoringRuleResponse"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringRuleResponse</span></code></a></li>
 </ul>
@@ -9654,6 +9662,14 @@ <h1 id="datadog-api-client--page-root">datadog_api_client<a class="headerlink" h
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_severity.SecurityMonitoringRuleSeverity"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringRuleSeverity</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.security_monitoring_rule_test_request">security_monitoring_rule_test_request</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_test_request.SecurityMonitoringRuleTestRequest"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringRuleTestRequest</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.security_monitoring_rule_test_response">security_monitoring_rule_test_response</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_test_response.SecurityMonitoringRuleTestResponse"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringRuleTestResponse</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.security_monitoring_rule_third_party_options">security_monitoring_rule_third_party_options</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_third_party_options.SecurityMonitoringRuleThirdPartyOptions"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringRuleThirdPartyOptions</span></code></a></li>
 </ul>

datadog_api_client.v2.api.html

@@ -1187,6 +1187,10 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.search_security_monitoring_signals_with_pagination" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.search_security_monitoring_signals_with_pagination()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.test_existing_security_monitoring_rule" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.test_existing_security_monitoring_rule()</span></code></a>
+        </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.test_security_monitoring_rule" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.test_security_monitoring_rule()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.update_security_filter" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.update_security_filter()</span></code></a>
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.update_security_monitoring_rule" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.update_security_monitoring_rule()</span></code></a>
@@ -2816,6 +2820,10 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.search_security_monitoring_signals_with_pagination" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.search_security_monitoring_signals_with_pagination()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.test_existing_security_monitoring_rule" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.test_existing_security_monitoring_rule()</span></code></a>
+        </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.test_security_monitoring_rule" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.test_security_monitoring_rule()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.update_security_filter" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.update_security_filter()</span></code></a>
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.update_security_monitoring_rule" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.update_security_monitoring_rule()</span></code></a>
@@ -7999,6 +8007,31 @@ <h1 id="datadog-api-client-v2-api--page-root">datadog_api_client.v2.api<a class=
 </dl>
 </dd></dl>
 <dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.test_existing_security_monitoring_rule">
+<span class="sig-name descname"><span class="pre">test_existing_security_monitoring_rule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rule_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_test_request.SecurityMonitoringRuleTestRequest" title="datadog_api_client.v2.model.security_monitoring_rule_test_request.SecurityMonitoringRuleTestRequest"><span class="pre">SecurityMonitoringRuleTestRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_test_response.SecurityMonitoringRuleTestResponse" title="datadog_api_client.v2.model.security_monitoring_rule_test_response.SecurityMonitoringRuleTestResponse"><span class="pre">SecurityMonitoringRuleTestResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.test_existing_security_monitoring_rule" title="Link to this definition">¶</a></dt>
+<dd><p>Test an existing rule.</p>
+<p>Test an existing rule.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>rule_id</strong> (<em>str</em>) – The ID of the rule.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_test_response.SecurityMonitoringRuleTestResponse" title="datadog_api_client.v2.model.security_monitoring_rule_test_response.SecurityMonitoringRuleTestResponse">SecurityMonitoringRuleTestResponse</a></p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.test_security_monitoring_rule">
+<span class="sig-name descname"><span class="pre">test_security_monitoring_rule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_test_request.SecurityMonitoringRuleTestRequest" title="datadog_api_client.v2.model.security_monitoring_rule_test_request.SecurityMonitoringRuleTestRequest"><span class="pre">SecurityMonitoringRuleTestRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_test_response.SecurityMonitoringRuleTestResponse" title="datadog_api_client.v2.model.security_monitoring_rule_test_response.SecurityMonitoringRuleTestResponse"><span class="pre">SecurityMonitoringRuleTestResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.test_security_monitoring_rule" title="Link to this definition">¶</a></dt>
+<dd><p>Test a rule.</p>
+<p>Test a rule.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_monitoring_rule_test_response.SecurityMonitoringRuleTestResponse" title="datadog_api_client.v2.model.security_monitoring_rule_test_response.SecurityMonitoringRuleTestResponse">SecurityMonitoringRuleTestResponse</a></p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.update_security_filter">
 <span class="sig-name descname"><span class="pre">update_security_filter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">security_filter_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_filter_update_request.SecurityFilterUpdateRequest" title="datadog_api_client.v2.model.security_filter_update_request.SecurityFilterUpdateRequest"><span class="pre">SecurityFilterUpdateRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.security_filter_response.SecurityFilterResponse" title="datadog_api_client.v2.model.security_filter_response.SecurityFilterResponse"><span class="pre">SecurityFilterResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.update_security_filter" title="Link to this definition">¶</a></dt>
 <dd><p>Update a security filter.</p>