diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index ce0a0f2f0e7..49487855750 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -26493,6 +26493,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 @@ -26541,6 +26570,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: 1234512345123456abcabc912349abcd + name: app_key schema: $ref: "#/components/schemas/ApiKeyListResponse" description: OK @@ -26576,6 +26613,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: 1234512345123456abcabc912349abcd + name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK @@ -26616,6 +26661,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: 1234512345123456abcabc912349abcd + name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK @@ -26660,6 +26713,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: 1234512345123456abcabc912349abcd + name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK @@ -26708,6 +26769,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: 1234512345123456abcabc912349abcd + name: app_key schema: $ref: "#/components/schemas/ApiKeyResponse" description: OK @@ -26749,6 +26818,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 @@ -26787,6 +26863,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 @@ -26835,6 +26918,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 @@ -26876,6 +26966,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 @@ -26927,6 +27024,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 @@ -26994,6 +27098,10 @@ paths: "202": content: text/json: + examples: + default: + value: + status: ok schema: $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted @@ -27068,6 +27176,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 @@ -27109,6 +27233,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 @@ -27237,6 +27378,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 @@ -27348,6 +27500,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 @@ -27387,6 +27560,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 @@ -27429,6 +27616,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 @@ -27476,6 +27676,10 @@ paths: "200": content: application/json: + examples: + default: + value: + deleted_dashboard_list_id: 123 schema: $ref: "#/components/schemas/DashboardListDeleteResponse" description: OK @@ -27521,6 +27725,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 @@ -27577,6 +27794,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 @@ -27639,6 +27869,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 @@ -27697,6 +27942,10 @@ paths: "200": content: application/json: + examples: + default: + value: + deleted_public_dashboard_token: abc-123 schema: $ref: "#/components/schemas/DeleteSharedDashboardResponse" description: OK @@ -27747,6 +27996,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 @@ -27815,6 +28079,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 @@ -27944,6 +28223,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 @@ -28004,6 +28297,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 @@ -28055,6 +28362,10 @@ paths: "200": content: application/json: + examples: + default: + value: + deleted_dashboard_id: abc-123 schema: $ref: "#/components/schemas/DashboardDeleteResponse" description: OK @@ -28098,6 +28409,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 @@ -28160,6 +28492,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 @@ -28234,6 +28587,10 @@ paths: "202": content: text/json: + examples: + default: + value: + status: ok schema: $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted @@ -28292,6 +28649,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" @@ -28344,6 +28712,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 @@ -28395,6 +28774,11 @@ paths: "200": content: application/json: + examples: + default: + value: + cancelled_ids: + - 123 schema: $ref: "#/components/schemas/CanceledDowntimesIds" description: OK @@ -28493,6 +28877,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 @@ -28559,6 +28954,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 @@ -28673,6 +29079,20 @@ paths: "200": content: application/json: + examples: + default: + value: + events: + - alert_type: info + date_happened: 1674842440 + host: "test.host" + priority: normal + source_type_name: my_apps + tags: + - "environment:test" + text: "Oh boy!" + title: "Did you hear the news today?" + status: ok schema: $ref: "#/components/schemas/EventListResponse" description: OK @@ -28726,6 +29146,18 @@ paths: "202": content: application/json: + examples: + default: + value: + event: + alert_type: info + id: 123 + priority: normal + tags: + - environment:test + text: Oh boy! + title: Did you hear the news today? + status: ok schema: $ref: "#/components/schemas/EventCreateResponse" description: OK @@ -28763,6 +29195,18 @@ paths: "200": content: application/json: + examples: + default: + value: + event: + alert_type: info + id: 123 + priority: normal + tags: + - environment:test + text: Oh boy! + title: Did you hear the news today? + status: ok schema: $ref: "#/components/schemas/EventResponse" description: OK @@ -28859,6 +29303,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 @@ -28914,6 +29363,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 @@ -28950,6 +29406,11 @@ paths: "200": content: application/json: + examples: + default: + value: + action: Unmuted + hostname: test.host schema: $ref: "#/components/schemas/HostMuteResponse" description: OK @@ -29037,6 +29498,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 @@ -29084,6 +29560,11 @@ paths: "200": content: application/json: + examples: + default: + value: + total_active: 65 + total_up: 42 schema: $ref: "#/components/schemas/HostTotals" description: OK @@ -29134,6 +29615,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: type: object description: OK @@ -29192,6 +29676,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 @@ -29253,6 +29754,10 @@ paths: "200": content: application/json: + examples: + default: + value: + external_id: abc-123 schema: $ref: "#/components/schemas/AWSAccountCreateResponse" description: OK @@ -29340,6 +29845,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: type: object description: OK @@ -29380,6 +29888,12 @@ paths: "200": content: application/json: + examples: + default: + value: + - namespace1 + - namespace2 + - namespace3 schema: example: ["namespace1", "namespace2", "namespace3"] items: @@ -29423,6 +29937,10 @@ paths: "200": content: application/json: + examples: + default: + value: + status: empty schema: $ref: "#/components/schemas/AWSEventBridgeDeleteResponse" description: OK @@ -29457,6 +29975,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 @@ -29502,6 +30031,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 @@ -29548,6 +30084,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -29589,6 +30128,12 @@ paths: "200": content: application/json: + examples: + default: + value: + filters: + - namespace: elb + tag_filter_str: "prod*" schema: $ref: "#/components/schemas/AWSTagFilterListResponse" description: OK @@ -29636,6 +30181,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -29686,6 +30234,10 @@ paths: "200": content: application/json: + examples: + default: + value: + external_id: abc-123 schema: $ref: "#/components/schemas/AWSAccountCreateResponse" description: OK @@ -29732,6 +30284,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: type: object description: OK @@ -29766,6 +30321,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: @@ -29813,6 +30380,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: type: object description: OK @@ -29866,6 +30436,11 @@ paths: "200": content: application/json: + examples: + default: + value: + errors: [] + status: created schema: $ref: "#/components/schemas/AWSLogsAsyncResponse" description: OK @@ -29901,6 +30476,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: @@ -29949,6 +30531,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: type: object description: OK @@ -30010,6 +30595,11 @@ paths: "200": content: application/json: + examples: + default: + value: + errors: [] + status: created schema: $ref: "#/components/schemas/AWSLogsAsyncResponse" description: OK @@ -30056,6 +30646,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30090,6 +30683,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 @@ -30149,6 +30749,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30205,6 +30808,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30253,6 +30859,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30302,6 +30911,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30337,6 +30949,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 @@ -30393,6 +31013,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30447,6 +31070,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -30493,6 +31119,10 @@ paths: "201": content: application/json: + examples: + default: + value: + service_name: test-service schema: $ref: "#/components/schemas/PagerDutyServiceName" description: OK @@ -30568,6 +31198,10 @@ paths: "200": content: application/json: + examples: + default: + value: + service_name: test-service schema: $ref: "#/components/schemas/PagerDutyServiceName" description: OK @@ -30654,6 +31288,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 @@ -30710,6 +31354,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 @@ -30788,6 +31442,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 @@ -30845,6 +31509,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 @@ -30897,6 +31571,11 @@ paths: "201": content: application/json: + examples: + default: + value: + is_secret: true + name: CUSTOM_VARIABLE_NAME schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK @@ -30975,6 +31654,11 @@ paths: "200": content: application/json: + examples: + default: + value: + is_secret: true + name: CUSTOM_VARIABLE_NAME schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK @@ -31032,6 +31716,11 @@ paths: "200": content: application/json: + examples: + default: + value: + is_secret: true + name: CUSTOM_VARIABLE_NAME schema: $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK @@ -31084,6 +31773,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 @@ -31163,6 +31858,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 @@ -31220,6 +31921,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 @@ -31287,6 +31994,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 @@ -31325,6 +32046,13 @@ paths: "200": content: application/json: + examples: + default: + value: + index_names: + - main + - payments + - web schema: $ref: "#/components/schemas/LogsIndexesOrder" description: OK @@ -31366,6 +32094,13 @@ paths: "200": content: application/json: + examples: + default: + value: + index_names: + - main + - payments + - web schema: $ref: "#/components/schemas/LogsIndexesOrder" description: OK @@ -31401,6 +32136,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 @@ -31449,6 +32194,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 @@ -31532,6 +32286,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 @@ -31597,6 +32360,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 @@ -31632,6 +32404,13 @@ paths: "200": content: application/json: + examples: + default: + value: + pipeline_ids: + - tags + - org_ids + - products schema: $ref: "#/components/schemas/LogsPipelinesOrder" description: OK @@ -31676,6 +32455,13 @@ paths: "200": content: application/json: + examples: + default: + value: + pipeline_ids: + - tags + - org_ids + - products schema: $ref: "#/components/schemas/LogsPipelinesOrder" description: OK @@ -31717,6 +32503,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 @@ -31757,6 +32553,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 @@ -31835,6 +32641,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 @@ -31892,6 +32708,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 @@ -31950,6 +32776,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 @@ -31994,6 +32827,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 @@ -32052,6 +32892,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 @@ -32157,6 +33004,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: @@ -32451,6 +33312,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 @@ -32502,6 +33377,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + ok: + - 123 + errors: schema: $ref: "#/components/schemas/CheckCanDeleteMonitorResponse" description: OK @@ -32587,6 +33469,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 @@ -32667,6 +33571,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 @@ -32727,6 +33652,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -32782,6 +33710,10 @@ paths: "200": content: application/json: + examples: + default: + value: + deleted_monitor_id: 123 schema: $ref: "#/components/schemas/DeletedMonitor" description: OK @@ -32857,6 +33789,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 @@ -32929,6 +33871,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 @@ -32989,6 +33941,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" @@ -33058,6 +34021,9 @@ paths: "200": content: application/json: + examples: + default: + value: {} schema: example: {} type: object @@ -33128,6 +34094,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 @@ -33169,6 +34151,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 @@ -33301,6 +34300,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 @@ -33379,6 +34393,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 @@ -33461,6 +34494,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 @@ -33550,6 +34603,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 @@ -33595,6 +34667,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 @@ -33645,6 +34724,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 @@ -33686,6 +34776,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 @@ -33740,6 +34837,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 @@ -33777,6 +34881,10 @@ paths: "200": content: application/json: + examples: + default: + value: + message: "Child organization abc-123 downgraded successfully" schema: $ref: "#/components/schemas/OrgDowngradedResponse" description: OK @@ -33829,6 +34937,10 @@ paths: "200": content: application/json: + examples: + default: + value: + message: IdP metadata successfully uploaded for example org schema: $ref: "#/components/schemas/IdpResponse" description: OK @@ -33885,6 +34997,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 @@ -33933,6 +35059,13 @@ paths: "200": content: application/json: + examples: + default: + value: + results: + metrics: + - system.cpu.idle + - system.load.1 schema: $ref: "#/components/schemas/MetricSearchResponse" description: OK @@ -33985,6 +35118,10 @@ paths: "200": content: application/json: + examples: + default: + value: + status: updated schema: $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK @@ -34039,6 +35176,10 @@ paths: "200": content: application/json: + examples: + default: + value: + status: updated schema: $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK @@ -34094,6 +35235,10 @@ paths: "200": content: application/json: + examples: + default: + value: + status: updated schema: $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK @@ -34173,6 +35318,10 @@ paths: "202": content: text/json: + examples: + default: + value: + status: ok schema: $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted @@ -34264,6 +35413,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 @@ -34335,6 +35501,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 @@ -34394,6 +35576,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + deleted: [] + updated: + - abc-123 + errors: [] schema: $ref: "#/components/schemas/SLOBulkDeleteResponse" description: OK @@ -34443,6 +35633,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + ok: + - abc-123 + errors: {} schema: $ref: "#/components/schemas/CheckCanDeleteSLOResponse" description: OK @@ -34505,6 +35702,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 @@ -34559,6 +35768,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 @@ -34642,6 +35863,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 @@ -34694,6 +35927,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 @@ -34759,6 +36004,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 @@ -34813,6 +36074,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - abc-123 + errors: {} schema: $ref: "#/components/schemas/SLODeleteResponse" description: OK @@ -34869,6 +36136,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 @@ -34937,6 +36219,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 @@ -34989,6 +36286,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 @@ -35079,6 +36388,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 @@ -35129,6 +36454,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 @@ -35162,6 +36499,16 @@ paths: "200": content: application/json: + examples: + default: + value: + locations: + - display_name: "Paris (AWS)" + id: "aws:eu-west-3" + is_active: true + is_public: true + name: "Paris (AWS)" + region: "Europe" schema: $ref: "#/components/schemas/SyntheticsLocations" description: OK @@ -35201,6 +36548,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 @@ -35281,6 +36637,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 @@ -35334,6 +36698,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 @@ -35368,6 +36740,11 @@ paths: "200": content: application/json: + examples: + default: + value: + - "aws:eu-west-3" + - "aws:us-east-1" schema: $ref: "#/components/schemas/SyntheticsDefaultLocations" description: OK @@ -35404,6 +36781,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. @@ -35598,6 +36988,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. @@ -35653,6 +37069,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 @@ -35729,6 +37164,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 @@ -35811,6 +37265,26 @@ paths: "200": content: application/json: + examples: + default: + value: + config: + 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. @@ -35866,6 +37340,26 @@ paths: "200": content: application/json: + examples: + default: + value: + config: + 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 @@ -35944,6 +37438,26 @@ paths: "200": content: application/json: + examples: + default: + value: + config: + 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 @@ -36025,6 +37539,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 @@ -36080,6 +37603,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 @@ -36131,6 +37661,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. @@ -36203,6 +37739,20 @@ paths: "200": content: application/json: + examples: + default: + value: + device_ids: + - "synthetics:mobile:device:apple_iphone_14_ios_16" + message: "Notification message" + name: "Example mobile test" + options: + 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. @@ -36258,6 +37808,20 @@ paths: "200": content: application/json: + examples: + default: + value: + device_ids: + - "synthetics:mobile:device:apple_iphone_14_ios_16" + message: "Notification message" + name: "Example mobile test" + options: + tick_every: 3600 + public_id: "abc-def-123" + status: live + tags: + - "env:production" + type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: OK @@ -36326,6 +37890,20 @@ paths: "200": content: application/json: + examples: + default: + value: + device_ids: + - "synthetics:mobile:device:apple_iphone_14_ios_16" + message: "Notification message" + name: "Example mobile test" + options: + tick_every: 3600 + public_id: "abc-def-123" + status: live + tags: + - "env:production" + type: mobile schema: $ref: "#/components/schemas/SyntheticsMobileTest" description: OK @@ -36418,6 +37996,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. @@ -36467,6 +38058,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 @@ -36511,6 +38112,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 @@ -36557,6 +38168,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" @@ -36605,6 +38228,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 @@ -36666,6 +38302,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 @@ -36745,6 +38394,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 @@ -36798,6 +38458,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 @@ -36855,6 +38522,9 @@ paths: "200": content: application/json: + examples: + default: + value: true schema: type: boolean description: OK - Returns a boolean indicating if the update was successful. @@ -36901,6 +38571,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 @@ -36952,6 +38634,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 @@ -37048,6 +38742,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 @@ -37105,6 +38810,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 @@ -37150,6 +38867,12 @@ paths: "200": content: application/json: + examples: + default: + value: + tags: + environment:production: + - test.metric.host schema: $ref: "#/components/schemas/TagToHosts" description: OK @@ -37237,6 +38960,12 @@ paths: "200": content: application/json: + examples: + default: + value: + host: test.host + tags: + - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: OK @@ -37294,6 +39023,12 @@ paths: "201": content: application/json: + examples: + default: + value: + host: test.host + tags: + - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: Created @@ -37351,6 +39086,12 @@ paths: "201": content: application/json: + examples: + default: + value: + host: test.host + tags: + - "environment:production" schema: $ref: "#/components/schemas/HostTags" description: OK @@ -37400,6 +39141,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 @@ -37461,6 +39210,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 @@ -37520,6 +39277,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 @@ -37579,6 +39345,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 @@ -37640,6 +39417,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 @@ -37701,6 +39489,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 @@ -37762,6 +39562,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 @@ -37823,6 +39632,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 @@ -37882,6 +39700,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 @@ -37941,6 +39768,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 @@ -38046,6 +39886,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 @@ -38101,6 +39955,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 @@ -38161,6 +40023,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 @@ -38222,6 +40092,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 @@ -38283,6 +40161,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 @@ -38342,6 +40228,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 @@ -38403,6 +40299,17 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + usage: + - hour: "2024-01-01T00:00:00+00:00" + 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 @@ -38468,6 +40375,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 @@ -38590,6 +40508,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 @@ -38645,6 +40578,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 @@ -38704,6 +40645,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 @@ -38765,6 +40714,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 @@ -38826,6 +40783,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 @@ -38885,6 +40851,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 @@ -38950,6 +40925,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 @@ -39012,6 +40996,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 @@ -39073,6 +41066,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 @@ -39147,6 +41148,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 @@ -39206,6 +41219,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 @@ -39265,6 +41286,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 @@ -39324,6 +41353,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 @@ -39383,6 +41420,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 @@ -39461,6 +41508,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 @@ -39502,6 +41561,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 @@ -39549,6 +41616,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 @@ -39600,6 +41675,10 @@ paths: "200": content: application/json: + examples: + default: + value: + message: "User user@example.com disabled" schema: $ref: "#/components/schemas/UserDisableResponse" description: User disabled @@ -39641,6 +41720,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 @@ -39692,6 +41779,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 @@ -39727,6 +41822,10 @@ paths: "200": content: application/json: + examples: + default: + value: + valid: true schema: $ref: "#/components/schemas/AuthenticationValidationResponse" description: OK @@ -39861,6 +41960,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 7ab82fd266b..65502839ee6 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -82109,6 +82109,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 @@ -82191,6 +82199,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 @@ -82238,6 +82260,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 @@ -82315,6 +82349,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 @@ -82399,6 +82448,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 @@ -82446,6 +82511,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 @@ -82500,6 +82577,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 @@ -82753,6 +82843,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 @@ -82835,6 +82940,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 @@ -82915,6 +83030,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 @@ -83001,6 +83126,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 @@ -83096,6 +83243,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 @@ -83190,6 +83355,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 @@ -83281,6 +83468,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 @@ -83339,6 +83548,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. @@ -83419,6 +83641,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 @@ -83684,6 +83921,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: abc-123 + type: datastores schema: $ref: "#/components/schemas/DatastoreArray" description: OK @@ -83719,6 +83970,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: datastores schema: $ref: "#/components/schemas/CreateAppsDatastoreResponse" description: OK @@ -83780,6 +84037,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: abc-123 + type: datastores schema: $ref: "#/components/schemas/Datastore" description: OK @@ -83829,6 +84100,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: abc-123 + type: datastores schema: $ref: "#/components/schemas/Datastore" description: OK @@ -83882,6 +84167,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: items schema: $ref: "#/components/schemas/DeleteAppsDatastoreItemResponse" description: OK @@ -83951,6 +84242,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: abc-123 + value: + key: example-value + id: abc-123 + type: items schema: $ref: "#/components/schemas/ItemApiPayloadArray" description: OK @@ -84006,6 +84311,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: abc-123 + value: + count: 42 + status: active + id: abc-123 + type: items schema: $ref: "#/components/schemas/ItemApiPayload" description: OK @@ -84057,6 +84377,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: abc-123 + type: items schema: $ref: "#/components/schemas/DeleteAppsDatastoreItemResponseArray" description: OK @@ -84120,6 +84446,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: abc-123 + type: items schema: $ref: "#/components/schemas/PutAppsDatastoreItemResponseArray" description: OK @@ -84167,6 +84499,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 @@ -84246,6 +84587,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 @@ -84289,6 +84636,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 @@ -84346,6 +84699,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + integration: + type: AWS + name: My AWS Connection + id: abc-123 + type: action_connection schema: $ref: "#/components/schemas/CreateActionConnectionResponse" description: Successfully created Action Connection @@ -84413,6 +84776,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + integration: + type: AWS + name: My AWS Connection + id: abc-123 + type: action_connection schema: $ref: "#/components/schemas/GetActionConnectionResponse" description: Successfully get Action Connection @@ -84468,6 +84841,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + integration: + type: AWS + name: My AWS Connection + id: abc-123 + type: action_connection schema: $ref: "#/components/schemas/UpdateActionConnectionResponse" description: Successfully updated Action Connection @@ -84506,6 +84889,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 @@ -84545,6 +84939,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. @@ -84597,6 +85002,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 @@ -84665,6 +85081,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 @@ -84700,6 +85125,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 @@ -84753,6 +85187,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 @@ -84800,6 +85243,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 @@ -84821,6 +85273,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 @@ -84859,6 +85320,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. @@ -84925,6 +85395,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 @@ -84974,6 +85453,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 @@ -85002,6 +85490,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 @@ -85041,6 +85540,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. @@ -85072,6 +85581,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. @@ -85118,6 +85638,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: anonymize_users_response schema: $ref: "#/components/schemas/AnonymizeUsersResponse" description: OK @@ -85169,6 +85695,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: abc-123 + type: api_keys schema: $ref: "#/components/schemas/APIKeysResponse" description: OK @@ -85213,6 +85750,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: abc-123 + type: api_keys schema: $ref: "#/components/schemas/APIKeyResponse" description: Created @@ -85278,6 +85826,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: abc-123 + type: api_keys schema: $ref: "#/components/schemas/APIKeyResponse" description: OK @@ -85325,6 +85884,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: abc-123 + type: api_keys schema: $ref: "#/components/schemas/APIKeyResponse" description: OK @@ -85391,6 +85961,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 @@ -85485,6 +86067,9 @@ paths: "200": content: multipart/form-data: + examples: + default: + value: openapi-spec.yaml schema: format: binary type: string @@ -85549,6 +86134,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 @@ -85608,6 +86200,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 @@ -85646,6 +86245,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 @@ -85692,6 +86307,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 @@ -85742,6 +86373,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 @@ -85789,6 +86436,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 @@ -85816,6 +86479,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 @@ -85861,6 +86537,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 @@ -85948,6 +86637,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 @@ -85997,6 +86699,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 @@ -86030,6 +86745,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 @@ -86067,6 +86794,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 @@ -86179,6 +86912,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: abc-123 + type: appDefinitions + meta: + page: + totalCount: 1 + totalFilteredCount: 1 schema: $ref: "#/components/schemas/ListAppsResponse" description: OK @@ -86227,6 +86977,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 @@ -86270,6 +87026,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: appDefinitions schema: $ref: "#/components/schemas/DeleteAppResponse" description: OK @@ -86328,6 +87090,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 @@ -86399,6 +87173,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 @@ -86442,6 +87228,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 @@ -86488,6 +87282,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 @@ -86534,6 +87336,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: abc-123 + type: application_keys schema: $ref: "#/components/schemas/ListApplicationKeysResponse" description: OK @@ -86605,6 +87417,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: abc-123 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -86662,6 +87484,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: abc-123 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -86755,6 +87587,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 @@ -86808,6 +87656,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 @@ -86857,6 +87723,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + attribute_key: member-of + attribute_value: Development + id: abc-123 + type: authn_mappings schema: $ref: "#/components/schemas/AuthNMappingsResponse" description: OK @@ -86896,6 +87771,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attribute_key: member-of + attribute_value: Development + id: abc-123 + type: authn_mappings schema: $ref: "#/components/schemas/AuthNMappingResponse" description: OK @@ -86966,6 +87850,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attribute_key: member-of + attribute_value: Development + id: abc-123 + type: authn_mappings schema: $ref: "#/components/schemas/AuthNMappingResponse" description: OK @@ -87014,6 +87907,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + attribute_key: member-of + attribute_value: Development + id: abc-123 + type: authn_mappings schema: $ref: "#/components/schemas/AuthNMappingResponse" description: OK @@ -87291,6 +88193,29 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case + meta: + page: + current: 1 + size: 10 + total: 1 schema: $ref: "#/components/schemas/CasesResponse" description: OK @@ -87350,6 +88275,24 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: CREATED @@ -87380,6 +88323,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + key: SEC + name: Security Investigation + id: abc-123 + type: project schema: $ref: "#/components/schemas/ProjectsResponse" description: OK @@ -87423,6 +88375,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + key: SEC + name: Security Investigation + id: abc-123 + type: project schema: $ref: "#/components/schemas/ProjectResponse" description: CREATED @@ -87481,6 +88442,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + key: SEC + name: Security Investigation + id: abc-123 + type: project schema: $ref: "#/components/schemas/ProjectResponse" description: OK @@ -87524,6 +88494,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + key: SEC + name: Security Investigation + id: abc-123 + type: project schema: $ref: "#/components/schemas/ProjectResponse" description: OK @@ -87562,6 +88541,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: abc-123 + type: notification_rule schema: $ref: "#/components/schemas/CaseNotificationRulesResponse" description: OK @@ -87615,6 +88610,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: abc-123 + type: notification_rule schema: $ref: "#/components/schemas/CaseNotificationRuleResponse" description: CREATED @@ -87729,6 +88740,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: Investigations done in case management + emoji: "🕵🏻‍♂️" + name: Investigation + id: abc-123 + type: case_type schema: $ref: "#/components/schemas/CaseTypesResponse" description: OK @@ -87764,6 +88785,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + description: Investigations done in case management + emoji: "🕵🏻‍♂️" + name: Investigation + id: abc-123 + type: case_type schema: $ref: "#/components/schemas/CaseTypeResponse" description: CREATED @@ -87786,6 +88817,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + case_type_id: abc-123 + description: "AWS Region, must be a valid region supported by AWS" + display_name: AWS Region + is_multi: true + key: aws_region + type: TEXT + id: abc-123 + type: custom_attribute schema: $ref: "#/components/schemas/CustomAttributeConfigsResponse" description: OK @@ -87826,6 +88870,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + case_type_id: abc-123 + description: "AWS Region, must be a valid region supported by AWS" + display_name: AWS Region + is_multi: true + key: aws_region + type: TEXT + id: abc-123 + type: custom_attribute schema: $ref: "#/components/schemas/CustomAttributeConfigsResponse" description: OK @@ -87867,6 +88924,19 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + case_type_id: abc-123 + description: "AWS Region, must be a valid region supported by AWS" + display_name: AWS Region + is_multi: true + key: aws_region + type: TEXT + id: abc-123 + type: custom_attribute schema: $ref: "#/components/schemas/CustomAttributeConfigResponse" description: CREATED @@ -87915,6 +88985,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -87958,6 +89046,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88003,6 +89109,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88055,6 +89179,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88100,6 +89242,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: 2024-01-01 00:00:00+00:00 + message: This is my comment ! + id: abc-123 + type: case schema: $ref: "#/components/schemas/TimelineResponse" description: OK @@ -88150,6 +89301,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88195,6 +89364,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88240,6 +89427,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88285,6 +89490,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88329,6 +89552,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: abc-123 + type: case schema: $ref: "#/components/schemas/CaseResponse" description: Created @@ -88623,6 +89857,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: abc-123 + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88749,6 +89994,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88794,6 +90057,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88837,6 +90118,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88880,6 +90179,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + key: CASEM-1234 + priority: NOT_DEFINED + status: OPEN + status_name: Open + title: Memory leak investigation on API + id: abc-123 + relationships: + project: + data: + id: abc-123 + type: project + type: case schema: $ref: "#/components/schemas/CaseResponse" description: OK @@ -88935,6 +90252,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 @@ -88995,6 +90326,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 @@ -89020,6 +90365,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 @@ -89079,6 +90430,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 @@ -89118,6 +90481,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 @@ -89191,6 +90566,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + from: + ref: service:test-service + to: + ref: service:other-service + type: RelationTypeOwns + id: abc-123 + type: relation + meta: + count: 1 schema: $ref: "#/components/schemas/ListRelationCatalogResponse" description: OK @@ -89243,6 +90632,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 @@ -89281,6 +90707,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 @@ -89347,6 +90810,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 @@ -89406,6 +90906,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 @@ -89445,6 +90982,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 @@ -89507,6 +91081,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 @@ -89574,6 +91185,9 @@ paths: "202": content: application/json: + examples: + default: + value: {} schema: type: object description: Request accepted for processing @@ -89668,6 +91282,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + buckets: + - by: + "@ci.status": error + computes: + pc90: + type: timeseries + value: [2345] schema: $ref: "#/components/schemas/CIAppPipelinesAnalyticsAggregateResponse" description: OK @@ -89749,6 +91374,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] + meta: + page: + after: schema: $ref: "#/components/schemas/CIAppPipelineEventsResponse" description: OK @@ -89805,6 +91437,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 @@ -89875,6 +91523,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 @@ -89922,6 +91578,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 @@ -90024,6 +91688,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 @@ -90073,6 +91753,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 @@ -90137,6 +91833,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + buckets: + - by: + "@test.service": web-tests + computes: + pc90: + type: timeseries + value: [2345] schema: $ref: "#/components/schemas/CIAppTestsAnalyticsAggregateResponse" description: OK @@ -90221,6 +91928,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] + meta: + page: + after: schema: $ref: "#/components/schemas/CIAppTestEventsResponse" description: OK @@ -90280,6 +91994,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 @@ -90317,6 +92049,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 @@ -90361,6 +92103,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 @@ -90429,6 +92181,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 @@ -90481,6 +92243,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 @@ -90517,6 +92288,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 @@ -90550,6 +92331,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 @@ -90602,6 +92399,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 @@ -90637,6 +92443,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 @@ -90687,6 +92504,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 @@ -90733,6 +92561,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 @@ -90792,6 +92631,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 @@ -90874,6 +92724,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 @@ -90954,6 +92823,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 @@ -90994,6 +92880,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 @@ -91072,6 +92986,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 @@ -91165,6 +93104,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 @@ -91252,6 +93218,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 @@ -91273,6 +93264,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-01 12:00:00 + 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 + id: "123" + type: aws_cur_config schema: $ref: "#/components/schemas/AwsCURConfigsResponse" description: OK @@ -91328,6 +93337,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-01 12:00:00 + 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 + id: "123456789123" + type: aws_cur_config schema: $ref: "#/components/schemas/AwsCurConfigResponse" description: OK @@ -91407,6 +93439,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-01 12:00:00 + 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 + id: "123456789123" + type: aws_cur_config schema: $ref: "#/components/schemas/AwsCurConfigResponse" description: OK @@ -91450,6 +93505,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-01 12:00:00 + 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 + id: "123" + type: aws_cur_config schema: $ref: "#/components/schemas/AwsCURConfigsResponse" description: OK @@ -91487,6 +93560,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-01 12:00:00 + 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-01 12:00:00 + storage_account: dd-storage-account + storage_container: dd-storage-container + updated_at: 2023-01-01 12:00:00 + id: "123456789123" + type: azure_uc_configs schema: $ref: "#/components/schemas/AzureUCConfigsResponse" description: OK @@ -91542,6 +93638,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-01 12:00:00 + 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-01 12:00:00 + storage_account: dd-storage-account + storage_container: dd-storage-container + updated_at: 2023-01-01 12:00:00 + id: "123456789123" + type: azure_uc_configs schema: $ref: "#/components/schemas/AzureUCConfigPairsResponse" description: OK @@ -91621,6 +93740,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-01 12:00:00 + 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-01 12:00:00 + storage_account: dd-storage-account + storage_container: dd-storage-container + updated_at: 2023-01-01 12:00:00 + id: "123456789123" + type: azure_uc_configs schema: $ref: "#/components/schemas/UCConfigPair" description: OK @@ -91656,6 +93798,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-01 12:00:00 + 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-01 12:00:00 + storage_account: dd-storage-account + storage_container: dd-storage-container + updated_at: 2023-01-01 12:00:00 + id: "123456789123" + type: azure_uc_configs schema: $ref: "#/components/schemas/AzureUCConfigPairsResponse" description: OK @@ -91722,6 +93887,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 @@ -91744,6 +93932,10 @@ paths: "200": content: application/json: + examples: + default: + value: + errors: [] schema: $ref: "#/components/schemas/ValidationResponse" description: OK @@ -91795,6 +93987,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 @@ -91832,6 +94033,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 @@ -91851,6 +94075,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 @@ -91907,6 +94148,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: abc-123 + type: custom_costs + meta: + total_filtered_count: 1 + version: "1" schema: $ref: "#/components/schemas/CustomCostsFileListResponse" description: OK @@ -91957,6 +94218,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: abc-123 + type: custom_costs + meta: + version: "1" schema: $ref: "#/components/schemas/CustomCostsFileUploadResponse" description: Accepted @@ -92026,6 +94306,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: abc-123 + type: custom_costs + meta: + version: "1" schema: $ref: "#/components/schemas/CustomCostsFileGetResponse" description: OK @@ -92059,6 +94364,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-01 12:00:00 + 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-01 12:00:00 + updated_at: 2023-01-01 12:00:00 + id: "123456789123" + type: gcp_uc_config schema: $ref: "#/components/schemas/GCPUsageCostConfigsResponse" description: OK @@ -92107,6 +94432,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-01 12:00:00 + 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-01 12:00:00 + updated_at: 2023-01-01 12:00:00 + id: "123456789123" + type: gcp_uc_config schema: $ref: "#/components/schemas/GCPUsageCostConfigResponse" description: OK @@ -92186,6 +94531,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-01 12:00:00 + 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-01 12:00:00 + updated_at: 2023-01-01 12:00:00 + id: "123456789123" + type: gcp_uc_config schema: $ref: "#/components/schemas/GcpUcConfigResponse" description: OK @@ -92221,6 +94586,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-01 12:00:00 + 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-01 12:00:00 + updated_at: 2023-01-01 12:00:00 + id: "123456789123" + type: gcp_uc_config schema: $ref: "#/components/schemas/GCPUsageCostConfigResponse" description: OK @@ -92265,6 +94650,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ActiveBillingDimensionsResponse" description: OK @@ -92382,6 +94771,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 @@ -92459,6 +94854,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 @@ -92479,6 +94888,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 @@ -92499,6 +94921,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 @@ -92519,6 +94954,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 @@ -92570,6 +95018,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 @@ -92595,6 +95057,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: abc-123 + type: application_keys schema: $ref: "#/components/schemas/ListApplicationKeysResponse" description: OK @@ -92649,6 +95121,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: abc-123 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: Created @@ -92715,6 +95197,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: abc-123 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -92768,6 +95260,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: abc-123 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: OK @@ -92828,6 +95330,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 @@ -92870,6 +95378,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 @@ -92927,6 +95442,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 @@ -92982,6 +95503,12 @@ paths: "200": content: application/json: + examples: + default: + value: + dashboards: + - id: q5j-nti-fv6 + type: host_timeboard schema: $ref: "#/components/schemas/DashboardListUpdateItemsResponse" description: OK @@ -93046,6 +95573,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + credential: A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6Q7r8S9t0U1v2 + dashboard_id: abc-def-ghi + global_time_selectable: true + id: "12345" + share_type: secure_embed + status: active + title: "Q1 Metrics Dashboard" + token: s3cur3t0k3n-abcdef123456 + url: "https://p.datadoghq.com/sb/secure-embed/s3cur3t0k3n-abcdef123456" + id: "12345" + type: secure_embed_create_response schema: $ref: "#/components/schemas/SecureEmbedCreateResponse" description: OK @@ -93136,6 +95680,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: s3cur3t0k3n-abcdef123456 + url: "https://p.datadoghq.com/sb/secure-embed/s3cur3t0k3n-abcdef123456" + id: "12345" + type: secure_embed_get_response schema: $ref: "#/components/schemas/SecureEmbedGetResponse" description: OK @@ -93188,6 +95749,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: s3cur3t0k3n-abcdef123456 + url: "https://p.datadoghq.com/sb/secure-embed/s3cur3t0k3n-abcdef123456" + id: "12345" + type: secure_embed_update_response schema: $ref: "#/components/schemas/SecureEmbedUpdateResponse" description: OK @@ -93229,6 +95807,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: abc-123 + type: dataset schema: $ref: "#/components/schemas/DatasetResponseMulti" description: OK @@ -93280,6 +95872,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: abc-123 + type: dataset schema: $ref: "#/components/schemas/DatasetResponseSingle" description: OK @@ -93348,6 +95954,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: abc-123 + type: dataset schema: $ref: "#/components/schemas/DatasetResponseSingle" description: OK @@ -93403,6 +96023,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: abc-123 + type: dataset schema: $ref: "#/components/schemas/DatasetResponseSingle" description: OK @@ -93446,6 +96080,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 @@ -93530,6 +96186,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 @@ -93569,6 +96247,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 @@ -93631,6 +96331,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: abc-123 + dry_run: false + env: production + identifier: pre + service: my-service + id: abc-123 + type: deployment_gate + meta: + page: + size: 50 schema: $ref: "#/components/schemas/DeploymentGatesListResponse" description: OK @@ -93684,6 +96401,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: abc-123 + name: Example Name + dry_run: false + env: production + identifier: pre + service: my-service + id: abc-123 + type: deployment_gate schema: $ref: "#/components/schemas/DeploymentGateResponse" description: OK @@ -93729,6 +96462,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + rules: + - created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: abc-123 + dry_run: false + gate_id: abc-123 + name: My deployment rule + options: + duration: 3600 + excluded_resources: [] + type: faulty_deployment_detection + id: abc-123 + type: list_deployment_rules schema: $ref: "#/components/schemas/DeploymentGateRulesResponse" description: OK @@ -93793,6 +96544,22 @@ 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: abc-123 + name: Test User + dry_run: false + gate_id: abc-123 + name: My deployment rule + type: faulty_deployment_detection + id: abc-123 + type: deployment_rule schema: $ref: "#/components/schemas/DeploymentRuleResponse" description: OK @@ -93892,6 +96659,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: abc-123 + dry_run: false + gate_id: abc-123 + name: My deployment rule + options: + duration: 3600 + excluded_resources: [] + type: faulty_deployment_detection + id: abc-123 + type: deployment_rule schema: $ref: "#/components/schemas/DeploymentRuleResponse" description: OK @@ -93963,6 +96747,24 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: abc-123 + dry_run: false + gate_id: abc-123 + name: Updated deployment rule + options: + duration: 3600 + excluded_resources: + - resource1 + type: faulty_deployment_detection + id: abc-123 + type: deployment_rule schema: $ref: "#/components/schemas/DeploymentRuleResponse" description: OK @@ -94052,6 +96854,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: abc-123 + dry_run: false + env: production + identifier: pre + service: my-service + id: abc-123 + type: deployment_gate schema: $ref: "#/components/schemas/DeploymentGateResponse" description: OK @@ -94112,6 +96928,20 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: + id: abc-123 + dry_run: false + env: production + identifier: pre + service: my-service + id: abc-123 + type: deployment_gate schema: $ref: "#/components/schemas/DeploymentGateResponse" description: OK @@ -94171,6 +97001,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 @@ -94223,6 +97061,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 @@ -94262,6 +97113,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + domains: + - "@example.com" + enabled: false + id: abc-123 + type: domain_allowlist schema: $ref: "#/components/schemas/DomainAllowlistResponse" description: OK @@ -94307,6 +97168,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + domains: + - "@example.com" + enabled: false + id: abc-123 + type: domain_allowlist schema: $ref: "#/components/schemas/DomainAllowlistResponse" description: OK @@ -94368,12 +97239,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 @@ -94452,6 +97335,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 @@ -94491,6 +97386,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 @@ -94602,12 +97509,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 @@ -94686,6 +97605,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_incident schema: $ref: "#/components/schemas/DORAFailuresListResponse" description: OK @@ -94725,6 +97658,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_incident schema: $ref: "#/components/schemas/DORAFailureFetchResponse" description: OK @@ -94787,12 +97734,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 @@ -94845,6 +97804,31 @@ 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_id: 123 + 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 @@ -94906,6 +97890,28 @@ 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_id: 123 + 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 @@ -95004,6 +98010,28 @@ 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_id: 123 + 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 @@ -95082,6 +98110,28 @@ 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_id: 123 + 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 @@ -95146,6 +98196,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 @@ -95176,6 +98236,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: abc-123 + type: issue schema: $ref: "#/components/schemas/IssueResponse" description: OK @@ -95249,6 +98320,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: abc-123 + type: issue schema: $ref: "#/components/schemas/IssueResponse" description: OK @@ -95298,6 +98380,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: abc-123 + type: issue schema: $ref: "#/components/schemas/IssueResponse" description: OK @@ -95375,6 +98468,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 @@ -95473,6 +98579,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 @@ -95561,6 +98676,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 @@ -95598,6 +98726,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 @@ -95662,6 +98801,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListFeatureFlagsResponse" description: OK @@ -95714,6 +98857,28 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + description: A sample feature flag + key: feature-flag-abc123 + name: Feature Flag ABC 123 + updated_at: 2024-01-01 00:00:00+00:00 + value_type: BOOLEAN + variants: + - id: abc-123 + key: variant-a + name: Variant A + value: "true" + - id: abc-123 + key: variant-b + name: Variant B + value: "false" + id: abc-123 + type: feature-flags schema: $ref: "#/components/schemas/FeatureFlagResponse" description: Created @@ -95788,6 +98953,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListEnvironmentsResponse" description: OK @@ -95833,6 +99002,21 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + is_production: false + key: staging-environment + name: staging-environment + queries: + - staging + require_feature_flag_approval: false + updated_at: 2024-01-01 00:00:00+00:00 + id: abc-123 + type: environments schema: $ref: "#/components/schemas/EnvironmentResponse" description: Created @@ -95910,6 +99094,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + is_production: false + key: staging-environment + name: staging-environment + queries: + - staging + require_feature_flag_approval: false + updated_at: 2024-01-01 00:00:00+00:00 + id: abc-123 + type: environments schema: $ref: "#/components/schemas/EnvironmentResponse" description: OK @@ -95964,6 +99163,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + is_production: false + key: production-environment + name: production-environment + queries: + - production + require_feature_flag_approval: false + updated_at: 2024-01-01 00:00:00+00:00 + id: abc-123 + type: environments schema: $ref: "#/components/schemas/EnvironmentResponse" description: OK @@ -96273,6 +99487,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + description: A sample feature flag + key: feature-flag-abc123 + name: Feature Flag ABC 123 + updated_at: 2024-01-01 00:00:00+00:00 + value_type: BOOLEAN + variants: + - id: abc-123 + key: variant-a + name: Variant A + value: "true" + - id: abc-123 + key: variant-b + name: Variant B + value: "false" + id: abc-123 + type: feature-flags schema: $ref: "#/components/schemas/FeatureFlagResponse" description: OK @@ -96327,6 +99563,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + description: A sample feature flag + key: feature-flag-abc123 + name: Feature Flag ABC 123 + updated_at: 2024-01-01 00:00:00+00:00 + value_type: BOOLEAN + variants: + - id: abc-123 + key: variant-a + name: Variant A + value: "true" + - id: abc-123 + key: variant-b + name: Variant B + value: "false" + id: abc-123 + type: feature-flags schema: $ref: "#/components/schemas/FeatureFlagResponse" description: OK @@ -96373,6 +99631,28 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + description: A sample feature flag + key: feature-flag-abc123 + name: Feature Flag ABC 123 + updated_at: 2024-01-01 00:00:00+00:00 + value_type: BOOLEAN + variants: + - id: abc-123 + key: variant-a + name: Variant A + value: "true" + - id: abc-123 + key: variant-b + name: Variant B + value: "false" + id: abc-123 + type: feature-flags schema: $ref: "#/components/schemas/FeatureFlagResponse" description: OK @@ -96466,6 +99746,27 @@ paths: "202": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: 2024-01-01 00:00:00+00:00 + environment_ids: + - abc-123 + guardrail_metrics: [] + id: abc-123 + key: prod-rollout + name: Production Rollout + order_position: 0 + targeting_rules: [] + type: FEATURE_GATE + updated_at: 2024-01-01 00:00:00+00:00 + variant_weights: + - value: 50 + variant_id: abc-123 + id: abc-123 + type: allocations schema: $ref: "#/components/schemas/AllocationResponse" description: Accepted - Approval required for this change @@ -96564,6 +99865,10 @@ paths: "202": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListAllocationsResponse" description: Accepted - Approval required for this change @@ -96691,6 +99996,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: abc-123 + key: variant-abc123 + name: Variant ABC123 + value: "true" + id: abc-123 + type: feature-flags schema: $ref: "#/components/schemas/FeatureFlagResponse" description: OK @@ -96736,6 +100062,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: abc-123 + type: hamr_org_connections schema: $ref: "#/components/schemas/HamrOrgConnectionResponse" description: OK @@ -96797,6 +100137,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: abc-123 + type: hamr_org_connections schema: $ref: "#/components/schemas/HamrOrgConnectionResponse" description: OK @@ -96842,6 +100196,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 @@ -96917,6 +100282,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 @@ -96982,6 +100362,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: abc-123 + type: incidents_handles schema: $ref: "#/components/schemas/IncidentHandlesResponse" description: OK @@ -97040,6 +100433,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: abc-123 + type: incidents_handles schema: $ref: "#/components/schemas/IncidentHandleResponse" description: Created @@ -97098,6 +100504,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: abc-123 + type: incidents_handles schema: $ref: "#/components/schemas/IncidentHandleResponse" description: OK @@ -97123,6 +100542,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + analytics_dashboard_id: abc-123-def + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: incidents_global_settings schema: $ref: "#/components/schemas/GlobalIncidentSettingsResponse" description: OK @@ -97160,6 +100589,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + analytics_dashboard_id: abc-123-def + created: "2024-01-01T00:00:00+00:00" + modified: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: incidents_global_settings schema: $ref: "#/components/schemas/GlobalIncidentSettingsResponse" description: OK @@ -97187,6 +100626,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@company.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 @@ -97256,6 +100714,23 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + conditions: + - field: severity + values: + - SEV-1 + - SEV-2 + enabled: true + handles: + - "@team-email@example.com" + trigger: incident_created_trigger + visibility: organization + id: abc-123 + type: incident_notification_rules schema: $ref: "#/components/schemas/IncidentNotificationRule" description: Created @@ -97330,6 +100805,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@company.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 @@ -97404,6 +100898,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@company.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 @@ -97444,6 +100957,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 @@ -97499,6 +101025,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 @@ -97573,6 +101112,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 @@ -97631,6 +101183,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 @@ -97668,6 +101233,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: abc-123 + type: postmortem_template schema: $ref: "#/components/schemas/PostmortemTemplatesResponse" description: OK @@ -97705,6 +101280,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: abc-123 + type: postmortem_template schema: $ref: "#/components/schemas/PostmortemTemplateResponse" description: Created @@ -97778,6 +101363,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: abc-123 + type: postmortem_template schema: $ref: "#/components/schemas/PostmortemTemplateResponse" description: OK @@ -97829,6 +101424,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: abc-123 + type: postmortem_template schema: $ref: "#/components/schemas/PostmortemTemplateResponse" description: OK @@ -97862,6 +101467,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: abc-123 + type: incident_types schema: $ref: "#/components/schemas/IncidentTypeListResponse" description: OK @@ -97915,6 +101530,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: abc-123 + type: incident_types schema: $ref: "#/components/schemas/IncidentTypeResponse" description: CREATED @@ -97988,6 +101613,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: abc-123 + type: incident_types schema: $ref: "#/components/schemas/IncidentTypeResponse" description: OK @@ -98045,6 +101680,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: abc-123 + type: incident_types schema: $ref: "#/components/schemas/IncidentTypeResponse" description: OK @@ -98597,6 +102242,22 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + customer_impacted: false + 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 @@ -98641,6 +102302,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 @@ -98718,6 +102390,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 @@ -98800,6 +102487,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 @@ -98846,6 +102548,18 @@ 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 + type: incident_attachments schema: $ref: "#/components/schemas/AttachmentArray" description: OK @@ -98892,6 +102606,18 @@ 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 + type: incident_attachments schema: $ref: "#/components/schemas/Attachment" description: Created @@ -98955,6 +102681,18 @@ 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 + type: incident_attachments schema: $ref: "#/components/schemas/Attachment" description: Created @@ -99030,6 +102768,18 @@ 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 + type: incident_attachments schema: $ref: "#/components/schemas/Attachment" description: OK @@ -99067,6 +102817,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: abc-123 + type: incident_impacts schema: $ref: "#/components/schemas/IncidentImpactsResponse" description: OK @@ -99123,6 +102883,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: abc-123 + type: incident_impacts schema: $ref: "#/components/schemas/IncidentImpactResponse" description: CREATED @@ -99189,6 +102959,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + incident_id: 00000000-aaaa-0000-0000-000000000000 + integration_type: 1 + metadata: + channels: + - channel_id: C0123456789 + channel_name: "#example-channel-name" + redirect_url: "https://slack.com/app_redirect?channel=C0123456789&team=T01234567" + team_id: T01234567 + id: 00000000-0000-0000-1234-000000000000 + type: incident_integrations schema: $ref: "#/components/schemas/IncidentIntegrationMetadataListResponse" description: OK @@ -99247,6 +103032,21 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + incident_id: 00000000-aaaa-0000-0000-000000000000 + integration_type: 1 + metadata: + channels: + - channel_id: C0123456789 + channel_name: "#example-channel-name" + redirect_url: "https://slack.com/app_redirect?channel=C0123456789&team=T01234567" + team_id: T01234567 + id: 00000000-0000-0000-1234-000000000000 + type: incident_integrations schema: $ref: "#/components/schemas/IncidentIntegrationMetadataResponse" description: CREATED @@ -99318,6 +103118,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + incident_id: 00000000-aaaa-0000-0000-000000000000 + integration_type: 1 + metadata: + channels: + - channel_id: C0123456789 + channel_name: "#example-channel-name" + redirect_url: "https://slack.com/app_redirect?channel=C0123456789&team=T01234567" + team_id: T01234567 + id: 00000000-0000-0000-1234-000000000000 + type: incident_integrations schema: $ref: "#/components/schemas/IncidentIntegrationMetadataResponse" description: OK @@ -99373,6 +103188,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + incident_id: 00000000-aaaa-0000-0000-000000000000 + integration_type: 1 + metadata: + channels: + - channel_id: C0123456789 + channel_name: "#updated-channel-name" + redirect_url: "https://slack.com/app_redirect?channel=C0123456789&team=T01234567" + team_id: T01234567 + id: 00000000-0000-0000-1234-000000000000 + type: incident_integrations schema: $ref: "#/components/schemas/IncidentIntegrationMetadataResponse" description: OK @@ -99408,6 +103238,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + assignees: + - "@test.user@test.com" + content: Restore lost data. + id: abc-123 + type: incident_todos schema: $ref: "#/components/schemas/IncidentTodoListResponse" description: OK @@ -99464,6 +103304,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + assignees: + - "@test.user@test.com" + content: Restore lost data. + id: abc-123 + type: incident_todos schema: $ref: "#/components/schemas/IncidentTodoResponse" description: CREATED @@ -99538,6 +103388,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + assignees: + - "@test.user@test.com" + content: Restore lost data. + id: abc-123 + type: incident_todos schema: $ref: "#/components/schemas/IncidentTodoResponse" description: OK @@ -99595,6 +103455,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + assignees: + - "@test.user@test.com" + content: Restore lost data. + id: abc-123 + type: incident_todos schema: $ref: "#/components/schemas/IncidentTodoResponse" description: OK @@ -99642,6 +103512,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/AWSAccountsResponse" description: AWS Accounts List object @@ -99700,6 +103574,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + auth_config: + role_name: DatadogIntegrationRole + aws_account_id: "123456789012" + aws_partition: aws + id: abc-123 + type: account schema: $ref: "#/components/schemas/AWSAccountResponse" description: AWS Account object @@ -99752,6 +103637,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + auth_config: + role_name: DatadogIntegrationRole + aws_account_id: "123456789012" + aws_partition: aws + id: abc-123 + type: account schema: $ref: "#/components/schemas/AWSAccountResponse" description: AWS Account object @@ -99817,6 +103713,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + auth_config: + role_name: DatadogIntegrationRole + aws_account_id: "123456789012" + aws_partition: aws + id: abc-123 + type: account schema: $ref: "#/components/schemas/AWSAccountResponse" description: AWS Account object @@ -99874,6 +103781,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: abc-123 + type: ccm_config schema: $ref: "#/components/schemas/AWSCcmConfigResponse" description: AWS CCM Config object @@ -99924,6 +103844,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: abc-123 + type: ccm_config schema: $ref: "#/components/schemas/AWSCcmConfigResponse" description: AWS CCM Config object @@ -99975,6 +103908,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: abc-123 + type: ccm_config schema: $ref: "#/components/schemas/AWSCcmConfigResponse" description: AWS CCM Config object @@ -100005,6 +103951,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 @@ -100043,6 +103998,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. @@ -100067,6 +104030,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. @@ -100107,6 +104079,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. @@ -100134,6 +104117,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 @@ -100156,6 +104147,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 @@ -100172,6 +104172,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. @@ -100188,6 +104197,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. @@ -100204,6 +104222,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 @@ -100226,6 +104253,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + automute: true + client_email: datadog-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 @@ -100285,6 +104323,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + automute: true + client_email: datadog-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 @@ -100373,6 +104422,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + automute: true + client_email: datadog-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 @@ -100400,6 +104460,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 @@ -100433,6 +104501,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 @@ -100461,6 +104537,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + display_name: General + organization_binding_id: abc-123 + resource_name: spaces/AAAAAAAAA + space_uri: https://chat.google.com/room/AAAAAAAAA + id: abc-123 + type: google-chat-app-named-space schema: $ref: "#/components/schemas/GoogleChatAppNamedSpaceResponse" description: OK @@ -100485,6 +104572,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: example-handle + space_display_name: General + space_resource_name: spaces/AAAAAAAAA + id: abc-123 + type: google-chat-organization-handle schema: $ref: "#/components/schemas/GoogleChatOrganizationHandlesResponse" description: OK @@ -100523,6 +104620,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: example-handle + space_display_name: General + space_resource_name: spaces/AAAAAAAAA + id: abc-123 + type: google-chat-organization-handle schema: $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse" description: CREATED @@ -100579,6 +104686,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: example-handle + space_display_name: General + space_resource_name: spaces/AAAAAAAAA + id: abc-123 + type: google-chat-organization-handle schema: $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse" description: OK @@ -100618,6 +104735,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: example-handle + space_display_name: General + space_resource_name: spaces/AAAAAAAAA + id: abc-123 + type: google-chat-organization-handle schema: $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse" description: OK @@ -100644,6 +104771,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 @@ -100701,6 +104839,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 @@ -100741,6 +104893,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 @@ -100800,6 +104966,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 @@ -100851,6 +105031,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 @@ -100880,6 +105074,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 @@ -100905,6 +105109,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: abc-123 + type: ms-teams-tenant-based-handle-info schema: $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandlesResponse" description: OK @@ -100945,6 +105160,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: abc-123 + type: tenant-based-handle schema: $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse" description: CREATED @@ -100993,6 +105219,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: abc-123 + type: tenant-based-handle schema: $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse" description: OK @@ -101035,6 +105272,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: abc-123 + type: tenant-based-handle schema: $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse" description: OK @@ -101064,6 +105312,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: fake-handle-name + id: abc-123 + type: workflows-webhook-handle schema: $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandlesResponse" description: OK @@ -101102,6 +105358,14 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: fake-handle-name + id: abc-123 + type: workflows-webhook-handle schema: $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse" description: CREATED @@ -101150,6 +105414,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: fake-handle-name + id: abc-123 + type: workflows-webhook-handle schema: $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse" description: OK @@ -101190,6 +105462,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: fake-handle-name-updated + id: abc-123 + type: workflows-webhook-handle schema: $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse" description: OK @@ -101225,6 +105505,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 @@ -101245,6 +105535,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 @@ -101311,6 +105612,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 @@ -101361,6 +105673,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 @@ -101431,6 +105754,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 @@ -101450,6 +105784,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + custom_url: + name: fake-opsgenie-service-name + region: us + id: abc-123 + type: opsgenie-service schema: $ref: "#/components/schemas/OpsgenieServicesResponse" description: OK @@ -101488,6 +105832,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + custom_url: https://example.com + name: fake-opsgenie-service-name + region: us + id: abc-123 + type: opsgenie-service schema: $ref: "#/components/schemas/OpsgenieServiceResponse" description: CREATED @@ -101540,6 +105894,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + custom_url: + name: fake-opsgenie-service-name + region: us + id: abc-123 + type: opsgenie-service schema: $ref: "#/components/schemas/OpsgenieServiceResponse" description: OK @@ -101587,6 +105951,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + custom_url: https://example.com + name: fake-opsgenie-service-name + region: us + id: abc-123 + type: opsgenie-service schema: $ref: "#/components/schemas/OpsgenieServiceResponse" description: OK @@ -101626,6 +106000,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 @@ -101664,6 +106048,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 @@ -101693,6 +106087,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 @@ -101730,6 +106134,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 @@ -101795,6 +106209,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 @@ -101853,6 +106277,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 @@ -101882,6 +106316,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 @@ -101914,6 +106356,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: abc-123 + id: 00000000-0000-0000-0000-000000000001 + type: users schema: $ref: "#/components/schemas/ServiceNowUsersResponse" description: OK @@ -101941,6 +106395,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. @@ -101960,6 +106426,15 @@ paths: "200": 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/CloudflareAccountsResponse" description: OK @@ -102008,6 +106483,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 @@ -102070,6 +106554,15 @@ paths: "200": 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: OK @@ -102124,6 +106617,15 @@ paths: "200": 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: OK @@ -102151,6 +106653,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + api_key: ACCESS_KEY_ID + tags: + - myTag + id: abc-123 + type: confluent-cloud-accounts schema: $ref: "#/components/schemas/ConfluentAccountsResponse" description: OK @@ -102201,6 +106713,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + api_key: ACCESS_KEY_ID + tags: + - myTag + id: abc-123 + type: confluent-cloud-accounts schema: $ref: "#/components/schemas/ConfluentAccountResponse" description: OK @@ -102253,6 +106775,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + api_key: ACCESS_KEY_ID + tags: + - myTag + id: abc-123 + type: confluent-cloud-accounts schema: $ref: "#/components/schemas/ConfluentAccountResponse" description: OK @@ -102298,6 +106830,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + api_key: ACCESS_KEY_ID + tags: + - myTag + id: abc-123 + type: confluent-cloud-accounts schema: $ref: "#/components/schemas/ConfluentAccountResponse" description: OK @@ -102327,6 +106869,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 @@ -102373,6 +106926,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 @@ -102427,6 +106991,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 @@ -102474,6 +107049,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 @@ -102501,6 +107087,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 @@ -102545,6 +107140,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 @@ -102597,6 +107201,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 @@ -102637,6 +107250,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 @@ -102666,6 +107288,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 @@ -102709,6 +107340,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 @@ -102763,6 +107403,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 @@ -102807,6 +107456,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 @@ -102834,6 +107492,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + auth_method: oauth + domain: "https://example.okta.com/" + name: Okta-Prod + id: abc-123 + type: okta-accounts schema: $ref: "#/components/schemas/OktaAccountsResponse" description: OK @@ -102877,6 +107545,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + auth_method: oauth + domain: "https://example.okta.com/" + name: Okta-Prod + id: abc-123 + type: okta-accounts schema: $ref: "#/components/schemas/OktaAccountResponse" description: OK @@ -102939,6 +107617,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + auth_method: oauth + domain: "https://example.okta.com/" + name: Okta-Prod + id: abc-123 + type: okta-accounts schema: $ref: "#/components/schemas/OktaAccountResponse" description: OK @@ -102985,6 +107673,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + auth_method: oauth + domain: "https://example.okta.com/" + name: Okta-Prod + id: abc-123 + type: okta-accounts schema: $ref: "#/components/schemas/OktaAccountResponse" description: OK @@ -103012,6 +107710,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: abc-123 + type: ip_allowlist_entry + id: abc-123 + type: ip_allowlist schema: $ref: "#/components/schemas/IPAllowlistResponse" description: OK @@ -103058,6 +107771,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: abc-123 + type: ip_allowlist_entry + id: abc-123 + type: ip_allowlist schema: $ref: "#/components/schemas/IPAllowlistResponse" description: OK @@ -103105,6 +107833,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: abc-123 + description: Queue for annotating customer support traces + modified_at: "2024-01-01T00:00:00+00:00" + modified_by: abc-123 + name: My annotation queue + owned_by: abc-123 + project_id: abc-123 + id: abc-123 + type: queues schema: $ref: "#/components/schemas/LLMObsAnnotationQueuesResponse" description: OK @@ -103162,6 +107905,21 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: abc-123 + description: Queue for annotating customer support traces + modified_at: "2024-01-01T00:00:00+00:00" + modified_by: abc-123 + name: My annotation queue + owned_by: abc-123 + project_id: abc-123 + id: abc-123 + type: queues schema: $ref: "#/components/schemas/LLMObsAnnotationQueueResponse" description: Created @@ -103257,6 +108015,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00+00:00" + created_by: abc-123 + description: Queue for annotating customer support traces + modified_at: "2024-01-01T00:00:00+00:00" + modified_by: abc-123 + name: My annotation queue + owned_by: abc-123 + project_id: abc-123 + id: abc-123 + type: queues schema: $ref: "#/components/schemas/LLMObsAnnotationQueueResponse" description: OK @@ -103305,6 +108078,26 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + annotated_interactions: + - annotations: + - created_at: "2024-01-01T00:00:00+00:00" + created_by: abc-123 + id: annotation-789 + interaction_id: interaction-456 + label_values: + quality: good + modified_at: "2024-01-01T00:00:00+00:00" + modified_by: abc-123 + content_id: trace-abc-123 + id: interaction-456 + type: trace + id: abc-123 + type: annotated_interactions schema: $ref: "#/components/schemas/LLMObsAnnotatedInteractionsResponse" description: OK @@ -103371,6 +108164,18 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + interactions: + - already_existed: false + content_id: trace-abc-123 + id: abc-123 + type: trace + id: abc-123 + type: interactions schema: $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsResponse" description: Created @@ -103504,6 +108309,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + config: + created_at: "2024-01-01T00:00:00+00:00" + dataset_id: abc-123 + description: "" + metadata: + name: My Experiment v1 + project_id: abc-123 + updated_at: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: experiments schema: $ref: "#/components/schemas/LLMObsExperimentsResponse" description: OK @@ -103559,12 +108379,42 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + config: + created_at: "2024-01-01T00:00:00+00:00" + dataset_id: abc-123 + description: "" + metadata: + name: My Experiment v1 + project_id: abc-123 + updated_at: "2024-01-01T00:00:00+00:00" + id: abc-123 + 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: abc-123 + description: "" + metadata: + name: My Experiment v1 + project_id: abc-123 + updated_at: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: experiments schema: $ref: "#/components/schemas/LLMObsExperimentResponse" description: Created @@ -103670,6 +108520,21 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + config: + created_at: "2024-01-01T00:00:00+00:00" + dataset_id: abc-123 + description: "" + metadata: + name: My Experiment v1 + project_id: abc-123 + updated_at: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: experiments schema: $ref: "#/components/schemas/LLMObsExperimentResponse" description: OK @@ -103810,6 +108675,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: abc-123 + type: projects schema: $ref: "#/components/schemas/LLMObsProjectsResponse" description: OK @@ -103863,12 +108739,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: abc-123 + 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: abc-123 + type: projects schema: $ref: "#/components/schemas/LLMObsProjectResponse" description: Created @@ -103974,6 +108872,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: abc-123 + type: projects schema: $ref: "#/components/schemas/LLMObsProjectResponse" description: OK @@ -104043,6 +108952,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: abc-123 + type: datasets schema: $ref: "#/components/schemas/LLMObsDatasetsResponse" description: OK @@ -104104,12 +109026,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: abc-123 + 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: abc-123 + type: datasets schema: $ref: "#/components/schemas/LLMObsDatasetResponse" description: Created @@ -104230,6 +109178,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: abc-123 + type: datasets schema: $ref: "#/components/schemas/LLMObsDatasetResponse" description: OK @@ -104296,6 +109257,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - created_at: "2024-01-01T00:00:00+00:00" + dataset_id: abc-123 + expected_output: "Paris" + id: abc-123 + input: "What is the capital of France?" + metadata: + updated_at: "2024-01-01T00:00:00+00:00" schema: $ref: "#/components/schemas/LLMObsDatasetRecordsListResponse" description: OK @@ -104359,6 +109331,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - records: + - created_at: "2024-01-01T00:00:00+00:00" + dataset_id: abc-123 + expected_output: "Paris" + id: abc-123 + input: "What is the capital of France?" + metadata: + updated_at: "2024-01-01T00:00:00+00:00" schema: $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse" description: OK @@ -104419,12 +109403,36 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - records: + - created_at: "2024-01-01T00:00:00+00:00" + dataset_id: abc-123 + expected_output: "Paris" + id: abc-123 + input: "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: abc-123 + expected_output: "Paris" + id: abc-123 + input: "What is the capital of France?" + metadata: + updated_at: "2024-01-01T00:00:00+00:00" schema: $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse" description: Created @@ -104648,6 +109656,9 @@ paths: "202": content: application/json: + examples: + default: + value: {} schema: type: object description: Request accepted for processing (always 202 empty JSON). @@ -104783,6 +109794,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 @@ -104809,6 +109832,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 @@ -104856,6 +109889,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 @@ -104896,6 +109939,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + include_tags: false + name: Nginx Archive + query: source:nginx + state: WORKING + id: abc-123 + type: archives schema: $ref: "#/components/schemas/LogsArchives" description: OK @@ -104945,6 +109999,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + include_tags: false + name: Nginx Archive + query: source:nginx + state: WORKING + id: abc-123 + type: archives schema: $ref: "#/components/schemas/LogsArchive" description: OK @@ -105017,6 +110082,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + include_tags: false + name: Nginx Archive + query: source:nginx + state: WORKING + id: abc-123 + type: archives schema: $ref: "#/components/schemas/LogsArchive" description: OK @@ -105084,6 +110160,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + include_tags: false + name: Nginx Archive + query: source:nginx + state: WORKING + id: abc-123 + type: archives schema: $ref: "#/components/schemas/LogsArchive" description: OK @@ -105173,6 +110260,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: Example Role + id: abc-123 + type: roles schema: $ref: "#/components/schemas/RolesResponse" description: OK @@ -105260,6 +110355,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: abc-123 + type: custom_destination schema: $ref: "#/components/schemas/CustomDestinationsResponse" description: OK @@ -105310,6 +110425,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: abc-123 + type: custom_destination schema: $ref: "#/components/schemas/CustomDestinationResponse" description: OK @@ -105362,6 +110497,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: abc-123 + type: custom_destination schema: $ref: "#/components/schemas/CustomDestinationResponse" description: OK @@ -105415,6 +110570,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: abc-123 + type: custom_destination schema: $ref: "#/components/schemas/CustomDestinationResponse" description: OK @@ -105444,6 +110619,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 @@ -105490,6 +110681,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 @@ -105540,6 +110747,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 @@ -105587,6 +110810,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 @@ -105617,6 +110856,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: abc-123 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryListResponse" description: OK @@ -105658,6 +110907,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + restriction_query: "env:sandbox" + id: abc-123 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse" description: OK @@ -105696,6 +110953,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: abc-123 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryListResponse" description: OK @@ -105739,6 +111006,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: abc-123 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryListResponse" description: OK @@ -105821,6 +111098,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + restriction_query: "env:sandbox" + id: abc-123 + relationships: {} + type: logs_restriction_queries + included: [] schema: $ref: "#/components/schemas/RestrictionQueryWithRelationshipsResponse" description: OK @@ -105878,6 +111165,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + restriction_query: "env:sandbox" + id: abc-123 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse" description: OK @@ -105935,6 +111230,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + restriction_query: "env:sandbox" + id: abc-123 + type: logs_restriction_queries schema: $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse" description: OK @@ -106032,6 +111335,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: Datadog Admin Role + id: abc-123 + type: roles schema: $ref: "#/components/schemas/RestrictionQueryRolesResponse" description: OK @@ -106207,6 +111518,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 @@ -106269,6 +111595,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 @@ -106393,6 +111732,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] + meta: + pagination: + next_cursor: schema: $ref: "#/components/schemas/MetricsAndMetricTagConfigurationsResponse" description: Success @@ -106459,6 +111805,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 @@ -106528,6 +111884,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 @@ -106584,6 +111951,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + active_aggregations: + - avg:hour + active_tags: + - app + id: http.endpoint.request + type: metric_active_configurations schema: $ref: "#/components/schemas/MetricSuggestedTagsAndAggregationsResponse" description: Success @@ -106687,6 +112065,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 @@ -106736,6 +112124,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: http.endpoint.request + relationships: + dashboards: + data: [] + monitors: + data: [] + notebooks: + data: [] + type: metric_asset schema: $ref: "#/components/schemas/MetricAssetsResponse" description: Success @@ -106822,6 +112223,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 @@ -106865,6 +112276,11 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] + meta: {} schema: $ref: "#/components/schemas/MetricTagCardinalitiesResponse" description: Success @@ -106945,6 +112361,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 @@ -107009,6 +112436,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 @@ -107076,6 +112514,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 @@ -107124,6 +112573,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 @@ -107211,6 +112669,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + filter: + tags: + - 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 @@ -107262,6 +112733,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + filter: + tags: + - 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 @@ -107344,6 +112828,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + filter: + tags: + - 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 @@ -107409,6 +112906,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + created: "2024-01-01T00:00:00+00:00" + filter: + tags: + - team:product + - 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 @@ -107448,6 +112962,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 @@ -107498,6 +113026,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 @@ -107580,6 +113122,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 @@ -107645,6 +113201,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 @@ -107684,6 +113254,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 @@ -107741,6 +113331,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 @@ -107871,6 +113481,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 @@ -107942,6 +113572,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 @@ -108065,6 +113715,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 @@ -108119,6 +113784,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: example:1.2.3.4 + type: device + meta: + page: + total_filtered_count: 1 schema: $ref: "#/components/schemas/ListDevicesResponse" description: OK @@ -108151,6 +113831,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: example:1.2.3.4 + type: device schema: $ref: "#/components/schemas/GetDeviceResponse" description: OK @@ -108186,6 +113880,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + description: a network interface + index: 0 + mac_address: 00:00:00:00:00:00 + name: if0 + status: up + id: example:1.2.3.4:99 + type: interface schema: $ref: "#/components/schemas/GetInterfacesResponse" description: OK @@ -108212,6 +113918,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - "tag:test" + - "tag:testbis" + id: example:1.2.3.4 + type: tags schema: $ref: "#/components/schemas/ListTagsResponse" description: OK @@ -108255,6 +113971,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - "tag:test" + - "tag:testbis" + id: example:1.2.3.4 + type: tags schema: $ref: "#/components/schemas/ListTagsResponse" description: OK @@ -108283,6 +114009,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - "tag:test" + - "tag:testbis" + id: example:1.2.3.4:1 + type: tags schema: $ref: "#/components/schemas/ListInterfaceTagsResponse" description: OK @@ -108326,6 +114062,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + tags: + - "tag:test" + - "tag:testbis" + id: example:1.2.3.4:1 + type: tags schema: $ref: "#/components/schemas/ListInterfaceTagsResponse" description: OK @@ -108378,6 +114124,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 @@ -108428,6 +114185,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 @@ -108449,6 +114221,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: abc-123 + type: pipelines schema: $ref: "#/components/schemas/ListPipelinesResponse" description: OK @@ -108512,6 +114301,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: abc-123 + type: pipelines schema: $ref: "#/components/schemas/ObservabilityPipeline" description: OK @@ -108580,6 +114386,10 @@ paths: "200": content: application/json: + examples: + default: + value: + errors: [] schema: $ref: "#/components/schemas/ValidationResponse" description: OK @@ -108651,6 +114461,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: abc-123 + type: pipelines schema: $ref: "#/components/schemas/ObservabilityPipeline" description: OK @@ -108724,6 +114551,23 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + destinations: + - id: datadog-logs-destination + inputs: + - datadog-agent-source + type: datadog_logs + name: My Updated Pipeline + processors: [] + sources: + - id: datadog-agent-source + type: datadog_agent + id: abc-123 + type: pipelines schema: $ref: "#/components/schemas/ObservabilityPipeline" description: OK @@ -108798,6 +114642,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 @@ -108874,6 +114737,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 @@ -108948,6 +114830,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 @@ -109001,6 +114902,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: pages schema: $ref: "#/components/schemas/CreatePageResponse" description: OK. @@ -109255,6 +115162,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 @@ -109331,6 +115256,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 @@ -109408,6 +115351,24 @@ paths: "200": content: "application/json": + examples: + default: + value: + data: + attributes: + name: On-Call Schedule + time_zone: America/New_York + id: abc-123 + relationships: + layers: + data: + - id: abc-123 + type: layers + teams: + data: + - id: abc-123 + type: teams + type: schedules schema: $ref: "#/components/schemas/Schedule" description: OK @@ -109459,6 +115420,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 @@ -109504,6 +115479,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 @@ -109549,6 +115539,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 @@ -109622,6 +115618,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: team_routing_rules schema: $ref: "#/components/schemas/TeamRoutingRules" description: OK @@ -109654,6 +115656,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 @@ -109710,6 +115724,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 @@ -109799,6 +115825,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 @@ -109844,6 +115882,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 @@ -109905,6 +115955,23 @@ paths: "201": content: "application/json": + examples: + default: + value: + data: + attributes: + category: high_urgency + channel_settings: + method: sms + type: phone + delay_minutes: 1 + id: abc-123 + relationships: + channel: + data: + id: abc-123 + type: notification_channels + type: notification_rules schema: $ref: "#/components/schemas/OnCallNotificationRule" description: Created @@ -109999,6 +116066,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 @@ -110073,6 +116157,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 @@ -110105,6 +116206,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"} @@ -110125,6 +116237,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"} @@ -110157,6 +116280,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"} @@ -110209,6 +116343,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + connection_types: + - logs + created_at: "2024-01-01T00:00:00+00:00" + id: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a + type: org_connection schema: $ref: "#/components/schemas/OrgConnectionListResponse" description: OK @@ -110256,6 +116400,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: org_connection schema: $ref: "#/components/schemas/OrgConnectionResponse" description: OK @@ -110338,6 +116488,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 @@ -111717,6 +117878,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: abc-123 + type: permissions schema: $ref: "#/components/schemas/PermissionsResponse" description: OK @@ -111760,6 +117933,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: abc-123 + type: personal_access_tokens + meta: + page: + total_filtered_count: 1 schema: $ref: "#/components/schemas/ListPersonalAccessTokensResponse" description: OK @@ -111809,6 +117997,21 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + alias: "2H9MCNMBM8FQjQ16YucXkX" + 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: abc-123 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenCreateResponse" description: Created @@ -111874,6 +118077,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: abc-123 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenResponse" description: OK @@ -111925,6 +118140,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: abc-123 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenResponse" description: OK @@ -112121,6 +118348,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: open + id: abc-123-xyz + type: finding + meta: + page: + cursor: "eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0=" + total_filtered_count: 1 + snapshot_timestamp: 1678721573794 schema: $ref: "#/components/schemas/ListFindingsResponse" description: OK @@ -112189,6 +118432,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: finding schema: $ref: "#/components/schemas/BulkMuteFindingsResponse" description: OK @@ -112246,6 +118495,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 @@ -112290,6 +118551,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: abc-123 + type: powerpack schema: $ref: "#/components/schemas/ListPowerpacksResponse" description: OK @@ -112365,6 +118650,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: powerpack schema: $ref: "#/components/schemas/PowerpackResponse" description: OK @@ -112437,6 +118728,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: abc-123 + type: powerpack schema: $ref: "#/components/schemas/PowerpackResponse" description: OK @@ -112521,6 +118836,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: abc-123 + type: powerpack schema: $ref: "#/components/schemas/PowerpackResponse" description: OK @@ -112611,6 +118950,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 @@ -112743,6 +119092,9 @@ paths: "202": content: application/json: + examples: + default: + value: {} schema: type: object description: Request accepted for processing (always 202 empty JSON). @@ -112856,6 +119208,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 @@ -112905,6 +119268,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 @@ -112949,6 +119325,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 @@ -112998,6 +119382,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 @@ -113053,6 +119446,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 @@ -113093,6 +119499,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 @@ -113142,6 +119559,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 @@ -113171,6 +119599,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 @@ -113338,6 +119774,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 @@ -113384,6 +119828,13 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + columns: [] + type: scalar_response schema: $ref: "#/components/schemas/ScalarFormulaQueryResponse" description: OK @@ -113440,6 +119891,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + series: [] + times: [] + values: [] + type: timeseries_response schema: $ref: "#/components/schemas/TimeseriesFormulaQueryResponse" description: OK @@ -113498,6 +119958,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. @@ -113580,6 +120053,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 @@ -113691,6 +120173,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 @@ -113748,6 +120239,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 @@ -113893,6 +120412,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. @@ -113999,6 +120528,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 @@ -114023,6 +120561,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: abc-123 + type: custom_rule schema: $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleListResponse" description: OK @@ -114074,6 +120633,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: abc-123 + type: custom_rule schema: $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse" description: Created @@ -114119,6 +120699,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: abc-123 + type: custom_rule schema: $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse" description: OK @@ -114179,6 +120780,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: abc-123 + type: custom_rule schema: $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse" description: OK @@ -114205,6 +120827,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: abc-123 + type: exclusion_filter schema: $ref: "#/components/schemas/ApplicationSecurityWafExclusionFiltersResponse" description: OK @@ -114260,6 +120896,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: abc-123 + type: exclusion_filter schema: $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse" description: OK @@ -114314,6 +120964,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: abc-123 + type: exclusion_filter schema: $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse" description: OK @@ -114371,6 +121035,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: abc-123 + type: exclusion_filter schema: $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse" description: OK @@ -114406,6 +121084,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 @@ -114444,6 +121133,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 @@ -114492,6 +121192,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 @@ -114536,6 +121247,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 @@ -114563,6 +121285,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 @@ -114600,6 +121332,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 @@ -114627,6 +121369,9 @@ paths: "200": content: application/zip: + examples: + default: + value: "" schema: format: binary type: string @@ -114671,6 +121416,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 @@ -114712,6 +121467,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 @@ -114762,6 +121527,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 @@ -114800,6 +121576,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 @@ -114867,6 +121654,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 @@ -114913,6 +121711,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 @@ -115023,6 +121832,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 @@ -115075,6 +121895,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: developers + id: abc-123 + type: roles + meta: + page: + total_count: 1 + total_filtered_count: 1 schema: $ref: "#/components/schemas/RolesResponse" description: OK @@ -115118,6 +121950,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: developers + id: abc-123 + type: roles schema: $ref: "#/components/schemas/RoleCreateResponse" description: OK @@ -115156,6 +121996,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: Datadog Standard Role + id: abc-123 + type: roles schema: $ref: "#/components/schemas/RoleTemplateArray" description: OK @@ -115211,6 +122059,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: developers + id: abc-123 + type: roles schema: $ref: "#/components/schemas/RoleResponse" description: OK @@ -115261,6 +122117,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: developers + id: abc-123 + type: roles schema: $ref: "#/components/schemas/RoleUpdateResponse" description: OK @@ -115326,6 +122190,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: developers + id: abc-123 + type: roles schema: $ref: "#/components/schemas/RoleResponse" description: OK @@ -115390,6 +122262,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: logs_read_data + id: abc-123 + type: permissions schema: $ref: "#/components/schemas/PermissionsResponse" description: OK @@ -115435,6 +122315,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: logs_read_data + id: abc-123 + type: permissions schema: $ref: "#/components/schemas/PermissionsResponse" description: OK @@ -115482,6 +122370,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: logs_read_data + id: abc-123 + type: permissions schema: $ref: "#/components/schemas/PermissionsResponse" description: OK @@ -115540,6 +122436,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: test@example.com + name: Example Name + id: abc-123 + type: users schema: $ref: "#/components/schemas/UsersResponse" description: OK @@ -115603,6 +122508,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: test@example.com + name: Example Name + id: abc-123 + type: users schema: $ref: "#/components/schemas/UsersResponse" description: OK @@ -115649,6 +122563,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: test@example.com + name: Example Name + id: abc-123 + type: users schema: $ref: "#/components/schemas/UsersResponse" description: OK @@ -115726,6 +122649,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 @@ -115750,6 +122687,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 @@ -115786,6 +122738,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + application_id: abc-123 + client_token: abcd1234efgh5678ijkl90abcd1234efgh0 + 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 @@ -115825,6 +122793,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 @@ -115848,6 +122822,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 @@ -115890,6 +122879,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: abc-123 + type: retention_filters schema: $ref: "#/components/schemas/RumRetentionFilterResponse" description: Created @@ -115932,6 +122933,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 @@ -115978,6 +122994,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 @@ -116031,6 +123062,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + application_id: abc-123 + client_token: abcd1234efgh5678ijkl90abcd1234efgh0 + 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 @@ -116075,6 +123122,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + application_id: abc-123 + client_token: abcd1234efgh5678ijkl90abcd1234efgh0 + 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 @@ -116105,6 +123168,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 @@ -116150,6 +123232,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 @@ -116192,6 +123293,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 @@ -116236,6 +123356,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 @@ -116315,6 +123454,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 @@ -116368,6 +123516,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 @@ -116422,6 +123583,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 @@ -116458,6 +123627,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 @@ -116509,6 +123686,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 @@ -116553,6 +123738,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 @@ -116628,6 +123821,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 @@ -116707,12 +123908,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 @@ -116809,6 +124026,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 @@ -116875,6 +124102,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 @@ -116940,6 +124177,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_viewership_history_session schema: $ref: "#/components/schemas/ViewershipHistorySessionArray" description: OK @@ -118051,6 +125296,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: abc-123 + type: seat-users schema: $ref: "#/components/schemas/SeatUserDataArray" description: OK @@ -118096,6 +125351,16 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + assigned_ids: + - abc-123 + product_code: example-product + id: abc-123 + type: seat-assignments schema: $ref: "#/components/schemas/AssignSeatsUserResponse" description: Created @@ -118197,6 +125462,34 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + configRisks: + hasIdentityRisk: false + hasMisconfiguration: true + isPubliclyAccessible: true + entityID: "arn:aws:iam::123456789012:user/test-user" + entityMetadata: {} + entityName: test-user + entityProviders: + - aws + entityRoles: [] + entityType: aws_iam_user + firstDetected: 1704067200000 + lastActivityTitle: "Suspicious API call detected" + lastDetected: 1705276800000 + riskScore: 85.5 + riskScoreEvolution: 12.3 + 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 @@ -118239,6 +125532,9 @@ paths: "200": content: application/yaml: + examples: + default: + value: "" schema: format: binary type: string @@ -118301,6 +125597,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 @@ -118407,6 +125719,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: abc-123 + type: cases schema: $ref: "#/components/schemas/FindingCaseResponseArray" description: Created @@ -118463,6 +125788,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: abc-123 + type: cases schema: $ref: "#/components/schemas/FindingCaseResponse" description: OK @@ -118517,6 +125855,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: abc-123 + type: cases schema: $ref: "#/components/schemas/FindingCaseResponse" description: OK @@ -118575,6 +125926,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: abc-123 + type: cases schema: $ref: "#/components/schemas/FindingCaseResponseArray" description: Created @@ -118628,6 +125992,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 @@ -118736,6 +126116,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListAssetsSBOMsResponse" description: OK @@ -118807,6 +126191,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + components: + - name: google.golang.org/grpc + type: library + version: 1.68.1 + id: "github.com/datadog/datadog-agent" + type: sboms schema: $ref: "#/components/schemas/GetSBOMResponse" description: OK @@ -118937,6 +126332,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 @@ -119021,6 +126428,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 @@ -119056,6 +126479,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 @@ -119133,6 +126568,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. @@ -119197,6 +126659,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. @@ -119259,6 +126748,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. @@ -119694,6 +127210,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListVulnerabilitiesResponse" description: OK @@ -119786,6 +127306,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. @@ -119850,6 +127398,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. @@ -119912,6 +127488,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. @@ -120079,6 +127683,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ListVulnerableAssetsResponse" description: OK @@ -120126,6 +127734,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 @@ -120166,6 +127785,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 @@ -120220,6 +127850,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 @@ -120265,6 +127906,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 @@ -120293,6 +127945,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 @@ -120335,6 +127999,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 @@ -120365,6 +128041,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 @@ -120414,6 +128102,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 @@ -120461,6 +128161,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 @@ -120490,6 +128202,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 @@ -120539,6 +128267,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 @@ -120601,6 +128345,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 @@ -120651,6 +128411,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 @@ -120707,6 +128483,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 @@ -120753,6 +128547,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 @@ -120836,6 +128641,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 @@ -120863,6 +128679,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 @@ -120960,6 +128789,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 @@ -121010,6 +128852,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 @@ -121043,6 +128898,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 @@ -121070,6 +128941,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 @@ -121222,6 +129109,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 @@ -121284,6 +129180,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 @@ -121332,6 +129242,9 @@ paths: "200": content: application/zip: + examples: + default: + value: "" schema: format: binary type: string @@ -121436,6 +129349,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 @@ -121541,6 +129459,11 @@ paths: "200": content: "application/json": + examples: + default: + value: + results: + - true schema: $ref: "#/components/schemas/SecurityMonitoringRuleTestResponse" description: OK @@ -121695,6 +129618,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 @@ -121755,6 +129692,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 @@ -121797,6 +129748,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 @@ -121877,6 +129833,11 @@ paths: "200": content: "application/json": + examples: + default: + value: + results: + - true schema: $ref: "#/components/schemas/SecurityMonitoringRuleTestResponse" description: OK @@ -121914,6 +129875,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 @@ -121951,6 +129921,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 @@ -122001,6 +129985,16 @@ paths: "200": content: application/json: + examples: + default: + value: + result: + count: 1 + events: + - event: {} + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + status: done + type: status schema: $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse" description: OK @@ -122051,6 +130045,16 @@ paths: "200": content: application/json: + examples: + default: + value: + result: + count: 1 + events: + - event: {} + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + status: done + type: status schema: $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse" description: OK @@ -122101,6 +130105,16 @@ paths: "200": content: application/json: + examples: + default: + value: + result: + count: 1 + events: + - event: {} + id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + status: done + type: status schema: $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse" description: OK @@ -122157,6 +130171,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 @@ -122193,6 +130221,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 @@ -122238,6 +130275,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 @@ -122285,6 +130333,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 @@ -122381,6 +130440,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 @@ -122477,6 +130547,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 @@ -122540,6 +130621,9 @@ paths: "200": content: application/zip: + examples: + default: + value: "" schema: format: binary type: string @@ -122601,6 +130685,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 @@ -122641,6 +130735,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 @@ -122674,6 +130778,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + relationships: + groups: + data: [] + type: sensitive_data_scanner_configuration + included: [] + meta: + version: 0 schema: $ref: "#/components/schemas/SensitiveDataScannerGetConfigResponse" description: OK @@ -122723,6 +130839,11 @@ paths: "200": content: application/json: + examples: + default: + value: + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerReorderGroupsResponse" description: OK @@ -122787,6 +130908,14 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: sensitive_data_scanner_group + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerCreateGroupResponse" description: OK @@ -122833,6 +130962,11 @@ paths: "200": content: application/json: + examples: + default: + value: + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerGroupDeleteResponse" description: OK @@ -122899,6 +131033,11 @@ paths: "200": content: application/json: + examples: + default: + value: + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerGroupUpdateResponse" description: OK @@ -122985,6 +131124,14 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: sensitive_data_scanner_rule + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerCreateRuleResponse" description: OK @@ -123031,6 +131178,11 @@ paths: "200": content: application/json: + examples: + default: + value: + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerRuleDeleteResponse" description: OK @@ -123117,6 +131269,11 @@ paths: "200": content: application/json: + examples: + default: + value: + meta: + version: 1 schema: $ref: "#/components/schemas/SensitiveDataScannerRuleUpdateResponse" description: OK @@ -123152,6 +131309,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: Credit Card Number + priority: 1 + id: abc-123 + type: sensitive_data_scanner_standard_pattern schema: $ref: "#/components/schemas/SensitiveDataScannerStandardPatternsResponseData" description: OK @@ -123227,6 +131393,10 @@ paths: "202": content: application/json: + examples: + default: + value: + errors: [] schema: $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted @@ -123288,6 +131458,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + service_account: true + id: abc-123 + type: users schema: $ref: "#/components/schemas/UserResponse" description: OK @@ -123327,6 +131506,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: abc-123 + type: personal_access_tokens + meta: + page: + total_filtered_count: 1 schema: $ref: "#/components/schemas/ListPersonalAccessTokensResponse" description: OK @@ -123382,6 +131576,21 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + alias: "2H9MCNMBM8FQjQ16YucXkX" + 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: abc-123 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenCreateResponse" description: Created @@ -123454,6 +131663,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: abc-123 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenResponse" description: OK @@ -123505,6 +131726,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: abc-123 + type: personal_access_tokens schema: $ref: "#/components/schemas/PersonalAccessTokenResponse" description: OK @@ -123552,6 +131785,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: abc-123 + type: application_keys schema: $ref: "#/components/schemas/ListApplicationKeysResponse" description: OK @@ -123608,6 +131850,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: abc-123 + type: application_keys schema: $ref: "#/components/schemas/ApplicationKeyResponse" description: Created @@ -123674,6 +131925,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: abc-123 + type: application_keys schema: $ref: "#/components/schemas/PartialApplicationKeyResponse" description: OK @@ -123726,6 +131986,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: abc-123 + type: application_keys schema: $ref: "#/components/schemas/PartialApplicationKeyResponse" description: OK @@ -123772,6 +132041,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: test-service + id: abc-123 + type: services schema: $ref: "#/components/schemas/IncidentServicesResponse" description: OK @@ -123830,6 +132107,14 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: test-service + id: abc-123 + type: services schema: $ref: "#/components/schemas/IncidentServiceResponse" description: CREATED @@ -123870,6 +132155,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 @@ -123950,6 +132246,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 @@ -124013,6 +132319,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 @@ -124085,6 +132402,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: test-service + id: abc-123 + type: services schema: $ref: "#/components/schemas/IncidentServiceResponse" description: OK @@ -124147,6 +132472,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: test-service + id: abc-123 + type: services schema: $ref: "#/components/schemas/IncidentServiceResponse" description: OK @@ -124190,6 +132523,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 @@ -124239,6 +132583,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 @@ -124274,6 +132629,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 @@ -124324,6 +132690,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: historicalDetectionsJobCreate + meta: + totalCount: 1 schema: $ref: "#/components/schemas/ListHistoricalJobsResponse" description: OK @@ -124384,6 +132764,12 @@ paths: "201": content: "application/json": + examples: + default: + value: + data: + id: abc-123 + type: historicalDetectionsJobCreate schema: $ref: "#/components/schemas/JobCreateResponse" description: Status created @@ -124498,6 +132884,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: historicalDetectionsJobCreate schema: $ref: "#/components/schemas/HistoricalJobResponse" description: OK @@ -124574,6 +132974,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 @@ -124627,6 +133038,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: report_id schema: $ref: "#/components/schemas/SLOReportPostResponse" description: OK @@ -124672,6 +133089,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 @@ -124715,6 +133135,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + status: completed + id: abc-123 + type: report_id schema: $ref: "#/components/schemas/SLOReportStatusGetResponse" description: OK @@ -124764,6 +133192,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 @@ -124960,6 +133402,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 @@ -125042,6 +133498,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 @@ -125102,6 +133566,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 @@ -125172,6 +133648,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 @@ -125238,6 +133724,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 @@ -125297,6 +133796,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 @@ -125350,6 +133862,17 @@ 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: + name: my-rule + id: my-rule + type: custom_rule schema: $ref: "#/components/schemas/CustomRuleResponse" description: Successfully created @@ -125447,6 +133970,17 @@ 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: + name: my-rule + id: my-rule + type: custom_rule schema: $ref: "#/components/schemas/CustomRuleResponse" description: Successful response @@ -125509,6 +134043,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 @@ -125699,6 +134260,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 @@ -125745,6 +134333,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 @@ -125768,6 +134364,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 @@ -125813,6 +134420,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: abc-123 + type: status_pages schema: $ref: "#/components/schemas/StatusPageArray" description: OK @@ -125880,6 +134501,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: abc-123 + type: status_pages schema: $ref: "#/components/schemas/StatusPage" description: Created @@ -125937,6 +134572,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: abc-123 + type: degradations schema: $ref: "#/components/schemas/DegradationArray" description: OK @@ -125994,6 +134643,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: abc-123 + type: maintenances schema: $ref: "#/components/schemas/MaintenanceArray" description: OK @@ -126060,6 +134724,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: abc-123 + type: status_pages schema: $ref: "#/components/schemas/StatusPage" description: OK @@ -126125,6 +134803,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: abc-123 + type: status_pages schema: $ref: "#/components/schemas/StatusPage" description: OK @@ -126163,6 +134855,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: Metrics Intake + position: 0 + status: operational + type: component + id: abc-123 + type: components schema: $ref: "#/components/schemas/StatusPagesComponentArray" description: OK @@ -126218,6 +134921,17 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: Metrics Intake + position: 0 + status: operational + type: component + id: abc-123 + type: components schema: $ref: "#/components/schemas/StatusPagesComponent" description: Created @@ -126300,6 +135014,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Metrics Intake + position: 0 + status: operational + type: component + id: abc-123 + type: components schema: $ref: "#/components/schemas/StatusPagesComponent" description: OK @@ -126360,6 +135085,17 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Metrics Intake Service + position: 4 + status: operational + type: component + id: abc-123 + type: components schema: $ref: "#/components/schemas/StatusPagesComponent" description: OK @@ -126422,6 +135158,22 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: abc-123 + 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: abc-123 + type: degradations schema: $ref: "#/components/schemas/Degradation" description: Created @@ -126504,6 +135256,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: abc-123 + 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: abc-123 + type: degradations schema: $ref: "#/components/schemas/Degradation" description: OK @@ -126574,6 +135342,22 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: abc-123 + 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: abc-123 + type: degradations schema: $ref: "#/components/schemas/Degradation" description: OK @@ -126638,6 +135422,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: abc-123 + type: maintenances schema: $ref: "#/components/schemas/Maintenance" description: Created @@ -126682,6 +135481,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: abc-123 + type: maintenances schema: $ref: "#/components/schemas/Maintenance" description: OK @@ -126749,6 +135563,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: abc-123 + type: maintenances schema: $ref: "#/components/schemas/Maintenance" description: OK @@ -126842,6 +135671,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/SyntheticsApiMultistepSubtestsResponse" description: OK @@ -126876,6 +135709,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/SyntheticsApiMultistepParentTestsResponse" description: OK @@ -126907,6 +135744,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 @@ -126937,6 +135781,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 @@ -126979,6 +135830,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 @@ -127024,6 +135894,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 @@ -127092,6 +135971,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 @@ -127129,6 +136026,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 @@ -127188,6 +136104,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 @@ -127250,6 +136185,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 @@ -127498,6 +136452,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: abc-def-123 + type: delete_tests schema: $ref: "#/components/schemas/DeletedTestsResponse" description: OK @@ -127648,6 +136608,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Example Network Path test + public_id: abc-def-123 + status: live + type: network schema: $ref: "#/components/schemas/SyntheticsNetworkTestResponse" description: OK @@ -127686,6 +136655,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Example Network Path test + public_id: abc-def-123 + status: live + type: network schema: $ref: "#/components/schemas/SyntheticsNetworkTestResponse" description: OK @@ -127778,6 +136756,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: Example Network Path test + public_id: abc-def-123 + status: live + type: network schema: $ref: "#/components/schemas/SyntheticsNetworkTestResponse" description: OK @@ -127907,6 +136894,10 @@ paths: "200": content: application/json: + examples: + default: + value: + presignedUrl: https://example.com/download schema: $ref: "#/components/schemas/SyntheticsTestFileDownloadResponse" description: OK @@ -127973,6 +136964,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 @@ -128149,6 +137145,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/SyntheticsTestParentSuitesResponse" description: OK @@ -128397,6 +137397,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/SyntheticsTestVersionHistoryResponse" description: OK @@ -128462,6 +137466,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 @@ -128524,6 +137534,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 @@ -128549,6 +137573,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: abc-123 + type: ruleset schema: $ref: "#/components/schemas/RulesetRespArray" description: OK @@ -128593,6 +137644,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: abc-123 + type: ruleset schema: $ref: "#/components/schemas/RulesetResp" description: OK @@ -128660,6 +137738,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 @@ -128711,6 +137796,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: abc-123 + type: ruleset schema: $ref: "#/components/schemas/RulesetResp" description: OK @@ -128787,6 +137899,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: abc-123 + type: ruleset schema: $ref: "#/components/schemas/RulesetResp" description: OK @@ -128849,6 +137982,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + handle: example-team + name: Example Team + id: abc-123 + type: team + meta: + pagination: + offset: 0 + total: 1 schema: $ref: "#/components/schemas/TeamsResponse" description: OK @@ -128899,6 +138045,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + handle: example-team + name: Example Team + id: abc-123 + type: team schema: $ref: "#/components/schemas/TeamResponse" description: CREATED @@ -128950,6 +138105,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 @@ -129000,6 +138164,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: team_hierarchy_links schema: $ref: "#/components/schemas/TeamHierarchyLinkResponse" description: OK @@ -129079,6 +138249,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 @@ -129197,6 +138376,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + managed_by: github_sync + source: github + id: abc-123 + type: team_connection schema: $ref: "#/components/schemas/TeamConnectionsResponse" description: OK @@ -129250,6 +138438,15 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + - attributes: + managed_by: github_sync + source: github + id: abc-123 + type: team_connection schema: $ref: "#/components/schemas/TeamConnectionsResponse" description: Created @@ -129290,6 +138487,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 @@ -129400,6 +138607,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + handle: example-team + name: Example Team + id: abc-123 + type: team + meta: + pagination: + offset: 0 + total: 1 schema: $ref: "#/components/schemas/TeamsResponse" description: OK @@ -129591,6 +138811,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + handle: example-team + name: Example Team + id: abc-123 + type: team schema: $ref: "#/components/schemas/TeamResponse" description: OK @@ -129653,6 +138882,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + handle: example-team + name: Example Team + id: abc-123 + type: team schema: $ref: "#/components/schemas/TeamResponse" description: OK @@ -129706,6 +138944,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + label: Link label + position: 0 + url: "https://example.com" + id: abc-123 + type: team_links schema: $ref: "#/components/schemas/TeamLinksResponse" description: OK @@ -129760,6 +139008,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + label: Link label + url: https://example.com + id: abc-123 + type: team_links schema: $ref: "#/components/schemas/TeamLinkResponse" description: OK @@ -129854,6 +139111,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + label: Link label + position: 0 + url: "https://example.com" + id: abc-123 + type: team_links schema: $ref: "#/components/schemas/TeamLinkResponse" description: OK @@ -129913,6 +139180,16 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + label: Link label + position: 0 + url: "https://example.com" + id: abc-123 + type: team_links schema: $ref: "#/components/schemas/TeamLinkResponse" description: OK @@ -129968,6 +139245,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 @@ -130036,6 +139321,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + role: admin + id: abc-123 + type: team_memberships schema: $ref: "#/components/schemas/UserTeamResponse" description: Represents a user's association to a team @@ -130149,6 +139442,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 @@ -130195,6 +139496,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: + enabled: true + slack: + channel: test-channel + workspace: Datadog + id: abc-123 + type: team_notification_rules schema: $ref: "#/components/schemas/TeamNotificationRulesResponse" description: OK @@ -130250,6 +139563,18 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + email: + enabled: true + slack: + channel: test-channel + workspace: Datadog + id: abc-123 + type: team_notification_rules schema: $ref: "#/components/schemas/TeamNotificationRuleResponse" description: OK @@ -130341,6 +139666,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: + enabled: true + slack: + channel: test-channel + workspace: Datadog + id: abc-123 + type: team_notification_rules schema: $ref: "#/components/schemas/TeamNotificationRuleResponse" description: OK @@ -130403,6 +139740,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: + enabled: true + slack: + channel: test-channel + workspace: Datadog + id: abc-123 + type: team_notification_rules schema: $ref: "#/components/schemas/TeamNotificationRuleResponse" description: OK @@ -130443,6 +139792,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 @@ -130502,6 +139861,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 @@ -130543,6 +139912,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + name: team name + id: abc-123 + type: teams schema: $ref: "#/components/schemas/IncidentTeamsResponse" description: OK @@ -130601,6 +139978,14 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + name: team name + id: abc-123 + type: teams schema: $ref: "#/components/schemas/IncidentTeamResponse" description: CREATED @@ -130676,6 +140061,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: team name + id: abc-123 + type: teams schema: $ref: "#/components/schemas/IncidentTeamResponse" description: OK @@ -130738,6 +140131,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + name: team name + id: abc-123 + type: teams schema: $ref: "#/components/schemas/IncidentTeamResponse" description: OK @@ -130790,6 +140191,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 @@ -130854,6 +140266,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 @@ -130911,6 +140341,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/UsageApplicationSecurityMonitoringResponse" description: OK @@ -130971,6 +140405,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/BillingDimensionsMappingResponse" description: OK @@ -131035,6 +140473,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/CostByOrgResponse" description: OK @@ -131132,6 +140574,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/CostByOrgResponse" description: OK @@ -131207,6 +140653,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/CostByOrgResponse" description: OK @@ -131326,6 +140776,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 @@ -131387,6 +140843,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/UsageLambdaTracedInvocationsResponse" description: OK @@ -131448,6 +140908,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/UsageObservabilityPipelinesResponse" description: OK @@ -131507,6 +140971,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/ProjectedCostResponse" description: OK @@ -131551,6 +141019,10 @@ paths: "200": content: application/json;datetime-format=rfc3339: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/UsageAttributionTypesResponse" description: OK @@ -131602,6 +141074,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: abc-123 + type: user_invitations schema: $ref: "#/components/schemas/UserInvitationsResponse" description: OK @@ -131648,6 +141131,15 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + invite_type: email + uuid: 00000000-0000-0000-0000-000000000001 + id: abc-123 + type: user_invitations schema: $ref: "#/components/schemas/UserInvitationResponse" description: OK @@ -131725,6 +141217,19 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + email: test@example.com + handle: example-handle + name: Example Name + status: Active + id: abc-123 + type: users + included: [] + meta: {} schema: $ref: "#/components/schemas/UsersResponse" description: OK @@ -131783,6 +141288,18 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + handle: example-handle + name: Example Name + status: Active + id: abc-123 + type: users + included: [] schema: $ref: "#/components/schemas/UserResponse" description: OK @@ -131861,6 +141378,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + handle: example-handle + name: Example Name + status: Active + id: abc-123 + type: users + included: [] schema: $ref: "#/components/schemas/UserResponse" description: OK @@ -131914,6 +141443,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + handle: example-handle + name: Example Name + status: Active + id: abc-123 + type: users + included: [] schema: $ref: "#/components/schemas/UserResponse" description: OK @@ -131969,6 +141510,18 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + email: test@example.com + handle: example-handle + name: Example Name + status: Active + id: abc-123 + type: users + included: [] schema: $ref: "#/components/schemas/UserResponse" description: OK @@ -132009,6 +141562,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: abc-123 + type: permissions schema: $ref: "#/components/schemas/PermissionsResponse" description: OK @@ -132054,6 +141618,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - attributes: + role: admin + id: abc-123 + type: team_memberships schema: $ref: "#/components/schemas/UserTeamsResponse" description: Represents a user's association to a team @@ -132141,6 +141713,10 @@ paths: "200": content: application/json: + examples: + default: + value: + data: [] schema: $ref: "#/components/schemas/WidgetListResponse" description: OK @@ -132201,6 +141777,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 @@ -132307,6 +141898,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 @@ -132380,6 +141986,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 @@ -132492,6 +142113,12 @@ paths: "201": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: workflows schema: $ref: "#/components/schemas/CreateWorkflowResponse" description: Successfully created a workflow. @@ -132563,6 +142190,20 @@ 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 + tags: + - team:infra + updatedAt: "2024-01-01T00:00:00+00:00" + id: abc-123 + type: workflows schema: $ref: "#/components/schemas/GetWorkflowResponse" description: Successfully got a workflow. @@ -132674,6 +142315,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 + type: workflows schema: $ref: "#/components/schemas/UpdateWorkflowResponse" description: Successfully updated a workflow. @@ -132720,6 +142367,14 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + - id: abc-123 + meta: + page: + totalCount: 1 schema: $ref: "#/components/schemas/WorkflowListInstancesResponse" description: OK @@ -132762,6 +142417,11 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 schema: $ref: "#/components/schemas/WorkflowInstanceCreateResponse" description: Created @@ -132795,6 +142455,12 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + attributes: + id: abc-123 schema: $ref: "#/components/schemas/WorklflowGetInstanceResponse" description: OK @@ -132829,6 +142495,11 @@ paths: "200": content: application/json: + examples: + default: + value: + data: + id: abc-123 schema: $ref: "#/components/schemas/WorklflowCancelInstanceResponse" description: OK