Skip to content

Commit b97c158

Browse files
Update docs for Security Finding API endpoints (#3074)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 83dabaf
1 parent fab547e commit b97c158

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

datadog_api_client.v2.api.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13409,9 +13409,9 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1340913409
<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.list_security_findings">
1341013410
<span class="sig-name descname"><span class="pre">list_security_findings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_cursor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sort</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_findings_sort.SecurityFindingsSort" title="datadog_api_client.v2.model.security_findings_sort.SecurityFindingsSort"><span class="pre">SecurityFindingsSort</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></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.list_security_findings_response.ListSecurityFindingsResponse" title="datadog_api_client.v2.model.list_security_findings_response.ListSecurityFindingsResponse"><span class="pre">ListSecurityFindingsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.list_security_findings" title="Link to this definition">¶</a></dt>
1341113411
<dd><p>List security findings.</p>
13412-
<p>Get a list of security findings that match a search query.</p>
13412+
<p>Get a list of security findings that match a search query. <a class="reference external" href="https://docs.datadoghq.com/security/guide/findings-schema/">See the schema for security findings</a>.</p>
1341313413
<p><strong>Query Syntax</strong></p>
13414-
<p>This endpoint uses the logs query syntax. Findings attributes (living in the custom. namespace) are prefixed by @ when queried. Tags are queried without a prefix.</p>
13414+
<p>This endpoint uses the logs query syntax. Findings attributes (living in the attributes.attributes. namespace) are prefixed by @ when queried. Tags are queried without a prefix.</p>
1341513415
<p>Example: <code class="docutils literal notranslate"><span class="pre">@severity:(critical</span> <span class="pre">OR</span> <span class="pre">high)</span> <span class="pre">@status:open</span> <span class="pre">team:platform</span></code></p>
1341613416
<dl class="field-list simple">
1341713417
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -13787,9 +13787,9 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1378713787
<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.search_security_findings">
1378813788
<span class="sig-name descname"><span class="pre">search_security_findings</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_findings_search_request.SecurityFindingsSearchRequest" title="datadog_api_client.v2.model.security_findings_search_request.SecurityFindingsSearchRequest"><span class="pre">SecurityFindingsSearchRequest</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.list_security_findings_response.ListSecurityFindingsResponse" title="datadog_api_client.v2.model.list_security_findings_response.ListSecurityFindingsResponse"><span class="pre">ListSecurityFindingsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.search_security_findings" title="Link to this definition">¶</a></dt>
1378913789
<dd><p>Search security findings.</p>
13790-
<p>Get a list of security findings that match a search query.</p>
13790+
<p>Get a list of security findings that match a search query. <a class="reference external" href="https://docs.datadoghq.com/security/guide/findings-schema/">See the schema for security findings</a>.</p>
1379113791
<p><strong>Query Syntax</strong></p>
13792-
<p>The API uses the logs query syntax. Findings attributes (living in the custom. namespace) are prefixed by @ when queried. Tags are queried without a prefix.</p>
13792+
<p>The API uses the logs query syntax. Findings attributes (living in the attributes.attributes. namespace) are prefixed by @ when queried. Tags are queried without a prefix.</p>
1379313793
<p>Example: <code class="docutils literal notranslate"><span class="pre">@severity:(critical</span> <span class="pre">OR</span> <span class="pre">high)</span> <span class="pre">@status:open</span> <span class="pre">team:platform</span></code></p>
1379413794
<dl class="field-list simple">
1379513795
<dt class="field-odd">Return type<span class="colon">:</span></dt>

0 commit comments

Comments
 (0)