Add CSM Agents Read Endpoint (#2314)

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": "2024-12-16 18:27:46.347897",
-            "spec_repo_commit": "a179b579"
+            "regenerated": "2024-12-16 19:15:40.395510",
+            "spec_repo_commit": "162aece5"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-16 18:27:46.361768",
-            "spec_repo_commit": "a179b579"
+            "regenerated": "2024-12-16 19:15:40.410120",
+            "spec_repo_commit": "162aece5"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -4339,6 +4339,34 @@ components:
             from the other indexes
           type: string
       type: object
+    CSMAgentsMetadata:
+      description: Metadata related to the paginated response.
+      properties:
+        page_index:
+          description: The index of the current page in the paginated results.
+          example: 0
+          format: int64
+          type: integer
+        page_size:
+          description: The number of items per page in the paginated results.
+          example: 10
+          format: int64
+          type: integer
+        total_filtered:
+          description: Total number of items that match the filter criteria.
+          example: 128697
+          format: int64
+          type: integer
+      type: object
+    CSMAgentsType:
+      default: datadog_agent
+      description: The type of the resource. The value should always be `datadog_agent`.
+      enum:
+      - datadog_agent
+      example: datadog_agent
+      type: string
+      x-enum-varnames:
+      - DATADOG_AGENT
     CalculatedField:
       description: Calculated field.
       properties:
@@ -6630,6 +6658,96 @@ components:
           nullable: true
           type: string
       type: object
+    CsmAgentData:
+      description: Single Agent Data.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/CsmAgentsAttributes'
+        id:
+          description: The ID of the Agent.
+          example: fffffc5505f6a006fdf7cf5aae053653
+          type: string
+        type:
+          $ref: '#/components/schemas/CSMAgentsType'
+      type: object
+    CsmAgentsAttributes:
+      description: A CSM Agent returned by the API.
+      properties:
+        agent_version:
+          description: Version of the Datadog Agent.
+          type: string
+        aws_fargate:
+          description: AWS Fargate details.
+          type: string
+        cluster_name:
+          description: List of cluster names associated with the Agent.
+          items:
+            type: string
+          type: array
+        datadog_agent:
+          description: Unique identifier for the Datadog Agent.
+          type: string
+        ecs_fargate_task_arn:
+          description: ARN of the ECS Fargate task.
+          type: string
+        envs:
+          description: List of environments associated with the Agent.
+          items:
+            type: string
+          nullable: true
+          type: array
+        host_id:
+          description: ID of the host.
+          format: int64
+          type: integer
+        hostname:
+          description: Name of the host.
+          type: string
+        install_method_installer_version:
+          description: Version of the installer used for installing the Datadog Agent.
+          type: string
+        install_method_tool:
+          description: Tool used for installing the Datadog Agent.
+          type: string
+        is_csm_vm_containers_enabled:
+          description: Indicates if CSM VM Containers is enabled.
+          nullable: true
+          type: boolean
+        is_csm_vm_hosts_enabled:
+          description: Indicates if CSM VM Hosts is enabled.
+          nullable: true
+          type: boolean
+        is_cspm_enabled:
+          description: Indicates if CSPM is enabled.
+          nullable: true
+          type: boolean
+        is_cws_enabled:
+          description: Indicates if CWS is enabled.
+          nullable: true
+          type: boolean
+        is_cws_remote_configuration_enabled:
+          description: Indicates if CWS Remote Configuration is enabled.
+          nullable: true
+          type: boolean
+        is_remote_configuration_enabled:
+          description: Indicates if Remote Configuration is enabled.
+          nullable: true
+          type: boolean
+        os:
+          description: Operating system of the host.
+          type: string
+      type: object
+    CsmAgentsResponse:
+      description: Response object that includes a list of CSM Agents.
+      properties:
+        data:
+          description: A list of Agents.
+          items:
+            $ref: '#/components/schemas/CsmAgentData'
+          type: array
+        meta:
+          $ref: '#/components/schemas/CSMAgentsMetadata'
+      type: object
     CustomCostGetResponseMeta:
       description: Meta for the response from the Get Custom Costs endpoints.
       properties:
@@ -17704,6 +17822,16 @@ components:
       required:
       - data
       type: object
+    OrderDirection:
+      description: The sort direction for results.
+      enum:
+      - asc
+      - desc
+      example: asc
+      type: string
+      x-enum-varnames:
+      - ASC
+      - DESC
     OrgConfigGetResponse:
       description: A response with a single Org Config.
       properties:
@@ -30922,6 +31050,113 @@ paths:
       x-unstable: '**Note**: This endpoint is in public beta.
 
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+  /api/v2/csm/onboarding/agents:
+    get:
+      description: Get the list of all CSM Agents running on your hosts and containers.
+      operationId: ListAllCSMAgents
+      parameters:
+      - description: The page index for pagination (zero-based).
+        in: query
+        name: page
+        required: false
+        schema:
+          example: 2
+          format: int32
+          maximum: 1000000
+          minimum: 0
+          type: integer
+      - description: The number of items to include in a single page.
+        in: query
+        name: size
+        required: false
+        schema:
+          example: 12
+          format: int32
+          maximum: 100
+          minimum: 0
+          type: integer
+      - description: A search query string to filter results (for example, `hostname:COMP-T2H4J27423`).
+        in: query
+        name: query
+        required: false
+        schema:
+          example: hostname:COMP-T2H4J27423
+          type: string
+      - description: The sort direction for results. Use `asc` for ascending or `desc`
+          for descending.
+        in: query
+        name: order_direction
+        required: false
+        schema:
+          $ref: '#/components/schemas/OrderDirection'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CsmAgentsResponse'
+          description: OK
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Get all CSM Agents
+      tags:
+      - CSM Agents
+  /api/v2/csm/onboarding/serverless/agents:
+    get:
+      description: Get the list of all CSM Serverless Agents running on your hosts
+        and containers.
+      operationId: ListAllCSMServerlessAgents
+      parameters:
+      - description: The page index for pagination (zero-based).
+        in: query
+        name: page
+        required: false
+        schema:
+          example: 2
+          format: int32
+          maximum: 1000000
+          minimum: 0
+          type: integer
+      - description: The number of items to include in a single page.
+        in: query
+        name: size
+        required: false
+        schema:
+          example: 12
+          format: int32
+          maximum: 100
+          minimum: 0
+          type: integer
+      - description: A search query string to filter results (for example, `hostname:COMP-T2H4J27423`).
+        in: query
+        name: query
+        required: false
+        schema:
+          example: hostname:COMP-T2H4J27423
+          type: string
+      - description: The sort direction for results. Use `asc` for ascending or `desc`
+          for descending.
+        in: query
+        name: order_direction
+        required: false
+        schema:
+          $ref: '#/components/schemas/OrderDirection'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CsmAgentsResponse'
+          description: OK
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Get all CSM Serverless Agents
+      tags:
+      - CSM Agents
   /api/v2/current_user/application_keys:
     get:
       description: List all application keys available for current user
@@ -44624,6 +44859,15 @@ tags:
     [Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more
     information.
   name: CI Visibility Tests
+- 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 Agents
 - 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

@@ -102,6 +102,13 @@ datadog\_api\_client.v2.api.containers\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.csm\_agents\_api module
+---------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.csm_agents_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.csm\_threats\_api module
 ----------------------------------------------------
 

docs/datadog_api_client.v2.model.rst

@@ -2587,6 +2587,41 @@ datadog\_api\_client.v2.model.creator module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.csm\_agent\_data module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_agent_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_agents\_attributes module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_agents_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_agents\_metadata module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_agents_metadata
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_agents\_response module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_agents_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.csm\_agents\_type module
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.csm_agents_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.custom\_cost\_get\_response\_meta module
 ----------------------------------------------------------------------
 
@@ -7641,6 +7676,13 @@ datadog\_api\_client.v2.model.opsgenie\_services\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.order\_direction module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.order_direction
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.org\_config\_get\_response module
 ---------------------------------------------------------------
 

examples/v2/csm-agents/ListAllCSMAgents.py

@@ -0,0 +1,13 @@
+"""
+Get all CSM Agents returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.csm_agents_api import CSMAgentsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = CSMAgentsApi(api_client)
+    response = api_instance.list_all_csm_agents()
+
+    print(response)

examples/v2/csm-agents/ListAllCSMServerlessAgents.py

@@ -0,0 +1,13 @@
+"""
+Get all CSM Serverless Agents returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.csm_agents_api import CSMAgentsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = CSMAgentsApi(api_client)
+    response = api_instance.list_all_csm_serverless_agents()
+
+    print(response)