Add CSM Coverage Analysis API specs (#2329)

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

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-02 14:39:45.568008",
-            "spec_repo_commit": "b4e964b3"
+            "regenerated": "2025-01-02 15:18:22.861274",
+            "spec_repo_commit": "bc53c28f"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-02 14:39:45.582278",
-            "spec_repo_commit": "b4e964b3"
+            "regenerated": "2025-01-02 15:18:22.882795",
+            "spec_repo_commit": "bc53c28f"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -7340,6 +7340,140 @@ components:
         meta:
           $ref: '#/components/schemas/CSMAgentsMetadata'
       type: object
+    CsmCloudAccountsCoverageAnalysisAttributes:
+      description: CSM Cloud Accounts Coverage Analysis attributes.
+      properties:
+        aws_coverage:
+          $ref: '#/components/schemas/CsmCoverageAnalysis'
+        azure_coverage:
+          $ref: '#/components/schemas/CsmCoverageAnalysis'
+        gcp_coverage:
+          $ref: '#/components/schemas/CsmCoverageAnalysis'
+        org_id:
+          description: The ID of your organization.
+          example: 123456
+          format: int64
+          type: integer
+        total_coverage:
+          $ref: '#/components/schemas/CsmCoverageAnalysis'
+      type: object
+    CsmCloudAccountsCoverageAnalysisData:
+      description: CSM Cloud Accounts Coverage Analysis data.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisAttributes'
+        id:
+          description: The ID of your organization.
+          example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3
+          type: string
+        type:
+          default: get_cloud_accounts_coverage_analysis_response_public_v0
+          description: The type of the resource. The value should always be `get_cloud_accounts_coverage_analysis_response_public_v0`.
+          example: get_cloud_accounts_coverage_analysis_response_public_v0
+          type: string
+      type: object
+    CsmCloudAccountsCoverageAnalysisResponse:
+      description: CSM Cloud Accounts Coverage Analysis response.
+      properties:
+        data:
+          $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisData'
+      type: object
+    CsmCoverageAnalysis:
+      description: CSM Coverage Analysis.
+      properties:
+        configured_resources_count:
+          description: The number of fully configured resources.
+          example: 8
+          format: int64
+          type: integer
+        coverage:
+          description: The coverage percentage.
+          example: 0.8
+          format: double
+          type: number
+        partially_configured_resources_count:
+          description: The number of partially configured resources.
+          example: 0
+          format: int64
+          type: integer
+        total_resources_count:
+          description: The total number of resources.
+          example: 10
+          format: int64
+          type: integer
+      type: object
+    CsmHostsAndContainersCoverageAnalysisAttributes:
+      description: CSM Hosts and Containers Coverage Analysis attributes.
+      properties:
+        cspm_coverage:
+          $ref: '#/components/schemas/CsmCoverageAnalysis'
+        cws_coverage:
+          $ref: '#/components/schemas/CsmCoverageAnalysis'
+        org_id:
+          description: The ID of your organization.
+          example: 123456
+          format: int64
+          type: integer
+        total_coverage:
+          $ref: '#/components/schemas/CsmCoverageAnalysis'
+        vm_coverage:
+          $ref: '#/components/schemas/CsmCoverageAnalysis'
+      type: object
+    CsmHostsAndContainersCoverageAnalysisData:
+      description: CSM Hosts and Containers Coverage Analysis data.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisAttributes'
+        id:
+          description: The ID of your organization.
+          example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3
+          type: string
+        type:
+          default: get_hosts_and_containers_coverage_analysis_response_public_v0
+          description: The type of the resource. The value should always be `get_hosts_and_containers_coverage_analysis_response_public_v0`.
+          example: get_hosts_and_containers_coverage_analysis_response_public_v0
+          type: string
+      type: object
+    CsmHostsAndContainersCoverageAnalysisResponse:
+      description: CSM Hosts and Containers Coverage Analysis response.
+      properties:
+        data:
+          $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisData'
+      type: object
+    CsmServerlessCoverageAnalysisAttributes:
+      description: CSM Serverless Resources Coverage Analysis attributes.
+      properties:
+        cws_coverage:
+          $ref: '#/components/schemas/CsmCoverageAnalysis'
+        org_id:
+          description: The ID of your organization.
+          example: 123456
+          format: int64
+          type: integer
+        total_coverage:
+          $ref: '#/components/schemas/CsmCoverageAnalysis'
+      type: object
+    CsmServerlessCoverageAnalysisData:
+      description: CSM Serverless Resources Coverage Analysis data.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/CsmServerlessCoverageAnalysisAttributes'
+        id:
+          description: The ID of your organization.
+          example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3
+          type: string
+        type:
+          default: get_serverless_coverage_analysis_response_public_v0
+          description: The type of the resource. The value should always be `get_serverless_coverage_analysis_response_public_v0`.
+          example: get_serverless_coverage_analysis_response_public_v0
+          type: string
+      type: object
+    CsmServerlessCoverageAnalysisResponse:
+      description: CSM Serverless Resources Coverage Analysis response.
+      properties:
+        data:
+          $ref: '#/components/schemas/CsmServerlessCoverageAnalysisData'
+      type: object
     CustomConnection:
       description: The definition of `CustomConnection` object.
       properties:
@@ -33610,6 +33744,72 @@ paths:
       summary: Get all CSM Agents
       tags:
       - CSM Agents
+  /api/v2/csm/onboarding/coverage_analysis/cloud_accounts:
+    get:
+      description: '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.'
+      operationId: GetCSMCloudAccountsCoverageAnalysis
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisResponse'
+          description: OK
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Get the CSM Cloud Accounts Coverage Analysis
+      tags:
+      - CSM Coverage Analysis
+  /api/v2/csm/onboarding/coverage_analysis/hosts_and_containers:
+    get:
+      description: '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.'
+      operationId: GetCSMHostsAndContainersCoverageAnalysis
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisResponse'
+          description: OK
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Get the CSM Hosts and Containers Coverage Analysis
+      tags:
+      - CSM Coverage Analysis
+  /api/v2/csm/onboarding/coverage_analysis/serverless:
+    get:
+      description: '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.'
+      operationId: GetCSMServerlessCoverageAnalysis
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CsmServerlessCoverageAnalysisResponse'
+          description: OK
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Get the CSM Serverless Coverage Analysis
+      tags:
+      - CSM Coverage Analysis
   /api/v2/csm/onboarding/serverless/agents:
     get:
       description: Get the list of all CSM Serverless Agents running on your hosts
@@ -47941,6 +48141,15 @@ tags:
 
     Go to https://docs.datadoghq.com/security/cloud_security_management to learn more'
   name: CSM Agents
+- description: '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 https://docs.datadoghq.com/security/cloud_security_management to learn more.'
+  name: CSM Coverage Analysis
 - description: Cloud Security Management Threats (CSM Threats) monitors file, network,
     and process activity across your environment to detect real-time threats to your
     infrastructure. See [Cloud Security Management Threats](https://docs.datadoghq.com/security/threats/)

docs/datadog_api_client.v2.api.rst

@@ -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
 ----------------------------------------------------
 

docs/datadog_api_client.v2.model.rst

@@ -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
 -------------------------------------------------------
 

examples/v2/csm-coverage-analysis/GetCSMCloudAccountsCoverageAnalysis.py

@@ -0,0 +1,13 @@
+"""
+Get the CSM Cloud Accounts Coverage Analysis returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.csm_coverage_analysis_api import CSMCoverageAnalysisApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = CSMCoverageAnalysisApi(api_client)
+    response = api_instance.get_csm_cloud_accounts_coverage_analysis()
+
+    print(response)

examples/v2/csm-coverage-analysis/GetCSMHostsAndContainersCoverageAnalysis.py

@@ -0,0 +1,13 @@
+"""
+Get the CSM Hosts and Containers Coverage Analysis returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.csm_coverage_analysis_api import CSMCoverageAnalysisApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = CSMCoverageAnalysisApi(api_client)
+    response = api_instance.get_csm_hosts_and_containers_coverage_analysis()
+
+    print(response)

examples/v2/csm-coverage-analysis/GetCSMServerlessCoverageAnalysis.py

@@ -0,0 +1,13 @@
+"""
+Get the CSM Serverless Coverage Analysis returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.csm_coverage_analysis_api import CSMCoverageAnalysisApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = CSMCoverageAnalysisApi(api_client)
+    response = api_instance.get_csm_serverless_coverage_analysis()
+
+    print(response)