Add support for vulnerability management - GetSBOM new endpoint (#2359)

Co-authored-by: ci.datadog-api-spec <[email protected]> 1e54c78

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

_sources/datadog_api_client.v2.model.rst.txt

@@ -340,24 +340,24 @@ datadog\_api\_client.v2.model.asset\_attributes module
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v2.model.asset\_attributes\_operating\_system module
--------------------------------------------------------------------------
+datadog\_api\_client.v2.model.asset\_entity\_type module
+--------------------------------------------------------
 
-.. automodule:: datadog_api_client.v2.model.asset_attributes_operating_system
+.. automodule:: datadog_api_client.v2.model.asset_entity_type
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v2.model.asset\_attributes\_risks module
+datadog\_api\_client.v2.model.asset\_operating\_system module
 -------------------------------------------------------------
 
-.. automodule:: datadog_api_client.v2.model.asset_attributes_risks
+.. automodule:: datadog_api_client.v2.model.asset_operating_system
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v2.model.asset\_entity\_type module
---------------------------------------------------------
+datadog\_api\_client.v2.model.asset\_risks module
+-------------------------------------------------
 
-.. automodule:: datadog_api_client.v2.model.asset_entity_type
+.. automodule:: datadog_api_client.v2.model.asset_risks
    :members:
    :show-inheritance:
 
@@ -5233,6 +5233,13 @@ datadog\_api\_client.v2.model.get\_interfaces\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.get\_sbom\_response module
+--------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.get_sbom_response
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.get\_team\_memberships\_sort module
 -----------------------------------------------------------------
 
@@ -10322,6 +10329,55 @@ datadog\_api\_client.v2.model.saml\_assertion\_attributes\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.sbom module
+-----------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.sbom
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.sbom\_attributes module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.sbom_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.sbom\_component module
+----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.sbom_component
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.sbom\_component\_type module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.sbom_component_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.sbom\_metadata module
+---------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.sbom_metadata
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.sbom\_metadata\_component module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.sbom_metadata_component
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.sbom\_type module
+-----------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.sbom_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.scalar\_column module
 ---------------------------------------------------
 
@@ -13437,17 +13493,17 @@ datadog\_api\_client.v2.model.vulnerability\_attributes module
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v2.model.vulnerability\_attributes\_cvss module
---------------------------------------------------------------------
+datadog\_api\_client.v2.model.vulnerability\_cvss module
+--------------------------------------------------------
 
-.. automodule:: datadog_api_client.v2.model.vulnerability_attributes_cvss
+.. automodule:: datadog_api_client.v2.model.vulnerability_cvss
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v2.model.vulnerability\_attributes\_dependency\_locations module
--------------------------------------------------------------------------------------
+datadog\_api\_client.v2.model.vulnerability\_dependency\_locations module
+-------------------------------------------------------------------------
 
-.. automodule:: datadog_api_client.v2.model.vulnerability_attributes_dependency_locations
+.. automodule:: datadog_api_client.v2.model.vulnerability_dependency_locations
    :members:
    :show-inheritance:
 

datadog_api_client.html

@@ -2343,9 +2343,9 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.apps_sort_field">datadog_api_client.v2.model.apps_sort_field module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.asset">datadog_api_client.v2.model.asset module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.asset_attributes">datadog_api_client.v2.model.asset_attributes module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.asset_attributes_operating_system">datadog_api_client.v2.model.asset_attributes_operating_system module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.asset_attributes_risks">datadog_api_client.v2.model.asset_attributes_risks module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.asset_entity_type">datadog_api_client.v2.model.asset_entity_type module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.asset_operating_system">datadog_api_client.v2.model.asset_operating_system module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.asset_risks">datadog_api_client.v2.model.asset_risks module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.asset_type">datadog_api_client.v2.model.asset_type module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.audit_logs_event">datadog_api_client.v2.model.audit_logs_event module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.audit_logs_event_attributes">datadog_api_client.v2.model.audit_logs_event_attributes module</a></li>
@@ -3042,6 +3042,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.get_finding_response">datadog_api_client.v2.model.get_finding_response module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.get_interfaces_data">datadog_api_client.v2.model.get_interfaces_data module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.get_interfaces_response">datadog_api_client.v2.model.get_interfaces_response module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.get_sbom_response">datadog_api_client.v2.model.get_sbom_response module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.get_team_memberships_sort">datadog_api_client.v2.model.get_team_memberships_sort module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.group_scalar_column">datadog_api_client.v2.model.group_scalar_column module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.group_tags">datadog_api_client.v2.model.group_tags module</a></li>
@@ -3769,6 +3770,13 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.saml_assertion_attribute">datadog_api_client.v2.model.saml_assertion_attribute module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.saml_assertion_attribute_attributes">datadog_api_client.v2.model.saml_assertion_attribute_attributes module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.saml_assertion_attributes_type">datadog_api_client.v2.model.saml_assertion_attributes_type module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sbom">datadog_api_client.v2.model.sbom module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sbom_attributes">datadog_api_client.v2.model.sbom_attributes module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sbom_component">datadog_api_client.v2.model.sbom_component module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sbom_component_type">datadog_api_client.v2.model.sbom_component_type module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sbom_metadata">datadog_api_client.v2.model.sbom_metadata module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sbom_metadata_component">datadog_api_client.v2.model.sbom_metadata_component module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sbom_type">datadog_api_client.v2.model.sbom_type module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.scalar_column">datadog_api_client.v2.model.scalar_column module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.scalar_column_type_group">datadog_api_client.v2.model.scalar_column_type_group module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.scalar_column_type_number">datadog_api_client.v2.model.scalar_column_type_number module</a></li>
@@ -4214,8 +4222,8 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.vulnerabilities_type">datadog_api_client.v2.model.vulnerabilities_type module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.vulnerability">datadog_api_client.v2.model.vulnerability module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.vulnerability_attributes">datadog_api_client.v2.model.vulnerability_attributes module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.vulnerability_attributes_cvss">datadog_api_client.v2.model.vulnerability_attributes_cvss module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.vulnerability_attributes_dependency_locations">datadog_api_client.v2.model.vulnerability_attributes_dependency_locations module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.vulnerability_cvss">datadog_api_client.v2.model.vulnerability_cvss module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.vulnerability_dependency_locations">datadog_api_client.v2.model.vulnerability_dependency_locations module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.vulnerability_ecosystem">datadog_api_client.v2.model.vulnerability_ecosystem module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.vulnerability_relationships">datadog_api_client.v2.model.vulnerability_relationships module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.vulnerability_relationships_affects">datadog_api_client.v2.model.vulnerability_relationships_affects module</a></li>

datadog_api_client.v2.api.html

@@ -1745,6 +1745,8 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.get_historical_job" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.get_historical_job()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.get_sbom" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.get_sbom()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.get_security_filter" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.get_security_filter()</span></code></a>
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.get_security_monitoring_rule" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SecurityMonitoringApi.get_security_monitoring_rule()</span></code></a>
@@ -7858,6 +7860,24 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 </dl>
 </dd></dl>
 <dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.get_sbom">
+<span class="sig-name descname"><span class="pre">get_sbom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">asset_type</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.asset_type.AssetType" title="datadog_api_client.v2.model.asset_type.AssetType"><span class="pre">AssetType</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_asset_name</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_repo_digest</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><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.get_sbom_response.GetSBOMResponse" title="datadog_api_client.v2.model.get_sbom_response.GetSBOMResponse"><span class="pre">GetSBOMResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.get_sbom" title="Link to this definition">¶</a></dt>
+<dd><p>Get SBOM.</p>
+<p>Get a single SBOM related to an asset by its type and name.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>asset_type</strong> (<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.asset_type.AssetType" title="datadog_api_client.v2.model.asset_type.AssetType"><em>AssetType</em></a>) – The type of the asset for the SBOM request.</p></li>
+<li><p><strong>filter_asset_name</strong> (<em>str</em>) – The name of the asset for the SBOM request.</p></li>
+<li><p><strong>filter_repo_digest</strong> (<em>str</em><em>, </em><em>optional</em>) – The container image <code class="docutils literal notranslate"><span class="pre">repo_digest</span></code> for the SBOM request. When the requested asset type is ‘Image’, this filter is mandatory.</p></li>
+</ul>
+</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.get_sbom_response.GetSBOMResponse" title="datadog_api_client.v2.model.get_sbom_response.GetSBOMResponse">GetSBOMResponse</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.get_security_filter">
 <span class="sig-name descname"><span class="pre">get_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><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.get_security_filter" title="Link to this definition">¶</a></dt>
 <dd><p>Get a security filter.</p>