datadog_api_client 2.30.0 → 2.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9af459549584cca07b18a0d073b14ab1d8919276e6f602b515ed620cee0b11ff
-  data.tar.gz: d35a5881de1d47a18f9ee0d4fe502d8b90345efb3a6a009778c49d464245f72f
+  metadata.gz: bf07414e021c91812a18c8340e904572b9a694f8f08e03c40a246266dd728cf5
+  data.tar.gz: 20dd8412640a0197a75ae4737663bdc430ab38c9e61a9d9dd82b17b8b4a66665
 SHA512:
-  metadata.gz: 1aacd466e55054a664df808540e46dc5c957fd15e0ecffbc8ad38a23dc44305ae170009a914a66707f94b8574ddbf8813ca48a1e345a5d32f357a478fb62f9b7
-  data.tar.gz: ab1cf82d5618199d1991608351bb017ca7c2c7dd0fcad8723a03d09c59211994e08a4557ac892113ca7f318557d737f38be0bbecf1bddb4aa60efa132547a42c
+  metadata.gz: a8027d3ef0b9be260236e9bb2216fb42649c436fe99642080c5b873d8e774d601a8e505ab614a4208061d97b46b2a306ba669b8604ddb30a0c47dd54afe46785
+  data.tar.gz: 05bf60ab43160d6d93d3e2b52e4ba7e2dba4ffb044e567af9d34cf011e1803bf08b6841004561b0217a49c686ac43f402e7140a0299f29bedc50d16cfcf52f73

data/.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-02-04 14:10:05.819748",
-            "spec_repo_commit": "4fb9047a"
+            "regenerated": "2025-03-11 13:16:50.144910",
+            "spec_repo_commit": "d7618fa5"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-02-04 14:10:05.835266",
-            "spec_repo_commit": "4fb9047a"
+            "regenerated": "2025-03-11 13:16:50.165212",
+            "spec_repo_commit": "d7618fa5"
         }
     }
 }

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

@@ -1034,7 +1034,7 @@ components:
       example: {}
       properties:
         ok:
-          description: An array of of Monitor IDs that can be safely deleted.
+          description: An array of Monitor IDs that can be safely deleted.
           items:
             description: ID of a monitor that can be safely deleted.
             format: int64
@@ -1057,7 +1057,7 @@ components:
       description: An array of service level objective objects.
       properties:
         ok:
-          description: An array of of SLO IDs that can be safely deleted.
+          description: An array of SLO IDs that can be safely deleted.
           items:
             description: An SLO ID.
             type: string
@@ -1451,11 +1451,13 @@ components:
       enum:
       - open
       - invite
+      - embed
       nullable: true
       type: string
       x-enum-varnames:
       - OPEN
       - INVITE
+      - EMBED
     DashboardSummary:
       description: Dashboard summary response.
       properties:
@@ -6049,6 +6051,7 @@ components:
       - $ref: '#/components/schemas/LogsLookupProcessor'
       - $ref: '#/components/schemas/ReferenceTableLogsLookupProcessor'
       - $ref: '#/components/schemas/LogsTraceRemapper'
+      - $ref: '#/components/schemas/LogsSpanRemapper'
     LogsQueryCompute:
       description: Define computation for a log query.
       properties:
@@ -6160,6 +6163,43 @@ components:
       x-enum-varnames:
       - TIME_ASCENDING
       - TIME_DESCENDING
+    LogsSpanRemapper:
+      description: "There are two ways to define correlation between application spans
+        and logs:\n\n  1. Follow the documentation on [how to inject a span ID in
+        the application logs](https://docs.datadoghq.com/tracing/connect_logs_and_traces).\n
+        \ Log integrations automatically handle all remaining setup steps by default.\n\n
+        \ 2. Use the span remapper processor to define a log attribute as its associated
+        span ID."
+      properties:
+        is_enabled:
+          default: false
+          description: Whether or not the processor is enabled.
+          type: boolean
+        name:
+          description: Name of the processor.
+          type: string
+        sources:
+          default:
+          - dd.span_id
+          description: Array of source attributes.
+          items:
+            description: Attribute to extract the span ID from.
+            type: string
+          type: array
+        type:
+          $ref: '#/components/schemas/LogsSpanRemapperType'
+      required:
+      - type
+      type: object
+    LogsSpanRemapperType:
+      default: span-id-remapper
+      description: Type of logs span remapper.
+      enum:
+      - span-id-remapper
+      example: span-id-remapper
+      type: string
+      x-enum-varnames:
+      - SPAN_ID_REMAPPER
     LogsStatusRemapper:
       description: "Use this Processor if you want to assign some attributes as the
         official status.\n\nEach incoming status value is mapped as follows.\n\n  -
@@ -6275,7 +6315,7 @@ components:
           - dd.trace_id
           description: Array of source attributes.
           items:
-            description: Attribute to extract the Trace ID from.
+            description: Attribute to extract the trace ID from.
             type: string
           type: array
         type:
@@ -7399,7 +7439,7 @@ components:
       properties:
         day_starts:
           description: The time of the day at which a one day cumulative evaluation
-            window starts. Must be defined in UTC time in `HH:mm` format.
+            window starts.
           example: 04:00
           type: string
         hour_starts:
@@ -7418,6 +7458,11 @@ components:
           maximum: 1
           minimum: 1
           type: integer
+        timezone:
+          description: The timezone of the time of the day of the cumulative evaluation
+            window start.
+          example: Europe/Paris
+          type: string
       type: object
     MonitorOverallStates:
       description: The different states your monitor can be in.
@@ -7506,6 +7551,9 @@ components:
           - handle: jane@datadoghq.com
             name: Jane Doe
           org_id: 1234
+          quality_issues:
+          - broken_at_handle
+          - noisy_monitor
           scopes:
           - '!availability-zone:us-east-1c'
           - name:cassandra
@@ -7605,6 +7653,14 @@ components:
           format: int64
           readOnly: true
           type: integer
+        quality_issues:
+          description: Quality issues detected with the monitor.
+          items:
+            description: A quality issue detected with the monitor.
+            readOnly: true
+            type: string
+          readOnly: true
+          type: array
         query:
           description: The monitor query.
           example: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100
@@ -9727,6 +9783,62 @@ components:
       items:
         $ref: '#/components/schemas/NotifyEndType'
       type: array
+    NumberFormatUnit:
+      description: Number format unit.
+      oneOf:
+      - $ref: '#/components/schemas/NumberFormatUnitCanonical'
+      - $ref: '#/components/schemas/NumberFormatUnitCustom'
+    NumberFormatUnitCanonical:
+      description: Canonical unit.
+      properties:
+        per_unit_name:
+          description: The name of the unit per item.
+          example: bytes
+          type: string
+        type:
+          $ref: '#/components/schemas/NumberFormatUnitScaleType'
+        unit_name:
+          description: The name of the unit.
+          example: bytes
+          type: string
+      type: object
+    NumberFormatUnitCustom:
+      description: Custom unit.
+      properties:
+        label:
+          description: The label for the custom unit.
+          maxLength: 12
+          minLength: 1
+          type: string
+        type:
+          $ref: '#/components/schemas/NumberFormatUnitCustomType'
+      type: object
+    NumberFormatUnitCustomType:
+      description: The type of custom unit.
+      enum:
+      - custom_unit_label
+      type: string
+      x-enum-varnames:
+      - CUSTOM_UNIT_LABEL
+    NumberFormatUnitScale:
+      description: The definition of `NumberFormatUnitScale` object.
+      nullable: true
+      properties:
+        type:
+          $ref: '#/components/schemas/NumberFormatUnitScaleType'
+        unit_name:
+          description: The name of the unit.
+          example: bytes
+          type: string
+      type: object
+    NumberFormatUnitScaleType:
+      description: The type of unit scale.
+      enum:
+      - canonical_unit
+      example: canonical_unit
+      type: string
+      x-enum-varnames:
+      - CANONICAL_UNIT
     OnMissingDataOption:
       description: 'Controls how groups or monitors are treated if an evaluation does
         not return any data points.
@@ -10516,7 +10628,7 @@ components:
       description: A list of  SLO correction objects.
       properties:
         data:
-          description: The list of of SLO corrections objects.
+          description: The list of SLO corrections objects.
           items:
             $ref: '#/components/schemas/SLOCorrection'
           type: array
@@ -12953,7 +13065,7 @@ components:
       properties:
         author:
           $ref: '#/components/schemas/SharedDashboardAuthor'
-        created_at:
+        created:
           description: Date the dashboard was shared.
           format: date-time
           readOnly: true
@@ -12964,6 +13076,20 @@ components:
           type: string
         dashboard_type:
           $ref: '#/components/schemas/DashboardType'
+        embeddable_domains:
+          description: The `SharedDashboard` `embeddable_domains`.
+          example:
+          - https://domain.atlassian.net/
+          - http://myserver.com/
+          items:
+            description: The allowlisted referrers for an EMBED shared dashboard.
+            type: string
+          type: array
+        expiration:
+          description: The time when an OPEN shared dashboard becomes publicly unavailable.
+          format: date-time
+          nullable: true
+          type: string
         global_time:
           $ref: '#/components/schemas/DashboardGlobalTime'
         global_time_selectable_enabled:
@@ -12971,6 +13097,23 @@ components:
             setting for the shared dashboard.
           nullable: true
           type: boolean
+        invitees:
+          description: The `SharedDashboard` `invitees`.
+          example:
+          - access_expiration: '2030-01-01T12:00:00.00Z'
+            email: test@datadoghq.com
+          - access_expiration: null
+            email: test2@datadoghq.com
+          items:
+            $ref: '#/components/schemas/SharedDashboardInviteesItems'
+          type: array
+        last_accessed:
+          description: The last time the shared dashboard was accessed. Null if never
+            accessed.
+          format: date-time
+          nullable: true
+          readOnly: true
+          type: string
         public_url:
           description: URL of the shared dashboard.
           readOnly: true
@@ -12990,6 +13133,7 @@ components:
           nullable: true
           type: array
         share_list:
+          deprecated: true
           description: List of email addresses that can receive an invitation to access
             to the shared dashboard.
           example:
@@ -13003,10 +13147,17 @@ components:
           type: array
         share_type:
           $ref: '#/components/schemas/DashboardShareType'
+        status:
+          $ref: '#/components/schemas/SharedDashboardStatus'
+        title:
+          description: Title of the shared dashboard.
+          type: string
         token:
           description: A unique token assigned to the shared dashboard.
           readOnly: true
           type: string
+        viewing_preferences:
+          $ref: '#/components/schemas/ViewingPreferences'
       required:
       - dashboard_id
       - dashboard_type
@@ -13026,6 +13177,27 @@ components:
           type: string
       readOnly: true
       type: object
+    SharedDashboardInviteesItems:
+      description: The allowlisted invitees for an INVITE-only shared dashboard.
+      properties:
+        access_expiration:
+          description: Time of the invitee expiration. Null means the invite will
+            not expire.
+          format: date-time
+          nullable: true
+          type: string
+        created_at:
+          description: Time that the invitee was created.
+          format: date-time
+          readOnly: true
+          type: string
+        email:
+          description: Email of the invitee.
+          example: test@datadoghq.com
+          type: string
+      required:
+      - email
+      type: object
     SharedDashboardInvites:
       description: Invitations data and metadata that exists for a shared dashboard
         returned by the API.
@@ -13142,6 +13314,17 @@ components:
           format: int64
           type: integer
       type: object
+    SharedDashboardStatus:
+      description: Active means the dashboard is publicly available. Paused means
+        the dashboard is not publicly available.
+      enum:
+      - active
+      - paused
+      example: active
+      type: string
+      x-enum-varnames:
+      - ACTIVE
+      - PAUSED
     SharedDashboardUpdateRequest:
       description: Update a shared dashboard's settings.
       example:
@@ -13152,6 +13335,20 @@ components:
         - test2@datadoghq.com
         share_type: invite
       properties:
+        embeddable_domains:
+          description: The `SharedDashboard` `embeddable_domains`.
+          example:
+          - https://domain.atlassian.net/
+          - http://myserver.com/
+          items:
+            description: The allowlisted referrers for an EMBED shared dashboard.
+            type: string
+          type: array
+        expiration:
+          description: The time when an OPEN shared dashboard becomes publicly unavailable.
+          format: date-time
+          nullable: true
+          type: string
         global_time:
           $ref: '#/components/schemas/SharedDashboardUpdateRequestGlobalTime'
         global_time_selectable_enabled:
@@ -13159,6 +13356,16 @@ components:
             setting for the shared dashboard.
           nullable: true
           type: boolean
+        invitees:
+          description: The `SharedDashboard` `invitees`.
+          example:
+          - access_expiration: '2030-01-01T12:00:00.00Z'
+            email: test@datadoghq.com
+          - access_expiration: null
+            email: test2@datadoghq.com
+          items:
+            $ref: '#/components/schemas/SharedDashboardInviteesItems'
+          type: array
         selectable_template_vars:
           description: List of objects representing template variables on the shared
             dashboard which can have selectable values.
@@ -13174,6 +13381,7 @@ components:
           nullable: true
           type: array
         share_list:
+          deprecated: true
           description: List of email addresses that can be given access to the shared
             dashboard.
           example:
@@ -13187,8 +13395,13 @@ components:
           type: array
         share_type:
           $ref: '#/components/schemas/DashboardShareType'
-      required:
-      - global_time
+        status:
+          $ref: '#/components/schemas/SharedDashboardStatus'
+        title:
+          description: Title of the shared dashboard.
+          type: string
+        viewing_preferences:
+          $ref: '#/components/schemas/ViewingPreferences'
       type: object
     SharedDashboardUpdateRequestGlobalTime:
       description: Timeframe setting for the shared dashboard.
@@ -13831,6 +14044,9 @@ components:
           items:
             $ref: '#/components/schemas/SyntheticsParsingOptions'
           type: array
+        extractedValuesFromScript:
+          description: Generate variables using JavaScript.
+          type: string
         isCritical:
           description: 'Determines whether or not to consider the entire test as failed
             if this step fails.
@@ -14988,7 +15204,6 @@ components:
       - element
       - email
       - global
-      - javascript
       - text
       example: text
       type: string
@@ -14996,7 +15211,6 @@ components:
       - ELEMENT
       - EMAIL
       - GLOBAL
-      - JAVASCRIPT
       - TEXT
     SyntheticsCIBatchMetadata:
       description: Metadata for the Synthetic tests run.
@@ -15098,7 +15312,7 @@ components:
       description: Object describing the synthetics tests to trigger.
       properties:
         tests:
-          description: Individual synthetics test.
+          description: List of Synthetic tests with overrides.
           items:
             $ref: '#/components/schemas/SyntheticsCITest'
           type: array
@@ -15726,8 +15940,7 @@ components:
       description: User locator to find the element.
       properties:
         failTestOnCannotLocate:
-          description: Whether if the the test should fail if the element cannot be
-            found.
+          description: Whether if the test should fail if the element cannot be found.
           type: boolean
         values:
           description: Values of the user locator.
@@ -17183,7 +17396,7 @@ components:
       description: Object describing the Synthetic tests to trigger.
       properties:
         tests:
-          description: Individual Synthetic test.
+          description: List of Synthetic tests.
           items:
             $ref: '#/components/schemas/SyntheticsTriggerTest'
           type: array
@@ -17343,11 +17556,13 @@ components:
       enum:
       - number
       - bar
+      - trend
       example: number
       type: string
       x-enum-varnames:
       - NUMBER
       - BAR
+      - TREND
     TableWidgetDefinition:
       description: The table visualization is available on timeboards and screenboards.
         It displays columns of metrics grouped by tag key.
@@ -21715,9 +21930,8 @@ components:
           format: int64
           type: integer
         cspm_container_hwm_sum:
-          description: Shows the sum of the the high-water marks of Cloud Security
-            Management Pro containers over all hours in the current month for all
-            organizations.
+          description: Shows the sum of the high-water marks of Cloud Security Management
+            Pro containers over all hours in the current month for all organizations.
           format: int64
           type: integer
         cspm_gcp_host_top99p_sum:
@@ -21938,8 +22152,8 @@ components:
           format: int64
           type: integer
         incident_management_monthly_active_users_hwm_sum:
-          description: Shows sum of the the high-water marks of incident management
-            monthly active users in the current month for all organizations.
+          description: Shows sum of the high-water marks of incident management monthly
+            active users in the current month for all organizations.
           format: int64
           type: integer
         indexed_events_count_agg_sum:
@@ -21970,8 +22184,8 @@ components:
           format: int64
           type: integer
         last_updated:
-          description: Shows the the most recent hour in the current month for all
-            organizations for which all usages were calculated.
+          description: Shows the most recent hour in the current month for all organizations
+            for which all usages were calculated.
           format: date-time
           type: string
         live_indexed_events_agg_sum:
@@ -22618,6 +22832,28 @@ components:
       example: 0
       format: int64
       type: integer
+    ViewingPreferences:
+      description: The viewing preferences for a shared dashboard.
+      properties:
+        high_density:
+          description: Whether the widgets on the shared dashboard should be displayed
+            with high density.
+          type: boolean
+        theme:
+          $ref: '#/components/schemas/ViewingPreferencesTheme'
+      type: object
+    ViewingPreferencesTheme:
+      description: The theme of the shared dashboard view. "system" follows your system's
+        default viewing theme.
+      enum:
+      - system
+      - light
+      - dark
+      type: string
+      x-enum-varnames:
+      - SYSTEM
+      - LIGHT
+      - DARK
     WebhooksIntegration:
       description: Datadog-Webhooks integration.
       properties:
@@ -23037,6 +23273,8 @@ components:
           type: string
         cell_display_mode:
           $ref: '#/components/schemas/TableWidgetCellDisplayMode'
+        cell_display_mode_options:
+          $ref: '#/components/schemas/WidgetFormulaCellDisplayModeOptions'
         conditional_formats:
           description: List of conditional formats.
           items:
@@ -23048,11 +23286,44 @@ components:
           type: string
         limit:
           $ref: '#/components/schemas/WidgetFormulaLimit'
+        number_format:
+          $ref: '#/components/schemas/WidgetNumberFormat'
         style:
           $ref: '#/components/schemas/WidgetFormulaStyle'
       required:
       - formula
       type: object
+    WidgetFormulaCellDisplayModeOptions:
+      description: Cell display mode options for the widget formula. (only if `cell_display_mode`
+        is set to `trend`).
+      properties:
+        trend_type:
+          $ref: '#/components/schemas/WidgetFormulaCellDisplayModeOptionsTrendType'
+        y_scale:
+          $ref: '#/components/schemas/WidgetFormulaCellDisplayModeOptionsYScale'
+      type: object
+    WidgetFormulaCellDisplayModeOptionsTrendType:
+      description: Trend type for the cell display mode options.
+      enum:
+      - area
+      - line
+      - bars
+      example: area
+      type: string
+      x-enum-varnames:
+      - AREA
+      - LINE
+      - BARS
+    WidgetFormulaCellDisplayModeOptionsYScale:
+      description: Y scale for the cell display mode options.
+      enum:
+      - shared
+      - independent
+      example: shared
+      type: string
+      x-enum-varnames:
+      - SHARED
+      - INDEPENDENT
     WidgetFormulaLimit:
       description: Options for limiting results returned.
       properties:
@@ -23467,6 +23738,14 @@ components:
       x-enum-varnames:
       - HOST
       - CONTAINER
+    WidgetNumberFormat:
+      description: Number format options for the widget.
+      properties:
+        unit:
+          $ref: '#/components/schemas/NumberFormatUnit'
+        unit_scale:
+          $ref: '#/components/schemas/NumberFormatUnitScale'
+      type: object
     WidgetOrderBy:
       description: What to order by.
       enum:
@@ -28479,6 +28758,43 @@ paths:
         permissions:
         - logs_modify_indexes
   /api/v1/logs/config/indexes/{name}:
+    delete:
+      description: 'Delete an existing index from your organization. Index deletions
+        are permanent and cannot be reverted.
+
+        You cannot recreate an index with the same name as deleted ones.'
+      operationId: DeleteLogsIndex
+      parameters:
+      - description: Name of the log index.
+        in: path
+        name: name
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+        '403':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Forbidden
+        '404':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/LogsAPIErrorResponse'
+          description: Not Found
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Delete an index
+      tags:
+      - Logs Indexes
+      x-permission:
+        operator: OR
+        permissions:
+        - logs_modify_indexes
     get:
       description: Get one log index from your organization. This endpoint takes no
         JSON arguments.
@@ -29012,7 +29328,7 @@ paths:
       - description: 'When specified, shows additional information about the group
           states.
 
-          Choose one or more from `all`, `alert`, `warn`, and `no data`.'
+          Choose one or more from `all`, `alert`, `warn`, and `no data` (`no%20data`).'
         in: query
         name: group_states
         required: false