Skip to content

Commit 014c45a

Browse files
Add support for vulnerability management - GetSBOM new endpoint (#2359)
Co-authored-by: ci.datadog-api-spec <[email protected]> 1e54c78
1 parent 384e264 commit 014c45a

9 files changed

+571
-118
lines changed

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 70 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -340,24 +340,24 @@ datadog\_api\_client.v2.model.asset\_attributes module
340340
:members:
341341
:show-inheritance:
342342

343-
datadog\_api\_client.v2.model.asset\_attributes\_operating\_system module
344-
-------------------------------------------------------------------------
343+
datadog\_api\_client.v2.model.asset\_entity\_type module
344+
--------------------------------------------------------
345345

346-
.. automodule:: datadog_api_client.v2.model.asset_attributes_operating_system
346+
.. automodule:: datadog_api_client.v2.model.asset_entity_type
347347
:members:
348348
:show-inheritance:
349349

350-
datadog\_api\_client.v2.model.asset\_attributes\_risks module
350+
datadog\_api\_client.v2.model.asset\_operating\_system module
351351
-------------------------------------------------------------
352352

353-
.. automodule:: datadog_api_client.v2.model.asset_attributes_risks
353+
.. automodule:: datadog_api_client.v2.model.asset_operating_system
354354
:members:
355355
:show-inheritance:
356356

357-
datadog\_api\_client.v2.model.asset\_entity\_type module
358-
--------------------------------------------------------
357+
datadog\_api\_client.v2.model.asset\_risks module
358+
-------------------------------------------------
359359

360-
.. automodule:: datadog_api_client.v2.model.asset_entity_type
360+
.. automodule:: datadog_api_client.v2.model.asset_risks
361361
:members:
362362
:show-inheritance:
363363

@@ -5233,6 +5233,13 @@ datadog\_api\_client.v2.model.get\_interfaces\_response module
52335233
:members:
52345234
:show-inheritance:
52355235

5236+
datadog\_api\_client.v2.model.get\_sbom\_response module
5237+
--------------------------------------------------------
5238+
5239+
.. automodule:: datadog_api_client.v2.model.get_sbom_response
5240+
:members:
5241+
:show-inheritance:
5242+
52365243
datadog\_api\_client.v2.model.get\_team\_memberships\_sort module
52375244
-----------------------------------------------------------------
52385245

@@ -10322,6 +10329,55 @@ datadog\_api\_client.v2.model.saml\_assertion\_attributes\_type module
1032210329
:members:
1032310330
:show-inheritance:
1032410331

10332+
datadog\_api\_client.v2.model.sbom module
10333+
-----------------------------------------
10334+
10335+
.. automodule:: datadog_api_client.v2.model.sbom
10336+
:members:
10337+
:show-inheritance:
10338+
10339+
datadog\_api\_client.v2.model.sbom\_attributes module
10340+
-----------------------------------------------------
10341+
10342+
.. automodule:: datadog_api_client.v2.model.sbom_attributes
10343+
:members:
10344+
:show-inheritance:
10345+
10346+
datadog\_api\_client.v2.model.sbom\_component module
10347+
----------------------------------------------------
10348+
10349+
.. automodule:: datadog_api_client.v2.model.sbom_component
10350+
:members:
10351+
:show-inheritance:
10352+
10353+
datadog\_api\_client.v2.model.sbom\_component\_type module
10354+
----------------------------------------------------------
10355+
10356+
.. automodule:: datadog_api_client.v2.model.sbom_component_type
10357+
:members:
10358+
:show-inheritance:
10359+
10360+
datadog\_api\_client.v2.model.sbom\_metadata module
10361+
---------------------------------------------------
10362+
10363+
.. automodule:: datadog_api_client.v2.model.sbom_metadata
10364+
:members:
10365+
:show-inheritance:
10366+
10367+
datadog\_api\_client.v2.model.sbom\_metadata\_component module
10368+
--------------------------------------------------------------
10369+
10370+
.. automodule:: datadog_api_client.v2.model.sbom_metadata_component
10371+
:members:
10372+
:show-inheritance:
10373+
10374+
datadog\_api\_client.v2.model.sbom\_type module
10375+
-----------------------------------------------
10376+
10377+
.. automodule:: datadog_api_client.v2.model.sbom_type
10378+
:members:
10379+
:show-inheritance:
10380+
1032510381
datadog\_api\_client.v2.model.scalar\_column module
1032610382
---------------------------------------------------
1032710383

@@ -13437,17 +13493,17 @@ datadog\_api\_client.v2.model.vulnerability\_attributes module
1343713493
:members:
1343813494
:show-inheritance:
1343913495

13440-
datadog\_api\_client.v2.model.vulnerability\_attributes\_cvss module
13441-
--------------------------------------------------------------------
13496+
datadog\_api\_client.v2.model.vulnerability\_cvss module
13497+
--------------------------------------------------------
1344213498

13443-
.. automodule:: datadog_api_client.v2.model.vulnerability_attributes_cvss
13499+
.. automodule:: datadog_api_client.v2.model.vulnerability_cvss
1344413500
:members:
1344513501
:show-inheritance:
1344613502

13447-
datadog\_api\_client.v2.model.vulnerability\_attributes\_dependency\_locations module
13448-
-------------------------------------------------------------------------------------
13503+
datadog\_api\_client.v2.model.vulnerability\_dependency\_locations module
13504+
-------------------------------------------------------------------------
1344913505

13450-
.. automodule:: datadog_api_client.v2.model.vulnerability_attributes_dependency_locations
13506+
.. automodule:: datadog_api_client.v2.model.vulnerability_dependency_locations
1345113507
:members:
1345213508
:show-inheritance:
1345313509

datadog_api_client.html

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2343,9 +2343,9 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
23432343
<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>
23442344
<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>
23452345
<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>
2346-
<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>
2347-
<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>
23482346
<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>
2347+
<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>
2348+
<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>
23492349
<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>
23502350
<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>
23512351
<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=
30423042
<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>
30433043
<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>
30443044
<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>
3045+
<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>
30453046
<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>
30463047
<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>
30473048
<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=
37693770
<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>
37703771
<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>
37713772
<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>
3773+
<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>
3774+
<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>
3775+
<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>
3776+
<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>
3777+
<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>
3778+
<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>
3779+
<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>
37723780
<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>
37733781
<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>
37743782
<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=
42144222
<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>
42154223
<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>
42164224
<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>
4217-
<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>
4218-
<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>
4225+
<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>
4226+
<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>
42194227
<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>
42204228
<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>
42214229
<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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1745,6 +1745,8 @@
17451745
</li>
17461746
<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>
17471747
</li>
1748+
<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>
1749+
</li>
17481750
<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>
17491751
</li>
17501752
<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
78587860
</dl>
78597861
</dd></dl>
78607862
<dl class="py method">
7863+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.get_sbom">
7864+
<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>
7865+
<dd><p>Get SBOM.</p>
7866+
<p>Get a single SBOM related to an asset by its type and name.</p>
7867+
<dl class="field-list simple">
7868+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7869+
<dd class="field-odd"><ul class="simple">
7870+
<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>
7871+
<li><p><strong>filter_asset_name</strong> (<em>str</em>) – The name of the asset for the SBOM request.</p></li>
7872+
<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>
7873+
</ul>
7874+
</dd>
7875+
<dt class="field-even">Return type<span class="colon">:</span></dt>
7876+
<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>
7877+
</dd>
7878+
</dl>
7879+
</dd></dl>
7880+
<dl class="py method">
78617881
<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.get_security_filter">
78627882
<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>
78637883
<dd><p>Get a security filter.</p>

0 commit comments

Comments
 (0)