datadog_api_client 2.17.0 → 2.19.0

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

@@ -808,8 +808,9 @@ components:
           example: key:value,filter:example
           type: string
         cspm_enabled:
-          description: Enable Cloud Security Management Misconfigurations for your
-            organization.
+          description: "When enabled, Datadog\u2019s Cloud Security Management product
+            scans resource configurations monitored by this app registration.\nNote:
+            This requires resource_collection_enabled to be set to true."
           example: true
           type: boolean
         custom_metrics_enabled:
@@ -840,6 +841,12 @@ components:
           description: Your New Azure Active Directory ID.
           example: new1c44-1234-5678-9101-cc00736ftest
           type: string
+        resource_collection_enabled:
+          description: When enabled, Datadog collects metadata and configuration info
+            from cloud resources (compute instances, databases, load balancers, etc.)
+            monitored by this app registration.
+          example: true
+          type: boolean
         tenant_name:
           description: Your Azure Active Directory ID.
           example: testc44-1234-5678-9101-cc00736ftest
@@ -3204,9 +3211,16 @@ components:
           example: key:value,filter:example
           type: string
         is_cspm_enabled:
+          description: 'When enabled, Datadog will activate the Cloud Security Monitoring
+            product for this service account. Note: This requires resource_collection_enabled
+            to be set to true.'
+          example: true
+          type: boolean
+        is_security_command_center_enabled:
           default: false
-          description: When enabled, Datadog performs configuration checks across
-            your Google Cloud environment by continuously scanning every resource.
+          description: 'When enabled, Datadog will attempt to collect Security Command
+            Center Findings. Note: This requires additional permissions on the service
+            account.'
           example: true
           type: boolean
         private_key:
@@ -3222,6 +3236,10 @@ components:
             key.
           example: datadog-apitest
           type: string
+        resource_collection_enabled:
+          description: When enabled, Datadog scans for all resources in your GCP environment.
+          example: true
+          type: boolean
         token_uri:
           description: Should be `https://accounts.google.com/o/oauth2/token`.
           example: https://accounts.google.com/o/oauth2/token
@@ -9341,7 +9359,7 @@ components:
           example: some description
           type: string
         name:
-          description: The name of the new child-organization, limited to 32 characters.
+          description: The name of the child organization, limited to 32 characters.
           example: New child org
           maxLength: 32
           type: string
@@ -10226,6 +10244,13 @@ components:
           nullable: true
           type: string
       type: object
+    SLODataSourceQueryDefinition:
+      description: A formula and function query.
+      example:
+        data_source: metrics
+        query: sum:trace.servlet.request.hits{*} by {env}.as_count()
+      oneOf:
+      - $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition'
     SLODeleteResponse:
       description: A response list of all service level objective deleted.
       properties:
@@ -10269,6 +10294,20 @@ components:
       - THIRTY_DAYS
       - NINETY_DAYS
       - ALL
+    SLOFormula:
+      description: A formula that specifies how to combine the results of multiple
+        queries.
+      example:
+        formula: query1 - default_zero(query2)
+      properties:
+        formula:
+          description: The formula string, which is an expression involving named
+            queries.
+          example: query1 - default_zero(query2)
+          type: string
+      required:
+      - formula
+      type: object
     SLOHistoryMetrics:
       description: 'A `metric` based SLO history response.
 
@@ -10998,6 +11037,8 @@ components:
           type: string
         query:
           $ref: '#/components/schemas/ServiceLevelObjectiveQuery'
+        sli_specification:
+          $ref: '#/components/schemas/SLOSliSpec'
         tags:
           description: 'A list of tags associated with this service level objective.
 
@@ -11052,6 +11093,11 @@ components:
           format: double
           type: number
       type: object
+    SLOSliSpec:
+      description: A generic SLI specification. This is currently used for time-slice
+        SLOs only.
+      oneOf:
+      - $ref: '#/components/schemas/SLOTimeSliceSpec'
     SLOState:
       description: State of the SLO.
       enum:
@@ -11152,6 +11198,106 @@ components:
       - timeframe
       - target
       type: object
+    SLOTimeSliceComparator:
+      description: The comparator used to compare the SLI value to the threshold.
+      enum:
+      - '>'
+      - '>='
+      - <
+      - <=
+      example: '>'
+      type: string
+      x-enum-varnames:
+      - GREATER
+      - GREATER_EQUAL
+      - LESS
+      - LESS_EQUAL
+    SLOTimeSliceCondition:
+      description: 'The time-slice condition, composed of 3 parts: 1. the metric timeseries
+        query, 2. the comparator,
+
+        and 3. the threshold.'
+      example:
+        comparator: <
+        query:
+          formulas:
+          - formula: query2/query1
+          queries:
+          - data_source: metrics
+            name: query1
+            query: sum:trace.servlet.request.hits{*} by {env}.as_count()
+          - data_source: metrics
+            name: query1
+            query: sum:trace.servlet.request.errors{*} by {env}.as_count()
+        threshold: 5
+      properties:
+        comparator:
+          $ref: '#/components/schemas/SLOTimeSliceComparator'
+        query:
+          $ref: '#/components/schemas/SLOTimeSliceQuery'
+        threshold:
+          description: The threshold value to which each SLI value will be compared.
+          example: 5
+          format: double
+          type: number
+      required:
+      - comparator
+      - threshold
+      - query
+      type: object
+    SLOTimeSliceQuery:
+      description: The queries and formula used to calculate the SLI value.
+      example:
+        formulas:
+        - formula: query2/query1
+        queries:
+        - data_source: metrics
+          name: query1
+          query: sum:trace.servlet.request.hits{*} by {env}.as_count()
+        - data_source: metrics
+          name: query1
+          query: sum:trace.servlet.request.errors{*} by {env}.as_count()
+      properties:
+        formulas:
+          description: A list that contains exactly one formula, as only a single
+            formula may be used in a time-slice SLO.
+          items:
+            $ref: '#/components/schemas/SLOFormula'
+          maxItems: 1
+          minItems: 1
+          type: array
+        queries:
+          description: A list of queries that are used to calculate the SLI value.
+          items:
+            $ref: '#/components/schemas/SLODataSourceQueryDefinition'
+          type: array
+      required:
+      - formulas
+      - queries
+      type: object
+    SLOTimeSliceSpec:
+      additionalProperties: false
+      description: A time-slice SLI specification.
+      example:
+        time_slice:
+          comparator: <
+          query:
+            formulas:
+            - formula: query2/query1
+            queries:
+            - data_source: metrics
+              name: query1
+              query: sum:trace.servlet.request.hits{*} by {env}.as_count()
+            - data_source: metrics
+              name: query1
+              query: sum:trace.servlet.request.errors{*} by {env}.as_count()
+          threshold: 5
+      properties:
+        time_slice:
+          $ref: '#/components/schemas/SLOTimeSliceCondition'
+      required:
+      - time_slice
+      type: object
     SLOTimeframe:
       description: The SLO time window options.
       enum:
@@ -11171,11 +11317,13 @@ components:
       enum:
       - metric
       - monitor
+      - time_slice
       example: metric
       type: string
       x-enum-varnames:
       - METRIC
       - MONITOR
+      - TIME_SLICE
     SLOTypeNumeric:
       description: 'A numeric representation of the type of the service level objective
         (`0` for
@@ -11186,12 +11334,14 @@ components:
       enum:
       - 0
       - 1
+      - 2
       example: 0
       format: int32
       type: integer
       x-enum-varnames:
       - MONITOR
       - METRIC
+      - TIME_SLICE
     SLOWidgetDefinition:
       description: Use the SLO and uptime widget to track your SLOs (Service Level
         Objectives) and uptime on screenboards and timeboards.
@@ -12001,6 +12151,8 @@ components:
           type: string
         query:
           $ref: '#/components/schemas/ServiceLevelObjectiveQuery'
+        sli_specification:
+          $ref: '#/components/schemas/SLOSliSpec'
         tags:
           description: 'A list of tags associated with this service level objective.
 
@@ -12130,6 +12282,8 @@ components:
           type: string
         query:
           $ref: '#/components/schemas/ServiceLevelObjectiveQuery'
+        sli_specification:
+          $ref: '#/components/schemas/SLOSliSpec'
         tags:
           description: 'A list of tags associated with this service level objective.
 
@@ -14705,6 +14859,55 @@ components:
         type:
           $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType'
       type: object
+    SyntheticsPatchTestBody:
+      description: Wrapper around an array of [JSON Patch](https://jsonpatch.com)
+        operations to perform on the test
+      properties:
+        data:
+          description: Array of [JSON Patch](https://jsonpatch.com) operations to
+            perform on the test
+          example:
+          - op: replace
+            path: /name
+            value: New test name
+          - op: remove
+            path: /config/assertions/0
+          items:
+            $ref: '#/components/schemas/SyntheticsPatchTestOperation'
+          type: array
+      type: object
+    SyntheticsPatchTestOperation:
+      description: A single [JSON Patch](https://jsonpatch.com) operation to perform
+        on the test
+      properties:
+        op:
+          $ref: '#/components/schemas/SyntheticsPatchTestOperationName'
+        path:
+          description: The path to the value to modify
+          example: /name
+          type: string
+        value:
+          description: A value to use in a [JSON Patch](https://jsonpatch.com) operation
+          example: New Test Name
+      type: object
+    SyntheticsPatchTestOperationName:
+      description: The operation to perform
+      enum:
+      - add
+      - remove
+      - replace
+      - move
+      - copy
+      - test
+      example: replace
+      type: string
+      x-enum-varnames:
+      - ADD
+      - REMOVE
+      - REPLACE
+      - MOVE
+      - COPY
+      - TEST
     SyntheticsPlayingTab:
       description: Navigate between different tabs for your browser test.
       enum:
@@ -18428,6 +18631,11 @@ components:
             over all hours in the current date all organizations.
           format: int64
           type: integer
+        apm_devsecops_host_top99p:
+          description: Shows the 99th percentile of all APM DevSecOps hosts over all
+            hours in the current date for the given org.
+          format: int64
+          type: integer
         apm_fargate_count_avg:
           description: Shows the average of all APM ECS Fargate tasks over all hours
             in the current date for all organizations.
@@ -18953,6 +19161,11 @@ components:
             over all hours in the current date for the given org.
           format: int64
           type: integer
+        apm_devsecops_host_top99p:
+          description: Shows the 99th percentile of all APM DevSecOps hosts over all
+            hours in the current date for the given org.
+          format: int64
+          type: integer
         apm_fargate_count_avg:
           description: Shows the average of all APM ECS Fargate tasks over all hours
             in the current months for the given org.
@@ -19177,6 +19390,16 @@ components:
             Pro hosts over all hours in the current date for the given org.
           format: int64
           type: integer
+        custom_historical_ts_avg:
+          description: Shows the average number of distinct historical custom metrics
+            over all hours in the current date for the given org.
+          format: int64
+          type: integer
+        custom_live_ts_avg:
+          description: Shows the average number of distinct live custom metrics over
+            all hours in the current date for the given org.
+          format: int64
+          type: integer
         custom_ts_avg:
           description: Shows the average number of distinct custom metrics over all
             hours in the current date for the given org.
@@ -19481,6 +19704,11 @@ components:
             over all hours in the current months all organizations.
           format: int64
           type: integer
+        apm_devsecops_host_top99p_sum:
+          description: Shows the 99th percentile of all APM DevSecOps hosts over all
+            hours in the current months for all organizations.
+          format: int64
+          type: integer
         apm_fargate_count_avg_sum:
           description: Shows the average of all APM ECS Fargate tasks over all hours
             in the current months for all organizations.
@@ -19708,6 +19936,16 @@ components:
             Pro hosts over all hours in the current months for all organizations.
           format: int64
           type: integer
+        custom_historical_ts_sum:
+          description: Shows the average number of distinct historical custom metrics
+            over all hours in the current months for all organizations.
+          format: int64
+          type: integer
+        custom_live_ts_sum:
+          description: Shows the average number of distinct live custom metrics over
+            all hours in the current months for all organizations.
+          format: int64
+          type: integer
         custom_ts_sum:
           description: Shows the average number of distinct custom metrics over all
             hours in the current months for all organizations.
@@ -20886,6 +21124,8 @@ components:
       - 1mo
       - 3mo
       - 6mo
+      - week_to_date
+      - month_to_date
       - 1y
       - alert
       example: 5m
@@ -20904,6 +21144,8 @@ components:
       - PAST_ONE_MONTH
       - PAST_THREE_MONTHS
       - PAST_SIX_MONTHS
+      - WEEK_TO_DATE
+      - MONTH_TO_DATE
       - PAST_ONE_YEAR
       - ALERT
     WidgetMargin:
@@ -21249,7 +21491,7 @@ components:
               an organization. Mute and unmute hosts. The ability to write monitors
               is not required to set downtimes.
             monitors_read: View monitors.
-            monitors_write: Edit, mute, and delete individual monitors.
+            monitors_write: Edit and delete individual monitors.
             security_monitoring_filters_read: Read Security Filters.
             security_monitoring_filters_write: Create, edit, and delete Security Filters.
             security_monitoring_findings_read: View CSPM Findings.
@@ -22891,7 +23133,9 @@ paths:
       x-codegen-request-body-name: body
   /api/v1/downtime:
     get:
-      description: Get all scheduled downtimes.
+      deprecated: true
+      description: Get all scheduled downtimes. **Note:** This endpoint has been deprecated.
+        Please use v2 endpoints.
       operationId: ListDowntimes
       parameters:
       - description: Only return downtimes that are active when the request is made.
@@ -22932,7 +23176,9 @@ paths:
       tags:
       - Downtimes
     post:
-      description: Schedule a downtime.
+      deprecated: true
+      description: Schedule a downtime. **Note:** This endpoint has been deprecated.
+        Please use v2 endpoints.
       operationId: CreateDowntime
       requestBody:
         content:
@@ -22973,7 +23219,11 @@ paths:
       x-codegen-request-body-name: body
   /api/v1/downtime/cancel/by_scope:
     post:
-      description: Delete all downtimes that match the scope of `X`.
+      deprecated: true
+      description: Delete all downtimes that match the scope of `X`. **Note:** This
+        only interacts with Downtimes created using v1 endpoints. This endpoint has
+        been deprecated and will not be replaced. Please use v2 endpoints to find
+        and cancel downtimes.
       operationId: CancelDowntimesByScope
       requestBody:
         content:
@@ -23020,7 +23270,9 @@ paths:
       x-codegen-request-body-name: body
   /api/v1/downtime/{downtime_id}:
     delete:
-      description: Cancel a downtime.
+      deprecated: true
+      description: Cancel a downtime. **Note:** This endpoint has been deprecated.
+        Please use v2 endpoints.
       operationId: CancelDowntime
       parameters:
       - description: ID of the downtime to cancel.
@@ -23057,7 +23309,9 @@ paths:
       tags:
       - Downtimes
     get:
-      description: Get downtime detail by `downtime_id`.
+      deprecated: true
+      description: Get downtime detail by `downtime_id`. **Note:** This endpoint has
+        been deprecated. Please use v2 endpoints.
       operationId: GetDowntime
       parameters:
       - description: ID of the downtime to fetch.
@@ -23098,7 +23352,9 @@ paths:
       tags:
       - Downtimes
     put:
-      description: Update a single downtime by `downtime_id`.
+      deprecated: true
+      description: Update a single downtime by `downtime_id`. **Note:** This endpoint
+        has been deprecated. Please use v2 endpoints.
       operationId: UpdateDowntime
       parameters:
       - description: ID of the downtime to update.
@@ -23435,7 +23691,8 @@ paths:
       - Snapshots
   /api/v1/host/{host_name}/mute:
     post:
-      description: Mute a host.
+      description: Mute a host. **Note:** This creates a [Downtime V2](https://docs.datadoghq.com/api/latest/downtimes/#schedule-a-downtime)
+        for the host.
       operationId: MuteHost
       parameters:
       - description: Name of the host to mute.
@@ -26251,7 +26508,7 @@ paths:
 
         - SLO: `slo alert`
 
-        - watchdog: `event alert`
+        - watchdog: `event-v2 alert`
 
         - event-v2: `event-v2 alert`
 
@@ -27082,7 +27339,9 @@ paths:
       x-codegen-request-body-name: body
   /api/v1/monitor/{monitor_id}/downtimes:
     get:
-      description: Get all active downtimes for the specified monitor.
+      deprecated: true
+      description: Get all active v1 downtimes for the specified monitor. **Note:**
+        This endpoint has been deprecated. Please use v2 endpoints.
       operationId: ListMonitorDowntimes
       parameters:
       - description: The id of the monitor
@@ -29650,7 +29909,7 @@ paths:
       description: Edit the configuration of a Synthetic browser test.
       operationId: UpdateBrowserTest
       parameters:
-      - description: The public ID of the test to get details from.
+      - description: The public ID of the test to edit.
         in: path
         name: public_id
         required: true
@@ -29989,6 +30248,65 @@ paths:
       summary: Get a test configuration
       tags:
       - Synthetics
+    patch:
+      description: Patch the configuration of a Synthetic test with partial data.
+      operationId: PatchTest
+      parameters:
+      - description: The public ID of the test to patch.
+        in: path
+        name: public_id
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SyntheticsPatchTestBody'
+        description: '[JSON Patch](https://jsonpatch.com/) compliant list of operations'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SyntheticsTestDetails'
+          description: OK
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: '- JSON format is wrong
+
+            - Updating sub-type is forbidden'
+        '403':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Forbidden
+        '404':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: '- Synthetic Monitoring is not activated for the user
+
+            - Test is not owned by the user
+
+            - Test can''t be found'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - synthetics_write
+      summary: Patch a Synthetic test
+      tags:
+      - Synthetics
+      x-codegen-request-body-name: body
   /api/v1/synthetics/tests/{public_id}/results:
     get:
       description: Get the last 150 test results summaries for a given Synthetic API