datadog_api_client 2.39.0 → 2.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82cd72afe2617f90cf778209f83c74eb17d0bf121ba6ea36bde868468d6fdf90
-  data.tar.gz: eea54c08621a2eaec3908445d866b037783f61f265f1ee326109417cb9737cd7
+  metadata.gz: 72f8efb930062e680b372eea8ef140f2b47ade1edc94cc9b5fb2aaa69282c983
+  data.tar.gz: 8e6484887c8620eacb952573af4541c3307ca46a8430cbe41b6b91bdd583dc86
 SHA512:
-  metadata.gz: 1c91c6efb5da17a3421e8bf7bd9854027bb2903965fd42412486c124bc22e525020a810796505a78057f95d42bde21ed9c217a8cd8979fab1dbdf3181f867e27
-  data.tar.gz: 79969164358190acf0d04a0777df448cf5976db548f9c021deebf82c25f6f4322157c6c198cbf47d0695c5386a35e51606f138453cb6aa11436c11798a554792
+  metadata.gz: 29d9306386f7a9f27d3bf416fb74a02aabcfefd0c9dc9a4e4162ded8a2f2a98acdc57b1dd166ebd29cf52811fd8aff2dbef15f7ca5db98f6835dafa896205fb8
+  data.tar.gz: 2ba5dd0ad0d2918121eef1349da113c27fa645f23e221937d106398858c1ef9564b8e1d9b45e09d863670208bf578c32751fe2adb5efaf9efe09e927a6bbee71

data/.generated-info

@@ -1,4 +1,4 @@
 {
-  "spec_repo_commit": "bb240c6",
-  "generated": "2025-07-14 18:16:06.328"
+  "spec_repo_commit": "6d9663b",
+  "generated": "2025-08-27 16:37:46.678"
 }

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

@@ -5123,6 +5123,12 @@ components:
         error:
           $ref: '#/components/schemas/LogsAPIError'
       type: object
+    LogsAPILimitReachedResponse:
+      description: Response returned by the Logs API when the max limit has been reached.
+      properties:
+        error:
+          $ref: '#/components/schemas/LogsAPIError'
+      type: object
     LogsArithmeticProcessor:
       description: "Use the Arithmetic Processor to add a new attribute (without spaces
         or special characters\nin the new attribute name) to a log with the result
@@ -5547,6 +5553,72 @@ components:
       type: string
       x-enum-varnames:
       - DATE_REMAPPER
+    LogsDecoderProcessor:
+      description: 'The decoder processor decodes any source attribute containing
+        a
+
+        base64/base16-encoded UTF-8/ASCII string back to its original value, storing
+        the
+
+        result in a target attribute.'
+      properties:
+        binary_to_text_encoding:
+          $ref: '#/components/schemas/LogsDecoderProcessorBinaryToTextEncoding'
+        input_representation:
+          $ref: '#/components/schemas/LogsDecoderProcessorInputRepresentation'
+        is_enabled:
+          default: false
+          description: Whether the processor is enabled.
+          type: boolean
+        name:
+          description: Name of the processor.
+          type: string
+        source:
+          description: Name of the log attribute with the encoded data.
+          example: encoded.field
+          type: string
+        target:
+          description: Name of the log attribute that contains the decoded data.
+          example: decoded.field
+          type: string
+        type:
+          $ref: '#/components/schemas/LogsDecoderProcessorType'
+      required:
+      - source
+      - target
+      - binary_to_text_encoding
+      - input_representation
+      - type
+      type: object
+    LogsDecoderProcessorBinaryToTextEncoding:
+      description: The encoding used to represent the binary data.
+      enum:
+      - base64
+      - base16
+      example: base64
+      type: string
+      x-enum-varnames:
+      - BASE64
+      - BASE16
+    LogsDecoderProcessorInputRepresentation:
+      description: The original representation of input string.
+      enum:
+      - utf_8
+      - integer
+      example: utf_8
+      type: string
+      x-enum-varnames:
+      - UTF_8
+      - INTEGER
+    LogsDecoderProcessorType:
+      default: decoder-processor
+      description: Type of logs decoder processor.
+      enum:
+      - decoder-processor
+      example: decoder-processor
+      type: string
+      x-enum-varnames:
+      - DECODER_PROCESSOR
     LogsExclusion:
       description: Represents the index exclusion filter object from configuration
         API.
@@ -6215,6 +6287,7 @@ components:
       - $ref: '#/components/schemas/LogsTraceRemapper'
       - $ref: '#/components/schemas/LogsSpanRemapper'
       - $ref: '#/components/schemas/LogsArrayProcessor'
+      - $ref: '#/components/schemas/LogsDecoderProcessor'
     LogsQueryCompute:
       description: Define computation for a log query.
       properties:
@@ -14340,6 +14413,11 @@ components:
         extractedValuesFromScript:
           description: Generate variables using JavaScript.
           type: string
+        id:
+          description: ID of the step.
+          example: abc-def-123
+          readOnly: true
+          type: string
         isCritical:
           description: 'Determines whether or not to consider the entire test as failed
             if this step fails.
@@ -14396,6 +14474,11 @@ components:
     SyntheticsAPIWaitStep:
       description: The Wait step used in a Synthetic multi-step API test.
       properties:
+        id:
+          description: ID of the step.
+          example: abc-def-123
+          readOnly: true
+          type: string
         name:
           description: The name of the step.
           example: Example step name
@@ -15623,6 +15706,10 @@ components:
             type: string
           description: Variables to replace in the test.
           type: object
+        version:
+          description: The version number of the Synthetic test version to trigger.
+          format: int64
+          type: integer
       required:
       - public_id
       type: object
@@ -17197,7 +17284,7 @@ components:
       description: Object describing the extra options for a Synthetic test.
       properties:
         accept_self_signed:
-          description: 'For SSL test, whether or not the test should allow self signed
+          description: 'For SSL tests, whether or not the test should allow self signed
 
             certificates.'
           type: boolean
@@ -17206,7 +17293,7 @@ components:
             test.
           type: boolean
         checkCertificateRevocation:
-          description: For SSL test, whether or not the test should fail on revoked
+          description: For SSL tests, whether or not the test should fail on revoked
             certificate in stapled OCSP.
           type: boolean
         ci:
@@ -17217,6 +17304,10 @@ components:
           items:
             $ref: '#/components/schemas/SyntheticsDeviceID'
           type: array
+        disableAiaIntermediateFetching:
+          description: For SSL tests, whether or not the test should disable fetching
+            intermediate certificates from AIA.
+          type: boolean
         disableCors:
           description: Whether or not to disable CORS mechanism.
           type: boolean
@@ -17460,6 +17551,9 @@ components:
           description: A protobuf file that needs to be gzipped first then base64
             encoded.
           type: string
+        disableAiaIntermediateFetching:
+          description: Disable fetching intermediate certificates from AIA.
+          type: boolean
         dnsServer:
           description: DNS server to use for DNS tests.
           type: string
@@ -18888,6 +18982,14 @@ components:
           description: The total account usage.
           format: int64
           type: integer
+        account_committed_usage:
+          description: The total account committed usage.
+          format: int64
+          type: integer
+        account_on_demand_usage:
+          description: The total account on-demand usage.
+          format: int64
+          type: integer
         elapsed_usage_hours:
           description: Elapsed usage hours for some billable product.
           format: int64
@@ -20685,6 +20787,21 @@ components:
             hours in the current date for the given org.
           format: int64
           type: integer
+        event_management_correlation_correlated_events_sum:
+          description: Shows the sum of all Event Management correlated events over
+            all hours in the current date for all organizations.
+          format: int64
+          type: integer
+        event_management_correlation_correlated_related_events_sum:
+          description: Shows the sum of all Event Management correlated related events
+            over all hours in the current date for all organizations.
+          format: int64
+          type: integer
+        event_management_correlation_sum:
+          description: Shows the sum of all Event Management correlations over all
+            hours in the current date for all organizations.
+          format: int64
+          type: integer
         fargate_container_profiler_profiling_fargate_avg:
           description: The average number of Profiling Fargate tasks over all hours
             in the current date for all organizations.
@@ -20720,6 +20837,11 @@ components:
             over all hours in the current date for the given org.
           format: int64
           type: integer
+        flex_logs_compute_xlarge_avg:
+          description: Shows the average number of Flex Logs Compute Extra Large Instances
+            over all hours in the current date for the given org.
+          format: int64
+          type: integer
         flex_logs_compute_xsmall_avg:
           description: Shows the average number of Flex Logs Compute Extra Small Instances
             over all hours in the current date for the given org.
@@ -21615,6 +21737,21 @@ components:
             hours in the current date for the given org.
           format: int64
           type: integer
+        event_management_correlation_correlated_events_sum:
+          description: Shows the sum of all Event Management correlated events over
+            all hours in the current date for the given org.
+          format: int64
+          type: integer
+        event_management_correlation_correlated_related_events_sum:
+          description: Shows the sum of all Event Management correlated related events
+            over all hours in the current date for the given org.
+          format: int64
+          type: integer
+        event_management_correlation_sum:
+          description: Shows the sum of all Event Management correlations over all
+            hours in the current date for the given org.
+          format: int64
+          type: integer
         fargate_container_profiler_profiling_fargate_avg:
           description: The average number of Profiling Fargate tasks over all hours
             in the current month for the given org.
@@ -21649,6 +21786,11 @@ components:
             over all hours in the current date for the given org.
           format: int64
           type: integer
+        flex_logs_compute_xlarge_avg:
+          description: Shows the average number of Flex Logs Compute Extra Large Instances
+            over all hours in the current date for the given org.
+          format: int64
+          type: integer
         flex_logs_compute_xsmall_avg:
           description: Shows the average number of Flex Logs Compute Extra Small Instances
             over all hours in the current date for the given org.
@@ -22550,6 +22692,21 @@ components:
             hours in the current month for all organizations.
           format: int64
           type: integer
+        event_management_correlation_agg_sum:
+          description: Shows the sum of all Event Management correlations over all
+            hours in the current month for all organizations.
+          format: int64
+          type: integer
+        event_management_correlation_correlated_events_agg_sum:
+          description: Shows the sum of all Event Management correlated events over
+            all hours in the current month for all organizations.
+          format: int64
+          type: integer
+        event_management_correlation_correlated_related_events_agg_sum:
+          description: Shows the sum of all Event Management correlated related events
+            over all hours in the current month for all organizations.
+          format: int64
+          type: integer
         fargate_container_profiler_profiling_fargate_avg_sum:
           description: The average number of Profiling Fargate tasks over all hours
             in the current month for all organizations.
@@ -22585,6 +22742,11 @@ components:
             over all hours in the current months for all organizations.
           format: int64
           type: integer
+        flex_logs_compute_xlarge_avg_sum:
+          description: Shows the average number of Flex Logs Compute Extra Large Instances
+            over all hours in the current months for all organizations.
+          format: int64
+          type: integer
         flex_logs_compute_xsmall_avg_sum:
           description: Shows the average number of Flex Logs Compute Extra Small Instances
             over all hours in the current months for all organizations.
@@ -24012,6 +24174,9 @@ components:
       additionalProperties: false
       description: Wrapper for live span
       properties:
+        hide_incomplete_cost_data:
+          description: Whether to hide incomplete cost data in the widget.
+          type: boolean
         live_span:
           $ref: '#/components/schemas/WidgetLiveSpan'
       type: object
@@ -24212,6 +24377,9 @@ components:
           format: int64
           minimum: 0
           type: integer
+        hide_incomplete_cost_data:
+          description: Whether to hide incomplete cost data in the widget.
+          type: boolean
         to:
           description: End time in seconds since epoch.
           example: 1712083128
@@ -24236,6 +24404,9 @@ components:
     WidgetNewLiveSpan:
       description: Used for arbitrary live span times, such as 17 minutes or 6 hours.
       properties:
+        hide_incomplete_cost_data:
+          description: Whether to hide incomplete cost data in the widget.
+          type: boolean
         type:
           $ref: '#/components/schemas/WidgetNewLiveSpanType'
         unit:
@@ -24523,6 +24694,8 @@ components:
             code_analysis_read: View Code Analysis.
             continuous_profiler_pgo_read: Read and query Continuous Profiler data
               for Profile-Guided Optimization (PGO).
+            coterm_read: Read terminal recordings.
+            coterm_write: Write terminal recordings.
             create_webhooks: Create webhooks integrations.
             dashboards_embed_share: Create, modify, and delete shared dashboards with
               share type 'embed'.
@@ -24559,10 +24732,6 @@ components:
             security_monitoring_filters_write: Create, edit, and delete Security Filters.
             security_monitoring_findings_read: View a list of findings that include
               both misconfigurations and identity risks.
-            security_monitoring_notification_profiles_read: View Rule Security Notification
-              rules.
-            security_monitoring_notification_profiles_write: Create, edit, and delete
-              Security Notification rules.
             security_monitoring_rules_read: Read Detection Rules.
             security_monitoring_rules_write: Create and edit Detection Rules.
             security_monitoring_signals_read: View Security Signals.
@@ -25768,6 +25937,10 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - dashboards_public_share
+      - AuthZ:
+        - dashboards_embed_share
+      - AuthZ:
+        - dashboards_invite_share
       summary: Create a shared dashboard
       tags:
       - Dashboards
@@ -25776,6 +25949,8 @@ paths:
         operator: OR
         permissions:
         - dashboards_public_share
+        - dashboards_embed_share
+        - dashboards_invite_share
   /api/v1/dashboard/public/{token}:
     delete:
       description: Revoke the public URL for a dashboard (rendering it private) associated
@@ -25814,6 +25989,10 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - dashboards_public_share
+      - AuthZ:
+        - dashboards_embed_share
+      - AuthZ:
+        - dashboards_invite_share
       summary: Revoke a shared dashboard URL
       tags:
       - Dashboards
@@ -25821,6 +26000,8 @@ paths:
         operator: OR
         permissions:
         - dashboards_public_share
+        - dashboards_embed_share
+        - dashboards_invite_share
     get:
       description: Fetch an existing shared dashboard's sharing metadata associated
         with the specified token.
@@ -25931,6 +26112,10 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - dashboards_public_share
+      - AuthZ:
+        - dashboards_embed_share
+      - AuthZ:
+        - dashboards_invite_share
       summary: Update a shared dashboard
       tags:
       - Dashboards
@@ -25939,6 +26124,8 @@ paths:
         operator: OR
         permissions:
         - dashboards_public_share
+        - dashboards_embed_share
+        - dashboards_invite_share
   /api/v1/dashboard/public/{token}/invitation:
     delete:
       description: Revoke previously sent invitation emails and active sessions used
@@ -25986,7 +26173,7 @@ paths:
       - apiKeyAuth: []
         appKeyAuth: []
       - AuthZ:
-        - dashboards_public_share
+        - dashboards_invite_share
       summary: Revoke shared dashboard invitations
       tags:
       - Dashboards
@@ -25994,7 +26181,7 @@ paths:
       x-permission:
         operator: OR
         permissions:
-        - dashboards_public_share
+        - dashboards_invite_share
     get:
       description: Describe the invitations that exist for the given shared dashboard
         (paginated).
@@ -26045,14 +26232,14 @@ paths:
       - apiKeyAuth: []
         appKeyAuth: []
       - AuthZ:
-        - dashboards_public_share
+        - dashboards_invite_share
       summary: Get all invitations for a shared dashboard
       tags:
       - Dashboards
       x-permission:
         operator: OR
         permissions:
-        - dashboards_public_share
+        - dashboards_invite_share
     post:
       description: Send emails to specified email addresses containing links to access
         a given authenticated shared dashboard. Email addresses must already belong
@@ -26110,7 +26297,7 @@ paths:
       - apiKeyAuth: []
         appKeyAuth: []
       - AuthZ:
-        - dashboards_public_share
+        - dashboards_invite_share
       summary: Send shared dashboard invitation email
       tags:
       - Dashboards
@@ -26118,7 +26305,7 @@ paths:
       x-permission:
         operator: OR
         permissions:
-        - dashboards_public_share
+        - dashboards_invite_share
   /api/v1/dashboard/{dashboard_id}:
     delete:
       description: Delete a dashboard using the specified ID.
@@ -29147,6 +29334,10 @@ paths:
           description: Authentication error
         '429':
           $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ: []
       summary: Search logs
       tags:
       - Logs
@@ -29245,10 +29436,6 @@ paths:
           description: Forbidden
         '429':
           $ref: '#/components/responses/TooManyRequestsResponse'
-      security:
-      - apiKeyAuth: []
-        appKeyAuth: []
-      - AuthZ: []
       summary: Get all indexes
       tags:
       - Logs Indexes
@@ -29286,6 +29473,12 @@ paths:
               schema:
                 $ref: '#/components/schemas/APIErrorResponse'
           description: Forbidden
+        '422':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/LogsAPILimitReachedResponse'
+          description: Unprocessable Entity
         '429':
           $ref: '#/components/responses/TooManyRequestsResponse'
       summary: Create an index
@@ -30452,7 +30645,7 @@ paths:
       - apiKeyAuth: []
         appKeyAuth: []
       - AuthZ:
-        - monitors_write
+        - monitors_read
       summary: Validate a monitor
       tags:
       - Monitors
@@ -30460,7 +30653,7 @@ paths:
       x-permission:
         operator: OR
         permissions:
-        - monitors_write
+        - monitors_read
   /api/v1/monitor/{monitor_id}:
     delete:
       description: Delete the specified monitor
@@ -30753,7 +30946,7 @@ paths:
       - apiKeyAuth: []
         appKeyAuth: []
       - AuthZ:
-        - monitors_write
+        - monitors_read
       summary: Validate an existing monitor
       tags:
       - Monitors
@@ -30761,7 +30954,7 @@ paths:
       x-permission:
         operator: OR
         permissions:
-        - monitors_write
+        - monitors_read
   /api/v1/monthly_custom_reports:
     get:
       deprecated: true
@@ -31621,13 +31814,15 @@ paths:
       security:
       - apiKeyAuth: []
         appKeyAuth: []
-      - AuthZ: []
+      - AuthZ:
+        - metrics_read
       summary: Search metrics
       tags:
       - Metrics
       x-permission:
-        operator: OPEN
-        permissions: []
+        operator: OR
+        permissions:
+        - metrics_read
   /api/v1/security_analytics/signals/{signal_id}/add_to_incident:
     patch:
       description: Add a security signal to an incident. This makes it possible to
@@ -31680,7 +31875,9 @@ paths:
         - security_monitoring_signals_write
   /api/v1/security_analytics/signals/{signal_id}/assignee:
     patch:
-      description: Modify the triage assignee of a security signal.
+      deprecated: true
+      description: This endpoint is deprecated - Modify the triage assignee of a security
+        signal.
       operationId: EditSecurityMonitoringSignalAssignee
       parameters:
       - $ref: '#/components/parameters/SignalID'
@@ -31728,7 +31925,9 @@ paths:
         - security_monitoring_signals_write
   /api/v1/security_analytics/signals/{signal_id}/state:
     patch:
-      description: Change the triage state of a security signal.
+      deprecated: true
+      description: This endpoint is deprecated - Change the triage state of a security
+        signal.
       operationId: EditSecurityMonitoringSignalState
       parameters:
       - $ref: '#/components/parameters/SignalID'
@@ -33794,6 +33993,12 @@ paths:
       description: Search for Synthetic tests and Test Suites.
       operationId: SearchTests
       parameters:
+      - description: The search query.
+        in: query
+        name: text
+        required: false
+        schema:
+          type: string
       - description: If true, include the full configuration for each test in the
           response.
         in: query
@@ -33829,7 +34034,7 @@ paths:
           default: 50
           format: int64
           type: integer
-      - description: The sort order for the results (e.g., 'name,asc' or 'name,desc').
+      - description: The sort order for the results (e.g., `name,asc` or `name,desc`).
         in: query
         name: sort
         required: false
@@ -34309,6 +34514,8 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - synthetics_global_variable_read
+      - AuthZ:
+        - apm_api_catalog_read
       summary: Get all global variables
       tags:
       - Synthetics
@@ -34316,6 +34523,7 @@ paths:
         operator: OR
         permissions:
         - synthetics_global_variable_read
+        - apm_api_catalog_read
     post:
       description: Create a Synthetic global variable.
       operationId: CreateGlobalVariable
@@ -37527,13 +37735,18 @@ tags:
 - description: Get a list of IP prefixes belonging to Datadog.
   name: IP Ranges
 - description: 'Manage your Datadog API and application keys. You need an API key
-    and
+    and an
+
+    application key for a user with the required permissions to interact with these
+    endpoints.
+
+
+    Consult the following pages to view and manage your keys:
 
-    an application key for a user with the required permissions to interact
 
-    with these endpoints. The full list of API and application keys can be
+    - [API Keys](https://app.datadoghq.com/organization-settings/api-keys)
 
-    seen on your [Datadog API page](https://app.datadoghq.com/account/settings#api).'
+    - [Application Keys](https://app.datadoghq.com/personal-settings/application-keys)'
   externalDocs:
     description: Find out more at
     url: https://docs.datadoghq.com/account_management/api-app-keys/