RubyGems - datadog_api_client - Versions diffs - 2.11.0 → 2.13.0 - Mend

datadog_api_client 2.11.0 → 2.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (954) hide show

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

@@ -352,7 +352,6 @@ components:
           type: array
       type: object
     AccessRole:
-      default: st
       description: The access role of the user. Options are **st** (standard user),
         **adm** (admin user), or **ro** (read-only user).
       enum:
@@ -360,7 +359,8 @@ components:
       - adm
       - ro
       - ERROR
-      example: st
+      example: ro
+      nullable: true
       type: string
       x-enum-varnames:
       - STANDARD
@@ -2466,6 +2466,38 @@ components:
       - service
       - stat
       type: object
+    FormulaAndFunctionCloudCostDataSource:
+      description: Data source for Cloud Cost queries.
+      enum:
+      - cloud_cost
+      example: cloud_cost
+      type: string
+      x-enum-varnames:
+      - CLOUD_COST
+    FormulaAndFunctionCloudCostQueryDefinition:
+      description: A formula and functions Cloud Cost query.
+      example:
+        data_source: cloud_cost
+        name: query1
+        query: sum:aws.cost.amortized{*}
+      properties:
+        aggregator:
+          $ref: '#/components/schemas/WidgetAggregator'
+        data_source:
+          $ref: '#/components/schemas/FormulaAndFunctionCloudCostDataSource'
+        name:
+          description: Name of the query for use in formulas.
+          example: my_query
+          type: string
+        query:
+          description: Query for Cloud Cost data.
+          example: ''
+          type: string
+      required:
+      - data_source
+      - query
+      - name
+      type: object
     FormulaAndFunctionEventAggregation:
       description: Aggregation methods for event platform queries.
       enum:
@@ -2729,17 +2761,21 @@ components:
       - $ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatsQueryDefinition'
       - $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition'
       - $ref: '#/components/schemas/FormulaAndFunctionSLOQueryDefinition'
+      - $ref: '#/components/schemas/FormulaAndFunctionCloudCostQueryDefinition'
       type: object
     FormulaAndFunctionResponseFormat:
-      description: Timeseries or Scalar response.
+      description: Timeseries, scalar, or event list response. Event list response
+        formats are supported by Geomap widgets.
       enum:
       - timeseries
       - scalar
+      - event_list
       example: timeseries
       type: string
       x-enum-varnames:
       - TIMESERIES
       - SCALAR
+      - EVENT_LIST
     FormulaAndFunctionSLODataSource:
       description: Data source for SLO measures queries.
       enum:
@@ -2779,6 +2815,7 @@ components:
     FormulaAndFunctionSLOQueryDefinition:
       description: A formula and functions metrics query.
       example:
+        additional_query_filters: '*'
         data_source: slo
         group_mode: overall
         measure: good_events
@@ -2786,6 +2823,10 @@ components:
         slo_id: '12345678910'
         slo_query_type: metric
       properties:
+        additional_query_filters:
+          description: Additional filters applied to the SLO query.
+          example: host:host_a,env:prod
+          type: string
         data_source:
           $ref: '#/components/schemas/FormulaAndFunctionSLODataSource'
         group_mode:
@@ -3127,6 +3168,16 @@ components:
     GeomapWidgetRequest:
       description: An updated geomap widget.
       properties:
+        columns:
+          description: Widget columns.
+          example:
+          - field: timestamp
+            width: auto
+          - field: content
+            width: full
+          items:
+            $ref: '#/components/schemas/ListStreamColumn'
+          type: array
         formulas:
           description: List of formulas that operate on queries.
           items:
@@ -3142,6 +3193,8 @@ components:
           items:
             $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
           type: array
+        query:
+          $ref: '#/components/schemas/ListStreamQuery'
         response_format:
           $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
         rum_query:
@@ -3996,6 +4049,22 @@ components:
             type: string
           type: array
       type: object
+    IPPrefixesRemoteConfiguration:
+      description: Available prefix information for the Remote Configuration endpoints.
+      properties:
+        prefixes_ipv4:
+          description: List of IPv4 prefixes.
+          items:
+            description: IPv4 prefix
+            type: string
+          type: array
+        prefixes_ipv6:
+          description: List of IPv6 prefixes.
+          items:
+            description: IPv6 prefix
+            type: string
+          type: array
+      type: object
     IPPrefixesSynthetics:
       description: Available prefix information for the Synthetics endpoints.
       properties:
@@ -4082,6 +4151,8 @@ components:
           $ref: '#/components/schemas/IPPrefixesOrchestrator'
         process:
           $ref: '#/components/schemas/IPPrefixesProcess'
+        remote-configuration:
+          $ref: '#/components/schemas/IPPrefixesRemoteConfiguration'
         synthetics:
           $ref: '#/components/schemas/IPPrefixesSynthetics'
         synthetics-private-locations:
@@ -7168,6 +7239,7 @@ components:
       - ci-pipelines alert
       - ci-tests alert
       - error-tracking alert
+      - database-monitoring alert
       example: query alert
       type: string
       x-enum-varnames:
@@ -7187,6 +7259,7 @@ components:
       - CI_PIPELINES_ALERT
       - CI_TESTS_ALERT
       - ERROR_TRACKING_ALERT
+      - DATABASE_MONITORING_ALERT
     MonitorUpdateRequest:
       description: Object describing a monitor update request.
       properties:
@@ -7248,6 +7321,7 @@ components:
           items:
             description: A role UUID.
             type: string
+          nullable: true
           type: array
         state:
           $ref: '#/components/schemas/MonitorState'
@@ -12405,6 +12479,7 @@ components:
       - isInMoreThan
       - isInLessThan
       - doesNotExist
+      - isUndefined
       example: contains
       type: string
       x-enum-varnames:
@@ -12422,6 +12497,7 @@ components:
       - IS_IN_MORE_DAYS_THAN
       - IS_IN_LESS_DAYS_THAN
       - DOES_NOT_EXIST
+      - IS_UNDEFINED
     SyntheticsAssertionTarget:
       description: An assertion which uses a simple target.
       properties:
@@ -13433,6 +13509,14 @@ components:
           description: URL attached to the metrics.
           type: string
       type: object
+    SyntheticsDefaultLocations:
+      description: List of Synthetics default locations settings.
+      example:
+      - aws:eu-west-3
+      items:
+        description: Name of the location.
+        type: string
+      type: array
     SyntheticsDeleteTestsPayload:
       description: 'A JSON list of the ID or IDs of the Synthetic tests that you want
@@ -15971,6 +16055,7 @@ components:
           description: The total number of audit logs lines indexed during a given
             hour.
           format: int64
+          nullable: true
           type: integer
         org_name:
           description: The organization name.
@@ -16758,6 +16843,7 @@ components:
         iot_device_count:
           description: The total number of IoT devices during a given hour.
           format: int64
+          nullable: true
           type: integer
         org_name:
           description: The organization name.
@@ -16885,6 +16971,7 @@ components:
         retention:
           description: The retention period in days or "custom" for all custom retention
             usage.
+          nullable: true
           type: string
       type: object
     UsageLogsByRetentionResponse:
@@ -17009,6 +17096,7 @@ components:
         host_count:
           description: Contains the number of active NPM hosts.
           format: int64
+          nullable: true
           type: integer
         hour:
           description: The hour for the usage.
@@ -17474,9 +17562,19 @@ components:
             over all hours in the current month for all organizations.
           format: int64
           type: integer
+        cloud_cost_management_aws_host_count_avg:
+          description: Host count average of Cloud Cost Management for AWS for the
+            given date and given organization.
+          format: int64
+          type: integer
+        cloud_cost_management_azure_host_count_avg:
+          description: Host count average of Cloud Cost Management for Azure for the
+            given date and given organization.
+          format: int64
+          type: integer
         cloud_cost_management_host_count_avg:
-          description: Host count average of Cloud Cost Management for the given date
-            and given organization.
+          description: Host count average of Cloud Cost Management for all cloud providers
+            for the given date and given organization.
           format: int64
           type: integer
         container_avg:
@@ -17638,6 +17736,11 @@ components:
             all hours in the current date for all organizations.
           format: int64
           type: integer
+        mobile_rum_session_count_roku_sum:
+          description: Shows the sum of all mobile RUM Sessions on Roku over all hours
+            in the current date for all organizations.
+          format: int64
+          type: integer
         mobile_rum_session_count_sum:
           description: Shows the sum of all mobile RUM Sessions over all hours in
             the current date for all organizations
@@ -17881,9 +17984,19 @@ components:
             over all hours in the current date for the given org.
           format: int64
           type: integer
+        cloud_cost_management_aws_host_count_avg:
+          description: Host count average of Cloud Cost Management for AWS for the
+            given date and given org.
+          format: int64
+          type: integer
+        cloud_cost_management_azure_host_count_avg:
+          description: Host count average of Cloud Cost Management for Azure for the
+            given date and given org.
+          format: int64
+          type: integer
         cloud_cost_management_host_count_avg:
-          description: Host count average of Cloud Cost Management for the given date
-            and given org.
+          description: Host count average of Cloud Cost Management for all cloud providers
+            for the given date and given org.
           format: int64
           type: integer
         container_avg:
@@ -18044,6 +18157,11 @@ components:
             all hours in the current date for the given org.
           format: int64
           type: integer
+        mobile_rum_session_count_roku_sum:
+          description: Shows the sum of all mobile RUM Sessions on Roku over all hours
+            in the current date for the given org.
+          format: int64
+          type: integer
         mobile_rum_session_count_sum:
           description: Shows the sum of all mobile RUM Sessions over all hours in
             the current date for the given org.
@@ -18297,8 +18415,19 @@ components:
             over all hours in the current months for all organizations.
           format: int64
           type: integer
+        cloud_cost_management_aws_host_count_avg_sum:
+          description: Sum of the host count average for Cloud Cost Management for
+            AWS.
+          format: int64
+          type: integer
+        cloud_cost_management_azure_host_count_avg_sum:
+          description: Sum of the host count average for Cloud Cost Management for
+            Azure.
+          format: int64
+          type: integer
         cloud_cost_management_host_count_avg_sum:
-          description: Sum of the host count average for Cloud Cost Management.
+          description: Sum of the host count average for Cloud Cost Management for
+            all cloud providers.
           format: int64
           type: integer
         container_avg_sum:
@@ -18488,6 +18617,11 @@ components:
             all hours in the current months for all organizations.
           format: int64
           type: integer
+        mobile_rum_session_count_roku_agg_sum:
+          description: Shows the sum of all mobile RUM Sessions on Roku over all hours
+            in the current months for all organizations.
+          format: int64
+          type: integer
         mobile_rum_units_agg_sum:
           description: Shows the sum of all mobile RUM units over all hours in the
             current months for all organizations.
@@ -19085,25 +19219,26 @@ components:
       description: Axis controls for the widget.
       properties:
         include_zero:
-          description: True includes zero.
+          description: Set to `true` to include zero.
           type: boolean
         label:
-          description: The label of the axis to display on the graph.
+          description: The label of the axis to display on the graph. Only usable
+            on Scatterplot Widgets.
           type: string
         max:
           default: auto
-          description: Specifies the maximum value to show on the y-axis. It takes
-            a number, or auto for default behavior.
+          description: Specifies maximum numeric value to show on the axis. Defaults
+            to `auto`.
           type: string
         min:
           default: auto
-          description: Specifies minimum value to show on the y-axis. It takes a number,
-            or auto for default behavior.
+          description: Specifies minimum numeric value to show on the axis. Defaults
+            to `auto`.
           type: string
         scale:
           default: linear
           description: Specifies the scale type. Possible values are `linear`, `log`,
-            `sqrt`, `pow##` (for example `pow2`, `pow0.5` etc.).
+            `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
           type: string
       type: object
     WidgetChangeType:
@@ -19254,11 +19389,13 @@ components:
       - area
       - bars
       - line
+      - overlay
       type: string
       x-enum-varnames:
       - AREA
       - BARS
       - LINE
+      - OVERLAY
     WidgetEvent:
       description: 'Event overlay control options.
@@ -23065,7 +23202,9 @@ paths:
       x-codegen-request-body-name: body
   /api/v1/integration/gcp:
     delete:
-      description: Delete a given Datadog-GCP integration.
+      deprecated: true
+      description: "This endpoint is deprecated \u2013 use the V2 endpoints instead.
+        Delete a given Datadog-GCP integration."
       operationId: DeleteGCPIntegration
       requestBody:
         content:
@@ -23101,7 +23240,9 @@ paths:
       - GCP Integration
       x-codegen-request-body-name: body
     get:
-      description: List all Datadog-GCP integrations configured in your Datadog account.
+      deprecated: true
+      description: "This endpoint is deprecated \u2013 use the V2 endpoints instead.
+        List all Datadog-GCP integrations configured in your Datadog account."
       operationId: ListGCPIntegration
       responses:
         '200':
@@ -23128,7 +23269,9 @@ paths:
       tags:
       - GCP Integration
     post:
-      description: Create a Datadog-GCP integration.
+      deprecated: true
+      description: "This endpoint is deprecated \u2013 use the V2 endpoints instead.
+        Create a Datadog-GCP integration."
       operationId: CreateGCPIntegration
       requestBody:
         content:
@@ -23164,14 +23307,12 @@ paths:
       - GCP Integration
       x-codegen-request-body-name: body
     put:
-      description: 'Update a Datadog-GCP integrations host_filters and/or auto-mute.
-        Requires a `project_id` and `client_email`, however these fields cannot be
-        updated.
-        If you need to update these fields, delete and use the create (`POST`) endpoint.
-        The unspecified fields will keep their original values.'
+      deprecated: true
+      description: "This endpoint is deprecated \u2013 use the V2 endpoints instead.
+        Update a Datadog-GCP integrations host_filters and/or auto-mute.\nRequires
+        a `project_id` and `client_email`, however these fields cannot be updated.\nIf
+        you need to update these fields, delete and use the create (`POST`) endpoint.\nThe
+        unspecified fields will keep their original values."
       operationId: UpdateGCPIntegration
       requestBody:
         content:
@@ -24691,6 +24832,8 @@ paths:
         - error-tracking: `error-tracking alert`
+        - database-monitoring: `database-monitoring alert`
         **Note**: Synthetic monitors are created through the Synthetics API. See the
         [Synthetics API] (https://docs.datadoghq.com/api/latest/synthetics/) documentation
@@ -25016,7 +25159,32 @@ paths:
         - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
-        - `#` an integer or decimal number used to set the threshold.'
+        - `#` an integer or decimal number used to set the threshold.
+        **Database Monitoring Alert Query**
+        Example: `database-monitoring(query).rollup(rollup_method[, measure]).last(time_window)
+        operator #`
+        - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
+        - `rollup_method` The stats roll-up method - supports `count`, `avg`, and
+        `cardinality`.
+        - `measure` For `avg` and cardinality `rollup_method` - specify the measure
+        or the facet name you want to use.
+        - `time_window` #m (between 1 and 2880), #h (between 1 and 48).
+        - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
+        - `#` an integer or decimal number used to set the threshold.
+        **NOTE** Database Monitoring monitors are in alpha on US1.'
       operationId: CreateMonitor
       requestBody:
         content:
@@ -25558,7 +25726,7 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - monitors_read
-      summary: Get all downtimes for a monitor
+      summary: Get active downtimes for a monitor
       tags:
       - Downtimes
       x-codegen-request-body-name: body
@@ -27100,38 +27268,6 @@ paths:
           description: Forbidden
         '429':
           $ref: '#/components/responses/TooManyRequestsResponse'
-      servers:
-      - url: https://{subdomain}.{site}
-        variables:
-          site:
-            default: datadoghq.com
-            description: The regional site for Datadog customers.
-            enum:
-            - datadoghq.com
-            - datadoghq.eu
-            - us3.datadoghq.com
-            - us5.datadoghq.com
-            - ap1.datadoghq.com
-            - ddog-gov.com
-          subdomain:
-            default: api
-            description: The subdomain where the API is deployed.
-      - url: '{protocol}://{name}'
-        variables:
-          name:
-            default: api.datadoghq.com
-            description: Full site DNS name.
-          protocol:
-            default: https
-            description: The protocol for accessing the API.
-      - url: https://{subdomain}.{site}
-        variables:
-          site:
-            default: datadoghq.com
-            description: Any Datadog deployment.
-          subdomain:
-            default: api
-            description: The subdomain where the API is deployed.
       summary: Search for SLOs
       tags:
       - Service Level Objectives
@@ -27607,6 +27743,27 @@ paths:
       tags:
       - Synthetics
       x-codegen-request-body-name: body
+  /api/v1/synthetics/settings/default_locations:
+    get:
+      description: Get the default locations settings.
+      operationId: GetSyntheticsDefaultLocations
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SyntheticsDefaultLocations'
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - synthetics_default_settings_read
+      summary: Get the default locations
+      tags:
+      - Synthetics
   /api/v1/synthetics/tests:
     get:
       description: Get the list of all Synthetic tests.