From c3ab283d4c7378cd6e781f7d1692ba7d1465bec6 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Thu, 9 Apr 2026 08:25:11 +0000 Subject: [PATCH] Regenerate client from commit f922991 of spec repo --- .generator/schemas/v1/openapi.yaml | 938 ++- .generator/schemas/v2/openapi.yaml | 6228 ++++++++++++++++- .../v2/oci-integration/CreateTenancyConfig.py | 4 +- .../v2/oci-integration/UpdateTenancyConfig.py | 4 +- .../v2/synthetics/DeleteSyntheticsTests.py | 2 +- tests/v2/features/oci_integration.feature | 4 +- tests/v2/features/synthetics.feature | 4 +- 7 files changed, 7103 insertions(+), 81 deletions(-) diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index 2562b6db95..65b6dfbfd5 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -25368,6 +25368,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + name: example key schema: $ref: "#/components/schemas/ApiKey" required: true @@ -25496,6 +25500,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + name: example key schema: $ref: "#/components/schemas/ApiKey" required: true @@ -25571,6 +25579,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + name: example key schema: $ref: "#/components/schemas/ApplicationKey" required: true @@ -25707,6 +25719,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + name: example key schema: $ref: "#/components/schemas/ApplicationKey" required: true @@ -25764,6 +25780,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + - check: app.ok + host_name: app.host1 + message: app is running + status: 0 + tags: + - "environment:test" schema: $ref: "#/components/schemas/ServiceChecks" description: Service Check request body. @@ -25923,6 +25948,13 @@ paths: content: application/json: examples: + default: + value: + data: + - id: 123-abc-456 + type: dashboard + - id: 789-def-101 + type: dashboard json-request-body: value: {"data": [{"id": "123-abc-456", "type": "dashboard"}, {"id": "789-def-101", "type": "dashboard"}]} schema: @@ -26042,6 +26074,13 @@ paths: content: application/json: examples: + default: + value: + data: + - id: 123-abc-456 + type: dashboard + - id: 789-def-101 + type: dashboard json-request-body: value: {"data": [{"id": "123-abc-456", "type": "dashboard"}, {"id": "789-def-101", "type": "dashboard"}]} schema: @@ -26092,6 +26131,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + description: An example dashboard for monitoring infrastructure. + layout_type: ordered + title: Example Dashboard + widgets: + - definition: + requests: + - q: avg:system.cpu.user{*} + title: CPU Usage + type: timeseries schema: $ref: "#/components/schemas/Dashboard" description: Create a dashboard request body. @@ -26169,6 +26220,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + name: My Dashboard List schema: $ref: "#/components/schemas/DashboardList" description: Create a dashboard list request body. @@ -26313,6 +26368,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + name: My Dashboard List schema: $ref: "#/components/schemas/DashboardList" description: Update a dashboard list request body. @@ -26366,6 +26425,13 @@ paths: content: application/json: examples: + default: + value: + dashboard_id: 123-abc-456 + dashboard_type: custom_timeboard + global_time: + live_span: 1h + share_type: open json-request-body: value: {"dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "share_type": "open"} schema: @@ -26527,6 +26593,21 @@ paths: content: application/json: examples: + default: + value: + global_time: + live_span: 1h + selectable_template_vars: + - default_value: "*" + name: exampleVar + prefix: test + visible_tags: + - selectableValue1 + - selectableValue2 + share_list: + - test@datadoghq.com + - test2@datadoghq.com + share_type: invite json-request-body: value: {"global_time": {"live_span": "1h"}, "selectable_template_vars": [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}], "share_list": ["test@datadoghq.com", "test2@datadoghq.com"], "share_type": "invite"} schema: @@ -26595,6 +26676,12 @@ paths: content: application/json: examples: + default: + value: + data: + attributes: + email: test@datadoghq.com + type: public_dashboard_invitation json-request-body: value: {"data": {"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}} schema: @@ -26704,6 +26791,12 @@ paths: content: application/json: examples: + default: + value: + data: + - attributes: + email: test@datadoghq.com + type: public_dashboard_invitation json-request-body: value: {"data": [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]} schema: @@ -26850,6 +26943,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + description: An example dashboard for monitoring infrastructure. + layout_type: ordered + title: Example Dashboard + widgets: + - definition: + requests: + - q: avg:system.cpu.user{*} + title: CPU Usage + type: timeseries schema: $ref: "#/components/schemas/Dashboard" description: Update Dashboard request body. @@ -26909,6 +27014,16 @@ paths: content: text/json: examples: + default: + value: + series: + - host: test.example.com + metric: system.load.1 + points: + - [1636629071, [1.0, 2.0]] + tags: + - "environment:test" + type: distribution dynamic-points: description: Post time-series data that can be graphed on Datadog’s dashboards. externalValue: examples/metrics/distribution-points.json.sh @@ -27013,6 +27128,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + end: 1412793983 + message: Scheduling downtime for a database maintenance window. + monitor_tags: + - "*" + scope: + - env:staging + start: 1412792983 + timezone: America/New_York schema: $ref: "#/components/schemas/Downtime" description: Schedule a downtime request body. @@ -27060,6 +27186,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + scope: host:myserver schema: $ref: "#/components/schemas/CancelDowntimesByScopeRequest" description: Scope to cancel downtimes for. @@ -27213,6 +27343,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + end: 1412793983 + message: Updating downtime end time. + monitor_tags: + - "*" + scope: + - env:staging + start: 1412792983 + timezone: America/New_York schema: $ref: "#/components/schemas/Downtime" description: Update a downtime request body. @@ -27372,6 +27513,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + priority: normal + tags: + - environment:test + text: Oh boy! + title: Did you hear the news today? schema: $ref: "#/components/schemas/EventCreateRequest" description: Event request object @@ -27554,6 +27703,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + end: 1579098130 + message: Muting this host for a test! + override: false schema: $ref: "#/components/schemas/HostMuteSettings" description: Mute a host request body. @@ -27769,6 +27924,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "123456789012" + role_name: "DatadogAWSIntegrationRole" schema: $ref: "#/components/schemas/AWSAccountDeleteRequest" description: AWS request object @@ -27870,6 +28030,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "123456789012" + account_specific_namespace_rules: + auto_scaling: false + opswork: false + cspm_resource_collection_enabled: true + excluded_regions: + - us-east-1 + - us-west-2 + extended_resource_collection_enabled: true + filter_tags: + - "$KEY:$VALUE" + host_tags: + - "$KEY:$VALUE" + metrics_collection_enabled: false + role_name: "DatadogAWSIntegrationRole" schema: $ref: "#/components/schemas/AWSAccount" description: AWS Request Object @@ -27939,6 +28117,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "123456789012" + account_specific_namespace_rules: + auto_scaling: false + opswork: false + cspm_resource_collection_enabled: true + excluded_regions: + - us-east-1 + - us-west-2 + extended_resource_collection_enabled: true + filter_tags: + - "$KEY:$VALUE" + host_tags: + - "$KEY:$VALUE" + metrics_collection_enabled: false + role_name: "DatadogAWSIntegrationRole" schema: $ref: "#/components/schemas/AWSAccount" description: AWS request object @@ -28016,6 +28212,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "123456789012" + event_generator_name: app-alerts-zyxw3210 + region: us-east-1 schema: $ref: "#/components/schemas/AWSEventBridgeDeleteRequest" description: Delete the Amazon EventBridge source with the given name, region, and associated AWS account. @@ -28088,6 +28290,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "123456789012" + create_event_bus: true + event_generator_name: app-alerts + region: us-east-1 schema: $ref: "#/components/schemas/AWSEventBridgeCreateRequest" description: Create an Amazon EventBridge source for an AWS account with a given name and region. @@ -28129,6 +28338,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "FAKEAC0FAKEAC2FAKEAC" + namespace: elb schema: $ref: "#/components/schemas/AWSTagFilterDeleteRequest" description: Delete a tag filtering entry for a given AWS account and `dd-aws` namespace. @@ -28209,6 +28423,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "123456789012" + namespace: elb + tag_filter_str: "prod*" schema: $ref: "#/components/schemas/AWSTagFilterCreateRequest" description: |- @@ -28253,6 +28473,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "123456789012" + role_name: "DatadogAWSIntegrationRole" schema: $ref: "#/components/schemas/AWSAccount" description: |- @@ -28297,6 +28522,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "1234567" + lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest" schema: $ref: "#/components/schemas/AWSAccountAndLambdaRequest" description: Delete AWS Lambda ARN request body. @@ -28373,6 +28603,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "1234567" + lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest" schema: $ref: "#/components/schemas/AWSAccountAndLambdaRequest" description: AWS Log Lambda Async request body. @@ -28421,6 +28656,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "1234567" + lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest" schema: $ref: "#/components/schemas/AWSAccountAndLambdaRequest" description: Check AWS Log Lambda Async request body. @@ -28493,6 +28733,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "1234567" + services: + - s3 + - elb + - elbv2 + - cloudfront + - redshift + - lambda schema: $ref: "#/components/schemas/AWSLogsServicesRequest" description: Enable AWS Log Services request body. @@ -28543,6 +28794,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + account_id: "1234567" + services: + - s3 + - elb + - elbv2 + - cloudfront + - redshift + - lambda schema: $ref: "#/components/schemas/AWSLogsServicesRequest" description: Check AWS Logs Async Services request body. @@ -28584,6 +28846,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + client_id: "testc7f6-1234-5678-9101-3fcbf464test" + tenant_name: "testc44-1234-5678-9101-cc00736ftest" schema: $ref: "#/components/schemas/AzureAccount" description: Delete a given Datadog-Azure integration request body. @@ -28663,6 +28930,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + app_service_plan_filters: "key:value,filter:example" + automute: true + client_id: "testc7f6-1234-5678-9101-3fcbf464test" + client_secret: "TestingRh2nx664kUy5dIApvM54T4AtO" + container_app_filters: "key:value,filter:example" + cspm_enabled: true + custom_metrics_enabled: true + host_filters: "key:value,filter:example" + metrics_enabled: true + resource_collection_enabled: true + tenant_name: "testc44-1234-5678-9101-cc00736ftest" schema: $ref: "#/components/schemas/AzureAccount" description: Create a Datadog-Azure integration for your Datadog account request body. @@ -28706,6 +28987,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + automute: true + client_id: "testc7f6-1234-5678-9101-3fcbf464test" + client_secret: "TestingRh2nx664kUy5dIApvM54T4AtO" + cspm_enabled: true + host_filters: "key:value,filter:example" + metrics_enabled: true + new_client_id: "new1c7f6-1234-5678-9101-3fcbf464test" + new_tenant_name: "new1c44-1234-5678-9101-cc00736ftest" + resource_collection_enabled: true + tenant_name: "testc44-1234-5678-9101-cc00736ftest" schema: $ref: "#/components/schemas/AzureAccount" description: Update a Datadog-Azure integration request body. @@ -28748,6 +29042,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + client_id: "testc7f6-1234-5678-9101-3fcbf464test" + host_filters: "key:value,filter:example" + tenant_name: "testc44-1234-5678-9101-cc00736ftest" schema: $ref: "#/components/schemas/AzureAccount" description: Update a Datadog-Azure integration's host filters request body. @@ -28791,6 +29091,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + client_email: "api-dev@datadog-sandbox.iam.gserviceaccount.com" + client_id: "123456712345671234567" + project_id: "datadog-apitest" schema: $ref: "#/components/schemas/GCPAccount" description: Delete a given Datadog-GCP integration. @@ -28866,6 +29172,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + auth_provider_x509_cert_url: "https://www.googleapis.com/oauth2/v1/certs" + auth_uri: "https://accounts.google.com/o/oauth2/auth" + client_email: "api-dev@datadog-sandbox.iam.gserviceaccount.com" + client_id: "123456712345671234567" + client_x509_cert_url: "https://www.googleapis.com/robot/v1/metadata/x509/$CLIENT_EMAIL" + host_filters: "$KEY1:$VALUE1,$KEY2:$VALUE2" + is_cspm_enabled: true + private_key: "private_key" + private_key_id: "123456789abcdefghi123456789abcdefghijklm" + project_id: "datadog-apitest" + resource_collection_enabled: true + token_uri: "https://accounts.google.com/o/oauth2/token" + type: "service_account" schema: $ref: "#/components/schemas/GCPAccount" description: Create a Datadog-GCP integration. @@ -28911,6 +29233,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + client_email: "api-dev@datadog-sandbox.iam.gserviceaccount.com" + client_id: "123456712345671234567" + host_filters: "$KEY1:$VALUE1,$KEY2:$VALUE2" + is_cspm_enabled: true + project_id: "datadog-apitest" + resource_collection_enabled: true schema: $ref: "#/components/schemas/GCPAccount" description: Update a Datadog-GCP integration. @@ -28952,6 +29283,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + service_key: "your-pagerduty-service-key" + service_name: "my-pagerduty-service" schema: $ref: "#/components/schemas/PagerDutyService" description: Create a new service object request body. @@ -29072,6 +29408,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + service_key: "updated-pagerduty-service-key" schema: $ref: "#/components/schemas/PagerDutyServiceKey" description: Update an existing service object request body. @@ -29155,6 +29495,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + display: + message: true + mute_buttons: false + notified: true + snapshot: true + tags: true + name: "#general" schema: $ref: "#/components/schemas/SlackIntegrationChannel" description: Payload describing Slack channel to be created @@ -29280,6 +29630,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + display: + message: true + mute_buttons: false + notified: true + snapshot: true + tags: true + name: "#general" schema: $ref: "#/components/schemas/SlackIntegrationChannel" description: Payload describing fields and values to be updated. @@ -29326,6 +29686,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + is_secret: true + name: CUSTOM_VARIABLE_NAME + value: CUSTOM_VARIABLE_VALUE schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariable" description: Define a custom variable request body. @@ -29455,6 +29821,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + is_secret: true + name: CUSTOM_VARIABLE_NAME + value: CUSTOM_VARIABLE_VALUE schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariableUpdateRequest" description: Update an existing custom variable request body. @@ -29501,6 +29873,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + encode_as: json + name: WEBHOOK_NAME + url: https://example.com/webhook schema: $ref: "#/components/schemas/WebhooksIntegration" description: Create a webhooks integration request body. @@ -29631,6 +30009,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + encode_as: json + name: WEBHOOK_NAME + url: https://example.com/webhook schema: $ref: "#/components/schemas/WebhooksIntegrationUpdateRequest" description: Update an existing Datadog-Webhooks integration. @@ -29688,6 +30072,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + index: "retention-3,retention-15" + limit: 25 + query: "service:web* AND @http.status_code:[200 TO 299]" + sort: desc + time: + from: "2020-02-02T02:02:02.202Z" + to: "2020-02-20T02:02:02.202Z" schema: $ref: "#/components/schemas/LogsListRequest" description: Logs filter @@ -29760,6 +30154,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + index_names: + - main + - payments + - web schema: $ref: "#/components/schemas/LogsIndexesOrder" description: Object containing the new ordered list of index names @@ -29828,6 +30229,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + daily_limit: 300000000 + daily_limit_warning_threshold_percentage: 70 + exclusion_filters: + - filter: + query: "*" + sample_rate: 1.0 + is_enabled: true + name: payment + filter: + query: source:python + name: main + num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndex" description: Object containing the new index. @@ -29961,6 +30377,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + daily_limit: 300000000 + daily_limit_warning_threshold_percentage: 70 + disable_daily_limit: false + exclusion_filters: + - filter: + query: "*" + sample_rate: 1.0 + is_enabled: true + name: payment + filter: + query: source:python + num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndexUpdateRequest" description: Object containing the new `LogsIndexUpdateRequest`. @@ -30033,6 +30464,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + pipeline_ids: + - tags + - org_ids + - products schema: $ref: "#/components/schemas/LogsPipelinesOrder" description: Object containing the new ordered list of pipeline IDs. @@ -30106,6 +30544,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + filter: + query: source:python + is_enabled: true + name: My Pipeline + processors: [] schema: $ref: "#/components/schemas/LogsPipeline" description: Definition of the new pipeline. @@ -30233,6 +30679,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + filter: + query: source:python + is_enabled: true + name: My Pipeline + processors: [] schema: $ref: "#/components/schemas/LogsPipeline" description: New definition of the pipeline. @@ -30386,6 +30840,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + description: Number of requests received. + per_unit: second + type: count + unit: byte schema: $ref: "#/components/schemas/MetricMetadata" description: New metadata. @@ -30772,15 +31233,18 @@ paths: content: application/json: examples: - json-request-body: + default: value: message: "You may need to add web hosts if this is consistently high." name: "Bytes received on host0" options: no_data_timeframe: 20 notify_no_data: true + priority: 3 query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" - tags: ["app:webserver", "frontend"] + tags: + - "app:webserver" + - "frontend" type: "query alert" schema: $ref: "#/components/schemas/Monitor" @@ -31045,6 +31509,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + message: "You may need to add web hosts if this is consistently high." + name: "My monitor" + options: + no_data_timeframe: 20 + notify_no_data: true + query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" + tags: + - "app:webserver" + - "frontend" + type: "query alert" schema: $ref: "#/components/schemas/Monitor" description: Monitor request object @@ -31233,6 +31710,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + message: "Updated notification message for this monitor." + name: "Updated monitor name" + options: + no_data_timeframe: 20 + notify_no_data: true + priority: 3 + query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" + tags: + - "app:webserver" + - "frontend" + type: "query alert" schema: $ref: "#/components/schemas/MonitorUpdateRequest" description: Edit a monitor request body. @@ -31349,6 +31840,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + message: "You may need to add web hosts if this is consistently high." + name: "My monitor" + options: + no_data_timeframe: 20 + notify_no_data: true + query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" + tags: + - "app:webserver" + - "frontend" + type: "query alert" schema: $ref: "#/components/schemas/Monitor" description: Monitor request object @@ -31635,6 +32139,39 @@ paths: content: application/json: examples: + default: + value: + data: + attributes: + cells: + - attributes: + definition: + text: "## Some test markdown\n\nWith some example content." + type: markdown + type: notebook_cells + - attributes: + definition: + requests: + - display_type: line + q: "avg:system.load.1{*}" + style: + line_type: solid + line_width: normal + palette: dog_classic + show_legend: true + type: timeseries + yaxis: + scale: linear + graph_size: m + split_by: + keys: [] + tags: [] + time: + type: notebook_cells + name: "Example Notebook" + time: + live_span: 1h + type: notebooks json-request-body: value: {"data": {"attributes": {"cells": [{"attributes": {"definition": {"text": "## Some test markdown\n\nWith some example content.", "type": "markdown"}}, "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "type": "notebook_cells"}], "name": "Example Notebook", "time": {"live_span": "1h"}}, "type": "notebooks"}} schema: @@ -31772,6 +32309,40 @@ paths: content: application/json: examples: + default: + value: + data: + attributes: + cells: + - attributes: + definition: + text: "## Some updated test markdown\n\nWith some example content." + type: markdown + type: notebook_cells + - attributes: + definition: + requests: + - display_type: bars + q: "avg:system.load.1{*}" + style: + line_type: solid + line_width: normal + palette: warm + show_legend: true + type: timeseries + yaxis: + scale: linear + graph_size: m + split_by: + keys: [] + tags: [] + time: + id: "abcd1234" + type: notebook_cells + name: "Example Notebook" + time: + live_span: 1h + type: notebooks json-request-body: value: {"data": {"attributes": {"cells": [{"attributes": {"definition": {"text": "## Some updated test markdown\n\nWith some example content.", "type": "markdown"}}, "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "bars", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "warm"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "id": "abcd1234", "type": "notebook_cells"}], "name": "Example Notebook", "time": {"live_span": "1h"}}, "type": "notebooks"}} schema: @@ -31861,6 +32432,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + billing: + type: parent_billing + name: "New child org" + subscription: + type: pro schema: $ref: "#/components/schemas/OrganizationCreateBody" description: Organization object that needs to be created @@ -31944,6 +32523,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + billing: + type: parent_billing + name: "New child org" + settings: + saml: + enabled: false + saml_idp_initiated_login: + enabled: false + saml_strict_mode: + enabled: false schema: $ref: "#/components/schemas/Organization" required: true @@ -32029,6 +32621,10 @@ paths: requestBody: content: multipart/form-data: + examples: + default: + value: + idp_file: "@/path/to/idp_metadata.xml" schema: $ref: "#/components/schemas/IdpFormData" required: true @@ -32179,6 +32775,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + incident_id: 2066 + version: 0 schema: $ref: "#/components/schemas/AddSignalToIncidentRequest" description: Attributes describing the signal update. @@ -32228,6 +32829,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + assignee: "773b045d-ccf8-4808-bd3b-955ef6a8c940" + version: 0 schema: $ref: "#/components/schemas/SignalAssigneeUpdateRequest" description: Attributes describing the signal update. @@ -32277,6 +32883,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + archiveReason: none + state: open + version: 0 schema: $ref: "#/components/schemas/SignalStateUpdateRequest" description: Attributes describing the signal update. @@ -32341,6 +32953,16 @@ paths: content: text/json: examples: + default: + value: + series: + - host: test.example.com + metric: system.load.1 + points: + - [1636629071, 0.7] + tags: + - "environment:test" + type: gauge dynamic-points: description: Post time-series data that can be graphed on Datadog’s dashboards. externalValue: examples/metrics/dynamic-points.json.sh @@ -32490,6 +33112,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + description: "Track the availability of our custom metric." + name: "Custom Metric SLO" + query: + denominator: "sum:my.custom.metric{*}.as_count()" + numerator: "sum:my.custom.metric{type:good}.as_count()" + tags: + - "env:prod" + - "app:core" + thresholds: + - target: 95 + timeframe: 7d + - target: 95 + timeframe: 30d + warning: 97 + type: metric schema: $ref: "#/components/schemas/ServiceLevelObjectiveRequest" description: Service level objective request object. @@ -32540,6 +33180,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + id1: + - "7d" + - "30d" + id2: + - "7d" + - "30d" schema: $ref: "#/components/schemas/SLOBulkDelete" description: Delete multiple service level objective objects request body. @@ -32693,6 +33342,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + category: "Scheduled Maintenance" + description: "Planned maintenance window for database upgrade." + end: 1600003600 + slo_id: sloId + start: 1600000000 + timezone: UTC + type: correction schema: $ref: "#/components/schemas/SLOCorrectionCreateRequest" description: Create an SLO Correction @@ -32817,6 +33478,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + category: "Scheduled Maintenance" + description: "Updated correction for maintenance window." + end: 1600003600 + start: 1600000000 + timezone: UTC + type: correction schema: $ref: "#/components/schemas/SLOCorrectionUpdateRequest" description: The edited SLO correction object. @@ -33042,6 +33714,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + description: "Updated description for the SLO." + name: "Custom Metric SLO" + query: + denominator: "sum:my.custom.metric{*}.as_count()" + numerator: "sum:my.custom.metric{type:good}.as_count()" + tags: + - "env:prod" + - "app:core" + thresholds: + - target: 95 + timeframe: 7d + - target: 95 + timeframe: 30d + warning: 97 + type: metric schema: $ref: "#/components/schemas/ServiceLevelObjective" description: The edited service level objective request object. @@ -33299,6 +33989,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + description: Description of private location + name: New private location + tags: + - "team:front" schema: $ref: "#/components/schemas/SyntheticsPrivateLocation" description: Details of the private location to create. @@ -33425,6 +34122,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + description: Description of private location + name: New private location + tags: + - "team:front" schema: $ref: "#/components/schemas/SyntheticsPrivateLocation" description: Details of the private location to be updated. @@ -33666,6 +34370,29 @@ paths: tags: - "env:prod" type: api + default: + value: + config: + assertions: + - operator: is + target: 200 + type: statusCode + request: + method: GET + url: "https://example.com" + locations: + - "aws:eu-west-3" + message: Notification message + name: Example API test + options: + min_failure_duration: 0 + min_location_failed: 1 + tick_every: 60 + status: live + subtype: http + tags: + - "env:production" + type: api schema: $ref: "#/components/schemas/SyntheticsAPITest" description: Details of the test to create. @@ -33773,6 +34500,30 @@ paths: requestBody: content: application/json: + examples: + default: + value: + config: + assertions: + - operator: is + target: 200 + type: statusCode + request: + method: GET + url: "https://example.com" + locations: + - "aws:eu-west-3" + message: Notification message + name: Example API test + options: + min_failure_duration: 0 + min_location_failed: 1 + tick_every: 60 + status: live + subtype: http + tags: + - "env:production" + type: api schema: $ref: "#/components/schemas/SyntheticsAPITest" description: New test details to be saved. @@ -33829,6 +34580,32 @@ paths: requestBody: content: application/json: + examples: + default: + value: + config: + assertions: [] + request: + method: GET + url: "https://example.com" + locations: + - "aws:eu-west-3" + message: "" + name: Example browser test + options: + device_ids: + - chrome.laptop_large + tick_every: 3600 + status: live + steps: + - name: Check current URL + params: + check: contains + value: example + type: assertCurrentUrl + tags: + - "env:production" + type: browser schema: $ref: "#/components/schemas/SyntheticsBrowserTest" description: Details of the test to create. @@ -33936,6 +34713,32 @@ paths: requestBody: content: application/json: + examples: + default: + value: + config: + assertions: [] + request: + method: GET + url: "https://example.com" + locations: + - "aws:eu-west-3" + message: "" + name: Example browser test + options: + device_ids: + - chrome.laptop_large + tick_every: 3600 + status: live + steps: + - name: Check current URL + params: + check: contains + value: example + type: assertCurrentUrl + tags: + - "env:production" + type: browser schema: $ref: "#/components/schemas/SyntheticsBrowserTest" description: New test details to be saved. @@ -34118,6 +34921,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + public_ids: + - "abc-def-123" schema: $ref: "#/components/schemas/SyntheticsDeleteTestsPayload" description: Public ID list of the Synthetic tests to be deleted. @@ -34174,6 +34982,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + config: + variables: [] + device_ids: + - "synthetics:mobile:device:apple_iphone_14_ios_16" + message: Notification message + name: Example mobile test + options: + min_failure_duration: 0 + min_location_failed: 1 + tick_every: 3600 + tags: + - "env:production" + type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: Details of the test to create. @@ -34281,6 +35105,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + config: + variables: [] + device_ids: + - "synthetics:mobile:device:apple_iphone_14_ios_16" + message: Notification message + name: Example mobile test + options: + min_failure_duration: 0 + min_location_failed: 1 + tick_every: 3600 + tags: + - "env:production" + type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: New test details to be saved. @@ -34417,6 +35257,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + tests: + - public_id: aaa-aaa-aaa schema: $ref: "#/components/schemas/SyntheticsTriggerBody" description: The identifiers of the tests to trigger. @@ -34456,6 +35301,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + tests: + - public_id: aaa-aaa-aaa schema: $ref: "#/components/schemas/SyntheticsCITestBody" description: Details of the test to trigger. @@ -34495,6 +35345,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + from_ts: 1726041488 + public_ids: + - "abc-def-123" + to_ts: 1726127888 schema: $ref: "#/components/schemas/SyntheticsFetchUptimesPayload" description: Public ID list of the Synthetic tests and timeframe. @@ -34595,6 +35452,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - op: replace + path: /name + value: New test name + - op: remove + path: /config/assertions/0 schema: $ref: "#/components/schemas/SyntheticsPatchTestBody" description: "[JSON Patch](https://jsonpatch.com/) compliant list of operations" @@ -34780,6 +35646,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + new_status: live schema: $ref: "#/components/schemas/SyntheticsUpdateTestPauseStatusPayload" description: Status to set the given Synthetic test to. @@ -34866,6 +35736,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + description: Example description + name: MY_VARIABLE + tags: + - "team:front" + - "test:workflow-1" + value: + secure: false + value: variable-value schema: $ref: "#/components/schemas/SyntheticsGlobalVariableRequest" description: Details of the global variable to create. @@ -35008,6 +35889,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + description: Example description + name: MY_VARIABLE + tags: + - "team:front" + - "test:workflow-1" + value: + secure: false + value: variable-value schema: $ref: "#/components/schemas/SyntheticsGlobalVariableRequest" description: Details of the global variable to update. @@ -35191,6 +36083,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + host: test.host + tags: + - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: Update host tags request body. @@ -35242,6 +36140,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + host: test.host + tags: + - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: Add tags to host @@ -37434,6 +38338,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + email: test@datadoghq.com + handle: test@datadoghq.com + name: test user schema: $ref: "#/components/schemas/User" description: User object that needs to be created. @@ -37571,6 +38481,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + disabled: false + email: test@datadoghq.com + name: test user schema: $ref: "#/components/schemas/User" description: Description of the update. @@ -37675,6 +38591,13 @@ paths: content: application/json: examples: + default: + value: + - ddsource: nginx + ddtags: "env:staging,version:5.1" + hostname: i-012345678 + message: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World" + service: payment multi-json-messages: description: Pass multiple log objects at once. summary: Multi JSON Messages @@ -37685,6 +38608,13 @@ paths: $ref: "#/components/schemas/HTTPLog" application/json;simple: examples: + default: + value: + ddsource: nginx + ddtags: "env:staging,version:5.1" + hostname: i-012345678 + message: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World" + service: payment simple-json-message: description: Log attributes can be passed as `key:value` pairs in valid JSON messages. summary: Simple JSON Message @@ -37697,6 +38627,8 @@ paths: $ref: "#/components/schemas/HTTPLogItem" application/logplex-1: examples: + default: + value: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World" multi-raw-message: description: Submit log messages. summary: Multi Logplex Messages @@ -37711,6 +38643,8 @@ paths: type: string text/plain: examples: + default: + value: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World" multi-raw-message: description: Submit log string. summary: Multi Raw Messages diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index d235bdcd3d..f70aa17b7c 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -16878,7 +16878,7 @@ components: enabled: true enabled_services: - service_1 - - service_1 + - service_2 metrics_config: compartment_tag_filters: - datadog:true @@ -16886,7 +16886,7 @@ components: enabled: true excluded_services: - service_1 - - service_1 + - service_2 regions_config: available: - us-ashburn-1 @@ -21134,7 +21134,7 @@ components: public_ids: description: List of public IDs of the Synthetic tests to delete. example: - - "" + - abc-def-123 items: description: The public ID of a Synthetic test to delete. type: string @@ -72415,7 +72415,7 @@ components: enabled: true enabled_services: - service_1 - - service_1 + - service_2 metrics_config: compartment_tag_filters: - datadog:true @@ -72423,7 +72423,7 @@ components: enabled: true excluded_services: - service_1 - - service_1 + - service_2 regions_config: available: - us-ashburn-1 @@ -75242,6 +75242,76 @@ paths: file_path: "/conf.d/deprecated-integration.yaml" filter_query: "env:prod AND datacenter:us-east-1" type: deployment + default: + value: + data: + attributes: + config_operations: + - file_op: merge-patch + file_path: /datadog.yaml + patch: + apm_config: + apm_dd_url: https://trace.agent.datadoghq.com + enabled: true + log_level: info + logs_enabled: true + process_config: + enabled: true + - file_op: merge-patch + file_path: /security-agent.yaml + patch: + runtime_security_config: + enabled: true + fim_enabled: true + - file_op: merge-patch + file_path: /system-probe.yaml + patch: + network_config: + enabled: true + service_monitoring_config: + enabled: true + - file_op: merge-patch + file_path: /application_monitoring.yaml + patch: + enabled: true + server: + host: 0.0.0.0 + port: 8126 + - file_op: merge-patch + file_path: /conf.d/logs.d/custom-app.yaml + patch: + logs: + - path: /var/log/custom-app/*.log + service: custom-app + source: custom + type: file + - file_op: merge-patch + file_path: /conf.d/docker.d/docker-logs.yaml + patch: + logs: + - service: docker + source: docker + type: docker + - file_op: merge-patch + file_path: /conf.d/snmp.d/network-devices.yaml + patch: + init_config: + loader: core + instances: + - community_string: public + ip_address: 192.168.1.1 + - file_op: merge-patch + file_path: /conf.d/postgres.d/conf.yaml + patch: + instances: + - dbname: postgres + host: localhost + port: 5432 + username: datadog + - file_op: delete + file_path: /conf.d/deprecated-integration.yaml + filter_query: env:prod AND datacenter:us-east-1 + type: deployment delete_config_file: summary: Delete a configuration file value: @@ -75330,6 +75400,15 @@ paths: content: application/json: examples: + default: + value: + data: + attributes: + filter_query: env:prod AND service:web + target_packages: + - name: datadog-agent + version: 7.52.0 + type: deployment upgrade_agent: summary: Upgrade Datadog Agent to version 7.52.0 value: @@ -75582,6 +75661,22 @@ paths: status: "active" version_to_latest: 1 type: schedule + default: + value: + data: + attributes: + name: Weekly Production Agent Updates + query: env:prod + rule: + days_of_week: + - Mon + - Wed + maintenance_window_duration: 180 + start_maintenance_window: 02:00 + timezone: America/New_York + status: active + version_to_latest: 0 + type: schedule weekly_production_update: summary: Weekly production agent updates value: @@ -75762,6 +75857,12 @@ paths: start_maintenance_window: "03:00" timezone: "America/New_York" type: schedule + default: + value: + data: + attributes: + status: inactive + type: schedule pause_schedule: summary: Pause a schedule value: @@ -75894,6 +75995,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: datastore-name + org_access: contributor + primary_column_name: primaryKey + primary_key_generation_strategy: none + type: datastores schema: $ref: "#/components/schemas/CreateAppsDatastoreRequest" required: true @@ -75999,6 +76110,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: datastores schema: $ref: "#/components/schemas/UpdateAppsDatastoreRequest" required: true @@ -76044,6 +76160,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + id: a7656bcc-51d4-4884-adf7-4d0d9a3e0633 + item_key: primaryKey + type: items schema: $ref: "#/components/schemas/DeleteAppsDatastoreItemRequest" required: true @@ -76157,6 +76281,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + item_changes: + ops_set: + count: 42 + status: active + item_key: my-item-key + type: items schema: $ref: "#/components/schemas/UpdateAppsDatastoreItemRequest" required: true @@ -76203,6 +76338,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: items schema: $ref: "#/components/schemas/BulkDeleteAppsDatastoreItemsRequest" required: true @@ -76254,6 +76394,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + conflict_mode: overwrite_on_conflict + values: + - data: example data + key: value + - data: example data2 + key: value2 + type: items schema: $ref: "#/components/schemas/BulkPutAppsDatastoreItemsRequest" required: true @@ -76467,6 +76619,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + integration: + credentials: + account_id: "123456789123" + role: MyRoleUpdated + type: AWSAssumeRole + type: AWS + name: My AWS Connection + type: action_connection schema: $ref: "#/components/schemas/CreateActionConnectionRequest" required: true @@ -76579,6 +76744,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + integration: + type: AWS + name: My AWS Connection + type: action_connection schema: $ref: "#/components/schemas/UpdateActionConnectionRequest" description: Update an existing Action Connection request body @@ -76645,6 +76819,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + lambda: true + sensitive_data: false + vuln_containers_os: true + vuln_host_os: true + id: "123456789012" + type: aws_scan_options schema: $ref: "#/components/schemas/AwsScanOptionsCreateRequest" description: The definition of the new scan options. @@ -76731,6 +76916,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + lambda: true + sensitive_data: false + vuln_containers_os: true + vuln_host_os: true + id: "123456789012" + type: aws_scan_options schema: $ref: "#/components/schemas/AwsScanOptionsUpdateRequest" description: New definition of the scan options. @@ -76781,6 +76977,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + vuln_containers_os: true + vuln_host_os: true + id: 12345678-90ab-cdef-1234-567890abcdef + type: azure_scan_options schema: $ref: "#/components/schemas/AzureScanOptions" required: true @@ -76873,6 +77078,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 12345678-90ab-cdef-1234-567890abcdef + type: azure_scan_options schema: $ref: "#/components/schemas/AzureScanOptionsInputUpdate" required: true @@ -76922,6 +77133,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + vuln_containers_os: true + vuln_host_os: true + id: company-project-id + type: gcp_scan_options schema: $ref: "#/components/schemas/GcpScanOptions" description: The definition of the new scan options. @@ -77029,6 +77249,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + vuln_containers_os: false + id: company-project-id + type: gcp_scan_options schema: $ref: "#/components/schemas/GcpScanOptionsInputUpdate" description: New definition of the scan options. @@ -77089,6 +77317,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + arn: arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba + type: aws_resource schema: $ref: "#/components/schemas/AwsOnDemandCreateRequest" description: The definition of the on demand task. @@ -77200,6 +77435,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: API Key for submitting metrics + type: api_keys schema: $ref: "#/components/schemas/APIKeyCreateRequest" required: true @@ -77304,6 +77546,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: API Key for submitting metrics + id: 00112233-4455-6677-8899-aabbccddeeff + type: api_keys schema: $ref: "#/components/schemas/APIKeyUpdateRequest" required: true @@ -77524,6 +77774,9 @@ paths: requestBody: content: multipart/form-data: + examples: + default: + value: {} schema: $ref: "#/components/schemas/OpenAPIFile" required: true @@ -77579,6 +77832,9 @@ paths: requestBody: content: multipart/form-data: + examples: + default: + value: {} schema: $ref: "#/components/schemas/OpenAPIFile" required: true @@ -77646,6 +77902,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + compute: + aggregation_type: distribution + include_percentiles: false + path: "@duration" + filter: + query: "@http.status_code:200 service:my-service" + group_by: + - path: resource_name + tag_name: resource_name + id: my.metric + type: spans_metrics schema: $ref: "#/components/schemas/SpansMetricCreateRequest" description: The definition of the new span-based metric. @@ -77730,6 +78002,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + compute: + include_percentiles: false + filter: + query: "@http.status_code:200 service:my-service" + group_by: + - path: resource_name + tag_name: resource_name + type: spans_metrics schema: $ref: "#/components/schemas/SpansMetricUpdateRequest" description: New definition of the span-based metric. @@ -77789,6 +78074,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + filter: + query: "@http.status_code:200 service:my-service" + filter_type: spans-sampling-processor + name: my retention filter + rate: 1.0 + trace_rate: 1.0 + type: apm_retention_filter schema: $ref: "#/components/schemas/RetentionFilterCreateRequest" description: The definition of the new retention filter. @@ -77823,6 +78121,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - id: 7RBOb7dLSYWI01yc3pIH8w + type: apm_retention_filter schema: $ref: "#/components/schemas/ReorderRetentionFiltersRequest" description: The list of retention filters in the new order. @@ -77905,6 +78209,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + filter: + query: "@http.status_code:200 service:my-service" + filter_type: spans-sampling-processor + name: my retention filter + rate: 1.0 + trace_rate: 1.0 + id: retention-filter-id + type: apm_retention_filter schema: $ref: "#/components/schemas/RetentionFilterUpdateRequest" description: The updated definition of the retention filter. @@ -77966,6 +78284,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - id: aea2ed17-b45f-40d0-ba59-c86b7972c901 + type: appDefinitions + - id: f69bb8be-6168-4fe7-a30d-370256b6504a + type: appDefinitions + - id: ab1ed73e-13ad-4426-b0df-a0ff8876a088 + type: appDefinitions schema: $ref: "#/components/schemas/DeleteAppsRequest" required: true @@ -78115,6 +78443,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + components: [] + description: This is a simple example app + name: Example App + queries: [] + rootInstanceName: grid0 + type: appDefinitions schema: $ref: "#/components/schemas/CreateAppRequest" required: true @@ -78275,6 +78614,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + components: [] + description: This is a simple example app + name: Example App + queries: [] + rootInstanceName: grid0 + id: 9e20cbaf-68da-45a6-9ccf-54193ac29fa5 + type: appDefinitions schema: $ref: "#/components/schemas/UpdateAppRequest" required: true @@ -78526,6 +78877,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Application Key for managing dashboards + scopes: + - dashboards_read + - dashboards_write + - dashboards_public_share + id: 00112233-4455-6677-8899-aabbccddeeff + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyUpdateRequest" required: true @@ -78659,6 +79022,19 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + filter: + from: now-15m + query: "@type:session AND @session.type:user" + to: now + options: + timezone: GMT + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + limit: 25 + sort: timestamp schema: $ref: "#/components/schemas/AuditLogsSearchEventsRequest" required: false @@ -78739,6 +79115,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + attribute_key: member-of + attribute_value: Development + type: authn_mappings schema: $ref: "#/components/schemas/AuthNMappingCreateRequest" required: true @@ -78848,6 +79232,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + attribute_key: member-of + attribute_value: Development + id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + type: authn_mappings schema: $ref: "#/components/schemas/AuthNMappingUpdateRequest" required: true @@ -78957,6 +79350,25 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + priority: NOT_DEFINED + status_name: Open + title: Security breach investigation + type_id: 3b010bde-09ce-4449-b745-71dd5f861963 + relationships: + assignee: + data: + id: 00000000-0000-0000-0000-000000000000 + type: user + project: + data: + id: e555e290-ed65-49bd-ae18-8acbfcf18db7 + type: project + type: case schema: $ref: "#/components/schemas/CaseCreateRequest" description: Case payload @@ -79022,6 +79434,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + key: SEC + name: Security Investigation + type: project schema: $ref: "#/components/schemas/ProjectCreateRequest" description: Project payload. @@ -79118,6 +79538,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: project schema: $ref: "#/components/schemas/ProjectUpdateRequest" description: Project payload. @@ -79199,6 +79624,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + recipients: + - type: EMAIL + triggers: + - type: CASE_CREATED + type: notification_rule schema: $ref: "#/components/schemas/CaseNotificationRuleCreateRequest" description: Notification rule payload @@ -79278,6 +79713,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + recipients: + - type: EMAIL + triggers: + - type: CASE_CREATED + type: notification_rule schema: $ref: "#/components/schemas/CaseNotificationRuleUpdateRequest" description: Notification rule payload @@ -79329,6 +79774,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: Investigations done in case management + emoji: 🕵🏻‍♂️ + name: Investigation + type: case_type schema: $ref: "#/components/schemas/CaseTypeCreateRequest" description: Case type payload @@ -79421,6 +79875,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: AWS Region, must be a valid region supported by AWS + display_name: AWS Region + is_multi: true + key: aws_region + type: NUMBER + type: custom_attribute schema: $ref: "#/components/schemas/CustomAttributeConfigCreateRequest" description: Custom attribute config payload @@ -79507,6 +79972,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: case schema: $ref: "#/components/schemas/CaseEmptyRequest" description: Archive case payload @@ -79545,6 +80015,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + assignee_id: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504 + type: case schema: $ref: "#/components/schemas/CaseAssignRequest" description: Assign case payload @@ -79583,6 +80060,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + attributes: + env: + - prod + service: + - web-store + - web-api + team: + - engineering + type: case schema: $ref: "#/components/schemas/CaseUpdateAttributesRequest" description: Case attributes update payload @@ -79621,6 +80112,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + comment: This is my comment ! + type: case schema: $ref: "#/components/schemas/CaseCommentRequest" description: Case comment payload @@ -79707,6 +80205,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + is_multi: false + type: NUMBER + value: 42 + type: case schema: $ref: "#/components/schemas/CaseUpdateCustomAttributeRequest" description: Update case custom attribute payload @@ -79745,6 +80252,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: Seeing some weird memory increase... We shouldn't ignore this + type: case schema: $ref: "#/components/schemas/CaseUpdateDescriptionRequest" description: Case description update payload @@ -79783,6 +80297,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + priority: NOT_DEFINED + type: case schema: $ref: "#/components/schemas/CaseUpdatePriorityRequest" description: Case priority update payload @@ -79821,6 +80342,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000000 + type: incidents schema: $ref: "#/components/schemas/RelationshipToIncidentRequest" description: Incident link request @@ -79923,6 +80450,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + jira_issue_url: https://jira.example.com/browse/PROJ-123 + type: issues schema: $ref: "#/components/schemas/JiraIssueLinkRequest" description: Jira issue link request @@ -79981,6 +80515,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + fields: {} + issue_type_id: "10001" + jira_account_id: "1234" + project_id: "5678" + type: issues schema: $ref: "#/components/schemas/JiraIssueCreateRequest" description: Jira issue creation request @@ -80034,6 +80578,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: notebook schema: $ref: "#/components/schemas/NotebookCreateRequest" description: Notebook creation request @@ -80087,6 +80636,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: e555e290-ed65-49bd-ae18-8acbfcf18db7 + type: project schema: $ref: "#/components/schemas/ProjectRelationship" description: Project update request @@ -80144,6 +80699,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + assignment_group: IT Support + instance_name: my-instance + type: tickets schema: $ref: "#/components/schemas/ServiceNowTicketCreateRequest" description: ServiceNow ticket creation request @@ -80197,6 +80760,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + status: OPEN + status_name: Open + type: case schema: $ref: "#/components/schemas/CaseUpdateStatusRequest" description: Case status update payload @@ -80235,6 +80806,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + title: Memory leak investigation on API + type: case schema: $ref: "#/components/schemas/CaseUpdateTitleRequest" description: Case title update payload @@ -80273,6 +80851,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: case schema: $ref: "#/components/schemas/CaseEmptyRequest" description: Unarchive case payload @@ -80311,6 +80894,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: case schema: $ref: "#/components/schemas/CaseEmptyRequest" description: Unassign case payload @@ -80399,6 +80987,33 @@ paths: requestBody: content: application/json: + examples: + default: + value: + apiVersion: v3 + integrations: + opsgenie: + serviceURL: https://www.opsgenie.com/service/shopping-cart + pagerduty: + serviceURL: https://www.pagerduty.com/service-directory/Pshopping-cart + kind: service + metadata: + additionalOwners: + - name: "" + contacts: + - contact: https://slack/ + type: slack + id: 4b163705-23c0-4573-b2fb-f6cea2163fcb + inheritFrom: application:default/myapp + links: + - name: mylink + type: link + url: https://mylink + name: myService + namespace: default + tags: + - this:tag + - that:tag schema: $ref: "#/components/schemas/UpsertCatalogEntityRequest" description: Entity YAML or JSON. @@ -80518,6 +81133,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + kind: my-job schema: $ref: "#/components/schemas/UpsertCatalogKindRequest" description: Kind YAML or JSON. @@ -80625,6 +81244,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + change_request_linked_incident_uuid: 00000000-0000-0000-0000-000000000000 + change_request_maintenance_window_query: "" + change_request_plan: 1. Deploy to staging 2. Run tests 3. Deploy to production + change_request_risk: LOW + change_request_type: NORMAL + description: Deploying new payment service v2.1 + end_date: "2024-01-02T15:00:00Z" + project_id: d4bbe1af-f36e-42f1-87c1-493ca35c320e + requested_teams: + - team-handle-1 + start_date: "2024-01-01T03:00:00Z" + title: Deploy new payment service + type: change_request schema: $ref: "#/components/schemas/ChangeRequestCreateRequest" description: Change request payload. @@ -80707,6 +81344,28 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + change_request_plan: Updated deployment plan + change_request_risk: LOW + change_request_type: NORMAL + end_date: "2024-01-02T15:00:00Z" + id: CHM-1234 + start_date: "2024-01-01T03:00:00Z" + relationships: + change_request_decisions: + data: + - id: decision-id-0 + type: change_request + included: + - attributes: + change_request_status: REQUESTED + request_reason: Please review and approve this change + id: decision-id-0 + type: change_request_decision schema: $ref: "#/components/schemas/ChangeRequestUpdateRequest" description: Change request update payload. @@ -80758,6 +81417,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + branch_name: chm/CHM-1234 + repo_id: DataDog/dd-source + type: change_request_branch schema: $ref: "#/components/schemas/ChangeRequestBranchCreateRequest" description: Branch creation payload. @@ -80842,6 +81509,23 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + id: CHM-1234 + relationships: + change_request_decisions: + data: + - id: decision-id-0 + type: change_request + included: + - attributes: + change_request_status: REQUESTED + request_reason: Please review and approve this change + id: decision-id-0 + type: change_request_decision schema: $ref: "#/components/schemas/ChangeRequestDecisionUpdateRequest" description: Decision update payload. @@ -80891,6 +81575,25 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + resource: + end: "2024-11-25T20:08:11.018Z" + git: + author_email: john.doe@email.com + repository_url: https://github.com/DataDog/datadog-agent + sha: 7f263865994b76066c4612fd1965215e7dcb4cd2 + level: pipeline + name: Deploy to AWS + partial_retry: false + start: "2024-11-25T20:06:41.018Z" + status: success + unique_id: 3eacb6f3-ff04-4e10-8a9c-46e6d054024a + url: https://my-ci-provider.example/pipelines/my-pipeline/run/1 + type: cipipeline_resource_request schema: $ref: "#/components/schemas/CIAppCreatePipelineEventRequest" required: true @@ -80962,6 +81665,29 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + compute: + - aggregation: pc90 + interval: 5m + metric: "@duration" + type: timeseries + filter: + from: now-15m + query: "@ci.provider.name:github AND @ci.status:error" + to: now + group_by: + - facet: "@ci.status" + histogram: + interval: 10 + max: 100 + min: 50 + sort: + aggregation: count + order: asc + options: + timezone: GMT schema: $ref: "#/components/schemas/CIAppPipelinesAggregateRequest" required: true @@ -81086,6 +81812,19 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + filter: + from: now-15m + query: "@ci.provider.name:github AND @ci.status:error" + to: now + options: + timezone: GMT + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + limit: 25 + sort: timestamp schema: $ref: "#/components/schemas/CIAppPipelineEventsRequest" required: false @@ -81127,6 +81866,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + env: prod + repository_id: github.com/datadog/shopist + service_name: shopist + type: test_optimization_delete_service_settings_request schema: $ref: "#/components/schemas/TestOptimizationDeleteServiceSettingsRequest" required: true @@ -81164,6 +81912,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + auto_test_retries_enabled: false + code_coverage_enabled: false + early_flake_detection_enabled: false + env: prod + failed_test_replay_enabled: false + pr_comments_enabled: true + repository_id: github.com/datadog/shopist + service_name: shopist + test_impact_analysis_enabled: false + type: test_optimization_update_service_settings_request schema: $ref: "#/components/schemas/TestOptimizationUpdateServiceSettingsRequest" required: true @@ -81204,6 +81967,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + env: prod + repository_id: github.com/datadog/shopist + service_name: shopist + type: test_optimization_get_service_settings_request schema: $ref: "#/components/schemas/TestOptimizationGetServiceSettingsRequest" required: true @@ -81245,6 +82017,29 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + compute: + - aggregation: pc90 + interval: 5m + metric: "@duration" + type: timeseries + filter: + from: now-15m + query: "@test.service:web-ui-tests AND @test.status:fail" + to: now + group_by: + - facet: "@test.service" + histogram: + interval: 10 + max: 100 + min: 50 + sort: + aggregation: count + order: asc + options: + timezone: GMT schema: $ref: "#/components/schemas/CIAppTestsAggregateRequest" required: true @@ -81375,6 +82170,19 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + filter: + from: now-15m + query: "@test.service:web-ui-tests AND @test.status:fail" + to: now + options: + timezone: GMT + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + limit: 25 + sort: timestamp schema: $ref: "#/components/schemas/CIAppTestEventsRequest" required: false @@ -81448,6 +82256,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + account_identifier: test@test.com + arn_pattern: arn:aws:iam::123456789012:user/testuser + type: aws_cloud_auth_config schema: $ref: "#/components/schemas/AWSCloudAuthPersonaMappingCreateRequest" required: true @@ -81553,6 +82369,21 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + handle: sec2 + name: security-framework + requirements: + - controls: + - name: control + rules_id: + - def-000-be9 + name: criteria + version: "2" + type: custom_framework schema: $ref: "#/components/schemas/CreateCustomFrameworkRequest" required: true @@ -81659,6 +82490,21 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + handle: sec2 + name: security-framework + requirements: + - controls: + - name: control + rules_id: + - def-000-be9 + name: criteria + version: "2" + type: custom_framework schema: $ref: "#/components/schemas/UpdateCustomFrameworkRequest" required: true @@ -81727,6 +82573,23 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + aws: + "123456789": + - environment:production + - team:devops + azure: + sub-001: + - app:frontend + gcp: + project-abc: + - region:us-central1 + id: csm_resource_filter + type: csm_resource_filter schema: $ref: "#/components/schemas/UpdateResourceEvaluationFiltersRequest" required: true @@ -81765,6 +82628,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + branch: prod + repository_id: github.com/datadog/shopist + type: ci_app_coverage_branch_summary_request schema: $ref: "#/components/schemas/BranchCoverageSummaryRequest" required: true @@ -81816,6 +82687,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 + repository_id: github.com/datadog/shopist + type: ci_app_coverage_commit_summary_request schema: $ref: "#/components/schemas/CommitCoverageSummaryRequest" required: true @@ -82057,6 +82936,45 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + costs_to_allocate: + - condition: is + tag: account_id + value: "123456789" + - condition: in + tag: environment + value: "" + values: + - production + - staging + enabled: true + order_id: 1 + provider: + - aws + - gcp + rule_name: example-arbitrary-cost-rule + strategy: + allocated_by_tag_keys: + - team + - environment + based_on_costs: + - condition: is + tag: service + value: web-api + - condition: not in + tag: team + value: "" + values: + - legacy + - deprecated + granularity: daily + method: proportional + type: shared + type: upsert_arbitrary_rule schema: $ref: "#/components/schemas/ArbitraryCostUpsertRequest" required: true @@ -82091,6 +83009,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - id: "456" + type: arbitrary_rule + - id: "123" + type: arbitrary_rule + - id: "789" + type: arbitrary_rule schema: $ref: "#/components/schemas/ReorderRuleResourceArray" required: true @@ -82188,6 +83116,45 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + costs_to_allocate: + - condition: is + tag: account_id + value: "123456789" + - condition: in + tag: environment + value: "" + values: + - production + - staging + enabled: true + order_id: 1 + provider: + - aws + - gcp + rule_name: example-arbitrary-cost-rule + strategy: + allocated_by_tag_keys: + - team + - environment + based_on_costs: + - condition: is + tag: service + value: web-api + - condition: not in + tag: team + value: "" + values: + - legacy + - deprecated + granularity: daily + method: proportional + type: shared + type: upsert_arbitrary_rule schema: $ref: "#/components/schemas/ArbitraryCostUpsertRequest" required: true @@ -82245,6 +83212,25 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + account_filters: + excluded_accounts: + - "123456789123" + - "123456789143" + include_new_accounts: true + included_accounts: + - "123456789123" + - "123456789143" + account_id: "123456789123" + bucket_name: dd-cost-bucket + bucket_region: us-east-1 + report_name: dd-report-name + report_prefix: dd-report-prefix + type: aws_cur_config_post_request schema: $ref: "#/components/schemas/AwsCURConfigPostRequest" required: true @@ -82352,6 +83338,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + account_filters: + excluded_accounts: + - "123456789123" + - "123456789143" + include_new_accounts: true + included_accounts: + - "123456789123" + - "123456789143" + is_enabled: true + type: aws_cur_config_patch_request schema: $ref: "#/components/schemas/AwsCURConfigPatchRequest" required: true @@ -82425,6 +83426,25 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + account_id: 1234abcd-1234-abcd-1234-1234abcd1234 + actual_bill_config: + export_name: dd-actual-export + export_path: dd-export-path + storage_account: dd-storage-account + storage_container: dd-storage-container + amortized_bill_config: + export_name: dd-actual-export + export_path: dd-export-path + storage_account: dd-storage-account + storage_container: dd-storage-container + client_id: 1234abcd-1234-abcd-1234-1234abcd1234 + scope: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234 + type: azure_uc_config_post_request schema: $ref: "#/components/schemas/AzureUCConfigPostRequest" required: true @@ -82532,6 +83552,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + is_enabled: true + type: azure_uc_config_patch_request schema: $ref: "#/components/schemas/AzureUCConfigPatchRequest" required: true @@ -82581,6 +83608,23 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 1738258683590 + created_by: 00000000-0a0a-0a0a-aaa0-00000000000a + end_month: 202502 + metrics_query: aws.cost.amortized{service:ec2} by {service} + name: my budget + org_id: 123 + start_month: 202501 + total_amount: 1000 + updated_at: 1738258683590 + updated_by: 00000000-0a0a-0a0a-aaa0-00000000000a + id: 00000000-0a0a-0a0a-aaa0-00000000000a + type: "" schema: $ref: "#/components/schemas/BudgetWithEntries" required: true @@ -82626,6 +83670,34 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 1738258683590 + created_by: 00000000-0a0a-0a0a-aaa0-00000000000a + end_month: 202502 + entries: + - amount: 500 + month: 202501 + tag_filters: + - tag_key: service + tag_value: ec2 + - amount: 500 + month: 202502 + tag_filters: + - tag_key: service + tag_value: ec2 + metrics_query: aws.cost.amortized{service:ec2} by {service} + name: my budget + org_id: 123 + start_month: 202501 + total_amount: 1000 + updated_at: 1738258683590 + updated_by: 00000000-0a0a-0a0a-aaa0-00000000000a + id: "1" + type: budget schema: $ref: "#/components/schemas/BudgetValidationRequest" required: true @@ -82768,6 +83840,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + - BilledCost: 100.5 + BillingCurrency: USD + ChargeDescription: Monthly usage charge for my service + ChargePeriodEnd: "2023-02-28" + ChargePeriodStart: "2023-02-01" schema: $ref: "#/components/schemas/CustomCostsFileUploadRequest" required: true @@ -82906,6 +83986,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + billing_account_id: 123456_A123BC_12AB34 + bucket_name: dd-cost-bucket + export_dataset_name: billing + export_prefix: datadog_cloud_cost_usage_export + export_project_name: dd-cloud-cost-report + service_account: dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com + type: gcp_usage_cost_config_post_request schema: $ref: "#/components/schemas/GCPUsageCostConfigPostRequest" required: true @@ -83013,6 +84105,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + is_enabled: true + type: gcp_uc_config_patch_request schema: $ref: "#/components/schemas/GCPUsageCostConfigPatchRequest" required: true @@ -83430,6 +84529,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Application Key for managing dashboards + scopes: + - dashboards_read + - dashboards_write + - dashboards_public_share + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyCreateRequest" required: true @@ -83537,6 +84647,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Application Key for managing dashboards + scopes: + - dashboards_read + - dashboards_write + - dashboards_public_share + id: 00112233-4455-6677-8899-aabbccddeeff + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyUpdateRequest" required: true @@ -83590,6 +84712,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + dashboards: + - id: q5j-nti-fv6 + type: host_timeboard schema: $ref: "#/components/schemas/DashboardListDeleteItemsRequest" description: Dashboards to delete from the dashboard list. @@ -83683,6 +84811,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + dashboards: + - id: q5j-nti-fv6 + type: host_timeboard schema: $ref: "#/components/schemas/DashboardListAddItemsRequest" description: Dashboards to add to the dashboard list. @@ -83732,6 +84866,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + dashboards: + - id: q5j-nti-fv6 + type: host_timeboard schema: $ref: "#/components/schemas/DashboardListUpdateItemsRequest" description: New dashboards of the dashboard list. @@ -83804,17 +84944,21 @@ paths: requestBody: content: application/json: - example: - data: - attributes: - name: "Test RUM Dataset" - principals: - - "role:94172442-be03-11e9-a77a-3b7612558ac1" - product_filters: - - filters: - - "@application.id:application_123" - product: "rum" - type: dataset + examples: + default: + value: + data: + attributes: + name: Security Audit Dataset + principals: + - role:editor + - org:00000000000000 + product_filters: + - filters: + - source:cloudtrail + type: logs + restriction_query_id: 00000000-0000-0000-0000-000000000001 + type: dataset schema: $ref: "#/components/schemas/DatasetCreateRequest" description: Dataset payload @@ -83925,6 +85069,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Security Audit Dataset + principals: + - role:94172442-be03-11e9-a77a-3b7612558ac1 + product_filters: + - filters: + - "@application.id:ABCD" + product: logs + type: dataset schema: $ref: "#/components/schemas/DatasetUpdateRequest" description: Dataset payload @@ -84197,6 +85354,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + dry_run: false + env: production + identifier: pre + service: my-service + type: deployment_gate schema: $ref: "#/components/schemas/CreateDeploymentGateParams" required: true @@ -84292,6 +85459,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + dry_run: false + name: My deployment rule + options: + duration: 3600 + excluded_resources: + - resource1 + - resource2 + type: faulty_deployment_detection + type: deployment_rule schema: $ref: "#/components/schemas/CreateDeploymentRuleParams" required: true @@ -84449,6 +85630,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + dry_run: false + name: Updated deployment rule + options: + duration: 3600 + excluded_resources: + - resource1 + - resource2 + type: deployment_rule schema: $ref: "#/components/schemas/UpdateDeploymentRuleParams" required: true @@ -84590,6 +85784,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + dry_run: false + id: 12345678-1234-1234-1234-123456789012 + type: deployment_gate schema: $ref: "#/components/schemas/UpdateDeploymentGateParams" required: true @@ -84638,6 +85840,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + env: staging + identifier: pre-deploy + primary_tag: region:us-east-1 + service: transaction-backend + version: v1.2.3 + type: deployment_gates_evaluation_request schema: $ref: "#/components/schemas/DeploymentGatesEvaluationRequest" required: true @@ -84765,6 +85978,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + domains: + - "@static-test-domain.test" + enabled: false + type: domain_allowlist schema: $ref: "#/components/schemas/DomainAllowlistRequest" required: true @@ -84809,6 +86031,23 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + custom_tags: + - language:java + - department:engineering + env: staging + finished_at: 1693491984000000000 + git: + commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 + repository_url: https://github.com/organization/example-repository + service: shopist + started_at: 1693491974000000000 + team: backend + version: v1.12.07 schema: $ref: "#/components/schemas/DORADeploymentRequest" required: true @@ -84882,6 +86121,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + from: "2025-01-01T00:00:00Z" + limit: 100 + query: service:(shopist OR api-service) env:production team:backend + sort: -finished_at + to: "2025-01-31T23:59:59Z" + type: dora_deployments_list_request schema: $ref: "#/components/schemas/DORAListDeploymentsRequest" required: true @@ -84965,6 +86215,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + change_failure: true + remediation: + id: eG42zNIkVjM + type: rollback + id: z_RwVLi7v4Y + type: dora_deployment_patch_request schema: $ref: "#/components/schemas/DORADeploymentPatchRequest" required: true @@ -85001,6 +86262,26 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + custom_tags: + - language:java + - department:engineering + env: staging + finished_at: 1693491984000000000 + git: + commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 + repository_url: https://github.com/organization/example-repository + name: Webserver is down failing all requests. + services: + - shopist + severity: High + started_at: 1693491974000000000 + team: backend + version: v1.12.07 schema: $ref: "#/components/schemas/DORAFailureRequest" required: true @@ -85074,6 +86355,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + from: "2025-01-01T00:00:00Z" + limit: 100 + query: severity:(SEV-1 OR SEV-2) env:production team:backend + sort: -started_at + to: "2025-01-31T23:59:59Z" + type: dora_failures_list_request schema: $ref: "#/components/schemas/DORAListFailuresRequest" required: true @@ -85155,6 +86447,26 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + custom_tags: + - language:java + - department:engineering + env: staging + finished_at: 1693491984000000000 + git: + commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 + repository_url: https://github.com/organization/example-repository + name: Webserver is down failing all requests. + services: + - shopist + severity: High + started_at: 1693491974000000000 + team: backend + version: v1.12.07 schema: $ref: "#/components/schemas/DORAFailureRequest" required: true @@ -85253,6 +86565,26 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + display_timezone: America/New_York + message: Message about the downtime + monitor_identifier: + monitor_id: 123 + mute_first_recovery_notification: false + notify_end_states: + - alert + - warn + notify_end_types: + - canceled + - expired + schedule: + timezone: America/New_York + scope: env:(staging OR prod) AND datacenter:us-east-1 + type: downtime schema: $ref: "#/components/schemas/DowntimeCreateRequest" description: Schedule a downtime request body. @@ -85408,6 +86740,27 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + display_timezone: America/New_York + message: Message about the downtime + monitor_identifier: + monitor_id: 123 + mute_first_recovery_notification: false + notify_end_states: + - alert + - warn + notify_end_types: + - canceled + - expired + schedule: + timezone: America/New_York + scope: env:(staging OR prod) AND datacenter:us-east-1 + id: 00000000-0000-1234-0000-000000000000 + type: downtime schema: $ref: "#/components/schemas/DowntimeUpdateRequest" description: Update a downtime request body. @@ -85461,6 +86814,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + from: 1671612804000 + order_by: IMPACTED_SESSIONS + persona: BACKEND + query: service:orders-* AND @language:go + to: 1671620004000 + track: trace + type: search_request schema: $ref: "#/components/schemas/IssuesSearchRequest" description: Search issues request payload. @@ -85558,6 +86923,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 87cb11a0-278c-440a-99fe-701223c80296 + type: assignee schema: $ref: "#/components/schemas/IssueUpdateAssigneeRequest" description: Update issue assignee request payload. @@ -85599,6 +86970,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + state: RESOLVED + id: c1726a66-1f64-11ee-b338-da7ad0900002 + type: error_tracking_issue schema: $ref: "#/components/schemas/IssueUpdateStateRequest" description: Update issue state request payload. @@ -85733,6 +87112,47 @@ paths: description: Example of a change event for tracking configuration or feature flag changes. summary: Change Event value: {"data": {"attributes": {"aggregation_key": "aggregation_key_123", "attributes": {"author": {"name": "example@datadog.com", "type": "user"}, "change_metadata": {"dd": {"team": "datadog_team", "user_email": "datadog@datadog.com", "user_id": "datadog_user_id", "user_name": "datadog_username"}, "resource_link": "datadog.com/feature/fallback_payments_test"}, "changed_resource": {"name": "fallback_payments_test", "type": "feature_flag"}, "impacted_resources": [{"name": "payments_api", "type": "service"}], "new_value": {"enabled": true, "percentage": "50%", "rule": {"datacenter": "devcycle.us1.prod"}}, "prev_value": {"enabled": true, "percentage": "10%", "rule": {"datacenter": "devcycle.us1.prod"}}}, "category": "change", "host": "hostname", "integration_id": "custom-events", "message": "payment_processed feature flag has been enabled", "tags": ["env:api_client_test"], "timestamp": "2020-01-01T01:30:15.010000Z", "title": "payment_processed feature flag updated"}, "type": "event"}} + default: + value: + data: + attributes: + aggregation_key: aggregation_key_123 + attributes: + author: + name: example@datadog.com + type: user + change_metadata: + dd: + team: datadog_team + user_email: datadog@datadog.com + user_id: datadog_user_id + user_name: datadog_username + resource_link: datadog.com/feature/fallback_payments_test + changed_resource: + name: fallback_payments_test + type: feature_flag + impacted_resources: + - name: payments_api + type: service + new_value: + enabled: true + percentage: 50% + rule: + datacenter: devcycle.us1.prod + prev_value: + enabled: true + percentage: 10% + rule: + datacenter: devcycle.us1.prod + category: change + host: hostname + integration_id: custom-events + message: payment_processed feature flag has been enabled + tags: + - env:api_client_test + timestamp: "2020-01-01T01:30:15.010000Z" + title: payment_processed feature flag updated + type: event schema: $ref: "#/components/schemas/EventCreateRequestPayload" description: Event creation request payload. @@ -85808,6 +87228,19 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + filter: + from: now-15m + query: service:web* AND @http.status_code:[200 TO 299] + to: now + options: + timezone: GMT + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + limit: 25 + sort: timestamp schema: $ref: "#/components/schemas/EventsListRequest" required: false @@ -85945,18 +87378,22 @@ paths: requestBody: content: application/json: - example: - data: - attributes: - description: "Demo feature flag with unique identifier" - key: "feature-flag-demo123" - name: "Feature Flag Demo123" - value_type: "BOOLEAN" - variants: - - key: "variant-demo123" - name: "Variant Demo123" - value: "true" - type: "feature-flags" + examples: + default: + value: + data: + attributes: + default_variant_key: variant-a + description: A sample feature flag + enabled: true + key: feature-flag-abc123 + name: Feature Flag ABC 123 + variants: + - description: Variant A + key: variant-a + - description: Variant B + key: variant-b + type: feature-flags schema: $ref: "#/components/schemas/CreateFeatureFlagRequest" required: true @@ -86066,12 +87503,16 @@ paths: requestBody: content: application/json: - example: - data: - attributes: - name: "Environment Demo123" - queries: ["env-demo123", "queries-demo456"] - type: "environments" + examples: + default: + value: + data: + attributes: + name: staging-environment + queries: + - staging + - canary + type: environments schema: $ref: "#/components/schemas/CreateEnvironmentRequest" required: true @@ -86193,12 +87634,16 @@ paths: requestBody: content: application/json: - example: - data: - attributes: - name: "Updated Environment XYZ789" - queries: ["updated-env-xyz789", "updated-queries-abc456"] - type: "environments" + examples: + default: + value: + data: + attributes: + name: production-environment + queries: + - production + - prod-us + type: environments schema: $ref: "#/components/schemas/UpdateEnvironmentRequest" required: true @@ -86553,12 +87998,15 @@ paths: requestBody: content: application/json: - example: - data: - attributes: - description: "Updated description for feature flag XYZ789" - name: "Updated Feature Flag XYZ789" - type: "feature-flags" + examples: + default: + value: + data: + attributes: + description: Updated description for the feature flag + enabled: true + name: Updated Feature Flag XYZ789 + type: feature-flags schema: $ref: "#/components/schemas/UpdateFeatureFlagRequest" required: true @@ -86657,18 +88105,20 @@ paths: requestBody: content: application/json: - example: - data: - attributes: - key: "prod-rollout" - name: "Production Rollout" - type: "FEATURE_GATE" - variant_weights: - - value: 50 - variant_id: "550e8400-e29b-41d4-a716-446655440001" - - value: 50 - variant_id: "550e8400-e29b-41d4-a716-446655440002" - type: "allocations" + examples: + default: + value: + data: + attributes: + key: "prod-rollout" + name: "Production Rollout" + type: "FEATURE_GATE" + variant_weights: + - value: 50 + variant_id: "550e8400-e29b-41d4-a716-446655440001" + - value: 50 + variant_id: "550e8400-e29b-41d4-a716-446655440002" + type: "allocations" schema: $ref: "#/components/schemas/CreateAllocationsRequest" required: true @@ -86753,18 +88203,20 @@ paths: requestBody: content: application/json: - example: - data: - - attributes: - key: "prod-rollout" - name: "Production Rollout" - type: "FEATURE_GATE" - variant_weights: - - value: 50 - variant_id: "550e8400-e29b-41d4-a716-446655440001" - - value: 50 - variant_id: "550e8400-e29b-41d4-a716-446655440002" - type: "allocations" + examples: + default: + value: + data: + - attributes: + key: "prod-rollout" + name: "Production Rollout" + type: "FEATURE_GATE" + variant_weights: + - value: 50 + variant_id: "550e8400-e29b-41d4-a716-446655440001" + - value: 50 + variant_id: "550e8400-e29b-41d4-a716-446655440002" + type: "allocations" schema: $ref: "#/components/schemas/OverwriteAllocationsRequest" required: true @@ -87012,6 +88464,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + hamr_status: 4 + is_primary: true + modified_by: admin@example.com + target_org_datacenter: us1 + target_org_name: Production Backup Org + target_org_uuid: 660f9511-f3ac-52e5-b827-557766551111 + id: 550e8400-e29b-41d4-a716-446655440000 + type: hamr_org_connections schema: $ref: "#/components/schemas/HamrOrgConnectionRequest" required: true @@ -87102,6 +88567,35 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + customer_impact_scope: Example customer impact scope + customer_impacted: false + fields: + severity: + type: dropdown + value: SEV-5 + incident_type_uuid: 00000000-0000-0000-0000-000000000000 + initial_cells: + - important: false + is_test: false + notification_handles: + - display_name: Jane Doe + handle: "@user@email.com" + - display_name: Slack Channel + handle: "@slack-channel" + - display_name: Incident Workflow + handle: "@workflow-from-incident" + title: A test incident title + relationships: + commander_user: + data: + id: 00000000-0000-0000-0000-000000000000 + type: users + type: incidents schema: $ref: "#/components/schemas/IncidentCreateRequest" description: Incident payload. @@ -87206,6 +88700,26 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + fields: + severity: + - SEV-1 + name: "@incident-sev-1" + id: b2494081-cdf0-4205-b366-4e1dd4fdf0bf + relationships: + commander_user: + data: + id: f7b538b1-ed7c-4e84-82de-fdf84a539d40 + type: incident_types + incident_type: + data: + id: f7b538b1-ed7c-4e84-82de-fdf84a539d40 + type: incident_types + type: incidents_handles schema: $ref: "#/components/schemas/IncidentHandleRequest" required: true @@ -87244,6 +88758,26 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + fields: + severity: + - SEV-1 + name: "@incident-sev-1" + id: b2494081-cdf0-4205-b366-4e1dd4fdf0bf + relationships: + commander_user: + data: + id: f7b538b1-ed7c-4e84-82de-fdf84a539d40 + type: incident_types + incident_type: + data: + id: f7b538b1-ed7c-4e84-82de-fdf84a539d40 + type: incident_types + type: incidents_handles schema: $ref: "#/components/schemas/IncidentHandleRequest" required: true @@ -87299,6 +88833,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + analytics_dashboard_id: abc-123-def + type: incidents_global_settings schema: $ref: "#/components/schemas/GlobalIncidentSettingsRequest" required: true @@ -87366,6 +88907,35 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + enabled: true + handles: + - "@team-email@company.com" + - "@slack-channel" + renotify_on: + - status + - severity + trigger: incident_created_trigger + visibility: organization + relationships: + incident_type: + data: + id: 00000000-0000-0000-0000-000000000000 + type: incident_types + notification_template: + data: + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates + type: incident_notification_rules schema: $ref: "#/components/schemas/CreateIncidentNotificationRuleRequest" required: true @@ -87484,6 +89054,36 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + enabled: true + handles: + - "@team-email@company.com" + - "@slack-channel" + renotify_on: + - status + - severity + trigger: incident_created_trigger + visibility: organization + id: 00000000-0000-0000-0000-000000000001 + relationships: + incident_type: + data: + id: 00000000-0000-0000-0000-000000000000 + type: incident_types + notification_template: + data: + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates + type: incident_notification_rules schema: $ref: "#/components/schemas/PutIncidentNotificationRuleRequest" required: true @@ -87564,6 +89164,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + category: alert + content: "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates." + name: Incident Alert Template + subject: "{{incident.severity}} Incident: {{incident.title}}" + relationships: + incident_type: + data: + id: 00000000-0000-0000-0000-000000000000 + type: incident_types + type: notification_templates schema: $ref: "#/components/schemas/CreateIncidentNotificationTemplateRequest" required: true @@ -87685,6 +89300,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + category: update + content: "Incident Status Update:\n\nTitle: {{incident.title}}\nNew Status: {{incident.state}}\nSeverity: {{incident.severity}}\nServices: {{incident.services}}\nCommander: {{incident.commander}}\n\nFor more details, visit the incident page." + name: Incident Status Update Template + subject: "Incident Update: {{incident.title}} - {{incident.state}}" + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates schema: $ref: "#/components/schemas/PatchIncidentNotificationTemplateRequest" required: true @@ -87752,6 +89378,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Standard Postmortem Template + type: postmortem_template schema: $ref: "#/components/schemas/PostmortemTemplateRequest" required: true @@ -87869,6 +89502,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Standard Postmortem Template + type: postmortem_template schema: $ref: "#/components/schemas/PostmortemTemplateRequest" required: true @@ -87942,6 +89582,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + createdBy: 00000000-0000-0000-0000-000000000000 + description: Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. + is_default: false + lastModifiedBy: 00000000-0000-0000-0000-000000000000 + name: Security Incident + prefix: IR + type: incident_types schema: $ref: "#/components/schemas/IncidentTypeCreateRequest" description: Incident type payload. @@ -88059,6 +89711,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + createdBy: 00000000-0000-0000-0000-000000000000 + description: "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team." + is_default: false + lastModifiedBy: 00000000-0000-0000-0000-000000000000 + name: Security Incident + prefix: IR + id: 00000000-0000-0000-0000-000000000000 + type: incident_types schema: $ref: "#/components/schemas/IncidentTypePatchRequest" description: Incident type payload. @@ -88224,6 +89889,31 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + category: what_happened + collected: active + default_value: critical + display_name: Root Cause + name: root_cause + ordinal: "1.5" + required: false + tag_key: datacenter + type: 3 + valid_values: + - description: A critical severity incident. + display_name: Critical + short_description: Critical + value: critical + relationships: + incident_type: + data: + id: 00000000-0000-0000-0000-000000000000 + type: incident_types + type: user_defined_field schema: $ref: "#/components/schemas/IncidentUserDefinedFieldCreateRequest" description: Incident user-defined field payload. @@ -88447,6 +90137,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + category: what_happened + collected: active + default_value: critical + display_name: Root Cause + ordinal: "1.5" + required: false + valid_values: + - description: A critical severity incident. + display_name: Critical + short_description: Critical + value: critical + id: 00000000-0000-0000-0000-000000000000 + type: user_defined_field schema: $ref: "#/components/schemas/IncidentUserDefinedFieldUpdateRequest" description: Incident user-defined field update payload. @@ -88542,6 +90250,32 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + declared: "2025-01-01T00:00:00Z" + detected: "2025-01-01T00:00:00Z" + fields: + severity: + value: SEV-5 + state: + value: active + incident_type_uuid: 00000000-0000-0000-0000-000000000000 + resolved: "2025-01-01T01:00:00Z" + title: Imported incident from external system + visibility: organization + relationships: + commander_user: + data: + id: 00000000-0000-0000-0000-000000000000 + type: users + declared_by_user: + data: + id: 00000000-0000-0000-0000-000000000000 + type: users + type: incidents schema: $ref: "#/components/schemas/IncidentImportRequest" description: Incident import payload. @@ -88709,6 +90443,42 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + customer_impact_scope: Example customer impact scope + customer_impacted: false + fields: + severity: + type: dropdown + value: SEV-5 + notification_handles: + - display_name: Jane Doe + handle: "@user@email.com" + - display_name: Slack Channel + handle: "@slack-channel" + - display_name: Incident Workflow + handle: "@workflow-from-incident" + title: A test incident title + id: 00000000-0000-0000-4567-000000000000 + relationships: + commander_user: + data: + id: 00000000-0000-0000-0000-000000000000 + type: users + integrations: + data: + - id: 00000000-abcd-0005-0000-000000000000 + type: incident_integrations + - id: 00000000-abcd-0006-0000-000000000000 + type: incident_integrations + postmortem: + data: + id: 00000000-0000-abcd-3000-000000000000 + type: incident_postmortems + type: incidents schema: $ref: "#/components/schemas/IncidentUpdateRequest" description: Incident Payload. @@ -88792,6 +90562,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + attachment: + documentUrl: https://app.datadoghq.com/notebook/123/Postmortem-IR-123 + title: Postmortem-IR-123 + attachment_type: postmortem + type: incident_attachments schema: $ref: "#/components/schemas/CreateAttachmentRequest" required: true @@ -88843,6 +90623,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + cells: + - id: cell-1 + type: markdown + content: "# Incident Report - IR-123\n[...]" + postmortem_template_id: 93645509-874e-45c4-adfa-623bfeaead89-123 + title: Postmortem-IR-123 + type: incident_attachments schema: $ref: "#/components/schemas/PostmortemAttachmentRequest" required: true @@ -88908,6 +90700,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + attachment: + documentUrl: https://app.datadoghq.com/notebook/124/Postmortem-IR-124 + title: Postmortem-IR-124 + id: 00000000-abcd-0002-0000-000000000000 + type: incident_attachments schema: $ref: "#/components/schemas/PatchAttachmentRequest" required: true @@ -88986,6 +90788,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: Service was unavailable for external users + end_at: "2025-08-29T13:17:00Z" + fields: + customers_impacted: all + products_impacted: + - shopping + - marketing + start_at: "2025-08-28T13:17:00Z" + type: incident_impacts schema: $ref: "#/components/schemas/IncidentImpactCreateRequest" description: Incident impact payload. @@ -89096,6 +90912,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + incident_id: 00000000-aaaa-0000-0000-000000000000 + integration_type: 1 + metadata: + channels: + - channel_id: C0123456789 + channel_name: "#new-channel" + redirect_url: https://slack.com/app_redirect?channel=C0123456789&team=T01234567 + team_id: T01234567 + type: incident_integrations schema: $ref: "#/components/schemas/IncidentIntegrationMetadataCreateRequest" description: Incident integration metadata payload. @@ -89208,6 +91038,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + incident_id: 00000000-aaaa-0000-0000-000000000000 + integration_type: 1 + metadata: + channels: + - channel_id: C0123456789 + channel_name: "#updated-channel-name" + redirect_url: https://slack.com/app_redirect?channel=C0123456789&team=T01234567 + team_id: T01234567 + type: incident_integrations schema: $ref: "#/components/schemas/IncidentIntegrationMetadataPatchRequest" description: Incident integration metadata payload. @@ -89287,6 +91131,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + assignees: + - "@test.user@test.com" + completed: "2023-03-06T22:00:00.000000+00:00" + content: Restore lost data. + due_date: "2023-07-10T05:00:00.000000+00:00" + incident_id: 00000000-aaaa-0000-0000-000000000000 + type: incident_todos schema: $ref: "#/components/schemas/IncidentTodoCreateRequest" description: Incident todo payload. @@ -89406,6 +91262,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + assignees: + - "@test.user@test.com" + completed: "2023-03-06T22:00:00.000000+00:00" + content: Restore lost data. + due_date: "2023-07-10T05:00:00.000000+00:00" + incident_id: 00000000-aaaa-0000-0000-000000000000 + type: incident_todos schema: $ref: "#/components/schemas/IncidentTodoPatchRequest" description: Incident todo payload. @@ -89481,6 +91349,37 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + account_tags: + - env:prod + auth_config: + access_key_id: AKIAIOSFODNN7EXAMPLE + secret_access_key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY + aws_account_id: "123456789012" + aws_partition: aws + aws_regions: + include_all: true + logs_config: + lambda_forwarder: + lambdas: + - arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder + sources: + - s3 + metrics_config: + automute_enabled: true + collect_cloudwatch_alarms: false + collect_custom_metrics: false + enabled: true + tag_filters: + - namespace: AWS/EC2 + resources_config: + cloud_security_posture_management_collection: false + extended_collection: true + type: account schema: $ref: "#/components/schemas/AWSAccountCreateRequest" required: true @@ -89566,6 +91465,38 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + account_tags: + - env:prod + auth_config: + access_key_id: AKIAIOSFODNN7EXAMPLE + secret_access_key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY + aws_account_id: "123456789012" + aws_partition: aws + aws_regions: + include_all: true + logs_config: + lambda_forwarder: + lambdas: + - arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder + sources: + - s3 + metrics_config: + automute_enabled: true + collect_cloudwatch_alarms: false + collect_custom_metrics: false + enabled: true + tag_filters: + - namespace: AWS/EC2 + resources_config: + cloud_security_posture_management_collection: false + extended_collection: true + id: 00000000-abcd-0001-0000-000000000000 + type: account schema: $ref: "#/components/schemas/AWSAccountUpdateRequest" required: true @@ -89659,6 +91590,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + ccm_config: + data_export_configs: + - bucket_name: billing + bucket_region: us-east-1 + report_name: cost-and-usage-report + report_prefix: reports + report_type: CUR2.0 + type: ccm_config schema: $ref: "#/components/schemas/AWSCcmConfigRequest" description: Update a Cloud Cost Management config for an AWS Account Integration Config. @@ -89697,6 +91641,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + ccm_config: + data_export_configs: + - bucket_name: billing + bucket_region: us-east-1 + report_name: cost-and-usage-report + report_prefix: reports + report_type: CUR2.0 + type: ccm_config schema: $ref: "#/components/schemas/AWSCcmConfigRequest" description: Create a Cloud Cost Management config for an AWS Account Integration Config. @@ -89756,6 +91713,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + account_id: "123456789012" + event_generator_name: app-alerts-zyxw3210 + region: us-east-1 + type: event_bridge schema: $ref: "#/components/schemas/AWSEventBridgeDeleteRequest" description: Delete the Amazon EventBridge source with the given name, region, and associated AWS account. @@ -89810,6 +91776,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + account_id: "123456789012" + create_event_bus: true + event_generator_name: app-alerts + region: us-east-1 + type: event_bridge schema: $ref: "#/components/schemas/AWSEventBridgeCreateRequest" description: Create an Amazon EventBridge source for an AWS account with a given name and region. @@ -89960,6 +91936,35 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + client_email: datadog-service-account@test-project.iam.gserviceaccount.com + cloud_run_revision_filters: + - $KEY:$VALUE + host_filters: + - $KEY:$VALUE + is_global_location_enabled: true + is_per_project_quota_enabled: true + is_resource_change_collection_enabled: true + is_security_command_center_enabled: true + metric_namespace_configs: + - disabled: true + id: aiplatform + - filters: + - snapshot.* + - "!*_by_region" + id: pubsub + monitored_resource_configs: + - filters: + - $KEY:$VALUE + type: gce_instance + region_filter_configs: + - nam4 + - europe-north1 + type: gcp_service_account schema: $ref: "#/components/schemas/GCPSTSServiceAccountCreateRequest" required: true @@ -90018,6 +92023,36 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + client_email: datadog-service-account@test-project.iam.gserviceaccount.com + cloud_run_revision_filters: + - $KEY:$VALUE + host_filters: + - $KEY:$VALUE + is_global_location_enabled: true + is_per_project_quota_enabled: true + is_resource_change_collection_enabled: true + is_security_command_center_enabled: true + metric_namespace_configs: + - disabled: true + id: aiplatform + - filters: + - snapshot.* + - "!*_by_region" + id: pubsub + monitored_resource_configs: + - filters: + - $KEY:$VALUE + type: gce_instance + region_filter_configs: + - nam4 + - europe-north1 + id: d291291f-12c2-22g4-j290-123456678897 + type: gcp_service_account schema: $ref: "#/components/schemas/GCPSTSServiceAccountUpdateRequest" required: true @@ -90073,6 +92108,9 @@ paths: requestBody: content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -90156,6 +92194,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: fake-handle-name + space_resource_name: spaces/AAAAAAAAA + type: google-chat-organization-handle schema: $ref: "#/components/schemas/GoogleChatCreateOrganizationHandleRequest" description: Organization handle payload. @@ -90243,6 +92289,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: fake-handle-name + space_resource_name: spaces/AAAAAAAAA + type: google-chat-organization-handle schema: $ref: "#/components/schemas/GoogleChatUpdateOrganizationHandleRequest" description: Organization handle payload. @@ -90352,6 +92406,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + fields: + description: + payload: Test + type: json + issue_type_id: "12730" + jira-account: + id: 80f16d40-1fba-486e-b1fc-983e6ca19bec + name: test-template + project_id: "10772" + type: jira-issue-template schema: $ref: "#/components/schemas/JiraIssueTemplateCreateRequest" required: true @@ -90451,6 +92520,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + fields: + description: + payload: Updated Description + type: json + name: test_template_updated + type: jira-issue-template schema: $ref: "#/components/schemas/JiraIssueTemplateUpdateRequest" required: true @@ -90534,6 +92614,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + channel_id: fake-channel-id + name: fake-handle-name + team_id: 00000000-0000-0000-0000-000000000000 + tenant_id: 00000000-0000-0000-0000-000000000001 + type: tenant-based-handle schema: $ref: "#/components/schemas/MicrosoftTeamsCreateTenantBasedHandleRequest" description: Tenant-based handle payload. @@ -90614,6 +92704,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + channel_id: fake-channel-id + name: fake-handle-name + team_id: 00000000-0000-0000-0000-000000000000 + tenant_id: 00000000-0000-0000-0000-000000000001 + type: tenant-based-handle schema: $ref: "#/components/schemas/MicrosoftTeamsUpdateTenantBasedHandleRequest" description: Tenant-based handle payload. @@ -90673,6 +92773,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: fake-handle-name + url: https://fake.url.com + type: workflows-webhook-handle schema: $ref: "#/components/schemas/MicrosoftTeamsCreateWorkflowsWebhookHandleRequest" description: Workflows Webhook handle payload. @@ -90753,6 +92861,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: fake-handle-name + url: https://fake.url.com + type: workflows-webhook-handle schema: $ref: "#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest" description: Workflows Webhook handle payload. @@ -90835,6 +92951,46 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + auth_credentials: + fingerprint: "" + private_key: "" + cost_collection_enabled: true + dd_compartment_id: ocid.compartment.test + dd_stack_id: ocid.stack.test + home_region: us-ashburn-1 + logs_config: + compartment_tag_filters: + - datadog:true + - env:prod + enabled: true + enabled_services: + - service_1 + - service_2 + metrics_config: + compartment_tag_filters: + - datadog:true + - env:prod + enabled: true + excluded_services: + - service_1 + - service_2 + regions_config: + available: + - us-ashburn-1 + - us-phoenix-1 + disabled: + - us-phoenix-1 + enabled: + - us-ashburn-1 + resource_collection_enabled: true + user_ocid: ocid.user.test + id: ocid.tenancy.test + type: oci_tenancy schema: $ref: "#/components/schemas/CreateTenancyConfigRequest" required: true @@ -90917,6 +93073,44 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + auth_credentials: + fingerprint: "" + private_key: "" + cost_collection_enabled: true + home_region: us-ashburn-1 + logs_config: + compartment_tag_filters: + - datadog:true + - env:prod + enabled: true + enabled_services: + - service_1 + - service_2 + metrics_config: + compartment_tag_filters: + - datadog:true + - env:prod + enabled: true + excluded_services: + - service_1 + - service_2 + regions_config: + available: + - us-ashburn-1 + - us-phoenix-1 + disabled: + - us-phoenix-1 + enabled: + - us-ashburn-1 + resource_collection_enabled: true + user_ocid: ocid.user.test + id: ocid.tenancy.test + type: oci_tenancy schema: $ref: "#/components/schemas/UpdateTenancyConfigRequest" required: true @@ -90963,6 +93157,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + custom_url: https://example.com + name: fake-opsgenie-service-name + opsgenie_api_key: 00000000-0000-0000-0000-000000000000 + region: us + type: opsgenie-service schema: $ref: "#/components/schemas/OpsgenieServiceCreateRequest" description: Opsgenie service payload @@ -91051,6 +93255,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + custom_url: https://example.com + name: fake-opsgenie-service-name + opsgenie_api_key: 00000000-0000-0000-0000-000000000000 + region: us + id: 596da4af-0563-4097-90ff-07230c3f9db3 + type: opsgenie-service schema: $ref: "#/components/schemas/OpsgenieServiceUpdateRequest" description: Opsgenie service payload. @@ -91180,6 +93395,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + assignment_group_id: 65b3341b-0680-47f9-a6d4-134db45c603e + business_service_id: 65b3341b-0680-47f9-a6d4-134db45c603e + fields_mapping: + category: software + priority: "1" + handle_name: incident-template + instance_id: 65b3341b-0680-47f9-a6d4-134db45c603e + servicenow_tablename: incident + user_id: 65b3341b-0680-47f9-a6d4-134db45c603e + type: servicenow_templates schema: $ref: "#/components/schemas/ServiceNowTemplateCreateRequest" required: true @@ -91288,6 +93518,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + assignment_group_id: 65b3341b-0680-47f9-a6d4-134db45c603e + business_service_id: 65b3341b-0680-47f9-a6d4-134db45c603e + fields_mapping: + category: hardware + priority: "2" + handle_name: incident-template-updated + instance_id: 65b3341b-0680-47f9-a6d4-134db45c603e + servicenow_tablename: incident + user_id: 65b3341b-0680-47f9-a6d4-134db45c603e + type: servicenow_templates schema: $ref: "#/components/schemas/ServiceNowTemplateUpdateRequest" required: true @@ -91426,6 +93671,23 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + api_key: EXAMPLE_API_KEY_abc123 + email: test-email@example.com + name: test-name + resources: + - web + - dns + - lb + - worker + zones: + - zone_id_1 + - zone_id_2 + type: cloudflare-accounts schema: $ref: "#/components/schemas/CloudflareAccountCreateRequest" required: true @@ -91526,6 +93788,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + api_key: EXAMPLE_API_KEY_abc123 + email: test-email@example.com + resources: + - web + - dns + - lb + - worker + zones: + - zone_id_1 + - zone_id_2 + type: cloudflare-accounts schema: $ref: "#/components/schemas/CloudflareAccountUpdateRequest" required: true @@ -91584,6 +93862,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + api_key: TESTAPIKEY123 + api_secret: test-api-secret-123 + resources: + - enable_custom_metrics: false + id: resource-id-123 + resource_type: kafka + tags: + - myTag + - myTag2:myValue + tags: + - myTag + - myTag2:myValue + type: confluent-cloud-accounts schema: $ref: "#/components/schemas/ConfluentAccountCreateRequest" description: Confluent payload @@ -91670,6 +93966,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + api_key: TESTAPIKEY123 + api_secret: test-api-secret-123 + tags: + - myTag + - myTag2:myValue + type: confluent-cloud-accounts schema: $ref: "#/components/schemas/ConfluentAccountUpdateRequest" description: Confluent payload @@ -91733,6 +94040,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + enable_custom_metrics: false + resource_type: kafka + tags: + - myTag + - myTag2:myValue + id: resource-id-123 + type: confluent-cloud-resources schema: $ref: "#/components/schemas/ConfluentResourceRequest" description: Confluent payload @@ -91822,6 +94141,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + enable_custom_metrics: false + resource_type: kafka + tags: + - myTag + - myTag2:myValue + id: resource-id-123 + type: confluent-cloud-resources schema: $ref: "#/components/schemas/ConfluentResourceRequest" description: Confluent payload @@ -91881,6 +94212,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + api_key: ABCDEFG123 + name: test-name + services: + - id: 6abc7de6893AbcDe9fghIj + tags: + - myTag + - myTag2:myValue + type: fastly-accounts schema: $ref: "#/components/schemas/FastlyAccountCreateRequest" required: true @@ -91966,6 +94310,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + api_key: ABCDEFG123 + type: fastly-accounts schema: $ref: "#/components/schemas/FastlyAccountUpdateRequest" required: true @@ -92028,6 +94379,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - myTag + - myTag2:myValue + id: abc123 + type: fastly-services schema: $ref: "#/components/schemas/FastlyServiceRequest" required: true @@ -92116,6 +94477,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - myTag + - myTag2:myValue + id: abc123 + type: fastly-services schema: $ref: "#/components/schemas/FastlyServiceRequest" required: true @@ -92174,6 +94545,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + auth_method: oauth + client_id: client_id + client_secret: client_secret + domain: https://example.okta.com/ + name: Okta-Prod + id: f749daaf-682e-4208-a38d-c9b43162c609 + type: okta-accounts schema: $ref: "#/components/schemas/OktaAccountRequest" required: true @@ -92274,6 +94657,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + auth_method: oauth + domain: https://example.okta.com/ + type: okta-accounts schema: $ref: "#/components/schemas/OktaAccountUpdateRequest" required: true @@ -92335,6 +94726,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + enabled: false + entries: + - data: + attributes: + cidr_block: 127.0.0.1/32 + type: ip_allowlist_entry + type: ip_allowlist schema: $ref: "#/components/schemas/IPAllowlistUpdateRequest" required: true @@ -92439,6 +94842,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + dataset_id: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d + name: My Experiment v1 + project_id: a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + type: experiments schema: $ref: "#/components/schemas/LLMObsExperimentRequest" description: Create experiment payload. @@ -92492,6 +94904,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + experiment_ids: + - 3fd6b5e0-8910-4b1c-a7d0-5b84de329012 + type: experiments schema: $ref: "#/components/schemas/LLMObsDeleteExperimentsRequest" description: Delete experiments payload. @@ -92537,6 +94957,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: experiments schema: $ref: "#/components/schemas/LLMObsExperimentUpdateRequest" description: Update experiment payload. @@ -92592,6 +95017,27 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + metrics: + - assessment: pass + label: faithfulness + metric_type: score + span_id: span-7a1b2c3d + timestamp_ms: 1705314600000 + spans: + - dataset_id: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d + duration: 1500000000 + name: llm_call + project_id: a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + span_id: span-7a1b2c3d + start_ns: 1705314600000000000 + status: ok + trace_id: abc123def456 + type: events schema: $ref: "#/components/schemas/LLMObsExperimentEventsRequest" description: Experiment events payload. @@ -92702,6 +95148,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: My LLM Project + type: projects schema: $ref: "#/components/schemas/LLMObsProjectRequest" description: Create project payload. @@ -92755,6 +95208,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + project_ids: + - a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + type: projects schema: $ref: "#/components/schemas/LLMObsDeleteProjectsRequest" description: Delete projects payload. @@ -92800,6 +95261,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: projects schema: $ref: "#/components/schemas/LLMObsProjectUpdateRequest" description: Update project payload. @@ -92923,6 +95389,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: My LLM Dataset + type: datasets schema: $ref: "#/components/schemas/LLMObsDatasetRequest" description: Create dataset payload. @@ -92984,6 +95457,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + dataset_ids: + - 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d + type: datasets schema: $ref: "#/components/schemas/LLMObsDeleteDatasetsRequest" description: Delete datasets payload. @@ -93036,6 +95517,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: datasets schema: $ref: "#/components/schemas/LLMObsDatasetUpdateRequest" description: Update dataset payload. @@ -93157,6 +95643,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + records: + - id: rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c + type: records schema: $ref: "#/components/schemas/LLMObsDatasetRecordsUpdateRequest" description: Update records payload. @@ -93212,6 +95706,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: records schema: $ref: "#/components/schemas/LLMObsDatasetRecordsRequest" description: Append records payload. @@ -93274,6 +95773,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + record_ids: + - rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c + type: records schema: $ref: "#/components/schemas/LLMObsDeleteDatasetRecordsRequest" description: Delete records payload. @@ -93362,6 +95869,13 @@ paths: content: application/json: examples: + default: + value: + ddsource: nginx + ddtags: env:staging,version:5.1 + hostname: i-012345678 + message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World + service: payment multi-json-messages: description: Pass multiple log objects at once. summary: Multi JSON Messages @@ -93389,6 +95903,12 @@ paths: $ref: "#/components/schemas/HTTPLog" application/logplex-1: examples: + default: + value: + multi-raw-message: + description: Submit log messages. + summary: Multi Logplex Messages + value: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\n2019-11-19T14:37:58,995 INFO [process.name][20081] World" multi-raw-message: description: Submit log messages. summary: Multi Logplex Messages @@ -93403,6 +95923,12 @@ paths: type: string text/plain: examples: + default: + value: + multi-raw-message: + description: Submit log string. + summary: Multi Raw Messages + value: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello\n2019-11-19T14:37:58,995 INFO [process.name][20081] World" multi-raw-message: description: Submit log string. summary: Multi Raw Messages @@ -93520,6 +96046,35 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + compute: + - aggregation: pc90 + interval: 5m + metric: "@duration" + type: timeseries + filter: + from: now-15m + indexes: + - main + - web + query: service:web* AND @http.status_code:[200 TO 299] + storage_tier: indexes + to: now + group_by: + - facet: host + histogram: + interval: 10 + max: 100 + min: 50 + sort: + aggregation: count + order: asc + options: + timezone: GMT + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== schema: $ref: "#/components/schemas/LogsAggregateRequest" required: true @@ -93582,6 +96137,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + archive_ids: + - a2zcMylnM4OCHpYusxIi1g + - a2zcMylnM4OCHpYusxIi2g + - a2zcMylnM4OCHpYusxIi3g + type: archive_order schema: $ref: "#/components/schemas/LogsArchiveOrder" description: An object containing the new ordered list of archive IDs. @@ -93654,6 +96219,23 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + destination: + container: container-name + storage_account: account-name + type: azure + include_tags: false + name: Nginx Archive + query: source:nginx + rehydration_max_scan_size_in_gb: 100 + rehydration_tags: + - team:intake + - team:app + type: archives schema: $ref: "#/components/schemas/LogsArchiveCreateRequest" description: The definition of the new archive. @@ -93776,6 +96358,23 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + destination: + container: container-name + storage_account: account-name + type: azure + include_tags: false + name: Nginx Archive + query: source:nginx + rehydration_max_scan_size_in_gb: 100 + rehydration_tags: + - team:intake + - team:app + type: archives schema: $ref: "#/components/schemas/LogsArchiveCreateRequest" description: New definition of the archive. @@ -93824,6 +96423,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + type: roles schema: $ref: "#/components/schemas/RelationshipToRole" required: true @@ -93906,6 +96511,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + type: roles schema: $ref: "#/components/schemas/RelationshipToRole" required: true @@ -93973,6 +96584,23 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + forward_tags: true + forward_tags_restriction_list: + - datacenter + - host + forward_tags_restriction_list_type: ALLOW_LIST + forwarder_destination: + endpoint: https://example.com + type: http + name: Nginx logs + query: source:nginx + type: custom_destination schema: $ref: "#/components/schemas/CustomDestinationCreateRequest" description: The definition of the new custom destination. @@ -94060,6 +96688,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + forward_tags: true + forward_tags_restriction_list: + - datacenter + - host + forward_tags_restriction_list_type: ALLOW_LIST + forwarder_destination: + endpoint: https://example.com + type: http + name: Nginx logs + query: source:nginx + id: be5d7a69-d0c8-4d4d-8ee8-bba292d98139 + type: custom_destination schema: $ref: "#/components/schemas/CustomDestinationUpdateRequest" description: New definition of the custom destination's fields. @@ -94119,6 +96765,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + compute: + aggregation_type: distribution + include_percentiles: true + path: "@duration" + filter: + query: service:web* AND @http.status_code:[200 TO 299] + group_by: + - path: "@http.status_code" + tag_name: status_code + id: logs.page.load.count + type: logs_metrics schema: $ref: "#/components/schemas/LogsMetricCreateRequest" description: The definition of the new log-based metric. @@ -94203,6 +96865,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + compute: + include_percentiles: true + filter: + query: service:web* AND @http.status_code:[200 TO 299] + group_by: + - path: "@http.status_code" + tag_name: status_code + type: logs_metrics schema: $ref: "#/components/schemas/LogsMetricUpdateRequest" description: New definition of the log-based metric. @@ -94268,6 +96943,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + restriction_query: env:sandbox + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryCreatePayload" required: true @@ -94481,6 +97163,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + restriction_query: env:sandbox + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryUpdatePayload" required: true @@ -94531,6 +97220,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + restriction_query: env:sandbox + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryUpdatePayload" required: true @@ -94581,6 +97277,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + type: roles schema: $ref: "#/components/schemas/RelationshipToRole" required: true @@ -94674,6 +97376,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + type: roles schema: $ref: "#/components/schemas/RelationshipToRole" required: true @@ -94836,6 +97544,23 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + filter: + from: now-15m + indexes: + - main + - web + query: service:web* AND @http.status_code:[200 TO 299] + storage_tier: indexes + to: now + options: + timezone: GMT + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + limit: 25 + sort: timestamp schema: $ref: "#/components/schemas/LogsListRequest" required: false @@ -95016,6 +97741,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + emails: + - sue@example.com + - bob@example.com + id: kafka.lag + type: metric_bulk_configure_tags schema: $ref: "#/components/schemas/MetricBulkTagConfigDeleteRequest" required: true @@ -95071,6 +97806,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + emails: + - sue@example.com + - bob@example.com + tags: + - host + - pod_name + - is_shadow + id: kafka.lag + type: metric_bulk_configure_tags schema: $ref: "#/components/schemas/MetricBulkTagConfigCreateRequest" required: true @@ -95541,6 +98290,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + group_by: + - app + - datacenter + include_percentiles: false + id: http.endpoint.request + type: manage_tags schema: $ref: "#/components/schemas/MetricTagConfigurationUpdateRequest" required: true @@ -95596,6 +98356,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + include_percentiles: false + metric_type: distribution + tags: + - app + - datacenter + id: http.endpoint.request + type: manage_tags schema: $ref: "#/components/schemas/MetricTagConfigurationCreateRequest" required: true @@ -95767,6 +98539,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + conditional_recipients: + fallback_recipients: + - slack-test-channel + - jira-test + filter: + tags: + - team:product + - host:abc + name: A notification rule name + recipients: + - slack-test-channel + - jira-test + type: monitor-notification-rule schema: $ref: "#/components/schemas/MonitorNotificationRuleCreateRequest" description: Request body to create a monitor notification rule. @@ -95899,6 +98689,25 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + conditional_recipients: + fallback_recipients: + - slack-test-channel + - jira-test + filter: + tags: + - team:product + - host:abc + name: A notification rule name + recipients: + - slack-test-channel + - jira-test + id: 00000000-0000-1234-0000-000000000000 + type: monitor-notification-rule schema: $ref: "#/components/schemas/MonitorNotificationRuleUpdateRequest" description: Request body to update the monitor notification rule. @@ -95975,6 +98784,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + policy: + tag_key: datacenter + tag_key_required: true + valid_tag_values: + - prod + - staging + policy_type: tag + type: monitor-config-policy schema: $ref: "#/components/schemas/MonitorConfigPolicyCreateRequest" description: Create a monitor configuration policy request body. @@ -96108,6 +98930,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + policy: + tag_key: datacenter + tag_key_required: true + valid_tag_values: + - prod + - staging + policy_type: tag + id: 00000000-0000-1234-0000-000000000000 + type: monitor-config-policy schema: $ref: "#/components/schemas/MonitorConfigPolicyEditRequest" description: Description of the update. @@ -96181,6 +99017,30 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: This is a template for monitoring user activity. + monitor_definition: + message: You may need to add web hosts if this is consistently high. + name: Bytes received on host0 + query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100 + type: query alert + tags: + - product:Our Custom App + - integration:Azure + template_variables: + - available_values: + - value1 + - value2 + defaults: + - defaultValue + name: regionName + tag_key: datacenter + title: Postgres CPU Monitor + type: monitor-user-template schema: $ref: "#/components/schemas/MonitorUserTemplateCreateRequest" required: true @@ -96216,6 +99076,30 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: This is a template for monitoring user activity. + monitor_definition: + message: You may need to add web hosts if this is consistently high. + name: Bytes received on host0 + query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100 + type: query alert + tags: + - product:Our Custom App + - integration:Azure + template_variables: + - available_values: + - value1 + - value2 + defaults: + - defaultValue + name: regionName + tag_key: datacenter + title: Postgres CPU Monitor + type: monitor-user-template schema: $ref: "#/components/schemas/MonitorUserTemplateCreateRequest" required: true @@ -96333,6 +99217,31 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: This is a template for monitoring user activity. + monitor_definition: + message: You may need to add web hosts if this is consistently high. + name: Bytes received on host0 + query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100 + type: query alert + tags: + - product:Our Custom App + - integration:Azure + template_variables: + - available_values: + - value1 + - value2 + defaults: + - defaultValue + name: regionName + tag_key: datacenter + title: Postgres CPU Monitor + id: 00000000-0000-1234-0000-000000000000 + type: monitor-user-template schema: $ref: "#/components/schemas/MonitorUserTemplateUpdateRequest" required: true @@ -96382,6 +99291,31 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: This is a template for monitoring user activity. + monitor_definition: + message: You may need to add web hosts if this is consistently high. + name: Bytes received on host0 + query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100 + type: query alert + tags: + - product:Our Custom App + - integration:Azure + template_variables: + - available_values: + - value1 + - value2 + defaults: + - defaultValue + name: regionName + tag_key: datacenter + title: Postgres CPU Monitor + id: 00000000-0000-1234-0000-000000000000 + type: monitor-user-template schema: $ref: "#/components/schemas/MonitorUserTemplateUpdateRequest" required: true @@ -96611,6 +99545,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - tag:test + - tag:testbis + id: example:1.2.3.4 + type: tags schema: $ref: "#/components/schemas/ListTagsResponse" required: true @@ -96672,6 +99616,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - tag:test + - tag:testbis + id: example:1.2.3.4:1 + type: tags schema: $ref: "#/components/schemas/ListInterfaceTagsResponse" required: true @@ -96824,6 +99778,40 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + config: + destinations: + - id: datadog-logs-destination + inputs: + - my-processor-group + type: datadog_logs + pipeline_type: logs + processor_groups: + - enabled: true + id: my-processor-group + include: service:my-service + inputs: + - datadog-agent-source + processors: + - enabled: true + id: filter-processor + include: status:error + type: filter + - enabled: true + field: message + id: json-processor + include: "*" + type: parse_json + processors: [] + sources: + - id: datadog-agent-source + type: datadog_agent + name: Main Observability Pipeline + type: pipelines schema: $ref: "#/components/schemas/ObservabilityPipelineSpec" required: true @@ -96858,6 +99846,40 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + config: + destinations: + - id: datadog-logs-destination + inputs: + - my-processor-group + type: datadog_logs + pipeline_type: logs + processor_groups: + - enabled: true + id: my-processor-group + include: service:my-service + inputs: + - datadog-agent-source + processors: + - enabled: true + id: filter-processor + include: status:error + type: filter + - enabled: true + field: message + id: json-processor + include: "*" + type: parse_json + processors: [] + sources: + - id: datadog-agent-source + type: datadog_agent + name: Main Observability Pipeline + type: pipelines schema: $ref: "#/components/schemas/ObservabilityPipelineSpec" required: true @@ -96967,6 +99989,41 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + config: + destinations: + - id: datadog-logs-destination + inputs: + - my-processor-group + type: datadog_logs + pipeline_type: logs + processor_groups: + - enabled: true + id: my-processor-group + include: service:my-service + inputs: + - datadog-agent-source + processors: + - enabled: true + id: filter-processor + include: status:error + type: filter + - enabled: true + field: message + id: json-processor + include: "*" + type: parse_json + processors: [] + sources: + - id: datadog-agent-source + type: datadog_agent + name: Main Observability Pipeline + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + type: pipelines schema: $ref: "#/components/schemas/ObservabilityPipeline" required: true @@ -97007,6 +100064,40 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Escalation Policy 1 + resolve_page_on_policy_end: true + retries: 2 + steps: + - assignment: default + escalate_after_seconds: 3600 + targets: + - id: 00000000-aba1-0000-0000-000000000000 + type: users + - config: + schedule: + position: previous + id: 00000000-aba2-0000-0000-000000000000 + type: schedules + - id: 00000000-aba3-0000-0000-000000000000 + type: teams + - assignment: round-robin + escalate_after_seconds: 3600 + targets: + - id: 00000000-aba1-0000-0000-000000000000 + type: users + - id: 00000000-abb1-0000-0000-000000000000 + type: users + relationships: + teams: + data: + - id: 00000000-da3a-0000-0000-000000000000 + type: teams + type: policies schema: $ref: "#/components/schemas/EscalationPolicyCreateRequest" required: true @@ -97133,6 +100224,30 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Escalation Policy 1 + resolve_page_on_policy_end: false + retries: 2 + steps: + - assignment: default + escalate_after_seconds: 3600 + id: 00000000-aba1-0000-0000-000000000000 + targets: + - id: 00000000-aba1-0000-0000-000000000000 + type: users + - id: 00000000-aba2-0000-0000-000000000000 + type: schedules + id: a3000000-0000-0000-0000-000000000000 + relationships: + teams: + data: + - id: 00000000-da3a-0000-0000-000000000000 + type: teams + type: policies schema: $ref: "#/components/schemas/EscalationPolicyUpdateRequest" required: true @@ -97172,6 +100287,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: Page details. + tags: + - service:test + target: + identifier: my-team + type: team_handle + title: Page title + urgency: low + type: pages schema: $ref: "#/components/schemas/CreatePageRequest" required: true @@ -97398,6 +100527,34 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + layers: + - effective_date: "2025-02-03T05:00:00Z" + end_date: "2025-12-31T00:00:00Z" + interval: + days: 1 + members: + - user: + id: 00000000-aba1-0000-0000-000000000000 + name: Layer 1 + restrictions: + - end_day: friday + end_time: "17:00:00" + start_day: monday + start_time: 09:00:00 + rotation_start: "2025-02-01T00:00:00Z" + name: On-Call Schedule + time_zone: America/New_York + relationships: + teams: + data: + - id: 00000000-da3a-0000-0000-000000000000 + type: teams + type: schedules schema: $ref: "#/components/schemas/ScheduleCreateRequest" required: true @@ -97522,6 +100679,35 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + layers: + - effective_date: "2025-02-03T05:00:00Z" + end_date: "2025-12-31T00:00:00Z" + interval: + seconds: 3600 + members: + - user: + id: 00000000-aba1-0000-0000-000000000000 + name: Layer 1 + restrictions: + - end_day: friday + end_time: "17:00:00" + start_day: monday + start_time: 09:00:00 + rotation_start: "2025-02-01T00:00:00Z" + name: On-Call Schedule Updated + time_zone: America/New_York + id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + relationships: + teams: + data: + - id: 00000000-da3a-0000-0000-000000000000 + type: teams + type: schedules schema: $ref: "#/components/schemas/ScheduleUpdateRequest" required: true @@ -97705,6 +100891,37 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + rules: + - actions: + policy_id: "" + query: tags.service:test + time_restriction: + restrictions: + - end_day: monday + end_time: "17:00:00" + start_day: monday + start_time: 09:00:00 + - end_day: tuesday + end_time: "17:00:00" + start_day: tuesday + start_time: 09:00:00 + time_zone: "" + urgency: high + - actions: + - channel: channel + type: send_slack_message + workspace: workspace + policy_id: fad4eee1-13f5-40d8-886b-4e56d8d5d1c6 + query: "" + time_restriction: + urgency: low + id: 27590dae-47be-4a7d-9abf-8f4e45124020 + type: team_routing_rules schema: $ref: "#/components/schemas/TeamRoutingRulesRequest" required: true @@ -97782,6 +100999,17 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + config: + address: foo@bar.com + formats: + - html + type: email + type: notification_channels schema: $ref: "#/components/schemas/CreateUserNotificationChannelRequest" required: true @@ -97961,6 +101189,22 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + category: high_urgency + channel_settings: + method: sms + type: phone + delay_minutes: 1 + relationships: + channel: + data: + id: 1562fab3-a8c2-49e2-8f3a-28dcda2405e2 + type: notification_channels + type: notification_rules schema: $ref: "#/components/schemas/CreateOnCallNotificationRuleRequest" required: true @@ -98112,6 +101356,23 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + category: high_urgency + channel_settings: + method: sms + type: phone + delay_minutes: 1 + id: 2462ace1-49e2-aab1-xc4f-29cc4ae1105n7 + relationships: + channel: + data: + id: 1562fab3-a8c2-49e2-8f3a-28dcda2405e2 + type: notification_channels + type: notification_rules schema: $ref: "#/components/schemas/UpdateOnCallNotificationRuleRequest" required: true @@ -98190,6 +101451,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + value: UTC + type: org_configs schema: {$ref: "#/components/schemas/OrgConfigWriteRequest"} required: true responses: @@ -98274,6 +101542,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + connection_types: + - logs + relationships: + sink_org: + data: + id: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a + name: Example Org + type: orgs + type: org_connection schema: $ref: "#/components/schemas/OrgConnectionCreateRequest" required: true @@ -98346,6 +101628,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + connection_types: + - logs + - metrics + id: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a + type: org_connection schema: $ref: "#/components/schemas/OrgConnectionUpdateRequest" required: true @@ -98615,6 +101907,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + mute: + expiration_date: 1778721573794 + muted: true + reason: ACCEPTED_RISK + id: dbe5f567-192b-4404-b908-29b70e1c9f76 + meta: + findings: + - finding_id: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw== + type: finding schema: $ref: "#/components/schemas/BulkMuteFindingsRequest" description: |- @@ -98761,6 +102067,46 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: Powerpack for ABC + group_widget: + definition: + layout_type: ordered + show_title: true + title: Sample Powerpack + type: group + widgets: + - definition: + content: example + type: note + layout: + height: 5 + width: 10 + x: 0 + y: 0 + layout: + height: 0 + width: 0 + x: 0 + y: 0 + live_span: 5m + name: Sample Powerpack + tags: + - tag:foo1 + template_variables: + - defaults: + - "*" + name: test + relationships: + author: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users + type: powerpack schema: $ref: "#/components/schemas/Powerpack" description: Create a powerpack request body. @@ -98877,6 +102223,46 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: Powerpack for ABC + group_widget: + definition: + layout_type: ordered + show_title: true + title: Sample Powerpack + type: group + widgets: + - definition: + content: example + type: note + layout: + height: 5 + width: 10 + x: 0 + y: 0 + layout: + height: 0 + width: 0 + x: 0 + y: 0 + live_span: 5m + name: Sample Powerpack + tags: + - tag:foo1 + template_variables: + - defaults: + - "*" + name: test + relationships: + author: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users + type: powerpack schema: $ref: "#/components/schemas/Powerpack" description: Update a powerpack request body. @@ -99044,6 +102430,15 @@ paths: content: application/json: examples: + default: + value: + application: + id: 123abcde-123a-123b-1234-123456789abc + event: + name: payment.processed + type: server + usr: + id: "123" event-with-account: description: Send a server-side event linked to an account. summary: Event with account ID @@ -99191,6 +102586,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + facet_id: first_browser_name + limit: 10 + search: + query: user_org_id:5001 AND first_country_code:US + term_search: + value: Chrome + id: facet_info_request + type: users_facet_info_request schema: $ref: "#/components/schemas/FacetInfoRequest" required: true @@ -99218,6 +102626,28 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + limit: 20 + query: plan_type:enterprise AND user_count:>100 AND subscription_status:active + select_columns: + - account_id + - account_name + - user_count + - plan_type + - subscription_status + - created_at + - mrr + - industry + sort: + field: user_count + order: DESC + wildcard_search_term: tech + id: query_account_request + type: query_account_request schema: $ref: "#/components/schemas/QueryAccountRequest" required: true @@ -99247,6 +102677,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + from: 1771232048460 + query: + compute: + aggregation: count + query: + data_source: product_analytics + search: + query: "@type:view" + to: 1771836848262 + type: formula_analytics_extended_request schema: $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequest" required: true @@ -99281,6 +102726,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + from: 1771232048460 + query: + compute: + aggregation: count + query: + data_source: product_analytics + search: + query: "@type:view" + to: 1771836848262 + type: formula_analytics_extended_request schema: $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequest" required: true @@ -99312,6 +102772,30 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + event_query: + query: "@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform" + time_frame: + end: 1761309676 + start: 1760100076 + include_row_count: true + limit: 25 + query: user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome + select_columns: + - user_id + - user_email + - first_country_code + - first_browser_name + - events_count + - session_count + - error_count + - avg_loading_time + id: query_event_filtered_users_request + type: query_event_filtered_users_request schema: $ref: "#/components/schemas/QueryEventFilteredUsersRequest" required: true @@ -99339,6 +102823,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + facet_id: first_browser_name + limit: 10 + search: + query: user_org_id:5001 AND first_country_code:US + term_search: + value: Chrome + id: facet_info_request + type: users_facet_info_request schema: $ref: "#/components/schemas/FacetInfoRequest" required: true @@ -99366,6 +102863,28 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + limit: 25 + query: user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome + select_columns: + - user_id + - user_email + - user_name + - user_org_id + - first_country_code + - first_browser_name + - first_device_type + - last_seen + sort: + field: first_seen + order: DESC + wildcard_search_term: john + id: query_users_request + type: query_users_request schema: $ref: "#/components/schemas/QueryUsersRequest" required: true @@ -99430,6 +102949,27 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + fields: + - description: Customer subscription tier from `CRM` + display_name: Customer Tier + id: customer_tier + source_name: subscription_tier + type: string + - description: Customer lifetime value in `USD` + display_name: Lifetime Value + id: lifetime_value + source_name: ltv + type: number + join_attribute: user_email + join_type: email + type: ref_table + id: crm-integration + type: connection_id schema: $ref: "#/components/schemas/CreateConnectionRequest" required: true @@ -99460,6 +103000,30 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + fields_to_add: + - description: Net Promoter Score from customer surveys + display_name: NPS Score + groups: + - Satisfaction + - Metrics + id: nps_score + source_name: net_promoter_score + type: number + fields_to_delete: + - old_revenue_field + fields_to_update: + - field_id: lifetime_value + updated_display_name: Customer Lifetime Value (`USD`) + updated_groups: + - Financial + - Metrics + id: crm-integration + type: connection_id schema: $ref: "#/components/schemas/UpdateConnectionRequest" required: true @@ -99547,6 +103111,22 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + formulas: + - formula: a+b + limit: + count: 10 + from: 1568899800000 + queries: + - aggregator: avg + data_source: metrics + query: avg:system.cpu.user{*} by {env} + to: 1568923200000 + type: scalar_request schema: $ref: "#/components/schemas/ScalarFormulaQueryRequest" required: true @@ -99587,6 +103167,22 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + formulas: + - formula: a+b + limit: + count: 10 + from: 1568899800000 + interval: 5000 + queries: + - data_source: metrics + query: avg:system.cpu.user{*} by {env} + to: 1568923200000 + type: timeseries_request schema: $ref: "#/components/schemas/TimeseriesFormulaQueryRequest" required: true @@ -99626,6 +103222,15 @@ paths: content: application/json: examples: + default: + value: + data: + attributes: + row_ids: + - row_id_1 + - row_id_2 + table_id: 00000000-0000-0000-0000-000000000000 + type: reference-tables-batch-rows-query happy_path: summary: Batch query reference table rows by their primary key values. value: @@ -99779,6 +103384,33 @@ paths: tags: - team:data-platform type: reference_table + default: + value: + data: + attributes: + description: Customer reference data synced from S3 + file_metadata: + access_details: + aws_detail: + aws_account_id: "924305315327" + aws_bucket_name: my-data-bucket + file_path: customers.csv + sync_enabled: true + schema: + fields: + - name: customer_id + type: STRING + - name: customer_name + type: STRING + - name: email + type: STRING + primary_keys: + - customer_id + source: S3 + table_name: customer_reference_data + tags: + - team:data-platform + type: reference_table local_file: summary: Create table from local file upload value: @@ -99896,6 +103528,30 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: this is a cloud table generated via a cloud bucket sync + file_metadata: + access_details: + aws_detail: + aws_account_id: test-account-id + aws_bucket_name: test-bucket + file_path: test_rt.csv + sync_enabled: true + schema: + fields: + - name: id + type: INT32 + - name: name + type: STRING + primary_keys: + - id + tags: + - test_tag + type: reference_table schema: $ref: "#/components/schemas/PatchTableRequest" required: true @@ -99929,6 +103585,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - id: primary_key_value + type: row schema: $ref: "#/components/schemas/BatchDeleteRowsRequestArray" required: true @@ -100012,6 +103674,16 @@ paths: content: application/json: examples: + default: + value: + data: + - attributes: + values: + age: 25 + example_key_value: primary_key_value + name: row_name + id: primary_key_value + type: row happy_path: summary: Upsert a row with mixed string and int values value: @@ -100057,6 +103729,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + headers: + - product_id + - product_name + - price + part_count: 3 + part_size: 10000000 + table_name: my_products_table + type: upload schema: $ref: "#/components/schemas/CreateUploadRequest" required: true @@ -100104,6 +103789,33 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + action: + action: block_request + parameters: + location: /blocking + status_code: 403 + blocking: false + conditions: + - operator: match_regex + parameters: + data: blocked_users + regex: path.* + value: custom_tag + enabled: false + name: Block request from a bad useragent + path_glob: /api/search/* + scope: + - env: prod + service: billing-service + tags: + category: business_logic + type: users.login.success + type: custom_rule schema: $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCreateRequest" description: The definition of the new WAF Custom Rule. @@ -100178,6 +103890,37 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + action: + action: block_request + parameters: + location: /blocking + status_code: 403 + blocking: false + conditions: + - operator: match_regex + parameters: + data: blocked_users + inputs: + - address: server.request.query + key_path: + - id + regex: path.* + value: custom_tag + enabled: false + name: Block request from bad useragent + path_glob: /api/search/* + scope: + - env: prod + service: billing-service + tags: + category: business_logic + type: users.login.success + type: custom_rule schema: $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleUpdateRequest" description: New definition of the WAF Custom Rule. @@ -100237,6 +103980,28 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: Exclude false positives on a path + enabled: true + ip_list: + - 198.51.100.72 + on_match: monitor + parameters: + - list.search.query + path_glob: /accounts/* + rules_target: + - rule_id: dog-913-009 + tags: + category: attack_attempt + type: lfi + scope: + - env: www + service: prod + type: exclusion_filter schema: $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterCreateRequest" description: The definition of the new WAF exclusion filter. @@ -100326,6 +104091,28 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: Exclude false positives on a path + enabled: true + ip_list: + - 198.51.100.72 + on_match: monitor + parameters: + - list.search.query + path_glob: /accounts/* + rules_target: + - rule_id: dog-913-009 + tags: + category: attack_attempt + type: lfi + scope: + - env: www + service: prod + type: exclusion_filter schema: $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateRequest" description: The exclusion filter to update. @@ -100387,6 +104174,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + agent_version: "> 7.60" + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + name: my_agent_rule + policy_id: a8c8e364-6556-434d-b798-a4c23de29c0b + silent: false + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest" description: "The definition of the new agent rule" @@ -100467,6 +104267,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + policy_id: a8c8e364-6556-434d-b798-a4c23de29c0b + silent: false + id: 3dd-0uc-h1s + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest" description: "New definition of the agent rule" @@ -100520,6 +104332,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: My agent policy + enabled: true + hostTagsLists: + - - env:test + name: my_agent_policy + type: policy schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateRequest" description: "The definition of the new Agent policy" @@ -100622,6 +104445,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: My agent policy + enabled: true + name: my_agent_policy + id: 6517fcc1-cec7-4394-a655-8d6e9d085255 + type: policy schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateRequest" description: "New definition of the Agent policy" @@ -100698,6 +104531,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + application_id: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb + device_type: desktop + event_id: 11111111-2222-3333-4444-555555555555 + is_device_type_selected_by_user: false + snapshot_name: My Snapshot + start: 0 + view_name: /home + type: snapshots schema: $ref: "#/components/schemas/SnapshotCreateRequest" required: true @@ -100755,6 +104601,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + event_id: 11111111-2222-3333-4444-555555555555 + is_device_type_selected_by_user: false + start: 0 + id: 00000000-0000-0000-0000-000000000001 + type: snapshots schema: $ref: "#/components/schemas/SnapshotUpdateRequest" required: true @@ -100899,6 +104755,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + bindings: + - principals: + - org:4dee724d-00cc-11ea-a77b-570c9d03c6c5 + relation: editor + id: dashboard:abc-def-ghi + type: restriction_policy schema: $ref: "#/components/schemas/RestrictionPolicyUpdateRequest" description: Restriction policy payload @@ -100988,6 +104855,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: developers + type: roles schema: $ref: "#/components/schemas/RoleCreateRequest" required: true @@ -101123,6 +104997,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-1111-0000-000000000000 + type: roles schema: $ref: "#/components/schemas/RoleUpdateRequest" required: true @@ -101181,6 +105061,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: cloned-role + type: roles schema: $ref: "#/components/schemas/RoleCloneRequest" required: true @@ -101239,6 +105126,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 6f66600e-dd12-11e8-9e55-7f30fbb45e73 + type: permissions schema: $ref: "#/components/schemas/RelationshipToPermission" required: true @@ -101325,6 +105218,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 6f66600e-dd12-11e8-9e55-7f30fbb45e73 + type: permissions schema: $ref: "#/components/schemas/RelationshipToPermission" required: true @@ -101377,6 +105276,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users schema: $ref: "#/components/schemas/RelationshipToUser" required: true @@ -101480,6 +105385,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users schema: $ref: "#/components/schemas/RelationshipToUser" required: true @@ -101531,6 +105442,32 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + compute: + - aggregation: pc90 + interval: 5m + metric: "@duration" + type: timeseries + filter: + from: now-15m + query: "@type:session AND @session.type:user" + to: now + group_by: + - facet: "@view.time_spent" + histogram: + interval: 10 + max: 100 + min: 50 + sort: + aggregation: count + order: asc + options: + timezone: GMT + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + limit: 25 schema: $ref: "#/components/schemas/RUMAggregateRequest" required: true @@ -101581,6 +105518,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: my_new_rum_application + product_analytics_retention_state: MAX + rum_event_processing_state: ALL + type: browser + type: rum_application_create schema: $ref: "#/components/schemas/RUMApplicationCreateRequest" required: true @@ -101613,6 +105560,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - id: 051601eb-54a0-abc0-03f9-cc02efa18892 + type: retention_filters schema: $ref: "#/components/schemas/RumRetentionFiltersOrderRequest" description: New definition of the RUM retention filter. @@ -101664,6 +105617,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + cross_product_sampling: + trace_enabled: true + trace_sample_rate: 25.0 + enabled: true + event_type: session + name: Retention filter for session + query: "@session.has_replay:true" + sample_rate: 50.5 + type: retention_filters schema: $ref: "#/components/schemas/RumRetentionFilterCreateRequest" description: The definition of the new RUM retention filter. @@ -101737,6 +105704,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + cross_product_sampling: + trace_enabled: true + trace_sample_rate: 25.0 + enabled: true + event_type: session + name: Retention filter for session + query: "@session.has_replay:true" + sample_rate: 50.5 + id: 051601eb-54a0-abc0-03f9-cc02efa18892 + type: retention_filters schema: $ref: "#/components/schemas/RumRetentionFilterUpdateRequest" description: New definition of the RUM retention filter. @@ -101824,6 +105806,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: updated_name_for_my_existing_rum_application + product_analytics_retention_state: MAX + rum_event_processing_state: ALL + type: browser + id: abcd1234-0000-0000-abcd-1234abcd5678 + type: rum_application_update schema: $ref: "#/components/schemas/RUMApplicationUpdateRequest" required: true @@ -101879,6 +105872,25 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + compute: + aggregation_type: distribution + include_percentiles: true + path: "@duration" + event_type: session + filter: + query: "@service:web-ui:" + group_by: + - path: "@browser.name" + tag_name: browser_name + uniqueness: + when: match + id: rum.sessions.webui.count + type: rum_metrics schema: $ref: "#/components/schemas/RumMetricCreateRequest" description: The definition of the new rum-based metric. @@ -101951,6 +105963,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + compute: + include_percentiles: true + filter: + query: "@service:web-ui:" + group_by: + - path: "@browser.name" + tag_name: browser_name + id: rum.sessions.webui.count + type: rum_metrics schema: $ref: "#/components/schemas/RumMetricUpdateRequest" description: New definition of the rum-based metric. @@ -102071,6 +106097,19 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + filter: + from: now-15m + query: "@type:session AND @session.type:user" + to: now + options: + timezone: GMT + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + limit: 25 + sort: timestamp schema: $ref: "#/components/schemas/RUMSearchEventsRequest" required: true @@ -102150,6 +106189,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + created_by: + handle: john.doe@example.com + id: 00000000-0000-0000-0000-000000000001 + uuid: 00000000-0000-0000-0000-000000000001 + name: My Playlist + type: rum_replay_playlist schema: $ref: "#/components/schemas/Playlist" required: true @@ -102234,6 +106284,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + created_by: + handle: john.doe@example.com + id: 00000000-0000-0000-0000-000000000001 + uuid: 00000000-0000-0000-0000-000000000001 + name: My Playlist + type: rum_replay_playlist schema: $ref: "#/components/schemas/Playlist" required: true @@ -102268,6 +106329,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - id: 00000000-0000-0000-0000-000000000001 + type: rum_replay_session schema: $ref: "#/components/schemas/SessionIdArray" required: true @@ -102541,6 +106608,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + application_id: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb + event_id: 11111111-2222-3333-4444-555555555555 + timestamp: "2026-01-13T17:15:53.208340Z" + type: rum_replay_watch schema: $ref: "#/components/schemas/Watch" required: true @@ -102635,6 +106711,9 @@ paths: requestBody: content: multipart/form-data: + examples: + default: + value: {} schema: $ref: "#/components/schemas/IdPMetadataFormData" required: true @@ -102773,6 +106852,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: Campaign to improve security posture for Q1 2024. + due_date: "2024-03-31T23:59:59Z" + entity_scope: "kind:service AND team:platform" + guidance: Please ensure all services pass the security requirements. + key: q1-security-2024 + name: Q1 Security Campaign + owner_id: 550e8400-e29b-41d4-a716-446655440000 + rule_ids: + - q8MQxk8TCqrHnWkx + - r9NRyl9UDrsIoXly + start_date: "2024-01-01T00:00:00Z" + status: in_progress + type: campaign schema: $ref: "#/components/schemas/CreateCampaignRequest" description: Campaign data. @@ -102984,6 +107081,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: Campaign to improve security posture for Q1 2024. + due_date: "2024-03-31T23:59:59Z" + entity_scope: "kind:service AND team:platform" + guidance: Please ensure all services pass the security requirements. + key: q1-security-2024 + name: Q1 Security Campaign + owner_id: 550e8400-e29b-41d4-a716-446655440000 + rule_ids: + - q8MQxk8TCqrHnWkx + - r9NRyl9UDrsIoXly + start_date: "2024-01-01T00:00:00Z" + status: in_progress + type: campaign schema: $ref: "#/components/schemas/UpdateCampaignRequest" description: Campaign data. @@ -103159,6 +107274,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + results: + - entity_reference: service:my-service + remarks: 'See: Services' + rule_id: q8MQxk8TCqrHnWkx + state: pass + type: batched-outcome schema: $ref: "#/components/schemas/UpdateOutcomesAsyncRequest" description: Set of scorecard outcomes. @@ -103191,6 +107317,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + results: + - remarks: 'See: Services' + rule_id: q8MQxk8TCqrHnWkx + service_name: my-service + state: pass + type: batched-outcome schema: $ref: "#/components/schemas/OutcomesBatchRequest" description: Set of scorecard outcomes. @@ -103602,6 +107739,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + product_code: "" + user_uuids: + - 626a4e8e-64bd-409d-b80e-428f08ac0b62 + type: seat-assignments schema: $ref: "#/components/schemas/UnassignSeatsUserRequest" required: true @@ -103683,6 +107829,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + product_code: "" + user_uuids: + - "" + type: seat-assignments schema: $ref: "#/components/schemas/AssignSeatsUserRequest" required: true @@ -103932,6 +108087,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + relationships: + findings: + data: + - id: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw== + type: findings + type: cases schema: $ref: "#/components/schemas/DetachCaseRequest" required: true @@ -103966,6 +108131,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - attributes: + assignee_id: f315bdaf-9ee7-4808-a9c1-99c15bf0f4d0 + description: A description of the case. + priority: NOT_DEFINED + title: A title for the case. + relationships: + findings: + data: + - id: YjdhNDM3N2QyNTFjYmUwYTY3NDdhMTg0YTk2Yjg5MDl-ZjNmMzAwOTFkZDNhNGQzYzI0MzgxNTk4MjRjZmE2NzE= + type: findings + project: + data: + id: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + type: cases schema: $ref: "#/components/schemas/CreateCaseRequestArray" required: true @@ -104012,6 +108195,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: c1234567-89ab-cdef-0123-456789abcdef + relationships: + findings: + data: + - id: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw== + type: cases schema: $ref: "#/components/schemas/AttachCaseRequest" required: true @@ -104051,6 +108244,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + jira_issue_url: https://datadoghq-sandbox-538.atlassian.net/browse/CSMSEC-105476 + relationships: + findings: + data: + - id: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw== + project: + data: + id: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + type: projects + type: jira_issues schema: $ref: "#/components/schemas/AttachJiraIssueRequest" required: true @@ -104089,6 +108297,26 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - attributes: + assignee_id: f315bdaf-9ee7-4808-a9c1-99c15bf0f4d0 + description: A description of the Jira issue. + fields: + key1: value + key2: + - value + key3: + key4: value + priority: NOT_DEFINED + title: A title for the Jira issue. + relationships: + project: + data: + id: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + type: jira_issues schema: $ref: "#/components/schemas/CreateJiraIssueRequestArray" required: true @@ -104132,6 +108360,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + filter: "@severity:(critical OR high) @status:open team:platform" + page: + cursor: eyJhZnRlciI6IkF3QUFBWnPcm1pd0FBQUJbVlBQUKBa1pqRTVdZUzSTBNemN0YWiIsLTE3Mjk0MzYwMjFdfQ== + limit: 25 + sort: "@detection_changed_at" schema: $ref: "#/components/schemas/SecurityFindingsSearchRequest" required: true @@ -104511,6 +108749,25 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + enabled: true + name: Rule 1 + selectors: + query: (source:production_service OR env:prod) + rule_types: + - misconfiguration + - attack_path + severities: + - critical + trigger_source: security_findings + targets: + - "@john.doe@email.com" + time_aggregation: 86400 + type: notification_rules schema: $ref: "#/components/schemas/CreateNotificationRuleParameters" description: |- @@ -104619,6 +108876,27 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + enabled: true + name: Rule 1 + selectors: + query: (source:production_service OR env:prod) + rule_types: + - misconfiguration + - attack_path + severities: + - critical + trigger_source: security_findings + targets: + - "@john.doe@email.com" + time_aggregation: 86400 + version: 1 + id: aaa-bbb-ccc + type: notification_rules schema: $ref: "#/components/schemas/PatchNotificationRuleParameters" required: true @@ -105124,6 +109402,25 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + enabled: true + name: Rule 1 + selectors: + query: (source:production_service OR env:prod) + rule_types: + - misconfiguration + - attack_path + severities: + - critical + trigger_source: security_findings + targets: + - "@john.doe@email.com" + time_aggregation: 86400 + type: notification_rules schema: $ref: "#/components/schemas/CreateNotificationRuleParameters" description: |- @@ -105232,6 +109529,27 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + enabled: true + name: Rule 1 + selectors: + query: (source:production_service OR env:prod) + rule_types: + - misconfiguration + - attack_path + severities: + - critical + trigger_source: security_findings + targets: + - "@john.doe@email.com" + time_aggregation: 86400 + version: 1 + id: aaa-bbb-ccc + type: notification_rules schema: $ref: "#/components/schemas/PatchNotificationRuleParameters" required: true @@ -105475,6 +109793,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + name: my_agent_rule + policy_id: a8c8e364-6556-434d-b798-a4c23de29c0b + silent: false + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest" description: "The definition of the new agent rule" @@ -105564,6 +109894,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + policy_id: a8c8e364-6556-434d-b798-a4c23de29c0b + silent: false + id: 3dd-0uc-h1s + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest" description: "New definition of the agent rule" @@ -105621,6 +109963,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + query: security:monitoring + rule_query: type:(log_detection OR signal_correlation OR workload_security OR application_security) source:cloudtrail + severity: increase + tags: + - team:database + - source:cloudtrail + type: critical_assets schema: $ref: "#/components/schemas/SecurityMonitoringCriticalAssetCreateRequest" description: The definition of the new critical asset. @@ -105733,6 +110088,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + query: security:monitoring + rule_query: type:log_detection source:cloudtrail + severity: increase + tags: + - technique:T1110-brute-force + - source:cloudtrail + version: 1 + type: critical_assets schema: $ref: "#/components/schemas/SecurityMonitoringCriticalAssetUpdateRequest" description: New definition of the critical asset. Supports partial updates. @@ -105798,6 +110167,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + exclusion_filters: + - name: Exclude staging + query: source:staging + filtered_data_type: logs + is_enabled: true + name: Custom security filter + query: service:api + type: security_filters schema: $ref: "#/components/schemas/SecurityFilterCreateRequest" description: The definition of the new security filter. @@ -105898,6 +110280,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + exclusion_filters: [] + filtered_data_type: logs + is_enabled: true + name: Custom security filter + query: service:api + version: 1 + type: security_filters schema: $ref: "#/components/schemas/SecurityFilterUpdateRequest" description: New definition of the security filter. @@ -105983,6 +110377,23 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + data_exclusion_query: source:cloudtrail account_id:12345 + description: This rule suppresses low-severity signals in staging environments. + enabled: true + expiration_date: 1703187336000 + name: Custom suppression + rule_query: type:log_detection source:cloudtrail + start_date: 1703187336000 + suppression_query: env:staging status:low + tags: + - technique:T1110-brute-force + - source:cloudtrail + type: suppressions schema: $ref: "#/components/schemas/SecurityMonitoringSuppressionCreateRequest" description: The definition of the new suppression rule. @@ -106018,6 +110429,55 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + calculatedFields: + - expression: "@request_end_timestamp - @request_start_timestamp" + name: response_time + cases: [] + filters: + - action: require + groupSignalsBy: + - service + hasExtendedTitle: true + isEnabled: true + message: "" + name: My security monitoring rule. + options: + anomalyDetectionOptions: + bucketDuration: 300 + detectionTolerance: 5 + instantaneousBaseline: false + complianceRuleOptions: + regoRule: + policy: "package datadog\n\nimport data.datadog.output as dd_output\nimport future.keywords.contains\nimport future.keywords.if\nimport future.keywords.in\n\neval(resource) = \"skip\" if {\n # Logic that evaluates to true if the resource should be skipped\n true\n} else = \"pass\" {\n # Logic that evaluates to true if the resource is compliant\n true\n} else = \"fail\" {\n # Logic that evaluates to true if the resource is not compliant\n true\n}\n\n# This part remains unchanged for all rules\nresults contains result if {\n some resource in input.resources[input.main_resource_type]\n result := dd_output.format(resource, eval(resource))\n}" + resourceTypes: + - gcp_iam_service_account + - gcp_iam_policy + resourceType: aws_acm + decreaseCriticalityBasedOnEnv: false + detectionMethod: threshold + hardcodedEvaluatorType: log4shell + impossibleTravelOptions: + baselineUserLocations: true + newValueOptions: + instantaneousBaseline: false + learningMethod: duration + thirdPartyRuleOptions: + defaultStatus: critical + rootQueries: + - query: source:cloudtrail + queries: [] + schedulingOptions: + rrule: FREQ=HOURLY;INTERVAL=1; + start: "2025-07-14T12:00:00" + timezone: America/New_York + tags: + - env:prod + - team:security + thirdPartyCases: [] + type: api_security schema: $ref: "#/components/schemas/SecurityMonitoringRuleCreatePayload" required: true @@ -106076,6 +110536,23 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + data_exclusion_query: source:cloudtrail account_id:12345 + description: This rule suppresses low-severity signals in staging environments. + enabled: true + expiration_date: 1703187336000 + name: Custom suppression + rule_query: type:log_detection source:cloudtrail + start_date: 1703187336000 + suppression_query: env:staging status:low + tags: + - technique:T1110-brute-force + - source:cloudtrail + type: suppressions schema: $ref: "#/components/schemas/SecurityMonitoringSuppressionCreateRequest" required: true @@ -106157,6 +110634,23 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + data_exclusion_query: source:cloudtrail account_id:12345 + description: This rule suppresses low-severity signals in staging environments. + enabled: true + expiration_date: 1703187336000 + name: Custom suppression + rule_query: type:log_detection source:cloudtrail + start_date: 1703187336000 + suppression_query: env:staging status:low + tags: + - technique:T1110-brute-force + - source:cloudtrail + type: suppressions schema: $ref: "#/components/schemas/SecurityMonitoringSuppressionUpdateRequest" description: New definition of the suppression rule. Supports partial updates. @@ -106372,6 +110866,55 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + calculatedFields: + - expression: "@request_end_timestamp - @request_start_timestamp" + name: response_time + cases: [] + filters: + - action: require + groupSignalsBy: + - service + hasExtendedTitle: true + isEnabled: true + message: "" + name: My security monitoring rule. + options: + anomalyDetectionOptions: + bucketDuration: 300 + detectionTolerance: 5 + instantaneousBaseline: false + complianceRuleOptions: + regoRule: + policy: "package datadog\n\nimport data.datadog.output as dd_output\nimport future.keywords.contains\nimport future.keywords.if\nimport future.keywords.in\n\neval(resource) = \"skip\" if {\n # Logic that evaluates to true if the resource should be skipped\n true\n} else = \"pass\" {\n # Logic that evaluates to true if the resource is compliant\n true\n} else = \"fail\" {\n # Logic that evaluates to true if the resource is not compliant\n true\n}\n\n# This part remains unchanged for all rules\nresults contains result if {\n some resource in input.resources[input.main_resource_type]\n result := dd_output.format(resource, eval(resource))\n}" + resourceTypes: + - gcp_iam_service_account + - gcp_iam_policy + resourceType: aws_acm + decreaseCriticalityBasedOnEnv: false + detectionMethod: threshold + hardcodedEvaluatorType: log4shell + impossibleTravelOptions: + baselineUserLocations: true + newValueOptions: + instantaneousBaseline: false + learningMethod: duration + thirdPartyRuleOptions: + defaultStatus: critical + rootQueries: + - query: source:cloudtrail + queries: [] + schedulingOptions: + rrule: FREQ=HOURLY;INTERVAL=1; + start: "2025-07-14T12:00:00" + timezone: America/New_York + tags: + - env:prod + - team:security + thirdPartyCases: [] + type: api_security schema: $ref: "#/components/schemas/SecurityMonitoringRuleCreatePayload" required: true @@ -106410,6 +110953,16 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + ruleIds: + - def-000-u7q + - def-000-7dd + id: bulk_export + type: security_monitoring_rules_bulk_export schema: $ref: "#/components/schemas/SecurityMonitoringRuleBulkExportPayload" required: true @@ -106455,6 +111008,65 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + calculatedFields: + - expression: "@request_end_timestamp - @request_start_timestamp" + name: response_time + cases: + - condition: a > 0 + name: "" + notifications: [] + status: info + filters: [] + groupSignalsBy: + - service + hasExtendedTitle: true + isEnabled: true + message: My security monitoring rule. + name: My security monitoring rule. + options: + anomalyDetectionOptions: + bucketDuration: 300 + detectionTolerance: 5 + instantaneousBaseline: false + complianceRuleOptions: + regoRule: + policy: "package datadog\n\nimport data.datadog.output as dd_output\nimport future.keywords.contains\nimport future.keywords.if\nimport future.keywords.in\n\neval(resource) = \"skip\" if {\n # Logic that evaluates to true if the resource should be skipped\n true\n} else = \"pass\" {\n # Logic that evaluates to true if the resource is compliant\n true\n} else = \"fail\" {\n # Logic that evaluates to true if the resource is not compliant\n true\n}\n\n# This part remains unchanged for all rules\nresults contains result if {\n some resource in input.resources[input.main_resource_type]\n result := dd_output.format(resource, eval(resource))\n}" + resourceTypes: + - gcp_iam_service_account + - gcp_iam_policy + resourceType: aws_acm + decreaseCriticalityBasedOnEnv: false + detectionMethod: threshold + evaluationWindow: 900 + hardcodedEvaluatorType: log4shell + impossibleTravelOptions: + baselineUserLocations: true + keepAlive: 3600 + maxSignalDuration: 86400 + newValueOptions: + instantaneousBaseline: false + learningMethod: duration + thirdPartyRuleOptions: + defaultStatus: critical + rootQueries: + - query: source:cloudtrail + queries: + - aggregation: count + distinctFields: [] + groupByFields: [] + query: source:cloudtrail + schedulingOptions: + rrule: FREQ=HOURLY;INTERVAL=1; + start: "2025-07-14T12:00:00" + timezone: America/New_York + tags: + - env:prod + - team:security + thirdPartyCases: [] + type: log_detection schema: $ref: "#/components/schemas/SecurityMonitoringRuleConvertPayload" required: true @@ -106495,6 +111107,71 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + rule: + calculatedFields: + - expression: "@request_end_timestamp - @request_start_timestamp" + name: response_time + cases: + - condition: a > 0 + name: "" + notifications: [] + status: info + filters: + - action: require + groupSignalsBy: + - service + hasExtendedTitle: true + isEnabled: true + message: My security monitoring rule message. + name: My security monitoring rule. + options: + anomalyDetectionOptions: + bucketDuration: 300 + detectionTolerance: 5 + instantaneousBaseline: false + complianceRuleOptions: + resourceType: aws_acm + decreaseCriticalityBasedOnEnv: false + detectionMethod: threshold + evaluationWindow: 0 + hardcodedEvaluatorType: log4shell + impossibleTravelOptions: + baselineUserLocations: true + keepAlive: 0 + maxSignalDuration: 0 + newValueOptions: + instantaneousBaseline: false + learningMethod: duration + thirdPartyRuleOptions: + defaultStatus: critical + queries: + - aggregation: count + distinctFields: [] + groupByFields: + - "@userIdentity.assumed_role" + name: "" + query: source:cloudtrail + schedulingOptions: + rrule: FREQ=HOURLY;INTERVAL=1; + start: "2025-07-14T12:00:00" + timezone: America/New_York + tags: + - env:prod + - team:security + thirdPartyCases: [] + type: log_detection + ruleQueryPayloads: + - expectedResult: true + index: 0 + payload: + ddsource: nginx + ddtags: env:staging,version:5.1 + hostname: i-012345678 + message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World + service: payment schema: $ref: "#/components/schemas/SecurityMonitoringRuleTestRequest" required: true @@ -106534,6 +111211,68 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + calculatedFields: + - expression: "@request_end_timestamp - @request_start_timestamp" + name: response_time + cases: + - condition: a > 0 + name: "" + notifications: [] + status: info + filters: + - action: require + groupSignalsBy: + - service + hasExtendedTitle: true + isEnabled: true + message: My security monitoring rule + name: My security monitoring rule. + options: + anomalyDetectionOptions: + bucketDuration: 300 + detectionTolerance: 5 + instantaneousBaseline: false + complianceRuleOptions: + regoRule: + policy: "package datadog\n\nimport data.datadog.output as dd_output\nimport future.keywords.contains\nimport future.keywords.if\nimport future.keywords.in\n\neval(resource) = \"skip\" if {\n # Logic that evaluates to true if the resource should be skipped\n true\n} else = \"pass\" {\n # Logic that evaluates to true if the resource is compliant\n true\n} else = \"fail\" {\n # Logic that evaluates to true if the resource is not compliant\n true\n}\n\n# This part remains unchanged for all rules\nresults contains result if {\n some resource in input.resources[input.main_resource_type]\n result := dd_output.format(resource, eval(resource))\n}" + resourceTypes: + - gcp_iam_service_account + - gcp_iam_policy + resourceType: aws_acm + decreaseCriticalityBasedOnEnv: false + detectionMethod: threshold + evaluationWindow: 1800 + hardcodedEvaluatorType: log4shell + impossibleTravelOptions: + baselineUserLocations: true + keepAlive: 1800 + maxSignalDuration: 1800 + newValueOptions: + instantaneousBaseline: false + learningMethod: duration + thirdPartyRuleOptions: + defaultStatus: critical + rootQueries: + - query: source:cloudtrail + queries: + - aggregation: count + distinctFields: [] + groupByFields: + - "@userIdentity.assumed_role" + name: "" + query: source:cloudtrail + schedulingOptions: + rrule: FREQ=HOURLY;INTERVAL=1; + start: "2025-07-14T12:00:00" + timezone: America/New_York + tags: + - env:prod + - team:security + thirdPartyCases: [] + type: log_detection schema: $ref: "#/components/schemas/SecurityMonitoringRuleValidatePayload" required: true @@ -106624,6 +111363,61 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + calculatedFields: + - expression: "@request_end_timestamp - @request_start_timestamp" + name: response_time + cases: + - actions: + - options: + duration: 0 + flaggedIPType: FLAGGED + type: block_ip + customStatus: critical + status: critical + filters: + - action: require + groupSignalsBy: + - service + hasExtendedTitle: true + options: + anomalyDetectionOptions: + bucketDuration: 300 + detectionTolerance: 5 + instantaneousBaseline: false + complianceRuleOptions: + regoRule: + policy: "package datadog\n\nimport data.datadog.output as dd_output\nimport future.keywords.contains\nimport future.keywords.if\nimport future.keywords.in\n\neval(resource) = \"skip\" if {\n # Logic that evaluates to true if the resource should be skipped\n true\n} else = \"pass\" {\n # Logic that evaluates to true if the resource is compliant\n true\n} else = \"fail\" {\n # Logic that evaluates to true if the resource is not compliant\n true\n}\n\n# This part remains unchanged for all rules\nresults contains result if {\n some resource in input.resources[input.main_resource_type]\n result := dd_output.format(resource, eval(resource))\n}" + resourceTypes: + - gcp_iam_service_account + - gcp_iam_policy + resourceType: aws_acm + decreaseCriticalityBasedOnEnv: false + detectionMethod: threshold + hardcodedEvaluatorType: log4shell + impossibleTravelOptions: + baselineUserLocations: true + newValueOptions: + instantaneousBaseline: false + learningMethod: duration + thirdPartyRuleOptions: + defaultStatus: critical + rootQueries: + - query: source:cloudtrail + queries: + - aggregation: count + customQueryExtension: a > 3 + dataSource: logs + hasOptionalGroupByFields: false + query: a > 3 + schedulingOptions: + rrule: FREQ=HOURLY;INTERVAL=1; + start: "2025-07-14T12:00:00" + timezone: America/New_York + thirdPartyCases: [] + version: 1 schema: $ref: "#/components/schemas/SecurityMonitoringRuleUpdatePayload" required: true @@ -106705,6 +111499,58 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + rule: + calculatedFields: + - expression: "@request_end_timestamp - @request_start_timestamp" + name: response_time + cases: [] + filters: + - action: require + groupSignalsBy: + - service + hasExtendedTitle: true + isEnabled: true + message: "" + name: My security monitoring rule. + options: + anomalyDetectionOptions: + bucketDuration: 300 + detectionTolerance: 5 + instantaneousBaseline: false + complianceRuleOptions: + resourceType: aws_acm + decreaseCriticalityBasedOnEnv: false + detectionMethod: threshold + hardcodedEvaluatorType: log4shell + impossibleTravelOptions: + baselineUserLocations: true + newValueOptions: + instantaneousBaseline: false + learningMethod: duration + thirdPartyRuleOptions: + defaultStatus: critical + queries: [] + schedulingOptions: + rrule: FREQ=HOURLY;INTERVAL=1; + start: "2025-07-14T12:00:00" + timezone: America/New_York + tags: + - env:prod + - team:security + thirdPartyCases: [] + type: log_detection + ruleQueryPayloads: + - expectedResult: true + index: 0 + payload: + ddsource: nginx + ddtags: env:staging,version:5.1 + hostname: i-012345678 + message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World + service: payment schema: $ref: "#/components/schemas/SecurityMonitoringRuleTestRequest" required: true @@ -106820,6 +111666,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - attributes: + assignee: 773b045d-ccf8-4808-bd3b-955ef6a8c940 + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: signal schema: $ref: "#/components/schemas/SecurityMonitoringSignalsBulkAssigneeUpdateRequest" description: Attributes describing the signal assignee updates. @@ -106861,6 +111715,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - attributes: + archive_reason: none + state: open + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: signal schema: $ref: "#/components/schemas/SecurityMonitoringSignalsBulkStateUpdateRequest" description: Attributes describing the signal state updates. @@ -106903,6 +111766,17 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + filter: + from: "2019-01-02T09:42:36.320Z" + query: security:attack status:high + to: "2019-01-03T09:42:36.320Z" + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + limit: 25 + sort: timestamp schema: $ref: "#/components/schemas/SecurityMonitoringSignalListRequest" required: false @@ -106976,6 +111850,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + assignee: + icon: /path/to/matching/gravatar/icon + uuid: 773b045d-ccf8-4808-bd3b-955ef6a8c940 schema: $ref: "#/components/schemas/SecurityMonitoringSignalAssigneeUpdateRequest" description: Attributes describing the signal update. @@ -107016,6 +111898,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + incident_ids: + - 2066 schema: $ref: "#/components/schemas/SecurityMonitoringSignalIncidentsUpdateRequest" description: Attributes describing the signal update. @@ -107104,6 +111993,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + archive_reason: none + state: open + type: signal_metadata schema: $ref: "#/components/schemas/SecurityMonitoringSignalStateUpdateRequest" description: Attributes describing the signal update. @@ -107220,6 +112117,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + relationships: + groups: + data: + - id: a796feff-a0cc-4a9f-8c61-16c4d5e44964 + type: sensitive_data_scanner_group + type: sensitive_data_scanner_configuration + meta: + version: 0 schema: $ref: "#/components/schemas/SensitiveDataScannerConfigRequest" required: true @@ -107264,6 +112173,26 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + filter: + query: "*" + is_enabled: false + product_list: + - logs + samplings: + - product: logs + rate: 100.0 + relationships: + configuration: + data: + type: sensitive_data_scanner_configuration + type: sensitive_data_scanner_group + meta: + version: 0 schema: $ref: "#/components/schemas/SensitiveDataScannerGroupCreateRequest" required: true @@ -107305,6 +112234,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + meta: + version: 0 schema: $ref: "#/components/schemas/SensitiveDataScannerGroupDeleteRequest" required: true @@ -107351,6 +112285,26 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + filter: + query: "*" + is_enabled: false + product_list: + - logs + samplings: + - product: logs + rate: 100.0 + relationships: + configuration: + data: + type: sensitive_data_scanner_configuration + type: sensitive_data_scanner_group + meta: + version: 0 schema: $ref: "#/components/schemas/SensitiveDataScannerGroupUpdateRequest" required: true @@ -107397,6 +112351,46 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + excluded_namespaces: + - admin.name + included_keyword_configuration: + character_count: 30 + keywords: + - email + - address + - login + is_enabled: true + namespaces: + - admin + suppressions: + ends_with: + - "@example.com" + - another.example.com + exact_match: + - admin@example.com + - user@example.com + starts_with: + - admin + - user + tags: + - sensitive_data:true + text_replacement: + type: none + relationships: + group: + data: + type: sensitive_data_scanner_group + standard_pattern: + data: + type: sensitive_data_scanner_standard_pattern + type: sensitive_data_scanner_rule + meta: + version: 0 schema: $ref: "#/components/schemas/SensitiveDataScannerRuleCreateRequest" required: true @@ -107438,6 +112432,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + meta: + version: 0 schema: $ref: "#/components/schemas/SensitiveDataScannerRuleDeleteRequest" required: true @@ -107484,6 +112483,46 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + excluded_namespaces: + - admin.name + included_keyword_configuration: + character_count: 30 + keywords: + - email + - address + - login + is_enabled: true + namespaces: + - admin + suppressions: + ends_with: + - "@example.com" + - another.example.com + exact_match: + - admin@example.com + - user@example.com + starts_with: + - admin + - user + tags: + - sensitive_data:true + text_replacement: + type: none + relationships: + group: + data: + type: sensitive_data_scanner_group + standard_pattern: + data: + type: sensitive_data_scanner_standard_pattern + type: sensitive_data_scanner_rule + meta: + version: 0 schema: $ref: "#/components/schemas/SensitiveDataScannerRuleUpdateRequest" required: true @@ -107577,6 +112616,17 @@ paths: content: application/json: examples: + default: + value: + series: + - metric: system.load.1 + points: + - timestamp: 1636629071 + value: 1.1 + resources: + - name: dummyhost + type: host + type: 0 dynamic-points: description: Post time-series data that can be graphed on Datadog’s dashboards. externalValue: examples/metrics/dynamic-points.json.sh @@ -107632,6 +112682,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + email: jane.doe@example.com + service_account: true + relationships: + roles: + data: + - id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + type: users schema: $ref: "#/components/schemas/ServiceAccountCreateRequest" required: true @@ -107718,6 +112780,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Application Key for managing dashboards + scopes: + - dashboards_read + - dashboards_write + - dashboards_public_share + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyCreateRequest" required: true @@ -107824,6 +112897,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Application Key for managing dashboards + scopes: + - dashboards_read + - dashboards_write + - dashboards_public_share + id: 00112233-4455-6677-8899-aabbccddeeff + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyUpdateRequest" required: true @@ -107911,6 +112996,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: an example service name + relationships: + created_by: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users + last_modified_by: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users + type: services schema: $ref: "#/components/schemas/IncidentServiceCreateRequest" description: Incident Service Payload. @@ -107988,6 +113089,49 @@ paths: requestBody: content: application/json: + examples: + default: + value: + application: my-app + ci-pipeline-fingerprints: + - j88xdEy0J5lc + - eZ7LMljCk8vo + contacts: + - contact: https://teams.microsoft.com/myteam + name: My team channel + type: slack + dd-service: my-service + description: My service description + extensions: + myorg/extension: extensionValue + integrations: + opsgenie: + region: US + service-url: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000 + pagerduty: + service-url: https://my-org.pagerduty.com/service-directory/PMyService + languages: + - dotnet + - go + - java + - js + - php + - python + - ruby + - c++ + lifecycle: sandbox + links: + - name: Runbook + provider: Github + type: runbook + url: https://my-runbook + schema-version: v2.2 + tags: + - my:tag + - service:tag + team: my-team + tier: High + type: web schema: $ref: "#/components/schemas/ServiceDefinitionsCreateRequest" description: Service Definition YAML/JSON. @@ -108168,6 +113312,23 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: an example service name + id: 00000000-0000-0000-0000-000000000000 + relationships: + created_by: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users + last_modified_by: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users + type: services schema: $ref: "#/components/schemas/IncidentServiceUpdateRequest" description: Incident Service Payload. @@ -108251,6 +113412,17 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + filter: + from: "2019-01-02T09:42:36.320Z" + query: security:attack status:high + to: "2019-01-03T09:42:36.320Z" + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + limit: 25 + sort: timestamp schema: $ref: "#/components/schemas/SecurityMonitoringSignalListRequest" required: false @@ -108368,6 +113540,36 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + fromRule: + from: 1729843470000 + id: abc-def-ghi + index: cloud_siem + notifications: + - "@sns-cloudtrail-results" + to: 1729847070000 + jobDefinition: + calculatedFields: + - expression: "@request_end_timestamp - @request_start_timestamp" + name: response_time + from: 1729843470000 + groupSignalsBy: + - service + index: cloud_siem + message: A large number of failed login attempts. + name: Excessive number of failed attempts. + options: + detectionMethod: threshold + queries: + - hasOptionalGroupByFields: false + query: a > 3 + thirdPartyCases: [] + to: 1729847070000 + type: historicalDetectionsJobCreate schema: $ref: "#/components/schemas/RunThreatHuntingJobRequest" required: true @@ -108411,6 +113613,18 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + jobResultIds: + - "" + notifications: + - "" + signalMessage: A large number of failed login attempts. + signalSeverity: critical + type: historicalDetectionsJobResultSignalConversion schema: $ref: "#/components/schemas/ConvertJobResultsToSignalsRequest" required: true @@ -108588,6 +113802,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + from_ts: 1690901870 + interval: weekly + query: slo_type:metric + timezone: America/New_York + to_ts: 1706803070 schema: $ref: "#/components/schemas/SloReportCreateRequest" description: Create SLO report job request body. @@ -108896,6 +114120,32 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + compute: + - aggregation: pc90 + interval: 5m + metric: "@duration" + type: timeseries + filter: + from: now-15m + query: service:web* AND @http.status_code:[200 TO 299] + to: now + group_by: + - facet: host + histogram: + interval: 10 + max: 100 + min: 50 + sort: + aggregation: count + order: asc + options: + timezone: GMT + type: aggregate_request schema: $ref: "#/components/schemas/SpansAggregateRequest" required: true @@ -109022,6 +114272,22 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + filter: + from: now-15m + query: service:web* AND @http.status_code:[200 TO 299] + to: now + options: + timezone: GMT + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + limit: 25 + sort: timestamp + type: search_request schema: $ref: "#/components/schemas/SpansListRequest" required: true @@ -109059,6 +114325,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: scarequests schema: $ref: "#/components/schemas/ScaRequest" required: true @@ -109082,6 +114353,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: resolve-vulnerable-symbols-request schema: $ref: "#/components/schemas/ResolveVulnerableSymbolsRequest" required: true @@ -109195,6 +114471,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + rules: + - created_at: "2026-01-09T13:00:57.473141Z" + created_by: foobarbaz + last_revision: + id: revision-123 + name: my-rule + type: custom_ruleset schema: $ref: "#/components/schemas/CustomRulesetRequest" required: true @@ -109243,6 +114531,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: custom_rule schema: $ref: "#/components/schemas/CustomRuleRequest" required: true @@ -109463,6 +114756,36 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + arguments: + - description: Maximum call depth to analyze + name: max_depth + category: SECURITY + code: "def rule(node): return node.type == 'call'" + creation_message: Initial revision + cve: CVE-2024-1234 + cwe: CWE-79 + description: Detects insecure coding patterns that may lead to vulnerabilities + documentation_url: https://docs.example.com/rules/my-rule + is_published: false + is_testing: false + language: PYTHON + severity: ERROR + short_description: Rule to detect insecure patterns + should_use_ai_fix: false + tags: + - security + - custom + tests: + - annotation_count: 1 + code: "result = insecure_function()" + filename: test.yaml + tree_sitter_query: "(call_expression) @call" + type: custom_rule_revision schema: $ref: "#/components/schemas/CustomRuleRevisionRequest" required: true @@ -109513,6 +114836,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: revert_custom_rule_revision_request schema: $ref: "#/components/schemas/RevertCustomRuleRevisionRequest" required: true @@ -109598,6 +114926,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + type: get_multiple_rulesets_request schema: $ref: "#/components/schemas/GetMultipleRulesetsRequest" required: true @@ -109696,6 +115029,38 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + company_logo: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAIKMMMM + components: + - name: API + position: 0 + type: component + - components: + - name: Login + position: 0 + type: component + - name: Settings + position: 1 + type: component + name: Web App + position: 1 + type: group + - name: Webhooks + position: 2 + type: component + domain_prefix: status-page-us1 + email_header_image: data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF + enabled: true + favicon: data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA + name: Status Page US1 + subscriptions_enabled: true + type: public + visualization_type: bars_and_uptime_percentage + type: status_pages schema: $ref: "#/components/schemas/CreateStatusPageRequest" required: true @@ -109925,6 +115290,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + company_logo: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAIKMMMM + domain_prefix: status-page-us1-east + email_header_image: data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF + enabled: false + favicon: data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA + name: Status Page US1 East + subscriptions_enabled: false + type: internal + visualization_type: bars_only + id: 1234abcd-12ab-34cd-56ef-123456abcdef + type: status_pages schema: $ref: "#/components/schemas/PatchStatusPageRequest" required: true @@ -110006,6 +115387,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Metrics Intake + position: 0 + type: component + relationships: + group: + data: + type: components schema: $ref: "#/components/schemas/CreateComponentRequest" required: true @@ -110139,6 +115532,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: Metrics Intake Service + position: 4 + id: 1234abcd-12ab-34cd-56ef-123456abcdef + type: components schema: $ref: "#/components/schemas/PatchComponentRequest" required: true @@ -110189,6 +115591,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: degraded + description: Our API is experiencing elevated latency. We are investigating the issue. + status: investigating + title: Elevated API Latency + type: degradations schema: $ref: "#/components/schemas/CreateDegradationRequest" required: true @@ -110328,6 +115742,19 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: operational + description: We've deployed a fix and latency has returned to normal. This issue has been resolved. + status: resolved + title: Elevated API Latency in US1 + id: 1234abcd-12ab-34cd-56ef-123456abcdef + type: degradations schema: $ref: "#/components/schemas/PatchDegradationRequest" required: true @@ -110377,6 +115804,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + completed_date: "2026-02-18T19:51:13.332360075Z" + completed_description: We have completed maintenance on the API to improve performance. + components_affected: + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: operational + in_progress_description: We are currently performing maintenance on the API to improve performance. + scheduled_description: We will be performing maintenance on the API to improve performance. + start_date: "2026-02-18T19:21:13.332360075Z" + title: API Maintenance + type: maintenances schema: $ref: "#/components/schemas/CreateMaintenanceRequest" required: true @@ -110476,6 +115918,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + completed_date: "2026-02-18T20:01:13.332360075Z" + in_progress_description: We are currently performing maintenance on the API to improve performance for 40 minutes. + scheduled_description: We will be performing maintenance on the API to improve performance for 40 minutes. + start_date: "2026-02-18T19:21:13.332360075Z" + title: API Maintenance + id: 1234abcd-12ab-34cd-56ef-123456abcdef + type: maintenances schema: $ref: "#/components/schemas/PatchMaintenanceRequest" required: true @@ -110659,6 +116113,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + on_demand_concurrency_cap: 20 schema: $ref: "#/components/schemas/OnDemandConcurrencyCapAttributes" description: . @@ -110686,6 +116144,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + message: Notification message + monitor_id: 12345678 + name: Example suite name + public_id: 123-abc-456 + tags: + - env:production + tests: + - alerting_criticality: critical + public_id: "" + type: suite + type: suites schema: $ref: "#/components/schemas/SuiteCreateEditRequest" required: true @@ -110723,6 +116197,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + public_ids: + - "" + type: delete_suites_request schema: $ref: "#/components/schemas/DeletedSuitesRequestDeleteRequest" required: true @@ -110870,6 +116352,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + message: Notification message + monitor_id: 12345678 + name: Example suite name + public_id: 123-abc-456 + tags: + - env:production + tests: + - alerting_criticality: critical + public_id: "" + type: suite + type: suites schema: $ref: "#/components/schemas/SuiteCreateEditRequest" description: New suite details to be saved. @@ -110923,6 +116421,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + json_patch: + - op: add + path: /name + type: suites_json_patch schema: $ref: "#/components/schemas/SuiteJsonPatchRequest" description: JSON Patch document with operations to apply. @@ -110962,6 +116469,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + public_ids: + - abc-def-123 + - xyz-uvw-456 + type: delete_tests_request schema: $ref: "#/components/schemas/DeletedTestsRequestDeleteRequest" required: true @@ -111048,6 +116564,49 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + config: + assertions: + - operator: lessThan + property: avg + target: 500 + type: latency + request: + e2e_queries: 50 + host: "" + max_ttl: 30 + port: 443 + tcp_method: prefer_sack + traceroute_queries: 3 + locations: + - aws:us-east-1 + - agent:my-agent-name + message: Network Path test notification + monitor_id: 12345678 + name: Example Network Path test + options: + monitor_options: + notification_preset_name: show_all + scheduling: + timeframes: + - day: 1 + from: 07:00 + to: "16:00" + - day: 3 + from: 07:00 + to: "16:00" + timezone: America/New_York + public_id: abc-def-123 + status: live + subtype: tcp + tags: + - env:production + type: network + type: network schema: $ref: "#/components/schemas/SyntheticsNetworkTestEditRequest" required: true @@ -111134,6 +116693,49 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + config: + assertions: + - operator: lessThan + property: avg + target: 500 + type: latency + request: + e2e_queries: 50 + host: "" + max_ttl: 30 + port: 443 + tcp_method: prefer_sack + traceroute_queries: 3 + locations: + - aws:us-east-1 + - agent:my-agent-name + message: Network Path test notification + monitor_id: 12345678 + name: Example Network Path test + options: + monitor_options: + notification_preset_name: show_all + scheduling: + timeframes: + - day: 1 + from: 07:00 + to: "16:00" + - day: 3 + from: 07:00 + to: "16:00" + timezone: America/New_York + public_id: abc-def-123 + status: live + subtype: tcp + tags: + - env:production + type: network + type: network schema: $ref: "#/components/schemas/SyntheticsNetworkTestEditRequest" description: New Network Path test details to be saved. @@ -111189,6 +116791,10 @@ paths: requestBody: content: application/json: + examples: + default: + value: + bucketKey: api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json schema: $ref: "#/components/schemas/SyntheticsTestFileDownloadRequest" required: true @@ -111248,6 +116854,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + bucketKeyPrefix: api-upload-file + parts: + - md5: 1B2M2Y8AsgTpgAmY7PhCfg== + partNumber: 1 schema: $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsRequest" required: true @@ -111308,6 +116921,11 @@ paths: requestBody: content: application/json: + examples: + default: + value: + key: org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json + uploadId: upload-id-abc123 schema: $ref: "#/components/schemas/SyntheticsTestFileAbortMultipartUploadRequest" required: true @@ -111364,6 +116982,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + key: org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json + parts: + - ETag: '"d41d8cd98f00b204e9800998ecf8427e"' + PartNumber: 1 + uploadId: upload-id-abc123 schema: $ref: "#/components/schemas/SyntheticsTestFileCompleteMultipartUploadRequest" required: true @@ -111581,6 +117207,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + json_patch: + - op: add + path: /name + type: global_variables_json_patch schema: $ref: "#/components/schemas/GlobalVariableJsonPatchRequest" description: JSON Patch document with operations to apply. @@ -111633,6 +117268,24 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + rules: + - enabled: true + name: Add Cost Center Tag + query: + addition: + key: cost_center + value: engineering + case_insensitivity: false + if_tag_exists: do_not_apply + query: account_id:"123456789" AND service:"web-api" + id: New Ruleset + type: create_ruleset schema: $ref: "#/components/schemas/CreateRulesetRequest" required: true @@ -111660,6 +117313,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - id: 55ef2385-9ae1-4410-90c4-5ac1b60fec10 + type: ruleset + - id: a7b8c9d0-1234-5678-9abc-def012345678 + type: ruleset + - id: f1e2d3c4-b5a6-9780-1234-567890abcdef + type: ruleset schema: $ref: "#/components/schemas/ReorderRulesetResourceArray" required: true @@ -111683,6 +117346,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + Query: example:query AND test:true + type: validate_query schema: $ref: "#/components/schemas/RulesValidateQueryRequest" required: true @@ -111767,6 +117437,49 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + last_version: 1 + name: Updated Ruleset + rules: + - enabled: true + name: Add Cost Center Tag + query: + addition: + key: cost_center + value: engineering + case_insensitivity: false + if_tag_exists: do_not_apply + query: account_id:"123456789" AND service:"web-api" + - enabled: true + mapping: + destination_key: team_owner + if_tag_exists: do_not_apply + source_keys: + - account_name + - account_id + name: Account Name Mapping + query: + - enabled: true + name: New table rule with new UI + query: + reference_table: + case_insensitivity: true + field_pairs: + - input_column: status_type + output_key: status + - input_column: status_description + output_key: dess + if_tag_exists: append + source_keys: + - http_status + - status_description + table_name: http_status_codes + type: update_ruleset schema: $ref: "#/components/schemas/UpdateRulesetRequest" required: true @@ -111867,6 +117580,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + avatar: 🥑 + handle: example-team + name: Example Team + relationships: + users: + data: [] + type: team schema: $ref: "#/components/schemas/TeamCreateRequest" required: true @@ -111954,6 +117679,20 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + relationships: + parent_team: + data: + id: 692e8073-12c4-4c71-8408-5090bd44c9c8 + type: team + sub_team: + data: + id: 692e8073-12c4-4c71-8408-5090bd44c9c8 + type: team + type: team_hierarchy_links schema: $ref: "#/components/schemas/TeamHierarchyLinkCreateRequest" required: true @@ -112072,6 +117811,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - id: 12345678-1234-5678-9abc-123456789012 + type: team_connection schema: $ref: "#/components/schemas/TeamConnectionDeleteRequest" required: true @@ -112183,6 +117928,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - attributes: + managed_by: github_sync + source: github + relationships: + connected_team: + data: + id: "@GitHubOrg/team-handle" + team: + data: + id: 87654321-4321-8765-dcba-210987654321 + type: team_connection schema: $ref: "#/components/schemas/TeamConnectionCreateRequest" required: true @@ -112270,6 +118030,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + source: github + type: link + type: team_sync_bulk schema: $ref: "#/components/schemas/TeamSyncRequest" required: true @@ -112383,6 +118151,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + type: member_teams schema: $ref: "#/components/schemas/AddMemberTeamRequest" required: true @@ -112557,6 +118331,21 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + avatar: 🥑 + handle: example-team + name: Example Team + relationships: + team_links: + data: + - id: f9bb8444-af7f-11ec-ac2c-da7ad0900001 + links: + related: /api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links + type: team schema: $ref: "#/components/schemas/TeamUpdateRequest" required: true @@ -112655,6 +118444,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + label: Link label + position: 0 + url: https://example.com + type: team_links schema: $ref: "#/components/schemas/TeamLinkCreateRequest" required: true @@ -112800,6 +118598,14 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + label: Link label + url: https://example.com + type: team_links schema: $ref: "#/components/schemas/TeamLinkCreateRequest" required: true @@ -112907,6 +118713,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + role: admin + relationships: + team: + data: + id: d7e15d9d-d346-43da-81d8-3d9e71d9a5e9 + type: team + user: + data: + id: b8626d7e-cedd-11eb-abf5-da7ad0900001 + type: users + type: team_memberships schema: $ref: "#/components/schemas/UserTeamRequest" required: true @@ -113013,6 +118835,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + role: admin + type: team_memberships schema: $ref: "#/components/schemas/UserTeamUpdateRequest" required: true @@ -113103,6 +118932,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + email: + enabled: true + slack: + channel: aaa-omg-ops + workspace: Datadog + type: team_notification_rules schema: $ref: "#/components/schemas/TeamNotificationRuleRequest" required: true @@ -113244,6 +119084,18 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + pagerduty: + service_name: Datadog-prod + slack: + channel: aaa-governance-ops + workspace: Datadog + id: b8626d7e-cedd-11eb-abf5-da7ad0900001 + type: team_notification_rules schema: $ref: "#/components/schemas/TeamNotificationRuleRequest" required: true @@ -113336,6 +119188,13 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + value: admins + type: team_permission_settings schema: $ref: "#/components/schemas/TeamPermissionSettingUpdateRequest" required: true @@ -113418,6 +119277,22 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: team name + relationships: + created_by: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users + last_modified_by: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users + type: teams schema: $ref: "#/components/schemas/IncidentTeamCreateRequest" description: Incident Team Payload. @@ -113538,6 +119413,23 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + name: team name + id: 00000000-7ea3-0000-0001-000000000000 + relationships: + created_by: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users + last_modified_by: + data: + id: 00000000-0000-0000-2345-000000000000 + type: users + type: teams schema: $ref: "#/components/schemas/IncidentTeamUpdateRequest" description: Incident Team Payload. @@ -113582,6 +119474,15 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + tests: + - id: 4eb1887a8adb1847 + new_state: active + type: update_flaky_test_state_request schema: $ref: "#/components/schemas/UpdateFlakyTestsRequest" required: true @@ -113633,6 +119534,19 @@ paths: requestBody: content: "application/json": + examples: + default: + value: + data: + attributes: + filter: + query: flaky_test_state:active @git.repository.id_v2:"github.com/datadog/shopist" + include_history: true + page: + cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + limit: 25 + sort: failure_rate + type: search_flaky_tests_request schema: $ref: "#/components/schemas/FlakyTestsSearchRequest" required: false @@ -114371,6 +120285,16 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + - relationships: + user: + data: + id: 6cf192b6-d1d9-11ec-ad3d-da7ad0900002 + type: users + type: user_invitations schema: $ref: "#/components/schemas/UserInvitationsRequest" required: true @@ -114541,6 +120465,17 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + email: jane.doe@example.com + relationships: + roles: + data: + - id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + type: users schema: $ref: "#/components/schemas/UserCreateRequest" required: true @@ -114666,6 +120601,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-feed-0000-000000000000 + type: users schema: $ref: "#/components/schemas/UserUpdateRequest" required: true @@ -114943,6 +120884,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + definition: + title: My Widget + type: bar_chart + type: widgets schema: $ref: "#/components/schemas/CreateOrUpdateWidgetRequest" description: Widget request body. @@ -115113,6 +121063,15 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + definition: + title: My Widget + type: bar_chart + type: widgets schema: $ref: "#/components/schemas/CreateOrUpdateWidgetRequest" description: Widget request body. @@ -115165,6 +121124,67 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: A sample workflow. + name: Example Workflow + published: true + spec: + annotations: + - display: + bounds: + height: 150 + width: 300 + x: -375 + y: -0.5 + id: 99999999-9999-9999-9999-999999999999 + markdownTextAnnotation: + text: Example annotation. + connectionEnvs: + - connections: + - connectionId: 11111111-1111-1111-1111-111111111111 + label: INTEGRATION_DATADOG + env: default + handle: my-handle + inputSchema: + parameters: + - defaultValue: default + name: input + type: STRING + outputSchema: + parameters: + - name: output + type: ARRAY_OBJECT + value: "{{ Steps.Step1 }}" + steps: + - actionId: com.datadoghq.dd.monitor.listMonitors + connectionLabel: INTEGRATION_DATADOG + name: Step1 + outboundEdges: + - branchName: main + nextStepName: Step2 + parameters: + - name: tags + value: service:monitoring + - actionId: com.datadoghq.core.noop + name: Step2 + triggers: + - monitorTrigger: + rateLimit: + count: 1 + interval: 3600s + startStepNames: + - Step1 + - githubWebhookTrigger: {} + startStepNames: + - Step1 + tags: + - team:infra + - service:monitoring + type: workflows schema: $ref: "#/components/schemas/CreateWorkflowRequest" required: true @@ -115285,6 +121305,68 @@ paths: requestBody: content: application/json: + examples: + default: + value: + data: + attributes: + description: A sample workflow. + name: Example Workflow + published: true + spec: + annotations: + - display: + bounds: + height: 150 + width: 300 + x: -375 + y: -0.5 + id: 99999999-9999-9999-9999-999999999999 + markdownTextAnnotation: + text: Example annotation. + connectionEnvs: + - connections: + - connectionId: 11111111-1111-1111-1111-111111111111 + label: INTEGRATION_DATADOG + env: default + handle: my-handle + inputSchema: + parameters: + - defaultValue: default + name: input + type: STRING + outputSchema: + parameters: + - name: output + type: ARRAY_OBJECT + value: "{{ Steps.Step1 }}" + steps: + - actionId: com.datadoghq.dd.monitor.listMonitors + connectionLabel: INTEGRATION_DATADOG + name: Step1 + outboundEdges: + - branchName: main + nextStepName: Step2 + parameters: + - name: tags + value: service:monitoring + - actionId: com.datadoghq.core.noop + name: Step2 + triggers: + - monitorTrigger: + rateLimit: + count: 1 + interval: 3600s + startStepNames: + - Step1 + - githubWebhookTrigger: {} + startStepNames: + - Step1 + tags: + - team:infra + - service:monitoring + id: 22222222-2222-2222-2222-222222222222 + type: workflows schema: $ref: "#/components/schemas/UpdateWorkflowRequest" required: true @@ -115367,6 +121449,12 @@ paths: requestBody: content: application/json: + examples: + default: + value: + meta: + payload: + input: value schema: $ref: "#/components/schemas/WorkflowInstanceCreateRequest" required: true diff --git a/examples/v2/oci-integration/CreateTenancyConfig.py b/examples/v2/oci-integration/CreateTenancyConfig.py index a472d2d5b9..449f906499 100644 --- a/examples/v2/oci-integration/CreateTenancyConfig.py +++ b/examples/v2/oci-integration/CreateTenancyConfig.py @@ -41,7 +41,7 @@ enabled=True, enabled_services=[ "service_1", - "service_1", + "service_2", ], ), metrics_config=CreateTenancyConfigDataAttributesMetricsConfig( @@ -52,7 +52,7 @@ enabled=True, excluded_services=[ "service_1", - "service_1", + "service_2", ], ), regions_config=CreateTenancyConfigDataAttributesRegionsConfig( diff --git a/examples/v2/oci-integration/UpdateTenancyConfig.py b/examples/v2/oci-integration/UpdateTenancyConfig.py index 927f97f4ba..3eda9889da 100644 --- a/examples/v2/oci-integration/UpdateTenancyConfig.py +++ b/examples/v2/oci-integration/UpdateTenancyConfig.py @@ -38,7 +38,7 @@ enabled=True, enabled_services=[ "service_1", - "service_1", + "service_2", ], ), metrics_config=UpdateTenancyConfigDataAttributesMetricsConfig( @@ -49,7 +49,7 @@ enabled=True, excluded_services=[ "service_1", - "service_1", + "service_2", ], ), regions_config=UpdateTenancyConfigDataAttributesRegionsConfig( diff --git a/examples/v2/synthetics/DeleteSyntheticsTests.py b/examples/v2/synthetics/DeleteSyntheticsTests.py index 6e77e0dd48..3508916b18 100644 --- a/examples/v2/synthetics/DeleteSyntheticsTests.py +++ b/examples/v2/synthetics/DeleteSyntheticsTests.py @@ -13,7 +13,7 @@ data=DeletedTestsRequestDelete( attributes=DeletedTestsRequestDeleteAttributes( public_ids=[ - "", + "abc-def-123", ], ), type=DeletedTestsRequestType.DELETE_TESTS_REQUEST, diff --git a/tests/v2/features/oci_integration.feature b/tests/v2/features/oci_integration.feature index 0da91f9a06..076654ddfb 100644 --- a/tests/v2/features/oci_integration.feature +++ b/tests/v2/features/oci_integration.feature @@ -11,7 +11,7 @@ Feature: OCI Integration Scenario: Create tenancy config returns "Created" response Given operation "CreateTenancyConfig" enabled And new "CreateTenancyConfig" request - And body with value {"data": {"attributes": {"auth_credentials": {"fingerprint": "", "private_key": "----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCdvSMmlfLyeD4M\nQsA3WlrWBqKdWa5eVV3/uODyqT3wWMEMIJHcG3/quNs8nh9xrK1/JkQT2qoKEHqR\nC5k59jN6Vp8em8ARJthMgam9K37ELt+IQ/G8ySTSuqZG8T4cHp/cs3fAclNqttOl\nYnGr4RbVAgMBAAECggEAGZNLGbyCUbIRTW6Kh4d8ZVC+eZtJMqGmGJ3KfVaW8Pjn\nQGWfSuJCEe2o2Y8G3phlidFauICnZ44enXA17Rhi+I/whnr7FIyQk2bR7rv+1Uhc\nmOJygWX5eFFMsledgVAdIAl9Luk2nykx7Un3g6rtbl/Vs+5k4m7ITLFMpCHzsJLU\nnm8kBzDOqY2JUkMd08nL88KL6QywWtal05UESzQpNFXd0e5kxYfexeMCsLsWP0mc\nquMLRbn7NuBjCbe9VU2kmIvcfDDaWjurT7d5m1OXx1cc8p6P4PFZTVyCjdhiWOr3\nLQXZ4/vdZNR3zgEHypRoM6D9Yq99LWUOUEMrdiSLQQKBgQDQkh7C1OtAXnpy7F6R\nW+/I3zBHici2p7A57UT7VECQ1IVGg37/uus83DkuOtdZ33JmHLAVrwLFJvUlbyjx\nl6dc/1ms40L5HFdLgaVtd4k0rSPFeOSDr6evz0lX4yBuzlP0fEh+o3XHW7mwe2G+\nrWCULF/Uqza66fjbCSKMNgLIXQKBgQDBm9nZg/s4S0THWCFNWcB1tXBG0p/sH5eY\nPC1H/VmTEINIixStrS4ufczf31X8rcoSjSbO7+vZDTTATdk7OLn1I2uGFVYl8M59\n86BYT2Hi7cwp7YVzOc/cJigVeBAqSRW/iYYyWBEUTiW1gbkV0sRWwhPp67m+c0sP\nXpY/iEZA2QKBgB1w8tynt4l/jKNaUEMOijt9ndALWATIiOy0XG9pxi9rgGCiwTOS\nDBCsOXoYHjv2eayGUijNaoOv6xzcoxfvQ1WySdNIxTRq1ru20kYwgHKqGgmO9hrM\nmcwMY5r/WZ2qjFlPjeAqbL62aPDLidGjoaVo2iIoBPK/gjxQ/5f0MS4N/YQ0zWoYBueSQ0DGs\n-----END PRIVATE KEY-----"}, "config_version": null, "cost_collection_enabled": true, "dd_compartment_id": "ocid.compartment.test", "dd_stack_id": "ocid.stack.test", "home_region": "us-ashburn-1", "logs_config": {"compartment_tag_filters": ["datadog:true", "env:prod"], "enabled": true, "enabled_services": ["service_1", "service_1"]}, "metrics_config": {"compartment_tag_filters": ["datadog:true", "env:prod"], "enabled": true, "excluded_services": ["service_1", "service_1"]}, "regions_config": {"available": ["us-ashburn-1", "us-phoenix-1"], "disabled": ["us-phoenix-1"], "enabled": ["us-ashburn-1"]}, "resource_collection_enabled": true, "user_ocid": "ocid.user.test"}, "id": "ocid.tenancy.test", "type": "oci_tenancy"}} + And body with value {"data": {"attributes": {"auth_credentials": {"fingerprint": "", "private_key": "----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCdvSMmlfLyeD4M\nQsA3WlrWBqKdWa5eVV3/uODyqT3wWMEMIJHcG3/quNs8nh9xrK1/JkQT2qoKEHqR\nC5k59jN6Vp8em8ARJthMgam9K37ELt+IQ/G8ySTSuqZG8T4cHp/cs3fAclNqttOl\nYnGr4RbVAgMBAAECggEAGZNLGbyCUbIRTW6Kh4d8ZVC+eZtJMqGmGJ3KfVaW8Pjn\nQGWfSuJCEe2o2Y8G3phlidFauICnZ44enXA17Rhi+I/whnr7FIyQk2bR7rv+1Uhc\nmOJygWX5eFFMsledgVAdIAl9Luk2nykx7Un3g6rtbl/Vs+5k4m7ITLFMpCHzsJLU\nnm8kBzDOqY2JUkMd08nL88KL6QywWtal05UESzQpNFXd0e5kxYfexeMCsLsWP0mc\nquMLRbn7NuBjCbe9VU2kmIvcfDDaWjurT7d5m1OXx1cc8p6P4PFZTVyCjdhiWOr3\nLQXZ4/vdZNR3zgEHypRoM6D9Yq99LWUOUEMrdiSLQQKBgQDQkh7C1OtAXnpy7F6R\nW+/I3zBHici2p7A57UT7VECQ1IVGg37/uus83DkuOtdZ33JmHLAVrwLFJvUlbyjx\nl6dc/1ms40L5HFdLgaVtd4k0rSPFeOSDr6evz0lX4yBuzlP0fEh+o3XHW7mwe2G+\nrWCULF/Uqza66fjbCSKMNgLIXQKBgQDBm9nZg/s4S0THWCFNWcB1tXBG0p/sH5eY\nPC1H/VmTEINIixStrS4ufczf31X8rcoSjSbO7+vZDTTATdk7OLn1I2uGFVYl8M59\n86BYT2Hi7cwp7YVzOc/cJigVeBAqSRW/iYYyWBEUTiW1gbkV0sRWwhPp67m+c0sP\nXpY/iEZA2QKBgB1w8tynt4l/jKNaUEMOijt9ndALWATIiOy0XG9pxi9rgGCiwTOS\nDBCsOXoYHjv2eayGUijNaoOv6xzcoxfvQ1WySdNIxTRq1ru20kYwgHKqGgmO9hrM\nmcwMY5r/WZ2qjFlPjeAqbL62aPDLidGjoaVo2iIoBPK/gjxQ/5f0MS4N/YQ0zWoYBueSQ0DGs\n-----END PRIVATE KEY-----"}, "config_version": null, "cost_collection_enabled": true, "dd_compartment_id": "ocid.compartment.test", "dd_stack_id": "ocid.stack.test", "home_region": "us-ashburn-1", "logs_config": {"compartment_tag_filters": ["datadog:true", "env:prod"], "enabled": true, "enabled_services": ["service_1", "service_2"]}, "metrics_config": {"compartment_tag_filters": ["datadog:true", "env:prod"], "enabled": true, "excluded_services": ["service_1", "service_2"]}, "regions_config": {"available": ["us-ashburn-1", "us-phoenix-1"], "disabled": ["us-phoenix-1"], "enabled": ["us-ashburn-1"]}, "resource_collection_enabled": true, "user_ocid": "ocid.user.test"}, "id": "ocid.tenancy.test", "type": "oci_tenancy"}} When the request is sent Then the response status is 201 Created @@ -47,6 +47,6 @@ Feature: OCI Integration Scenario: Update tenancy config returns "OK" response Given new "UpdateTenancyConfig" request And request contains "tenancy_ocid" parameter from "REPLACE.ME" - And body with value {"data": {"attributes": {"auth_credentials": {"fingerprint": "", "private_key": "----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCdvSMmlfLyeD4M\nQsA3WlrWBqKdWa5eVV3/uODyqT3wWMEMIJHcG3/quNs8nh9xrK1/JkQT2qoKEHqR\nC5k59jN6Vp8em8ARJthMgam9K37ELt+IQ/G8ySTSuqZG8T4cHp/cs3fAclNqttOl\nYnGr4RbVAgMBAAECggEAGZNLGbyCUbIRTW6Kh4d8ZVC+eZtJMqGmGJ3KfVaW8Pjn\nQGWfSuJCEe2o2Y8G3phlidFauICnZ44enXA17Rhi+I/whnr7FIyQk2bR7rv+1Uhc\nmOJygWX5eFFMsledgVAdIAl9Luk2nykx7Un3g6rtbl/Vs+5k4m7ITLFMpCHzsJLU\nnm8kBzDOqY2JUkMd08nL88KL6QywWtal05UESzQpNFXd0e5kxYfexeMCsLsWP0mc\nquMLRbn7NuBjCbe9VU2kmIvcfDDaWjurT7d5m1OXx1cc8p6P4PFZTVyCjdhiWOr3\nLQXZ4/vdZNR3zgEHypRoM6D9Yq99LWUOUEMrdiSLQQKBgQDQkh7C1OtAXnpy7F6R\nW+/I3zBHici2p7A57UT7VECQ1IVGg37/uus83DkuOtdZ33JmHLAVrwLFJvUlbyjx\nl6dc/1ms40L5HFdLgaVtd4k0rSPFeOSDr6evz0lX4yBuzlP0fEh+o3XHW7mwe2G+\nrWCULF/Uqza66fjbCSKMNgLIXQKBgQDBm9nZg/s4S0THWCFNWcB1tXBG0p/sH5eY\nPC1H/VmTEINIixStrS4ufczf31X8rcoSjSbO7+vZDTTATdk7OLn1I2uGFVYl8M59\n86BYT2Hi7cwp7YVzOc/cJigVeBAqSRW/iYYyWBEUTiW1gbkV0sRWwhPp67m+c0sP\nXpY/iEZA2QKBgB1w8tynt4l/jKNaUEMOijt9ndALWATIiOy0XG9pxi9rgGCiwTOS\nDBCsOXoYHjv2eayGUijNaoOv6xzcoxfvQ1WySdNIxTRq1ru20kYwgHKqGgmO9hrM\nmcwMY5r/WZ2qjFlPjeAqbL62aPDLidGjoaVo2iIoBPK/gjxQ/5f0MS4N/YQ0zWoYBueSQ0DGs\n-----END PRIVATE KEY-----"}, "cost_collection_enabled": true, "home_region": "us-ashburn-1", "logs_config": {"compartment_tag_filters": ["datadog:true", "env:prod"], "enabled": true, "enabled_services": ["service_1", "service_1"]}, "metrics_config": {"compartment_tag_filters": ["datadog:true", "env:prod"], "enabled": true, "excluded_services": ["service_1", "service_1"]}, "regions_config": {"available": ["us-ashburn-1", "us-phoenix-1"], "disabled": ["us-phoenix-1"], "enabled": ["us-ashburn-1"]}, "resource_collection_enabled": true, "user_ocid": "ocid.user.test"}, "id": "ocid.tenancy.test", "type": "oci_tenancy"}} + And body with value {"data": {"attributes": {"auth_credentials": {"fingerprint": "", "private_key": "----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCdvSMmlfLyeD4M\nQsA3WlrWBqKdWa5eVV3/uODyqT3wWMEMIJHcG3/quNs8nh9xrK1/JkQT2qoKEHqR\nC5k59jN6Vp8em8ARJthMgam9K37ELt+IQ/G8ySTSuqZG8T4cHp/cs3fAclNqttOl\nYnGr4RbVAgMBAAECggEAGZNLGbyCUbIRTW6Kh4d8ZVC+eZtJMqGmGJ3KfVaW8Pjn\nQGWfSuJCEe2o2Y8G3phlidFauICnZ44enXA17Rhi+I/whnr7FIyQk2bR7rv+1Uhc\nmOJygWX5eFFMsledgVAdIAl9Luk2nykx7Un3g6rtbl/Vs+5k4m7ITLFMpCHzsJLU\nnm8kBzDOqY2JUkMd08nL88KL6QywWtal05UESzQpNFXd0e5kxYfexeMCsLsWP0mc\nquMLRbn7NuBjCbe9VU2kmIvcfDDaWjurT7d5m1OXx1cc8p6P4PFZTVyCjdhiWOr3\nLQXZ4/vdZNR3zgEHypRoM6D9Yq99LWUOUEMrdiSLQQKBgQDQkh7C1OtAXnpy7F6R\nW+/I3zBHici2p7A57UT7VECQ1IVGg37/uus83DkuOtdZ33JmHLAVrwLFJvUlbyjx\nl6dc/1ms40L5HFdLgaVtd4k0rSPFeOSDr6evz0lX4yBuzlP0fEh+o3XHW7mwe2G+\nrWCULF/Uqza66fjbCSKMNgLIXQKBgQDBm9nZg/s4S0THWCFNWcB1tXBG0p/sH5eY\nPC1H/VmTEINIixStrS4ufczf31X8rcoSjSbO7+vZDTTATdk7OLn1I2uGFVYl8M59\n86BYT2Hi7cwp7YVzOc/cJigVeBAqSRW/iYYyWBEUTiW1gbkV0sRWwhPp67m+c0sP\nXpY/iEZA2QKBgB1w8tynt4l/jKNaUEMOijt9ndALWATIiOy0XG9pxi9rgGCiwTOS\nDBCsOXoYHjv2eayGUijNaoOv6xzcoxfvQ1WySdNIxTRq1ru20kYwgHKqGgmO9hrM\nmcwMY5r/WZ2qjFlPjeAqbL62aPDLidGjoaVo2iIoBPK/gjxQ/5f0MS4N/YQ0zWoYBueSQ0DGs\n-----END PRIVATE KEY-----"}, "cost_collection_enabled": true, "home_region": "us-ashburn-1", "logs_config": {"compartment_tag_filters": ["datadog:true", "env:prod"], "enabled": true, "enabled_services": ["service_1", "service_2"]}, "metrics_config": {"compartment_tag_filters": ["datadog:true", "env:prod"], "enabled": true, "excluded_services": ["service_1", "service_2"]}, "regions_config": {"available": ["us-ashburn-1", "us-phoenix-1"], "disabled": ["us-phoenix-1"], "enabled": ["us-ashburn-1"]}, "resource_collection_enabled": true, "user_ocid": "ocid.user.test"}, "id": "ocid.tenancy.test", "type": "oci_tenancy"}} When the request is sent Then the response status is 200 OK diff --git a/tests/v2/features/synthetics.feature b/tests/v2/features/synthetics.feature index 22e61a439c..33f538109f 100644 --- a/tests/v2/features/synthetics.feature +++ b/tests/v2/features/synthetics.feature @@ -50,14 +50,14 @@ Feature: Synthetics @generated @skip @team:DataDog/synthetics-orchestrating-managing Scenario: Bulk delete tests returns "API error response." response Given new "DeleteSyntheticsTests" request - And body with value {"data": {"attributes": {"public_ids": [""]}, "type": "delete_tests_request"}} + And body with value {"data": {"attributes": {"public_ids": ["abc-def-123"]}, "type": "delete_tests_request"}} When the request is sent Then the response status is 404 API error response. @generated @skip @team:DataDog/synthetics-orchestrating-managing Scenario: Bulk delete tests returns "OK" response Given new "DeleteSyntheticsTests" request - And body with value {"data": {"attributes": {"public_ids": [""]}, "type": "delete_tests_request"}} + And body with value {"data": {"attributes": {"public_ids": ["abc-def-123"]}, "type": "delete_tests_request"}} When the request is sent Then the response status is 200 OK