datadog_api_client 1.0.0 → 1.1.0

data/data/v2/openapi.yaml

@@ -207,6 +207,7 @@ components:
       required: false
       schema:
         default: 0
+        example: 0
         format: int64
         type: integer
     PageOffset:
@@ -216,6 +217,7 @@ components:
       required: false
       schema:
         default: 0
+        example: 0
         format: int64
         type: integer
     PageSize:
@@ -225,6 +227,7 @@ components:
       required: false
       schema:
         default: 10
+        example: 10
         format: int64
         type: integer
     RoleID:
@@ -234,6 +237,13 @@ components:
       required: true
       schema:
         type: string
+    SecurityFilterID:
+      description: The ID of the security filter.
+      in: path
+      name: security_filter_id
+      required: true
+      schema:
+        type: string
     SecurityMonitoringRuleID:
       description: The ID of the rule.
       in: path
@@ -247,6 +257,7 @@ components:
       name: user_id
       required: true
       schema:
+        example: 00000000-0000-0000-0000-000000000000
         type: string
   requestBodies: {}
   responses:
@@ -949,14 +960,14 @@ components:
       - METRICTAG
       - AUTOCOMPLETE
     IncidentIntegrationMetadataType:
-      default: incident_integration_metadata
+      default: incident_integrations
       description: Integration metadata resource type.
       enum:
-      - incident_integration_metadata
-      example: incident_integration_metadata
+      - incident_integrations
+      example: incident_integrations
       type: string
       x-enum-varnames:
-      - INCIDENT_INTEGRATION_METADATA
+      - INCIDENT_INTEGRATIONS
     IncidentPostmortemType:
       default: incident_postmortems
       description: Incident postmortem resource type.
@@ -1674,9 +1685,9 @@ components:
               integrations:
                 data:
                 - id: 00000000-0000-0000-0000-000000000000
-                  type: incident_integration_metadata
+                  type: incident_integrations
                 - id: 00000000-0000-0000-0000-000000000000
-                  type: incident_integration_metadata
+                  type: incident_integrations
               last_modified_by_user:
                 data:
                   id: 00000000-0000-0000-0000-000000000000
@@ -1718,9 +1729,9 @@ components:
               integrations:
                 data:
                 - id: 00000000-0000-0000-0000-000000000000
-                  type: incident_integration_metadata
+                  type: incident_integrations
                 - id: 00000000-0000-0000-0000-000000000000
-                  type: incident_integration_metadata
+                  type: incident_integrations
               last_modified_by_user:
                 data:
                   id: 00000000-0000-0000-0000-000000000000
@@ -3484,7 +3495,7 @@ components:
       description: A relationship reference for an integration metadata object.
       example:
         id: 00000000-0000-0000-0000-000000000000
-        type: incident_integration_metadata
+        type: incident_integrations
       properties:
         id:
           description: A unique identifier that represents the integration metadata.
@@ -3501,17 +3512,17 @@ components:
       example:
         data:
         - id: 00000000-0000-0000-0000-000000000000
-          type: incident_integration_metadata
+          type: incident_integrations
         - id: 00000000-0000-0000-0000-000000000000
-          type: incident_integration_metadata
+          type: incident_integrations
       properties:
         data:
           description: The integration metadata relationship array
           example:
           - id: 00000000-0000-0000-0000-000000000000
-            type: incident_integration_metadata
+            type: incident_integrations
           - id: 00000000-0000-0000-0000-000000000000
-            type: incident_integration_metadata
+            type: incident_integrations
           items:
             $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadataData'
           type: array
@@ -3881,6 +3892,237 @@ components:
       type: string
       x-enum-varnames:
       - ROLES
+    SecurityFilter:
+      description: The security filter's properties.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/SecurityFilterAttributes'
+        id:
+          $ref: '#/components/schemas/SecurityFilterID'
+        type:
+          $ref: '#/components/schemas/SecurityFilterType'
+      type: object
+    SecurityFilterAttributes:
+      description: The object describing a security filter.
+      properties:
+        exclusion_filters:
+          description: The list of exclusion filters applied in this security filter.
+          items:
+            $ref: '#/components/schemas/SecurityFilterExclusionFilterResponse'
+          type: array
+        filtered_data_type:
+          $ref: '#/components/schemas/SecurityFilterFilteredDataType'
+        is_builtin:
+          description: Whether the security filter is the built-in filter.
+          example: false
+          type: boolean
+        is_enabled:
+          description: Whether the security filter is enabled.
+          example: false
+          type: boolean
+        name:
+          description: The security filter name.
+          example: Custom security filter
+          type: string
+        query:
+          description: The security filter query. Logs accepted by this query will
+            be accepted by this filter.
+          example: service:api
+          type: string
+        version:
+          description: The version of the security filter.
+          example: 1
+          format: int32
+          maximum: 2147483647
+          type: integer
+      type: object
+    SecurityFilterCreateAttributes:
+      description: Object containing the attributes of the security filter to be created.
+      properties:
+        exclusion_filters:
+          description: Exclusion filters to exclude some logs from the security filter.
+          example:
+          - name: Exclude staging
+            query: source:staging
+          items:
+            $ref: '#/components/schemas/SecurityFilterExclusionFilter'
+          type: array
+        filtered_data_type:
+          $ref: '#/components/schemas/SecurityFilterFilteredDataType'
+        is_enabled:
+          description: Whether the security filter is enabled.
+          example: true
+          type: boolean
+        name:
+          description: The name of the security filter.
+          example: Custom security filter
+          type: string
+        query:
+          description: The query of the security filter.
+          example: service:api
+          type: string
+      required:
+      - name
+      - query
+      - exclusion_filters
+      - filtered_data_type
+      - is_enabled
+      type: object
+    SecurityFilterCreateData:
+      description: Object for a single security filter.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/SecurityFilterCreateAttributes'
+        type:
+          $ref: '#/components/schemas/SecurityFilterType'
+      required:
+      - type
+      - attributes
+      type: object
+    SecurityFilterCreateRequest:
+      description: Request object that includes the security filter that you would
+        like to create.
+      properties:
+        data:
+          $ref: '#/components/schemas/SecurityFilterCreateData'
+      required:
+      - data
+      type: object
+    SecurityFilterDeleteResponse:
+      description: Response object which only includes the metadata.
+      properties:
+        meta:
+          $ref: '#/components/schemas/SecurityFilterMeta'
+      type: object
+    SecurityFilterExclusionFilter:
+      description: Exclusion filter for the security filter.
+      example:
+        name: Exclude staging
+        query: source:staging
+      properties:
+        name:
+          description: Exclusion filter name.
+          example: Exclude staging
+          type: string
+        query:
+          description: Exclusion filter query. Logs that match this query are excluded
+            from the security filter.
+          example: source:staging
+          type: string
+      required:
+      - name
+      - query
+      type: object
+    SecurityFilterExclusionFilterResponse:
+      description: A single exclusion filter.
+      properties:
+        name:
+          description: The exclusion filter name.
+          example: Exclude staging
+          type: string
+        query:
+          description: The exclusion filter query.
+          example: source:staging
+          type: string
+      type: object
+    SecurityFilterFilteredDataType:
+      description: The filtered data type.
+      enum:
+      - logs
+      example: logs
+      type: string
+      x-enum-varnames:
+      - LOGS
+    SecurityFilterID:
+      description: The ID of the security filter.
+      example: 3dd-0uc-h1s
+      type: string
+    SecurityFilterMeta:
+      description: Optional metadata associated to the response.
+      properties:
+        warning:
+          description: A warning message.
+          example: All the security filters are disabled. As a result, no logs are
+            being analyzed.
+          type: string
+      type: object
+    SecurityFilterResponse:
+      description: Response object which includes a single security filter.
+      properties:
+        data:
+          $ref: '#/components/schemas/SecurityFilter'
+        meta:
+          $ref: '#/components/schemas/SecurityFilterMeta'
+      type: object
+    SecurityFilterType:
+      default: security_filters
+      description: The type of the resource. The value should always be `security_filters`.
+      enum:
+      - security_filters
+      example: security_filters
+      type: string
+      x-enum-varnames:
+      - SECURITY_FILTERS
+    SecurityFilterUpdateAttributes:
+      description: The security filters properties to be updated.
+      properties:
+        exclusion_filters:
+          description: Exclusion filters to exclude some logs from the security filter.
+          example: []
+          items:
+            $ref: '#/components/schemas/SecurityFilterExclusionFilter'
+          type: array
+        filtered_data_type:
+          $ref: '#/components/schemas/SecurityFilterFilteredDataType'
+        is_enabled:
+          description: Whether the security filter is enabled.
+          example: true
+          type: boolean
+        name:
+          description: The name of the security filter.
+          example: Custom security filter
+          type: string
+        query:
+          description: The query of the security filter.
+          example: service:api
+          type: string
+        version:
+          description: The version of the security filter to update.
+          example: 1
+          format: int32
+          maximum: 2147483647
+          type: integer
+      type: object
+    SecurityFilterUpdateData:
+      description: The new security filter properties.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/SecurityFilterUpdateAttributes'
+        type:
+          $ref: '#/components/schemas/SecurityFilterType'
+      required:
+      - type
+      - attributes
+      type: object
+    SecurityFilterUpdateRequest:
+      description: The new security filter body.
+      properties:
+        data:
+          $ref: '#/components/schemas/SecurityFilterUpdateData'
+      required:
+      - data
+      type: object
+    SecurityFiltersResponse:
+      description: All the available security filters objects.
+      properties:
+        data:
+          description: A list of security filters objects.
+          items:
+            $ref: '#/components/schemas/SecurityFilter'
+          type: array
+        meta:
+          $ref: '#/components/schemas/SecurityFilterMeta'
+      type: object
     SecurityMonitoringFilter:
       description: The rule's suppression filter.
       properties:
@@ -7310,6 +7552,168 @@ paths:
       x-menu-order: 10
       x-undo:
         type: safe
+  /api/v2/security_monitoring/configuration/security_filters:
+    get:
+      description: Get the list of configured security filters with their definitions.
+      operationId: ListSecurityFilters
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SecurityFiltersResponse'
+          description: OK
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Get all security filters
+      tags:
+      - Security Monitoring
+      x-undo:
+        type: safe
+    post:
+      description: 'Create a security filter.
+
+
+        See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
+
+        for more examples.'
+      operationId: CreateSecurityFilter
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SecurityFilterCreateRequest'
+        description: The definition of the new security filter.
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SecurityFilterResponse'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '409':
+          $ref: '#/components/responses/ConflictResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Create a security filter
+      tags:
+      - Security Monitoring
+      x-codegen-request-body-name: body
+      x-given:
+        security_filter:
+          parameters:
+          - name: body
+            value: "{\n  \"data\": {\n    \"type\": \"security_filters\",\n    \"\
+              attributes\": {\n      \"name\": \"{{ unique }}\",\n      \"query\"\
+              : \"service:{{ unique_alnum }}\",\n      \"exclusion_filters\":[\n \
+              \       {\n          \"name\": \"Exclude logs from staging\",\n    \
+              \      \"query\": \"source:staging\"\n        }\n     ],\n      \"filtered_data_type\"\
+              :\"logs\",\n      \"is_enabled\": true\n     }\n  }\n}"
+          step: there is a valid "security_filter" in the system
+      x-undo:
+        operationId: DeleteSecurityFilter
+        parameters:
+        - name: security_filter_id
+          source: data.id
+        type: unsafe
+  /api/v2/security_monitoring/configuration/security_filters/{security_filter_id}:
+    delete:
+      description: Delete a specific security filter.
+      operationId: DeleteSecurityFilter
+      parameters:
+      - $ref: '#/components/parameters/SecurityFilterID'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SecurityFilterDeleteResponse'
+          description: OK
+        '204':
+          description: No Content
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Delete a security filter
+      tags:
+      - Security Monitoring
+      x-undo:
+        type: idempotent
+    get:
+      description: 'Get the details of a specific security filter.
+
+
+        See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)
+
+        for more examples.'
+      operationId: GetSecurityFilter
+      parameters:
+      - $ref: '#/components/parameters/SecurityFilterID'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SecurityFilterResponse'
+          description: OK
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Get a security filter
+      tags:
+      - Security Monitoring
+      x-undo:
+        type: safe
+    patch:
+      description: 'Update a specific security filter.
+
+        Returns the security filter object when the request is successful.'
+      operationId: UpdateSecurityFilter
+      parameters:
+      - $ref: '#/components/parameters/SecurityFilterID'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SecurityFilterUpdateRequest'
+        description: New definition of the security filter.
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SecurityFilterResponse'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '409':
+          $ref: '#/components/responses/ConcurrentModificationResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Update a security filter
+      tags:
+      - Security Monitoring
+      x-codegen-request-body-name: body
+      x-undo:
+        type: idempotent
   /api/v2/security_monitoring/rules:
     get:
       description: List rules.
@@ -7968,6 +8372,7 @@ paths:
         name: user_invitation_uuid
         required: true
         schema:
+          example: 00000000-0000-0000-0000-000000000000
           type: string
       responses:
         '200':
@@ -8017,6 +8422,7 @@ paths:
         required: false
         schema:
           default: name
+          example: name
           type: string
       - description: 'Direction of sort. Options: `asc`, `desc`.'
         in: query
@@ -8039,6 +8445,7 @@ paths:
         name: filter[status]
         required: false
         schema:
+          example: Active
           type: string
       responses:
         '200':