Add CSM Coverage Analysis API specs (#2329)

Co-authored-by: ci.datadog-api-spec <[email protected]> 99cf671
DataDog · Jan 2, 2025 · f370ef8 · f370ef8
1 parent dda1349
commit f370ef8
Show file tree

Hide file tree

Showing 10 changed files with 624 additions and 7 deletions.
diff --git a/_sources/datadog_api_client.v2.api.rst.txt b/_sources/datadog_api_client.v2.api.rst.txt
@@ -123,6 +123,13 @@ datadog\_api\_client.v2.api.csm\_agents\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.csm\_coverage\_analysis\_api module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.csm_coverage_analysis_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.csm\_threats\_api module
 ----------------------------------------------------
 

diff --git a/_sources/datadog_api_client.v2.model.rst.txt b/_sources/datadog_api_client.v2.model.rst.txt
@@ -2839,6 +2839,76 @@ datadog\_api\_client.v2.model.csm\_agents\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.csm\_cloud\_accounts\_coverage\_analysis\_attributes module
+-----------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_cloud_accounts_coverage_analysis_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_cloud\_accounts\_coverage\_analysis\_data module
+-----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_cloud_accounts_coverage_analysis_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_cloud\_accounts\_coverage\_analysis\_response module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_cloud_accounts_coverage_analysis_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_coverage\_analysis module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_coverage_analysis
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_hosts\_and\_containers\_coverage\_analysis\_attributes module
+------------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_hosts\_and\_containers\_coverage\_analysis\_data module
+------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_hosts\_and\_containers\_coverage\_analysis\_response module
+----------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_serverless\_coverage\_analysis\_attributes module
+------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_serverless_coverage_analysis_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_serverless\_coverage\_analysis\_data module
+------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_serverless_coverage_analysis_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_serverless\_coverage\_analysis\_response module
+----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_serverless_coverage_analysis_response
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.custom\_connection module
 -------------------------------------------------------
 

diff --git a/datadog_api_client.html b/datadog_api_client.html
@@ -2240,6 +2240,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.container_images_api">datadog_api_client.v2.api.container_images_api module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.containers_api">datadog_api_client.v2.api.containers_api module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.csm_agents_api">datadog_api_client.v2.api.csm_agents_api module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.csm_coverage_analysis_api">datadog_api_client.v2.api.csm_coverage_analysis_api module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.csm_threats_api">datadog_api_client.v2.api.csm_threats_api module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.dashboard_lists_api">datadog_api_client.v2.api.dashboard_lists_api module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.data_deletion_api">datadog_api_client.v2.api.data_deletion_api module</a></li>
@@ -2695,6 +2696,16 @@ <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.csm_agents_metadata">datadog_api_client.v2.model.csm_agents_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.csm_agents_response">datadog_api_client.v2.model.csm_agents_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.csm_agents_type">datadog_api_client.v2.model.csm_agents_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.csm_cloud_accounts_coverage_analysis_attributes">datadog_api_client.v2.model.csm_cloud_accounts_coverage_analysis_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.csm_cloud_accounts_coverage_analysis_data">datadog_api_client.v2.model.csm_cloud_accounts_coverage_analysis_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.csm_cloud_accounts_coverage_analysis_response">datadog_api_client.v2.model.csm_cloud_accounts_coverage_analysis_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.csm_coverage_analysis">datadog_api_client.v2.model.csm_coverage_analysis module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_attributes">datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_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.csm_hosts_and_containers_coverage_analysis_data">datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_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.csm_hosts_and_containers_coverage_analysis_response">datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_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.csm_serverless_coverage_analysis_attributes">datadog_api_client.v2.model.csm_serverless_coverage_analysis_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.csm_serverless_coverage_analysis_data">datadog_api_client.v2.model.csm_serverless_coverage_analysis_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.csm_serverless_coverage_analysis_response">datadog_api_client.v2.model.csm_serverless_coverage_analysis_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.custom_connection">datadog_api_client.v2.model.custom_connection module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.custom_connection_attributes">datadog_api_client.v2.model.custom_connection_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.custom_connection_attributes_on_prem_runner">datadog_api_client.v2.model.custom_connection_attributes_on_prem_runner module</a></li>

diff --git a/datadog_api_client.v2.api.html b/datadog_api_client.v2.api.html
@@ -1001,6 +1001,20 @@
         </li></ul>
             </nav>
         </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.csm_coverage_analysis_api" class="md-nav__link">datadog_api_client.v2.api.csm_coverage_analysis_api module</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">CSMCoverageAnalysisApi</span></code></a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi.get_csm_cloud_accounts_coverage_analysis" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">CSMCoverageAnalysisApi.get_csm_cloud_accounts_coverage_analysis()</span></code></a>
+        </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi.get_csm_hosts_and_containers_coverage_analysis" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">CSMCoverageAnalysisApi.get_csm_hosts_and_containers_coverage_analysis()</span></code></a>
+        </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi.get_csm_serverless_coverage_analysis" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">CSMCoverageAnalysisApi.get_csm_serverless_coverage_analysis()</span></code></a>
+        </li></ul>
+            </nav>
+        </li></ul>
+            </nav>
+        </li>
         <li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.csm_threats_api" class="md-nav__link">datadog_api_client.v2.api.csm_threats_api module</a><nav class="md-nav">
               <ul class="md-nav__list">
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.csm_threats_api.CSMThreatsApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">CSMThreatsApi</span></code></a><nav class="md-nav">
@@ -3659,6 +3673,57 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 </dd></dl>
 </dd></dl>
 </section>
+<section id="module-datadog_api_client.v2.api.csm_coverage_analysis_api">
+<span id="datadog-api-client-v2-api-csm-coverage-analysis-api-module"></span><h2 id="module-datadog_api_client.v2.api.csm_coverage_analysis_api">datadog_api_client.v2.api.csm_coverage_analysis_api module<a class="headerlink" href="#module-datadog_api_client.v2.api.csm_coverage_analysis_api" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CSMCoverageAnalysisApi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Datadog Cloud Security Management (CSM) delivers real-time threat detection
+and continuous configuration audits across your entire cloud infrastructure,
+all in a unified view for seamless collaboration and faster remediation.
+Go to <a class="reference external" href="https://docs.datadoghq.com/security/cloud_security_management">https://docs.datadoghq.com/security/cloud_security_management</a> to learn more.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi.get_csm_cloud_accounts_coverage_analysis">
+<span class="sig-name descname"><span class="pre">get_csm_cloud_accounts_coverage_analysis</span></span><span class="sig-paren">(</span><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.csm_cloud_accounts_coverage_analysis_response.CsmCloudAccountsCoverageAnalysisResponse" title="datadog_api_client.v2.model.csm_cloud_accounts_coverage_analysis_response.CsmCloudAccountsCoverageAnalysisResponse"><span class="pre">CsmCloudAccountsCoverageAnalysisResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi.get_csm_cloud_accounts_coverage_analysis" title="Link to this definition">¶</a></dt>
+<dd><p>Get the CSM Cloud Accounts Coverage Analysis.</p>
+<p>Get the CSM Coverage Analysis of your Cloud Accounts.
+This is calculated based on the number of your Cloud Accounts that are
+scanned for security issues.</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.csm_cloud_accounts_coverage_analysis_response.CsmCloudAccountsCoverageAnalysisResponse" title="datadog_api_client.v2.model.csm_cloud_accounts_coverage_analysis_response.CsmCloudAccountsCoverageAnalysisResponse">CsmCloudAccountsCoverageAnalysisResponse</a></p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi.get_csm_hosts_and_containers_coverage_analysis">
+<span class="sig-name descname"><span class="pre">get_csm_hosts_and_containers_coverage_analysis</span></span><span class="sig-paren">(</span><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.csm_hosts_and_containers_coverage_analysis_response.CsmHostsAndContainersCoverageAnalysisResponse" title="datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_response.CsmHostsAndContainersCoverageAnalysisResponse"><span class="pre">CsmHostsAndContainersCoverageAnalysisResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi.get_csm_hosts_and_containers_coverage_analysis" title="Link to this definition">¶</a></dt>
+<dd><p>Get the CSM Hosts and Containers Coverage Analysis.</p>
+<p>Get the CSM Coverage Analysis of your Hosts and Containers.
+This is calculated based on the number of agents running on your Hosts
+and Containers with CSM feature(s) enabled.</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.csm_hosts_and_containers_coverage_analysis_response.CsmHostsAndContainersCoverageAnalysisResponse" title="datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_response.CsmHostsAndContainersCoverageAnalysisResponse">CsmHostsAndContainersCoverageAnalysisResponse</a></p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi.get_csm_serverless_coverage_analysis">
+<span class="sig-name descname"><span class="pre">get_csm_serverless_coverage_analysis</span></span><span class="sig-paren">(</span><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.csm_serverless_coverage_analysis_response.CsmServerlessCoverageAnalysisResponse" title="datadog_api_client.v2.model.csm_serverless_coverage_analysis_response.CsmServerlessCoverageAnalysisResponse"><span class="pre">CsmServerlessCoverageAnalysisResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.csm_coverage_analysis_api.CSMCoverageAnalysisApi.get_csm_serverless_coverage_analysis" title="Link to this definition">¶</a></dt>
+<dd><p>Get the CSM Serverless Coverage Analysis.</p>
+<p>Get the CSM Coverage Analysis of your Serverless Resources.
+This is calculated based on the number of agents running on your Serverless
+Resources with CSM feature(s) enabled.</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.csm_serverless_coverage_analysis_response.CsmServerlessCoverageAnalysisResponse" title="datadog_api_client.v2.model.csm_serverless_coverage_analysis_response.CsmServerlessCoverageAnalysisResponse">CsmServerlessCoverageAnalysisResponse</a></p>
+</dd>
+</dl>
+</dd></dl>
+</dd></dl>
+</section>
 <section id="module-datadog_api_client.v2.api.csm_threats_api">
 <span id="datadog-api-client-v2-api-csm-threats-api-module"></span><h2 id="module-datadog_api_client.v2.api.csm_threats_api">datadog_api_client.v2.api.csm_threats_api module<a class="headerlink" href="#module-datadog_api_client.v2.api.csm_threats_api" title="Link to this heading">¶</a></h2>
 <dl class="py class">