.generator/schemas/v2/openapi.yaml in datadog_api_client-1.10.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-1.11.0

- old
+ new

@@ -222,10 +222,17 @@ in: path name: metric_name required: true schema: type: string + OpsgenieServiceIDPathParameter: + description: The UUID of the service. + in: path + name: integration_service_id + required: true + schema: + type: string PageNumber: description: Specific page number to return. in: query name: page[number] required: false @@ -2603,14 +2610,16 @@ - data type: object IntakePayloadAccepted: description: The payload accepted for intake. properties: - status: - description: The status of the intake payload. - example: ok - type: string + errors: + description: A list of errors. + items: + description: An empty error list. + type: string + type: array type: object ListApplicationKeysResponse: description: Response for a list of application keys. properties: data: @@ -4308,11 +4317,10 @@ to be created. properties: aggregations: $ref: '#/components/schemas/MetricCustomAggregations' include_percentiles: - default: false description: 'Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`.' example: true @@ -4400,11 +4408,10 @@ to be updated. properties: aggregations: $ref: '#/components/schemas/MetricCustomAggregations' include_percentiles: - default: false description: 'Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`.' example: true @@ -4508,10 +4515,178 @@ $ref: '#/components/schemas/UsersType' required: - id - type type: object + OpsgenieServiceCreateAttributes: + description: The Opsgenie service attributes for a create request. + properties: + custom_url: + description: The custom URL for a custom region. + example: https://example.com + type: string + name: + description: The name for the Opsgenie service. + example: fake-opsgenie-service-name + type: string + opsgenie_api_key: + description: The Opsgenie API key for your Opsgenie service. + example: 00000000-0000-0000-0000-000000000000 + type: string + region: + $ref: '#/components/schemas/OpsgenieServiceRegionType' + required: + - name + - opsgenie_api_key + - region + type: object + OpsgenieServiceCreateData: + description: Opsgenie service data for a create request. + properties: + attributes: + $ref: '#/components/schemas/OpsgenieServiceCreateAttributes' + type: + $ref: '#/components/schemas/OpsgenieServiceType' + required: + - type + - attributes + type: object + OpsgenieServiceCreateRequest: + description: Create request for an Opsgenie service. + properties: + data: + $ref: '#/components/schemas/OpsgenieServiceCreateData' + required: + - data + type: object + OpsgenieServiceRegionType: + description: The region for the Opsgenie service. + enum: + - us + - eu + - custom + example: us + type: string + x-enum-varnames: + - US + - EU + - CUSTOM + OpsgenieServiceResponse: + description: Response of an Opsgenie service. + properties: + data: + $ref: '#/components/schemas/OpsgenieServiceResponseData' + required: + - data + type: object + OpsgenieServiceResponseAttributes: + description: The attributes from an Opsgenie service response. + properties: + custom_url: + description: The custom URL for a custom region. + example: null + nullable: true + type: string + name: + description: The name for the Opsgenie service. + example: fake-opsgenie-service-name + type: string + region: + $ref: '#/components/schemas/OpsgenieServiceRegionType' + type: object + OpsgenieServiceResponseData: + description: Opsgenie service data from a response. + properties: + attributes: + $ref: '#/components/schemas/OpsgenieServiceResponseAttributes' + id: + description: The ID of the Opsgenie service. + example: 596da4af-0563-4097-90ff-07230c3f9db3 + type: string + type: + $ref: '#/components/schemas/OpsgenieServiceType' + required: + - id + - type + - attributes + type: object + OpsgenieServiceType: + default: opsgenie-service + description: Opsgenie service resource type. + enum: + - opsgenie-service + example: opsgenie-service + type: string + x-enum-varnames: + - OPSGENIE_SERVICE + OpsgenieServiceUpdateAttributes: + description: The Opsgenie service attributes for an update request. + properties: + custom_url: + description: The custom URL for a custom region. + example: https://example.com + nullable: true + type: string + name: + description: The name for the Opsgenie service. + example: fake-opsgenie-service-name + type: string + opsgenie_api_key: + description: The Opsgenie API key for your Opsgenie service. + example: 00000000-0000-0000-0000-000000000000 + type: string + region: + $ref: '#/components/schemas/OpsgenieServiceRegionType' + type: object + OpsgenieServiceUpdateData: + description: Opsgenie service for an update request. + properties: + attributes: + $ref: '#/components/schemas/OpsgenieServiceUpdateAttributes' + id: + description: The ID of the Opsgenie service. + example: 596da4af-0563-4097-90ff-07230c3f9db3 + type: string + type: + $ref: '#/components/schemas/OpsgenieServiceType' + required: + - id + - type + - attributes + type: object + OpsgenieServiceUpdateRequest: + description: Update request for an Opsgenie service. + properties: + data: + $ref: '#/components/schemas/OpsgenieServiceUpdateData' + required: + - data + type: object + OpsgenieServicesResponse: + description: Response with a list of Opsgenie services. + properties: + data: + description: An array of Opsgenie services. + example: + - attributes: + custom_url: null + name: fake-opsgenie-service-name + region: us + id: 596da4af-0563-4097-90ff-07230c3f9db3 + type: opsgenie-service + - attributes: + custom_url: null + name: fake-opsgenie-service-name-2 + region: eu + id: 0d2937f1-b561-44fa-914a-99910f848014 + type: opsgenie-service + items: + $ref: '#/components/schemas/OpsgenieServiceResponseData' + type: array + required: + - data + type: object Organization: description: Organization object. properties: attributes: $ref: '#/components/schemas/OrganizationAttributes' @@ -6165,10 +6340,21 @@ - queries - options - cases - message type: object + SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv: + description: 'If true, signals in non-production environments have a lower severity + than what is defined by the rule case, which can reduce signal noise. + + The severity is decreased by one level: `CRITICAL` in production becomes `HIGH` + in non-production, `HIGH` becomes `MEDIUM` and so on. `INFO` remains `INFO`. + + The decrement is applied when the environment tag of the signal starts with + `staging`, `test` or `dev`.' + example: false + type: boolean SecurityMonitoringRuleDetectionMethod: description: The detection method. enum: - threshold - new_value @@ -6292,10 +6478,14 @@ properties: forgetAfter: $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsForgetAfter' learningDuration: $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningDuration' + learningMethod: + $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningMethod' + learningThreshold: + $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningThreshold' type: object SecurityMonitoringRuleNewValueOptionsForgetAfter: description: The duration in days after which a learned value is forgotten. enum: - 1 @@ -6312,10 +6502,11 @@ - ONE_WEEK - TWO_WEEKS - THREE_WEEKS - FOUR_WEEKS SecurityMonitoringRuleNewValueOptionsLearningDuration: + default: 0 description: 'The duration in days during which values are learned, and after which signals will be generated for values that weren''t learned. If set to 0, a signal will be generated for all new values after the first value is learned.' @@ -6327,13 +6518,38 @@ type: integer x-enum-varnames: - ZERO_DAYS - ONE_DAY - SEVEN_DAYS + SecurityMonitoringRuleNewValueOptionsLearningMethod: + default: duration + description: The learning method used to determine when signals should be generated + for values that weren't learned. + enum: + - duration + - threshold + type: string + x-enum-varnames: + - DURATION + - THRESHOLD + SecurityMonitoringRuleNewValueOptionsLearningThreshold: + default: 0 + description: A number of occurrences after which signals will be generated for + values that weren't learned. + enum: + - 0 + - 1 + format: int32 + type: integer + x-enum-varnames: + - ZERO_OCCURRENCES + - ONE_OCCURRENCE SecurityMonitoringRuleOptions: description: Options on rules. properties: + decreaseCriticalityBasedOnEnv: + $ref: '#/components/schemas/SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv' detectionMethod: $ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod' evaluationWindow: $ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow' hardcodedEvaluatorType: @@ -7134,18 +7350,19 @@ description: This API uses OAuth 2 with the implicit grant flow. flows: authorizationCode: authorizationUrl: /oauth2/v1/authorize scopes: - dashboards_public_share: Share dashboards externally. dashboards_read: View dashboards. dashboards_write: Create and change dashboards. events_read: Read Events data. incident_read: View incidents in Datadog. incident_settings_write: Configure Incidents settings. incident_write: Create, view, and manage incidents in Datadog. metrics_read: View custom metrics. + monitors_read: View monitors. + monitors_write: Edit, mute, and delete individual monitors. security_monitoring_filters_read: Read Security Filters. security_monitoring_filters_write: Create, edit, and delete Security Filters. security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. security_monitoring_signals_read: View Security Signals. @@ -8510,10 +8727,163 @@ x-undo: type: idempotent x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/integration/opsgenie/services: + get: + description: Get a list of all services from the Datadog Opsgenie integration. + operationId: ListOpsgenieServices + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OpsgenieServicesResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get all service objects + tags: + - Opsgenie Integration + x-menu-order: 1 + x-undo: + type: safe + post: + description: Create a new service object in the Opsgenie integration. + operationId: CreateOpsgenieService + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpsgenieServiceCreateRequest' + description: Opsgenie service payload + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/OpsgenieServiceResponse' + description: CREATED + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Create a new service object + tags: + - Opsgenie Integration + x-codegen-request-body-name: body + x-given: + opsgenie_service: + parameters: + - name: body + value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{ + unique }}\",\n \"opsgenie_api_key\": \"00000000-0000-0000-0000-000000000000\",\n + \ \"region\": \"us\"\n },\n \"type\": \"opsgenie-service\"\n + \ }\n}" + step: there is a valid "opsgenie_service" in the system + x-menu-order: 2 + x-undo: + operationId: DeleteOpsgenieService + parameters: + - name: integration_service_id + source: data.id + type: unsafe + /api/v2/integration/opsgenie/services/{integration_service_id}: + delete: + description: Delete a single service object in the Datadog Opsgenie integration. + operationId: DeleteOpsgenieService + parameters: + - $ref: '#/components/parameters/OpsgenieServiceIDPathParameter' + responses: + '204': + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Delete a single service object + tags: + - Opsgenie Integration + x-menu-order: 5 + x-undo: + type: idempotent + get: + description: Get a single service from the Datadog Opsgenie integration. + operationId: GetOpsgenieService + parameters: + - $ref: '#/components/parameters/OpsgenieServiceIDPathParameter' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OpsgenieServiceResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get a single service object + tags: + - Opsgenie Integration + x-menu-order: 3 + x-undo: + type: safe + patch: + description: Update a single service object in the Datadog Opsgenie integration. + operationId: UpdateOpsgenieService + parameters: + - $ref: '#/components/parameters/OpsgenieServiceIDPathParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpsgenieServiceUpdateRequest' + description: Opsgenie service payload. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OpsgenieServiceResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Update a single service object + tags: + - Opsgenie Integration + x-codegen-request-body-name: body + x-menu-order: 4 + x-undo: + type: idempotent /api/v2/logs: post: description: 'Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: @@ -9573,14 +9943,10 @@ tags: - Metrics 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™ beta customers.\nIf you\u2019re - interested in Metrics without Limits™, please contact your Customer - Success Manager.**" /api/v2/metrics/config/bulk-tags: delete: description: 'Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics. @@ -9883,14 +10249,10 @@ tags: - Metrics 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™ beta customers.\nIf you\u2019re - interested in Metrics without Limits™, please contact your Customer - Success Manager.**" get: description: Returns the tag configuration for the given metric name. operationId: ListTagConfigurationByName parameters: - $ref: '#/components/parameters/MetricName' @@ -9923,14 +10285,10 @@ tags: - Metrics 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™ beta customers.\nIf you\u2019re - interested in Metrics without Limits™, please contact your Customer - Success Manager.**" patch: description: 'Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations of a count, rate, or gauge metric. @@ -9982,14 +10340,10 @@ - Metrics x-codegen-request-body-name: body 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™ beta customers.\nIf you\u2019re - interested in Metrics without Limits™, 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 on any distribution metric or @@ -10059,25 +10413,15 @@ operationId: DeleteTagConfiguration parameters: - 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™ beta customers.\nIf you\u2019re - interested in Metrics without Limits™, please contact your Customer - Success Manager.**" /api/v2/metrics/{metric_name}/volumes: get: description: 'View distinct metrics volumes for the given metric name. - Custom distribution metrics will return both ingested and indexed custom metric - volumes. - - For Metrics without Limits™ beta customers, all metrics will return - both ingested/indexed volumes. - Custom metrics generated in-app from other products will return `null` for ingested volumes.' operationId: ListVolumesByMetricName parameters: - $ref: '#/components/parameters/MetricName' @@ -11094,15 +11438,10 @@ description: OK '403': $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_read summary: Get the latest Cloud Workload Security policy tags: - Cloud Workload Security x-menu-order: 1 x-undo: @@ -11700,13 +12039,10 @@ cursorPath: meta.page.after limitParam: page[limit] resultsPath: data x-undo: type: safe - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/security_monitoring/signals/search: post: description: 'Returns security signals that match a search query. Both this endpoint and the GET endpoint can be used interchangeably for listing @@ -11747,13 +12083,10 @@ cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data x-undo: type: safe - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/series: post: description: "The metrics end-point allows you to post time-series data that can be graphed on Datadog\u2019s dashboards.\nThe maximum payload size is 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed @@ -12613,10 +12946,85 @@ tags: - Usage Metering x-menu-order: 39 x-undo: type: safe + /api/v2/usage/estimated_cost_by_org: + get: + description: Get estimated cost across multi-org account. + operationId: GetEstimatedCostByOrg + parameters: + - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` + for cost beginning this month. Either start_month or start_date should be + specified, but not both.' + in: query + name: start_month + required: false + schema: + format: date-time + type: string + - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` + for cost ending this month.' + in: query + name: end_month + required: false + schema: + format: date-time + type: string + - description: 'Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` + for cost beginning this day. Either start_month or start_date should be + specified, but not both.' + in: query + name: start_date + required: false + schema: + format: date-time + type: string + - description: 'Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` + for cost ending this day.' + in: query + name: end_date + required: false + schema: + format: date-time + type: string + responses: + '200': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/CostByOrgResponse' + description: OK + '400': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Forbidden - User is not authorized + '429': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Too many requests + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read + summary: Get estimated cost across multi-org account + tags: + - Usage Metering + x-menu-order: 39 + x-undo: + type: safe /api/v2/usage/lambda_traced_invocations: get: description: Get hourly usage for Lambda Traced Invocations. operationId: GetUsageLambdaTracedInvocations parameters: @@ -13271,9 +13679,15 @@ 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: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/) + + directly through the Datadog API.' + externalDocs: + url: https://docs.datadoghq.com/api/latest/opsgenie-integration + name: Opsgenie Integration - description: Create, edit, and manage your organizations. Read more about [multi-org accounts](https://docs.datadoghq.com/account_management/multi_organization). externalDocs: description: Find out more at url: https://docs.datadoghq.com/account_management/multi_organization