From be6521719feca540a513e99ae701d7736b9e8ef9 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Tue, 5 May 2026 14:21:08 +0000 Subject: [PATCH] Regenerate client from commit 471512b of spec repo --- .generator/schemas/v1/openapi.yaml | 2151 +++- .generator/schemas/v2/openapi.yaml | 10028 +++++++++++++++- .../CreateLLMObsAnnotationQueue.java | 4 +- ...eateLLMObsAnnotationQueueInteractions.java | 2 +- .../DeleteLLMObsAnnotationQueue.java | 2 +- ...leteLLMObsAnnotationQueueInteractions.java | 2 +- .../GetLLMObsAnnotatedInteractions.java | 2 +- .../GetLLMObsAnnotationQueueLabelSchema.java | 2 +- .../UpdateLLMObsAnnotationQueue.java | 4 +- ...pdateLLMObsAnnotationQueueLabelSchema.java | 4 +- .../MuteSecurityFindings.java | 2 +- .../SecurityEntityRiskScoreAttributes.java | 20 +- .../client/v2/api/llm_observability.feature | 16 +- .../client/v2/api/security_monitoring.feature | 8 +- 14 files changed, 12157 insertions(+), 90 deletions(-) diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index 4ac4cbb66ff..9e5cc48776b 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -26597,6 +26597,35 @@ paths: "200": content: application/json: + examples: + default: + value: + agents: + prefixes_ipv4: + - "1.2.3.4/32" + prefixes_ipv6: [] + api: + prefixes_ipv4: + - "1.2.3.4/32" + prefixes_ipv6: [] + apm: + prefixes_ipv4: + - "1.2.3.4/32" + prefixes_ipv6: [] + logs: + prefixes_ipv4: + - "1.2.3.4/32" + prefixes_ipv6: [] + modified: "2019-10-31-20-00-00" + process: + prefixes_ipv4: + - "1.2.3.4/32" + prefixes_ipv6: [] + version: 11 + webhooks: + prefixes_ipv4: + - "1.2.3.4/32" + prefixes_ipv6: [] schema: $ref: "#/components/schemas/IPRanges" description: OK @@ -26654,6 +26683,14 @@ paths: "200": content: application/json: + examples: + default: + value: + api_keys: + - created: "2024-01-01T00:00:00+00:00" + created_by: test@example.com + key: abc123example456key789placeholder0 + name: app_key schema: $ref: "#/components/schemas/ApiKeyListResponse" description: OK @@ -26689,6 +26726,14 @@ paths: "200": content: application/json: + examples: + default: + value: + api_key: + created: "2024-01-01T00:00:00+00:00" + created_by: test@example.com + key: abc123example456key789placeholder0 + name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK @@ -26729,6 +26774,14 @@ paths: "200": content: application/json: + examples: + default: + value: + api_key: + created: "2024-01-01T00:00:00+00:00" + created_by: test@example.com + key: abc123example456key789placeholder0 + name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK @@ -26773,6 +26826,14 @@ paths: "200": content: application/json: + examples: + default: + value: + api_key: + created: "2024-01-01T00:00:00+00:00" + created_by: test@example.com + key: abc123example456key789placeholder0 + name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK @@ -26821,6 +26882,14 @@ paths: "200": content: application/json: + examples: + default: + value: + api_key: + created: "2024-01-01T00:00:00+00:00" + created_by: test@example.com + key: abc123example456key789placeholder0 + name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK @@ -26862,6 +26931,13 @@ paths: "200": content: application/json: + examples: + default: + value: + application_keys: + - hash: 1234512345123459cda4eb9ced49a3d84fd0138c + name: app_key + owner: test@example.com schema: $ref: "#/components/schemas/ApplicationKeyListResponse" description: OK @@ -26900,6 +26976,13 @@ paths: "200": content: application/json: + examples: + default: + value: + application_key: + hash: 1234512345123459cda4eb9ced49a3d84fd0138c + name: app_key + owner: test@example.com schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -26948,6 +27031,13 @@ paths: "200": content: application/json: + examples: + default: + value: + application_key: + hash: 1234512345123459cda4eb9ced49a3d84fd0138c + name: app_key + owner: test@example.com schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -26989,6 +27079,13 @@ paths: "200": content: application/json: + examples: + default: + value: + application_key: + hash: 1234512345123459cda4eb9ced49a3d84fd0138c + name: app_key + owner: test@example.com schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -27040,6 +27137,13 @@ paths: "200": content: application/json: + examples: + default: + value: + application_key: + hash: 1234512345123459cda4eb9ced49a3d84fd0138c + name: app_key + owner: test@example.com schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -27107,6 +27211,10 @@ paths: "202": content: text/json: + examples: + default: + value: + status: ok schema: $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted @@ -27181,6 +27289,22 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: + - attributes: + computed_on: "2024-01-02" + end_date: "2024-01-01" + size: 1024 + start_date: "2024-01-01" + tags: + - env + id: "2024-01-01" + type: reports + meta: + page: + total_count: 1 schema: $ref: "#/components/schemas/UsageCustomReportsResponse" description: OK @@ -27222,6 +27346,23 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: + attributes: + computed_on: "2024-01-02" + end_date: "2024-01-01" + location: "https://example.s3.amazonaws.com/report.csv" + size: 1024 + start_date: "2024-01-01" + tags: + - env + id: "2024-01-01" + type: reports + meta: + page: + total_count: 1 schema: $ref: "#/components/schemas/UsageSpecifiedCustomReportsResponse" description: OK @@ -27350,6 +27491,17 @@ paths: "200": content: application/json: + examples: + default: + value: + dashboards: + - author_handle: test@example.com + created_at: "2024-01-01T00:00:00+00:00" + id: abc-123-def + layout_type: ordered + modified_at: "2024-01-01T00:00:00+00:00" + title: Example Dashboard + url: /dashboard/abc-123-def/example-dashboard schema: $ref: "#/components/schemas/DashboardSummary" description: OK @@ -27461,6 +27613,27 @@ paths: "200": content: application/json: + examples: + default: + value: + author_handle: test@example.com + author_name: Example Name + created_at: "2024-01-01T00:00:00+00:00" + id: abc-123-def + layout_type: ordered + modified_at: "2024-01-01T00:00:00+00:00" + notify_list: + restricted_roles: [] + template_variables: + title: Example Dashboard + url: /dashboard/abc-123-def/example-dashboard + widgets: + - definition: + requests: + - q: avg:system.cpu.user{*} + title: CPU Usage + type: timeseries + id: 123 schema: $ref: "#/components/schemas/Dashboard" description: OK @@ -27500,6 +27673,20 @@ paths: "200": content: application/json: + examples: + default: + value: + dashboard_lists: + - author: + handle: test@example.com + name: Example Name + created: "2024-01-01T00:00:00+00:00" + dashboard_count: 0 + id: 123 + is_favorite: false + modified: "2024-01-01T00:00:00+00:00" + name: My Dashboard List + type: manual_dashboard_list schema: $ref: "#/components/schemas/DashboardListListResponse" description: OK @@ -27542,6 +27729,19 @@ paths: "200": content: application/json: + examples: + default: + value: + author: + handle: test@example.com + name: Example Name + created: "2024-01-01T00:00:00+00:00" + dashboard_count: 0 + id: 123 + is_favorite: false + modified: "2024-01-01T00:00:00+00:00" + name: My Dashboard List + type: manual_dashboard_list schema: $ref: "#/components/schemas/DashboardList" description: OK @@ -27589,6 +27789,10 @@ paths: "200": content: application/json: + examples: + default: + value: + deleted_dashboard_list_id: 123 schema: $ref: "#/components/schemas/DashboardListDeleteResponse" description: OK @@ -27634,6 +27838,19 @@ paths: "200": content: application/json: + examples: + default: + value: + author: + handle: test@example.com + name: Example Name + created: "2024-01-01T00:00:00+00:00" + dashboard_count: 0 + id: 123 + is_favorite: false + modified: "2024-01-01T00:00:00+00:00" + name: My Dashboard List + type: manual_dashboard_list schema: $ref: "#/components/schemas/DashboardList" description: OK @@ -27690,6 +27907,19 @@ paths: "200": content: application/json: + examples: + default: + value: + author: + handle: test@example.com + name: Example Name + created: "2024-01-01T00:00:00+00:00" + dashboard_count: 0 + id: 123 + is_favorite: false + modified: "2024-01-01T00:00:00+00:00" + name: My Dashboard List + type: manual_dashboard_list schema: $ref: "#/components/schemas/DashboardList" description: OK @@ -27752,6 +27982,21 @@ paths: "200": content: application/json: + examples: + default: + value: + author: + handle: test@example.com + name: Example Name + created: "2024-01-01T00:00:00+00:00" + dashboard_id: abc-123-def + dashboard_type: custom_timeboard + global_time: + live_span: 1h + public_url: https://p.datadoghq.com/sb/abc-123 + share_type: open + status: active + token: abc-123 schema: $ref: "#/components/schemas/SharedDashboard" description: OK @@ -27810,6 +28055,10 @@ paths: "200": content: application/json: + examples: + default: + value: + deleted_public_dashboard_token: abc-123 schema: $ref: "#/components/schemas/DeleteSharedDashboardResponse" description: OK @@ -27860,6 +28109,21 @@ paths: "200": content: application/json: + examples: + default: + value: + author: + handle: test@example.com + name: Example Name + created: "2024-01-01T00:00:00+00:00" + dashboard_id: abc-123-def + dashboard_type: custom_timeboard + global_time: + live_span: 1h + public_url: https://p.datadoghq.com/sb/abc-123 + share_type: open + status: active + token: abc-123 schema: $ref: "#/components/schemas/SharedDashboard" description: OK @@ -27928,6 +28192,21 @@ paths: "200": content: application/json: + examples: + default: + value: + author: + handle: test@example.com + name: Example Name + created: "2024-01-01T00:00:00+00:00" + dashboard_id: abc-123-def + dashboard_type: custom_timeboard + global_time: + live_span: 1h + public_url: https://p.datadoghq.com/sb/abc-123 + share_type: open + status: active + token: abc-123 schema: $ref: "#/components/schemas/SharedDashboard" description: OK @@ -28057,6 +28336,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + email: test@example.com + has_session: false + session_expiry: + share_token: abc-123 + type: public_dashboard_invitation + meta: + page: + total_count: 1 schema: $ref: "#/components/schemas/SharedDashboardInvites" description: OK @@ -28117,6 +28410,20 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + email: test@example.com + has_session: false + session_expiry: + share_token: abc-123 + type: public_dashboard_invitation + meta: + page: + total_count: 1 schema: $ref: "#/components/schemas/SharedDashboardInvites" description: OK @@ -28168,6 +28475,10 @@ paths: "200": content: application/json: + examples: + default: + value: + deleted_dashboard_id: abc-123 schema: $ref: "#/components/schemas/DashboardDeleteResponse" description: OK @@ -28211,6 +28522,27 @@ paths: "200": content: application/json: + examples: + default: + value: + author_handle: test@example.com + author_name: Example Name + created_at: "2024-01-01T00:00:00+00:00" + id: abc-123-def + layout_type: ordered + modified_at: "2024-01-01T00:00:00+00:00" + notify_list: + restricted_roles: [] + template_variables: + title: Example Dashboard + url: /dashboard/abc-123-def/example-dashboard + widgets: + - definition: + requests: + - q: avg:system.cpu.user{*} + title: CPU Usage + type: timeseries + id: 123 schema: $ref: "#/components/schemas/Dashboard" description: OK @@ -28273,6 +28605,27 @@ paths: "200": content: application/json: + examples: + default: + value: + author_handle: test@example.com + author_name: Example Name + created_at: "2024-01-01T00:00:00+00:00" + id: abc-123-def + layout_type: ordered + modified_at: "2024-01-01T00:00:00+00:00" + notify_list: + restricted_roles: [] + template_variables: + title: Example Dashboard + url: /dashboard/abc-123-def/example-dashboard + widgets: + - definition: + requests: + - q: avg:system.cpu.user{*} + title: CPU Usage + type: timeseries + id: 123 schema: $ref: "#/components/schemas/Dashboard" description: OK @@ -28347,6 +28700,10 @@ paths: "202": content: text/json: + examples: + default: + value: + status: ok schema: $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted @@ -28405,6 +28762,17 @@ paths: "200": content: application/json: + examples: + default: + value: + - active: true + disabled: false + end: 1412793983 + id: 1625 + message: Scheduled maintenance + scope: + - env:staging + start: 1412792983 schema: items: $ref: "#/components/schemas/Downtime" @@ -28457,6 +28825,17 @@ paths: "200": content: application/json: + examples: + default: + value: + active: true + disabled: false + end: 1412793983 + id: 1625 + message: Scheduling downtime for a database maintenance window. + scope: + - env:staging + start: 1412792983 schema: $ref: "#/components/schemas/Downtime" description: OK @@ -28508,6 +28887,11 @@ paths: "200": content: application/json: + examples: + default: + value: + cancelled_ids: + - 123 schema: $ref: "#/components/schemas/CanceledDowntimesIds" description: OK @@ -28606,6 +28990,17 @@ paths: "200": content: application/json: + examples: + default: + value: + active: true + disabled: false + end: 1412793983 + id: 1625 + message: Scheduled maintenance + scope: + - env:staging + start: 1412792983 schema: $ref: "#/components/schemas/Downtime" description: OK @@ -28672,6 +29067,17 @@ paths: "200": content: application/json: + examples: + default: + value: + active: true + disabled: false + end: 1412793983 + id: 1625 + message: Updating downtime end time. + scope: + - env:staging + start: 1412792983 schema: $ref: "#/components/schemas/Downtime" description: OK @@ -28786,6 +29192,23 @@ paths: "200": content: application/json: + examples: + default: + value: + events: + - alert_type: info + date_happened: 1674842440 + host: "test.host" + id: 123 + id_str: "123" + priority: normal + source_type_name: my_apps + tags: + - "environment:test" + text: "Oh boy!" + title: "Did you hear the news today?" + url: "/event/event?id=123" + status: ok schema: $ref: "#/components/schemas/EventListResponse" description: OK @@ -28839,6 +29262,21 @@ paths: "202": content: application/json: + examples: + default: + value: + event: + alert_type: info + date_happened: 1674842440 + id: 123 + id_str: "123" + priority: normal + tags: + - environment:test + text: Oh boy! + title: Did you hear the news today? + url: "/event/event?id=123" + status: ok schema: $ref: "#/components/schemas/EventCreateResponse" description: OK @@ -28876,6 +29314,22 @@ paths: "200": content: application/json: + examples: + default: + value: + event: + alert_type: info + date_happened: 1674842440 + host: "test.host" + id: 123 + id_str: "123" + priority: normal + tags: + - environment:test + text: Oh boy! + title: Did you hear the news today? + url: "/event/event?id=123" + status: ok schema: $ref: "#/components/schemas/EventResponse" description: OK @@ -28972,6 +29426,11 @@ paths: "200": content: application/json: + examples: + default: + value: + metric_query: "avg:system.load.1{*}" + snapshot_url: https://app.datadoghq.com/s/f12345678/aaa-bbb-ccc schema: $ref: "#/components/schemas/GraphSnapshot" description: OK @@ -29027,6 +29486,13 @@ paths: "200": content: application/json: + examples: + default: + value: + action: Muted + end: 1579098130 + hostname: test.host + message: Muting this host for a test! schema: $ref: "#/components/schemas/HostMuteResponse" description: OK @@ -29063,6 +29529,11 @@ paths: "200": content: application/json: + examples: + default: + value: + action: Unmuted + hostname: test.host schema: $ref: "#/components/schemas/HostMuteResponse" description: OK @@ -29150,6 +29621,21 @@ paths: "200": content: application/json: + examples: + default: + value: + host_list: + - apps: + - agent + host_name: "i-deadbeef" + is_muted: false + last_reported_time: 1565000000 + name: "i-hostname" + sources: + - aws + up: true + total_matching: 1 + total_returned: 1 schema: $ref: "#/components/schemas/HostListResponse" description: OK @@ -29197,6 +29683,11 @@ paths: "200": content: application/json: + examples: + default: + value: + total_active: 65 + total_up: 42 schema: $ref: "#/components/schemas/HostTotals" description: OK @@ -29247,6 +29738,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: type: object description: OK @@ -29305,6 +29799,23 @@ paths: "200": content: application/json: + examples: + default: + value: + accounts: + - account_id: "123456789012" + account_specific_namespace_rules: + auto_scaling: false + cspm_resource_collection_enabled: true + excluded_regions: + - us-east-1 + extended_resource_collection_enabled: true + filter_tags: + - "$KEY:$VALUE" + host_tags: + - "$KEY:$VALUE" + metrics_collection_enabled: false + role_name: "DatadogAWSIntegrationRole" schema: $ref: "#/components/schemas/AWSAccountListResponse" description: OK @@ -29366,6 +29877,10 @@ paths: "200": content: application/json: + examples: + default: + value: + external_id: abc-123 schema: $ref: "#/components/schemas/AWSAccountCreateResponse" description: OK @@ -29453,6 +29968,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: type: object description: OK @@ -29493,6 +30011,12 @@ paths: "200": content: application/json: + examples: + default: + value: + - namespace1 + - namespace2 + - namespace3 schema: example: ["namespace1", "namespace2", "namespace3"] items: @@ -29536,6 +30060,10 @@ paths: "200": content: application/json: + examples: + default: + value: + status: empty schema: $ref: "#/components/schemas/AWSEventBridgeDeleteResponse" description: OK @@ -29570,6 +30098,17 @@ paths: "200": content: application/json: + examples: + default: + value: + accounts: + - accountId: "123456789012" + eventHubs: + - name: app-alerts-zyxw3210 + region: us-east-1 + tags: + - "$KEY:$VALUE" + isInstalled: true schema: $ref: "#/components/schemas/AWSEventBridgeListResponse" description: OK @@ -29615,6 +30154,13 @@ paths: "200": content: application/json: + examples: + default: + value: + event_source_name: app-alerts-zyxw3210 + has_bus: true + region: us-east-1 + status: created schema: $ref: "#/components/schemas/AWSEventBridgeCreateResponse" description: OK @@ -29661,6 +30207,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -29702,6 +30251,12 @@ paths: "200": content: application/json: + examples: + default: + value: + filters: + - namespace: elb + tag_filter_str: "prod*" schema: $ref: "#/components/schemas/AWSTagFilterListResponse" description: OK @@ -29749,6 +30304,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -29799,6 +30357,10 @@ paths: "200": content: application/json: + examples: + default: + value: + external_id: abc-123 schema: $ref: "#/components/schemas/AWSAccountCreateResponse" description: OK @@ -29845,6 +30407,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: type: object description: OK @@ -29879,6 +30444,18 @@ paths: "200": content: application/json: + examples: + default: + value: + - account_id: "123456789101" + lambdas: [] + services: + - s3 + - elb + - elbv2 + - cloudfront + - redshift + - lambda schema: example: [{"account_id": "123456789101", "lambdas": [], "services": ["s3", "elb", "elbv2", "cloudfront", "redshift", "lambda"]}] items: @@ -29926,6 +30503,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: type: object description: OK @@ -29979,6 +30559,11 @@ paths: "200": content: application/json: + examples: + default: + value: + errors: [] + status: created schema: $ref: "#/components/schemas/AWSLogsAsyncResponse" description: OK @@ -30014,6 +30599,13 @@ paths: "200": content: application/json: + examples: + default: + value: + - id: s3 + label: S3 Access Logs + - id: elb + label: Classic ELB Access Logs schema: example: [{"id": "s3", "label": "S3 Access Logs"}, {"id": "elb", "label": "Classic ELB Access Logs"}, {"id": "elbv2", "label": "Application ELB Access Logs"}, {"id": "cloudfront", "label": "CloudFront Access Logs"}, {"id": "redshift", "label": "Redshift Logs"}, {"id": "lambda", "label": "Lambda Cloudwatch Logs"}] items: @@ -30062,6 +30654,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: type: object description: OK @@ -30123,6 +30718,11 @@ paths: "200": content: application/json: + examples: + default: + value: + errors: [] + status: created schema: $ref: "#/components/schemas/AWSLogsAsyncResponse" description: OK @@ -30169,6 +30769,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30203,6 +30806,13 @@ paths: "200": content: application/json: + examples: + default: + value: + - client_id: testc7f6-1234-5678-9101-3fcbf464test + errors: [] + host_filters: "key:value,filter:example" + tenant_name: testc44-1234-5678-9101-cc00736ftest schema: $ref: "#/components/schemas/AzureAccountListResponse" description: OK @@ -30262,6 +30872,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30318,6 +30931,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30366,6 +30982,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30415,6 +31034,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30450,6 +31072,14 @@ paths: "200": content: application/json: + examples: + default: + value: + - client_email: test@example.com + client_id: "123456712345671234567" + errors: [] + project_id: datadog-apitest + type: service_account schema: $ref: "#/components/schemas/GCPAccountListResponse" description: OK @@ -30506,6 +31136,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30560,6 +31193,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30606,6 +31242,10 @@ paths: "201": content: application/json: + examples: + default: + value: + service_name: test-service schema: $ref: "#/components/schemas/PagerDutyServiceName" description: OK @@ -30681,6 +31321,10 @@ paths: "200": content: application/json: + examples: + default: + value: + service_name: test-service schema: $ref: "#/components/schemas/PagerDutyServiceName" description: OK @@ -30767,6 +31411,16 @@ paths: "200": content: application/json: + examples: + default: + value: + - display: + message: true + mute_buttons: false + notified: true + snapshot: true + tags: true + name: "#test-channel" schema: $ref: "#/components/schemas/SlackIntegrationChannels" description: OK @@ -30823,6 +31477,16 @@ paths: "200": content: application/json: + examples: + default: + value: + display: + message: true + mute_buttons: false + notified: true + snapshot: true + tags: true + name: "#test-channel" schema: $ref: "#/components/schemas/SlackIntegrationChannel" description: OK @@ -30901,6 +31565,16 @@ paths: "200": content: application/json: + examples: + default: + value: + display: + message: true + mute_buttons: false + notified: true + snapshot: true + tags: true + name: "#test-channel" schema: $ref: "#/components/schemas/SlackIntegrationChannel" description: OK @@ -30958,6 +31632,16 @@ paths: "200": content: application/json: + examples: + default: + value: + display: + message: true + mute_buttons: false + notified: true + snapshot: true + tags: true + name: "#test-channel" schema: $ref: "#/components/schemas/SlackIntegrationChannel" description: OK @@ -31010,6 +31694,11 @@ paths: "201": content: application/json: + examples: + default: + value: + is_secret: true + name: CUSTOM_VARIABLE_NAME schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK @@ -31088,6 +31777,11 @@ paths: "200": content: application/json: + examples: + default: + value: + is_secret: true + name: CUSTOM_VARIABLE_NAME schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK @@ -31145,6 +31839,11 @@ paths: "200": content: application/json: + examples: + default: + value: + is_secret: true + name: CUSTOM_VARIABLE_NAME schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK @@ -31197,6 +31896,12 @@ paths: "201": content: application/json: + examples: + default: + value: + encode_as: json + name: WEBHOOK_NAME + url: https://example.com/webhook schema: $ref: "#/components/schemas/WebhooksIntegration" description: OK @@ -31276,6 +31981,12 @@ paths: "200": content: application/json: + examples: + default: + value: + encode_as: json + name: WEBHOOK_NAME + url: https://example.com/webhook schema: $ref: "#/components/schemas/WebhooksIntegration" description: OK @@ -31333,6 +32044,12 @@ paths: "200": content: application/json: + examples: + default: + value: + encode_as: json + name: WEBHOOK_NAME + url: https://example.com/webhook schema: $ref: "#/components/schemas/WebhooksIntegration" description: OK @@ -31400,6 +32117,20 @@ paths: "200": content: application/json: + examples: + default: + value: + logs: + - content: + attributes: + customAttribute: 123 + host: i-0123 + service: test-service + tags: + - team:A + timestamp: "2020-05-26T13:36:14Z" + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + status: done schema: $ref: "#/components/schemas/LogsListResponse" description: OK @@ -31438,6 +32169,13 @@ paths: "200": content: application/json: + examples: + default: + value: + index_names: + - main + - payments + - web schema: $ref: "#/components/schemas/LogsIndexesOrder" description: OK @@ -31479,6 +32217,13 @@ paths: "200": content: application/json: + examples: + default: + value: + index_names: + - main + - payments + - web schema: $ref: "#/components/schemas/LogsIndexesOrder" description: OK @@ -31514,6 +32259,16 @@ paths: "200": content: application/json: + examples: + default: + value: + indexes: + - daily_limit: 300000000 + filter: + query: source:python + is_rate_limited: false + name: main + num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndexListResponse" description: OK @@ -31562,6 +32317,15 @@ paths: "200": content: application/json: + examples: + default: + value: + daily_limit: 300000000 + filter: + query: source:python + is_rate_limited: false + name: main + num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndex" description: OK @@ -31645,6 +32409,15 @@ paths: "200": content: application/json: + examples: + default: + value: + daily_limit: 300000000 + filter: + query: source:python + is_rate_limited: false + name: main + num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndex" description: OK @@ -31710,6 +32483,15 @@ paths: "200": content: application/json: + examples: + default: + value: + daily_limit: 300000000 + filter: + query: source:python + is_rate_limited: false + name: main + num_retention_days: 15 schema: $ref: "#/components/schemas/LogsIndex" description: OK @@ -31745,6 +32527,13 @@ paths: "200": content: application/json: + examples: + default: + value: + pipeline_ids: + - tags + - org_ids + - products schema: $ref: "#/components/schemas/LogsPipelinesOrder" description: OK @@ -31789,6 +32578,13 @@ paths: "200": content: application/json: + examples: + default: + value: + pipeline_ids: + - tags + - org_ids + - products schema: $ref: "#/components/schemas/LogsPipelinesOrder" description: OK @@ -31830,6 +32626,16 @@ paths: "200": content: application/json: + examples: + default: + value: + - filter: + query: source:python + id: abc-123 + is_enabled: true + is_read_only: false + name: My Pipeline + processors: [] schema: $ref: "#/components/schemas/LogsPipelineList" description: OK @@ -31870,6 +32676,16 @@ paths: "200": content: application/json: + examples: + default: + value: + filter: + query: source:python + id: abc-123 + is_enabled: true + is_read_only: false + name: My Pipeline + processors: [] schema: $ref: "#/components/schemas/LogsPipeline" description: OK @@ -31948,6 +32764,16 @@ paths: "200": content: application/json: + examples: + default: + value: + filter: + query: source:python + id: abc-123 + is_enabled: true + is_read_only: false + name: My Pipeline + processors: [] schema: $ref: "#/components/schemas/LogsPipeline" description: OK @@ -32005,6 +32831,16 @@ paths: "200": content: application/json: + examples: + default: + value: + filter: + query: source:python + id: abc-123 + is_enabled: true + is_read_only: false + name: My Pipeline + processors: [] schema: $ref: "#/components/schemas/LogsPipeline" description: OK @@ -32063,6 +32899,13 @@ paths: "200": content: application/json: + examples: + default: + value: + from: "1567816237" + metrics: + - system.cpu.idle + - system.load.1 schema: $ref: "#/components/schemas/MetricsListResponse" description: OK @@ -32107,6 +32950,13 @@ paths: "200": content: application/json: + examples: + default: + value: + description: Number of requests received. + per_unit: second + type: count + unit: byte schema: $ref: "#/components/schemas/MetricMetadata" description: OK @@ -32165,6 +33015,13 @@ paths: "200": content: application/json: + examples: + default: + value: + description: Number of requests received. + per_unit: second + type: count + unit: byte schema: $ref: "#/components/schemas/MetricMetadata" description: OK @@ -32270,6 +33127,20 @@ paths: "200": content: application/json: + examples: + default: + value: + - id: 123 + 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: description: An array of monitor objects. items: @@ -32564,6 +33435,20 @@ paths: "200": content: application/json: + examples: + default: + value: + id: 123 + 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 + 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: OK @@ -32615,6 +33500,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + ok: + - 123 + errors: schema: $ref: "#/components/schemas/CheckCanDeleteMonitorResponse" description: OK @@ -32700,6 +33592,28 @@ paths: "200": content: application/json: + examples: + default: + value: + counts: + status: + - count: 1 + name: OK + type: + - count: 1 + name: metric + groups: + - group: "*" + group_tags: + - "*" + monitor_id: 123 + monitor_name: Example Monitor + status: OK + metadata: + page: 0 + page_count: 1 + per_page: 30 + total_count: 1 schema: $ref: "#/components/schemas/MonitorGroupSearchResponse" description: OK @@ -32780,6 +33694,27 @@ paths: "200": content: application/json: + examples: + default: + value: + counts: + status: + - count: 1 + name: No Data + type: + - count: 1 + name: metric + metadata: + page: 0 + page_count: 1 + per_page: 30 + total_count: 1 + monitors: + - id: 123 + name: Example Monitor + org_id: 123 + status: No Data + type: query alert schema: $ref: "#/components/schemas/MonitorSearchResponse" description: OK @@ -32840,6 +33775,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -32895,6 +33833,10 @@ paths: "200": content: application/json: + examples: + default: + value: + deleted_monitor_id: 123 schema: $ref: "#/components/schemas/DeletedMonitor" description: OK @@ -32970,6 +33912,16 @@ paths: "200": content: application/json: + examples: + default: + value: + id: 123 + 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" + tags: + - "app:webserver" + type: query alert schema: $ref: "#/components/schemas/Monitor" description: OK @@ -33042,6 +33994,16 @@ paths: "200": content: application/json: + examples: + default: + value: + id: 123 + message: Updated notification message for this monitor. + name: Updated monitor name + query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" + tags: + - "app:webserver" + type: query alert schema: $ref: "#/components/schemas/Monitor" description: OK @@ -33102,6 +34064,17 @@ paths: "200": content: application/json: + examples: + default: + value: + - active: true + disabled: false + end: 1412793983 + id: 1625 + message: Scheduled maintenance + scope: + - env:staging + start: 1412792983 schema: items: $ref: "#/components/schemas/Downtime" @@ -33171,6 +34144,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -33241,6 +34217,22 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: + - attributes: + computed_on: "2024-02-01" + end_date: "2024-01-31" + size: 2048 + start_date: "2024-01-01" + tags: + - env + id: "2024-01" + type: reports + meta: + page: + total_count: 1 schema: $ref: "#/components/schemas/UsageCustomReportsResponse" description: OK @@ -33282,6 +34274,23 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: + attributes: + computed_on: "2024-02-01" + end_date: "2024-01-31" + location: "https://example.s3.amazonaws.com/report.csv" + size: 2048 + start_date: "2024-01-01" + tags: + - env + id: "2024-01" + type: reports + meta: + page: + total_count: 1 schema: $ref: "#/components/schemas/UsageSpecifiedCustomReportsResponse" description: OK @@ -33414,6 +34423,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created: "2021-02-24T23:14:15.173964+00:00" + modified: "2021-02-24T23:15:23.274966+00:00" + name: "Example Notebook" + status: published + id: 123456 + type: notebooks + meta: + page: + total_count: 1 + total_filtered_count: 1 schema: $ref: "#/components/schemas/NotebooksResponse" description: OK @@ -33492,6 +34516,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + cells: + - attributes: + definition: + text: "## Some test markdown\n\nWith some example content." + type: markdown + id: "bzbycoya" + type: notebook_cells + created: "2021-02-24T23:14:15.173964+00:00" + modified: "2021-02-24T23:15:23.274966+00:00" + name: "Example Notebook" + time: + live_span: 1h + id: 123456 + type: notebooks schema: $ref: "#/components/schemas/NotebookResponse" description: OK @@ -33574,6 +34617,26 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + cells: + - attributes: + definition: + text: "## Example markdown" + type: markdown + id: abc-123 + type: notebook_cells + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + name: Example Notebook + status: published + time: + live_span: 1h + id: 123 + type: notebooks schema: $ref: "#/components/schemas/NotebookResponse" description: OK @@ -33663,6 +34726,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + cells: + - attributes: + definition: + text: "## Some updated test markdown\n\nWith some example content." + type: markdown + id: "abcd1234" + type: notebook_cells + created: "2021-02-24T23:14:15.173964+00:00" + modified: "2021-02-24T23:15:23.274966+00:00" + name: "Example Notebook" + time: + live_span: 1h + id: 123456 + type: notebooks schema: $ref: "#/components/schemas/NotebookResponse" description: OK @@ -33708,6 +34790,13 @@ paths: "200": content: application/json: + examples: + default: + value: + orgs: + - created: "2019-09-26T17:28:28Z" + name: Example Org + public_id: abc-123 schema: $ref: "#/components/schemas/OrganizationListResponse" description: OK @@ -33758,6 +34847,17 @@ paths: "200": content: application/json: + examples: + default: + value: + org: + created: "2019-09-26T17:28:28Z" + name: New child org + public_id: abc-123 + user: + email: test@example.com + handle: test@example.com + name: Example Name schema: $ref: "#/components/schemas/OrganizationCreateResponse" description: OK @@ -33799,6 +34899,13 @@ paths: "200": content: application/json: + examples: + default: + value: + org: + created: "2019-09-26T17:28:28Z" + name: Example Org + public_id: abc-123 schema: $ref: "#/components/schemas/OrganizationResponse" description: OK @@ -33853,6 +34960,13 @@ paths: "200": content: application/json: + examples: + default: + value: + org: + created: "2019-09-26T17:28:28Z" + name: Example Org + public_id: abc-123 schema: $ref: "#/components/schemas/OrganizationResponse" description: OK @@ -33890,6 +35004,10 @@ paths: "200": content: application/json: + examples: + default: + value: + message: "Child organization abc-123 downgraded successfully" schema: $ref: "#/components/schemas/OrgDowngradedResponse" description: OK @@ -33942,6 +35060,10 @@ paths: "200": content: application/json: + examples: + default: + value: + message: IdP metadata successfully uploaded for example org schema: $ref: "#/components/schemas/IdpResponse" description: OK @@ -33998,6 +35120,20 @@ paths: "200": content: application/json: + examples: + default: + value: + query: "avg:system.cpu.idle{*}" + res_type: time_series + series: + - aggr: avg + display_name: system.cpu.idle + expression: "avg:system.cpu.idle{*}" + metric: system.cpu.idle + pointlist: + - [1681683300000.0, 77.62145685254418] + scope: "*" + status: ok schema: $ref: "#/components/schemas/MetricsQueryResponse" description: OK @@ -34046,6 +35182,13 @@ paths: "200": content: application/json: + examples: + default: + value: + results: + metrics: + - system.cpu.idle + - system.load.1 schema: $ref: "#/components/schemas/MetricSearchResponse" description: OK @@ -34098,6 +35241,10 @@ paths: "200": content: application/json: + examples: + default: + value: + status: updated schema: $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK @@ -34152,6 +35299,10 @@ paths: "200": content: application/json: + examples: + default: + value: + status: updated schema: $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK @@ -34207,6 +35358,10 @@ paths: "200": content: application/json: + examples: + default: + value: + status: updated schema: $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK @@ -34286,6 +35441,10 @@ paths: "202": content: text/json: + examples: + default: + value: + status: ok schema: $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted @@ -34377,6 +35536,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: abc-123 + name: "Custom Metric SLO" + tags: + - "env:prod" + - "app:core" + thresholds: + - target: 95 + timeframe: "7d" + - target: 95 + timeframe: "30d" + warning: 97 + type: metric + errors: [] schema: $ref: "#/components/schemas/SLOListResponse" description: OK @@ -34448,6 +35624,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - description: "Track the availability of our custom metric." + id: abc-123 + name: "Custom Metric SLO" + tags: + - "env:prod" + - "app:core" + thresholds: + - target: 95 + target_display: "95.0" + timeframe: 7d + type: metric + errors: [] schema: $ref: "#/components/schemas/SLOListResponse" description: OK @@ -34507,6 +35699,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + deleted: [] + updated: + - abc-123 + errors: [] schema: $ref: "#/components/schemas/SLOBulkDeleteResponse" description: OK @@ -34556,6 +35756,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + ok: + - abc-123 + errors: {} schema: $ref: "#/components/schemas/CheckCanDeleteSLOResponse" description: OK @@ -34618,6 +35825,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + category: Scheduled Maintenance + end: 1600003600 + slo_id: abc-123 + start: 1600000000 + timezone: UTC + id: abc-123 + type: correction schema: $ref: "#/components/schemas/SLOCorrectionListResponse" description: OK @@ -34672,6 +35891,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + category: Scheduled Maintenance + end: 1600003600 + slo_id: abc-123 + start: 1600000000 + timezone: UTC + id: abc-123 + type: correction schema: $ref: "#/components/schemas/SLOCorrectionResponse" description: OK @@ -34755,6 +35986,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + category: Scheduled Maintenance + end: 1600003600 + slo_id: abc-123 + start: 1600000000 + timezone: UTC + id: abc-123 + type: correction schema: $ref: "#/components/schemas/SLOCorrectionResponse" description: OK @@ -34807,6 +36050,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + category: Scheduled Maintenance + end: 1600003600 + slo_id: abc-123 + start: 1600000000 + timezone: UTC + id: abc-123 + type: correction schema: $ref: "#/components/schemas/SLOCorrectionResponse" description: OK @@ -34872,6 +36127,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + slos: + - data: + attributes: + name: Example SLO + thresholds: + - target: 95 + target_display: "95" + timeframe: 7d + id: abc-123 + type: slo + type: service_level_objective_search_results schema: $ref: "#/components/schemas/SearchSLOResponse" description: OK @@ -34926,6 +36197,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - abc-123 + errors: {} schema: $ref: "#/components/schemas/SLODeleteResponse" description: OK @@ -34982,6 +36259,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + description: "Track the availability of our custom metric." + id: abc-123 + name: "Custom Metric SLO" + tags: + - "env:prod" + thresholds: + - target: 95 + target_display: "95.0" + timeframe: 7d + type: metric + errors: [] schema: $ref: "#/components/schemas/SLOResponse" description: OK @@ -35050,6 +36342,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - description: "Updated description for the SLO." + id: abc-123 + name: "Custom Metric SLO" + tags: + - "env:prod" + thresholds: + - target: 95 + target_display: "95.0" + timeframe: 7d + type: metric + errors: [] schema: $ref: "#/components/schemas/SLOListResponse" description: OK @@ -35102,6 +36409,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + category: Scheduled Maintenance + end: 1600003600 + slo_id: abc-123 + start: 1600000000 + timezone: UTC + id: abc-123 + type: correction schema: $ref: "#/components/schemas/SLOCorrectionListResponse" description: OK @@ -35192,6 +36511,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + from_ts: 1615323990 + overall: + sli_value: 99.99 + span_precision: 2.0 + thresholds: + "7d": + target: 95 + timeframe: 7d + to_ts: 1615928790 + type: metric + type_id: 1 + errors: schema: $ref: "#/components/schemas/SLOHistoryResponse" description: OK @@ -35242,6 +36577,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + results: + - location: "aws:eu-west-3" + result_id: "abc-123" + status: passed + test_name: "Example API test" + test_public_id: "abc-def-123" + test_type: api + status: passed schema: $ref: "#/components/schemas/SyntheticsBatchDetails" description: OK @@ -35275,6 +36622,12 @@ paths: "200": content: application/json: + examples: + default: + value: + locations: + - id: "aws:eu-west-3" + name: "Paris (AWS)" schema: $ref: "#/components/schemas/SyntheticsLocations" description: OK @@ -35314,6 +36667,15 @@ paths: "200": content: application/json: + examples: + default: + value: + private_location: + description: "Description of private location" + id: "pl:new-private-location-abc-123" + name: "New private location" + tags: + - "team:front" schema: $ref: "#/components/schemas/SyntheticsPrivateLocationCreationResponse" description: OK @@ -35394,6 +36756,14 @@ paths: "200": content: application/json: + examples: + default: + value: + description: "Description of private location" + id: "pl:new-private-location-abc-123" + name: "New private location" + tags: + - "team:front" schema: $ref: "#/components/schemas/SyntheticsPrivateLocation" description: OK @@ -35447,6 +36817,14 @@ paths: "200": content: application/json: + examples: + default: + value: + description: "Description of private location" + id: "pl:new-private-location-abc-123" + name: "New private location" + tags: + - "team:front" schema: $ref: "#/components/schemas/SyntheticsPrivateLocation" description: OK @@ -35481,6 +36859,11 @@ paths: "200": content: application/json: + examples: + default: + value: + - "aws:eu-west-3" + - "aws:us-east-1" schema: $ref: "#/components/schemas/SyntheticsDefaultLocations" description: OK @@ -35517,6 +36900,19 @@ paths: "200": content: application/json: + examples: + default: + value: + tests: + - locations: + - "aws:eu-west-3" + name: "Example API test" + public_id: "abc-def-123" + status: live + subtype: http + tags: + - "env:production" + type: api schema: $ref: "#/components/schemas/SyntheticsListTestsResponse" description: OK - Returns the list of all Synthetic tests. @@ -35586,11 +36982,6 @@ paths: min_failure_duration: 0 min_location_failed: 1 monitor_options: - include_tags: true - locked: false - new_host_delay: 300 - notify_audit: false - notify_no_data: false renotify_interval: 0 tick_every: 60 status: live @@ -35711,6 +37102,32 @@ paths: "200": 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" + monitor_id: 12345678 + name: "Example API test" + options: + min_failure_duration: 0 + min_location_failed: 1 + tick_every: 60 + public_id: "abc-123-def" + status: live + subtype: http + tags: + - "env:production" + type: api schema: $ref: "#/components/schemas/SyntheticsAPITest" description: OK - Returns the created test details. @@ -35766,6 +37183,25 @@ paths: "200": content: application/json: + examples: + default: + value: + config: + request: + method: GET + url: "https://example.com" + locations: + - "aws:eu-west-3" + message: "Notification message" + name: "Example API test" + options: + tick_every: 60 + public_id: "abc-def-123" + status: live + subtype: http + tags: + - "env:production" + type: api schema: $ref: "#/components/schemas/SyntheticsAPITest" description: OK @@ -35842,6 +37278,25 @@ paths: "200": content: application/json: + examples: + default: + value: + config: + request: + method: GET + url: "https://example.com" + locations: + - "aws:eu-west-3" + message: "Notification message" + name: "Example API test" + options: + tick_every: 60 + public_id: "abc-def-123" + status: live + subtype: http + tags: + - "env:production" + type: api schema: $ref: "#/components/schemas/SyntheticsAPITest" description: OK @@ -35924,6 +37379,27 @@ paths: "200": 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 + public_id: "abc-def-123" + status: live + tags: + - "env:production" + type: browser schema: $ref: "#/components/schemas/SyntheticsBrowserTest" description: OK - Returns the created test details. @@ -35979,6 +37455,27 @@ paths: "200": 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 + public_id: "abc-def-123" + status: live + tags: + - "env:production" + type: browser schema: $ref: "#/components/schemas/SyntheticsBrowserTest" description: OK @@ -36057,6 +37554,27 @@ paths: "200": 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 + public_id: "abc-def-123" + status: live + tags: + - "env:production" + type: browser schema: $ref: "#/components/schemas/SyntheticsBrowserTest" description: OK @@ -36138,6 +37656,15 @@ paths: "200": content: application/json: + examples: + default: + value: + last_timestamp_fetched: 1706745600000 + results: + - check_time: 1706745600000 + probe_dc: "aws:eu-west-3" + result_id: "abc-123" + status: 0 schema: $ref: "#/components/schemas/SyntheticsGetBrowserTestLatestResultsResponse" description: OK @@ -36193,6 +37720,13 @@ paths: "200": content: application/json: + examples: + default: + value: + check_time: 1706745600000 + probe_dc: "aws:eu-west-3" + result_id: "abc-123" + status: 0 schema: $ref: "#/components/schemas/SyntheticsBrowserTestResultFull" description: OK @@ -36244,6 +37778,12 @@ paths: "200": content: application/json: + examples: + default: + value: + deleted_tests: + - deleted_at: "2024-01-01T00:00:00+00:00" + public_id: "abc-def-123" schema: $ref: "#/components/schemas/SyntheticsDeleteTestsResponse" description: OK. @@ -36297,13 +37837,16 @@ paths: value: config: variables: [] - device_ids: - - "synthetics:mobile:device:apple_iphone_14_ios_16" message: Notification message name: Example mobile test options: + device_ids: + - "synthetics:mobile:device:apple_iphone_14_ios_16" min_failure_duration: 0 - min_location_failed: 1 + mobileApplication: + applicationId: "abc-123" + referenceId: "abc-456" + referenceType: latest tick_every: 3600 tags: - "env:production" @@ -36316,6 +37859,26 @@ paths: "200": content: application/json: + examples: + default: + value: + config: + variables: [] + message: "Notification message" + name: "Example mobile test" + options: + device_ids: + - "synthetics:mobile:device:apple_iphone_14_ios_16" + mobileApplication: + applicationId: "abc-123" + referenceId: "abc-456" + referenceType: latest + tick_every: 3600 + public_id: "abc-def-123" + status: live + tags: + - "env:production" + type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: OK - Returns the created test details. @@ -36371,6 +37934,26 @@ paths: "200": content: application/json: + examples: + default: + value: + config: + variables: [] + message: "Notification message" + name: "Example mobile test" + options: + device_ids: + - "synthetics:mobile:device:apple_iphone_14_ios_16" + mobileApplication: + applicationId: "abc-123" + referenceId: "abc-456" + referenceType: latest + tick_every: 3600 + public_id: "abc-def-123" + status: live + tags: + - "env:production" + type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: OK @@ -36420,13 +38003,16 @@ paths: value: config: variables: [] - device_ids: - - "synthetics:mobile:device:apple_iphone_14_ios_16" message: Notification message name: Example mobile test options: + device_ids: + - "synthetics:mobile:device:apple_iphone_14_ios_16" min_failure_duration: 0 - min_location_failed: 1 + mobileApplication: + applicationId: "abc-123" + referenceId: "abc-456" + referenceType: latest tick_every: 3600 tags: - "env:production" @@ -36439,6 +38025,26 @@ paths: "200": content: application/json: + examples: + default: + value: + config: + variables: [] + message: "Notification message" + name: "Example mobile test" + options: + device_ids: + - "synthetics:mobile:device:apple_iphone_14_ios_16" + mobileApplication: + applicationId: "abc-123" + referenceId: "abc-456" + referenceType: latest + tick_every: 3600 + public_id: "abc-def-123" + status: live + tags: + - "env:production" + type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: OK @@ -36531,6 +38137,19 @@ paths: "200": content: application/json: + examples: + default: + value: + tests: + - locations: + - aws:eu-west-3 + message: Test notification + name: Example Test + public_id: abc-def-123 + status: live + tags: + - env:prod + type: api schema: $ref: "#/components/schemas/SyntheticsListTestsResponse" description: OK - Returns the list of Synthetic tests matching the search. @@ -36580,6 +38199,16 @@ paths: "200": content: application/json: + examples: + default: + value: + batch_id: abc-123 + results: + - location: 1 + public_id: "abc-def-123" + result_id: "abc-123" + triggered_check_ids: + - "abc-def-123" schema: $ref: "#/components/schemas/SyntheticsTriggerCITestsResponse" description: OK @@ -36624,6 +38253,16 @@ paths: "200": content: application/json: + examples: + default: + value: + batch_id: abc-123 + results: + - location: 1 + public_id: "abc-def-123" + result_id: "abc-123" + triggered_check_ids: + - "abc-def-123" schema: $ref: "#/components/schemas/SyntheticsTriggerCITestsResponse" description: OK @@ -36670,6 +38309,18 @@ paths: "200": content: application/json: + examples: + default: + value: + - from_ts: 1726041488 + overall: + group: "name" + history: + - [1726041488, 0] + span_precision: 2.0 + uptime: 99.99 + public_id: abc-def-123 + to_ts: 1726127888 schema: items: $ref: "#/components/schemas/SyntheticsTestUptime" @@ -36718,6 +38369,19 @@ paths: "200": content: application/json: + examples: + default: + value: + locations: + - "aws:eu-west-3" + message: "Notification message" + name: "Example test" + public_id: "abc-def-123" + status: live + subtype: http + tags: + - "env:production" + type: api schema: $ref: "#/components/schemas/SyntheticsTestDetailsWithoutSteps" description: OK @@ -36779,6 +38443,19 @@ paths: "200": content: application/json: + examples: + default: + value: + locations: + - "aws:eu-west-3" + message: "Notification message" + name: "New test name" + public_id: "abc-def-123" + status: live + subtype: http + tags: + - "env:production" + type: api schema: $ref: "#/components/schemas/SyntheticsTestDetails" description: OK @@ -36858,6 +38535,17 @@ paths: "200": content: application/json: + examples: + default: + value: + last_timestamp_fetched: 1706745600000 + results: + - check_time: 1706745600000 + probe_dc: "aws:eu-west-3" + result: + passed: true + result_id: "abc-123" + status: 0 schema: $ref: "#/components/schemas/SyntheticsGetAPITestLatestResultsResponse" description: OK @@ -36911,6 +38599,13 @@ paths: "200": content: application/json: + examples: + default: + value: + check_time: 1706745600000 + probe_dc: "aws:eu-west-3" + result_id: "abc-123" + status: 0 schema: $ref: "#/components/schemas/SyntheticsAPITestResultFull" description: OK @@ -36968,6 +38663,9 @@ paths: "200": content: application/json: + examples: + default: + value: true schema: type: boolean description: OK - Returns a boolean indicating if the update was successful. @@ -37014,6 +38712,18 @@ paths: "200": content: application/json: + examples: + default: + value: + variables: + - description: "Example description" + id: abc-123 + name: "MY_VARIABLE" + tags: + - "team:front" + value: + secure: false + value: "example-value" schema: $ref: "#/components/schemas/SyntheticsListGlobalVariablesResponse" description: OK @@ -37065,6 +38775,18 @@ paths: "200": content: application/json: + examples: + default: + value: + description: "Example description" + id: abc-123 + name: "MY_VARIABLE" + tags: + - "team:front" + - "test:workflow-1" + value: + secure: false + value: "variable-value" schema: $ref: "#/components/schemas/SyntheticsGlobalVariable" description: OK @@ -37161,6 +38883,17 @@ paths: "200": content: application/json: + examples: + default: + value: + description: "Example description" + id: abc-123 + name: "MY_VARIABLE" + tags: + - "team:front" + value: + secure: false + value: "variable-value" schema: $ref: "#/components/schemas/SyntheticsGlobalVariable" description: OK @@ -37218,6 +38951,18 @@ paths: "200": content: application/json: + examples: + default: + value: + description: "Example description" + id: abc-123 + name: "MY_VARIABLE" + tags: + - "team:front" + - "test:workflow-1" + value: + secure: false + value: "variable-value" schema: $ref: "#/components/schemas/SyntheticsGlobalVariable" description: OK @@ -37263,6 +39008,12 @@ paths: "200": content: application/json: + examples: + default: + value: + tags: + environment:production: + - test.metric.host schema: $ref: "#/components/schemas/TagToHosts" description: OK @@ -37350,6 +39101,12 @@ paths: "200": content: application/json: + examples: + default: + value: + host: test.host + tags: + - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: OK @@ -37407,6 +39164,12 @@ paths: "201": content: application/json: + examples: + default: + value: + host: test.host + tags: + - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: Created @@ -37464,6 +39227,12 @@ paths: "201": content: application/json: + examples: + default: + value: + host: test.host + tags: + - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: OK @@ -37513,6 +39282,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - analyzed_logs: 50 + hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageAnalyzedLogsResponse" description: OK @@ -37574,6 +39351,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + lines_indexed: 1000 + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageAuditLogsResponse" description: OK @@ -37633,6 +39418,15 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - func_count: 10 + hour: "2024-01-01T00:00:00+00:00" + invocations_sum: 100 + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageLambdaResponse" description: OK @@ -37692,6 +39486,17 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - account_name: Example Name + account_public_id: abc-123 + end_date: "2024-01-31T00:00:00+00:00" + num_orgs: 1 + org_name: example-handle + public_id: abc-123 + start_date: "2024-01-01T00:00:00+00:00" schema: $ref: "#/components/schemas/UsageBillableSummaryResponse" description: OK @@ -37753,6 +39558,17 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - ci_pipeline_indexed_spans: 1000 + ci_test_indexed_spans: 2000 + ci_visibility_itr_committers: 5 + ci_visibility_pipeline_committers: 3 + ci_visibility_test_committers: 10 + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageCIVisibilityResponse" description: OK @@ -37814,6 +39630,18 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - aws_host_count: 2.0 + azure_host_count: 1.0 + container_count: 10.0 + gcp_host_count: 1.0 + host_count: 5.0 + hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageCloudSecurityPostureManagementResponse" description: OK @@ -37875,6 +39703,15 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - cws_container_count: 10 + cws_host_count: 5 + hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageCWSResponse" description: OK @@ -37936,6 +39773,15 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - dbm_host_count: 5 + dbm_queries_count: 100 + hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageDBMResponse" description: OK @@ -37995,6 +39841,15 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - apm_fargate_count: 2 + hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 + tasks_count: 5 schema: $ref: "#/components/schemas/UsageFargateResponse" description: OK @@ -38054,6 +39909,19 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - agent_host_count: 1 + apm_host_count: 1 + aws_host_count: 0 + container_count: 2 + gcp_host_count: 0 + host_count: 1 + hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageHostsResponse" description: OK @@ -38159,6 +40027,20 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + metadata: + pagination: + next_record_id: + usage: + - hour: "2024-01-01T00:00:00+00:00" + org_name: "Test Org" + public_id: "abc-123" + region: "us" + total_usage_sum: 1.0 + updated_at: "2024-01-01T00:00:00+00:00" + usage_type: infra_host_usage schema: $ref: "#/components/schemas/HourlyUsageAttributionResponse" description: OK @@ -38214,6 +40096,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + monthly_active_users: 5 + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageIncidentManagementResponse" description: OK @@ -38274,6 +40164,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + indexed_events_count: 500 + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageIndexedSpansResponse" description: OK @@ -38335,6 +40233,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + ingested_events_bytes: 1000000 + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageIngestedSpansResponse" description: OK @@ -38396,6 +40302,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + iot_device_count: 100 + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageIoTResponse" description: OK @@ -38455,6 +40369,16 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - billable_ingested_bytes: 100 + hour: "2024-01-01T00:00:00+00:00" + indexed_events_count: 10 + ingested_events_bytes: 200 + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageLogsResponse" description: OK @@ -38516,6 +40440,16 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - indexed_events_count: 100 + live_indexed_events_count: 80 + org_name: example-handle + public_id: abc-123 + rehydrated_indexed_events_count: 20 + retention: "15" schema: $ref: "#/components/schemas/UsageLogsByRetentionResponse" description: OK @@ -38581,6 +40515,17 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - event_count: 1000 + hour: "2024-01-01T00:00:00+00:00" + index_id: abc-123 + index_name: main + org_name: example-handle + public_id: abc-123 + retention: 15 schema: $ref: "#/components/schemas/UsageLogsByIndexResponse" description: OK @@ -38703,6 +40648,21 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + metadata: + pagination: + next_record_id: + usage: + - month: "2024-01-01T00:00:00+00:00" + org_name: "Test Org" + public_id: "abc-123" + region: "us" + updated_at: "2024-01-01T00:00:00+00:00" + values: + infra_host_percentage: 100.0 + infra_host_usage: 1.0 schema: $ref: "#/components/schemas/MonthlyUsageAttributionResponse" description: OK @@ -38758,6 +40718,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + indexed_events_count: 200 + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageNetworkFlowsResponse" description: OK @@ -38817,6 +40785,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - host_count: 5 + hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageNetworkHostsResponse" description: OK @@ -38878,6 +40854,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + online_archive_events_count: 5000 + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageOnlineArchiveResponse" description: OK @@ -38939,6 +40923,15 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - avg_container_agent_count: 2 + host_count: 5 + hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageProfilingResponse" description: OK @@ -38998,6 +40991,15 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - browser_rum_units: 50 + mobile_rum_units: 50 + org_name: example-handle + public_id: abc-123 + rum_units: 100 schema: $ref: "#/components/schemas/UsageRumUnitsResponse" description: OK @@ -39063,6 +41065,15 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 + replay_session_count: 10 + session_count: 100 schema: $ref: "#/components/schemas/UsageRumSessionsResponse" description: OK @@ -39125,6 +41136,15 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + logs_scanned_bytes: 1000000 + org_name: example-handle + public_id: abc-123 + total_scanned_bytes: 2000000 schema: $ref: "#/components/schemas/UsageSDSResponse" description: OK @@ -39186,6 +41206,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 + snmp_devices: 10 schema: $ref: "#/components/schemas/UsageSNMPResponse" description: OK @@ -39260,6 +41288,18 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + apm_host_top99p_sum: 2 + container_avg_sum: 5 + end_date: "2024-01-31T00:00:00+00:00" + last_updated: "2024-01-01T00:00:00+00:00" + start_date: "2024-01-01T00:00:00+00:00" + usage: + - apm_host_top99p: 2 + container_avg: 5 + date: "2024-01-01T00:00:00+00:00" schema: $ref: "#/components/schemas/UsageSummaryResponse" description: OK @@ -39319,6 +41359,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - check_calls_count: 50 + hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageSyntheticsResponse" description: OK @@ -39378,6 +41426,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - check_calls_count: 50 + hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageSyntheticsAPIResponse" description: OK @@ -39437,6 +41493,14 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - browser_check_calls_count: 20 + hour: "2024-01-01T00:00:00+00:00" + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageSyntheticsBrowserResponse" description: OK @@ -39496,6 +41560,16 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + num_custom_input_timeseries: 10 + num_custom_output_timeseries: 5 + num_custom_timeseries: 100 + org_name: example-handle + public_id: abc-123 schema: $ref: "#/components/schemas/UsageTimeseriesResponse" description: OK @@ -39574,6 +41648,18 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + metadata: + month: "2024-01-01T00:00:00+00:00" + pagination: + next_record_id: + usage: + - avg_metric_hour: 5 + max_metric_hour: 10 + metric_category: custom + metric_name: test-metric schema: $ref: "#/components/schemas/UsageTopAvgMetricsResponse" description: OK @@ -39615,6 +41701,14 @@ paths: "200": content: application/json: + examples: + default: + value: + users: + - disabled: false + email: test@example.com + handle: test@example.com + name: Example Name schema: $ref: "#/components/schemas/UserListResponse" description: OK @@ -39662,6 +41756,14 @@ paths: "200": content: application/json: + examples: + default: + value: + user: + disabled: false + email: test@example.com + handle: test@example.com + name: Example Name schema: $ref: "#/components/schemas/UserResponse" description: User created @@ -39713,6 +41815,10 @@ paths: "200": content: application/json: + examples: + default: + value: + message: "User user@example.com disabled" schema: $ref: "#/components/schemas/UserDisableResponse" description: User disabled @@ -39754,6 +41860,14 @@ paths: "200": content: application/json: + examples: + default: + value: + user: + disabled: false + email: test@example.com + handle: test@example.com + name: Example Name schema: $ref: "#/components/schemas/UserResponse" description: OK for get user @@ -39805,6 +41919,14 @@ paths: "200": content: application/json: + examples: + default: + value: + user: + disabled: false + email: test@example.com + handle: test@example.com + name: Example Name schema: $ref: "#/components/schemas/UserResponse" description: User updated @@ -39840,6 +41962,10 @@ paths: "200": content: application/json: + examples: + default: + value: + valid: true schema: $ref: "#/components/schemas/AuthenticationValidationResponse" description: OK @@ -39974,6 +42100,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: type: object description: Response from server (always 200 empty JSON). diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 95a832b986b..75ed9fa7a9f 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -782,7 +782,7 @@ components: type: string LLMObsAnnotationQueueIDPathParameter: description: The ID of the LLM Observability annotation queue. - example: "b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c" + example: "00000000-0000-0000-0000-000000000001" in: path name: queue_id required: true @@ -7539,14 +7539,14 @@ components: account_id: "123456789123" bucket_name: dd-cost-bucket bucket_region: us-east-1 - created_at: 2023-01-01 12:00:00 + created_at: "2023-01-01T12:00:00.000000" error_messages: [] months: 36 report_name: dd-report-name report_prefix: dd-report-prefix status: active - status_updated_at: 2023-01-01 12:00:00 - updated_at: 2023-01-01 12:00:00 + status_updated_at: "2023-01-01T12:00:00.000000" + updated_at: "2023-01-01T12:00:00.000000" id: "123456789123" type: aws_cur_config properties: @@ -30046,7 +30046,7 @@ components: description: Type of Google Cloud Usage Cost config post request. enum: - gcp_uc_config_post_request - example: gcp_usage_cost_config_post_request + example: gcp_uc_config_post_request type: string x-enum-varnames: - GCP_USAGE_COST_CONFIG_POST_REQUEST @@ -30192,7 +30192,7 @@ components: attributes: account_id: 123456_A123BC_12AB34 bucket_name: dd-cost-bucket - created_at: 2023-01-01 12:00:00 + created_at: "2023-01-01T12:00:00.000000" dataset: billing error_messages: [] export_prefix: datadog_cloud_cost_usage_export @@ -30201,8 +30201,8 @@ components: project_id: my-project-123 service_account: dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com status: active - status_updated_at: 2023-01-01 12:00:00 - updated_at: 2023-01-01 12:00:00 + status_updated_at: "2023-01-01T12:00:00.000000" + updated_at: "2023-01-01T12:00:00.000000" id: "123456789123" type: gcp_uc_config properties: @@ -38206,7 +38206,7 @@ components: $ref: "#/components/schemas/LLMObsAnnotatedInteractionsDataAttributesResponse" id: description: The queue ID. - example: "b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c" + example: "00000000-0000-0000-0000-000000000001" type: string type: $ref: "#/components/schemas/LLMObsAnnotatedInteractionsType" @@ -38290,7 +38290,7 @@ components: type: string project_id: description: Identifier of the project this queue belongs to. - example: "a33671aa-24fd-4dcd-9b33-a8ec7dde7751" + example: "00000000-0000-0000-0000-000000000002" type: string required: - name @@ -38333,7 +38333,7 @@ components: type: string project_id: description: Identifier of the project this queue belongs to. - example: "a33671aa-24fd-4dcd-9b33-a8ec7dde7751" + example: "00000000-0000-0000-0000-000000000002" type: string required: - name @@ -38363,7 +38363,7 @@ components: $ref: "#/components/schemas/LLMObsAnnotationQueueDataAttributesResponse" id: description: Unique identifier of the annotation queue. - example: "b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c" + example: "00000000-0000-0000-0000-000000000001" type: string type: $ref: "#/components/schemas/LLMObsAnnotationQueueType" @@ -38449,7 +38449,7 @@ components: $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsDataAttributesResponse" id: description: The queue ID the interactions were added to. - example: "b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c" + example: "00000000-0000-0000-0000-000000000001" type: string type: $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsType" @@ -38497,7 +38497,7 @@ components: $ref: "#/components/schemas/LLMObsAnnotationQueueLabelSchemaAttributes" id: description: Unique identifier of the annotation queue. - example: "b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c" + example: "00000000-0000-0000-0000-000000000001" type: string type: $ref: "#/components/schemas/LLMObsAnnotationQueueType" @@ -39934,7 +39934,7 @@ components: type: boolean id: description: Unique identifier of the label schema. Assigned by the server if not provided. - example: "ab12cd34" + example: "abc-123" type: string is_assessment: description: Whether the boolean label represents an assessment. Requires `has_assessment` to be true. @@ -40973,7 +40973,7 @@ components: evaluation: fail resource: "arn:aws:s3:::my-bucket" resource_type: aws_s3_bucket - status: open + status: high id: "abc-123-xyz" type: finding meta: @@ -45512,7 +45512,7 @@ components: $ref: "#/components/schemas/MuteFindingsRequestDataAttributes" id: description: Unique identifier of the mute request. - example: "93bfeb70-af47-424d-908a-948d3f08e37f" + example: "00000000-0000-0000-0000-000000000001" type: string relationships: $ref: "#/components/schemas/MuteFindingsRequestDataRelationships" @@ -45551,7 +45551,7 @@ components: properties: id: description: Unique identifier of the mute request. - example: "93bfeb70-af47-424d-908a-948d3f08e37f" + example: "00000000-0000-0000-0000-000000000001" type: string type: $ref: "#/components/schemas/MuteDataType" @@ -63177,14 +63177,14 @@ components: type: integer riskScore: description: Current risk score for the entity - example: 85.5 - format: double - type: number + example: 85 + format: int64 + type: integer riskScoreEvolution: description: Change in risk score compared to previous period - example: 12.3 - format: double - type: number + example: 12 + format: int64 + type: integer severity: $ref: "#/components/schemas/SecurityEntityRiskScoreAttributesSeverity" signalsDetected: @@ -79369,7 +79369,7 @@ components: configs: - account_id: 1234abcd-1234-abcd-1234-1234abcd1234 client_id: 1234abcd-1234-abcd-1234-1234abcd1234 - created_at: 2023-01-01 12:00:00 + created_at: "2023-01-01T12:00:00.000000" dataset_type: actual error_messages: [] export_name: dd-actual-export @@ -79378,10 +79378,10 @@ components: months: 36 scope: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234 status: active - status_updated_at: 2023-01-01 12:00:00 + status_updated_at: "2023-01-01T12:00:00.000000" storage_account: dd-storage-account storage_container: dd-storage-container - updated_at: 2023-01-01 12:00:00 + updated_at: "2023-01-01T12:00:00.000000" id: "123456789123" type: azure_uc_configs properties: @@ -83391,6 +83391,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + version: "7.50.0" + id: "7.50.0" + type: agent_version schema: $ref: "#/components/schemas/FleetAgentVersionsResponse" description: OK @@ -83473,6 +83481,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + agents: + - agent_version: "7.50.0" + datadog_agent_key: my-agent-hostname + hostname: my-hostname + os: linux + id: done + type: status + meta: + total_filtered_count: 1 schema: $ref: "#/components/schemas/FleetAgentsResponse" description: OK @@ -83520,6 +83542,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + agent_infos: + agent_version: "7.50.0" + datadog_agent_key: my-agent-hostname + hostname: my-hostname + os: linux + id: my-agent-hostname + type: datadog_agent_key schema: $ref: "#/components/schemas/FleetAgentInfoResponse" description: OK @@ -83597,6 +83631,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tracers: + - env: production + hostname: my-hostname + language: java + service: test-service + tracer_version: "1.32.0" + id: done + type: status + meta: + total_filtered_count: 1 schema: $ref: "#/components/schemas/FleetTracersResponse" description: OK @@ -83681,6 +83730,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + clusters: + - agent_versions: + - "7.50.0" + cluster_name: production-us-east-1 + enabled_products: + - apm + node_count: 25 + id: done + type: status + meta: + total_filtered_count: 1 schema: $ref: "#/components/schemas/FleetClustersResponse" description: OK @@ -83728,6 +83793,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + groups: + - kube_ownerref_kind: Deployment + kube_ownerref_name: inventory-service + namespace: default + pod_count: 3 + id: production-us-east-1 + type: cluster_name schema: $ref: "#/components/schemas/FleetInstrumentedPodsResponse" description: OK @@ -83782,6 +83859,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + filter_query: "env:prod AND service:web" + high_level_status: running + total_hosts: 10 + id: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + type: deployment + meta: + page: + total_count: 1 schema: $ref: "#/components/schemas/FleetDeploymentsResponse" description: OK @@ -84035,6 +84125,21 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + config_operations: + - file_op: merge-patch + file_path: /datadog.yaml + patch: + log_level: info + filter_query: env:prod AND service:web + high_level_status: pending + total_hosts: 42 + id: abc-123 + type: deployment schema: $ref: "#/components/schemas/FleetDeploymentResponse" description: CREATED @@ -84117,6 +84222,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + filter_query: "env:prod AND service:web" + high_level_status: pending + total_hosts: 0 + id: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + type: deployment schema: $ref: "#/components/schemas/FleetDeploymentResponse" description: CREATED @@ -84197,6 +84312,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + filter_query: "env:prod AND service:web" + high_level_status: running + total_hosts: 10 + id: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + type: deployment schema: $ref: "#/components/schemas/FleetDeploymentResponse" description: OK @@ -84283,6 +84408,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at_unix: 1699999999 + created_by: test@example.com + name: Weekly Production Agent Updates + query: env:prod AND service:web + rule: + days_of_week: + - Mon + - Wed + maintenance_window_duration: 120 + start_maintenance_window: "02:00" + timezone: America/New_York + status: active + updated_at_unix: 1699999999 + updated_by: test@example.com + version_to_latest: 0 + id: abc-def-ghi-123 + type: schedule schema: $ref: "#/components/schemas/FleetSchedulesResponse" description: OK @@ -84378,6 +84525,24 @@ paths: "201": content: application/json: + examples: + 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 + id: abc-123 + type: schedule schema: $ref: "#/components/schemas/FleetScheduleResponse" description: CREATED @@ -84472,6 +84637,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at_unix: 1699999999 + created_by: test@example.com + name: Weekly Production Agent Updates + query: env:prod AND service:web + rule: + days_of_week: + - Mon + - Wed + maintenance_window_duration: 120 + start_maintenance_window: "02:00" + timezone: America/New_York + status: active + updated_at_unix: 1699999999 + updated_by: test@example.com + version_to_latest: 0 + id: abc-def-ghi-123 + type: schedule schema: $ref: "#/components/schemas/FleetScheduleResponse" description: OK @@ -84563,6 +84750,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at_unix: 1699999999 + created_by: test@example.com + name: Weekly Production Agent Updates + query: env:prod AND service:web + rule: + days_of_week: + - Mon + - Wed + maintenance_window_duration: 120 + start_maintenance_window: "02:00" + timezone: America/New_York + status: inactive + updated_at_unix: 1699999999 + updated_by: test@example.com + version_to_latest: 0 + id: abc-def-ghi-123 + type: schedule schema: $ref: "#/components/schemas/FleetScheduleResponse" description: OK @@ -84621,6 +84830,19 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + filter_query: env:prod AND service:web + high_level_status: pending + packages: + - name: datadog-agent + version: 7.52.0 + total_hosts: 10 + id: abc-123 + type: deployment schema: $ref: "#/components/schemas/FleetDeploymentResponse" description: CREATED - Deployment successfully created and started. @@ -84701,6 +84923,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tracers: + - env: production + hostname: my-hostname + language: java + service: test-service + tracer_version: "1.32.0" + id: done + type: status + meta: + total_filtered_count: 1 schema: $ref: "#/components/schemas/FleetTracersResponse" description: OK @@ -84966,6 +85203,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: A sample datastore + modified_at: "2024-01-01T00:00:00+00:00" + name: Example Datastore + org_id: 123 + primary_column_name: id + primary_key_generation_strategy: none + id: 00000000-0000-0000-0000-000000000001 + type: datastores schema: $ref: "#/components/schemas/DatastoreArray" description: OK @@ -85001,6 +85252,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000002 + type: datastores schema: $ref: "#/components/schemas/CreateAppsDatastoreResponse" description: OK @@ -85062,6 +85319,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: A sample datastore + modified_at: "2024-01-01T00:00:00+00:00" + name: Example Datastore + org_id: 123 + primary_column_name: id + primary_key_generation_strategy: none + id: 00000000-0000-0000-0000-000000000003 + type: datastores schema: $ref: "#/components/schemas/Datastore" description: OK @@ -85111,6 +85382,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: An updated datastore + modified_at: "2024-01-01T00:00:00+00:00" + name: Updated Datastore + org_id: 123 + primary_column_name: id + primary_key_generation_strategy: none + id: 00000000-0000-0000-0000-000000000004 + type: datastores schema: $ref: "#/components/schemas/Datastore" description: OK @@ -85164,6 +85449,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000007 + type: items schema: $ref: "#/components/schemas/DeleteAppsDatastoreItemResponse" description: OK @@ -85233,6 +85524,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + modified_at: "2024-01-01T00:00:00+00:00" + org_id: 123 + primary_column_name: id + store_id: 00000000-0000-0000-0000-000000000006 + value: + key: example-value + id: 00000000-0000-0000-0000-000000000005 + type: items schema: $ref: "#/components/schemas/ItemApiPayloadArray" description: OK @@ -85288,6 +85593,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + modified_at: "2024-01-01T00:00:00+00:00" + org_id: 123 + primary_column_name: id + store_id: 00000000-0000-0000-0000-000000000009 + value: + count: 42 + status: active + id: 00000000-0000-0000-0000-000000000008 + type: items schema: $ref: "#/components/schemas/ItemApiPayload" description: OK @@ -85339,6 +85659,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: 00000000-0000-0000-0000-000000000010 + type: items schema: $ref: "#/components/schemas/DeleteAppsDatastoreItemResponseArray" description: OK @@ -85402,6 +85728,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: 00000000-0000-0000-0000-000000000011 + type: items schema: $ref: "#/components/schemas/PutAppsDatastoreItemResponseArray" description: OK @@ -85449,6 +85781,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: 00000000-0000-0000-0000-000000000001 + type: app_key_registration + meta: + total: 1 + total_filtered: 1 schema: $ref: "#/components/schemas/ListAppKeyRegistrationsResponse" description: OK @@ -85528,6 +85869,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000001 + type: app_key_registration schema: $ref: "#/components/schemas/GetAppKeyRegistrationResponse" description: OK @@ -85571,6 +85918,12 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000001 + type: app_key_registration schema: $ref: "#/components/schemas/RegisterAppKeyResponse" description: Created @@ -85628,6 +85981,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + integration: + type: AWS + name: My AWS Connection + id: 00000000-0000-0000-0000-000000000001 + type: action_connection schema: $ref: "#/components/schemas/CreateActionConnectionResponse" description: Successfully created Action Connection @@ -85695,6 +86058,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + integration: + type: AWS + name: My AWS Connection + id: 00000000-0000-0000-0000-000000000002 + type: action_connection schema: $ref: "#/components/schemas/GetActionConnectionResponse" description: Successfully get Action Connection @@ -85750,6 +86123,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + integration: + type: AWS + name: My AWS Connection + id: 00000000-0000-0000-0000-000000000003 + type: action_connection schema: $ref: "#/components/schemas/UpdateActionConnectionResponse" description: Successfully updated Action Connection @@ -85788,6 +86171,17 @@ paths: "200": 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/AwsScanOptionsListResponse" description: OK @@ -85827,6 +86221,17 @@ paths: "201": 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/AwsScanOptionsResponse" description: Agentless scan options enabled successfully. @@ -85879,6 +86284,17 @@ paths: "200": 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/AwsScanOptionsResponse" description: OK @@ -85947,6 +86363,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + vuln_containers_os: true + vuln_host_os: true + id: 00000000-0000-0000-0000-000000000001 + type: azure_scan_options schema: $ref: "#/components/schemas/AzureScanOptionsArray" description: OK @@ -85982,6 +86407,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + vuln_containers_os: true + vuln_host_os: true + id: 00000000-0000-0000-0000-000000000001 + type: azure_scan_options schema: $ref: "#/components/schemas/AzureScanOptions" description: Created @@ -86035,6 +86469,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + vuln_containers_os: true + vuln_host_os: true + id: 00000000-0000-0000-0000-000000000001 + type: azure_scan_options schema: $ref: "#/components/schemas/AzureScanOptions" description: OK @@ -86082,6 +86525,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + vuln_containers_os: false + vuln_host_os: true + id: 00000000-0000-0000-0000-000000000001 + type: azure_scan_options schema: $ref: "#/components/schemas/AzureScanOptions" description: OK @@ -86103,6 +86555,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + vuln_containers_os: true + vuln_host_os: true + id: abc-123 + type: gcp_scan_options schema: $ref: "#/components/schemas/GcpScanOptionsArray" description: OK @@ -86141,6 +86602,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + vuln_containers_os: true + vuln_host_os: true + id: abc-123 + type: gcp_scan_options schema: $ref: "#/components/schemas/GcpScanOptions" description: Agentless scan options enabled successfully. @@ -86207,6 +86677,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + vuln_containers_os: true + vuln_host_os: true + id: abc-123 + type: gcp_scan_options schema: $ref: "#/components/schemas/GcpScanOptions" description: OK @@ -86256,6 +86735,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + vuln_containers_os: true + vuln_host_os: true + id: abc-123 + type: gcp_scan_options schema: $ref: "#/components/schemas/GcpScanOptions" description: OK @@ -86284,6 +86772,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + arn: "arn:aws:ec2:us-east-1:123456789012:instance/i-0eabb50529b67a1ba" + assigned_at: "2024-01-01T00:00:00+00:00" + created_at: "2024-01-01T00:00:00+00:00" + status: QUEUED + id: abc-123 + type: aws_resource schema: $ref: "#/components/schemas/AwsOnDemandListResponse" description: OK @@ -86323,6 +86822,16 @@ paths: "201": content: "application/json": + examples: + default: + value: + data: + attributes: + arn: "arn:aws:ec2:us-east-1:123456789012:instance/i-0eabb50529b67a1ba" + created_at: "2024-01-01T00:00:00+00:00" + status: QUEUED + id: abc-123 + type: aws_resource schema: $ref: "#/components/schemas/AwsOnDemandResponse" description: AWS on demand task created successfully. @@ -86354,6 +86863,17 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + arn: "arn:aws:ec2:us-east-1:123456789012:instance/i-0eabb50529b67a1ba" + assigned_at: "2024-01-01T00:00:00+00:00" + created_at: "2024-01-01T00:00:00+00:00" + status: ASSIGNED + id: abc-123 + type: aws_resource schema: $ref: "#/components/schemas/AwsOnDemandResponse" description: OK. @@ -86400,6 +86920,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: anonymize_users_response schema: $ref: "#/components/schemas/AnonymizeUsersResponse" description: OK @@ -86451,6 +86977,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + last4: abcd + modified_at: "2024-01-01T00:00:00+00:00" + name: API Key for submitting metrics + id: 00000000-0000-0000-0000-000000000001 + type: api_keys schema: $ref: "#/components/schemas/APIKeysResponse" description: OK @@ -86495,6 +87032,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + last4: abcd + modified_at: "2024-01-01T00:00:00+00:00" + name: API Key for submitting metrics + id: 00000000-0000-0000-0000-000000000002 + type: api_keys schema: $ref: "#/components/schemas/APIKeyResponse" description: Created @@ -86560,6 +87108,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + last4: abcd + modified_at: "2024-01-01T00:00:00+00:00" + name: API Key for submitting metrics + id: 00000000-0000-0000-0000-000000000003 + type: api_keys schema: $ref: "#/components/schemas/APIKeyResponse" description: OK @@ -86607,6 +87166,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + last4: abcd + modified_at: "2024-01-01T00:00:00+00:00" + name: API Key for submitting metrics + id: 00000000-0000-0000-0000-000000000004 + type: api_keys schema: $ref: "#/components/schemas/APIKeyResponse" description: OK @@ -86673,6 +87243,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: Payments API + id: abc-123 + meta: + pagination: + limit: 20 + offset: 0 + total_count: 1 schema: $ref: "#/components/schemas/ListAPIsResponse" description: OK @@ -86767,6 +87349,9 @@ paths: "200": content: multipart/form-data: + examples: + default: + value: openapi-spec.yaml schema: format: binary type: string @@ -86831,6 +87416,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + failed_endpoints: [] + id: abc-123 schema: $ref: "#/components/schemas/UpdateOpenAPIResponse" description: API updated successfully @@ -86890,6 +87482,13 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + failed_endpoints: [] + id: abc-123 schema: $ref: "#/components/schemas/CreateOpenAPIResponse" description: API created successfully @@ -86928,6 +87527,22 @@ paths: "200": 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/SpansMetricsResponse" description: OK @@ -86974,6 +87589,22 @@ paths: "200": 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/SpansMetricResponse" description: OK @@ -87024,6 +87655,22 @@ paths: "200": 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/SpansMetricResponse" description: OK @@ -87071,6 +87718,22 @@ paths: "200": 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/SpansMetricResponse" description: OK @@ -87098,6 +87761,19 @@ paths: "200": 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 + id: abc-123 + type: apm_retention_filter schema: $ref: "#/components/schemas/RetentionFiltersResponse" description: OK @@ -87143,6 +87819,19 @@ paths: "200": 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 + id: abc-123 + type: apm_retention_filter schema: $ref: "#/components/schemas/RetentionFilterCreateResponse" description: OK @@ -87230,6 +87919,19 @@ paths: "200": 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 + id: abc-123 + type: apm_retention_filter schema: $ref: "#/components/schemas/RetentionFilterResponse" description: OK @@ -87279,6 +87981,19 @@ paths: "200": 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 + id: abc-123 + type: apm_retention_filter schema: $ref: "#/components/schemas/RetentionFilterResponse" description: OK @@ -87312,6 +88027,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + metadata: + - isTraced: true + isUsm: false + services: + - test-service + id: abc-123 + type: services_list schema: $ref: "#/components/schemas/ServiceList" description: OK @@ -87349,6 +88076,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: 00000000-0000-0000-0000-000000000001 + type: appDefinitions schema: $ref: "#/components/schemas/DeleteAppsResponse" description: OK @@ -87461,6 +88194,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: A sample app + favorite: false + name: My App + selfService: false + tags: + - "team:webshop" + id: 00000000-0000-0000-0000-000000000001 + type: appDefinitions + meta: + page: + totalCount: 1 + totalFilteredCount: 1 schema: $ref: "#/components/schemas/ListAppsResponse" description: OK @@ -87509,6 +88259,12 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000001 + type: appDefinitions schema: $ref: "#/components/schemas/CreateAppResponse" description: Created @@ -87552,6 +88308,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000002 + type: appDefinitions schema: $ref: "#/components/schemas/DeleteAppResponse" description: OK @@ -87610,6 +88372,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + components: [] + description: A sample app + name: Example App + queries: [] + rootInstanceName: grid0 + id: 00000000-0000-0000-0000-000000000001 + type: appDefinitions schema: $ref: "#/components/schemas/GetAppResponse" description: OK @@ -87681,6 +88455,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + components: [] + description: This is a simple example app + name: Example App + queries: [] + rootInstanceName: grid0 + id: 00000000-0000-0000-0000-000000000001 + type: appDefinitions schema: $ref: "#/components/schemas/UpdateAppResponse" description: OK @@ -87724,6 +88510,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + app_version_id: 00000000-0000-0000-0000-000000000000 + id: 00000000-0000-0000-0000-000000000001 + type: deployment schema: $ref: "#/components/schemas/UnpublishAppResponse" description: OK @@ -87770,6 +88564,14 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + app_version_id: 00000000-0000-0000-0000-000000000001 + id: 00000000-0000-0000-0000-000000000001 + type: deployment schema: $ref: "#/components/schemas/PublishAppResponse" description: Created @@ -87816,6 +88618,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2020-11-23T10:00:00.000Z" + last4: abcd + name: Application Key for managing dashboards + id: 00000000-0000-0000-0000-000000000001 + type: application_keys schema: $ref: "#/components/schemas/ListApplicationKeysResponse" description: OK @@ -87887,6 +88699,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2020-11-23T10:00:00.000Z" + last4: abcd + name: Application Key for managing dashboards + id: 00000000-0000-0000-0000-000000000002 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -87944,6 +88766,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2020-11-23T10:00:00.000Z" + last4: abcd + name: Application Key for managing dashboards + id: 00000000-0000-0000-0000-000000000003 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -88037,6 +88869,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + message: "User logged in" + service: web-app + tags: + - "team:A" + timestamp: "2024-01-01T00:00:00+00:00" + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: audit + meta: + elapsed: 132 + request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + status: done schema: $ref: "#/components/schemas/AuditLogsEventsResponse" description: OK @@ -88090,6 +88938,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + message: "User logged in" + service: web-app + tags: + - team:A + timestamp: "2019-01-02T09:42:36.320Z" + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: audit + links: + next: "https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" + meta: + elapsed: 132 + request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + status: done schema: $ref: "#/components/schemas/AuditLogsEventsResponse" description: OK @@ -88139,6 +89005,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + attribute_key: member-of + attribute_value: Development + id: 00000000-0000-0000-0000-000000000003 + type: authn_mappings schema: $ref: "#/components/schemas/AuthNMappingsResponse" description: OK @@ -88178,6 +89053,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attribute_key: member-of + attribute_value: Development + id: 00000000-0000-0000-0000-000000000004 + type: authn_mappings schema: $ref: "#/components/schemas/AuthNMappingResponse" description: OK @@ -88248,6 +89132,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attribute_key: member-of + attribute_value: Development + id: 00000000-0000-0000-0000-000000000001 + type: authn_mappings schema: $ref: "#/components/schemas/AuthNMappingResponse" description: OK @@ -88296,6 +89189,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attribute_key: member-of + attribute_value: Development + id: 00000000-0000-0000-0000-000000000002 + type: authn_mappings schema: $ref: "#/components/schemas/AuthNMappingResponse" description: OK @@ -88573,6 +89475,29 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case + meta: + page: + current: 1 + size: 10 + total: 1 schema: $ref: "#/components/schemas/CasesResponse" description: OK @@ -88632,6 +89557,24 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: CREATED @@ -88662,6 +89605,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + key: SEC + name: Security Investigation + id: 00000000-0000-0000-0000-000000000002 + type: project schema: $ref: "#/components/schemas/ProjectsResponse" description: OK @@ -88705,6 +89657,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + key: SEC + name: Security Investigation + id: 00000000-0000-0000-0000-000000000001 + type: project schema: $ref: "#/components/schemas/ProjectResponse" description: CREATED @@ -88763,6 +89724,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + key: SEC + name: Security Investigation + id: 00000000-0000-0000-0000-000000000003 + type: project schema: $ref: "#/components/schemas/ProjectResponse" description: OK @@ -88806,6 +89776,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + key: SEC + name: Security Investigation + id: 00000000-0000-0000-0000-000000000004 + type: project schema: $ref: "#/components/schemas/ProjectResponse" description: OK @@ -88844,6 +89823,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + is_enabled: true + query: "" + recipients: + - data: + email: test@example.com + type: EMAIL + triggers: + - data: {} + type: CASE_CREATED + id: 00000000-0000-0000-0000-000000000001 + type: notification_rule schema: $ref: "#/components/schemas/CaseNotificationRulesResponse" description: OK @@ -88897,6 +89892,22 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + is_enabled: true + query: "" + recipients: + - data: + email: test@example.com + type: EMAIL + triggers: + - data: {} + type: CASE_CREATED + id: 00000000-0000-0000-0000-000000000002 + type: notification_rule schema: $ref: "#/components/schemas/CaseNotificationRuleResponse" description: CREATED @@ -89011,6 +90022,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: Investigations done in case management + emoji: "🕵🏻‍♂️" + name: Investigation + id: 00000000-0000-0000-0000-000000000001 + type: case_type schema: $ref: "#/components/schemas/CaseTypesResponse" description: OK @@ -89046,6 +90067,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + description: Investigations done in case management + emoji: "🕵🏻‍♂️" + name: Investigation + id: 00000000-0000-0000-0000-000000000001 + type: case_type schema: $ref: "#/components/schemas/CaseTypeResponse" description: CREATED @@ -89068,6 +90099,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + case_type_id: 00000000-0000-0000-0000-000000000002 + description: "AWS Region, must be a valid region supported by AWS" + display_name: AWS Region + is_multi: true + key: aws_region + type: TEXT + id: 00000000-0000-0000-0000-000000000001 + type: custom_attribute schema: $ref: "#/components/schemas/CustomAttributeConfigsResponse" description: OK @@ -89108,6 +90152,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + case_type_id: 00000000-0000-0000-0000-000000000004 + description: "AWS Region, must be a valid region supported by AWS" + display_name: AWS Region + is_multi: true + key: aws_region + type: TEXT + id: 00000000-0000-0000-0000-000000000003 + type: custom_attribute schema: $ref: "#/components/schemas/CustomAttributeConfigsResponse" description: OK @@ -89149,6 +90206,19 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + case_type_id: 00000000-0000-0000-0000-000000000006 + description: "AWS Region, must be a valid region supported by AWS" + display_name: AWS Region + is_multi: true + key: aws_region + type: TEXT + id: 00000000-0000-0000-0000-000000000005 + type: custom_attribute schema: $ref: "#/components/schemas/CustomAttributeConfigResponse" description: CREATED @@ -89197,6 +90267,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -89240,6 +90328,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -89285,6 +90391,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -89337,6 +90461,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -89382,6 +90524,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + cell_content: + message: This is my comment ! + created_at: "2024-01-01T00:00:00+00:00" + type: COMMENT + id: 00000000-0000-0000-0000-000000000001 + type: timeline_cell schema: $ref: "#/components/schemas/TimelineResponse" description: OK @@ -89432,6 +90585,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -89477,6 +90648,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -89522,6 +90711,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -89567,6 +90774,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -89611,6 +90836,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + key: CASEM-4523 + priority: NOT_DEFINED + status: OPEN + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000002 + type: case schema: $ref: "#/components/schemas/CaseResponse" description: Created @@ -89905,6 +91141,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + key: CASEM-4523 + priority: NOT_DEFINED + status: OPEN + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -90031,6 +91278,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -90076,6 +91341,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -90119,6 +91402,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -90162,6 +91463,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: 00000000-0000-0000-0000-000000000001 + relationships: + project: + data: + id: 00000000-0000-0000-0000-000000000002 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -90217,6 +91536,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + apiVersion: v3 + kind: service + name: myService + namespace: default + id: 4b163705-23c0-4573-b2fb-f6cea2163fcb + type: entity + meta: + count: 1 + includeCount: 0 schema: $ref: "#/components/schemas/ListEntityCatalogResponse" description: OK @@ -90277,6 +91610,20 @@ paths: "202": content: application/json: + examples: + default: + value: + data: + - attributes: + apiVersion: v3 + kind: service + name: myService + namespace: default + id: 4b163705-23c0-4573-b2fb-f6cea2163fcb + type: entity + meta: + count: 1 + includeCount: 0 schema: $ref: "#/components/schemas/UpsertCatalogEntityResponse" description: ACCEPTED @@ -90302,6 +91649,12 @@ paths: "202": content: application/json: + examples: + default: + value: + data: + - id: 4b163705-23c0-4573-b2fb-f6cea2163fcb + type: entity schema: $ref: "#/components/schemas/EntityResponseArray" description: Accepted @@ -90361,6 +91714,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: A job entity in the catalog. + displayName: My Job + name: my-job + id: 4b163705-23c0-4573-b2fb-f6cea2163fcb + type: kind + meta: + count: 1 schema: $ref: "#/components/schemas/ListKindCatalogResponse" description: OK @@ -90400,6 +91765,18 @@ paths: "202": content: application/json: + examples: + default: + value: + data: + - attributes: + description: A job entity in the catalog. + displayName: My Job + name: my-job + id: 4b163705-23c0-4573-b2fb-f6cea2163fcb + type: kind + meta: + count: 1 schema: $ref: "#/components/schemas/UpsertCatalogKindResponse" description: ACCEPTED @@ -90473,6 +91850,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + from: + kind: service + name: test-service + to: + kind: service + name: other-service + type: RelationTypeOwns + id: abc-123 + type: relation + meta: + count: 1 schema: $ref: "#/components/schemas/ListRelationCatalogResponse" description: OK @@ -90525,6 +91918,43 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + attributes: {} + change_request_linked_incident_uuid: "" + change_request_maintenance_window_query: "" + change_request_plan: "" + change_request_risk: LOW + change_request_type: NORMAL + created_at: "2024-01-01T00:00:00+00:00" + creation_source: CS_MANUAL + description: Deploying new payment service v2.1 + end_date: "2024-01-02T00:00:00+00:00" + key: CHM-1234 + modified_at: "2024-01-01T00:00:00+00:00" + plan_notebook_id: 0 + priority: NOT_DEFINED + project_id: 00000000-0000-0000-0000-000000000001 + start_date: "2024-01-01T00:00:00+00:00" + status: OPEN + title: Deploy new payment service + type: CHANGE_REQUEST + id: CHM-1234 + relationships: + change_request_decisions: + data: [] + created_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + modified_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + type: change_request schema: $ref: "#/components/schemas/ChangeRequestResponse" description: Created @@ -90563,6 +91993,43 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attributes: {} + change_request_linked_incident_uuid: "" + change_request_maintenance_window_query: "" + change_request_plan: "" + change_request_risk: LOW + change_request_type: NORMAL + created_at: "2024-01-01T00:00:00+00:00" + creation_source: CS_MANUAL + description: Deploying new payment service v2.1 + end_date: "2024-01-02T00:00:00+00:00" + key: CHM-1234 + modified_at: "2024-01-01T00:00:00+00:00" + plan_notebook_id: 0 + priority: NOT_DEFINED + project_id: 00000000-0000-0000-0000-000000000001 + start_date: "2024-01-01T00:00:00+00:00" + status: OPEN + title: Deploy new payment service + type: CHANGE_REQUEST + id: CHM-1234 + relationships: + change_request_decisions: + data: [] + created_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + modified_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + type: change_request schema: $ref: "#/components/schemas/ChangeRequestResponse" description: OK @@ -90629,6 +92096,43 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attributes: {} + change_request_linked_incident_uuid: "" + change_request_maintenance_window_query: "" + change_request_plan: "" + change_request_risk: LOW + change_request_type: NORMAL + created_at: "2024-01-01T00:00:00+00:00" + creation_source: CS_MANUAL + description: Deploying new payment service v2.1 + end_date: "2024-01-02T00:00:00+00:00" + key: CHM-1234 + modified_at: "2024-01-01T00:00:00+00:00" + plan_notebook_id: 0 + priority: NOT_DEFINED + project_id: 00000000-0000-0000-0000-000000000001 + start_date: "2024-01-01T00:00:00+00:00" + status: OPEN + title: Deploy new payment service + type: CHANGE_REQUEST + id: CHM-1234 + relationships: + change_request_decisions: + data: [] + created_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + modified_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + type: change_request schema: $ref: "#/components/schemas/ChangeRequestResponse" description: OK @@ -90688,6 +92192,43 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attributes: {} + change_request_linked_incident_uuid: "" + change_request_maintenance_window_query: "" + change_request_plan: "" + change_request_risk: LOW + change_request_type: NORMAL + created_at: "2024-01-01T00:00:00+00:00" + creation_source: CS_MANUAL + description: Deploying new payment service v2.1 + end_date: "2024-01-02T00:00:00+00:00" + key: CHM-1234 + modified_at: "2024-01-01T00:00:00+00:00" + plan_notebook_id: 0 + priority: NOT_DEFINED + project_id: 00000000-0000-0000-0000-000000000001 + start_date: "2024-01-01T00:00:00+00:00" + status: OPEN + title: Deploy new payment service + type: CHANGE_REQUEST + id: CHM-1234 + relationships: + change_request_decisions: + data: [] + created_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + modified_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + type: change_request schema: $ref: "#/components/schemas/ChangeRequestResponse" description: OK @@ -90727,6 +92268,43 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attributes: {} + change_request_linked_incident_uuid: "" + change_request_maintenance_window_query: "" + change_request_plan: "" + change_request_risk: LOW + change_request_type: NORMAL + created_at: "2024-01-01T00:00:00+00:00" + creation_source: CS_MANUAL + description: Deploying new payment service v2.1 + end_date: "2024-01-02T00:00:00+00:00" + key: CHM-1234 + modified_at: "2024-01-01T00:00:00+00:00" + plan_notebook_id: 0 + priority: NOT_DEFINED + project_id: 00000000-0000-0000-0000-000000000001 + start_date: "2024-01-01T00:00:00+00:00" + status: OPEN + title: Deploy new payment service + type: CHANGE_REQUEST + id: CHM-1234 + relationships: + change_request_decisions: + data: [] + created_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + modified_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + type: change_request schema: $ref: "#/components/schemas/ChangeRequestResponse" description: OK @@ -90789,6 +92367,43 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attributes: {} + change_request_linked_incident_uuid: "" + change_request_maintenance_window_query: "" + change_request_plan: "" + change_request_risk: LOW + change_request_type: NORMAL + created_at: "2024-01-01T00:00:00+00:00" + creation_source: CS_MANUAL + description: Deploying new payment service v2.1 + end_date: "2024-01-02T00:00:00+00:00" + key: CHM-1234 + modified_at: "2024-01-01T00:00:00+00:00" + plan_notebook_id: 0 + priority: NOT_DEFINED + project_id: 00000000-0000-0000-0000-000000000001 + start_date: "2024-01-01T00:00:00+00:00" + status: OPEN + title: Deploy new payment service + type: CHANGE_REQUEST + id: CHM-1234 + relationships: + change_request_decisions: + data: [] + created_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + modified_by: + data: + id: 00000000-0000-0000-0000-000000000001 + type: user + type: change_request schema: $ref: "#/components/schemas/ChangeRequestResponse" description: OK @@ -90856,6 +92471,9 @@ paths: "202": content: application/json: + examples: + default: + value: {} schema: type: object description: Request accepted for processing @@ -90950,6 +92568,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + buckets: + - by: + "@ci.status": error + computes: + pc90: + - time: "2020-06-08T11:55:00.123Z" + value: 2345 schema: $ref: "#/components/schemas/CIAppPipelinesAnalyticsAggregateResponse" description: OK @@ -91031,6 +92660,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] + meta: + page: {} schema: $ref: "#/components/schemas/CIAppPipelineEventsResponse" description: OK @@ -91087,6 +92722,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + attributes: + duration: 2345 + ci_level: pipeline + tags: + - team:backend + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: cipipeline + meta: + elapsed: 132 + request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + status: done schema: $ref: "#/components/schemas/CIAppPipelineEventsResponse" description: OK @@ -91157,6 +92808,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + repository_id: github.com/datadog/test-service + id: github.com/datadog/test-service + type: test_optimization_flaky_tests_management_policies schema: $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesResponse" description: OK @@ -91201,6 +92860,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + repository_id: github.com/datadog/test-service + id: github.com/datadog/test-service + type: test_optimization_flaky_tests_management_policies schema: $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesResponse" description: OK @@ -91297,6 +92964,22 @@ paths: "200": 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/test-service + service_name: test-service + test_impact_analysis_enabled: false + id: github.com/datadog/test-service::test-service::prod + type: test_optimization_service_settings schema: $ref: "#/components/schemas/TestOptimizationServiceSettingsResponse" description: OK @@ -91343,6 +93026,22 @@ paths: "200": 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/test-service + service_name: test-service + test_impact_analysis_enabled: false + id: github.com/datadog/test-service::test-service::prod + type: test_optimization_service_settings schema: $ref: "#/components/schemas/TestOptimizationServiceSettingsResponse" description: OK @@ -91404,6 +93103,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + buckets: + - by: + "@test.service": web-tests + computes: + pc90: + - time: "2020-06-08T11:55:00.123Z" + value: 2345 schema: $ref: "#/components/schemas/CIAppTestsAnalyticsAggregateResponse" description: OK @@ -91488,6 +93198,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] + meta: + page: {} schema: $ref: "#/components/schemas/CIAppTestEventsResponse" description: OK @@ -91547,6 +93263,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + attributes: + duration: 2345 + tags: + - team:backend + test_level: test + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: citest + links: + next: https://app.datadoghq.com/api/v2/ci/tests/events?page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + meta: + elapsed: 132 + request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + status: done schema: $ref: "#/components/schemas/CIAppTestEventsResponse" description: OK @@ -91584,6 +93318,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + account_identifier: test@example.com + account_uuid: 00000000-0000-0000-0000-000000000001 + arn_pattern: "arn:aws:iam::123456789012:user/testuser" + id: abc-123 + type: aws_cloud_auth_config schema: $ref: "#/components/schemas/AWSCloudAuthPersonaMappingsResponse" description: OK @@ -91628,6 +93372,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + account_identifier: test@example.com + account_uuid: 00000000-0000-0000-0000-000000000001 + arn_pattern: "arn:aws:iam::123456789012:user/testuser" + id: abc-123 + type: aws_cloud_auth_config schema: $ref: "#/components/schemas/AWSCloudAuthPersonaMappingResponse" description: Created @@ -91696,6 +93450,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + account_identifier: test@example.com + account_uuid: 00000000-0000-0000-0000-000000000001 + arn_pattern: "arn:aws:iam::123456789012:user/testuser" + id: abc-123 + type: aws_cloud_auth_config schema: $ref: "#/components/schemas/AWSCloudAuthPersonaMappingResponse" description: OK @@ -91748,6 +93512,15 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + handle: sec2 + version: "2" + id: sec2-2 + type: custom_framework schema: $ref: "#/components/schemas/CreateCustomFrameworkResponse" description: OK @@ -91784,6 +93557,16 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + handle: sec2 + name: security-framework + version: "2" + id: sec2-2 + type: custom_framework schema: $ref: "#/components/schemas/DeleteCustomFrameworkResponse" description: OK @@ -91817,6 +93600,22 @@ paths: "200": 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" + id: sec2-2 + type: custom_framework schema: $ref: "#/components/schemas/GetCustomFrameworkResponse" description: OK @@ -91869,6 +93668,15 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + handle: sec2 + version: "2" + id: sec2-2 + type: custom_framework schema: $ref: "#/components/schemas/UpdateCustomFrameworkResponse" description: OK @@ -91904,6 +93712,17 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + cloud_provider: + aws: + "123456789": + - environment:production + id: csm_resource_filter + type: csm_resource_filter schema: $ref: "#/components/schemas/GetResourceEvaluationFiltersResponse" description: OK @@ -91954,6 +93773,17 @@ paths: "201": content: "application/json": + examples: + default: + value: + data: + attributes: + cloud_provider: + aws: + "123456789": + - environment:production + id: csm_resource_filter + type: csm_resource_filter schema: $ref: "#/components/schemas/UpdateResourceEvaluationFiltersResponse" description: OK @@ -92004,6 +93834,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + aws_account_id: "123456789012" + aws_bucket_name: my-inventory-bucket + aws_region: us-east-1 + id: aws + type: sync_configs schema: $ref: "#/components/schemas/CloudInventorySyncConfigResponse" description: OK @@ -92053,6 +93893,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + evaluated_flags_count: 8 + evaluated_reports_count: 12 + patch_coverage: 70.1 + total_coverage: 82.4 + id: ZGQxMjM0NV9tYWluXzE3MDk1NjQwMDA= + type: ci_app_coverage_summary schema: $ref: "#/components/schemas/CoverageSummaryResponse" description: OK @@ -92112,6 +93963,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + evaluated_flags_count: 8 + evaluated_reports_count: 12 + patch_coverage: 70.1 + total_coverage: 82.4 + id: ZGQxMjM0NV9tYWluXzE3MDk1NjQwMDA= + type: ci_app_coverage_summary schema: $ref: "#/components/schemas/CoverageSummaryResponse" description: OK @@ -92194,6 +94056,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + container_count: 1 + image_tags: + - latest + name: nginx + registry: docker.io + repository: library/nginx + short_image: nginx + id: abc-123 + type: container_image + meta: + pagination: + limit: 1000 + total: 1 + type: cursor_limit schema: $ref: "#/components/schemas/ContainerImagesResponse" description: OK @@ -92274,6 +94155,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + container_id: abc-123 + host: example-host + image_name: nginx + name: example-container + state: running + id: abc-123 + type: container + meta: + pagination: + limit: 1000 + total: 1 + type: cursor_limit schema: $ref: "#/components/schemas/ContainersResponse" description: OK @@ -92314,6 +94212,34 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + costs_to_allocate: + - condition: is + tag: account_id + value: "123456789" + values: + created: "2024-01-01T00:00:00+00:00" + enabled: true + last_modified_user_uuid: user-example-uuid + order_id: 1 + processing_status: done + provider: + - aws + rule_name: example-custom-allocation-rule + strategy: + allocated_by_tag_keys: + - team + granularity: daily + method: proportional + type: shared + updated: "2024-01-01T00:00:00+00:00" + version: 1 + id: "123" + type: arbitrary_rule schema: $ref: "#/components/schemas/ArbitraryRuleResponseArray" description: OK @@ -92392,6 +94318,31 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + costs_to_allocate: + - condition: is + tag: account_id + value: "123456789" + created: "2024-01-01T00:00:00+00:00" + enabled: true + order_id: 1 + provider: + - aws + rule_name: example-arbitrary-cost-rule + strategy: + allocated_by_tag_keys: + - team + granularity: daily + method: proportional + type: shared + updated: "2024-01-01T00:00:00+00:00" + version: 1 + id: "123" + type: arbitrary_rule schema: $ref: "#/components/schemas/ArbitraryRuleResponse" description: OK @@ -92485,6 +94436,33 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + costs_to_allocate: + - condition: is + tag: account_id + value: "123456789" + values: + created: "2024-01-01T00:00:00+00:00" + enabled: true + last_modified_user_uuid: user-example-uuid + order_id: 1 + provider: + - aws + rule_name: example-custom-allocation-rule + strategy: + allocated_by_tag_keys: + - team + granularity: daily + method: proportional + type: shared + updated: "2024-01-01T00:00:00+00:00" + version: 1 + id: "123" + type: arbitrary_rule schema: $ref: "#/components/schemas/ArbitraryRuleResponse" description: OK @@ -92572,6 +94550,31 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + costs_to_allocate: + - condition: is + tag: account_id + value: "123456789" + created: "2024-01-01T00:00:00+00:00" + enabled: true + order_id: 1 + provider: + - aws + rule_name: example-arbitrary-cost-rule + strategy: + allocated_by_tag_keys: + - team + granularity: daily + method: proportional + type: shared + updated: "2024-01-01T00:00:00+00:00" + version: 1 + id: "123" + type: arbitrary_rule schema: $ref: "#/components/schemas/ArbitraryRuleResponse" description: OK @@ -92593,6 +94596,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + account_id: "123456789123" + bucket_name: dd-cost-bucket + bucket_region: us-east-1 + created_at: "2023-01-01T12:00:00.000000" + error_messages: [] + months: 36 + report_name: dd-report-name + report_prefix: dd-report-prefix + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + updated_at: "2023-01-01T12:00:00.000000" + id: "123" + type: aws_cur_config schema: $ref: "#/components/schemas/AwsCURConfigsResponse" description: OK @@ -92648,6 +94669,29 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + account_filters: + excluded_accounts: + - "123456789124" + - "123456789125" + include_new_accounts: true + account_id: "123456789123" + bucket_name: dd-cost-bucket + bucket_region: us-east-1 + created_at: "2023-01-01T12:00:00.000000" + error_messages: [] + months: 36 + report_name: dd-report-name + report_prefix: dd-report-prefix + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + updated_at: "2023-01-01T12:00:00.000000" + id: "123456789123" + type: aws_cur_config schema: $ref: "#/components/schemas/AwsCurConfigResponse" description: OK @@ -92727,6 +94771,29 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + account_filters: + excluded_accounts: + - "123456789124" + - "123456789125" + include_new_accounts: true + account_id: "123456789123" + bucket_name: dd-cost-bucket + bucket_region: us-east-1 + created_at: "2023-01-01T12:00:00.000000" + error_messages: [] + months: 36 + report_name: dd-report-name + report_prefix: dd-report-prefix + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + updated_at: "2023-01-01T12:00:00.000000" + id: "123456789123" + type: aws_cur_config schema: $ref: "#/components/schemas/AwsCurConfigResponse" description: OK @@ -92770,6 +94837,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + account_id: "123456789123" + bucket_name: dd-cost-bucket + bucket_region: us-east-1 + created_at: "2023-01-01T12:00:00.000000" + error_messages: [] + months: 36 + report_name: dd-report-name + report_prefix: dd-report-prefix + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + updated_at: "2023-01-01T12:00:00.000000" + id: "123" + type: aws_cur_config schema: $ref: "#/components/schemas/AwsCURConfigsResponse" description: OK @@ -92807,6 +94892,29 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + configs: + - account_id: 1234abcd-1234-abcd-1234-1234abcd1234 + client_id: 1234abcd-1234-abcd-1234-1234abcd1234 + created_at: "2023-01-01T12:00:00.000000" + dataset_type: actual + error_messages: [] + export_name: dd-actual-export + export_path: dd-export-path + id: "123456789123" + months: 36 + scope: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234 + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + storage_account: dd-storage-account + storage_container: dd-storage-container + updated_at: "2023-01-01T12:00:00.000000" + id: "123456789123" + type: azure_uc_configs schema: $ref: "#/components/schemas/AzureUCConfigsResponse" description: OK @@ -92862,6 +94970,29 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + configs: + - account_id: 1234abcd-1234-abcd-1234-1234abcd1234 + client_id: 1234abcd-1234-abcd-1234-1234abcd1234 + created_at: "2023-01-01T12:00:00.000000" + dataset_type: actual + error_messages: [] + export_name: dd-actual-export + export_path: dd-export-path + id: "123456789123" + months: 36 + scope: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234 + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + storage_account: dd-storage-account + storage_container: dd-storage-container + updated_at: "2023-01-01T12:00:00.000000" + id: "123456789123" + type: azure_uc_configs schema: $ref: "#/components/schemas/AzureUCConfigPairsResponse" description: OK @@ -92941,6 +95072,29 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + configs: + - account_id: 1234abcd-1234-abcd-1234-1234abcd1234 + client_id: 1234abcd-1234-abcd-1234-1234abcd1234 + created_at: "2023-01-01T12:00:00.000000" + dataset_type: actual + error_messages: [] + export_name: dd-actual-export + export_path: dd-export-path + id: "123456789123" + months: 36 + scope: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234 + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + storage_account: dd-storage-account + storage_container: dd-storage-container + updated_at: "2023-01-01T12:00:00.000000" + id: "123456789123" + type: azure_uc_configs schema: $ref: "#/components/schemas/UCConfigPair" description: OK @@ -92976,6 +95130,29 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + configs: + - account_id: 1234abcd-1234-abcd-1234-1234abcd1234 + client_id: 1234abcd-1234-abcd-1234-1234abcd1234 + created_at: "2023-01-01T12:00:00.000000" + dataset_type: actual + error_messages: [] + export_name: dd-actual-export + export_path: dd-export-path + id: "123456789123" + months: 36 + scope: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234 + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + storage_account: dd-storage-account + storage_container: dd-storage-container + updated_at: "2023-01-01T12:00:00.000000" + id: "123456789123" + type: azure_uc_configs schema: $ref: "#/components/schemas/AzureUCConfigPairsResponse" description: OK @@ -93042,6 +95219,29 @@ paths: "200": 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 + 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: budget schema: $ref: "#/components/schemas/BudgetWithEntries" description: OK @@ -93064,6 +95264,10 @@ paths: "200": content: application/json: + examples: + default: + value: + errors: [] schema: $ref: "#/components/schemas/ValidationResponse" description: OK @@ -93115,6 +95319,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + errors: [] + valid: true + id: budget_validation + type: budget_validation schema: $ref: "#/components/schemas/BudgetValidationResponse" description: OK @@ -93152,6 +95365,29 @@ paths: "200": 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 + 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: budget schema: $ref: "#/components/schemas/BudgetWithEntries" description: OK @@ -93171,6 +95407,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: 1741011342772 + created_by: user1 + 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: 1741011342772 + updated_by: user2 + id: 00000000-0a0a-0a0a-aaa0-00000000000a + type: budget schema: $ref: "#/components/schemas/BudgetArray" description: OK @@ -93227,6 +95480,26 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + billed_cost: 100.5 + billing_currency: USD + charge_period: + end: 1706745600000 + start: 1704067200000 + name: my_file.json + provider_names: + - my_provider + status: active + uploaded_at: 1704067200000 + id: 00000000-0000-0000-0000-000000000005 + type: custom_costs + meta: + total_filtered_count: 1 + version: "1" schema: $ref: "#/components/schemas/CustomCostsFileListResponse" description: OK @@ -93277,6 +95550,25 @@ paths: "202": content: application/json: + examples: + default: + value: + data: + attributes: + billed_cost: 100.5 + billing_currency: USD + charge_period: + end: 1706745600000 + start: 1704067200000 + name: my_file.json + provider_names: + - my_provider + status: pending + uploaded_at: 1704067200000 + id: 00000000-0000-0000-0000-000000000006 + type: custom_costs + meta: + version: "1" schema: $ref: "#/components/schemas/CustomCostsFileUploadResponse" description: Accepted @@ -93346,6 +95638,31 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + billed_cost: 100.5 + billing_currency: USD + charge_period: + end: 1706745600000 + start: 1704067200000 + content: + - BilledCost: 100.5 + BillingCurrency: USD + ChargeDescription: Monthly usage charge for my service + ChargePeriodEnd: "2023-02-28" + ChargePeriodStart: "2023-02-01" + name: my_file.json + provider_names: + - my_provider + status: active + uploaded_at: 1704067200000 + id: 00000000-0000-0000-0000-000000000007 + type: custom_costs + meta: + version: "1" schema: $ref: "#/components/schemas/CustomCostsFileGetResponse" description: OK @@ -93379,6 +95696,26 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + account_id: 123456_A123BC_12AB34 + bucket_name: dd-cost-bucket + created_at: "2023-01-01T12:00:00.000000" + dataset: billing + error_messages: [] + export_prefix: datadog_cloud_cost_usage_export + export_project_name: dd-cloud-cost-report + months: 36 + project_id: my-project-123 + service_account: dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + updated_at: "2023-01-01T12:00:00.000000" + id: "123456789123" + type: gcp_uc_config schema: $ref: "#/components/schemas/GCPUsageCostConfigsResponse" description: OK @@ -93419,7 +95756,7 @@ paths: 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 + type: gcp_uc_config_post_request schema: $ref: "#/components/schemas/GCPUsageCostConfigPostRequest" required: true @@ -93427,6 +95764,26 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + account_id: 123456_A123BC_12AB34 + bucket_name: dd-cost-bucket + created_at: "2023-01-01T12:00:00.000000" + dataset: billing + error_messages: [] + export_prefix: datadog_cloud_cost_usage_export + export_project_name: dd-cloud-cost-report + months: 36 + project_id: my-project-123 + service_account: dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + updated_at: "2023-01-01T12:00:00.000000" + id: "123456789123" + type: gcp_uc_config schema: $ref: "#/components/schemas/GCPUsageCostConfigResponse" description: OK @@ -93506,6 +95863,26 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + account_id: 123456_A123BC_12AB34 + bucket_name: dd-cost-bucket + created_at: "2023-01-01T12:00:00.000000" + dataset: billing + error_messages: [] + export_prefix: datadog_cloud_cost_usage_export + export_project_name: dd-cloud-cost-report + months: 36 + project_id: my-project-123 + service_account: dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + updated_at: "2023-01-01T12:00:00.000000" + id: "123456789123" + type: gcp_uc_config schema: $ref: "#/components/schemas/GcpUcConfigResponse" description: OK @@ -93541,6 +95918,26 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + account_id: 123456_A123BC_12AB34 + bucket_name: dd-cost-bucket + created_at: "2023-01-01T12:00:00.000000" + dataset: billing + error_messages: [] + export_prefix: datadog_cloud_cost_usage_export + export_project_name: dd-cloud-cost-report + months: 36 + project_id: my-project-123 + service_account: dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com + status: active + status_updated_at: "2023-01-01T12:00:00.000000" + updated_at: "2023-01-01T12:00:00.000000" + id: "123456789123" + type: gcp_uc_config schema: $ref: "#/components/schemas/GCPUsageCostConfigResponse" description: OK @@ -93584,6 +95981,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + account_id: "ocid1.tenancy.oc1..example" + created_at: "2026-01-01T12:00:00Z" + status: active + status_updated_at: "2026-01-01T12:00:00Z" + updated_at: "2026-01-01T12:00:00Z" + id: "1" + type: oci_config schema: $ref: "#/components/schemas/OCIConfigsResponse" description: OK @@ -93616,6 +96025,12 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: + id: abc-123 + type: billing_dimensions schema: $ref: "#/components/schemas/ActiveBillingDimensionsResponse" description: OK @@ -93733,6 +96148,12 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: + - id: abc-123 + type: cost_by_tag schema: $ref: "#/components/schemas/MonthlyCostAttributionResponse" description: OK @@ -93810,6 +96231,20 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + - attributes: + agent_version: "7.50.0" + hostname: example-host + os: linux + id: abc-123 + type: datadog_agent + meta: + page_index: 0 + page_size: 10 + total_filtered: 1 schema: $ref: "#/components/schemas/CsmAgentsResponse" description: OK @@ -93830,6 +96265,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + org_id: 123 + total_coverage: + configured_resources_count: 8 + coverage: 0.8 + partially_configured_resources_count: 0 + total_resources_count: 10 + id: abc-123 + type: get_cloud_accounts_coverage_analysis_response_public_v0 schema: $ref: "#/components/schemas/CsmCloudAccountsCoverageAnalysisResponse" description: OK @@ -93850,6 +96298,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + org_id: 123 + total_coverage: + configured_resources_count: 8 + coverage: 0.8 + partially_configured_resources_count: 0 + total_resources_count: 10 + id: abc-123 + type: get_hosts_and_containers_coverage_analysis_response_public_v0 schema: $ref: "#/components/schemas/CsmHostsAndContainersCoverageAnalysisResponse" description: OK @@ -93870,6 +96331,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + org_id: 123 + total_coverage: + configured_resources_count: 8 + coverage: 0.8 + partially_configured_resources_count: 0 + total_resources_count: 10 + id: abc-123 + type: get_serverless_coverage_analysis_response_public_v0 schema: $ref: "#/components/schemas/CsmServerlessCoverageAnalysisResponse" description: OK @@ -93921,6 +96395,20 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + - attributes: + agent_version: "7.50.0" + hostname: example-host + os: linux + id: abc-123 + type: datadog_agent + meta: + page_index: 0 + page_size: 10 + total_filtered: 1 schema: $ref: "#/components/schemas/CsmAgentsResponse" description: OK @@ -93946,6 +96434,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2020-11-23T10:00:00.000Z" + last4: abcd + name: Application Key for managing dashboards + id: 00000000-0000-0000-0000-000000000004 + type: application_keys schema: $ref: "#/components/schemas/ListApplicationKeysResponse" description: OK @@ -94000,6 +96498,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2020-11-23T10:00:00.000Z" + last4: abcd + name: Application Key for managing dashboards + id: 00000000-0000-0000-0000-000000000005 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: Created @@ -94066,6 +96574,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2020-11-23T10:00:00.000Z" + last4: abcd + name: Application Key for managing dashboards + id: 00000000-0000-0000-0000-000000000006 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -94119,6 +96637,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2020-11-23T10:00:00.000Z" + last4: abcd + name: Application Key for managing dashboards + id: 00000000-0000-0000-0000-000000000007 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -94179,6 +96707,12 @@ paths: "200": content: application/json: + examples: + default: + value: + deleted_dashboards_from_list: + - id: q5j-nti-fv6 + type: host_timeboard schema: $ref: "#/components/schemas/DashboardListDeleteItemsResponse" description: OK @@ -94221,6 +96755,13 @@ paths: "200": content: application/json: + examples: + default: + value: + dashboards: + - id: q5j-nti-fv6 + type: host_timeboard + total: 1 schema: $ref: "#/components/schemas/DashboardListItems" description: OK @@ -94278,6 +96819,12 @@ paths: "200": content: application/json: + examples: + default: + value: + added_dashboards_to_list: + - id: q5j-nti-fv6 + type: host_timeboard schema: $ref: "#/components/schemas/DashboardListAddItemsResponse" description: OK @@ -94333,6 +96880,12 @@ paths: "200": content: application/json: + examples: + default: + value: + dashboards: + - id: q5j-nti-fv6 + type: host_timeboard schema: $ref: "#/components/schemas/DashboardListUpdateItemsResponse" description: OK @@ -94397,6 +96950,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + credential: example-credential-value + dashboard_id: abc-def-ghi + global_time_selectable: true + id: "12345" + share_type: secure_embed + status: active + title: "Q1 Metrics Dashboard" + token: abc-123-token + url: "https://p.datadoghq.com/sb/secure-embed/abc-123-token" + id: "12345" + type: secure_embed_create_response schema: $ref: "#/components/schemas/SecureEmbedCreateResponse" description: OK @@ -94487,6 +97057,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + credential_suffix: ab3f + dashboard_id: abc-def-ghi + global_time_selectable: true + id: "12345" + share_type: secure_embed + status: active + title: "Q1 Metrics Dashboard" + token: abc-123-token + url: "https://p.datadoghq.com/sb/secure-embed/abc-123-token" + id: "12345" + type: secure_embed_get_response schema: $ref: "#/components/schemas/SecureEmbedGetResponse" description: OK @@ -94539,6 +97126,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + credential_suffix: ab3f + dashboard_id: abc-def-ghi + global_time_selectable: true + id: "12345" + share_type: secure_embed + status: active + title: "Q1 Metrics Dashboard (Updated)" + token: abc-123-token + url: "https://p.datadoghq.com/sb/secure-embed/abc-123-token" + id: "12345" + type: secure_embed_update_response schema: $ref: "#/components/schemas/SecureEmbedUpdateResponse" description: OK @@ -94580,6 +97184,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: Security Audit Dataset + principals: + - role:94172442-be03-11e9-a77a-3b7612558ac1 + product_filters: + - filters: + - source:cloudtrail + product: logs + id: 00000000-0000-0000-0000-000000000003 + type: dataset schema: $ref: "#/components/schemas/DatasetResponseMulti" description: OK @@ -94631,6 +97249,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Security Audit Dataset + principals: + - "role:abc-123" + product_filters: + - filters: + - source:cloudtrail + product: logs + id: 00000000-0000-0000-0000-000000000004 + type: dataset schema: $ref: "#/components/schemas/DatasetResponseSingle" description: OK @@ -94699,6 +97331,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Security Audit Dataset + principals: + - role:94172442-be03-11e9-a77a-3b7612558ac1 + product_filters: + - filters: + - source:cloudtrail + product: logs + id: 00000000-0000-0000-0000-000000000001 + type: dataset schema: $ref: "#/components/schemas/DatasetResponseSingle" description: OK @@ -94754,6 +97400,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Security Audit Dataset + principals: + - role:94172442-be03-11e9-a77a-3b7612558ac1 + product_filters: + - filters: + - source:cloudtrail + product: logs + id: 00000000-0000-0000-0000-000000000002 + type: dataset schema: $ref: "#/components/schemas/DatasetResponseSingle" description: OK @@ -94797,6 +97457,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00.000000Z" + created_by: test@example.com + from_time: 1672527600000 + is_created: true + org_id: 123 + product: logs + query: "service:xyz host:abc" + starting_at: "2024-01-01T02:00:00.000000Z" + status: pending + to_time: 1704063600000 + total_unrestricted: 100 + updated_at: "2024-01-01T00:00:00.000000Z" + id: "1" + type: deletion_request + meta: + product: logs + request_status: pending schema: $ref: "#/components/schemas/CreateDataDeletionResponseBody" description: OK @@ -94881,6 +97563,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00.000000Z" + created_by: test@example.com + from_time: 1672527600000 + is_created: true + org_id: 123 + product: logs + query: "service:xyz host:abc" + starting_at: "2024-01-01T02:00:00.000000Z" + status: pending + to_time: 1704063600000 + total_unrestricted: 100 + updated_at: "2024-01-01T00:00:00.000000Z" + id: "1" + type: deletion_request + meta: + next_page: "cGFnZTI=" + product: logs schema: $ref: "#/components/schemas/GetDataDeletionsResponseBody" description: OK @@ -94920,6 +97624,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00.000000Z" + created_by: test@example.com + from_time: 1672527600000 + is_created: true + org_id: 123 + product: logs + query: "service:xyz host:abc" + starting_at: "2024-01-01T02:00:00.000000Z" + status: canceled + to_time: 1704063600000 + total_unrestricted: 100 + updated_at: "2024-01-01T00:00:00.000000Z" + id: "1" + type: deletion_request + meta: + product: logs + request_status: canceled schema: $ref: "#/components/schemas/CancelDataDeletionResponseBody" description: OK @@ -94982,6 +97708,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: 00000000-0000-0000-0000-000000000004 + dry_run: false + env: production + identifier: pre + service: my-service + id: 00000000-0000-0000-0000-000000000003 + type: deployment_gate + meta: + page: + size: 50 schema: $ref: "#/components/schemas/DeploymentGatesListResponse" description: OK @@ -95035,6 +97778,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + handle: example-handle + id: 00000000-0000-0000-0000-000000000002 + name: Example Name + dry_run: false + env: production + identifier: pre + service: my-service + id: 00000000-0000-0000-0000-000000000001 + type: deployment_gate schema: $ref: "#/components/schemas/DeploymentGateResponse" description: OK @@ -95080,6 +97839,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + rules: + - created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: 00000000-0000-0000-0000-000000000012 + dry_run: false + gate_id: abc-123 + name: My deployment rule + options: + type: faulty_deployment_detection + id: 00000000-0000-0000-0000-000000000011 + type: list_deployment_rules schema: $ref: "#/components/schemas/DeploymentGateRulesResponse" description: OK @@ -95131,10 +97906,8 @@ paths: dry_run: false name: My deployment rule options: - duration: 3600 - excluded_resources: - - resource1 - - resource2 + - resource1 + - resource2 type: faulty_deployment_detection type: deployment_rule schema: @@ -95144,6 +97917,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + handle: test-user + id: 00000000-0000-0000-0000-000000000010 + name: Test User + dry_run: false + gate_id: abc-123 + name: My deployment rule + options: + type: faulty_deployment_detection + id: 00000000-0000-0000-0000-000000000009 + type: deployment_rule schema: $ref: "#/components/schemas/DeploymentRuleResponse" description: OK @@ -95243,6 +98033,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: 00000000-0000-0000-0000-000000000014 + dry_run: false + gate_id: abc-123 + name: My deployment rule + options: + type: faulty_deployment_detection + id: 00000000-0000-0000-0000-000000000013 + type: deployment_rule schema: $ref: "#/components/schemas/DeploymentRuleResponse" description: OK @@ -95302,10 +98107,8 @@ paths: dry_run: false name: Updated deployment rule options: - duration: 3600 - excluded_resources: - - resource1 - - resource2 + - resource1 + - resource2 type: deployment_rule schema: $ref: "#/components/schemas/UpdateDeploymentRuleParams" @@ -95314,6 +98117,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: 00000000-0000-0000-0000-000000000016 + dry_run: false + gate_id: abc-123 + name: Updated deployment rule + options: + - resource1 + type: faulty_deployment_detection + id: 00000000-0000-0000-0000-000000000015 + type: deployment_rule schema: $ref: "#/components/schemas/DeploymentRuleResponse" description: OK @@ -95403,6 +98222,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: 00000000-0000-0000-0000-000000000006 + dry_run: false + env: production + identifier: pre + service: my-service + id: 00000000-0000-0000-0000-000000000005 + type: deployment_gate schema: $ref: "#/components/schemas/DeploymentGateResponse" description: OK @@ -95463,6 +98296,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: 00000000-0000-0000-0000-000000000008 + dry_run: false + env: production + identifier: pre + service: my-service + id: 00000000-0000-0000-0000-000000000007 + type: deployment_gate schema: $ref: "#/components/schemas/DeploymentGateResponse" description: OK @@ -95522,6 +98369,14 @@ paths: "202": content: application/json: + examples: + default: + value: + data: + attributes: + evaluation_id: 00000000-0000-0000-0000-000000000001 + id: 00000000-0000-0000-0000-000000000001 + type: deployment_gates_evaluation_response schema: $ref: "#/components/schemas/DeploymentGatesEvaluationResponse" description: Accepted @@ -95574,6 +98429,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + dry_run: false + evaluation_id: 00000000-0000-0000-0000-000000000001 + evaluation_url: https://app.datadoghq.com/ci/deployment-gates/evaluations?index=cdgates&query=level%3Agate+%40evaluation_id%3A00000000-0000-0000-0000-000000000001 + gate_id: 00000000-0000-0000-0000-000000000001 + gate_status: pass + rules: [] + id: 00000000-0000-0000-0000-000000000001 + type: deployment_gates_evaluation_result_response schema: $ref: "#/components/schemas/DeploymentGatesEvaluationResultResponse" description: OK @@ -95613,6 +98481,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + domains: + - "@example.com" + enabled: false + id: 00000000-0000-0000-0000-000000000002 + type: domain_allowlist schema: $ref: "#/components/schemas/DomainAllowlistResponse" description: OK @@ -95658,6 +98536,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + domains: + - "@example.com" + enabled: false + id: 00000000-0000-0000-0000-000000000001 + type: domain_allowlist schema: $ref: "#/components/schemas/DomainAllowlistResponse" description: OK @@ -95719,12 +98607,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 4242fcdd31586083 + type: dora_deployment schema: $ref: "#/components/schemas/DORADeploymentResponse" description: OK "202": content: application/json: + examples: + default: + value: + data: + id: 4242fcdd31586083 + type: dora_deployment schema: $ref: "#/components/schemas/DORADeploymentResponse" description: OK - but delayed due to incident @@ -95803,6 +98703,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + env: production + finished_at: 1693491984000000000 + service: test-service + started_at: 1693491974000000000 + team: backend + id: abc-123 + type: dora_deployment schema: $ref: "#/components/schemas/DORADeploymentsListResponse" description: OK @@ -95842,6 +98754,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + env: production + finished_at: 1693491984000000000 + service: test-service + started_at: 1693491974000000000 + team: backend + id: abc-123 + type: dora_deployment schema: $ref: "#/components/schemas/DORADeploymentFetchResponse" description: OK @@ -95953,12 +98877,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 4242fcdd31586085 + type: dora_failure schema: $ref: "#/components/schemas/DORAFailureResponse" description: OK "202": content: application/json: + examples: + default: + value: + data: + id: 4242fcdd31586085 + type: dora_failure schema: $ref: "#/components/schemas/DORAFailureResponse" description: OK - but delayed due to incident @@ -96037,6 +98973,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + env: production + name: Database outage + services: + - test-service + severity: SEV-1 + started_at: 1693492174000000000 + team: backend + id: abc-123 + type: dora_failure schema: $ref: "#/components/schemas/DORAFailuresListResponse" description: OK @@ -96076,6 +99026,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + env: production + name: Database outage + services: + - test-service + severity: SEV-1 + started_at: 1693492174000000000 + team: backend + id: abc-123 + type: dora_failure schema: $ref: "#/components/schemas/DORAFailureFetchResponse" description: OK @@ -96138,12 +99102,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 4242fcdd31586085 + type: dora_failure schema: $ref: "#/components/schemas/DORAFailureResponse" description: OK "202": content: application/json: + examples: + default: + value: + data: + id: 4242fcdd31586085 + type: dora_failure schema: $ref: "#/components/schemas/DORAFailureResponse" description: OK - but delayed due to incident @@ -96196,6 +99172,32 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created: "2024-01-01T00:00:00+00:00" + display_timezone: America/New_York + message: Message about the downtime + modified: "2024-01-01T00:00:00+00:00" + monitor_identifier: + monitor_tags: + - "*" + mute_first_recovery_notification: false + notify_end_states: + - alert + - warn + notify_end_types: + - canceled + - expired + scope: env:(staging OR prod) AND datacenter:us-east-1 + status: active + id: "00000000-0000-1234-0000-000000000000" + type: downtime + meta: + page: + total_filtered_count: 1 schema: $ref: "#/components/schemas/ListDowntimesResponse" description: OK @@ -96257,6 +99259,29 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + display_timezone: America/New_York + message: Message about the downtime + modified: "2024-01-01T00:00:00+00:00" + monitor_identifier: + monitor_tags: + - "*" + mute_first_recovery_notification: false + notify_end_states: + - alert + - warn + notify_end_types: + - canceled + - expired + scope: env:(staging OR prod) AND datacenter:us-east-1 + status: active + id: "00000000-0000-1234-0000-000000000000" + type: downtime schema: $ref: "#/components/schemas/DowntimeResponse" description: OK @@ -96355,6 +99380,29 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + display_timezone: America/New_York + message: Message about the downtime + modified: "2024-01-01T00:00:00+00:00" + monitor_identifier: + monitor_tags: + - "*" + mute_first_recovery_notification: false + notify_end_states: + - alert + - warn + notify_end_types: + - canceled + - expired + scope: env:(staging OR prod) AND datacenter:us-east-1 + status: active + id: "00000000-0000-1234-0000-000000000000" + type: downtime schema: $ref: "#/components/schemas/DowntimeResponse" description: OK @@ -96433,6 +99481,29 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + display_timezone: America/New_York + message: Message about the downtime + modified: "2024-01-01T00:00:00+00:00" + monitor_identifier: + monitor_tags: + - "*" + mute_first_recovery_notification: false + notify_end_states: + - alert + - warn + notify_end_types: + - canceled + - expired + scope: env:(staging OR prod) AND datacenter:us-east-1 + status: active + id: "00000000-0000-1234-0000-000000000000" + type: downtime schema: $ref: "#/components/schemas/DowntimeResponse" description: OK @@ -96497,6 +99568,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + impacted_sessions: 12 + impacted_users: 4 + total_count: 82 + id: abc-123 + type: error_tracking_search_result schema: $ref: "#/components/schemas/IssuesSearchResponse" description: OK @@ -96527,6 +99608,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + error_message: "object of type 'NoneType' has no len()" + error_type: builtins.TypeError + service: test-service + state: OPEN + id: 00000000-0000-0000-0000-000000000001 + type: issue schema: $ref: "#/components/schemas/IssueResponse" description: OK @@ -96600,6 +99692,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + error_message: "object of type 'NoneType' has no len()" + error_type: builtins.TypeError + service: test-service + state: OPEN + id: 00000000-0000-0000-0000-000000000003 + type: issue schema: $ref: "#/components/schemas/IssueResponse" description: OK @@ -96649,6 +99752,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + error_message: "object of type 'NoneType' has no len()" + error_type: builtins.TypeError + service: test-service + state: RESOLVED + id: 00000000-0000-0000-0000-000000000002 + type: issue schema: $ref: "#/components/schemas/IssueResponse" description: OK @@ -96726,6 +99840,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + message: "Test event" + tags: + - "env:prod" + timestamp: "2019-01-02T09:42:36.320Z" + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: event + meta: + request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR schema: $ref: "#/components/schemas/EventsListResponse" description: OK @@ -96824,6 +99951,15 @@ paths: "202": content: application/json: + examples: + default: + value: + data: + attributes: + attributes: + evt: + uid: abc-123 + type: event schema: $ref: "#/components/schemas/EventCreateResponsePayload" description: OK @@ -96921,6 +100057,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + message: "Test event" + tags: + - "env:prod" + timestamp: "2019-01-02T09:42:36.320Z" + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: event + meta: + request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR schema: $ref: "#/components/schemas/EventsListResponse" description: OK @@ -96958,6 +100107,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + message: "The event message" + tags: + - "env:api_client_test" + timestamp: "2017-01-15T01:30:15.010000Z" + id: abc-123 + type: event schema: $ref: "#/components/schemas/V2EventResponse" description: OK @@ -97022,6 +100182,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListFeatureFlagsResponse" description: OK @@ -97074,6 +100238,28 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: A sample feature flag + key: feature-flag-abc123 + name: Feature Flag ABC 123 + updated_at: "2024-01-01T00:00:00+00:00" + value_type: BOOLEAN + variants: + - id: 00000000-0000-0000-0000-000000000002 + key: variant-a + name: Variant A + value: "true" + - id: 00000000-0000-0000-0000-000000000003 + key: variant-b + name: Variant B + value: "false" + id: 00000000-0000-0000-0000-000000000001 + type: feature-flags schema: $ref: "#/components/schemas/FeatureFlagResponse" description: Created @@ -97148,6 +100334,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListEnvironmentsResponse" description: OK @@ -97193,6 +100383,21 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + is_production: false + key: staging-environment + name: staging-environment + queries: + - staging + require_feature_flag_approval: false + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000017 + type: environments schema: $ref: "#/components/schemas/EnvironmentResponse" description: Created @@ -97270,6 +100475,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + is_production: false + key: staging-environment + name: staging-environment + queries: + - staging + require_feature_flag_approval: false + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000018 + type: environments schema: $ref: "#/components/schemas/EnvironmentResponse" description: OK @@ -97324,6 +100544,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + is_production: false + key: production-environment + name: production-environment + queries: + - production + require_feature_flag_approval: false + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000019 + type: environments schema: $ref: "#/components/schemas/EnvironmentResponse" description: OK @@ -97633,6 +100868,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: A sample feature flag + key: feature-flag-abc123 + name: Feature Flag ABC 123 + updated_at: "2024-01-01T00:00:00+00:00" + value_type: BOOLEAN + variants: + - id: 00000000-0000-0000-0000-000000000005 + key: variant-a + name: Variant A + value: "true" + - id: 00000000-0000-0000-0000-000000000006 + key: variant-b + name: Variant B + value: "false" + id: 00000000-0000-0000-0000-000000000004 + type: feature-flags schema: $ref: "#/components/schemas/FeatureFlagResponse" description: OK @@ -97687,6 +100944,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: A sample feature flag + key: feature-flag-abc123 + name: Feature Flag ABC 123 + updated_at: "2024-01-01T00:00:00+00:00" + value_type: BOOLEAN + variants: + - id: 00000000-0000-0000-0000-000000000008 + key: variant-a + name: Variant A + value: "true" + - id: 00000000-0000-0000-0000-000000000009 + key: variant-b + name: Variant B + value: "false" + id: 00000000-0000-0000-0000-000000000007 + type: feature-flags schema: $ref: "#/components/schemas/FeatureFlagResponse" description: OK @@ -97733,6 +101012,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: A sample feature flag + key: feature-flag-abc123 + name: Feature Flag ABC 123 + updated_at: "2024-01-01T00:00:00+00:00" + value_type: BOOLEAN + variants: + - id: 00000000-0000-0000-0000-000000000011 + key: variant-a + name: Variant A + value: "true" + - id: 00000000-0000-0000-0000-000000000012 + key: variant-b + name: Variant B + value: "false" + id: 00000000-0000-0000-0000-000000000010 + type: feature-flags schema: $ref: "#/components/schemas/FeatureFlagResponse" description: OK @@ -97826,6 +101127,27 @@ paths: "202": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + environment_ids: + - abc-123 + guardrail_metrics: [] + id: 00000000-0000-0000-0000-000000000016 + key: prod-rollout + name: Production Rollout + order_position: 0 + targeting_rules: [] + type: FEATURE_GATE + updated_at: "2024-01-01T00:00:00+00:00" + variant_weights: + - value: 50 + variant_id: abc-123 + id: 00000000-0000-0000-0000-000000000015 + type: allocations schema: $ref: "#/components/schemas/AllocationResponse" description: Accepted - Approval required for this change @@ -97924,6 +101246,10 @@ paths: "202": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListAllocationsResponse" description: Accepted - Approval required for this change @@ -98051,6 +101377,27 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: This is an example feature flag + distribution_channel: ALL + key: feature-flag-abc123 + name: Feature Flag ABC123 + require_approval: false + tags: [] + updated_at: "2024-01-01T00:00:00+00:00" + value_type: boolean + variants: + - id: 00000000-0000-0000-0000-000000000014 + key: variant-abc123 + name: Variant ABC123 + value: "true" + id: 00000000-0000-0000-0000-000000000013 + type: feature-flags schema: $ref: "#/components/schemas/FeatureFlagResponse" description: OK @@ -98096,6 +101443,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + hamr_status: 4 + is_primary: true + modified_at: "2024-01-01T00:00:00+00:00" + modified_by: test@example.com + target_org_datacenter: us1 + target_org_name: Production Backup Org + target_org_uuid: 00000000-0000-0000-0000-000000000001 + id: 00000000-0000-0000-0000-000000000001 + type: hamr_org_connections schema: $ref: "#/components/schemas/HamrOrgConnectionResponse" description: OK @@ -98157,6 +101518,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + hamr_status: 4 + is_primary: true + modified_at: "2024-01-01T00:00:00+00:00" + modified_by: test@example.com + target_org_datacenter: us1 + target_org_name: Production Backup Org + target_org_uuid: 00000000-0000-0000-0000-000000000001 + id: 00000000-0000-0000-0000-000000000002 + type: hamr_org_connections schema: $ref: "#/components/schemas/HamrOrgConnectionResponse" description: OK @@ -98202,6 +101577,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created: "2024-01-01T00:00:00+00:00" + customer_impacted: false + modified: "2024-01-01T00:00:00+00:00" + title: A test incident title + id: "00000000-0000-0000-1234-000000000000" + type: incidents schema: $ref: "#/components/schemas/IncidentsResponse" description: OK @@ -98253,7 +101639,10 @@ paths: value: SEV-5 incident_type_uuid: 00000000-0000-0000-0000-000000000000 initial_cells: - - important: false + - cell_type: markdown + content: + content: "An example timeline cell message." + important: false is_test: false notification_handles: - display_name: Jane Doe @@ -98277,6 +101666,21 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + customer_impacted: false + fields: + severity: + type: dropdown + value: SEV-5 + modified: "2024-01-01T00:00:00+00:00" + title: A test incident title + id: "00000000-0000-0000-1234-000000000000" + type: incidents schema: $ref: "#/components/schemas/IncidentResponse" description: CREATED @@ -98342,6 +101746,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + fields: + severity: + - SEV-1 + modified_at: "2024-01-01T00:00:00+00:00" + name: "@incident-sev-1" + id: 00000000-0000-0000-0000-000000000006 + type: incidents_handles schema: $ref: "#/components/schemas/IncidentHandlesResponse" description: OK @@ -98400,6 +101817,19 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + fields: + severity: + - SEV-1 + modified_at: "2024-01-01T00:00:00+00:00" + name: "@incident-sev-1" + id: 00000000-0000-0000-0000-000000000007 + type: incidents_handles schema: $ref: "#/components/schemas/IncidentHandleResponse" description: Created @@ -98458,6 +101888,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + fields: + severity: + - SEV-1 + modified_at: "2024-01-01T00:00:00+00:00" + name: "@incident-sev-1" + id: 00000000-0000-0000-0000-000000000008 + type: incidents_handles schema: $ref: "#/components/schemas/IncidentHandleResponse" description: OK @@ -98483,6 +101926,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + analytics_dashboard_id: 00000000-0000-0000-0000-000000000002-def + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000001 + type: incidents_global_settings schema: $ref: "#/components/schemas/GlobalIncidentSettingsResponse" description: OK @@ -98511,7 +101964,7 @@ paths: value: data: attributes: - analytics_dashboard_id: abc-123-def + analytics_dashboard_id: 00000000-0000-0000-0000-000000000003-def type: incidents_global_settings schema: $ref: "#/components/schemas/GlobalIncidentSettingsRequest" @@ -98520,6 +101973,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + analytics_dashboard_id: 00000000-0000-0000-0000-000000000005-def + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000004 + type: incidents_global_settings schema: $ref: "#/components/schemas/GlobalIncidentSettingsResponse" description: OK @@ -98547,6 +102010,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + created: "2024-01-01T00:00:00+00:00" + enabled: true + handles: + - "@team-email@example.com" + modified: "2024-01-01T00:00:00+00:00" + trigger: incident_created_trigger + visibility: organization + id: 00000000-0000-0000-0000-000000000001 + type: incident_notification_rules schema: $ref: "#/components/schemas/IncidentNotificationRuleArray" description: OK @@ -98616,6 +102098,25 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + created: "2024-01-01T00:00:00+00:00" + enabled: true + handles: + - "@team-email@example.com" + modified: "2024-01-01T00:00:00+00:00" + trigger: incident_created_trigger + visibility: organization + id: 00000000-0000-0000-0000-000000000001 + type: incident_notification_rules schema: $ref: "#/components/schemas/IncidentNotificationRule" description: Created @@ -98690,6 +102191,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + created: "2024-01-01T00:00:00+00:00" + enabled: true + handles: + - "@team-email@example.com" + modified: "2024-01-01T00:00:00+00:00" + trigger: incident_created_trigger + visibility: organization + id: 00000000-0000-0000-0000-000000000001 + type: incident_notification_rules schema: $ref: "#/components/schemas/IncidentNotificationRule" description: OK @@ -98764,6 +102284,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + created: "2024-01-01T00:00:00+00:00" + enabled: true + handles: + - "@team-email@example.com" + modified: "2024-01-01T00:00:00+00:00" + trigger: incident_created_trigger + visibility: organization + id: 00000000-0000-0000-0000-000000000001 + type: incident_notification_rules schema: $ref: "#/components/schemas/IncidentNotificationRule" description: OK @@ -98804,6 +102343,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + category: alert + content: "An incident has been declared.\n\nTitle: {{incident.title}}" + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + name: Incident Alert Template + subject: "{{incident.severity}} Incident: {{incident.title}}" + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates schema: $ref: "#/components/schemas/IncidentNotificationTemplateArray" description: OK @@ -98859,6 +102411,19 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + category: alert + content: "An incident has been declared.\n\nTitle: {{incident.title}}" + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + name: Incident Alert Template + subject: "{{incident.severity}} Incident: {{incident.title}}" + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates schema: $ref: "#/components/schemas/IncidentNotificationTemplate" description: Created @@ -98933,6 +102498,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + category: alert + content: "An incident has been declared.\n\nTitle: {{incident.title}}" + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + name: Incident Alert Template + subject: "{{incident.severity}} Incident: {{incident.title}}" + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates schema: $ref: "#/components/schemas/IncidentNotificationTemplate" description: OK @@ -98991,6 +102569,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + category: alert + content: "An incident has been declared.\n\nTitle: {{incident.title}}" + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + name: Incident Alert Template + subject: "{{incident.severity}} Incident: {{incident.title}}" + id: 00000000-0000-0000-0000-000000000001 + type: notification_templates schema: $ref: "#/components/schemas/IncidentNotificationTemplate" description: OK @@ -99028,6 +102619,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + createdAt: "2024-01-01T00:00:00+00:00" + modifiedAt: "2024-01-01T00:00:00+00:00" + name: Standard Postmortem Template + id: 00000000-0000-0000-0000-000000000001 + type: postmortem_template schema: $ref: "#/components/schemas/PostmortemTemplatesResponse" description: OK @@ -99065,6 +102666,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + createdAt: "2024-01-01T00:00:00+00:00" + modifiedAt: "2024-01-01T00:00:00+00:00" + name: Standard Postmortem Template + id: 00000000-0000-0000-0000-000000000002 + type: postmortem_template schema: $ref: "#/components/schemas/PostmortemTemplateResponse" description: Created @@ -99138,6 +102749,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + createdAt: "2024-01-01T00:00:00+00:00" + modifiedAt: "2024-01-01T00:00:00+00:00" + name: Standard Postmortem Template + id: 00000000-0000-0000-0000-000000000003 + type: postmortem_template schema: $ref: "#/components/schemas/PostmortemTemplateResponse" description: OK @@ -99189,6 +102810,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + createdAt: "2024-01-01T00:00:00+00:00" + modifiedAt: "2024-01-01T00:00:00+00:00" + name: Standard Postmortem Template + id: 00000000-0000-0000-0000-000000000004 + type: postmortem_template schema: $ref: "#/components/schemas/PostmortemTemplateResponse" description: OK @@ -99222,6 +102853,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: Any incidents that harm the confidentiality, integrity, or availability of our data. + is_default: false + name: Security Incident + id: 00000000-0000-0000-0000-000000000002 + type: incident_types schema: $ref: "#/components/schemas/IncidentTypeListResponse" description: OK @@ -99275,6 +102916,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + description: Any incidents that harm the confidentiality, integrity, or availability of our data. + is_default: false + name: Security Incident + id: 00000000-0000-0000-0000-000000000001 + type: incident_types schema: $ref: "#/components/schemas/IncidentTypeResponse" description: CREATED @@ -99348,6 +102999,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: Any incidents that harm the confidentiality, integrity, or availability of our data. + is_default: false + name: Security Incident + id: 00000000-0000-0000-0000-000000000003 + type: incident_types schema: $ref: "#/components/schemas/IncidentTypeResponse" description: OK @@ -99405,6 +103066,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: Any incidents that harm the confidentiality, integrity, or availability of our data. + is_default: false + name: Security Incident + id: 00000000-0000-0000-0000-000000000004 + type: incident_types schema: $ref: "#/components/schemas/IncidentTypeResponse" description: OK @@ -99957,6 +103628,21 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + fields: + severity: + value: SEV-5 + state: + value: active + modified: "2024-01-01T00:00:00+00:00" + title: Imported incident from external system + id: "00000000-0000-0000-1234-000000000000" + type: incidents schema: $ref: "#/components/schemas/IncidentImportResponse" description: CREATED @@ -100001,6 +103687,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + facets: + severity: [] + state: [] + incidents: [] + total: 0 + type: incidents_search_results schema: $ref: "#/components/schemas/IncidentSearchResponse" description: OK @@ -100078,6 +103775,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + customer_impacted: false + fields: + severity: + type: dropdown + value: SEV-5 + modified: "2024-01-01T00:00:00+00:00" + title: A test incident title + id: "00000000-0000-0000-1234-000000000000" + type: incidents schema: $ref: "#/components/schemas/IncidentResponse" description: OK @@ -100160,6 +103872,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + customer_impacted: false + fields: + severity: + type: dropdown + value: SEV-5 + modified: "2024-01-01T00:00:00+00:00" + title: A test incident title + id: "00000000-0000-0000-1234-000000000000" + type: incidents schema: $ref: "#/components/schemas/IncidentResponse" description: OK @@ -100206,6 +103933,23 @@ paths: "200": 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 + modified: "2024-01-01T00:00:00+00:00" + id: 00000000-abcd-0002-0000-000000000000 + relationships: + incident: + data: + id: 00000000-0000-0000-1234-000000000000 + type: incidents + type: incident_attachments schema: $ref: "#/components/schemas/AttachmentArray" description: OK @@ -100252,6 +103996,23 @@ paths: "201": 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 + modified: "2024-01-01T00:00:00+00:00" + id: 00000000-abcd-0002-0000-000000000000 + relationships: + incident: + data: + id: 00000000-0000-0000-1234-000000000000 + type: incidents + type: incident_attachments schema: $ref: "#/components/schemas/Attachment" description: Created @@ -100315,6 +104076,23 @@ paths: "201": 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 + modified: "2024-01-01T00:00:00+00:00" + id: 00000000-abcd-0002-0000-000000000000 + relationships: + incident: + data: + id: 00000000-0000-0000-1234-000000000000 + type: incidents + type: incident_attachments schema: $ref: "#/components/schemas/Attachment" description: Created @@ -100390,6 +104168,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attachment: + documentUrl: "https://app.datadoghq.com/notebook/124/Postmortem-IR-124" + title: Postmortem IR-124 + attachment_type: postmortem + modified: "2024-01-01T00:00:00+00:00" + id: 00000000-abcd-0002-0000-000000000000 + relationships: + incident: + data: + id: 00000000-0000-0000-1234-000000000000 + type: incidents + type: incident_attachments schema: $ref: "#/components/schemas/Attachment" description: OK @@ -100427,6 +104222,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: "Service was unavailable for external users" + end_at: "2024-01-01T01:00:00+00:00" + start_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000001 + type: incident_impacts schema: $ref: "#/components/schemas/IncidentImpactsResponse" description: OK @@ -100483,6 +104288,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + description: "Service was unavailable for external users" + end_at: "2024-01-01T01:00:00+00:00" + start_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000002 + type: incident_impacts schema: $ref: "#/components/schemas/IncidentImpactResponse" description: CREATED @@ -100549,6 +104364,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + incident_id: 00000000-aaaa-0000-0000-000000000000 + integration_type: 8 + metadata: + issues: + - account: https://example.atlassian.net + project_key: PROJ + id: 00000000-0000-0000-1234-000000000000 + type: incident_integrations schema: $ref: "#/components/schemas/IncidentIntegrationMetadataListResponse" description: OK @@ -100607,6 +104435,19 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + incident_id: 00000000-aaaa-0000-0000-000000000000 + integration_type: 8 + metadata: + issues: + - account: https://example.atlassian.net + project_key: PROJ + id: 00000000-0000-0000-1234-000000000000 + type: incident_integrations schema: $ref: "#/components/schemas/IncidentIntegrationMetadataResponse" description: CREATED @@ -100678,6 +104519,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + incident_id: 00000000-aaaa-0000-0000-000000000000 + integration_type: 8 + metadata: + issues: + - account: https://example.atlassian.net + project_key: PROJ + id: 00000000-0000-0000-1234-000000000000 + type: incident_integrations schema: $ref: "#/components/schemas/IncidentIntegrationMetadataResponse" description: OK @@ -100733,6 +104587,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + incident_id: 00000000-aaaa-0000-0000-000000000000 + integration_type: 8 + metadata: + issues: + - account: https://example.atlassian.net + issue_key: PROJ-123 + project_key: PROJ + id: 00000000-0000-0000-1234-000000000000 + type: incident_integrations schema: $ref: "#/components/schemas/IncidentIntegrationMetadataResponse" description: OK @@ -100768,6 +104636,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + assignees: + - "@test.user@example.com" + content: Restore lost data. + id: 00000000-0000-0000-0000-000000000002 + type: incident_todos schema: $ref: "#/components/schemas/IncidentTodoListResponse" description: OK @@ -100824,6 +104702,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + assignees: + - "@test.user@example.com" + content: Restore lost data. + id: 00000000-0000-0000-0000-000000000001 + type: incident_todos schema: $ref: "#/components/schemas/IncidentTodoResponse" description: CREATED @@ -100898,6 +104786,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + assignees: + - "@test.user@example.com" + content: Restore lost data. + id: 00000000-0000-0000-0000-000000000003 + type: incident_todos schema: $ref: "#/components/schemas/IncidentTodoResponse" description: OK @@ -100955,6 +104853,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + assignees: + - "@test.user@example.com" + content: Restore lost data. + id: 00000000-0000-0000-0000-000000000004 + type: incident_todos schema: $ref: "#/components/schemas/IncidentTodoResponse" description: OK @@ -101002,6 +104910,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/AWSAccountsResponse" description: AWS Accounts List object @@ -101060,6 +104972,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + auth_config: + access_key_id: ACCESS_KEY_ID + aws_account_id: "123456789012" + aws_partition: aws + id: 00000000-0000-0000-0000-000000000001 + type: account schema: $ref: "#/components/schemas/AWSAccountResponse" description: AWS Account object @@ -101112,6 +105035,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + auth_config: + access_key_id: ACCESS_KEY_ID + aws_account_id: "123456789012" + aws_partition: aws + id: 00000000-0000-0000-0000-000000000002 + type: account schema: $ref: "#/components/schemas/AWSAccountResponse" description: AWS Account object @@ -101177,6 +105111,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + auth_config: + access_key_id: ACCESS_KEY_ID + aws_account_id: "123456789012" + aws_partition: aws + id: 00000000-0000-0000-0000-000000000003 + type: account schema: $ref: "#/components/schemas/AWSAccountResponse" description: AWS Account object @@ -101234,6 +105179,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + data_export_configs: + - bucket_name: billing + bucket_region: us-east-1 + report_name: cost-and-usage-report + report_prefix: reports + report_type: CUR2.0 + id: 00000000-0000-0000-0000-000000000004 + type: ccm_config schema: $ref: "#/components/schemas/AWSCcmConfigResponse" description: AWS CCM Config object @@ -101284,6 +105242,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + data_export_configs: + - bucket_name: billing + bucket_region: us-east-1 + report_name: cost-and-usage-report + report_prefix: reports + report_type: CUR2.0 + id: 00000000-0000-0000-0000-000000000006 + type: ccm_config schema: $ref: "#/components/schemas/AWSCcmConfigResponse" description: AWS CCM Config object @@ -101335,6 +105306,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + data_export_configs: + - bucket_name: billing + bucket_region: us-east-1 + report_name: cost-and-usage-report + report_prefix: reports + report_type: CUR2.0 + id: 00000000-0000-0000-0000-000000000005 + type: ccm_config schema: $ref: "#/components/schemas/AWSCcmConfigResponse" description: AWS CCM Config object @@ -101365,6 +105349,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + namespaces: + - AWS/EC2 + id: namespaces + type: namespaces schema: $ref: "#/components/schemas/AWSNamespacesResponse" description: AWS Namespaces List object @@ -101403,6 +105396,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + status: empty + id: delete_event_bridge + type: event_bridge schema: $ref: "#/components/schemas/AWSEventBridgeDeleteResponse" description: Amazon EventBridge source deleted. @@ -101427,6 +105428,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + accounts: [] + is_installed: true + id: get_event_bridge + type: event_bridge schema: $ref: "#/components/schemas/AWSEventBridgeListResponse" description: Amazon EventBridge sources list. @@ -101467,6 +105477,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + event_source_name: app-alerts-zyxw3210 + has_bus: true + region: us-east-1 + status: created + id: create_event_bridge + type: event_bridge schema: $ref: "#/components/schemas/AWSEventBridgeCreateResponse" description: Amazon EventBridge source created. @@ -101494,6 +105515,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + external_id: abc-123 + id: external_id + type: external_id schema: $ref: "#/components/schemas/AWSNewExternalIDResponse" description: AWS External ID object @@ -101516,6 +105545,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + permissions: + - account:GetContactInformation + id: permissions + type: permissions schema: $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponse" description: AWS IAM Permissions object @@ -101532,6 +105570,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + permissions: + - account:GetContactInformation + id: permissions + type: permissions schema: $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponse" description: AWS integration resource collection IAM permissions. @@ -101548,6 +105595,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + permissions: + - account:GetContactInformation + id: permissions + type: permissions schema: $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponse" description: AWS integration standard IAM permissions. @@ -101564,6 +105620,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + logs_services: + - s3 + id: logs_services + type: logs_services schema: $ref: "#/components/schemas/AWSLogsServicesResponse" description: AWS Logs Services List object @@ -101586,6 +105651,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + automute: true + client_email: service-account@test-project.iam.gserviceaccount.com + is_cspm_enabled: true + resource_collection_enabled: true + id: abc-123 + type: gcp_service_account schema: $ref: "#/components/schemas/GCPSTSServiceAccountsResponse" description: OK @@ -101645,6 +105721,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + automute: true + client_email: service-account@test-project.iam.gserviceaccount.com + is_cspm_enabled: true + resource_collection_enabled: true + id: abc-123 + type: gcp_service_account schema: $ref: "#/components/schemas/GCPSTSServiceAccountResponse" description: OK @@ -101733,6 +105820,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + automute: true + client_email: service-account@test-project.iam.gserviceaccount.com + is_cspm_enabled: true + resource_collection_enabled: true + id: abc-123 + type: gcp_service_account schema: $ref: "#/components/schemas/GCPSTSServiceAccountResponse" description: OK @@ -101760,6 +105858,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + delegate_account_email: test@example.com + id: abc-123 + type: gcp_sts_delegate schema: $ref: "#/components/schemas/GCPSTSDelegateAccountResponse" description: OK @@ -101793,6 +105899,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + delegate_account_email: test@example.com + id: abc-123 + type: gcp_sts_delegate schema: $ref: "#/components/schemas/GCPSTSDelegateAccountResponse" description: OK @@ -101821,6 +105935,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + display_name: General + organization_binding_id: 00000000-0000-0000-0000-000000000006 + resource_name: spaces/AAAAAAAAA + space_uri: https://chat.google.com/room/AAAAAAAAA + id: 00000000-0000-0000-0000-000000000005 + type: google-chat-app-named-space schema: $ref: "#/components/schemas/GoogleChatAppNamedSpaceResponse" description: OK @@ -101845,6 +105970,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: example-handle + space_display_name: General + space_resource_name: spaces/AAAAAAAAA + id: 00000000-0000-0000-0000-000000000001 + type: google-chat-organization-handle schema: $ref: "#/components/schemas/GoogleChatOrganizationHandlesResponse" description: OK @@ -101883,6 +106018,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: example-handle + space_display_name: General + space_resource_name: spaces/AAAAAAAAA + id: 00000000-0000-0000-0000-000000000002 + type: google-chat-organization-handle schema: $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse" description: CREATED @@ -101939,6 +106084,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: example-handle + space_display_name: General + space_resource_name: spaces/AAAAAAAAA + id: 00000000-0000-0000-0000-000000000003 + type: google-chat-organization-handle schema: $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse" description: OK @@ -101978,6 +106133,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: example-handle + space_display_name: General + space_resource_name: spaces/AAAAAAAAA + id: 00000000-0000-0000-0000-000000000004 + type: google-chat-organization-handle schema: $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse" description: OK @@ -102004,6 +106169,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + consumer_key: consumer-key-1 + instance_url: "https://example.atlassian.net" + id: account-1 + type: jira-account + meta: + public_key: "c29tZSBkYXRhIHdpdGggACBhbmQg77u/" schema: $ref: "#/components/schemas/JiraAccountsResponse" description: OK @@ -102061,6 +106237,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + fields: + description: + payload: "Test Description" + type: json + issue_type_id: "456" + name: Bug Report Template + project_id: "123" + id: "abc-123" + type: jira-issue-template schema: $ref: "#/components/schemas/JiraIssueTemplatesResponse" description: OK @@ -102101,6 +106291,20 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + fields: + description: + payload: Test + type: json + issue_type_id: "456" + name: test-template + project_id: "123" + id: "abc-123" + type: jira-issue-template schema: $ref: "#/components/schemas/JiraIssueTemplateResponse" description: Created @@ -102160,6 +106364,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + fields: + description: + payload: Test Description + type: json + issue_type_id: "456" + name: test-template + project_id: "123" + id: "abc-123" + type: jira-issue-template schema: $ref: "#/components/schemas/JiraIssueTemplateResponse" description: OK @@ -102211,6 +106429,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + fields: + description: + payload: Updated Description + type: json + issue_type_id: "456" + name: test_template_updated + project_id: "123" + id: "abc-123" + type: jira-issue-template schema: $ref: "#/components/schemas/JiraIssueTemplateResponse" description: OK @@ -102240,6 +106472,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + is_primary: true + team_id: 00000000-0000-0000-0000-000000000000 + tenant_id: 00000000-0000-0000-0000-000000000001 + id: "19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2" + type: ms-teams-channel-info schema: $ref: "#/components/schemas/MicrosoftTeamsGetChannelByNameResponse" description: OK @@ -102265,6 +106507,17 @@ paths: "200": 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 + id: 00000000-0000-0000-0000-000000000001 + type: ms-teams-tenant-based-handle-info schema: $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandlesResponse" description: OK @@ -102305,6 +106558,17 @@ paths: "201": 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 + id: 00000000-0000-0000-0000-000000000002 + type: tenant-based-handle schema: $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse" description: CREATED @@ -102353,6 +106617,17 @@ paths: "200": 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 + id: 00000000-0000-0000-0000-000000000003 + type: tenant-based-handle schema: $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse" description: OK @@ -102395,6 +106670,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + channel_id: fake-channel-id + name: fake-handle-name-updated + team_id: 00000000-0000-0000-0000-000000000000 + tenant_id: 00000000-0000-0000-0000-000000000001 + id: 00000000-0000-0000-0000-000000000004 + type: tenant-based-handle schema: $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse" description: OK @@ -102424,6 +106710,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: fake-handle-name + id: 00000000-0000-0000-0000-000000000005 + type: workflows-webhook-handle schema: $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandlesResponse" description: OK @@ -102462,6 +106756,14 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: fake-handle-name + id: 00000000-0000-0000-0000-000000000006 + type: workflows-webhook-handle schema: $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse" description: CREATED @@ -102510,6 +106812,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: fake-handle-name + id: 00000000-0000-0000-0000-000000000007 + type: workflows-webhook-handle schema: $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse" description: OK @@ -102550,6 +106860,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: fake-handle-name-updated + id: 00000000-0000-0000-0000-000000000008 + type: workflows-webhook-handle schema: $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse" description: OK @@ -102585,6 +106903,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + products: + - enabled: true + product_key: CLOUD_SECURITY_POSTURE_MANAGEMENT + id: ocid.tenancy.test + type: oci_tenancy_product schema: $ref: "#/components/schemas/TenancyProductsList" description: OK @@ -102605,6 +106933,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + cost_collection_enabled: true + home_region: us-ashburn-1 + resource_collection_enabled: true + user_ocid: ocid.user.test + id: ocid.tenancy.test + type: oci_tenancy schema: $ref: "#/components/schemas/TenancyConfigList" description: OK @@ -102671,6 +107010,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + cost_collection_enabled: true + home_region: us-ashburn-1 + resource_collection_enabled: true + user_ocid: ocid.user.test + id: ocid.tenancy.test + type: oci_tenancy schema: $ref: "#/components/schemas/TenancyConfig" description: Created @@ -102721,6 +107071,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + cost_collection_enabled: true + home_region: us-ashburn-1 + resource_collection_enabled: true + user_ocid: ocid.user.test + id: ocid.tenancy.test + type: oci_tenancy schema: $ref: "#/components/schemas/TenancyConfig" description: OK @@ -102791,6 +107152,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + cost_collection_enabled: true + home_region: us-ashburn-1 + resource_collection_enabled: true + user_ocid: ocid.user.test + id: ocid.tenancy.test + type: oci_tenancy schema: $ref: "#/components/schemas/TenancyConfig" description: OK @@ -102810,6 +107182,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + custom_url: + name: fake-opsgenie-service-name + region: us + id: 00000000-0000-0000-0000-000000000001 + type: opsgenie-service schema: $ref: "#/components/schemas/OpsgenieServicesResponse" description: OK @@ -102848,6 +107230,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + custom_url: https://example.com + name: fake-opsgenie-service-name + region: us + id: 00000000-0000-0000-0000-000000000002 + type: opsgenie-service schema: $ref: "#/components/schemas/OpsgenieServiceResponse" description: CREATED @@ -102900,6 +107292,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + custom_url: + name: fake-opsgenie-service-name + region: us + id: 00000000-0000-0000-0000-000000000003 + type: opsgenie-service schema: $ref: "#/components/schemas/OpsgenieServiceResponse" description: OK @@ -102947,6 +107349,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + custom_url: https://example.com + name: fake-opsgenie-service-name + region: us + id: 00000000-0000-0000-0000-000000000004 + type: opsgenie-service schema: $ref: "#/components/schemas/OpsgenieServiceResponse" description: OK @@ -102986,6 +107398,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + assignment_group_name: Network Team + assignment_group_sys_id: abc-123 + instance_id: 00000000-0000-0000-0000-000000000001 + id: 00000000-0000-0000-0000-000000000001 + type: assignment_groups schema: $ref: "#/components/schemas/ServiceNowAssignmentGroupsResponse" description: OK @@ -103024,6 +107446,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + instance_id: 00000000-0000-0000-0000-000000000001 + service_name: IT Support + service_sys_id: abc-123 + id: 00000000-0000-0000-0000-000000000001 + type: business_services schema: $ref: "#/components/schemas/ServiceNowBusinessServicesResponse" description: OK @@ -103053,6 +107485,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + handle_name: incident-template + instance_id: 00000000-0000-0000-0000-000000000001 + servicenow_tablename: incident + id: 00000000-0000-0000-0000-000000000001 + type: servicenow_templates schema: $ref: "#/components/schemas/ServiceNowTemplatesResponse" description: OK @@ -103090,6 +107532,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + handle_name: incident-template + instance_id: 00000000-0000-0000-0000-000000000001 + servicenow_tablename: incident + id: 00000000-0000-0000-0000-000000000001 + type: servicenow_templates schema: $ref: "#/components/schemas/ServiceNowTemplateResponse" description: Created @@ -103155,6 +107607,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + handle_name: incident-template + instance_id: 00000000-0000-0000-0000-000000000001 + servicenow_tablename: incident + id: 00000000-0000-0000-0000-000000000001 + type: servicenow_templates schema: $ref: "#/components/schemas/ServiceNowTemplateResponse" description: OK @@ -103213,6 +107675,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + handle_name: incident-template-updated + instance_id: 00000000-0000-0000-0000-000000000001 + servicenow_tablename: incident + id: 00000000-0000-0000-0000-000000000001 + type: servicenow_templates schema: $ref: "#/components/schemas/ServiceNowTemplateResponse" description: OK @@ -103242,6 +107714,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + instance_name: my-servicenow-instance + id: 00000000-0000-0000-0000-000000000001 + type: instance schema: $ref: "#/components/schemas/ServiceNowInstancesResponse" description: OK @@ -103274,6 +107754,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: test@example.com + full_name: Example Name + instance_id: 00000000-0000-0000-0000-000000000001 + user_name: example-handle + user_sys_id: 00000000-0000-0000-0000-000000000001 + id: 00000000-0000-0000-0000-000000000001 + type: users schema: $ref: "#/components/schemas/ServiceNowUsersResponse" description: OK @@ -103301,6 +107793,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + categories: + - Category::Kubernetes + description: Calico is a networking and network security solution for containers. + installed: true + title: calico + id: calico + type: integration schema: $ref: "#/components/schemas/ListIntegrationsResponse" description: Successful Response. @@ -103320,6 +107824,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: test@example.com + name: test-name + resources: + - web + - dns + - lb + - worker + zones: + - zone_id_1 + - zone_id_2 + id: abc-123 + type: cloudflare-accounts schema: $ref: "#/components/schemas/CloudflareAccountsResponse" description: OK @@ -103368,6 +107889,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + name: test-name + id: abc-123 + type: cloudflare-accounts schema: $ref: "#/components/schemas/CloudflareAccountResponse" description: CREATED @@ -103430,6 +107960,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + name: test-name + resources: + - web + - dns + - lb + - worker + zones: + - zone_id_1 + - zone_id_2 + id: abc-123 + type: cloudflare-accounts schema: $ref: "#/components/schemas/CloudflareAccountResponse" description: OK @@ -103484,6 +108031,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + name: test-name + resources: + - web + - dns + - lb + - worker + zones: + - zone_id_1 + - zone_id_2 + id: abc-123 + type: cloudflare-accounts schema: $ref: "#/components/schemas/CloudflareAccountResponse" description: OK @@ -103511,6 +108075,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + api_key: abc-123-key + tags: + - myTag + id: abc-123 + type: confluent-cloud-accounts schema: $ref: "#/components/schemas/ConfluentAccountsResponse" description: OK @@ -103561,6 +108135,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + api_key: abc-123-key + tags: + - myTag + id: abc-123 + type: confluent-cloud-accounts schema: $ref: "#/components/schemas/ConfluentAccountResponse" description: OK @@ -103613,6 +108197,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + api_key: abc-123-key + tags: + - myTag + id: abc-123 + type: confluent-cloud-accounts schema: $ref: "#/components/schemas/ConfluentAccountResponse" description: OK @@ -103658,6 +108252,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + api_key: abc-123-key + tags: + - myTag + id: abc-123 + type: confluent-cloud-accounts schema: $ref: "#/components/schemas/ConfluentAccountResponse" description: OK @@ -103687,6 +108291,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + enable_custom_metrics: false + resource_type: kafka + tags: + - myTag + id: abc-123 + type: confluent-cloud-resources schema: $ref: "#/components/schemas/ConfluentResourcesResponse" description: OK @@ -103733,6 +108348,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + enable_custom_metrics: false + resource_type: kafka + tags: + - myTag + id: abc-123 + type: confluent-cloud-resources schema: $ref: "#/components/schemas/ConfluentResourceResponse" description: OK @@ -103787,6 +108413,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + enable_custom_metrics: false + resource_type: kafka + tags: + - myTag + id: abc-123 + type: confluent-cloud-resources schema: $ref: "#/components/schemas/ConfluentResourceResponse" description: OK @@ -103834,6 +108471,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + enable_custom_metrics: false + resource_type: kafka + tags: + - myTag + id: abc-123 + type: confluent-cloud-resources schema: $ref: "#/components/schemas/ConfluentResourceResponse" description: OK @@ -103861,6 +108509,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: test-name + services: [] + id: abc-123 + type: fastly-accounts schema: $ref: "#/components/schemas/FastlyAccountsResponse" description: OK @@ -103905,6 +108562,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: test-name + services: [] + id: abc-123 + type: fastly-accounts schema: $ref: "#/components/schemas/FastlyAccountResponse" description: CREATED @@ -103957,6 +108623,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: test-name + services: [] + id: abc-123 + type: fastly-accounts schema: $ref: "#/components/schemas/FastlyAccountResponse" description: OK @@ -103997,6 +108672,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: test-name + services: [] + id: abc-123 + type: fastly-accounts schema: $ref: "#/components/schemas/FastlyAccountResponse" description: OK @@ -104026,6 +108710,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + tags: + - myTag + id: abc-123 + type: fastly-services schema: $ref: "#/components/schemas/FastlyServicesResponse" description: OK @@ -104069,6 +108762,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - myTag + id: abc-123 + type: fastly-services schema: $ref: "#/components/schemas/FastlyServiceResponse" description: CREATED @@ -104123,6 +108825,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - myTag + id: abc-123 + type: fastly-services schema: $ref: "#/components/schemas/FastlyServiceResponse" description: OK @@ -104167,6 +108878,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - myTag + id: abc-123 + type: fastly-services schema: $ref: "#/components/schemas/FastlyServiceResponse" description: OK @@ -104194,6 +108914,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + auth_method: oauth + domain: "https://example.okta.com/" + name: Okta-Prod + id: 00000000-0000-0000-0000-000000000001 + type: okta-accounts schema: $ref: "#/components/schemas/OktaAccountsResponse" description: OK @@ -104237,6 +108967,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + auth_method: oauth + domain: "https://example.okta.com/" + name: Okta-Prod + id: 00000000-0000-0000-0000-000000000002 + type: okta-accounts schema: $ref: "#/components/schemas/OktaAccountResponse" description: OK @@ -104299,6 +109039,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + auth_method: oauth + domain: "https://example.okta.com/" + name: Okta-Prod + id: 00000000-0000-0000-0000-000000000003 + type: okta-accounts schema: $ref: "#/components/schemas/OktaAccountResponse" description: OK @@ -104345,6 +109095,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + auth_method: oauth + domain: "https://example.okta.com/" + name: Okta-Prod + id: 00000000-0000-0000-0000-000000000004 + type: okta-accounts schema: $ref: "#/components/schemas/OktaAccountResponse" description: OK @@ -104372,6 +109132,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + enabled: false + entries: + - data: + attributes: + cidr_block: "127.0.0.1/32" + note: "Example entry" + id: 00000000-0000-0000-0000-000000000003 + type: ip_allowlist_entry + id: 00000000-0000-0000-0000-000000000001 + type: ip_allowlist schema: $ref: "#/components/schemas/IPAllowlistResponse" description: OK @@ -104418,6 +109193,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + enabled: false + entries: + - data: + attributes: + cidr_block: "127.0.0.1/32" + note: "Example entry" + id: 00000000-0000-0000-0000-000000000004 + type: ip_allowlist_entry + id: 00000000-0000-0000-0000-000000000002 + type: ip_allowlist schema: $ref: "#/components/schemas/IPAllowlistResponse" description: OK @@ -104465,6 +109255,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-15T10:30:00Z" + created_by: 00000000-0000-0000-0000-000000000002 + description: Queue for annotating customer support traces + modified_at: "2024-01-15T10:30:00Z" + modified_by: 00000000-0000-0000-0000-000000000002 + name: My annotation queue + owned_by: 00000000-0000-0000-0000-000000000002 + project_id: 00000000-0000-0000-0000-000000000002 + id: 00000000-0000-0000-0000-000000000001 + type: queues schema: $ref: "#/components/schemas/LLMObsAnnotationQueuesResponse" description: OK @@ -104514,7 +109319,7 @@ paths: attributes: description: Queue for annotating customer support traces name: My annotation queue - project_id: a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + project_id: 00000000-0000-0000-0000-000000000002 type: queues with_schema: summary: Create queue with annotation schema @@ -104536,7 +109341,7 @@ paths: - neutral description: Queue for annotating customer support traces name: My annotation queue - project_id: a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + project_id: 00000000-0000-0000-0000-000000000002 type: queues schema: $ref: "#/components/schemas/LLMObsAnnotationQueueRequest" @@ -104546,6 +109351,21 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-15T10:30:00Z" + created_by: 00000000-0000-0000-0000-000000000002 + description: Queue for annotating customer support traces + modified_at: "2024-01-15T10:30:00Z" + modified_by: 00000000-0000-0000-0000-000000000002 + name: My annotation queue + owned_by: 00000000-0000-0000-0000-000000000002 + project_id: 00000000-0000-0000-0000-000000000002 + id: 00000000-0000-0000-0000-000000000001 + type: queues schema: $ref: "#/components/schemas/LLMObsAnnotationQueueResponse" description: Created @@ -104641,6 +109461,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-15T10:30:00Z" + created_by: 00000000-0000-0000-0000-000000000002 + description: Queue for annotating customer support traces + modified_at: "2024-01-15T10:30:00Z" + modified_by: 00000000-0000-0000-0000-000000000002 + name: My annotation queue + owned_by: 00000000-0000-0000-0000-000000000002 + project_id: 00000000-0000-0000-0000-000000000002 + id: 00000000-0000-0000-0000-000000000001 + type: queues schema: $ref: "#/components/schemas/LLMObsAnnotationQueueResponse" description: OK @@ -104689,6 +109524,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + annotated_interactions: + - annotations: [] + content_id: trace-abc-123 + id: interaction-456 + type: trace + id: 00000000-0000-0000-0000-000000000001 + type: annotated_interactions schema: $ref: "#/components/schemas/LLMObsAnnotatedInteractionsResponse" description: OK @@ -104755,6 +109602,18 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + interactions: + - already_existed: false + content_id: trace-abc-123 + id: 00000000-0000-0000-0000-000000000000 + type: trace + id: 00000000-0000-0000-0000-000000000001 + type: interactions schema: $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsResponse" description: Created @@ -104870,7 +109729,7 @@ paths: attributes: annotation_schema: label_schemas: - - id: "ab12cd34" + - id: "abc-123" is_required: true max: 5.0 min: 0.0 @@ -104883,7 +109742,7 @@ paths: - positive - negative - neutral - id: "b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c" + id: "00000000-0000-0000-0000-000000000001" type: queues schema: $ref: "#/components/schemas/LLMObsAnnotationQueueLabelSchemaResponse" @@ -105009,6 +109868,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + annotation_schema: + label_schemas: + - id: abc-123 + is_required: true + max: 5.0 + min: 0.0 + name: quality + type: score + id: 00000000-0000-0000-0000-000000000001 + type: queues schema: $ref: "#/components/schemas/LLMObsAnnotationQueueLabelSchemaResponse" description: OK @@ -105088,6 +109962,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + config: + created_at: "2024-01-01T00:00:00+00:00" + dataset_id: 00000000-0000-0000-0000-000000000011 + description: "" + metadata: + name: My Experiment v1 + project_id: 00000000-0000-0000-0000-000000000010 + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000009 + type: experiments schema: $ref: "#/components/schemas/LLMObsExperimentsResponse" description: OK @@ -105143,12 +110032,42 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + config: + created_at: "2024-01-01T00:00:00+00:00" + dataset_id: 00000000-0000-0000-0000-000000000014 + description: "" + metadata: + name: My Experiment v1 + project_id: 00000000-0000-0000-0000-000000000013 + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000012 + type: experiments schema: $ref: "#/components/schemas/LLMObsExperimentResponse" description: OK "201": content: application/json: + examples: + default: + value: + data: + attributes: + config: + created_at: "2024-01-01T00:00:00+00:00" + dataset_id: 00000000-0000-0000-0000-000000000017 + description: "" + metadata: + name: My Experiment v1 + project_id: 00000000-0000-0000-0000-000000000016 + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000015 + type: experiments schema: $ref: "#/components/schemas/LLMObsExperimentResponse" description: Created @@ -105254,6 +110173,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + config: + created_at: "2024-01-01T00:00:00+00:00" + dataset_id: 00000000-0000-0000-0000-000000000020 + description: "" + metadata: + name: My Experiment v1 + project_id: 00000000-0000-0000-0000-000000000019 + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000018 + type: experiments schema: $ref: "#/components/schemas/LLMObsExperimentResponse" description: OK @@ -105394,6 +110328,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: "" + name: My LLM Project + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000001 + type: projects schema: $ref: "#/components/schemas/LLMObsProjectsResponse" description: OK @@ -105447,12 +110392,34 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: "" + name: My LLM Project + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000002 + type: projects schema: $ref: "#/components/schemas/LLMObsProjectResponse" description: OK "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: "" + name: My LLM Project + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000003 + type: projects schema: $ref: "#/components/schemas/LLMObsProjectResponse" description: Created @@ -105558,6 +110525,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: "" + name: My LLM Project + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000004 + type: projects schema: $ref: "#/components/schemas/LLMObsProjectResponse" description: OK @@ -105627,6 +110605,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + current_version: 1 + description: "" + metadata: + name: My LLM Dataset + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000005 + type: datasets schema: $ref: "#/components/schemas/LLMObsDatasetsResponse" description: OK @@ -105688,12 +110679,38 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + current_version: 1 + description: "" + metadata: + name: My LLM Dataset + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000006 + type: datasets schema: $ref: "#/components/schemas/LLMObsDatasetResponse" description: OK "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + current_version: 1 + description: "" + metadata: + name: My LLM Dataset + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000007 + type: datasets schema: $ref: "#/components/schemas/LLMObsDatasetResponse" description: Created @@ -105814,6 +110831,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + current_version: 1 + description: "" + metadata: + name: My LLM Dataset + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000008 + type: datasets schema: $ref: "#/components/schemas/LLMObsDatasetResponse" description: OK @@ -105880,6 +110910,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - created_at: "2024-01-01T00:00:00+00:00" + dataset_id: 00000000-0000-0000-0000-000000000022 + expected_output: + answer: "Paris" + id: 00000000-0000-0000-0000-000000000021 + input: + question: "What is the capital of France?" + metadata: + updated_at: "2024-01-01T00:00:00+00:00" schema: $ref: "#/components/schemas/LLMObsDatasetRecordsListResponse" description: OK @@ -105943,6 +110986,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - records: + - created_at: "2024-01-01T00:00:00+00:00" + dataset_id: 00000000-0000-0000-0000-000000000028 + expected_output: + answer: "Paris" + id: 00000000-0000-0000-0000-000000000027 + input: + question: "What is the capital of France?" + metadata: + updated_at: "2024-01-01T00:00:00+00:00" schema: $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse" description: OK @@ -106003,12 +111060,40 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - records: + - created_at: "2024-01-01T00:00:00+00:00" + dataset_id: 00000000-0000-0000-0000-000000000024 + expected_output: + answer: "Paris" + id: 00000000-0000-0000-0000-000000000023 + input: + question: "What is the capital of France?" + metadata: + updated_at: "2024-01-01T00:00:00+00:00" schema: $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse" description: OK "201": content: application/json: + examples: + default: + value: + data: + - records: + - created_at: "2024-01-01T00:00:00+00:00" + dataset_id: 00000000-0000-0000-0000-000000000026 + expected_output: + answer: "Paris" + id: 00000000-0000-0000-0000-000000000025 + input: + question: "What is the capital of France?" + metadata: + updated_at: "2024-01-01T00:00:00+00:00" schema: $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse" description: Created @@ -106232,6 +111317,9 @@ paths: "202": content: application/json: + examples: + default: + value: {} schema: type: object description: Request accepted for processing (always 202 empty JSON). @@ -106376,6 +111464,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + buckets: + - by: + host: my-hostname + computes: + c0: 19 + meta: + elapsed: 132 + status: done schema: $ref: "#/components/schemas/LogsAggregateResponse" description: OK @@ -106402,6 +111502,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + archive_ids: + - a2zcMylnM4OCHpYusxIi1g + - a2zcMylnM4OCHpYusxIi2g + - a2zcMylnM4OCHpYusxIi3g + type: archive_order schema: $ref: "#/components/schemas/LogsArchiveOrder" description: OK @@ -106449,6 +111559,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + archive_ids: + - a2zcMylnM4OCHpYusxIi1g + - a2zcMylnM4OCHpYusxIi2g + - a2zcMylnM4OCHpYusxIi3g + type: archive_order schema: $ref: "#/components/schemas/LogsArchiveOrder" description: OK @@ -106489,6 +111609,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + destination: + bucket: my-bucket + integration: + account_id: "123456789012" + role_name: my-role + type: s3 + include_tags: false + name: Nginx Archive + query: source:nginx + state: WORKING + id: 00000000-0000-0000-0000-000000000001 + type: archives schema: $ref: "#/components/schemas/LogsArchives" description: OK @@ -106538,6 +111675,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + destination: + bucket: my-bucket + integration: + account_id: "123456789012" + role_name: my-role + type: s3 + include_tags: false + name: Nginx Archive + query: source:nginx + state: WORKING + id: 00000000-0000-0000-0000-000000000002 + type: archives schema: $ref: "#/components/schemas/LogsArchive" description: OK @@ -106610,6 +111764,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + destination: + bucket: my-bucket + integration: + account_id: "123456789012" + role_name: my-role + type: s3 + include_tags: false + name: Nginx Archive + query: source:nginx + state: WORKING + id: 00000000-0000-0000-0000-000000000003 + type: archives schema: $ref: "#/components/schemas/LogsArchive" description: OK @@ -106677,6 +111848,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + destination: + bucket: my-bucket + integration: + account_id: "123456789012" + role_name: my-role + type: s3 + include_tags: false + name: Nginx Archive + query: source:nginx + state: WORKING + id: 00000000-0000-0000-0000-000000000004 + type: archives schema: $ref: "#/components/schemas/LogsArchive" description: OK @@ -106766,6 +111954,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: Example Role + id: 00000000-0000-0000-0000-000000000005 + type: roles schema: $ref: "#/components/schemas/RolesResponse" description: OK @@ -106853,6 +112049,26 @@ paths: "200": 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: + auth: + type: basic + endpoint: https://example.com + type: http + name: Nginx logs + query: source:nginx + id: 00000000-0000-0000-0000-000000000001 + type: custom_destination schema: $ref: "#/components/schemas/CustomDestinationsResponse" description: OK @@ -106903,6 +112119,26 @@ paths: "200": 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: + auth: + type: basic + endpoint: https://example.com + type: http + name: Nginx logs + query: source:nginx + id: 00000000-0000-0000-0000-000000000002 + type: custom_destination schema: $ref: "#/components/schemas/CustomDestinationResponse" description: OK @@ -106955,6 +112191,26 @@ paths: "200": 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: + auth: + type: basic + endpoint: https://example.com + type: http + name: Nginx logs + query: source:nginx + id: 00000000-0000-0000-0000-000000000003 + type: custom_destination schema: $ref: "#/components/schemas/CustomDestinationResponse" description: OK @@ -107008,6 +112264,26 @@ paths: "200": 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: + auth: + type: basic + endpoint: https://example.com + type: http + name: Nginx logs + query: source:nginx + id: 00000000-0000-0000-0000-000000000004 + type: custom_destination schema: $ref: "#/components/schemas/CustomDestinationResponse" description: OK @@ -107037,6 +112313,22 @@ paths: "200": 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/LogsMetricsResponse" description: OK @@ -107083,6 +112375,22 @@ paths: "200": 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/LogsMetricResponse" description: OK @@ -107133,6 +112441,22 @@ paths: "200": 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/LogsMetricResponse" description: OK @@ -107180,6 +112504,22 @@ paths: "200": 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/LogsMetricResponse" description: OK @@ -107210,6 +112550,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + modified_at: "2024-01-01T00:00:00+00:00" + restriction_query: "env:sandbox" + id: 00000000-0000-0000-0000-000000000001 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryListResponse" description: OK @@ -107251,6 +112601,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + restriction_query: "env:sandbox" + id: 00000000-0000-0000-0000-000000000002 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse" description: OK @@ -107289,6 +112647,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + modified_at: "2024-01-01T00:00:00+00:00" + restriction_query: "env:sandbox" + id: 00000000-0000-0000-0000-000000000007 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryListResponse" description: OK @@ -107332,6 +112700,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + modified_at: "2024-01-01T00:00:00+00:00" + restriction_query: "env:sandbox" + id: 00000000-0000-0000-0000-000000000006 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryListResponse" description: OK @@ -107414,6 +112792,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + restriction_query: "env:sandbox" + id: 00000000-0000-0000-0000-000000000003 + relationships: {} + type: logs_restriction_queries + included: [] schema: $ref: "#/components/schemas/RestrictionQueryWithRelationshipsResponse" description: OK @@ -107471,6 +112859,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + restriction_query: "env:sandbox" + id: 00000000-0000-0000-0000-000000000004 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse" description: OK @@ -107528,6 +112924,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + restriction_query: "env:sandbox" + id: 00000000-0000-0000-0000-000000000005 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse" description: OK @@ -107625,6 +113029,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: Datadog Admin Role + id: 00000000-0000-0000-0000-000000000008 + type: roles schema: $ref: "#/components/schemas/RestrictionQueryRolesResponse" description: OK @@ -107800,6 +113212,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + message: "Hello World" + service: web-app + tags: + - "env:prod" + timestamp: "2024-01-01T00:00:00+00:00" + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: log + meta: + elapsed: 132 + status: done schema: $ref: "#/components/schemas/LogsListResponse" description: OK @@ -107862,6 +113289,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + message: Host connected to remote + service: test-service + status: INFO + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: log + meta: + elapsed: 132 + status: done schema: $ref: "#/components/schemas/LogsListResponse" description: OK @@ -107986,6 +113426,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] + meta: + pagination: + next_cursor: schema: $ref: "#/components/schemas/MetricsAndMetricTagConfigurationsResponse" description: Success @@ -108052,6 +113499,16 @@ paths: "202": content: application/json: + examples: + default: + value: + data: + attributes: + emails: + - test@example.com + status: Accepted + id: kafka.lag + type: metric_bulk_configure_tags schema: $ref: "#/components/schemas/MetricBulkTagConfigResponse" description: Accepted @@ -108121,6 +113578,17 @@ paths: "202": content: application/json: + examples: + default: + value: + data: + attributes: + emails: + - test@example.com + tags: + - host + id: kafka.lag + type: metric_bulk_configure_tags schema: $ref: "#/components/schemas/MetricBulkTagConfigResponse" description: Accepted @@ -108177,6 +113645,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + active_aggregations: + - space: avg + time: avg + active_tags: + - app + id: http.endpoint.request + type: actively_queried_configurations schema: $ref: "#/components/schemas/MetricSuggestedTagsAndAggregationsResponse" description: Success @@ -108280,6 +113760,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - "env:prod" + - "host:myhost" + id: system.cpu.user + type: metrics schema: $ref: "#/components/schemas/MetricAllTagsResponse" description: Success @@ -108329,6 +113819,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: http.endpoint.request + relationships: + dashboards: + data: [] + monitors: + data: [] + notebooks: + data: [] + type: metrics schema: $ref: "#/components/schemas/MetricAssetsResponse" description: Success @@ -108415,6 +113918,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + estimate_type: count_or_gauge + estimated_at: "2024-01-01T00:00:00+00:00" + estimated_output_series: 50 + id: system.cpu.user + type: metric_cardinality_estimate schema: $ref: "#/components/schemas/MetricEstimateResponse" description: Success @@ -108458,6 +113971,11 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] + meta: {} schema: $ref: "#/components/schemas/MetricTagCardinalitiesResponse" description: Success @@ -108538,6 +114056,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + metric_type: distribution + tags: + - app + - datacenter + id: http.endpoint.request + type: manage_tags schema: $ref: "#/components/schemas/MetricTagConfigurationResponse" description: Success @@ -108602,6 +114131,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + metric_type: distribution + tags: + - app + - datacenter + id: http.endpoint.request + type: manage_tags schema: $ref: "#/components/schemas/MetricTagConfigurationResponse" description: OK @@ -108669,6 +114209,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + metric_type: distribution + tags: + - app + - datacenter + id: http.endpoint.request + type: manage_tags schema: $ref: "#/components/schemas/MetricTagConfigurationResponse" description: Created @@ -108717,6 +114268,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + indexed_volume: 100 + ingested_volume: 200 + id: http.endpoint.request + type: metric_volumes schema: $ref: "#/components/schemas/MetricVolumesResponse" description: Success @@ -108804,6 +114364,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + filter: + scope: "team:product" + name: A notification rule name + recipients: + - slack-test-channel + id: "00000000-0000-1234-0000-000000000000" + type: monitor-notification-rule schema: $ref: "#/components/schemas/MonitorNotificationRuleListResponse" description: OK @@ -108855,6 +114427,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + filter: + scope: "team:product" + name: A notification rule name + recipients: + - slack-test-channel + id: "00000000-0000-1234-0000-000000000000" + type: monitor-notification-rule schema: $ref: "#/components/schemas/MonitorNotificationRuleResponse" description: OK @@ -108937,6 +114521,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + filter: + scope: "team:product" + name: A notification rule name + recipients: + - slack-test-channel + id: "00000000-0000-1234-0000-000000000000" + type: monitor-notification-rule schema: $ref: "#/components/schemas/MonitorNotificationRuleResponse" description: OK @@ -109002,6 +114598,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + filter: + scope: "team:product AND host:abc" + modified: "2024-01-01T00:00:00+00:00" + 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/MonitorNotificationRuleResponse" description: OK @@ -109041,6 +114652,20 @@ paths: "200": 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/MonitorConfigPolicyListResponse" description: OK @@ -109091,6 +114716,20 @@ paths: "200": 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/MonitorConfigPolicyResponse" description: OK @@ -109173,6 +114812,20 @@ paths: "200": 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/MonitorConfigPolicyResponse" description: OK @@ -109238,6 +114891,20 @@ paths: "200": 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/MonitorConfigPolicyResponse" description: OK @@ -109277,6 +114944,26 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created: "2024-01-01T00:00:00+00:00" + description: This is a template for monitoring user activity. + modified: "2024-01-01T00:00:00+00:00" + 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 + title: Postgres CPU Monitor + version: 1 + id: "00000000-0000-1234-0000-000000000000" + type: monitor-user-template schema: $ref: "#/components/schemas/MonitorUserTemplateListResponse" description: OK @@ -109334,6 +115021,26 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + description: This is a template for monitoring user activity. + modified: "2024-01-01T00:00:00+00:00" + 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 + title: Postgres CPU Monitor + version: 1 + id: "00000000-0000-1234-0000-000000000000" + type: monitor-user-template schema: $ref: "#/components/schemas/MonitorUserTemplateCreateResponse" description: OK @@ -109464,6 +115171,26 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + description: This is a template for monitoring user activity. + modified: "2024-01-01T00:00:00+00:00" + 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 + title: Postgres CPU Monitor + version: 1 + id: "00000000-0000-1234-0000-000000000000" + type: monitor-user-template schema: $ref: "#/components/schemas/MonitorUserTemplateResponse" description: OK @@ -109535,6 +115262,26 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + description: This is a template for monitoring user activity. + modified: "2024-01-01T00:00:00+00:00" + 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 + title: Postgres CPU Monitor + version: 2 + id: "00000000-0000-1234-0000-000000000000" + type: monitor-user-template schema: $ref: "#/components/schemas/MonitorUserTemplateResponse" description: OK @@ -109658,6 +115405,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + end: "2024-01-01T01:00:00+00:00" + groups: + - service:postgres + scope: env:(staging OR prod) AND datacenter:us-east-1 + start: "2024-01-01T00:00:00+00:00" + id: "00000000-0000-1234-0000-000000000000" + type: downtime_match + meta: + page: + total_filtered_count: 1 schema: $ref: "#/components/schemas/MonitorDowntimeMatchResponse" description: OK @@ -109712,6 +115474,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + device_type: other + integration: snmp + ip_address: 1.2.3.4 + name: example device + status: ok + id: foiwf7rgw38fh + type: device + meta: + page: + total_filtered_count: 1 schema: $ref: "#/components/schemas/ListDevicesResponse" description: OK @@ -109744,6 +115521,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + device_type: other + integration: snmp + ip_address: 1.2.3.4 + model: xx-123 + name: example device + status: ok + vendor: example vendor + id: foiwf7rgw38fh + type: device schema: $ref: "#/components/schemas/GetDeviceResponse" description: OK @@ -109779,6 +115570,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: a network interface + index: 99 + mac_address: 00:00:00:00:00:00 + name: if0 + status: up + id: foiwf7rgw38fh:99 + type: interface schema: $ref: "#/components/schemas/GetInterfacesResponse" description: OK @@ -109805,6 +115608,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - "tag:test" + - "tag:testbis" + id: foiwf7rgw38fh + type: tags schema: $ref: "#/components/schemas/ListTagsResponse" description: OK @@ -109848,6 +115661,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - "tag:test" + - "tag:testbis" + id: foiwf7rgw38fh + type: tags schema: $ref: "#/components/schemas/ListTagsResponse" description: OK @@ -109876,6 +115699,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - "tag:test" + - "tag:testbis" + id: foiwf7rgw38fh:1 + type: tags schema: $ref: "#/components/schemas/ListInterfaceTagsResponse" description: OK @@ -109919,6 +115752,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - "tag:test" + - "tag:testbis" + id: foiwf7rgw38fh:1 + type: tags schema: $ref: "#/components/schemas/ListInterfaceTagsResponse" description: OK @@ -109971,6 +115814,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + bytes_sent_by_client: 100 + bytes_sent_by_server: 200 + packets_sent_by_client: 10 + packets_sent_by_server: 20 + id: abc-123 + type: aggregated_connection schema: $ref: "#/components/schemas/SingleAggregatedConnectionResponseArray" description: OK @@ -110021,6 +115875,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + group_bys: + - key: client_service + value: test-service + - key: network.dns_query + value: example.com + metrics: + - key: dns_total_requests + value: 100 + id: abc-123 + type: aggregated_dns schema: $ref: "#/components/schemas/SingleAggregatedDnsResponseArray" description: OK @@ -110042,6 +115911,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + config: + destinations: + - id: datadog-logs-destination + inputs: + - datadog-agent-source + type: datadog_logs + sources: + - id: datadog-agent-source + type: datadog_agent + name: Main Observability Pipeline + id: 00000000-0000-0000-0000-000000000001 + type: pipelines schema: $ref: "#/components/schemas/ListPipelinesResponse" description: OK @@ -110105,6 +115991,23 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + config: + destinations: + - id: datadog-logs-destination + inputs: + - datadog-agent-source + type: datadog_logs + sources: + - id: datadog-agent-source + type: datadog_agent + name: Main Observability Pipeline + id: 00000000-0000-0000-0000-000000000002 + type: pipelines schema: $ref: "#/components/schemas/ObservabilityPipeline" description: OK @@ -110173,6 +116076,10 @@ paths: "200": content: application/json: + examples: + default: + value: + errors: [] schema: $ref: "#/components/schemas/ValidationResponse" description: OK @@ -110244,6 +116151,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + config: + destinations: + - id: datadog-logs-destination + inputs: + - datadog-agent-source + type: datadog_logs + sources: + - id: datadog-agent-source + type: datadog_agent + name: Main Observability Pipeline + id: 00000000-0000-0000-0000-000000000003 + type: pipelines schema: $ref: "#/components/schemas/ObservabilityPipeline" description: OK @@ -110317,6 +116241,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + config: + destinations: + - id: datadog-logs-destination + inputs: + - datadog-agent-source + type: datadog_logs + sources: + - id: datadog-agent-source + type: datadog_agent + name: My Updated Pipeline + id: 00000000-0000-0000-0000-000000000004 + type: pipelines schema: $ref: "#/components/schemas/ObservabilityPipeline" description: OK @@ -110391,6 +116332,25 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: Escalation Policy 1 + resolve_page_on_policy_end: true + retries: 2 + id: 00000000-aba1-0000-0000-000000000000 + relationships: + steps: + data: + - id: 00000000-aba1-0000-0000-000000000000 + type: steps + teams: + data: + - id: 00000000-da3a-0000-0000-000000000000 + type: teams + type: policies schema: $ref: "#/components/schemas/EscalationPolicy" description: Created @@ -110467,6 +116427,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Escalation Policy 1 + resolve_page_on_policy_end: true + retries: 2 + id: 00000000-aba1-0000-0000-000000000000 + relationships: + steps: + data: + - id: 00000000-aba1-0000-0000-000000000000 + type: steps + teams: + data: + - id: 00000000-da3a-0000-0000-000000000000 + type: teams + type: policies schema: $ref: "#/components/schemas/EscalationPolicy" description: OK @@ -110541,6 +116520,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Escalation Policy 1 + resolve_page_on_policy_end: true + retries: 2 + id: 00000000-aba1-0000-0000-000000000000 + relationships: + steps: + data: + - id: 00000000-aba1-0000-0000-000000000000 + type: steps + teams: + data: + - id: 00000000-da3a-0000-0000-000000000000 + type: teams + type: policies schema: $ref: "#/components/schemas/EscalationPolicy" description: OK @@ -110594,6 +116592,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000001 + type: pages schema: $ref: "#/components/schemas/CreatePageResponse" description: OK. @@ -110876,6 +116880,24 @@ paths: "201": content: "application/json": + examples: + default: + value: + data: + attributes: + name: On-Call Schedule + time_zone: America/New_York + id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + relationships: + layers: + data: + - id: 00000000-0000-0000-0000-000000000001 + type: layers + teams: + data: + - id: 00000000-da3a-0000-0000-000000000000 + type: teams + type: schedules schema: $ref: "#/components/schemas/Schedule" description: Created @@ -110952,6 +116974,24 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + name: On-Call Schedule + time_zone: America/New_York + id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + relationships: + layers: + data: + - id: 00000000-0000-0000-0000-000000000001 + type: layers + teams: + data: + - id: 00000000-da3a-0000-0000-000000000000 + type: teams + type: schedules schema: $ref: "#/components/schemas/Schedule" description: OK @@ -111029,6 +117069,24 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + name: On-Call Schedule + time_zone: America/New_York + id: 00000000-0000-0000-0000-000000000001 + relationships: + layers: + data: + - id: 00000000-0000-0000-0000-000000000002 + type: layers + teams: + data: + - id: 00000000-0000-0000-0000-000000000003 + type: teams + type: schedules schema: $ref: "#/components/schemas/Schedule" description: OK @@ -111080,6 +117138,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + end: "2024-01-01T03:53:01.000000000Z" + start: "2024-01-01T02:53:01.000000000Z" + id: 00000000-0000-0000-0000-000000000000 + relationships: + user: + data: + id: 00000000-aba1-0000-0000-000000000000 + type: users + type: shifts schema: $ref: "#/components/schemas/Shift" description: OK @@ -111125,6 +117197,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000001 + relationships: + escalations: + data: + - id: 00000000-aba1-0000-0000-000000000000 + type: escalation_policy_steps + responders: + data: + - id: 00000000-aba1-0000-0000-000000000000 + type: users + type: team_oncall_responders schema: $ref: "#/components/schemas/TeamOnCallResponders" description: OK @@ -111170,6 +117257,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 27590dae-47be-4a7d-9abf-8f4e45124020 + type: team_routing_rules schema: $ref: "#/components/schemas/TeamRoutingRules" description: OK @@ -111243,6 +117336,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000001 + type: team_routing_rules schema: $ref: "#/components/schemas/TeamRoutingRules" description: OK @@ -111275,6 +117374,18 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + - attributes: + config: + address: test@example.com + formats: + - html + type: email + id: 27590dae-47be-4a7d-9abf-8f4e45124020 + type: notification_channels schema: $ref: "#/components/schemas/ListNotificationChannelsResponse" description: OK @@ -111331,6 +117442,18 @@ paths: "201": content: "application/json": + examples: + default: + value: + data: + attributes: + config: + address: test@example.com + formats: + - html + type: email + id: 27590dae-47be-4a7d-9abf-8f4e45124020 + type: notification_channels schema: $ref: "#/components/schemas/NotificationChannel" description: Created @@ -111420,6 +117543,18 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + config: + address: test@example.com + formats: + - html + type: email + id: 27590dae-47be-4a7d-9abf-8f4e45124020 + type: notification_channels schema: $ref: "#/components/schemas/NotificationChannel" description: OK @@ -111465,6 +117600,18 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + - attributes: + category: high_urgency + channel_settings: + method: sms + type: phone + delay_minutes: 1 + id: 27590dae-47be-4a7d-9abf-8f4e45124020 + type: notification_rules schema: $ref: "#/components/schemas/ListOnCallNotificationRulesResponse" description: OK @@ -111526,6 +117673,23 @@ paths: "201": content: "application/json": + examples: + default: + value: + data: + attributes: + category: high_urgency + channel_settings: + method: sms + type: phone + delay_minutes: 1 + id: 00000000-0000-0000-0000-000000000001 + relationships: + channel: + data: + id: 00000000-0000-0000-0000-000000000002 + type: notification_channels + type: notification_rules schema: $ref: "#/components/schemas/OnCallNotificationRule" description: Created @@ -111620,6 +117784,23 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + category: high_urgency + channel_settings: + method: sms + type: phone + delay_minutes: 1 + id: 27590dae-47be-4a7d-9abf-8f4e45124020 + relationships: + channel: + data: + id: 1562fab3-a8c2-49e2-8f3a-28dcda2405e2 + type: notification_channels + type: notification_rules schema: $ref: "#/components/schemas/OnCallNotificationRule" description: OK @@ -111694,6 +117875,23 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + category: high_urgency + channel_settings: + method: sms + type: phone + delay_minutes: 1 + id: 27590dae-47be-4a7d-9abf-8f4e45124020 + relationships: + channel: + data: + id: 1562fab3-a8c2-49e2-8f3a-28dcda2405e2 + type: notification_channels + type: notification_rules schema: $ref: "#/components/schemas/OnCallNotificationRule" description: OK @@ -111803,6 +118001,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: Example org config description + name: monitor_timezone + value: UTC + value_type: bool + id: abcd1234 + type: org_configs schema: {$ref: "#/components/schemas/OrgConfigListResponse"} description: OK "400": {$ref: "#/components/responses/BadRequestResponse"} @@ -111823,6 +118032,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: Example org config description + name: monitor_timezone + value: UTC + value_type: bool + id: abcd1234 + type: org_configs schema: {$ref: "#/components/schemas/OrgConfigGetResponse"} description: OK "400": {$ref: "#/components/responses/BadRequestResponse"} @@ -111855,6 +118075,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: Example org config description + name: monitor_timezone + value: UTC + value_type: bool + id: abcd1234 + type: org_configs schema: {$ref: "#/components/schemas/OrgConfigGetResponse"} description: OK "400": {$ref: "#/components/responses/BadRequestResponse"} @@ -111907,6 +118138,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + connection_types: + - logs + created_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000001 + relationships: {} + type: org_connection schema: $ref: "#/components/schemas/OrgConnectionListResponse" description: OK @@ -111954,6 +118196,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + connection_types: + - logs + created_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000002 + relationships: {} + type: org_connection schema: $ref: "#/components/schemas/OrgConnectionResponse" description: OK @@ -112036,6 +118289,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + connection_types: + - logs + - metrics + created_at: "2024-01-01T00:00:00+00:00" + id: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a + type: org_connection schema: $ref: "#/components/schemas/OrgConnectionResponse" description: OK @@ -113467,6 +119731,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: Full access to all resources. + display_name: Admin + group_name: General + name: admin + restricted: false + id: 00000000-0000-0000-0000-000000000001 + type: permissions schema: $ref: "#/components/schemas/PermissionsResponse" description: OK @@ -113510,6 +119786,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + expires_at: "2025-12-31T23:59:59+00:00" + name: My Personal Access Token + scopes: + - dashboards_read + id: 00000000-0000-0000-0000-000000000002 + type: personal_access_tokens + meta: + page: + total_filtered_count: 1 schema: $ref: "#/components/schemas/ListPersonalAccessTokensResponse" description: OK @@ -113559,6 +119850,20 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + expires_at: "2025-12-31T23:59:59+00:00" + key: "" + name: My Personal Access Token + public_portion: ddpat_abc123 + scopes: + - dashboards_read + id: 00000000-0000-0000-0000-000000000001 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenCreateResponse" description: Created @@ -113624,6 +119929,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + expires_at: "2025-12-31T23:59:59+00:00" + name: My Personal Access Token + scopes: + - dashboards_read + id: 00000000-0000-0000-0000-000000000003 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenResponse" description: OK @@ -113675,6 +119992,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + expires_at: "2025-12-31T23:59:59+00:00" + name: My Personal Access Token + scopes: + - dashboards_read + id: 00000000-0000-0000-0000-000000000004 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenResponse" description: OK @@ -113871,6 +120200,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + evaluation: fail + resource: "arn:aws:s3:::my-bucket" + resource_type: aws_s3_bucket + status: high + id: abc-123-xyz + type: finding + meta: + page: + cursor: "eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0=" + total_filtered_count: 1 + snapshot_timestamp: 1678721573794 schema: $ref: "#/components/schemas/ListFindingsResponse" description: OK @@ -113939,6 +120284,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: finding schema: $ref: "#/components/schemas/BulkMuteFindingsResponse" description: OK @@ -113996,6 +120347,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + evaluation: fail + message: "## Remediation\n\n1. Go to Storage Account." + resource: my_resource_name + resource_type: azure_storage_account + status: critical + id: abc-123 + type: detailed_finding schema: $ref: "#/components/schemas/GetFindingResponse" description: OK @@ -114040,6 +120403,30 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: Powerpack for ABC + group_widget: + definition: + layout_type: ordered + type: group + widgets: + - definition: + content: example + type: note + layout: + height: 5 + width: 10 + x: 0 + y: 0 + name: Sample Powerpack + tags: + - "tag:foo1" + id: 00000000-0000-0000-0000-000000000001 + type: powerpack schema: $ref: "#/components/schemas/ListPowerpacksResponse" description: OK @@ -114115,6 +120502,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000002 + type: powerpack schema: $ref: "#/components/schemas/PowerpackResponse" description: OK @@ -114187,6 +120580,30 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: Powerpack for ABC + group_widget: + definition: + layout_type: ordered + type: group + widgets: + - definition: + content: example + type: note + layout: + height: 5 + width: 10 + x: 0 + y: 0 + name: Sample Powerpack + tags: + - "tag:foo1" + id: 00000000-0000-0000-0000-000000000003 + type: powerpack schema: $ref: "#/components/schemas/PowerpackResponse" description: OK @@ -114271,6 +120688,30 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: Powerpack for ABC + group_widget: + definition: + layout_type: ordered + type: group + widgets: + - definition: + content: example + type: note + layout: + height: 5 + width: 10 + x: 0 + y: 0 + name: Sample Powerpack + tags: + - "tag:foo1" + id: 00000000-0000-0000-0000-000000000004 + type: powerpack schema: $ref: "#/components/schemas/PowerpackResponse" description: OK @@ -114361,6 +120802,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + cmdline: /usr/bin/python3 + host: my-host + pid: 123 + id: abc-123 + type: process schema: $ref: "#/components/schemas/ProcessSummariesResponse" description: OK @@ -114493,6 +120944,9 @@ paths: "202": content: application/json: + examples: + default: + value: {} schema: type: object description: Request accepted for processing (always 202 empty JSON). @@ -114613,6 +121067,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + result: + values: + - count: 4892 + value: Chrome + id: facet_info_response + type: users_facet_info schema: $ref: "#/components/schemas/FacetInfoResponse" description: Successful response with facet information @@ -114662,6 +121127,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + hits: + - account_id: "123" + account_name: Example Account + plan_type: enterprise + user_count: 150 + total: 1 + id: query_response + type: query_response schema: $ref: "#/components/schemas/QueryResponse" description: Successful response with account data @@ -114706,6 +121184,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + columns: [] + id: abc-123 + type: scalar_response schema: $ref: "#/components/schemas/ProductAnalyticsScalarResponse" description: OK @@ -114755,6 +121241,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + series: [] + times: [] + id: abc-123 + type: timeseries_response schema: $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponse" description: OK @@ -114810,6 +121305,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + hits: + - first_browser_name: Chrome + first_country_code: US + user_email: test@example.com + user_id: "123" + total: 1 + id: query_response + type: query_response schema: $ref: "#/components/schemas/QueryResponse" description: Successful response with filtered user data @@ -114850,6 +121358,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + result: + values: + - count: 4892 + value: Chrome + id: facet_info_response + type: users_facet_info schema: $ref: "#/components/schemas/FacetInfoResponse" description: Successful response with facet information @@ -114899,6 +121418,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + hits: + - user_email: test@example.com + user_id: "123" + total: 1 + id: query_response + type: query_response schema: $ref: "#/components/schemas/QueryResponse" description: Successful response with user data @@ -114928,6 +121458,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attributes: [] + id: get_mappings_response + type: get_mappings_response schema: $ref: "#/components/schemas/GetMappingResponse" description: Successful response with entity mapping configuration @@ -115095,6 +121633,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + connections: [] + id: list_connections_response + type: list_connections_response schema: $ref: "#/components/schemas/ListConnectionsResponse" description: Successful response with list of connections @@ -115141,6 +121687,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + columns: [] + type: scalar_response schema: $ref: "#/components/schemas/ScalarFormulaQueryResponse" description: OK @@ -115197,6 +121750,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + series: [] + times: [] + values: [] + type: timeseries_response schema: $ref: "#/components/schemas/TimeseriesFormulaQueryResponse" description: OK @@ -115255,6 +121817,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000000 + relationships: + rows: + data: + - id: row_id_1 + type: row + - id: row_id_2 + type: row + type: reference-tables-batch-rows-query schema: $ref: "#/components/schemas/BatchRowsQueryResponse" description: Successfully retrieved rows. Some or all requested rows were found. Response includes found rows in the included section. @@ -115337,6 +121912,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + status: DONE + table_name: my_reference_table + id: abc-123 + type: reference_table schema: $ref: "#/components/schemas/TableResultV2Array" description: OK @@ -115448,6 +122032,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + status: DONE + table_name: my_reference_table + id: abc-123 + type: reference_table schema: $ref: "#/components/schemas/TableResultV2" description: Created @@ -115505,6 +122098,34 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_by: 00000000-0000-0000-0000-000000000000 + description: example description + file_metadata: + access_details: {} + sync_enabled: false + last_updated_by: 00000000-0000-0000-0000-000000000000 + row_count: 5 + schema: + fields: + - name: id + type: INT32 + - name: name + type: STRING + primary_keys: + - id + source: S3 + status: DONE + table_name: test_reference_table + tags: + - tag1 + updated_at: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000000 + type: reference_table schema: $ref: "#/components/schemas/TableResultV2" description: OK @@ -115650,6 +122271,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + values: + id: 1 + name: Example Row + id: row_id_1 + type: row schema: $ref: "#/components/schemas/TableRowResourceArray" description: Some or all requested rows were found. @@ -115756,6 +122387,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + part_urls: + - https://example.com/upload-part-1 + id: 00000000-0000-0000-0000-000000000000 + type: upload schema: $ref: "#/components/schemas/CreateUploadResponse" description: Created @@ -115780,6 +122420,27 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + blocking: false + conditions: + - operator: match_regex + parameters: + inputs: + - address: server.request.query + key_path: + - id + regex: path.* + enabled: false + name: Block request from bad useragent + tags: + category: attack_attempt + type: lfi + id: 00000000-0000-0000-0000-000000000003 + type: custom_rule schema: $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleListResponse" description: OK @@ -115831,6 +122492,27 @@ paths: "201": content: "application/json": + examples: + default: + value: + data: + attributes: + blocking: false + conditions: + - operator: match_regex + parameters: + inputs: + - address: server.request.query + key_path: + - id + regex: path.* + enabled: false + name: Block request from a bad useragent + tags: + category: attack_attempt + type: lfi + id: 00000000-0000-0000-0000-000000000004 + type: custom_rule schema: $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse" description: Created @@ -115876,6 +122558,27 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + blocking: false + conditions: + - operator: match_regex + parameters: + inputs: + - address: server.request.query + key_path: + - id + regex: path.* + enabled: false + name: Block request from bad useragent + tags: + category: attack_attempt + type: lfi + id: 00000000-0000-0000-0000-000000000001 + type: custom_rule schema: $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse" description: OK @@ -115936,6 +122639,27 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + blocking: false + conditions: + - operator: match_regex + parameters: + inputs: + - address: server.request.query + key_path: + - id + regex: path.* + enabled: false + name: Block request from bad useragent + tags: + category: attack_attempt + type: lfi + id: 00000000-0000-0000-0000-000000000002 + type: custom_rule schema: $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse" description: OK @@ -115962,6 +122686,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: Exclude false positives on a path + enabled: true + ip_list: + - 198.51.100.72 + parameters: + - list.search.query + path_glob: /accounts/* + id: 00000000-0000-0000-0000-000000000003 + type: exclusion_filter schema: $ref: "#/components/schemas/ApplicationSecurityWafExclusionFiltersResponse" description: OK @@ -116017,6 +122755,20 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + description: Exclude false positives on a path + enabled: true + ip_list: + - 198.51.100.72 + parameters: + - list.search.query + path_glob: /accounts/* + id: 00000000-0000-0000-0000-000000000004 + type: exclusion_filter schema: $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse" description: OK @@ -116071,6 +122823,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: Exclude false positives on a path + enabled: true + ip_list: + - 198.51.100.72 + parameters: + - list.search.query + path_glob: /accounts/* + id: 00000000-0000-0000-0000-000000000001 + type: exclusion_filter schema: $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse" description: OK @@ -116128,6 +122894,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: Exclude false positives on a path + enabled: true + ip_list: + - 198.51.100.72 + parameters: + - list.search.query + path_glob: /accounts/* + id: 00000000-0000-0000-0000-000000000002 + type: exclusion_filter schema: $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse" description: OK @@ -116163,6 +122943,17 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + - attributes: + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + name: my_agent_rule + id: abc-123 + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse" description: OK @@ -116201,6 +122992,17 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + name: my_agent_rule + id: abc-123 + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK @@ -116249,6 +123051,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + name: my_agent_rule + id: abc-123 + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK @@ -116293,6 +123106,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + name: my_agent_rule + id: abc-123 + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK @@ -116320,6 +123144,16 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + - attributes: + description: My agent policy + enabled: true + name: my_agent_policy + id: abc-123 + type: policy schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentPoliciesListResponse" description: OK @@ -116357,6 +123191,16 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + description: My agent policy + enabled: true + name: my_agent_policy + id: abc-123 + type: policy schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse" description: OK @@ -116384,6 +123228,7 @@ paths: "200": content: application/zip: + example: "" schema: format: binary type: string @@ -116428,6 +123273,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: My agent policy + enabled: true + name: my_agent_policy + id: abc-123 + type: policy schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse" description: OK @@ -116469,6 +123324,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: My agent policy + enabled: true + name: my_agent_policy + id: abc-123 + type: policy schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse" description: OK @@ -116519,6 +123384,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + device_type: desktop + event_id: 11111111-2222-3333-4444-555555555555 + snapshot_name: My Snapshot + view_name: /home + id: 00000000-0000-0000-0000-000000000001 + type: snapshots schema: $ref: "#/components/schemas/SnapshotArray" description: OK @@ -116557,6 +123433,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + device_type: desktop + event_id: 11111111-2222-3333-4444-555555555555 + snapshot_name: My Snapshot + view_name: /home + id: 00000000-0000-0000-0000-000000000001 + type: snapshots schema: $ref: "#/components/schemas/Snapshot" description: Created @@ -116624,6 +123511,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + device_type: desktop + event_id: 11111111-2222-3333-4444-555555555555 + snapshot_name: My Snapshot + view_name: /home + id: 00000000-0000-0000-0000-000000000001 + type: snapshots schema: $ref: "#/components/schemas/Snapshot" description: OK @@ -116670,6 +123568,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + bindings: + - principals: + - "role:00000000-0000-1111-0000-000000000000" + relation: editor + id: dashboard:abc-def-ghi + type: restriction_policy schema: $ref: "#/components/schemas/RestrictionPolicyResponse" description: OK @@ -116780,6 +123689,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + bindings: + - principals: + - "role:00000000-0000-1111-0000-000000000000" + relation: editor + id: dashboard:abc-def-ghi + type: restriction_policy schema: $ref: "#/components/schemas/RestrictionPolicyResponse" description: OK @@ -116832,6 +123752,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: developers + id: 00000000-0000-0000-0000-000000000001 + type: roles + meta: + page: + total_count: 1 + total_filtered_count: 1 schema: $ref: "#/components/schemas/RolesResponse" description: OK @@ -116875,6 +123807,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: developers + id: 00000000-0000-0000-0000-000000000002 + type: roles schema: $ref: "#/components/schemas/RoleCreateResponse" description: OK @@ -116913,6 +123853,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: Datadog Standard Role + id: 00000000-0000-0000-0000-000000000012 + type: roles schema: $ref: "#/components/schemas/RoleTemplateArray" description: OK @@ -116968,6 +123916,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: developers + id: 00000000-0000-0000-0000-000000000003 + type: roles schema: $ref: "#/components/schemas/RoleResponse" description: OK @@ -117018,6 +123974,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: developers + id: 00000000-0000-0000-0000-000000000004 + type: roles schema: $ref: "#/components/schemas/RoleUpdateResponse" description: OK @@ -117083,6 +124047,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: developers + id: 00000000-0000-0000-0000-000000000011 + type: roles schema: $ref: "#/components/schemas/RoleResponse" description: OK @@ -117147,6 +124119,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: logs_read_data + id: 00000000-0000-0000-0000-000000000007 + type: permissions schema: $ref: "#/components/schemas/PermissionsResponse" description: OK @@ -117192,6 +124172,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: logs_read_data + id: 00000000-0000-0000-0000-000000000005 + type: permissions schema: $ref: "#/components/schemas/PermissionsResponse" description: OK @@ -117239,6 +124227,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: logs_read_data + id: 00000000-0000-0000-0000-000000000006 + type: permissions schema: $ref: "#/components/schemas/PermissionsResponse" description: OK @@ -117297,6 +124293,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: test@example.com + name: Example Name + id: 00000000-0000-0000-0000-000000000010 + type: users schema: $ref: "#/components/schemas/UsersResponse" description: OK @@ -117360,6 +124365,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: test@example.com + name: Example Name + id: 00000000-0000-0000-0000-000000000008 + type: users schema: $ref: "#/components/schemas/UsersResponse" description: OK @@ -117406,6 +124420,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: test@example.com + name: Example Name + id: 00000000-0000-0000-0000-000000000009 + type: users schema: $ref: "#/components/schemas/UsersResponse" description: OK @@ -117483,6 +124506,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + buckets: + - by: + "@session.type": user + "@type": view + computes: + c0: 19 + meta: + elapsed: 132 + request_id: abc-123 + status: done schema: $ref: "#/components/schemas/RUMAnalyticsAggregateResponse" description: OK @@ -117507,6 +124544,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + application_id: abc-123 + created_at: 1659479836169 + created_by_handle: example-handle + name: my_rum_application + org_id: 123 + type: browser + updated_at: 1659479836169 + updated_by_handle: example-handle + id: abc-123 + type: rum_application schema: $ref: "#/components/schemas/RUMApplicationsResponse" description: OK @@ -117543,6 +124595,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + application_id: abc-123 + client_token: abc-123-token + created_at: 1659479836169 + created_by_handle: example-handle + name: my_rum_application + org_id: 123 + type: browser + updated_at: 1659479836169 + updated_by_handle: example-handle + id: abc-123 + type: rum_application schema: $ref: "#/components/schemas/RUMApplicationResponse" description: OK @@ -117582,6 +124650,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: "051601eb-54a0-abc0-03f9-cc02efa18892" + type: retention_filters schema: $ref: "#/components/schemas/RumRetentionFiltersOrderResponse" description: Ordered @@ -117605,6 +124679,21 @@ paths: "200": 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/RumRetentionFiltersResponse" description: OK @@ -117647,6 +124736,18 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + event_type: session + name: Retention filter for session + query: "@session.has_replay:true" + sample_rate: 50.5 + id: 00000000-0000-0000-0000-000000000001 + type: retention_filters schema: $ref: "#/components/schemas/RumRetentionFilterResponse" description: Created @@ -117689,6 +124790,21 @@ paths: "200": 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/RumRetentionFilterResponse" description: OK @@ -117735,6 +124851,21 @@ paths: "200": 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/RumRetentionFilterResponse" description: Updated @@ -117788,6 +124919,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + application_id: abc-123 + client_token: abc-123-token + created_at: 1659479836169 + created_by_handle: example-handle + name: my_rum_application + org_id: 123 + type: browser + updated_at: 1659479836169 + updated_by_handle: example-handle + id: abc-123 + type: rum_application schema: $ref: "#/components/schemas/RUMApplicationResponse" description: OK @@ -117832,6 +124979,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + application_id: abc-123 + client_token: abc-123-token + created_at: 1659479836169 + created_by_handle: example-handle + name: updated_name_for_my_existing_rum_application + org_id: 123 + type: browser + updated_at: 1659479836169 + updated_by_handle: example-handle + id: abc-123 + type: rum_application schema: $ref: "#/components/schemas/RUMApplicationResponse" description: OK @@ -117862,6 +125025,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + compute: + aggregation_type: distribution + include_percentiles: true + path: "@duration" + event_type: session + filter: + query: "@service:web-api" + group_by: + - path: "@browser.name" + tag_name: browser_name + uniqueness: + when: match + id: rum.sessions.web.count + type: rum_metrics schema: $ref: "#/components/schemas/RumMetricsResponse" description: OK @@ -117891,7 +125073,7 @@ paths: path: "@duration" event_type: session filter: - query: "@service:web-api:" + query: "@service:web-api" group_by: - path: "@browser.name" tag_name: browser_name @@ -117907,6 +125089,25 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + compute: + aggregation_type: distribution + include_percentiles: true + path: "@duration" + event_type: session + filter: + query: "@service:web-api" + group_by: + - path: "@browser.name" + tag_name: browser_name + uniqueness: + when: match + id: rum.sessions.web.count + type: rum_metrics schema: $ref: "#/components/schemas/RumMetricResponse" description: Created @@ -117949,6 +125150,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + compute: + aggregation_type: distribution + include_percentiles: true + path: "@duration" + event_type: session + filter: + query: "@service:web-api" + group_by: + - path: "@browser.name" + tag_name: browser_name + uniqueness: + when: match + id: rum.sessions.web.count + type: rum_metrics schema: $ref: "#/components/schemas/RumMetricResponse" description: OK @@ -117979,7 +125199,7 @@ paths: compute: include_percentiles: true filter: - query: "@service:web-api:" + query: "@service:web-api" group_by: - path: "@browser.name" tag_name: browser_name @@ -117993,6 +125213,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + compute: + aggregation_type: distribution + include_percentiles: true + path: "@duration" + event_type: session + filter: + query: "@service:web-api" + group_by: + - path: "@browser.name" + tag_name: browser_name + uniqueness: + when: match + id: rum.sessions.web.count + type: rum_metrics schema: $ref: "#/components/schemas/RumMetricResponse" description: OK @@ -118072,6 +125311,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + service: test-service + timestamp: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: rum schema: $ref: "#/components/schemas/RUMEventsResponse" description: OK @@ -118125,6 +125373,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + service: test-service + timestamp: "2024-01-01T00:00:00+00:00" + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: rum + meta: + elapsed: 132 + request_id: abc-123 + status: done schema: $ref: "#/components/schemas/RUMEventsResponse" description: OK @@ -118179,6 +125440,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: My Playlist + id: "123" + type: rum_replay_playlist schema: $ref: "#/components/schemas/PlaylistArray" description: OK @@ -118215,6 +125484,14 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: My Playlist + id: "123" + type: rum_replay_playlist schema: $ref: "#/components/schemas/Playlist" description: Created @@ -118266,6 +125543,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: My Playlist + id: "123" + type: rum_replay_playlist schema: $ref: "#/components/schemas/Playlist" description: OK @@ -118310,6 +125595,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: My Playlist + id: "123" + type: rum_replay_playlist schema: $ref: "#/components/schemas/Playlist" description: OK @@ -118385,6 +125678,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + track: main + id: 00000000-0000-0000-0000-000000000001 + type: rum_replay_session schema: $ref: "#/components/schemas/PlaylistsSessionArray" description: OK @@ -118464,12 +125765,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + track: main + id: 00000000-0000-0000-0000-000000000001 + type: rum_replay_session schema: $ref: "#/components/schemas/PlaylistsSession" description: OK "201": content: application/json: + examples: + default: + value: + data: + attributes: + track: main + id: 00000000-0000-0000-0000-000000000001 + type: rum_replay_session schema: $ref: "#/components/schemas/PlaylistsSession" description: Created @@ -118566,6 +125883,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + handle: test@example.com + last_watched_at: "2024-01-01T00:00:00+00:00" + watch_count: 1 + id: abc-123 + type: rum_replay_watcher schema: $ref: "#/components/schemas/WatcherArray" description: OK @@ -118632,6 +125959,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + application_id: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb + event_id: 11111111-2222-3333-4444-555555555555 + timestamp: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: rum_replay_watch schema: $ref: "#/components/schemas/Watch" description: Created @@ -118697,6 +126034,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + last_watched_at: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: rum_replay_session schema: $ref: "#/components/schemas/ViewershipHistorySessionArray" description: OK @@ -119808,6 +127153,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + assigned_at: "2024-01-01T00:00:00+00:00" + email: test@example.com + name: Example Name + id: 00000000-0000-0000-0000-000000000001 + type: seat-users schema: $ref: "#/components/schemas/SeatUserDataArray" description: OK @@ -119853,6 +127208,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + assigned_ids: + - abc-123 + product_code: example-product + id: 00000000-0000-0000-0000-000000000002 + type: seat-assignments schema: $ref: "#/components/schemas/AssignSeatsUserResponse" description: Created @@ -119954,6 +127319,45 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + configRisks: + hasIdentityRisk: false + hasMisconfiguration: true + hasPrivilegedRole: false + isPrivileged: false + isProduction: true + isPubliclyAccessible: true + entityID: "arn:aws:iam::123456789012:user/test-user" + entityMetadata: + environments: + - production + mitreTactics: [] + mitreTechniques: [] + services: + - api-gateway + sources: + - cloudtrail + entityName: test-user + entityProviders: + - aws + entityRoles: [] + entityType: aws_iam_user + firstDetected: 1704067200000 + lastActivityTitle: "Suspicious API call detected" + lastDetected: 1705276800000 + riskScore: 85 + riskScoreEvolution: 12 + severity: critical + signalsDetected: 15 + id: "arn:aws:iam::123456789012:user/test-user" + type: security_entity_risk_score + meta: + page: + total: 1 schema: $ref: "#/components/schemas/SecurityEntityRiskScoresResponse" description: OK @@ -119996,6 +127400,7 @@ paths: "200": content: application/yaml: + example: "" schema: format: binary type: string @@ -120058,6 +127463,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + attributes: + severity: high + status: open + tags: + - "team:platform" + timestamp: 1765901760 + id: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw== + type: finding + meta: + elapsed: 548 + status: done schema: $ref: "#/components/schemas/ListSecurityFindingsResponse" description: OK @@ -120164,6 +127585,19 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: A description of the case. + modified_at: "2024-01-01T00:00:00+00:00" + priority: P4 + status: OPEN + title: A title for the case. + id: 00000000-0000-0000-0000-000000000001 + type: cases schema: $ref: "#/components/schemas/FindingCaseResponseArray" description: Created @@ -120220,6 +127654,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: A description of the case. + modified_at: "2024-01-01T00:00:00+00:00" + priority: P4 + status: OPEN + title: A title for the case. + id: 00000000-0000-0000-0000-000000000002 + type: cases schema: $ref: "#/components/schemas/FindingCaseResponse" description: OK @@ -120274,6 +127721,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: A description of the Jira issue. + modified_at: "2024-01-01T00:00:00+00:00" + priority: P4 + status: OPEN + title: A title for the Jira issue. + id: 00000000-0000-0000-0000-000000000004 + type: cases schema: $ref: "#/components/schemas/FindingCaseResponse" description: OK @@ -120332,6 +127792,19 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + description: A description of the Jira issue. + modified_at: "2024-01-01T00:00:00+00:00" + priority: P4 + status: OPEN + title: A title for the Jira issue. + id: 00000000-0000-0000-0000-000000000003 + type: cases schema: $ref: "#/components/schemas/FindingCaseResponseArray" description: Created @@ -120389,6 +127862,12 @@ paths: "202": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000001 + type: mute schema: $ref: "#/components/schemas/MuteFindingsResponse" description: Accepted @@ -120453,6 +127932,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + attributes: + severity: high + status: open + tags: + - "team:platform" + timestamp: 1765901760 + id: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw== + type: finding + meta: + elapsed: 548 + status: done schema: $ref: "#/components/schemas/ListSecurityFindingsResponse" description: OK @@ -120561,6 +128056,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListAssetsSBOMsResponse" description: OK @@ -120632,6 +128131,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + bomFormat: CycloneDX + components: + - name: google.golang.org/grpc + type: library + version: 1.68.1 + dependencies: [] + metadata: {} + serialNumber: urn:uuid:abc-123 + specVersion: "1.5" + version: 1 + id: "github.com/datadog/datadog-agent" + type: sboms schema: $ref: "#/components/schemas/GetSBOMResponse" description: OK @@ -120762,6 +128278,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + asset: + name: i-0fc7edef1ab26d7ef + type: Host + first_success_timestamp: "2024-01-01T00:00:00Z" + last_success: + env: prod + id: "Host|i-0fc7edef1ab26d7ef" schema: $ref: "#/components/schemas/ScannedAssetsMetadata" description: OK @@ -120846,6 +128374,22 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + data: + - id: abc-123 + indicator: "192.0.2.1" + indicator_type: ip + score: 85.0 + metadata: + count: 1 + paging: + offset: 0 + id: abc-123 + type: ioc_explorer_list_response schema: $ref: "#/components/schemas/IoCExplorerListResponse" description: OK @@ -120881,6 +128425,18 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + data: + id: abc-123 + indicator: "192.0.2.1" + indicator_type: ip + score: 85.0 + id: abc-123 + type: ioc_indicator_response schema: $ref: "#/components/schemas/GetIoCIndicatorResponse" description: OK @@ -120958,6 +128514,33 @@ paths: "201": content: "application/json": + examples: + default: + value: + data: + attributes: + created_at: 1722439510282 + created_by: + handle: example-handle + name: Example Name + enabled: true + modified_at: 1722439510282 + modified_by: + handle: example-handle + name: Example Name + name: Rule 1 + selectors: + query: env:prod + rule_types: + - log_detection + severities: + - critical + trigger_source: security_signals + targets: + - "@test@example.com" + version: 1 + id: aaa-bbb-ccc + type: notification_rules schema: $ref: "#/components/schemas/NotificationRuleResponse" description: Successfully created the notification rule. @@ -121022,6 +128605,33 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + created_at: 1722439510282 + created_by: + handle: example-handle + name: Example Name + enabled: true + modified_at: 1722439510282 + modified_by: + handle: example-handle + name: Example Name + name: Rule 1 + selectors: + query: env:prod + rule_types: + - log_detection + severities: + - critical + trigger_source: security_signals + targets: + - "@test@example.com" + version: 1 + id: aaa-bbb-ccc + type: notification_rules schema: $ref: "#/components/schemas/NotificationRuleResponse" description: Notification rule details. @@ -121084,6 +128694,33 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + created_at: 1722439510282 + created_by: + handle: example-handle + name: Example Name + enabled: true + modified_at: 1722439510282 + modified_by: + handle: example-handle + name: Example Name + name: Rule 1 + selectors: + query: env:prod + rule_types: + - log_detection + severities: + - critical + trigger_source: security_signals + targets: + - "@test@example.com" + version: 1 + id: aaa-bbb-ccc + type: notification_rules schema: $ref: "#/components/schemas/NotificationRuleResponse" description: Notification rule successfully patched. @@ -121519,6 +129156,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListVulnerabilitiesResponse" description: OK @@ -121611,6 +129252,34 @@ paths: "201": content: "application/json": + examples: + default: + value: + data: + attributes: + created_at: 1722439510282 + created_by: + handle: example-handle + name: Example Name + enabled: true + modified_at: 1722439510282 + modified_by: + handle: example-handle + name: Example Name + name: Rule 1 + selectors: + query: env:prod + rule_types: + - misconfiguration + severities: + - critical + trigger_source: security_findings + targets: + - "@test@example.com" + time_aggregation: 86400 + version: 1 + id: aaa-bbb-ccc + type: notification_rules schema: $ref: "#/components/schemas/NotificationRuleResponse" description: Successfully created the notification rule. @@ -121675,6 +129344,34 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + created_at: 1722439510282 + created_by: + handle: example-handle + name: Example Name + enabled: true + modified_at: 1722439510282 + modified_by: + handle: example-handle + name: Example Name + name: Rule 1 + selectors: + query: env:prod + rule_types: + - misconfiguration + severities: + - critical + trigger_source: security_findings + targets: + - "@test@example.com" + time_aggregation: 86400 + version: 1 + id: aaa-bbb-ccc + type: notification_rules schema: $ref: "#/components/schemas/NotificationRuleResponse" description: Notification rule details. @@ -121737,6 +129434,34 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + created_at: 1722439510282 + created_by: + handle: example-handle + name: Example Name + enabled: true + modified_at: 1722439510282 + modified_by: + handle: example-handle + name: Example Name + name: Rule 1 + selectors: + query: env:prod + rule_types: + - misconfiguration + severities: + - critical + trigger_source: security_findings + targets: + - "@test@example.com" + time_aggregation: 86400 + version: 1 + id: aaa-bbb-ccc + type: notification_rules schema: $ref: "#/components/schemas/NotificationRuleResponse" description: Notification rule successfully patched. @@ -121904,6 +129629,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListVulnerableAssetsResponse" description: OK @@ -121951,6 +129680,17 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + - attributes: + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + name: my_agent_rule + id: abc-123 + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse" description: OK @@ -121991,6 +129731,17 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + name: my_agent_rule + id: abc-123 + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK @@ -122045,6 +129796,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + name: my_agent_rule + id: abc-123 + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK @@ -122090,6 +129852,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: My Agent rule + enabled: true + expression: exec.file.name == "sh" + name: my_agent_rule + id: abc-123 + type: agent_rule schema: $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK @@ -122118,6 +129891,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + enabled: true + query: security:monitoring + rule_query: type:log_detection source:cloudtrail + severity: increase + version: 1 + id: 4e2435a5-6670-4b8f-baff-46083cd1c250 + type: critical_assets schema: $ref: "#/components/schemas/SecurityMonitoringCriticalAssetsResponse" description: OK @@ -122160,6 +129945,18 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + enabled: true + query: security:monitoring + rule_query: type:log_detection source:cloudtrail + severity: increase + version: 1 + id: 4e2435a5-6670-4b8f-baff-46083cd1c250 + type: critical_assets schema: $ref: "#/components/schemas/SecurityMonitoringCriticalAssetResponse" description: OK @@ -122190,6 +129987,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + enabled: true + query: security:monitoring + rule_query: type:log_detection source:cloudtrail + severity: increase + version: 1 + id: 4e2435a5-6670-4b8f-baff-46083cd1c250 + type: critical_assets schema: $ref: "#/components/schemas/SecurityMonitoringCriticalAssetsResponse" description: OK @@ -122239,6 +130048,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + query: security:monitoring + rule_query: type:log_detection source:cloudtrail + severity: increase + version: 1 + id: 4e2435a5-6670-4b8f-baff-46083cd1c250 + type: critical_assets schema: $ref: "#/components/schemas/SecurityMonitoringCriticalAssetResponse" description: OK @@ -122286,6 +130107,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + query: security:monitoring + rule_query: type:log_detection source:cloudtrail + severity: increase + version: 1 + id: 4e2435a5-6670-4b8f-baff-46083cd1c250 + type: critical_assets schema: $ref: "#/components/schemas/SecurityMonitoringCriticalAssetResponse" description: OK @@ -122315,6 +130148,22 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + - attributes: + exclusion_filters: + - name: Exclude staging + query: source:staging + filtered_data_type: logs + is_builtin: false + is_enabled: true + name: Custom security filter + query: service:api + version: 1 + id: 3dd-0uc-h1s + type: security_filters schema: $ref: "#/components/schemas/SecurityFiltersResponse" description: OK @@ -122364,6 +130213,22 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + exclusion_filters: + - name: Exclude staging + query: source:staging + filtered_data_type: logs + is_builtin: false + is_enabled: true + name: Custom security filter + query: service:api + version: 1 + id: 3dd-0uc-h1s + type: security_filters schema: $ref: "#/components/schemas/SecurityFilterResponse" description: OK @@ -122426,6 +130291,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + exclusion_filters: + - name: Exclude staging + query: source:staging + filtered_data_type: logs + is_builtin: false + is_enabled: true + name: Custom security filter + query: service:api + version: 1 + id: 3dd-0uc-h1s + type: security_filters schema: $ref: "#/components/schemas/SecurityFilterResponse" description: OK @@ -122476,6 +130357,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + exclusion_filters: + - name: Exclude staging + query: source:staging + filtered_data_type: logs + is_builtin: false + is_enabled: true + name: Custom security filter + query: service:api + version: 1 + id: 3dd-0uc-h1s + type: security_filters schema: $ref: "#/components/schemas/SecurityFilterResponse" description: OK @@ -122532,6 +130429,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + editable: true + enabled: true + name: Custom suppression + rule_query: type:log_detection source:cloudtrail + suppression_query: env:staging status:low + version: 1 + id: 3dd-0uc-h1s + type: suppressions + meta: + page: + pageNumber: 0 + pageSize: 10 + totalCount: 1 schema: $ref: "#/components/schemas/SecurityMonitoringPaginatedSuppressionsResponse" description: OK @@ -122578,6 +130493,17 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + enabled: true + name: Custom suppression + rule_query: type:log_detection source:cloudtrail + suppression_query: env:staging status:low + id: abc-123 + type: suppressions schema: $ref: "#/components/schemas/SecurityMonitoringSuppressionResponse" description: OK @@ -122661,6 +130587,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + enabled: true + name: Custom suppression + rule_query: type:log_detection source:cloudtrail + suppression_query: env:staging status:low + id: abc-123 + type: suppressions schema: $ref: "#/components/schemas/SecurityMonitoringSuppressionsResponse" description: OK @@ -122688,6 +130625,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + editable: true + enabled: true + name: Custom suppression + rule_query: type:log_detection source:cloudtrail + suppression_query: env:staging status:low + version: 1 + id: 3dd-0uc-h1s + type: suppressions schema: $ref: "#/components/schemas/SecurityMonitoringSuppressionsResponse" description: OK @@ -122785,6 +130735,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + editable: true + enabled: true + name: Custom suppression + rule_query: type:log_detection source:cloudtrail + suppression_query: env:staging status:low + version: 1 + id: 3dd-0uc-h1s + type: suppressions schema: $ref: "#/components/schemas/SecurityMonitoringSuppressionResponse" description: OK @@ -122835,6 +130798,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + editable: true + enabled: true + name: Custom suppression + rule_query: type:log_detection source:cloudtrail + suppression_query: env:staging status:low + version: 1 + id: 3dd-0uc-h1s + type: suppressions schema: $ref: "#/components/schemas/SecurityMonitoringSuppressionResponse" description: OK @@ -122868,6 +130844,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + count: 1 + data: + "1": + changes: [] + suppression: + enabled: true + name: Custom suppression + rule_query: type:log_detection source:cloudtrail + version: 1 + id: 3dd-0uc-h1s + type: suppression_version_history schema: $ref: "#/components/schemas/GetSuppressionVersionHistoryResponse" description: OK @@ -122895,6 +130887,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + cloud_siem_index_incorrect: false + cp_activation: activated + filters_configured_for_logs: true + logs_last_collected: within_24_hours + logs_seen_from_any_index: true + state: active + id: aws-cloudtrail + type: content_pack_state + meta: + cloud_siem_index_incorrect: false + sku: add_on_2024 schema: $ref: "#/components/schemas/SecurityMonitoringContentPackStatesResponse" description: OK @@ -123047,6 +131055,15 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + - id: abc-123 + isEnabled: true + name: My security monitoring rule. + type: log_detection + meta: {} schema: $ref: "#/components/schemas/SecurityMonitoringListRulesResponse" description: OK @@ -123109,6 +131126,20 @@ paths: "200": content: "application/json": + examples: + default: + value: + cases: + - condition: "a > 0" + name: "" + notifications: [] + status: info + id: abc-123 + isEnabled: true + message: Test rule + name: My security monitoring rule. + tags: [] + type: log_detection schema: $ref: "#/components/schemas/SecurityMonitoringRuleResponse" description: OK @@ -123157,6 +131188,9 @@ paths: "200": content: application/zip: + examples: + default: + value: "" schema: format: binary type: string @@ -123261,6 +131295,11 @@ paths: "200": content: "application/json": + examples: + default: + value: + ruleId: abc-123 + terraformContent: 'resource "datadog_security_monitoring_rule" "example" {}' schema: $ref: "#/components/schemas/SecurityMonitoringRuleConvertResponse" description: OK @@ -123366,6 +131405,11 @@ paths: "200": content: "application/json": + examples: + default: + value: + results: + - true schema: $ref: "#/components/schemas/SecurityMonitoringRuleTestResponse" description: OK @@ -123520,6 +131564,20 @@ paths: "200": content: "application/json": + examples: + default: + value: + cases: + - condition: "a > 0" + name: "" + notifications: [] + status: info + id: abc-123 + isEnabled: true + message: Test rule + name: My security monitoring rule. + tags: [] + type: log_detection schema: $ref: "#/components/schemas/SecurityMonitoringRuleResponse" description: OK @@ -123580,6 +131638,20 @@ paths: "200": content: "application/json": + examples: + default: + value: + cases: + - condition: "a > 0" + name: "" + notifications: [] + status: info + id: abc-123 + isEnabled: true + message: Test rule + name: My security monitoring rule. + tags: [] + type: log_detection schema: $ref: "#/components/schemas/SecurityMonitoringRuleResponse" description: OK @@ -123622,6 +131694,11 @@ paths: "200": content: "application/json": + examples: + default: + value: + ruleId: abc-123 + terraformContent: 'resource "datadog_security_monitoring_rule" "example" {}' schema: $ref: "#/components/schemas/SecurityMonitoringRuleConvertResponse" description: OK @@ -123702,6 +131779,11 @@ paths: "200": content: "application/json": + examples: + default: + value: + results: + - true schema: $ref: "#/components/schemas/SecurityMonitoringRuleTestResponse" description: OK @@ -123739,6 +131821,15 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + count: 1 + data: {} + id: abc-123 + type: GetRuleVersionHistoryResponse schema: $ref: "#/components/schemas/GetRuleVersionHistoryResponse" description: OK @@ -123776,6 +131867,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + tags: + - "source:cloudtrail" + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: signal + links: + next: "" + meta: + page: + after: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== schema: $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse" description: OK @@ -123826,6 +131931,21 @@ paths: "200": content: application/json: + examples: + default: + value: + result: + count: 1 + events: + - event: + assignee: + uuid: 00000000-0000-0000-0000-000000000001 + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + incident_ids: [] + state: archived + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + status: done + type: status schema: $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse" description: OK @@ -123876,6 +131996,21 @@ paths: "200": content: application/json: + examples: + default: + value: + result: + count: 1 + events: + - event: + assignee: + uuid: 00000000-0000-0000-0000-000000000001 + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + incident_ids: [] + state: archived + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + status: done + type: status schema: $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse" description: OK @@ -123926,6 +132061,21 @@ paths: "200": content: application/json: + examples: + default: + value: + result: + count: 1 + events: + - event: + assignee: + uuid: 00000000-0000-0000-0000-000000000001 + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + incident_ids: [] + state: archived + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + status: done + type: status schema: $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse" description: OK @@ -123982,6 +132132,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + tags: + - "source:cloudtrail" + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: signal + links: + next: "" + meta: + page: + after: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== schema: $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse" description: OK @@ -124018,6 +132182,15 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + tags: + - "source:cloudtrail" + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: signal schema: $ref: "#/components/schemas/SecurityMonitoringSignalResponse" description: OK @@ -124063,6 +132236,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + assignee: + uuid: 00000000-0000-0000-0000-000000000001 + incident_ids: [] + state: archived + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: signal_metadata schema: $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse" description: OK @@ -124110,6 +132294,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + assignee: + uuid: 00000000-0000-0000-0000-000000000001 + incident_ids: [] + state: archived + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: signal_metadata schema: $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse" description: OK @@ -124206,6 +132401,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + assignee: + uuid: 00000000-0000-0000-0000-000000000001 + incident_ids: [] + state: archived + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: signal_metadata schema: $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse" description: OK @@ -124302,6 +132508,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + assignee: + uuid: 00000000-0000-0000-0000-000000000001 + incident_ids: [] + state: archived + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: signal_metadata schema: $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse" description: OK @@ -124365,6 +132582,9 @@ paths: "200": content: application/zip: + examples: + default: + value: "" schema: format: binary type: string @@ -124426,6 +132646,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + output: 'resource "datadog_security_monitoring_suppression" "abc-123" {}' + resource_id: abc-123 + type_name: datadog_security_monitoring_suppression + id: datadog_security_monitoring_suppression|abc-123 + type: format_resource schema: $ref: "#/components/schemas/SecurityMonitoringTerraformExportResponse" description: OK @@ -124466,6 +132696,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + output: 'resource "datadog_security_monitoring_suppression" "abc-123" {}' + resource_id: abc-123 + type_name: datadog_security_monitoring_suppression + id: datadog_security_monitoring_suppression|abc-123 + type: format_resource schema: $ref: "#/components/schemas/SecurityMonitoringTerraformExportResponse" description: OK @@ -124499,6 +132739,70 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: {} + id: abc-123 + relationships: + groups: + data: + - id: group-abc-123 + type: sensitive_data_scanner_group + type: sensitive_data_scanner_configuration + included: + - attributes: + description: "" + filter: + query: "*" + is_enabled: true + name: My scanning group + product_list: + - logs + samplings: + - product: logs + rate: 100.0 + id: group-abc-123 + relationships: + configuration: + data: + id: abc-123 + type: sensitive_data_scanner_configuration + rules: + data: + - id: rule-abc-123 + type: sensitive_data_scanner_rule + type: sensitive_data_scanner_group + - attributes: + description: Detects credit card numbers in various formats + excluded_namespaces: + - admin.name + included_keyword_configuration: + character_count: 35 + keywords: + - credit card + is_enabled: true + name: Credit Card Rule + namespaces: + - admin + priority: 1 + tags: + - sensitive_data:true + text_replacement: + type: none + id: rule-abc-123 + relationships: + group: + data: + id: group-abc-123 + type: sensitive_data_scanner_group + type: sensitive_data_scanner_rule + meta: + count_limit: 500 + group_count_limit: 20 + is_pci_compliant: false + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerGetConfigResponse" description: OK @@ -124548,6 +132852,11 @@ paths: "200": content: application/json: + examples: + default: + value: + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerReorderGroupsResponse" description: OK @@ -124612,6 +132921,32 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + description: "" + filter: + query: "*" + is_enabled: false + name: My scanning group + product_list: + - logs + samplings: + - product: logs + rate: 100.0 + id: group-abc-123 + relationships: + configuration: + data: + id: abc-123 + type: sensitive_data_scanner_configuration + rules: + data: [] + type: sensitive_data_scanner_group + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerCreateGroupResponse" description: OK @@ -124658,6 +132993,11 @@ paths: "200": content: application/json: + examples: + default: + value: + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerGroupDeleteResponse" description: OK @@ -124724,6 +133064,11 @@ paths: "200": content: application/json: + examples: + default: + value: + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerGroupUpdateResponse" description: OK @@ -124810,6 +133155,36 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + description: Detects credit card numbers in various formats + excluded_namespaces: + - admin.name + included_keyword_configuration: + character_count: 35 + keywords: + - credit card + is_enabled: true + name: Credit Card Rule + namespaces: + - admin + priority: 1 + tags: + - sensitive_data:true + text_replacement: + type: none + id: rule-abc-123 + relationships: + group: + data: + id: group-abc-123 + type: sensitive_data_scanner_group + type: sensitive_data_scanner_rule + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerCreateRuleResponse" description: OK @@ -124856,6 +133231,11 @@ paths: "200": content: application/json: + examples: + default: + value: + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerRuleDeleteResponse" description: OK @@ -124942,6 +133322,11 @@ paths: "200": content: application/json: + examples: + default: + value: + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerRuleUpdateResponse" description: OK @@ -124977,6 +133362,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: Detects credit card numbers in various formats + included_keywords: + - credit card + - card number + name: Credit Card Number + priority: 1 + tags: + - card_number + id: abc-123 + type: sensitive_data_scanner_standard_pattern schema: $ref: "#/components/schemas/SensitiveDataScannerStandardPatternsResponseData" description: OK @@ -125052,6 +133452,10 @@ paths: "202": content: application/json: + examples: + default: + value: + errors: [] schema: $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted @@ -125113,6 +133517,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + service_account: true + id: 00000000-0000-0000-0000-000000000001 + type: users schema: $ref: "#/components/schemas/UserResponse" description: OK @@ -125152,6 +133565,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + expires_at: "2025-12-31T23:59:59+00:00" + name: My Personal Access Token + scopes: + - dashboards_read + id: 00000000-0000-0000-0000-000000000005 + type: personal_access_tokens + meta: + page: + total_filtered_count: 1 schema: $ref: "#/components/schemas/ListPersonalAccessTokensResponse" description: OK @@ -125207,6 +133635,20 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + expires_at: "2025-12-31T23:59:59+00:00" + key: "" + name: My Personal Access Token + public_portion: ddpat_abc123 + scopes: + - dashboards_read + id: 00000000-0000-0000-0000-000000000006 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenCreateResponse" description: Created @@ -125279,6 +133721,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + expires_at: "2025-12-31T23:59:59+00:00" + name: My Personal Access Token + scopes: + - dashboards_read + id: 00000000-0000-0000-0000-000000000007 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenResponse" description: OK @@ -125330,6 +133784,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + expires_at: "2025-12-31T23:59:59+00:00" + name: My Personal Access Token + scopes: + - dashboards_read + id: 00000000-0000-0000-0000-000000000008 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenResponse" description: OK @@ -125377,6 +133843,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + name: Application Key for managing dashboards + id: 00000000-0000-0000-0000-000000000002 + type: application_keys schema: $ref: "#/components/schemas/ListApplicationKeysResponse" description: OK @@ -125433,6 +133908,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + name: Application Key for managing dashboards + id: 00000000-0000-0000-0000-000000000003 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: Created @@ -125499,6 +133983,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + name: Application Key for managing dashboards + id: 00000000-0000-0000-0000-000000000004 + type: application_keys schema: $ref: "#/components/schemas/PartialApplicationKeyResponse" description: OK @@ -125551,6 +134044,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + name: Application Key for managing dashboards + id: 00000000-0000-0000-0000-000000000005 + type: application_keys schema: $ref: "#/components/schemas/PartialApplicationKeyResponse" description: OK @@ -125597,6 +134099,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: test-service + id: 00000000-0000-0000-0000-000000000002 + type: services schema: $ref: "#/components/schemas/IncidentServicesResponse" description: OK @@ -125655,6 +134165,14 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: test-service + id: 00000000-0000-0000-0000-000000000001 + type: services schema: $ref: "#/components/schemas/IncidentServiceResponse" description: CREATED @@ -125695,6 +134213,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + schema: + dd-service: test-service + schema-version: v2.2 + team: my-team + id: test-service + type: service_definitions schema: $ref: "#/components/schemas/ServiceDefinitionsListResponse" description: OK @@ -125775,6 +134304,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + schema: + dd-service: my-service + schema-version: v2.2 + id: abc-123 + type: service_definitions schema: $ref: "#/components/schemas/ServiceDefinitionCreateResponse" description: CREATED @@ -125838,6 +134377,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + schema: + dd-service: test-service + schema-version: v2.2 + team: my-team + id: test-service + type: service_definitions schema: $ref: "#/components/schemas/ServiceDefinitionGetResponse" description: OK @@ -125910,6 +134460,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: test-service + id: 00000000-0000-0000-0000-000000000004 + type: services schema: $ref: "#/components/schemas/IncidentServiceResponse" description: OK @@ -125972,6 +134530,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: test-service + id: 00000000-0000-0000-0000-000000000003 + type: services schema: $ref: "#/components/schemas/IncidentServiceResponse" description: OK @@ -126015,6 +134581,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + message: A large number of failed login attempts. + tags: + - source:production + timestamp: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: signal schema: $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse" description: OK @@ -126064,6 +134641,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + message: A large number of failed login attempts. + tags: + - source:production + timestamp: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: signal schema: $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse" description: OK @@ -126099,6 +134687,17 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + message: A large number of failed login attempts. + tags: + - source:production + timestamp: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: signal schema: $ref: "#/components/schemas/SecurityMonitoringSignalResponse" description: OK @@ -126149,6 +134748,20 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + - attributes: + createdAt: "2024-01-01T00:00:00+00:00" + createdByHandle: example-handle + createdByName: Example Name + jobName: Example Job + jobStatus: COMPLETED + id: abc-123 + type: historicalDetectionsJob + meta: + totalCount: 1 schema: $ref: "#/components/schemas/ListHistoricalJobsResponse" description: OK @@ -126209,6 +134822,12 @@ paths: "201": content: "application/json": + examples: + default: + value: + data: + id: abc-123 + type: historicalDetectionsJob schema: $ref: "#/components/schemas/JobCreateResponse" description: Status created @@ -126323,6 +134942,20 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + createdAt: "2024-01-01T00:00:00+00:00" + createdByHandle: example-handle + createdByName: Example Name + jobName: Example Job + jobStatus: COMPLETED + modifiedAt: "2024-01-01T00:00:00+00:00" + signalOutput: false + id: abc-123 + type: historicalDetectionsJob schema: $ref: "#/components/schemas/HistoricalJobResponse" description: OK @@ -126399,6 +135032,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + message: A large number of failed login attempts. + tags: + - source:production + timestamp: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: signal schema: $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse" description: OK @@ -126452,6 +135096,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000001 + type: report_id schema: $ref: "#/components/schemas/SLOReportPostResponse" description: OK @@ -126497,6 +135147,9 @@ paths: "200": content: text/csv: + examples: + default: + value: "slo_name,slo_id,sli,error_budget_remaining\nMy SLO,abc-123,99.95,99.5" schema: type: string description: OK @@ -126540,6 +135193,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + status: completed + id: 00000000-0000-0000-0000-000000000002 + type: report_id schema: $ref: "#/components/schemas/SLOReportStatusGetResponse" description: OK @@ -126589,6 +135250,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + error_budget_remaining: 99.5 + raw_error_budget_remaining: + unit: seconds + value: 86400.5 + sli: 99.95 + span_precision: 2 + state: ok + id: "00000000-0000-0000-0000-000000000000" + type: slo_status schema: $ref: "#/components/schemas/SloStatusResponse" description: OK @@ -126785,6 +135460,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + by: + host: my-hostname + computes: + c0: 19 + id: abc-123 + type: bucket + meta: + elapsed: 132 + status: done schema: $ref: "#/components/schemas/SpansAggregateResponse" description: OK @@ -126867,6 +135556,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + service: web-store + id: abc-123 + type: spans schema: $ref: "#/components/schemas/SpansListResponse" description: OK @@ -126927,6 +135624,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + env: prod + service: test-service + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + type: spans + meta: + elapsed: 132 + status: done schema: $ref: "#/components/schemas/SpansListResponse" description: OK @@ -126997,6 +135706,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + results: + - purl: "pkg:npm/lodash@4.17.20" + vulnerable_symbols: [] + id: abc-123 + type: resolve-vulnerable-symbols-response schema: $ref: "#/components/schemas/ResolveVulnerableSymbolsResponse" description: OK @@ -127063,6 +135782,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: example-handle + description: Example ruleset description + name: my-ruleset + rules: [] + short_description: Short description + id: my-ruleset + type: custom_ruleset schema: $ref: "#/components/schemas/CustomRulesetResponse" description: Successful response @@ -127122,6 +135854,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: example-handle + description: Example ruleset description + name: my-ruleset + rules: [] + short_description: Short description + id: my-ruleset + type: custom_ruleset schema: $ref: "#/components/schemas/CustomRulesetResponse" description: Successfully updated @@ -127175,6 +135920,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: example-handle + last_revision: + attributes: {} + id: revision-abc-123 + type: custom_rule_revision + name: my-rule + id: my-rule + type: custom_rule schema: $ref: "#/components/schemas/CustomRuleResponse" description: Successfully created @@ -127272,6 +136031,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: example-handle + last_revision: + attributes: {} + id: revision-abc-123 + type: custom_rule_revision + name: my-rule + id: my-rule + type: custom_rule schema: $ref: "#/components/schemas/CustomRuleResponse" description: Successful response @@ -127334,6 +136107,33 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + arguments: [] + category: SECURITY + checksum: 8a66c4e4e631099ad71be3c1ea3ea8fc2d57193e56db2c296e2dd8a508b26b99 + code: Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ== + created_at: "2024-01-01T00:00:00+00:00" + created_by: example-handle + creation_message: Initial revision + cve: + cwe: + description: Example ruleset description + documentation_url: + is_published: false + is_testing: false + language: PYTHON + severity: ERROR + short_description: Short description + should_use_ai_fix: false + tags: [] + tests: [] + tree_sitter_query: Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ== + id: revision-123 + type: custom_rule_revision schema: $ref: "#/components/schemas/CustomRuleRevisionsResponse" description: Successful response @@ -127524,6 +136324,33 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + arguments: [] + category: SECURITY + checksum: 8a66c4e4e631099ad71be3c1ea3ea8fc2d57193e56db2c296e2dd8a508b26b99 + code: Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ== + created_at: "2024-01-01T00:00:00+00:00" + created_by: example-handle + creation_message: Initial revision + cve: + cwe: + description: Example ruleset description + documentation_url: + is_published: false + is_testing: false + language: PYTHON + severity: ERROR + short_description: Short description + should_use_ai_fix: false + tags: [] + tests: [] + tree_sitter_query: Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ== + id: revision-123 + type: custom_rule_revision schema: $ref: "#/components/schemas/CustomRuleRevisionResponse" description: Successful response @@ -127570,6 +136397,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + rulesets: [] + id: abc-123 + type: get_multiple_rulesets_response schema: $ref: "#/components/schemas/GetMultipleRulesetsResponse" description: OK @@ -127593,6 +136428,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: "Detects example secrets" + name: "Example Secret Rule" + pattern: "[A-Za-z0-9]{32}" + priority: "1" + id: abc-123 + type: secret_rule schema: $ref: "#/components/schemas/SecretRuleArray" description: OK @@ -127638,6 +136484,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + components: [] + domain_prefix: status-page-us1 + enabled: true + name: Status Page US1 + subscriptions_enabled: true + type: public + visualization_type: bars_and_uptime_percentage + id: 00000000-0000-0000-0000-000000000001 + type: status_pages schema: $ref: "#/components/schemas/StatusPageArray" description: OK @@ -127704,6 +136564,20 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + components: [] + domain_prefix: status-page-us1 + enabled: true + name: Status Page US1 + subscriptions_enabled: true + type: public + visualization_type: bars_and_uptime_percentage + id: 00000000-0000-0000-0000-000000000002 + type: status_pages schema: $ref: "#/components/schemas/StatusPage" description: Created @@ -127761,6 +136635,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + components_affected: [] + created_at: "2024-01-01T00:00:00+00:00" + description: Our API is experiencing elevated latency. + modified_at: "2024-01-01T00:00:00+00:00" + status: investigating + title: Elevated API Latency + updates: [] + id: 00000000-0000-0000-0000-000000000005 + type: degradations schema: $ref: "#/components/schemas/DegradationArray" description: OK @@ -127818,6 +136706,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + completed_date: "2024-01-01T01:00:00+00:00" + completed_description: We have completed maintenance on the API. + components_affected: [] + in_progress_description: We are currently performing maintenance on the API. + scheduled_description: We will be performing maintenance on the API. + start_date: "2024-01-01T00:00:00+00:00" + status: scheduled + title: API Maintenance + id: 00000000-0000-0000-0000-000000000016 + type: maintenances schema: $ref: "#/components/schemas/MaintenanceArray" description: OK @@ -127884,6 +136787,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + components: [] + domain_prefix: status-page-us1 + enabled: true + name: Status Page US1 + subscriptions_enabled: true + type: public + visualization_type: bars_and_uptime_percentage + id: 00000000-0000-0000-0000-000000000007 + type: status_pages schema: $ref: "#/components/schemas/StatusPage" description: OK @@ -127949,6 +136866,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + components: [] + domain_prefix: status-page-us1-east + enabled: false + name: Status Page US1 East + subscriptions_enabled: false + type: internal + visualization_type: bars_only + id: 00000000-0000-0000-0000-000000000006 + type: status_pages schema: $ref: "#/components/schemas/StatusPage" description: OK @@ -127987,6 +136918,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: Metrics Intake + position: 0 + status: operational + type: component + id: 00000000-0000-0000-0000-000000000008 + type: components schema: $ref: "#/components/schemas/StatusPagesComponentArray" description: OK @@ -128042,6 +136984,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: Metrics Intake + position: 0 + status: operational + type: component + id: 00000000-0000-0000-0000-000000000009 + type: components schema: $ref: "#/components/schemas/StatusPagesComponent" description: Created @@ -128124,6 +137077,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Metrics Intake + position: 0 + status: operational + type: component + id: 00000000-0000-0000-0000-000000000012 + type: components schema: $ref: "#/components/schemas/StatusPagesComponent" description: OK @@ -128184,6 +137148,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Metrics Intake Service + position: 4 + status: operational + type: component + id: 00000000-0000-0000-0000-000000000011 + type: components schema: $ref: "#/components/schemas/StatusPagesComponent" description: OK @@ -128246,6 +137221,22 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: 00000000-0000-0000-0000-000000000019 + status: degraded + created_at: "2024-01-01T00:00:00+00:00" + description: Our API is experiencing elevated latency. We are investigating the issue. + modified_at: "2024-01-01T00:00:00+00:00" + status: investigating + title: Elevated API Latency + updates: [] + id: 00000000-0000-0000-0000-000000000010 + type: degradations schema: $ref: "#/components/schemas/Degradation" description: Created @@ -128328,6 +137319,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: 00000000-0000-0000-0000-000000000018 + status: degraded + created_at: "2024-01-01T00:00:00+00:00" + description: Our API is experiencing elevated latency. We are investigating the issue. + modified_at: "2024-01-01T00:00:00+00:00" + status: investigating + title: Elevated API Latency + updates: [] + id: 00000000-0000-0000-0000-000000000004 + type: degradations schema: $ref: "#/components/schemas/Degradation" description: OK @@ -128398,6 +137405,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: 00000000-0000-0000-0000-000000000017 + status: operational + created_at: "2024-01-01T00:00:00+00:00" + description: We've deployed a fix and latency has returned to normal. + modified_at: "2024-01-01T00:00:00+00:00" + status: resolved + title: Elevated API Latency + updates: [] + id: 00000000-0000-0000-0000-000000000003 + type: degradations schema: $ref: "#/components/schemas/Degradation" description: OK @@ -128462,6 +137485,21 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + completed_date: "2024-01-01T01:00:00+00:00" + completed_description: We have completed maintenance on the API to improve performance. + components_affected: [] + 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: "2024-01-01T00:00:00+00:00" + status: scheduled + title: API Maintenance + id: 00000000-0000-0000-0000-000000000015 + type: maintenances schema: $ref: "#/components/schemas/Maintenance" description: Created @@ -128506,6 +137544,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + completed_date: "2024-01-01T01:00:00+00:00" + completed_description: We have completed maintenance on the API. + components_affected: [] + in_progress_description: We are currently performing maintenance on the API. + scheduled_description: We will be performing maintenance on the API. + start_date: "2024-01-01T00:00:00+00:00" + status: scheduled + title: API Maintenance + id: 00000000-0000-0000-0000-000000000013 + type: maintenances schema: $ref: "#/components/schemas/Maintenance" description: OK @@ -128573,6 +137626,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + completed_date: "2024-01-01T01:00:00+00:00" + completed_description: We have completed maintenance on the API. + components_affected: [] + 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: "2024-01-01T00:00:00+00:00" + status: scheduled + title: API Maintenance + id: 00000000-0000-0000-0000-000000000014 + type: maintenances schema: $ref: "#/components/schemas/Maintenance" description: OK @@ -128666,6 +137734,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/SyntheticsApiMultistepSubtestsResponse" description: OK @@ -128700,6 +137772,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/SyntheticsApiMultistepParentTestsResponse" description: OK @@ -129270,6 +138346,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + on_demand_concurrency_cap: 20 + type: on_demand_concurrency_cap schema: $ref: "#/components/schemas/OnDemandConcurrencyCapResponse" description: OK @@ -129300,6 +138383,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + on_demand_concurrency_cap: 20 + type: on_demand_concurrency_cap schema: $ref: "#/components/schemas/OnDemandConcurrencyCapResponse" description: OK @@ -129342,6 +138432,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + message: Notification message + monitor_id: 12345678 + name: Example suite name + options: + alerting_threshold: 0.5 + public_id: 123-abc-456 + tags: + - env:production + tests: + - alerting_criticality: critical + public_id: "" + type: suite + id: 123-abc-456 + type: suites schema: $ref: "#/components/schemas/SyntheticsSuiteResponse" description: OK @@ -129387,6 +138496,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + deleted_at: "2024-01-01T00:00:00+00:00" + public_id: 123-abc-456 + id: 123-abc-456 + type: suites schema: $ref: "#/components/schemas/DeletedSuitesResponse" description: OK @@ -129455,6 +138573,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + suites: + - monitor_id: 12345678 + name: Example suite name + options: + alerting_threshold: 0.5 + public_id: 123-abc-456 + tags: + - env:production + tests: [] + type: suite + total: 1 + id: abc-123 + type: suites_search schema: $ref: "#/components/schemas/SyntheticsSuiteSearchResponse" description: OK @@ -129492,6 +138628,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + message: Notification message + monitor_id: 12345678 + name: Example suite name + options: + alerting_threshold: 0.5 + public_id: 123-abc-456 + tags: + - env:production + tests: + - alerting_criticality: critical + public_id: "" + type: suite + id: 123-abc-456 + type: suites schema: $ref: "#/components/schemas/SyntheticsSuiteResponse" description: OK @@ -129551,6 +138706,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + message: Notification message + monitor_id: 12345678 + name: Example suite name + options: + alerting_threshold: 0.5 + public_id: 123-abc-456 + tags: + - env:production + tests: + - alerting_criticality: critical + public_id: "" + type: suite + id: 123-abc-456 + type: suites schema: $ref: "#/components/schemas/SyntheticsSuiteResponse" description: OK @@ -129613,6 +138787,25 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + message: Notification message + monitor_id: 12345678 + name: Example suite name + options: + alerting_threshold: 0.5 + public_id: 123-abc-456 + tags: + - env:production + tests: + - alerting_criticality: critical + public_id: "" + type: suite + id: 123-abc-456 + type: suites schema: $ref: "#/components/schemas/SyntheticsSuiteResponse" description: OK @@ -129861,6 +139054,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: abc-def-123 + type: delete_tests schema: $ref: "#/components/schemas/DeletedTestsResponse" description: OK @@ -130011,6 +139210,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + config: {} + locations: + - aws:us-east-1 + message: Network Path test notification + name: Example Network Path test + options: {} + status: live + type: network + id: abc-def-123 + type: network_test schema: $ref: "#/components/schemas/SyntheticsNetworkTestResponse" description: OK @@ -130049,6 +139263,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + config: {} + locations: + - aws:us-east-1 + message: Network Path test notification + name: Example Network Path test + options: {} + status: live + type: network + id: abc-def-123 + type: network_test schema: $ref: "#/components/schemas/SyntheticsNetworkTestResponse" description: OK @@ -130141,6 +139370,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + config: {} + locations: + - aws:us-east-1 + message: Network Path test notification + name: Example Network Path test + options: {} + status: live + type: network + id: abc-def-123 + type: network_test schema: $ref: "#/components/schemas/SyntheticsNetworkTestResponse" description: OK @@ -130270,6 +139514,10 @@ paths: "200": content: application/json: + examples: + default: + value: + presignedUrl: https://example.com/download schema: $ref: "#/components/schemas/SyntheticsTestFileDownloadResponse" description: OK @@ -130336,6 +139584,11 @@ paths: "200": content: application/json: + examples: + default: + value: + bucketKey: api-upload-file/abc-def-123/file.json + presignedUrls: [] schema: $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsResponse" description: OK @@ -130512,6 +139765,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/SyntheticsTestParentSuitesResponse" description: OK @@ -130760,6 +140017,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/SyntheticsTestVersionHistoryResponse" description: OK @@ -130825,6 +140086,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + public_id: abc-def-123 + version_number: 1 schema: $ref: "#/components/schemas/SyntheticsTestVersionResponse" description: OK @@ -130887,6 +140154,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + description: Example description + name: MY_VARIABLE + tags: + - "team:front" + value: + secure: false + value: example-value + id: abc-123 + type: global_variables schema: $ref: "#/components/schemas/GlobalVariableResponse" description: OK @@ -130912,6 +140193,33 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created: + enabled: true + last_modified_user_uuid: "" + modified: + name: Production Cost Allocation Rules + position: 0 + rules: + - enabled: true + mapping: + metadata: + name: AWS Production Account Tagging + query: + addition: + key: environment + value: production + case_insensitivity: false + if_tag_exists: do_not_apply + query: billingcurrency:"USD" AND account_name:"prod-account" + reference_table: + version: 2 + id: 00000000-0000-0000-0000-000000000001 + type: ruleset schema: $ref: "#/components/schemas/RulesetRespArray" description: OK @@ -130956,6 +140264,33 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: + enabled: true + last_modified_user_uuid: "" + modified: + name: Example Ruleset + position: 0 + rules: + - enabled: true + mapping: + metadata: + 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" + reference_table: + version: 1 + id: 00000000-0000-0000-0000-000000000002 + type: ruleset schema: $ref: "#/components/schemas/RulesetResp" description: OK @@ -131023,6 +140358,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + Canonical: canonical query representation + type: validate_response schema: $ref: "#/components/schemas/RulesValidateQueryResponse" description: OK @@ -131074,6 +140416,33 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: + enabled: true + last_modified_user_uuid: "" + modified: + name: Example Ruleset + position: 0 + rules: + - enabled: true + mapping: + metadata: + 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" + reference_table: + version: 1 + id: 00000000-0000-0000-0000-000000000004 + type: ruleset schema: $ref: "#/components/schemas/RulesetResp" description: OK @@ -131150,6 +140519,27 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + enabled: true + name: Example Ruleset + position: 0 + rules: + - enabled: true + name: Example Rule + query: + addition: + key: env + value: prod + case_insensitivity: false + if_tag_exists: do_not_apply + query: account_id:"123456789" + version: 1 + id: 00000000-0000-0000-0000-000000000003 + type: ruleset schema: $ref: "#/components/schemas/RulesetResp" description: OK @@ -131212,6 +140602,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + handle: example-team + name: Example Team + id: 00000000-0000-0000-0000-000000000001 + type: team + meta: + pagination: + offset: 0 + total: 1 schema: $ref: "#/components/schemas/TeamsResponse" description: OK @@ -131262,6 +140665,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + handle: example-team + name: Example Team + id: 00000000-0000-0000-0000-000000000002 + type: team schema: $ref: "#/components/schemas/TeamResponse" description: CREATED @@ -131313,6 +140725,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + provisioned_by: system + id: b8626d7e-cedd-11eb-abf5-da7ad0900001 + type: team_hierarchy_links schema: $ref: "#/components/schemas/TeamHierarchyLinksResponse" description: OK @@ -131363,6 +140784,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + provisioned_by: system + id: 00000000-0000-0000-0000-000000000001 + type: team_hierarchy_links schema: $ref: "#/components/schemas/TeamHierarchyLinkResponse" description: OK @@ -131442,6 +140872,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + provisioned_by: system + id: b8626d7e-cedd-11eb-abf5-da7ad0900001 + type: team_hierarchy_links schema: $ref: "#/components/schemas/TeamHierarchyLinkResponse" description: OK @@ -131560,6 +140999,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + managed_by: github_sync + source: github + id: 00000000-0000-0000-0000-000000000001 + type: team_connection schema: $ref: "#/components/schemas/TeamConnectionsResponse" description: OK @@ -131613,6 +141061,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + - attributes: + managed_by: github_sync + source: github + id: 00000000-0000-0000-0000-000000000002 + type: team_connection schema: $ref: "#/components/schemas/TeamConnectionsResponse" description: Created @@ -131653,6 +141110,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + frequency: once + source: github + sync_membership: false + type: link + type: team_sync_bulk schema: $ref: "#/components/schemas/TeamSyncResponse" description: OK @@ -131763,6 +141230,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + handle: example-team + name: Example Team + id: 00000000-0000-0000-0000-000000000005 + type: team + meta: + pagination: + offset: 0 + total: 1 schema: $ref: "#/components/schemas/TeamsResponse" description: OK @@ -131954,6 +141434,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + handle: example-team + name: Example Team + id: 00000000-0000-0000-0000-000000000003 + type: team schema: $ref: "#/components/schemas/TeamResponse" description: OK @@ -132016,6 +141505,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + handle: example-team + name: Example Team + id: 00000000-0000-0000-0000-000000000004 + type: team schema: $ref: "#/components/schemas/TeamResponse" description: OK @@ -132069,6 +141567,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + label: Link label + position: 0 + url: "https://example.com" + id: 00000000-0000-0000-0000-000000000001 + type: team_links schema: $ref: "#/components/schemas/TeamLinksResponse" description: OK @@ -132123,6 +141631,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + label: Link label + url: https://example.com + id: 00000000-0000-0000-0000-000000000002 + type: team_links schema: $ref: "#/components/schemas/TeamLinkResponse" description: OK @@ -132217,6 +141734,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + label: Link label + position: 0 + url: "https://example.com" + id: 00000000-0000-0000-0000-000000000003 + type: team_links schema: $ref: "#/components/schemas/TeamLinkResponse" description: OK @@ -132276,6 +141803,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + label: Link label + position: 0 + url: "https://example.com" + id: 00000000-0000-0000-0000-000000000004 + type: team_links schema: $ref: "#/components/schemas/TeamLinkResponse" description: OK @@ -132331,6 +141868,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + role: admin + id: TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835 + type: team_memberships schema: $ref: "#/components/schemas/UserTeamsResponse" description: Represents a user's association to a team @@ -132399,6 +141944,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + role: admin + id: 00000000-0000-0000-0000-000000000001 + type: team_memberships schema: $ref: "#/components/schemas/UserTeamResponse" description: Represents a user's association to a team @@ -132512,6 +142065,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + role: admin + id: TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835 + type: team_memberships schema: $ref: "#/components/schemas/UserTeamResponse" description: OK @@ -132558,6 +142119,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: + enabled: true + slack: + channel: test-channel + workspace: Datadog + id: 00000000-0000-0000-0000-000000000001 + type: team_notification_rules schema: $ref: "#/components/schemas/TeamNotificationRulesResponse" description: OK @@ -132613,6 +142186,18 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + email: + enabled: true + slack: + channel: test-channel + workspace: Datadog + id: 00000000-0000-0000-0000-000000000002 + type: team_notification_rules schema: $ref: "#/components/schemas/TeamNotificationRuleResponse" description: OK @@ -132704,6 +142289,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: + enabled: true + slack: + channel: test-channel + workspace: Datadog + id: 00000000-0000-0000-0000-000000000003 + type: team_notification_rules schema: $ref: "#/components/schemas/TeamNotificationRuleResponse" description: OK @@ -132766,6 +142363,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: + enabled: true + slack: + channel: test-channel + workspace: Datadog + id: 00000000-0000-0000-0000-000000000004 + type: team_notification_rules schema: $ref: "#/components/schemas/TeamNotificationRuleResponse" description: OK @@ -132806,6 +142415,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + action: edit + editable: true + value: admins + id: TeamPermission-abc-123-edit + type: team_permission_settings schema: $ref: "#/components/schemas/TeamPermissionSettingsResponse" description: OK @@ -132865,6 +142484,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + action: edit + editable: true + value: admins + id: TeamPermission-abc-123-edit + type: team_permission_settings schema: $ref: "#/components/schemas/TeamPermissionSettingResponse" description: OK @@ -132906,6 +142535,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: team name + id: 00000000-0000-0000-0000-000000000002 + type: teams schema: $ref: "#/components/schemas/IncidentTeamsResponse" description: OK @@ -132964,6 +142601,14 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: team name + id: 00000000-0000-0000-0000-000000000001 + type: teams schema: $ref: "#/components/schemas/IncidentTeamResponse" description: CREATED @@ -133039,6 +142684,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: team name + id: 00000000-0000-0000-0000-000000000004 + type: teams schema: $ref: "#/components/schemas/IncidentTeamResponse" description: OK @@ -133101,6 +142754,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: team name + id: 00000000-0000-0000-0000-000000000003 + type: teams schema: $ref: "#/components/schemas/IncidentTeamResponse" description: OK @@ -133153,6 +142814,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + has_errors: false + results: + - id: 4eb1887a8adb1847 + success: true + id: abc-123 + type: update_flaky_test_state_response schema: $ref: "#/components/schemas/UpdateFlakyTestsResponse" description: OK @@ -133201,7 +142873,6 @@ paths: attributes: filter: query: flaky_test_state:active @git.repository.id_v2:"github.com/datadog/test-service" - include_history: true page: cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== limit: 25 @@ -133214,6 +142885,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + envs: + - prod + flaky_state: active + module: TestModule + name: TestName + services: + - test-service + suite: TestSuite + id: 4eb1887a8adb1847 + type: flaky_test + meta: + pagination: + next_page: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== schema: $ref: "#/components/schemas/FlakyTestsSearchResponse" description: OK @@ -133268,6 +142957,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/UsageApplicationSecurityMonitoringResponse" description: OK @@ -133328,6 +143021,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/BillingDimensionsMappingResponse" description: OK @@ -133392,6 +143089,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/CostByOrgResponse" description: OK @@ -133489,6 +143190,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/CostByOrgResponse" description: OK @@ -133564,6 +143269,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/CostByOrgResponse" description: OK @@ -133683,6 +143392,12 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: + - id: abc-123 + type: usage_timeseries schema: $ref: "#/components/schemas/HourlyUsageResponse" description: OK @@ -133744,6 +143459,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/UsageLambdaTracedInvocationsResponse" description: OK @@ -133805,6 +143524,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/UsageObservabilityPipelinesResponse" description: OK @@ -133864,6 +143587,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ProjectedCostResponse" description: OK @@ -133908,6 +143635,12 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: + id: abc-123 + type: usage_attribution_types schema: $ref: "#/components/schemas/UsageAttributionTypesResponse" description: OK @@ -133959,6 +143692,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + expires_at: "2024-01-08T00:00:00+00:00" + invite_type: email + uuid: 00000000-0000-0000-0000-000000000001 + id: 00000000-0000-0000-0000-000000000007 + type: user_invitations schema: $ref: "#/components/schemas/UserInvitationsResponse" description: OK @@ -134005,6 +143749,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + invite_type: email + uuid: 00000000-0000-0000-0000-000000000001 + id: 00000000-0000-0000-0000-000000000008 + type: user_invitations schema: $ref: "#/components/schemas/UserInvitationResponse" description: OK @@ -134082,6 +143835,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: test@example.com + handle: example-handle + name: Example Name + status: Active + id: 00000000-0000-0000-0000-000000000001 + type: users + included: [] + meta: {} schema: $ref: "#/components/schemas/UsersResponse" description: OK @@ -134140,6 +143906,18 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + handle: example-handle + name: Example Name + status: Active + id: 00000000-0000-0000-0000-000000000002 + type: users + included: [] schema: $ref: "#/components/schemas/UserResponse" description: OK @@ -134218,6 +143996,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + handle: example-handle + name: Example Name + status: Active + id: 00000000-0000-0000-0000-000000000003 + type: users + included: [] schema: $ref: "#/components/schemas/UserResponse" description: OK @@ -134271,6 +144061,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + handle: example-handle + name: Example Name + status: Active + id: 00000000-0000-0000-0000-000000000004 + type: users + included: [] schema: $ref: "#/components/schemas/UserResponse" description: OK @@ -134370,6 +144172,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + handle: example-handle + name: Example Name + status: Active + id: 00000000-0000-0000-0000-000000000005 + type: users + included: [] schema: $ref: "#/components/schemas/UserResponse" description: OK @@ -134410,6 +144224,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + display_name: Logs Read Data + display_type: read + name: logs_read_data + restricted: false + id: 00000000-0000-0000-0000-000000000006 + type: permissions schema: $ref: "#/components/schemas/PermissionsResponse" description: OK @@ -134455,6 +144280,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + role: admin + id: 00000000-0000-0000-0000-000000000001 + type: team_memberships schema: $ref: "#/components/schemas/UserTeamsResponse" description: Represents a user's association to a team @@ -134542,6 +144375,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/WidgetListResponse" description: OK @@ -134602,6 +144439,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + definition: + title: My Widget + type: bar_chart + is_favorited: false + modified_at: "2024-01-01T00:00:00+00:00" + tags: + - "team:my-team" + id: abc-123 + type: widgets schema: $ref: "#/components/schemas/WidgetResponse" description: OK @@ -134708,6 +144560,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + definition: + title: My Widget + type: bar_chart + is_favorited: false + modified_at: "2024-01-01T00:00:00+00:00" + tags: + - "team:my-team" + id: abc-123 + type: widgets schema: $ref: "#/components/schemas/WidgetResponse" description: OK @@ -134781,6 +144648,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + definition: + title: My Widget + type: bar_chart + is_favorited: false + modified_at: "2024-01-01T00:00:00+00:00" + tags: + - "team:my-team" + id: abc-123 + type: widgets schema: $ref: "#/components/schemas/WidgetResponse" description: OK @@ -134893,6 +144775,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: Example Workflow + spec: {} + id: 00000000-0000-0000-0000-000000000001 + type: workflows schema: $ref: "#/components/schemas/CreateWorkflowResponse" description: Successfully created a workflow. @@ -134964,6 +144855,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + createdAt: "2024-01-01T00:00:00+00:00" + description: A sample workflow. + name: Example Workflow + published: true + spec: {} + tags: + - team:infra + updatedAt: "2024-01-01T00:00:00+00:00" + id: 00000000-0000-0000-0000-000000000002 + type: workflows schema: $ref: "#/components/schemas/GetWorkflowResponse" description: Successfully got a workflow. @@ -135075,6 +144981,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Example Workflow + id: 00000000-0000-0000-0000-000000000003 + type: workflows schema: $ref: "#/components/schemas/UpdateWorkflowResponse" description: Successfully updated a workflow. @@ -135121,6 +145035,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: 00000000-0000-0000-0000-000000000004 + meta: + page: + totalCount: 1 schema: $ref: "#/components/schemas/WorkflowListInstancesResponse" description: OK @@ -135163,6 +145085,11 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000005 schema: $ref: "#/components/schemas/WorkflowInstanceCreateResponse" description: Created @@ -135196,6 +145123,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + id: 00000000-0000-0000-0000-000000000006 schema: $ref: "#/components/schemas/WorklflowGetInstanceResponse" description: OK @@ -135230,6 +145163,11 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: 00000000-0000-0000-0000-000000000007 schema: $ref: "#/components/schemas/WorklflowCancelInstanceResponse" description: OK diff --git a/examples/v2/llm-observability/CreateLLMObsAnnotationQueue.java b/examples/v2/llm-observability/CreateLLMObsAnnotationQueue.java index 6addd81882b..9fae258b15b 100644 --- a/examples/v2/llm-observability/CreateLLMObsAnnotationQueue.java +++ b/examples/v2/llm-observability/CreateLLMObsAnnotationQueue.java @@ -34,7 +34,7 @@ public static void main(String[] args) { .description("Rating of the response quality.") .hasAssessment(false) .hasReasoning(false) - .id("ab12cd34") + .id("abc-123") .isAssessment(false) .isInteger(false) .isRequired(true) @@ -44,7 +44,7 @@ public static void main(String[] args) { .values(Arrays.asList("good", "bad", "neutral"))))) .description("Queue for annotating customer support traces") .name("My annotation queue") - .projectId("a33671aa-24fd-4dcd-9b33-a8ec7dde7751")) + .projectId("00000000-0000-0000-0000-000000000002")) .type(LLMObsAnnotationQueueType.QUEUES)); try { diff --git a/examples/v2/llm-observability/CreateLLMObsAnnotationQueueInteractions.java b/examples/v2/llm-observability/CreateLLMObsAnnotationQueueInteractions.java index 052832c8449..47e40bd6ad9 100644 --- a/examples/v2/llm-observability/CreateLLMObsAnnotationQueueInteractions.java +++ b/examples/v2/llm-observability/CreateLLMObsAnnotationQueueInteractions.java @@ -34,7 +34,7 @@ public static void main(String[] args) { try { LLMObsAnnotationQueueInteractionsResponse result = apiInstance.createLLMObsAnnotationQueueInteractions( - "b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c", body); + "00000000-0000-0000-0000-000000000001", body); System.out.println(result); } catch (ApiException e) { System.err.println( diff --git a/examples/v2/llm-observability/DeleteLLMObsAnnotationQueue.java b/examples/v2/llm-observability/DeleteLLMObsAnnotationQueue.java index 5182dad3fce..fb447a7a7f0 100644 --- a/examples/v2/llm-observability/DeleteLLMObsAnnotationQueue.java +++ b/examples/v2/llm-observability/DeleteLLMObsAnnotationQueue.java @@ -11,7 +11,7 @@ public static void main(String[] args) { LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient); try { - apiInstance.deleteLLMObsAnnotationQueue("b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c"); + apiInstance.deleteLLMObsAnnotationQueue("00000000-0000-0000-0000-000000000001"); } catch (ApiException e) { System.err.println("Exception when calling LlmObservabilityApi#deleteLLMObsAnnotationQueue"); System.err.println("Status code: " + e.getCode()); diff --git a/examples/v2/llm-observability/DeleteLLMObsAnnotationQueueInteractions.java b/examples/v2/llm-observability/DeleteLLMObsAnnotationQueueInteractions.java index 1057e6e62d1..b5ee87b9880 100644 --- a/examples/v2/llm-observability/DeleteLLMObsAnnotationQueueInteractions.java +++ b/examples/v2/llm-observability/DeleteLLMObsAnnotationQueueInteractions.java @@ -29,7 +29,7 @@ public static void main(String[] args) { try { apiInstance.deleteLLMObsAnnotationQueueInteractions( - "b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c", body); + "00000000-0000-0000-0000-000000000001", body); } catch (ApiException e) { System.err.println( "Exception when calling LlmObservabilityApi#deleteLLMObsAnnotationQueueInteractions"); diff --git a/examples/v2/llm-observability/GetLLMObsAnnotatedInteractions.java b/examples/v2/llm-observability/GetLLMObsAnnotatedInteractions.java index cfc8ab3b5c9..4a89205bbce 100644 --- a/examples/v2/llm-observability/GetLLMObsAnnotatedInteractions.java +++ b/examples/v2/llm-observability/GetLLMObsAnnotatedInteractions.java @@ -13,7 +13,7 @@ public static void main(String[] args) { try { LLMObsAnnotatedInteractionsResponse result = - apiInstance.getLLMObsAnnotatedInteractions("b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c"); + apiInstance.getLLMObsAnnotatedInteractions("00000000-0000-0000-0000-000000000001"); System.out.println(result); } catch (ApiException e) { System.err.println( diff --git a/examples/v2/llm-observability/GetLLMObsAnnotationQueueLabelSchema.java b/examples/v2/llm-observability/GetLLMObsAnnotationQueueLabelSchema.java index f412531bf89..1901de64813 100644 --- a/examples/v2/llm-observability/GetLLMObsAnnotationQueueLabelSchema.java +++ b/examples/v2/llm-observability/GetLLMObsAnnotationQueueLabelSchema.java @@ -13,7 +13,7 @@ public static void main(String[] args) { try { LLMObsAnnotationQueueLabelSchemaResponse result = - apiInstance.getLLMObsAnnotationQueueLabelSchema("b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c"); + apiInstance.getLLMObsAnnotationQueueLabelSchema("00000000-0000-0000-0000-000000000001"); System.out.println(result); } catch (ApiException e) { System.err.println( diff --git a/examples/v2/llm-observability/UpdateLLMObsAnnotationQueue.java b/examples/v2/llm-observability/UpdateLLMObsAnnotationQueue.java index c4eb9dffd47..87be0779fc6 100644 --- a/examples/v2/llm-observability/UpdateLLMObsAnnotationQueue.java +++ b/examples/v2/llm-observability/UpdateLLMObsAnnotationQueue.java @@ -34,7 +34,7 @@ public static void main(String[] args) { .description("Rating of the response quality.") .hasAssessment(false) .hasReasoning(false) - .id("ab12cd34") + .id("abc-123") .isAssessment(false) .isInteger(false) .isRequired(true) @@ -48,7 +48,7 @@ public static void main(String[] args) { try { LLMObsAnnotationQueueResponse result = - apiInstance.updateLLMObsAnnotationQueue("b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c", body); + apiInstance.updateLLMObsAnnotationQueue("00000000-0000-0000-0000-000000000001", body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LlmObservabilityApi#updateLLMObsAnnotationQueue"); diff --git a/examples/v2/llm-observability/UpdateLLMObsAnnotationQueueLabelSchema.java b/examples/v2/llm-observability/UpdateLLMObsAnnotationQueueLabelSchema.java index 689b49dbf82..46396d0c352 100644 --- a/examples/v2/llm-observability/UpdateLLMObsAnnotationQueueLabelSchema.java +++ b/examples/v2/llm-observability/UpdateLLMObsAnnotationQueueLabelSchema.java @@ -34,7 +34,7 @@ public static void main(String[] args) { .description("Rating of the response quality.") .hasAssessment(false) .hasReasoning(false) - .id("ab12cd34") + .id("abc-123") .isAssessment(false) .isInteger(false) .isRequired(true) @@ -47,7 +47,7 @@ public static void main(String[] args) { try { LLMObsAnnotationQueueLabelSchemaResponse result = apiInstance.updateLLMObsAnnotationQueueLabelSchema( - "b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c", body); + "00000000-0000-0000-0000-000000000001", body); System.out.println(result); } catch (ApiException e) { System.err.println( diff --git a/examples/v2/security-monitoring/MuteSecurityFindings.java b/examples/v2/security-monitoring/MuteSecurityFindings.java index 805c47b8ecb..fac98013184 100644 --- a/examples/v2/security-monitoring/MuteSecurityFindings.java +++ b/examples/v2/security-monitoring/MuteSecurityFindings.java @@ -34,7 +34,7 @@ public static void main(String[] args) { .expireAt(1778721573794L) .isMuted(true) .reason(MuteFindingsReason.PENDING_FIX))) - .id("93bfeb70-af47-424d-908a-948d3f08e37f") + .id("00000000-0000-0000-0000-000000000001") .relationships( new MuteFindingsRequestDataRelationships() .findings( diff --git a/src/main/java/com/datadog/api/client/v2/model/SecurityEntityRiskScoreAttributes.java b/src/main/java/com/datadog/api/client/v2/model/SecurityEntityRiskScoreAttributes.java index b9f561005df..26956efe942 100644 --- a/src/main/java/com/datadog/api/client/v2/model/SecurityEntityRiskScoreAttributes.java +++ b/src/main/java/com/datadog/api/client/v2/model/SecurityEntityRiskScoreAttributes.java @@ -71,10 +71,10 @@ public class SecurityEntityRiskScoreAttributes { private Long lastDetected; public static final String JSON_PROPERTY_RISK_SCORE = "riskScore"; - private Double riskScore; + private Long riskScore; public static final String JSON_PROPERTY_RISK_SCORE_EVOLUTION = "riskScoreEvolution"; - private Double riskScoreEvolution; + private Long riskScoreEvolution; public static final String JSON_PROPERTY_SEVERITY = "severity"; private SecurityEntityRiskScoreAttributesSeverity severity; @@ -98,9 +98,9 @@ public SecurityEntityRiskScoreAttributes( @JsonProperty(required = true, value = JSON_PROPERTY_LAST_ACTIVITY_TITLE) String lastActivityTitle, @JsonProperty(required = true, value = JSON_PROPERTY_LAST_DETECTED) Long lastDetected, - @JsonProperty(required = true, value = JSON_PROPERTY_RISK_SCORE) Double riskScore, + @JsonProperty(required = true, value = JSON_PROPERTY_RISK_SCORE) Long riskScore, @JsonProperty(required = true, value = JSON_PROPERTY_RISK_SCORE_EVOLUTION) - Double riskScoreEvolution, + Long riskScoreEvolution, @JsonProperty(required = true, value = JSON_PROPERTY_SEVERITY) SecurityEntityRiskScoreAttributesSeverity severity, @JsonProperty(required = true, value = JSON_PROPERTY_SIGNALS_DETECTED) Long signalsDetected) { @@ -338,7 +338,7 @@ public void setLastDetected(Long lastDetected) { this.lastDetected = lastDetected; } - public SecurityEntityRiskScoreAttributes riskScore(Double riskScore) { + public SecurityEntityRiskScoreAttributes riskScore(Long riskScore) { this.riskScore = riskScore; return this; } @@ -350,15 +350,15 @@ public SecurityEntityRiskScoreAttributes riskScore(Double riskScore) { */ @JsonProperty(JSON_PROPERTY_RISK_SCORE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public Double getRiskScore() { + public Long getRiskScore() { return riskScore; } - public void setRiskScore(Double riskScore) { + public void setRiskScore(Long riskScore) { this.riskScore = riskScore; } - public SecurityEntityRiskScoreAttributes riskScoreEvolution(Double riskScoreEvolution) { + public SecurityEntityRiskScoreAttributes riskScoreEvolution(Long riskScoreEvolution) { this.riskScoreEvolution = riskScoreEvolution; return this; } @@ -370,11 +370,11 @@ public SecurityEntityRiskScoreAttributes riskScoreEvolution(Double riskScoreEvol */ @JsonProperty(JSON_PROPERTY_RISK_SCORE_EVOLUTION) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public Double getRiskScoreEvolution() { + public Long getRiskScoreEvolution() { return riskScoreEvolution; } - public void setRiskScoreEvolution(Double riskScoreEvolution) { + public void setRiskScoreEvolution(Long riskScoreEvolution) { this.riskScoreEvolution = riskScoreEvolution; } diff --git a/src/test/resources/com/datadog/api/client/v2/api/llm_observability.feature b/src/test/resources/com/datadog/api/client/v2/api/llm_observability.feature index e9c054c7366..639121ad238 100644 --- a/src/test/resources/com/datadog/api/client/v2/api/llm_observability.feature +++ b/src/test/resources/com/datadog/api/client/v2/api/llm_observability.feature @@ -79,7 +79,7 @@ Feature: LLM Observability Scenario: Create an LLM Observability annotation queue returns "Bad Request" response Given operation "CreateLLMObsAnnotationQueue" enabled And new "CreateLLMObsAnnotationQueue" request - And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Queue for annotating customer support traces", "name": "My annotation queue", "project_id": "a33671aa-24fd-4dcd-9b33-a8ec7dde7751"}, "type": "queues"}} + And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Queue for annotating customer support traces", "name": "My annotation queue", "project_id": "00000000-0000-0000-0000-000000000002"}, "type": "queues"}} When the request is sent Then the response status is 400 Bad Request @@ -87,7 +87,7 @@ Feature: LLM Observability Scenario: Create an LLM Observability annotation queue returns "Created" response Given operation "CreateLLMObsAnnotationQueue" enabled And new "CreateLLMObsAnnotationQueue" request - And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Queue for annotating customer support traces", "name": "My annotation queue", "project_id": "a33671aa-24fd-4dcd-9b33-a8ec7dde7751"}, "type": "queues"}} + And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Queue for annotating customer support traces", "name": "My annotation queue", "project_id": "00000000-0000-0000-0000-000000000002"}, "type": "queues"}} When the request is sent Then the response status is 201 Created @@ -586,7 +586,7 @@ Feature: LLM Observability Given operation "UpdateLLMObsAnnotationQueue" enabled And new "UpdateLLMObsAnnotationQueue" request And request contains "queue_id" parameter from "REPLACE.ME" - And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}} + And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}} When the request is sent Then the response status is 400 Bad Request @@ -595,7 +595,7 @@ Feature: LLM Observability Given operation "UpdateLLMObsAnnotationQueue" enabled And new "UpdateLLMObsAnnotationQueue" request And request contains "queue_id" parameter from "REPLACE.ME" - And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}} + And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}} When the request is sent Then the response status is 404 Not Found @@ -604,7 +604,7 @@ Feature: LLM Observability Given operation "UpdateLLMObsAnnotationQueue" enabled And new "UpdateLLMObsAnnotationQueue" request And request contains "queue_id" parameter from "REPLACE.ME" - And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}} + And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}} When the request is sent Then the response status is 200 OK @@ -697,7 +697,7 @@ Feature: LLM Observability Given operation "UpdateLLMObsAnnotationQueueLabelSchema" enabled And new "UpdateLLMObsAnnotationQueueLabelSchema" request And request contains "queue_id" parameter from "REPLACE.ME" - And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}} + And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}} When the request is sent Then the response status is 400 Bad Request @@ -706,7 +706,7 @@ Feature: LLM Observability Given operation "UpdateLLMObsAnnotationQueueLabelSchema" enabled And new "UpdateLLMObsAnnotationQueueLabelSchema" request And request contains "queue_id" parameter from "REPLACE.ME" - And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}} + And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}} When the request is sent Then the response status is 404 Not Found @@ -715,6 +715,6 @@ Feature: LLM Observability Given operation "UpdateLLMObsAnnotationQueueLabelSchema" enabled And new "UpdateLLMObsAnnotationQueueLabelSchema" request And request contains "queue_id" parameter from "REPLACE.ME" - And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}} + And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}} When the request is sent Then the response status is 200 OK diff --git a/src/test/resources/com/datadog/api/client/v2/api/security_monitoring.feature b/src/test/resources/com/datadog/api/client/v2/api/security_monitoring.feature index 820747b79b7..f621803eba6 100644 --- a/src/test/resources/com/datadog/api/client/v2/api/security_monitoring.feature +++ b/src/test/resources/com/datadog/api/client/v2/api/security_monitoring.feature @@ -1868,7 +1868,7 @@ Feature: Security Monitoring Scenario: Mute or unmute security findings returns "Accepted" response Given operation "MuteSecurityFindings" enabled And new "MuteSecurityFindings" request - And body with value {"data": {"attributes": {"mute": {"description": "To be resolved later.", "expire_at": 1778721573794, "is_muted": true, "reason": "PENDING_FIX"}}, "id": "93bfeb70-af47-424d-908a-948d3f08e37f", "relationships": {"findings": {"data": [{"id": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", "type": "findings"}]}}, "type": "mute"}} + And body with value {"data": {"attributes": {"mute": {"description": "To be resolved later.", "expire_at": 1778721573794, "is_muted": true, "reason": "PENDING_FIX"}}, "id": "00000000-0000-0000-0000-000000000001", "relationships": {"findings": {"data": [{"id": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", "type": "findings"}]}}, "type": "mute"}} When the request is sent Then the response status is 202 Accepted @@ -1876,7 +1876,7 @@ Feature: Security Monitoring Scenario: Mute or unmute security findings returns "Bad Request" response Given operation "MuteSecurityFindings" enabled And new "MuteSecurityFindings" request - And body with value {"data": {"attributes": {"mute": {"description": "To be resolved later.", "expire_at": 1778721573794, "is_muted": true, "reason": "PENDING_FIX"}}, "id": "93bfeb70-af47-424d-908a-948d3f08e37f", "relationships": {"findings": {"data": [{"id": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", "type": "findings"}]}}, "type": "mute"}} + And body with value {"data": {"attributes": {"mute": {"description": "To be resolved later.", "expire_at": 1778721573794, "is_muted": true, "reason": "PENDING_FIX"}}, "id": "00000000-0000-0000-0000-000000000001", "relationships": {"findings": {"data": [{"id": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", "type": "findings"}]}}, "type": "mute"}} When the request is sent Then the response status is 400 Bad Request @@ -1884,7 +1884,7 @@ Feature: Security Monitoring Scenario: Mute or unmute security findings returns "Not Found" response Given operation "MuteSecurityFindings" enabled And new "MuteSecurityFindings" request - And body with value {"data": {"attributes": {"mute": {"description": "To be resolved later.", "expire_at": 1778721573794, "is_muted": true, "reason": "PENDING_FIX"}}, "id": "93bfeb70-af47-424d-908a-948d3f08e37f", "relationships": {"findings": {"data": [{"id": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", "type": "findings"}]}}, "type": "mute"}} + And body with value {"data": {"attributes": {"mute": {"description": "To be resolved later.", "expire_at": 1778721573794, "is_muted": true, "reason": "PENDING_FIX"}}, "id": "00000000-0000-0000-0000-000000000001", "relationships": {"findings": {"data": [{"id": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", "type": "findings"}]}}, "type": "mute"}} When the request is sent Then the response status is 404 Not Found @@ -1892,7 +1892,7 @@ Feature: Security Monitoring Scenario: Mute or unmute security findings returns "Unprocessable Entity" response Given operation "MuteSecurityFindings" enabled And new "MuteSecurityFindings" request - And body with value {"data": {"attributes": {"mute": {"description": "To be resolved later.", "expire_at": 1778721573794, "is_muted": true, "reason": "PENDING_FIX"}}, "id": "93bfeb70-af47-424d-908a-948d3f08e37f", "relationships": {"findings": {"data": [{"id": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", "type": "findings"}]}}, "type": "mute"}} + And body with value {"data": {"attributes": {"mute": {"description": "To be resolved later.", "expire_at": 1778721573794, "is_muted": true, "reason": "PENDING_FIX"}}, "id": "00000000-0000-0000-0000-000000000001", "relationships": {"findings": {"data": [{"id": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", "type": "findings"}]}}, "type": "mute"}} When the request is sent Then the response status is 422 Unprocessable Entity