datadog_api_client 1.1.0 → 1.2.0

data/data/v2/openapi.yaml

@@ -102,6 +102,15 @@ components:
       required: true
       schema:
         type: string
+    ApplicationKeyIncludeParameter:
+      description: Resource path for related resources to include in the response.
+        Only `owned_by` is supported.
+      in: query
+      name: include
+      required: false
+      schema:
+        example: owned_by
+        type: string
     ApplicationKeysSortParameter:
       description: 'Application key attribute used to sort results. Sort order is
         ascending
@@ -3988,12 +3997,6 @@ components:
       required:
       - data
       type: object
-    SecurityFilterDeleteResponse:
-      description: Response object which only includes the metadata.
-      properties:
-        meta:
-          $ref: '#/components/schemas/SecurityFilterMeta'
-      type: object
     SecurityFilterExclusionFilter:
       description: Exclusion filter for the security filter.
       example:
@@ -4145,7 +4148,7 @@ components:
       description: List of rules.
       properties:
         data:
-          description: TODO.
+          description: Array containing the list of rules.
           items:
             $ref: '#/components/schemas/SecurityMonitoringRuleResponse'
           type: array
@@ -4211,6 +4214,11 @@ components:
           items:
             $ref: '#/components/schemas/SecurityMonitoringFilter'
           type: array
+        hasExtendedTitle:
+          description: Whether the notifications include the triggering group-by values
+            in their title.
+          example: true
+          type: boolean
         isEnabled:
           description: Whether the rule is enabled.
           example: true
@@ -4221,7 +4229,7 @@ components:
           type: string
         name:
           description: The name of the rule.
-          example: ''
+          example: My security monitoring rule.
           type: string
         options:
           $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
@@ -4285,8 +4293,8 @@ components:
       - ONE_HOUR
       - TWO_HOURS
     SecurityMonitoringRuleKeepAlive:
-      description: "Once a signal is generated, the signal will remain \u201Copen\u201D\
-        \ if a case is matched at least once within\nthis keep alive window."
+      description: "Once a signal is generated, the signal will remain \u201Copen\u201D
+        if a case is matched at least once within\nthis keep alive window."
       enum:
       - 0
       - 60
@@ -4312,9 +4320,9 @@ components:
       - THREE_HOURS
       - SIX_HOURS
     SecurityMonitoringRuleMaxSignalDuration:
-      description: "A signal will \u201Cclose\u201D regardless of the query being\
-        \ matched once the time exceeds the maximum duration.\nThis time is calculated\
-        \ from the first seen timestamp."
+      description: "A signal will \u201Cclose\u201D regardless of the query being
+        matched once the time exceeds the maximum duration.\nThis time is calculated
+        from the first seen timestamp."
       enum:
       - 0
       - 60
@@ -4474,13 +4482,13 @@ components:
           type: string
         query:
           description: Query to run on logs.
-          example: a < 3
+          example: a > 3
           type: string
       required:
       - query
       type: object
     SecurityMonitoringRuleResponse:
-      description: Detection rule.
+      description: Rule.
       properties:
         cases:
           description: Cases for generating signals.
@@ -4501,6 +4509,10 @@ components:
           items:
             $ref: '#/components/schemas/SecurityMonitoringFilter'
           type: array
+        hasExtendedTitle:
+          description: Whether the notifications include the triggering group-by values
+            in their title.
+          type: boolean
         id:
           description: The ID of the rule.
           type: string
@@ -4532,6 +4544,10 @@ components:
             description: Tag.
             type: string
           type: array
+        updateAuthorId:
+          description: User ID of the user who updated the rule.
+          format: int64
+          type: integer
         version:
           description: The version of the rule.
           format: int64
@@ -4565,6 +4581,11 @@ components:
           items:
             $ref: '#/components/schemas/SecurityMonitoringFilter'
           type: array
+        hasExtendedTitle:
+          description: Whether the notifications include the triggering group-by values
+            in their title.
+          example: true
+          type: boolean
         isEnabled:
           description: Whether the rule is enabled.
           type: boolean
@@ -4587,6 +4608,12 @@ components:
             description: Tag.
             type: string
           type: array
+        version:
+          description: The version of the rule being updated.
+          example: 1
+          format: int32
+          maximum: 2147483647
+          type: integer
       type: object
     SecurityMonitoringRuntimeAgentRule:
       description: The Agent rule.
@@ -5114,8 +5141,8 @@ paths:
         api_key:
           parameters:
           - name: body
-            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"{{\
-              \ unique }}\"\n    },\n    \"type\": \"api_keys\"\n  }\n}"
+            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"{{
+              unique }}\"\n    },\n    \"type\": \"api_keys\"\n  }\n}"
           step: there is a valid "api_key" in the system
       x-undo:
         operationId: DeleteAPIKey
@@ -5289,6 +5316,42 @@ paths:
       x-codegen-request-body-name: body
       x-undo:
         type: idempotent
+    get:
+      description: Get an application key for your org.
+      operationId: GetApplicationKey
+      parameters:
+      - $ref: '#/components/parameters/ApplicationKeyId'
+      - $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApplicationKeyResponse'
+          description: OK
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Bad Request
+        '403':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Forbidden
+        '404':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Not Found
+      summary: Get an application key
+      tags:
+      - Key Management
+      x-undo:
+        type: safe
     patch:
       description: Edit an application key
       operationId: UpdateApplicationKey
@@ -5408,8 +5471,8 @@ paths:
         application_key:
           parameters:
           - name: body
-            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"{{\
-              \ unique }}\"\n    },\n    \"type\": \"application_keys\"\n  }\n}"
+            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"{{
+              unique }}\"\n    },\n    \"type\": \"application_keys\"\n  }\n}"
           step: there is a valid "application_key" in the system
       x-undo:
         operationId: DeleteCurrentUserApplicationKey
@@ -5765,9 +5828,9 @@ paths:
         incident:
           parameters:
           - name: body
-            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"title\": \"{{\
-              \ unique }}\",\n      \"customer_impacted\": false\n     },\n     \"\
-              type\": \"incidents\"\n  }\n}"
+            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"title\": \"{{
+              unique }}\",\n      \"customer_impacted\": false\n     },\n     \"type\":
+              \"incidents\"\n  }\n}"
           step: there is a valid "incident" in the system
       x-undo:
         operationId: DeleteIncident
@@ -6328,10 +6391,10 @@ paths:
         logs_metric:
           parameters:
           - name: body
-            value: "{\n  \"data\": {\n    \"id\": \"{{ unique }}\",\n    \"attributes\"\
-              : {\n      \"filter\": {\n        \"query\": \"source:{{ unique }}\"\
-              \n      },\n      \"compute\": {\n        \"aggregation_type\": \"count\"\
-              \n      }\n    },\n    \"type\": \"logs_metrics\"\n  }\n}"
+            value: "{\n  \"data\": {\n    \"id\": \"{{ unique }}\",\n    \"attributes\":
+              {\n      \"filter\": {\n        \"query\": \"source:{{ unique }}\"\n
+              \     },\n      \"compute\": {\n        \"aggregation_type\": \"count\"\n
+              \     }\n    },\n    \"type\": \"logs_metrics\"\n  }\n}"
           step: there is a valid "logs_metric" in the system
       x-menu-order: 2
       x-undo:
@@ -6651,10 +6714,10 @@ paths:
       x-menu-order: 5
       x-undo:
         type: safe
-      x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types\
-        \ is only accessible for Metrics without Limits&trade; beta customers.\nIf\
-        \ you\u2019re interested in Metrics without Limits&trade;, please contact\
-        \ your Customer Success Manager.**"
+      x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types
+        is only accessible for Metrics without Limits&trade; beta customers.\nIf you\u2019re
+        interested in Metrics without Limits&trade;, please contact your Customer
+        Success Manager.**"
   /api/v2/metrics/{metric_name}/all-tags:
     get:
       description: View indexed tag key-value pairs for a given metric name.
@@ -6733,10 +6796,10 @@ paths:
       x-menu-order: 4
       x-undo:
         type: idempotent
-      x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types\
-        \ is only accessible for Metrics without Limits&trade; beta customers.\nIf\
-        \ you\u2019re interested in Metrics without Limits&trade;, please contact\
-        \ your Customer Success Manager.**"
+      x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types
+        is only accessible for Metrics without Limits&trade; beta customers.\nIf you\u2019re
+        interested in Metrics without Limits&trade;, please contact your Customer
+        Success Manager.**"
     get:
       description: Returns the tag configuration for the given metric name.
       operationId: ListTagConfigurationByName
@@ -6773,10 +6836,10 @@ paths:
       x-menu-order: 2
       x-undo:
         type: safe
-      x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types\
-        \ is only accessible for Metrics without Limits&trade; beta customers.\nIf\
-        \ you\u2019re interested in Metrics without Limits&trade;, please contact\
-        \ your Customer Success Manager.**"
+      x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types
+        is only accessible for Metrics without Limits&trade; beta customers.\nIf you\u2019re
+        interested in Metrics without Limits&trade;, please contact your Customer
+        Success Manager.**"
     patch:
       description: 'Update the tag configuration of a metric or percentile aggregations
         of a distribution metric. Can only be used with
@@ -6829,10 +6892,10 @@ paths:
       x-menu-order: 3
       x-undo:
         type: idempotent
-      x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types\
-        \ is only accessible for Metrics without Limits&trade; beta customers.\nIf\
-        \ you\u2019re interested in Metrics without Limits&trade;, please contact\
-        \ your Customer Success Manager.**"
+      x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types
+        is only accessible for Metrics without Limits&trade; beta customers.\nIf you\u2019re
+        interested in Metrics without Limits&trade;, please contact your Customer
+        Success Manager.**"
     post:
       description: 'Create and define a list of queryable tag keys for an existing
         count/gauge/rate/distribution metric. Optionally, include percentile aggregations
@@ -6890,10 +6953,10 @@ paths:
           - name: metric_name
             value: '"{{ unique_alnum }}"'
           - name: body
-            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"tags\":[\"app\"\
-              , \"datacenter\", \"{{ unique_alnum }}\"],\n      \"metric_type\":\"\
-              distribution\"\n     },\n     \"type\": \"manage_tags\",\n     \"id\"\
-              : \"{{ unique_alnum }}\"\n  }\n}"
+            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"tags\":[\"app\",
+              \"datacenter\", \"{{ unique_alnum }}\"],\n      \"metric_type\":\"distribution\"\n
+              \    },\n     \"type\": \"manage_tags\",\n     \"id\": \"{{ unique_alnum
+              }}\"\n  }\n}"
           step: there is a valid "metric_tag_configuration" in the system
       x-menu-order: 1
       x-undo:
@@ -6902,10 +6965,10 @@ paths:
         - name: metric_name
           source: data.id
         type: unsafe
-      x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types\
-        \ is only accessible for Metrics without Limits&trade; beta customers.\nIf\
-        \ you\u2019re interested in Metrics without Limits&trade;, please contact\
-        \ your Customer Success Manager.**"
+      x-unstable: "**Note: Use of this endpoint for count/gauge/rate metric types
+        is only accessible for Metrics without Limits&trade; beta customers.\nIf you\u2019re
+        interested in Metrics without Limits&trade;, please contact your Customer
+        Success Manager.**"
   /api/v2/metrics/{metric_name}/volumes:
     get:
       description: 'View distinct metrics volumes for the given metric name.
@@ -7160,8 +7223,8 @@ paths:
         role:
           parameters:
           - name: body
-            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"{{\
-              \ unique }}\"\n     },\n     \"type\": \"roles\"\n  }\n}"
+            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"{{
+              unique }}\"\n     },\n     \"type\": \"roles\"\n  }\n}"
           step: there is a valid "role" in the system
       x-menu-order: 2
       x-undo:
@@ -7400,8 +7463,8 @@ paths:
           - name: role_id
             source: role.data.id
           - name: body
-            value: "{\n  \"data\": {\n    \"id\": \"{{ permission.id }}\",\n    \"\
-              type\": \"{{ permission.type }}\"\n  }\n}"
+            value: "{\n  \"data\": {\n    \"id\": \"{{ permission.id }}\",\n    \"type\":
+              \"{{ permission.type }}\"\n  }\n}"
           step: the "permission" is granted to the "role"
       x-menu-order: 7
       x-undo:
@@ -7546,8 +7609,8 @@ paths:
           - name: role_id
             source: role.data.id
           - name: body
-            value: "{\n  \"data\": {\n    \"id\": \"{{ user.data.id }}\",\n    \"\
-              type\": \"{{ user.data.type }}\"\n  }\n}"
+            value: "{\n  \"data\": {\n    \"id\": \"{{ user.data.id }}\",\n    \"type\":
+              \"{{ user.data.type }}\"\n  }\n}"
           step: the "user" has the "role"
       x-menu-order: 10
       x-undo:
@@ -7610,12 +7673,12 @@ paths:
         security_filter:
           parameters:
           - name: body
-            value: "{\n  \"data\": {\n    \"type\": \"security_filters\",\n    \"\
-              attributes\": {\n      \"name\": \"{{ unique }}\",\n      \"query\"\
-              : \"service:{{ unique_alnum }}\",\n      \"exclusion_filters\":[\n \
-              \       {\n          \"name\": \"Exclude logs from staging\",\n    \
-              \      \"query\": \"source:staging\"\n        }\n     ],\n      \"filtered_data_type\"\
-              :\"logs\",\n      \"is_enabled\": true\n     }\n  }\n}"
+            value: "{\n  \"data\": {\n    \"type\": \"security_filters\",\n    \"attributes\":
+              {\n      \"name\": \"{{ unique }}\",\n      \"query\": \"service:{{
+              unique_alnum }}\",\n      \"exclusion_filters\":[\n        {\n          \"name\":
+              \"Exclude logs from staging\",\n          \"query\": \"source:staging\"\n
+              \       }\n     ],\n      \"filtered_data_type\":\"logs\",\n      \"is_enabled\":
+              true\n     }\n  }\n}"
           step: there is a valid "security_filter" in the system
       x-undo:
         operationId: DeleteSecurityFilter
@@ -7630,14 +7693,8 @@ paths:
       parameters:
       - $ref: '#/components/parameters/SecurityFilterID'
       responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/SecurityFilterDeleteResponse'
-          description: OK
         '204':
-          description: No Content
+          description: OK
         '403':
           $ref: '#/components/responses/NotAuthorizedResponse'
         '404':
@@ -7764,14 +7821,14 @@ paths:
         security_rule:
           parameters:
           - name: body
-            value: "{\n  \"name\": \"{{ unique }}\",\n  \"queries\": [{\n    \"query\"\
-              : \"@test:true\",\n    \"aggregation\": \"count\",\n    \"groupByFields\"\
-              : [],\n    \"distinctFields\": [],\n    \"metric\": \"\"\n  }],\n  \"\
-              filters\": [],\n  \"cases\": [{\n    \"name\": \"\",\n    \"status\"\
-              : \"info\",\n    \"condition\": \"a > 0\",\n    \"notifications\": []\n\
-              \  }],\n  \"options\": {\n    \"evaluationWindow\": 900,\n    \"keepAlive\"\
-              : 3600,\n    \"maxSignalDuration\": 86400\n  },\n  \"message\": \"Test\
-              \ rule\",\n  \"tags\": [],\n  \"isEnabled\": true\n}"
+            value: "{\n  \"name\": \"{{ unique }}\",\n  \"queries\": [{\n    \"query\":
+              \"@test:true\",\n    \"aggregation\": \"count\",\n    \"groupByFields\":
+              [],\n    \"distinctFields\": [],\n    \"metric\": \"\"\n  }],\n  \"filters\":
+              [],\n  \"cases\": [{\n    \"name\": \"\",\n    \"status\": \"info\",\n
+              \   \"condition\": \"a > 0\",\n    \"notifications\": []\n  }],\n  \"options\":
+              {\n    \"evaluationWindow\": 900,\n    \"keepAlive\": 3600,\n    \"maxSignalDuration\":
+              86400\n  },\n  \"message\": \"Test rule\",\n  \"tags\": [],\n  \"isEnabled\":
+              true\n}"
           step: there is a valid "security_rule" in the system
       x-menu-order: 2
       x-undo:
@@ -8037,8 +8094,8 @@ paths:
         service:
           parameters:
           - name: body
-            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"{{\
-              \ unique }}\"\n     },\n     \"type\": \"services\"\n  }\n}"
+            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"{{
+              unique }}\"\n     },\n     \"type\": \"services\"\n  }\n}"
           step: there is a valid "service" in the system
       x-undo:
         operationId: DeleteIncidentService
@@ -8210,8 +8267,8 @@ paths:
         team:
           parameters:
           - name: body
-            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"{{\
-              \ unique }}\"\n     },\n     \"type\": \"teams\"\n  }\n}"
+            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"{{
+              unique }}\"\n     },\n     \"type\": \"teams\"\n  }\n}"
           step: there is a valid "team" in the system
       x-undo:
         operationId: DeleteIncidentTeam
@@ -8353,10 +8410,9 @@ paths:
         user_invitation:
           parameters:
           - name: body
-            value: "{\n  \"data\": [\n    {\n      \"relationships\": {\"user\": {\"\
-              data\": {\n        \"id\": \"{{ user.data.id }}\",\n        \"type\"\
-              : \"{{ user.data.type }}\"\n      }}},\n      \"type\": \"user_invitations\"\
-              \n    }\n  ]\n}"
+            value: "{\n  \"data\": [\n    {\n      \"relationships\": {\"user\": {\"data\":
+              {\n        \"id\": \"{{ user.data.id }}\",\n        \"type\": \"{{ user.data.type
+              }}\"\n      }}},\n      \"type\": \"user_invitations\"\n    }\n  ]\n}"
           source: data[0]
           step: the "user" has a "user_invitation"
       x-menu-order: 8
@@ -8509,9 +8565,9 @@ paths:
         user:
           parameters:
           - name: body
-            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"email\": \"{{\
-              \ unique }}@datadoghq.com\",\n      \"title\": \"user title\"\n    \
-              \ },\n     \"type\": \"users\"\n  }\n}"
+            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"email\": \"{{
+              unique }}@datadoghq.com\",\n      \"title\": \"user title\"\n     },\n
+              \    \"type\": \"users\"\n  }\n}"
           step: there is a valid "user" in the system
       x-menu-order: 2
       x-undo:
@@ -8669,8 +8725,8 @@ paths:
         type: safe
   /api/v2/users/{user_id}/permissions:
     get:
-      description: "Get a user permission set. Returns a list of the user\u2019s permissions\n\
-        granted by the associated user's roles."
+      description: "Get a user permission set. Returns a list of the user\u2019s permissions\ngranted
+        by the associated user's roles."
       operationId: ListUserPermissions
       parameters:
       - $ref: '#/components/parameters/UserID'
@@ -8778,14 +8834,13 @@ tags:
     description: Find out more at
     url: https://docs.datadoghq.com/logs/logs_to_metrics/
   name: Logs Metrics
-- description: "The metrics endpoint allows you to:\n\n- Post metrics data so it can\
-    \ be graphed on Datadog\u2019s dashboards\n- Query metrics from any time period\n\
-    - Modify tag configurations for metrics\n- View tags and volumes for metrics\n\
-    \n**Note**: A graph can only contain a set number of points\nand as the timeframe\
-    \ over which a metric is viewed increases,\naggregation between points occurs\
-    \ to stay below that set number.\n\nThe Post, Patch, and Delete `manage_tags`\
-    \ API methods can only be performed by\na user who has the `Manage Tags for Metrics`\
-    \ permission."
+- description: "The metrics endpoint allows you to:\n\n- Post metrics data so it can
+    be graphed on Datadog\u2019s dashboards\n- Query metrics from any time period\n-
+    Modify tag configurations for metrics\n- View tags and volumes for metrics\n\n**Note**:
+    A graph can only contain a set number of points\nand as the timeframe over which
+    a metric is viewed increases,\naggregation between points occurs to stay below
+    that set number.\n\nThe Post, Patch, and Delete `manage_tags` API methods can
+    only be performed by\na user who has the `Manage Tags for Metrics` permission."
   name: Metrics
 - description: The processes API allows you to query processes data for your organization.
   name: Processes