datadog_api_client 2.42.0 → 2.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89b824a5b4aa2800b04212b73ad0c60c432b87ffe4c0d2feef64b2653bc9666f
-  data.tar.gz: 035abe3532c2240a3e7f4947ee70adab673f88a200dd285f6a4e0c3b7af297b3
+  metadata.gz: 7f48725290c6affbbffeeb9cb0d08776eddff7eb6182c086b861ae2461a9eca9
+  data.tar.gz: af6f30400bb85566b5ddd5533e1bc41839b8bd7b9587a4cb2072e33a374746c0
 SHA512:
-  metadata.gz: 58979e61f1173f32ce514773ee121263b7e4feb14e48e1bd5e4eec145368a22070b84efe5fa284ecde0b9bcc264fb3bc2576018f5d5b84c5fef67fd68126cf5d
-  data.tar.gz: d88b7aedc49c92ed65e235114e801599ebb80832b631867377c8d440d17deba3dc2f1166d036a934a4823e95c75e41315294fc939c737301bd06d532f2b048ea
+  metadata.gz: 2e6379d442bebef4fa70af12ef6ab4b196083f19b487fc6df2f18720798917ee0d6198c0bea64e5d3c7b32fe4b9520c637d561fd266727ac95ff0de64c4c5519
+  data.tar.gz: 711238e51fc6dac110878400ff2841bfce74deacf9bfc086d37e2ae00eee05d9697b36c7c0d11b37d9a1a6b7419beae710b748faec94cb87405442368cba4002

data/.generator/schemas/v1/openapi.yaml

@@ -2875,6 +2875,7 @@ components:
       - ci_tests
       - ci_pipelines
       - incident_analytics
+      - product_analytics
       example: logs
       type: string
       x-enum-varnames:
@@ -2889,6 +2890,7 @@ components:
       - CI_TESTS
       - CI_PIPELINES
       - INCIDENT_ANALYTICS
+      - PRODUCT_ANALYTICS
     FormulaAndFunctionMetricAggregation:
       description: The aggregation methods available for metrics queries.
       enum:
@@ -3200,10 +3202,8 @@ components:
       - value
       type: object
     FunnelWidgetDefinition:
-      description: 'The funnel visualization displays a funnel of user sessions that
+      description: The funnel visualization displays a funnel of user sessions that
         maps a sequence of view navigation and user interaction in your application.
-
-        '
       properties:
         requests:
           description: Request payload used to query items.
@@ -4893,9 +4893,7 @@ components:
       description: 'The list stream visualization displays a table of recent events
         in your application that
 
-        match a search criteria using user-defined columns.
-
-        '
+        match a search criteria using user-defined columns.'
       properties:
         legend_size:
           $ref: '#/components/schemas/WidgetLegendSize'
@@ -5803,9 +5801,7 @@ components:
             line.
           example: 'rule_name_1 foo
 
-            rule_name_2 bar
-
-            '
+            rule_name_2 bar'
           type: string
         support_rules:
           default: ''
@@ -5813,9 +5809,7 @@ components:
             line.
           example: 'rule_name_1 foo
 
-            rule_name_2 bar
-
-            '
+            rule_name_2 bar'
           type: string
       required:
       - match_rules
@@ -6337,6 +6331,7 @@ components:
       - $ref: '#/components/schemas/LogsSpanRemapper'
       - $ref: '#/components/schemas/LogsArrayProcessor'
       - $ref: '#/components/schemas/LogsDecoderProcessor'
+      - $ref: '#/components/schemas/LogsSchemaProcessor'
     LogsQueryCompute:
       description: Define computation for a log query.
       properties:
@@ -6398,6 +6393,243 @@ components:
             periods.
           type: string
       type: object
+    LogsSchemaCategoryMapper:
+      description: "Use the Schema Category Mapper to categorize log event into enum
+        fields.\nIn the case of OCSF, they can be used to map sibling fields which
+        are composed of an ID and a name.\n\n**Notes**:\n\n- The syntax of the query
+        is the one of Logs Explorer search bar.\n  The query can be done on any log
+        attribute or tag, whether it is a facet or not.\n  Wildcards can also be used
+        inside your query.\n- Categories are executed in order and processing stops
+        at the first match.\n  Make sure categories are properly ordered in case a
+        log could match multiple queries.\n- Sibling fields always have a numerical
+        ID field and a human-readable string name.\n- A fallback section handles cases
+        where the name or ID value matches a specific value.\n  If the name matches
+        \"Other\" or the ID matches 99, the value of the sibling name field will be
+        pulled from a source field from the original log."
+      properties:
+        categories:
+          description: 'Array of filters to match or not a log and their
+
+            corresponding `name` to assign a custom value to the log.'
+          example:
+          - filter:
+              query: '@eventName:(ConsoleLogin OR ExternalIdPDirectoryLogin OR UserAuthentication
+                OR Authenticate)'
+            id: 1
+            name: Logon
+          - filter:
+              query: '@eventName:*'
+            id: 99
+            name: Other
+          items:
+            $ref: '#/components/schemas/LogsSchemaCategoryMapperCategory'
+          type: array
+        fallback:
+          $ref: '#/components/schemas/LogsSchemaCategoryMapperFallback'
+        name:
+          description: Name of the logs schema category mapper.
+          example: activity_id and activity_name
+          type: string
+        targets:
+          $ref: '#/components/schemas/LogsSchemaCategoryMapperTargets'
+        type:
+          $ref: '#/components/schemas/LogsSchemaCategoryMapperType'
+      required:
+      - categories
+      - targets
+      - type
+      - name
+      type: object
+    LogsSchemaCategoryMapperCategory:
+      description: Object describing the logs filter with corresponding category ID
+        and name assignment.
+      properties:
+        filter:
+          $ref: '#/components/schemas/LogsFilter'
+        id:
+          description: ID to inject into the category.
+          example: 1
+          format: int64
+          type: integer
+        name:
+          description: Value to assign to target schema field.
+          example: Password Change
+          type: string
+      required:
+      - filter
+      - id
+      - name
+      type: object
+    LogsSchemaCategoryMapperFallback:
+      description: Used to override hardcoded category values with a value pulled
+        from a source attribute on the log.
+      properties:
+        sources:
+          additionalProperties:
+            items:
+              type: string
+            type: array
+          description: Fallback sources used to populate value of field.
+          example: {}
+          type: object
+        values:
+          additionalProperties:
+            type: string
+          description: Values that define when the fallback is used.
+          example: {}
+          type: object
+      type: object
+    LogsSchemaCategoryMapperTargets:
+      description: Name of the target attributes which value is defined by the matching
+        category.
+      properties:
+        id:
+          description: ID of the field to map log attributes to.
+          example: ocsf.activity_id
+          type: string
+        name:
+          description: Name of the field to map log attributes to.
+          example: ocsf.activity_name
+          type: string
+      type: object
+    LogsSchemaCategoryMapperType:
+      description: Type of logs schema category mapper.
+      enum:
+      - schema-category-mapper
+      example: schema-category-mapper
+      type: string
+      x-enum-varnames:
+      - SCHEMA_CATEGORY_MAPPER
+    LogsSchemaData:
+      description: Configuration of the schema data to use.
+      properties:
+        class_name:
+          description: Class name of the schema to use.
+          example: Account Change
+          type: string
+        class_uid:
+          description: Class UID of the schema to use.
+          example: 3001
+          format: int64
+          type: integer
+        profiles:
+          description: Optional list of profiles to modify the schema.
+          example:
+          - security_control
+          - host
+          items:
+            type: string
+          type: array
+        schema_type:
+          description: Type of schema to use.
+          example: ocsf
+          type: string
+        version:
+          description: Version of the schema to use.
+          example: 1.5.0
+          type: string
+      required:
+      - schema_type
+      - version
+      - class_uid
+      - class_name
+      type: object
+    LogsSchemaMapper:
+      description: Configuration of the schema processor mapper to use.
+      oneOf:
+      - $ref: '#/components/schemas/LogsSchemaRemapper'
+      - $ref: '#/components/schemas/LogsSchemaCategoryMapper'
+    LogsSchemaProcessor:
+      description: A processor that has additional validations and checks for a given
+        schema. Currently supported schema types include OCSF.
+      properties:
+        is_enabled:
+          default: false
+          description: Whether or not the processor is enabled.
+          type: boolean
+        mappers:
+          description: The `LogsSchemaProcessor` `mappers`.
+          example:
+          - name: Map userIdentity to ocsf.user.uid
+            sources:
+            - userIdentity.principalId
+            target: ocsf.user.uid
+            type: schema-remapper
+          items:
+            $ref: '#/components/schemas/LogsSchemaMapper'
+          type: array
+        name:
+          description: Name of the processor.
+          example: Map additionalEventData.LoginTo to ocsf.dst_endpoint.svc_name
+          type: string
+        schema:
+          $ref: '#/components/schemas/LogsSchemaData'
+        type:
+          $ref: '#/components/schemas/LogsSchemaProcessorType'
+      required:
+      - name
+      - mappers
+      - type
+      - schema
+      type: object
+    LogsSchemaProcessorType:
+      default: schema-processor
+      description: Type of logs schema processor.
+      enum:
+      - schema-processor
+      example: schema-processor
+      type: string
+      x-enum-varnames:
+      - SCHEMA_PROCESSOR
+    LogsSchemaRemapper:
+      description: The schema remapper maps source log fields to their correct fields.
+      properties:
+        name:
+          description: Name of the logs schema remapper.
+          example: Map userIdentity.principalId, responseElements.role.roleId, responseElements.user.userId
+            to ocsf.user.uid
+          type: string
+        override_on_conflict:
+          default: false
+          description: Override or not the target element if already set.
+          type: boolean
+        preserve_source:
+          default: false
+          description: Remove or preserve the remapped source element.
+          type: boolean
+        sources:
+          description: Array of source attributes.
+          example:
+          - userIdentity.principalId
+          - responseElements.role.roleId
+          - responseElements.user.userId
+          items:
+            description: Attribute used as a source to remap its value to the target
+              attribute.
+            type: string
+          type: array
+        target:
+          description: Target field to map log source field to.
+          example: ocsf.user.uid
+          type: string
+        target_format:
+          $ref: '#/components/schemas/TargetFormatType'
+        type:
+          $ref: '#/components/schemas/LogsSchemaRemapperType'
+      required:
+      - name
+      - sources
+      - target
+      - type
+      type: object
+    LogsSchemaRemapperType:
+      description: Type of logs schema remapper.
+      enum:
+      - schema-remapper
+      example: schema-remapper
+      type: string
+      x-enum-varnames:
+      - SCHEMA_REMAPPER
     LogsServiceRemapper:
       description: 'Use this processor if you want to assign one or more attributes
         as the official service.
@@ -7132,9 +7364,7 @@ components:
 
 
         This field is in preview. The draft value is only available to customers with
-        the feature enabled.
-
-        '
+        the feature enabled.'
       enum:
       - draft
       - published
@@ -9580,7 +9810,7 @@ components:
                 text: '## Some test markdown
 
 
-                  ```js
+                  ```
 
                   var x, y;
 
@@ -9654,6 +9884,8 @@ components:
       type: object
     NotebookGlobalTime:
       description: Notebook global timeframe.
+      example:
+        live_span: 1h
       oneOf:
       - $ref: '#/components/schemas/NotebookRelativeTime'
       - $ref: '#/components/schemas/NotebookAbsoluteTime'
@@ -9822,7 +10054,7 @@ components:
                 text: '## Some test markdown
 
 
-                  ```js
+                  ```
 
                   var x, y;
 
@@ -9982,7 +10214,7 @@ components:
                 text: '## Some test markdown
 
 
-                  ```js
+                  ```
 
                   var x, y;
 
@@ -14024,9 +14256,7 @@ components:
       - LG
     SplitGraphWidgetDefinition:
       description: 'The split graph widget allows you to create repeating units of
-        a graph - one for each value in a group (for example: one per service)
-
-        '
+        a graph - one for each value in a group (for example: one per service)'
       properties:
         has_uniform_y_axes:
           description: Normalize y axes across graphs
@@ -14830,6 +15060,7 @@ components:
     SyntheticsAssertionTargetValue:
       description: Value used by the operator in assertions. Can be either a number
         or string.
+      example: 0.0
       oneOf:
       - $ref: '#/components/schemas/SyntheticsAssertionTargetValueNumber'
       - $ref: '#/components/schemas/SyntheticsAssertionTargetValueString'
@@ -15144,9 +15375,7 @@ components:
 
             rkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtp
 
-            Z3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE
-
-            '
+            Z3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE'
           type: string
         type:
           $ref: '#/components/schemas/SyntheticsBasicAuthSigv4Type'
@@ -17341,6 +17570,11 @@ components:
           description: Allows loading insecure content for an HTTP request in an API
             test.
           type: boolean
+        blockedRequestPatterns:
+          description: Array of URL patterns to block.
+          items:
+            type: string
+          type: array
         checkCertificateRevocation:
           description: For SSL tests, whether or not the test should fail on revoked
             certificate in stapled OCSP.
@@ -24337,7 +24571,7 @@ components:
         display_type:
           description: "Combination of:\n  - A severity error, warning, ok, or info\n
             \ - A line type: dashed, solid, or bold\nIn this case of a Distribution
-            widget, this can be set to be `x_axis_percentile`.\n"
+            widget, this can be set to be `x_axis_percentile`."
           example: error dashed
           type: string
         label:
@@ -27252,7 +27486,11 @@ paths:
         Results are paginated with a max of 1000 results at a time.
 
         **Note:** If the host is an Amazon EC2 instance, `id` is replaced with `aws_id`
-        in the response.'
+        in the response.
+
+        **Note**: To enrich the data returned by this endpoint with security scans,
+        see the new [api/v2/security/scanned-assets-metadata](https://docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata)
+        endpoint.'
       operationId: ListHosts
       parameters:
       - description: String to filter search results.
@@ -34051,7 +34289,7 @@ paths:
         - synthetics_write
   /api/v1/synthetics/tests/search:
     get:
-      description: Search for Synthetic tests and Test Suites.
+      description: Search for Synthetic tests.
       operationId: SearchTests
       parameters:
       - description: The search query.
@@ -34067,12 +34305,6 @@ paths:
         required: false
         schema:
           type: boolean
-      - description: If true, returns suites instead of tests.
-        in: query
-        name: search_suites
-        required: false
-        schema:
-          type: boolean
       - description: If true, return only facets instead of full test details.
         in: query
         name: facets_only
@@ -37614,9 +37846,7 @@ paths:
                 summary: Multi Raw Messages
                 value: 'hello
 
-                  world
-
-                  '
+                  world'
               simple-raw-message:
                 description: 'Submit log string. Log attributes can be passed as query
                   parameters in the URL. This enables the addition of tags or the