datadog_api_client 2.13.0 → 2.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.generator/schemas/v1/openapi.yaml +346 -36
- data/.generator/schemas/v2/openapi.yaml +436 -174
- data/.generator/src/generator/formatter.py +34 -29
- data/.generator/src/generator/openapi.py +3 -1
- data/.generator/src/generator/templates/api.j2 +8 -2
- data/.generator/src/generator/templates/api_client.j2 +81 -53
- data/.generator/src/generator/templates/configuration.j2 +21 -0
- data/.pre-commit-config.yaml +2 -2
- data/CHANGELOG.md +57 -0
- data/README.md +23 -0
- data/examples/v1/azure-integration/CreateAzureIntegration.rb +3 -0
- data/examples/v1/azure-integration/DeleteAzureIntegration.rb +3 -0
- data/examples/v1/azure-integration/UpdateAzureHostFilters.rb +3 -0
- data/examples/v1/azure-integration/UpdateAzureIntegration.rb +3 -0
- data/examples/v1/dashboards/CreateDashboard_252716965.rb +6 -0
- data/examples/v1/dashboards/CreateDashboard_2618036642.rb +36 -0
- data/examples/v1/dashboards/CreateDashboard_2705593938.rb +3 -0
- data/examples/v1/dashboards/CreateDashboard_3777304439.rb +50 -0
- data/examples/v1/dashboards/DeletePublicDashboardInvitation.rb +3 -3
- data/examples/v1/dashboards/ListDashboards_1062671515.rb +8 -0
- data/examples/v1/monitors/ListMonitors_2966492814.rb +8 -0
- data/examples/v1/notebooks/ListNotebooks_788665428.rb +8 -0
- data/examples/v1/service-level-objective-corrections/ListSLOCorrection_2647266873.rb +8 -0
- data/examples/v1/service-level-objectives/ListSLOs_3036942817.rb +8 -0
- data/examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.rb +2 -0
- data/examples/v1/synthetics/ListTests_1938827783.rb +8 -0
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.rb +3 -0
- data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.rb +3 -0
- data/examples/v2/downtimes/CancelDowntime.rb +0 -3
- data/examples/v2/downtimes/CreateDowntime.rb +0 -3
- data/examples/v2/downtimes/GetDowntime.rb +0 -3
- data/examples/v2/downtimes/ListDowntimes.rb +0 -3
- data/examples/v2/downtimes/ListDowntimes_805770330.rb +8 -0
- data/examples/v2/downtimes/ListMonitorDowntimes.rb +0 -3
- data/examples/v2/downtimes/ListMonitorDowntimes_128979780.rb +0 -3
- data/examples/v2/downtimes/UpdateDowntime.rb +0 -3
- data/examples/v2/logs/AggregateLogs_2955613758.rb +1 -1
- data/examples/v2/security-monitoring/CreateSecurityMonitoringRule_1092490364.rb +1 -1
- data/examples/v2/security-monitoring/UpdateSecurityMonitoringRule_428087276.rb +1 -1
- data/examples/v2/teams/CreateTeam.rb +2 -2
- data/examples/v2/teams/CreateTeam_252121814.rb +24 -0
- data/examples/v2/teams/GetUserMemberships.rb +8 -0
- data/examples/v2/teams/ListTeams_3592098458.rb +8 -0
- data/examples/v2/teams/UpdateTeam.rb +9 -0
- data/examples/v2/users/ListUsers_4075885358.rb +8 -0
- data/lib/datadog_api_client/api_client.rb +81 -53
- data/lib/datadog_api_client/configuration.rb +22 -6
- data/lib/datadog_api_client/inflector.rb +11 -1
- data/lib/datadog_api_client/v1/api/dashboards_api.rb +25 -0
- data/lib/datadog_api_client/v1/api/monitors_api.rb +22 -0
- data/lib/datadog_api_client/v1/api/notebooks_api.rb +21 -0
- data/lib/datadog_api_client/v1/api/service_level_objective_corrections_api.rb +23 -2
- data/lib/datadog_api_client/v1/api/service_level_objectives_api.rb +31 -10
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +25 -3
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +3 -3
- data/lib/datadog_api_client/v1/models/azure_account.rb +32 -1
- data/lib/datadog_api_client/v1/models/distribution_widget_definition.rb +13 -1
- data/lib/datadog_api_client/v1/models/heat_map_widget_request.rb +35 -1
- data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +4 -0
- data/lib/datadog_api_client/v1/models/list_stream_source.rb +1 -0
- data/lib/datadog_api_client/v1/models/monitor.rb +1 -1
- data/lib/datadog_api_client/v1/models/monitor_options.rb +1 -1
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +8 -0
- data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +81 -1
- data/lib/datadog_api_client/v1/models/sunburst_widget_request.rb +14 -4
- data/lib/datadog_api_client/v1/models/synthetics_assertion_target.rb +11 -1
- data/lib/datadog_api_client/v1/models/synthetics_assertion_timings_scope.rb +27 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +11 -1
- data/lib/datadog_api_client/v1/models/usage_ci_visibility_hour.rb +12 -1
- data/lib/datadog_api_client/v1/models/usage_profiling_hour.rb +12 -1
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +44 -4
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +44 -4
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +44 -4
- data/lib/datadog_api_client/v1/models/widget_comparator.rb +1 -0
- data/lib/datadog_api_client/v2/api/audit_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/ci_visibility_pipelines_api.rb +11 -7
- data/lib/datadog_api_client/v2/api/ci_visibility_tests_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/downtimes_api.rb +25 -36
- data/lib/datadog_api_client/v2/api/events_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/ip_allowlist_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/logs_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/metrics_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/processes_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/rum_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +6 -6
- data/lib/datadog_api_client/v2/api/service_definition_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/spans_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/spans_metrics_api.rb +2 -2
- data/lib/datadog_api_client/v2/api/teams_api.rb +87 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +1 -1
- data/lib/datadog_api_client/v2/api/users_api.rb +22 -0
- data/lib/datadog_api_client/v2/models/application_key_create_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/application_key_update_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/audit_logs_event_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/ci_app_event_attributes.rb +9 -21
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_event.rb +1 -1
- data/lib/datadog_api_client/v2/models/{team_data.rb → ci_app_pipeline_event_attributes.rb} +24 -62
- data/lib/datadog_api_client/v2/models/ci_app_pipeline_level.rb +30 -0
- data/lib/datadog_api_client/v2/models/ci_app_pipelines_query_filter.rb +1 -1
- data/lib/datadog_api_client/v2/models/ci_app_test_level.rb +29 -0
- data/lib/datadog_api_client/v2/models/ci_app_tests_analytics_aggregate_response.rb +1 -1
- data/lib/datadog_api_client/v2/models/ci_app_tests_query_filter.rb +1 -1
- data/lib/datadog_api_client/v2/models/cloud_configuration_rule_compliance_signal_options.rb +25 -1
- data/lib/datadog_api_client/v2/models/dashboard_list_item.rb +25 -1
- data/lib/datadog_api_client/v2/models/downtime_relationships_monitor_data.rb +1 -1
- data/lib/datadog_api_client/v2/models/downtime_schedule_one_time_response.rb +19 -1
- data/lib/datadog_api_client/v2/models/formula_limit.rb +1 -0
- data/lib/datadog_api_client/v2/models/full_application_key_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_aggregate_request.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_aggregate_request_page.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_group_by.rb +3 -2
- data/lib/datadog_api_client/v2/models/logs_group_by_histogram.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_list_request.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_query_options.rb +1 -1
- data/lib/datadog_api_client/v2/models/logs_response_metadata_page.rb +1 -1
- data/lib/datadog_api_client/v2/models/on_demand_concurrency_cap.rb +14 -4
- data/lib/datadog_api_client/v2/models/on_demand_concurrency_cap_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/partial_application_key_attributes.rb +1 -1
- data/lib/datadog_api_client/v2/models/query_formula.rb +1 -0
- data/lib/datadog_api_client/v2/models/relationship_to_team_links.rb +14 -4
- data/lib/datadog_api_client/v2/models/relationship_to_user_team_permission.rb +14 -4
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_metadata_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_rule_response_query.rb +26 -2
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_state_update_data.rb +24 -4
- data/lib/datadog_api_client/v2/models/security_monitoring_signal_triage_update_data.rb +24 -4
- data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_query.rb +1 -19
- data/lib/datadog_api_client/v2/models/security_monitoring_triage_user.rb +11 -1
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_get_config_response_data.rb +11 -1
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_meta.rb +11 -1
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_pattern_attributes.rb +11 -1
- data/lib/datadog_api_client/v2/models/team_attributes.rb +50 -4
- data/lib/datadog_api_client/v2/models/team_create_attributes.rb +57 -4
- data/lib/datadog_api_client/v2/models/team_relationships_links.rb +80 -0
- data/lib/datadog_api_client/v2/models/team_response.rb +1 -1
- data/lib/datadog_api_client/v2/models/team_update_attributes.rb +57 -4
- data/lib/datadog_api_client/v2/models/teams_response.rb +24 -4
- data/lib/datadog_api_client/v2/models/teams_response_links.rb +129 -0
- data/lib/datadog_api_client/v2/models/teams_response_meta.rb +80 -0
- data/lib/datadog_api_client/v2/models/teams_response_meta_pagination.rb +150 -0
- data/lib/datadog_api_client/v2/models/usage_attributes_object.rb +11 -1
- data/lib/datadog_api_client/v2/models/user_teams_response.rb +24 -4
- data/lib/datadog_api_client/version.rb +1 -1
- data/spec/configuration_spec.rb +17 -0
- data/spec/retry_spec.rb +44 -0
- metadata +28 -3
|
@@ -622,7 +622,6 @@ components:
|
|
|
622
622
|
description: An object related to an API key.
|
|
623
623
|
oneOf:
|
|
624
624
|
- $ref: '#/components/schemas/User'
|
|
625
|
-
type: object
|
|
626
625
|
APIKeyUpdateAttributes:
|
|
627
626
|
description: Attributes used to update an API Key.
|
|
628
627
|
properties:
|
|
@@ -710,9 +709,7 @@ components:
|
|
|
710
709
|
example: Application Key for managing dashboards
|
|
711
710
|
type: string
|
|
712
711
|
scopes:
|
|
713
|
-
description: Array of scopes to grant the application key.
|
|
714
|
-
is in private beta, please contact Datadog support to enable scopes for
|
|
715
|
-
your application keys.
|
|
712
|
+
description: Array of scopes to grant the application key.
|
|
716
713
|
example:
|
|
717
714
|
- dashboards_read
|
|
718
715
|
- dashboards_write
|
|
@@ -766,7 +763,6 @@ components:
|
|
|
766
763
|
oneOf:
|
|
767
764
|
- $ref: '#/components/schemas/User'
|
|
768
765
|
- $ref: '#/components/schemas/Role'
|
|
769
|
-
type: object
|
|
770
766
|
ApplicationKeyUpdateAttributes:
|
|
771
767
|
description: Attributes used to update an application Key.
|
|
772
768
|
properties:
|
|
@@ -775,9 +771,7 @@ components:
|
|
|
775
771
|
example: Application Key for managing dashboards
|
|
776
772
|
type: string
|
|
777
773
|
scopes:
|
|
778
|
-
description: Array of scopes to grant the application key.
|
|
779
|
-
is in private beta, please contact Datadog support to enable scopes for
|
|
780
|
-
your application keys.
|
|
774
|
+
description: Array of scopes to grant the application key.
|
|
781
775
|
example:
|
|
782
776
|
- dashboards_read
|
|
783
777
|
- dashboards_write
|
|
@@ -863,6 +857,9 @@ components:
|
|
|
863
857
|
customAttribute: 123
|
|
864
858
|
duration: 2345
|
|
865
859
|
type: object
|
|
860
|
+
message:
|
|
861
|
+
description: Message of the event.
|
|
862
|
+
type: string
|
|
866
863
|
service:
|
|
867
864
|
description: 'Name of the application or service generating Audit Logs events.
|
|
868
865
|
|
|
@@ -1146,8 +1143,6 @@ components:
|
|
|
1146
1143
|
oneOf:
|
|
1147
1144
|
- $ref: '#/components/schemas/SAMLAssertionAttribute'
|
|
1148
1145
|
- $ref: '#/components/schemas/Role'
|
|
1149
|
-
properties: {}
|
|
1150
|
-
type: object
|
|
1151
1146
|
AuthNMappingRelationships:
|
|
1152
1147
|
description: All relationships associated with AuthN Mapping.
|
|
1153
1148
|
properties:
|
|
@@ -1485,25 +1480,15 @@ components:
|
|
|
1485
1480
|
properties:
|
|
1486
1481
|
attributes:
|
|
1487
1482
|
additionalProperties: {}
|
|
1488
|
-
description: JSON object of attributes from CI Visibility events.
|
|
1483
|
+
description: JSON object of attributes from CI Visibility test events.
|
|
1489
1484
|
example:
|
|
1490
1485
|
customAttribute: 123
|
|
1491
1486
|
duration: 2345
|
|
1492
1487
|
type: object
|
|
1493
|
-
service:
|
|
1494
|
-
description: 'The name of the application or service generating CI Visibility
|
|
1495
|
-
events.
|
|
1496
|
-
|
|
1497
|
-
It is used to switch from CI Visibility to APM, so make sure you define
|
|
1498
|
-
the same
|
|
1499
|
-
|
|
1500
|
-
value when you use both products.'
|
|
1501
|
-
example: web-ui-tests
|
|
1502
|
-
type: string
|
|
1503
1488
|
tags:
|
|
1504
1489
|
$ref: '#/components/schemas/TagsEventAttribute'
|
|
1505
|
-
|
|
1506
|
-
$ref: '#/components/schemas/
|
|
1490
|
+
test_level:
|
|
1491
|
+
$ref: '#/components/schemas/CIAppTestLevel'
|
|
1507
1492
|
type: object
|
|
1508
1493
|
CIAppGitInfo:
|
|
1509
1494
|
description: 'If pipelines are triggered due to actions to a Git repository,
|
|
@@ -1665,7 +1650,7 @@ components:
|
|
|
1665
1650
|
stored by Datadog.
|
|
1666
1651
|
properties:
|
|
1667
1652
|
attributes:
|
|
1668
|
-
$ref: '#/components/schemas/
|
|
1653
|
+
$ref: '#/components/schemas/CIAppPipelineEventAttributes'
|
|
1669
1654
|
id:
|
|
1670
1655
|
description: Unique ID of the event.
|
|
1671
1656
|
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
|
|
@@ -1673,6 +1658,22 @@ components:
|
|
|
1673
1658
|
type:
|
|
1674
1659
|
$ref: '#/components/schemas/CIAppPipelineEventTypeName'
|
|
1675
1660
|
type: object
|
|
1661
|
+
CIAppPipelineEventAttributes:
|
|
1662
|
+
description: JSON object containing all event attributes and their associated
|
|
1663
|
+
values.
|
|
1664
|
+
properties:
|
|
1665
|
+
attributes:
|
|
1666
|
+
additionalProperties: {}
|
|
1667
|
+
description: JSON object of attributes from CI Visibility pipeline events.
|
|
1668
|
+
example:
|
|
1669
|
+
customAttribute: 123
|
|
1670
|
+
duration: 2345
|
|
1671
|
+
type: object
|
|
1672
|
+
ci_level:
|
|
1673
|
+
$ref: '#/components/schemas/CIAppPipelineLevel'
|
|
1674
|
+
tags:
|
|
1675
|
+
$ref: '#/components/schemas/TagsEventAttribute'
|
|
1676
|
+
type: object
|
|
1676
1677
|
CIAppPipelineEventJob:
|
|
1677
1678
|
description: Details of a CI job.
|
|
1678
1679
|
properties:
|
|
@@ -2194,6 +2195,22 @@ components:
|
|
|
2194
2195
|
meta:
|
|
2195
2196
|
$ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
|
|
2196
2197
|
type: object
|
|
2198
|
+
CIAppPipelineLevel:
|
|
2199
|
+
description: Pipeline execution level.
|
|
2200
|
+
enum:
|
|
2201
|
+
- pipeline
|
|
2202
|
+
- stage
|
|
2203
|
+
- job
|
|
2204
|
+
- step
|
|
2205
|
+
- custom
|
|
2206
|
+
example: pipeline
|
|
2207
|
+
type: string
|
|
2208
|
+
x-enum-varnames:
|
|
2209
|
+
- PIPELINE
|
|
2210
|
+
- STAGE
|
|
2211
|
+
- JOB
|
|
2212
|
+
- STEP
|
|
2213
|
+
- CUSTOM
|
|
2197
2214
|
CIAppPipelinesAggregateRequest:
|
|
2198
2215
|
description: The object sent with the request to retrieve aggregation buckets
|
|
2199
2216
|
of pipeline events from your organization.
|
|
@@ -2281,7 +2298,8 @@ components:
|
|
|
2281
2298
|
type: string
|
|
2282
2299
|
query:
|
|
2283
2300
|
default: '*'
|
|
2284
|
-
description: The search query following the
|
|
2301
|
+
description: The search query following the CI Visibility Explorer search
|
|
2302
|
+
syntax.
|
|
2285
2303
|
example: '@ci.provider.name:github AND @ci.status:error'
|
|
2286
2304
|
type: string
|
|
2287
2305
|
to:
|
|
@@ -2467,6 +2485,20 @@ components:
|
|
|
2467
2485
|
meta:
|
|
2468
2486
|
$ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
|
|
2469
2487
|
type: object
|
|
2488
|
+
CIAppTestLevel:
|
|
2489
|
+
description: Test run level.
|
|
2490
|
+
enum:
|
|
2491
|
+
- session
|
|
2492
|
+
- module
|
|
2493
|
+
- suite
|
|
2494
|
+
- test
|
|
2495
|
+
example: test
|
|
2496
|
+
type: string
|
|
2497
|
+
x-enum-varnames:
|
|
2498
|
+
- SESSION
|
|
2499
|
+
- MODULE
|
|
2500
|
+
- SUITE
|
|
2501
|
+
- TEST
|
|
2470
2502
|
CIAppTestsAggregateRequest:
|
|
2471
2503
|
description: The object sent with the request to retrieve aggregation buckets
|
|
2472
2504
|
of test events from your organization.
|
|
@@ -2504,7 +2536,7 @@ components:
|
|
|
2504
2536
|
links:
|
|
2505
2537
|
$ref: '#/components/schemas/CIAppResponseLinks'
|
|
2506
2538
|
meta:
|
|
2507
|
-
$ref: '#/components/schemas/
|
|
2539
|
+
$ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
|
|
2508
2540
|
type: object
|
|
2509
2541
|
CIAppTestsBucketResponse:
|
|
2510
2542
|
description: Bucket values.
|
|
@@ -2554,7 +2586,8 @@ components:
|
|
|
2554
2586
|
type: string
|
|
2555
2587
|
query:
|
|
2556
2588
|
default: '*'
|
|
2557
|
-
description: The search query following the
|
|
2589
|
+
description: The search query following the CI Visibility Explorer search
|
|
2590
|
+
syntax.
|
|
2558
2591
|
example: '@test.service:web-ui-tests AND @test.status:fail'
|
|
2559
2592
|
type: string
|
|
2560
2593
|
to:
|
|
@@ -2600,6 +2633,7 @@ components:
|
|
|
2600
2633
|
type: string
|
|
2601
2634
|
type: object
|
|
2602
2635
|
CloudConfigurationComplianceRuleOptions:
|
|
2636
|
+
additionalProperties: {}
|
|
2603
2637
|
description: 'Options for cloud_configuration rules.
|
|
2604
2638
|
|
|
2605
2639
|
Fields `resourceType` and `regoRule` are mandatory when managing custom `cloud_configuration`
|
|
@@ -2671,6 +2705,16 @@ components:
|
|
|
2671
2705
|
description: How to generate compliance signals. Useful for cloud_configuration
|
|
2672
2706
|
rules only.
|
|
2673
2707
|
properties:
|
|
2708
|
+
defaultActivationStatus:
|
|
2709
|
+
description: The default activation status.
|
|
2710
|
+
nullable: true
|
|
2711
|
+
type: boolean
|
|
2712
|
+
defaultGroupByFields:
|
|
2713
|
+
description: The default group by fields.
|
|
2714
|
+
items:
|
|
2715
|
+
type: string
|
|
2716
|
+
nullable: true
|
|
2717
|
+
type: array
|
|
2674
2718
|
userActivationStatus:
|
|
2675
2719
|
description: Whether signals will be sent.
|
|
2676
2720
|
nullable: true
|
|
@@ -3557,6 +3601,15 @@ components:
|
|
|
3557
3601
|
maximum: 5
|
|
3558
3602
|
readOnly: true
|
|
3559
3603
|
type: integer
|
|
3604
|
+
tags:
|
|
3605
|
+
description: List of team names representing ownership of a dashboard.
|
|
3606
|
+
items:
|
|
3607
|
+
description: The name of a Datadog team, formatted as `team:<name>`
|
|
3608
|
+
type: string
|
|
3609
|
+
maxItems: 5
|
|
3610
|
+
nullable: true
|
|
3611
|
+
readOnly: true
|
|
3612
|
+
type: array
|
|
3560
3613
|
title:
|
|
3561
3614
|
description: Title of the dashboard.
|
|
3562
3615
|
readOnly: true
|
|
@@ -3820,7 +3873,6 @@ components:
|
|
|
3820
3873
|
oneOf:
|
|
3821
3874
|
- $ref: '#/components/schemas/DowntimeMonitorIdentifierId'
|
|
3822
3875
|
- $ref: '#/components/schemas/DowntimeMonitorIdentifierTags'
|
|
3823
|
-
type: object
|
|
3824
3876
|
DowntimeMonitorIdentifierId:
|
|
3825
3877
|
additionalProperties: {}
|
|
3826
3878
|
description: Object of the monitor identifier.
|
|
@@ -3965,9 +4017,8 @@ components:
|
|
|
3965
4017
|
properties:
|
|
3966
4018
|
id:
|
|
3967
4019
|
description: Monitor ID of the downtime.
|
|
3968
|
-
example: 12345
|
|
3969
|
-
|
|
3970
|
-
type: integer
|
|
4020
|
+
example: '12345'
|
|
4021
|
+
type: string
|
|
3971
4022
|
type:
|
|
3972
4023
|
$ref: '#/components/schemas/DowntimeIncludedMonitorType'
|
|
3973
4024
|
type: object
|
|
@@ -4055,13 +4106,11 @@ components:
|
|
|
4055
4106
|
oneOf:
|
|
4056
4107
|
- $ref: '#/components/schemas/User'
|
|
4057
4108
|
- $ref: '#/components/schemas/DowntimeMonitorIncludedItem'
|
|
4058
|
-
type: object
|
|
4059
4109
|
DowntimeScheduleCreateRequest:
|
|
4060
4110
|
description: Schedule for the downtime.
|
|
4061
4111
|
oneOf:
|
|
4062
4112
|
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesCreateRequest'
|
|
4063
4113
|
- $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest'
|
|
4064
|
-
type: object
|
|
4065
4114
|
DowntimeScheduleCurrentDowntimeResponse:
|
|
4066
4115
|
description: 'The most recent actual start and end dates for a recurring downtime.
|
|
4067
4116
|
For a canceled downtime,
|
|
@@ -4120,6 +4169,8 @@ components:
|
|
|
4120
4169
|
example: 2020-01-02 03:04:00+00:00
|
|
4121
4170
|
format: date-time
|
|
4122
4171
|
type: string
|
|
4172
|
+
required:
|
|
4173
|
+
- start
|
|
4123
4174
|
type: object
|
|
4124
4175
|
DowntimeScheduleRecurrenceCreateUpdateRequest:
|
|
4125
4176
|
additionalProperties: {}
|
|
@@ -4241,13 +4292,11 @@ components:
|
|
|
4241
4292
|
oneOf:
|
|
4242
4293
|
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesResponse'
|
|
4243
4294
|
- $ref: '#/components/schemas/DowntimeScheduleOneTimeResponse'
|
|
4244
|
-
type: object
|
|
4245
4295
|
DowntimeScheduleUpdateRequest:
|
|
4246
4296
|
description: Schedule for the downtime.
|
|
4247
4297
|
oneOf:
|
|
4248
4298
|
- $ref: '#/components/schemas/DowntimeScheduleRecurrencesUpdateRequest'
|
|
4249
4299
|
- $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest'
|
|
4250
|
-
type: object
|
|
4251
4300
|
DowntimeScope:
|
|
4252
4301
|
description: The scope to which the downtime applies. Must follow the [common
|
|
4253
4302
|
search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).
|
|
@@ -5183,8 +5232,10 @@ components:
|
|
|
5183
5232
|
x-enum-varnames:
|
|
5184
5233
|
- FINDING
|
|
5185
5234
|
FormulaLimit:
|
|
5186
|
-
description: Message for specifying limits to the number of values returned
|
|
5235
|
+
description: 'Message for specifying limits to the number of values returned
|
|
5187
5236
|
by a query.
|
|
5237
|
+
|
|
5238
|
+
This limit is only for scalar queries and has no effect on timeseries queries.'
|
|
5188
5239
|
properties:
|
|
5189
5240
|
count:
|
|
5190
5241
|
description: The number of results to which to limit.
|
|
@@ -5274,9 +5325,7 @@ components:
|
|
|
5274
5325
|
example: Application Key for managing dashboards
|
|
5275
5326
|
type: string
|
|
5276
5327
|
scopes:
|
|
5277
|
-
description: Array of scopes to grant the application key.
|
|
5278
|
-
is in private beta, please contact Datadog support to enable scopes for
|
|
5279
|
-
your application keys.
|
|
5328
|
+
description: Array of scopes to grant the application key.
|
|
5280
5329
|
example:
|
|
5281
5330
|
- dashboards_read
|
|
5282
5331
|
- dashboards_write
|
|
@@ -5799,7 +5848,6 @@ components:
|
|
|
5799
5848
|
oneOf:
|
|
5800
5849
|
- $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes'
|
|
5801
5850
|
- $ref: '#/components/schemas/IncidentAttachmentLinkAttributes'
|
|
5802
|
-
type: object
|
|
5803
5851
|
IncidentAttachmentData:
|
|
5804
5852
|
description: A single incident attachment.
|
|
5805
5853
|
example:
|
|
@@ -5914,7 +5962,6 @@ components:
|
|
|
5914
5962
|
oneOf:
|
|
5915
5963
|
- $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes'
|
|
5916
5964
|
- $ref: '#/components/schemas/IncidentAttachmentLinkAttributes'
|
|
5917
|
-
type: object
|
|
5918
5965
|
IncidentAttachmentUpdateData:
|
|
5919
5966
|
description: A single incident attachment.
|
|
5920
5967
|
properties:
|
|
@@ -6020,7 +6067,6 @@ components:
|
|
|
6020
6067
|
description: An object related to an attachment that is included in the response.
|
|
6021
6068
|
oneOf:
|
|
6022
6069
|
- $ref: '#/components/schemas/User'
|
|
6023
|
-
type: object
|
|
6024
6070
|
IncidentCreateAttributes:
|
|
6025
6071
|
description: The incident's attributes for a create request.
|
|
6026
6072
|
properties:
|
|
@@ -6101,7 +6147,6 @@ components:
|
|
|
6101
6147
|
- $ref: '#/components/schemas/IncidentFieldAttributesMultipleValue'
|
|
6102
6148
|
required:
|
|
6103
6149
|
- type
|
|
6104
|
-
type: object
|
|
6105
6150
|
IncidentFieldAttributesMultipleValue:
|
|
6106
6151
|
description: A field with potentially multiple values selected.
|
|
6107
6152
|
properties:
|
|
@@ -6232,7 +6277,6 @@ components:
|
|
|
6232
6277
|
oneOf:
|
|
6233
6278
|
- $ref: '#/components/schemas/SlackIntegrationMetadata'
|
|
6234
6279
|
- $ref: '#/components/schemas/JiraIntegrationMetadata'
|
|
6235
|
-
type: object
|
|
6236
6280
|
IncidentIntegrationMetadataPatchData:
|
|
6237
6281
|
description: Incident integration metadata data for a patch request.
|
|
6238
6282
|
properties:
|
|
@@ -6286,7 +6330,6 @@ components:
|
|
|
6286
6330
|
in the response.
|
|
6287
6331
|
oneOf:
|
|
6288
6332
|
- $ref: '#/components/schemas/User'
|
|
6289
|
-
type: object
|
|
6290
6333
|
IncidentIntegrationMetadataType:
|
|
6291
6334
|
default: incident_integrations
|
|
6292
6335
|
description: Integration metadata resource type.
|
|
@@ -6466,7 +6509,6 @@ components:
|
|
|
6466
6509
|
oneOf:
|
|
6467
6510
|
- $ref: '#/components/schemas/User'
|
|
6468
6511
|
- $ref: '#/components/schemas/IncidentAttachmentData'
|
|
6469
|
-
type: object
|
|
6470
6512
|
IncidentResponseMeta:
|
|
6471
6513
|
description: The metadata object containing pagination metadata.
|
|
6472
6514
|
properties:
|
|
@@ -6766,7 +6808,6 @@ components:
|
|
|
6766
6808
|
included payload.
|
|
6767
6809
|
oneOf:
|
|
6768
6810
|
- $ref: '#/components/schemas/User'
|
|
6769
|
-
type: object
|
|
6770
6811
|
IncidentServiceRelationships:
|
|
6771
6812
|
description: The incident service's relationships.
|
|
6772
6813
|
properties:
|
|
@@ -6925,7 +6966,6 @@ components:
|
|
|
6925
6966
|
payload.
|
|
6926
6967
|
oneOf:
|
|
6927
6968
|
- $ref: '#/components/schemas/User'
|
|
6928
|
-
type: object
|
|
6929
6969
|
IncidentTeamRelationships:
|
|
6930
6970
|
description: The incident team's relationships.
|
|
6931
6971
|
properties:
|
|
@@ -7052,7 +7092,6 @@ components:
|
|
|
7052
7092
|
description: The timeline cell's attributes for a create request.
|
|
7053
7093
|
oneOf:
|
|
7054
7094
|
- $ref: '#/components/schemas/IncidentTimelineCellMarkdownCreateAttributes'
|
|
7055
|
-
type: object
|
|
7056
7095
|
IncidentTimelineCellMarkdownContentType:
|
|
7057
7096
|
default: markdown
|
|
7058
7097
|
description: Type of the Markdown timeline cell.
|
|
@@ -7254,7 +7293,6 @@ components:
|
|
|
7254
7293
|
description: An object related to an incident todo that is included in the response.
|
|
7255
7294
|
oneOf:
|
|
7256
7295
|
- $ref: '#/components/schemas/User'
|
|
7257
|
-
type: object
|
|
7258
7296
|
IncidentTodoType:
|
|
7259
7297
|
default: incident_todos
|
|
7260
7298
|
description: Todo resource type.
|
|
@@ -7785,7 +7823,8 @@ components:
|
|
|
7785
7823
|
description: Paging settings
|
|
7786
7824
|
properties:
|
|
7787
7825
|
cursor:
|
|
7788
|
-
description: The returned paging point to use to get the next results
|
|
7826
|
+
description: 'The returned paging point to use to get the next results.
|
|
7827
|
+
Note: at most 1000 results can be paged.'
|
|
7789
7828
|
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
7790
7829
|
type: string
|
|
7791
7830
|
type: object
|
|
@@ -7993,7 +8032,6 @@ components:
|
|
|
7993
8032
|
required:
|
|
7994
8033
|
- type
|
|
7995
8034
|
- integration
|
|
7996
|
-
type: object
|
|
7997
8035
|
LogsArchiveDefinition:
|
|
7998
8036
|
description: The definition of an archive.
|
|
7999
8037
|
properties:
|
|
@@ -8023,7 +8061,6 @@ components:
|
|
|
8023
8061
|
required:
|
|
8024
8062
|
- type
|
|
8025
8063
|
- integration
|
|
8026
|
-
type: object
|
|
8027
8064
|
LogsArchiveDestinationAzure:
|
|
8028
8065
|
description: The Azure archive destination.
|
|
8029
8066
|
properties:
|
|
@@ -8270,7 +8307,11 @@ components:
|
|
|
8270
8307
|
$ref: '#/components/schemas/LogsGroupByHistogram'
|
|
8271
8308
|
limit:
|
|
8272
8309
|
default: 10
|
|
8273
|
-
description: The maximum buckets to return for this group by
|
|
8310
|
+
description: 'The maximum buckets to return for this group by. Note: at
|
|
8311
|
+
most 10000 buckets are allowed.
|
|
8312
|
+
|
|
8313
|
+
If grouping by multiple facets, the product of limits must not exceed
|
|
8314
|
+
10000.'
|
|
8274
8315
|
format: int64
|
|
8275
8316
|
type: integer
|
|
8276
8317
|
missing:
|
|
@@ -8285,7 +8326,7 @@ components:
|
|
|
8285
8326
|
LogsGroupByHistogram:
|
|
8286
8327
|
description: 'Used to perform a histogram computation (only for measure facets).
|
|
8287
8328
|
|
|
8288
|
-
Note:
|
|
8329
|
+
Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.'
|
|
8289
8330
|
properties:
|
|
8290
8331
|
interval:
|
|
8291
8332
|
description: The bin size of the histogram buckets
|
|
@@ -8663,7 +8704,7 @@ components:
|
|
|
8663
8704
|
LogsQueryOptions:
|
|
8664
8705
|
description: 'Global query options that are used during the query.
|
|
8665
8706
|
|
|
8666
|
-
Note:
|
|
8707
|
+
Note: you should supply either timezone or time offset, but not both. Otherwise,
|
|
8667
8708
|
the query will fail.'
|
|
8668
8709
|
properties:
|
|
8669
8710
|
timeOffset:
|
|
@@ -8707,7 +8748,7 @@ components:
|
|
|
8707
8748
|
properties:
|
|
8708
8749
|
after:
|
|
8709
8750
|
description: 'The cursor to use to get the next results, if any. To make
|
|
8710
|
-
the next request, use the same
|
|
8751
|
+
the next request, use the same
|
|
8711
8752
|
|
|
8712
8753
|
parameters with the addition of the `page[cursor]`.'
|
|
8713
8754
|
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
|
|
@@ -9567,7 +9608,6 @@ components:
|
|
|
9567
9608
|
oneOf:
|
|
9568
9609
|
- $ref: '#/components/schemas/MetricDistinctVolume'
|
|
9569
9610
|
- $ref: '#/components/schemas/MetricIngestedIndexedVolume'
|
|
9570
|
-
type: object
|
|
9571
9611
|
MetricVolumesResponse:
|
|
9572
9612
|
description: Response object which includes a single metric's volume.
|
|
9573
9613
|
properties:
|
|
@@ -9606,7 +9646,6 @@ components:
|
|
|
9606
9646
|
oneOf:
|
|
9607
9647
|
- $ref: '#/components/schemas/Metric'
|
|
9608
9648
|
- $ref: '#/components/schemas/MetricTagConfiguration'
|
|
9609
|
-
type: object
|
|
9610
9649
|
MetricsAndMetricTagConfigurationsResponse:
|
|
9611
9650
|
description: Response object that includes metrics and metric tag configurations.
|
|
9612
9651
|
properties:
|
|
@@ -9749,12 +9788,10 @@ components:
|
|
|
9749
9788
|
description: Configuration for the policy.
|
|
9750
9789
|
oneOf:
|
|
9751
9790
|
- $ref: '#/components/schemas/MonitorConfigPolicyTagPolicy'
|
|
9752
|
-
type: object
|
|
9753
9791
|
MonitorConfigPolicyPolicyCreateRequest:
|
|
9754
9792
|
description: Configuration for the policy.
|
|
9755
9793
|
oneOf:
|
|
9756
9794
|
- $ref: '#/components/schemas/MonitorConfigPolicyTagPolicyCreateRequest'
|
|
9757
|
-
type: object
|
|
9758
9795
|
MonitorConfigPolicyResourceType:
|
|
9759
9796
|
default: monitor-config-policy
|
|
9760
9797
|
description: Monitor configuration policy resource type.
|
|
@@ -10112,6 +10149,8 @@ components:
|
|
|
10112
10149
|
properties:
|
|
10113
10150
|
attributes:
|
|
10114
10151
|
$ref: '#/components/schemas/OnDemandConcurrencyCapAttributes'
|
|
10152
|
+
type:
|
|
10153
|
+
$ref: '#/components/schemas/OnDemandConcurrencyCapType'
|
|
10115
10154
|
type: object
|
|
10116
10155
|
OnDemandConcurrencyCapAttributes:
|
|
10117
10156
|
description: On-demand concurrency cap attributes.
|
|
@@ -10127,6 +10166,13 @@ components:
|
|
|
10127
10166
|
data:
|
|
10128
10167
|
$ref: '#/components/schemas/OnDemandConcurrencyCap'
|
|
10129
10168
|
type: object
|
|
10169
|
+
OnDemandConcurrencyCapType:
|
|
10170
|
+
description: On-demand concurrency cap type.
|
|
10171
|
+
enum:
|
|
10172
|
+
- on_demand_concurrency_cap
|
|
10173
|
+
type: string
|
|
10174
|
+
x-enum-varnames:
|
|
10175
|
+
- ON_DEMAND_CONCURRENCY_CAP
|
|
10130
10176
|
OpsgenieServiceCreateAttributes:
|
|
10131
10177
|
description: The Opsgenie service attributes for a create request.
|
|
10132
10178
|
properties:
|
|
@@ -10430,9 +10476,7 @@ components:
|
|
|
10430
10476
|
example: Application Key for managing dashboards
|
|
10431
10477
|
type: string
|
|
10432
10478
|
scopes:
|
|
10433
|
-
description: Array of scopes to grant the application key.
|
|
10434
|
-
is in private beta, please contact Datadog support to enable scopes for
|
|
10435
|
-
your application keys.
|
|
10479
|
+
description: Array of scopes to grant the application key.
|
|
10436
10480
|
example:
|
|
10437
10481
|
- dashboards_read
|
|
10438
10482
|
- dashboards_write
|
|
@@ -11600,6 +11644,8 @@ components:
|
|
|
11600
11644
|
items:
|
|
11601
11645
|
$ref: '#/components/schemas/RelationshipToTeamLinkData'
|
|
11602
11646
|
type: array
|
|
11647
|
+
links:
|
|
11648
|
+
$ref: '#/components/schemas/TeamRelationshipsLinks'
|
|
11603
11649
|
type: object
|
|
11604
11650
|
RelationshipToUser:
|
|
11605
11651
|
description: Relationship to user.
|
|
@@ -11627,6 +11673,8 @@ components:
|
|
|
11627
11673
|
properties:
|
|
11628
11674
|
data:
|
|
11629
11675
|
$ref: '#/components/schemas/RelationshipToUserTeamPermissionData'
|
|
11676
|
+
links:
|
|
11677
|
+
$ref: '#/components/schemas/TeamRelationshipsLinks'
|
|
11630
11678
|
type: object
|
|
11631
11679
|
RelationshipToUserTeamPermissionData:
|
|
11632
11680
|
description: Related user team permission data
|
|
@@ -12063,7 +12111,6 @@ components:
|
|
|
12063
12111
|
oneOf:
|
|
12064
12112
|
- $ref: '#/components/schemas/GroupScalarColumn'
|
|
12065
12113
|
- $ref: '#/components/schemas/DataScalarColumn'
|
|
12066
|
-
type: object
|
|
12067
12114
|
ScalarFormulaQueryRequest:
|
|
12068
12115
|
description: A wrapper request around one scalar query to be executed.
|
|
12069
12116
|
properties:
|
|
@@ -12172,10 +12219,13 @@ components:
|
|
|
12172
12219
|
type: object
|
|
12173
12220
|
ScalarQuery:
|
|
12174
12221
|
description: An individual scalar query to one of the basic Datadog data sources.
|
|
12222
|
+
example:
|
|
12223
|
+
aggregator: avg
|
|
12224
|
+
data_source: metrics
|
|
12225
|
+
query: avg:system.cpu.user{*} by {env}
|
|
12175
12226
|
oneOf:
|
|
12176
12227
|
- $ref: '#/components/schemas/MetricsScalarQuery'
|
|
12177
12228
|
- $ref: '#/components/schemas/EventsScalarQuery'
|
|
12178
|
-
type: object
|
|
12179
12229
|
ScalarResponse:
|
|
12180
12230
|
description: A message containing the response to a scalar query.
|
|
12181
12231
|
properties:
|
|
@@ -12488,7 +12538,6 @@ components:
|
|
|
12488
12538
|
- $ref: '#/components/schemas/SecurityMonitoringStandardRuleCreatePayload'
|
|
12489
12539
|
- $ref: '#/components/schemas/SecurityMonitoringSignalRuleCreatePayload'
|
|
12490
12540
|
- $ref: '#/components/schemas/CloudConfigurationRuleCreatePayload'
|
|
12491
|
-
type: object
|
|
12492
12541
|
SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv:
|
|
12493
12542
|
description: 'If true, signals in non-production environments have a lower severity
|
|
12494
12543
|
than what is defined by the rule case, which can reduce signal noise.
|
|
@@ -12719,7 +12768,6 @@ components:
|
|
|
12719
12768
|
oneOf:
|
|
12720
12769
|
- $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
|
|
12721
12770
|
- $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
|
|
12722
|
-
type: object
|
|
12723
12771
|
SecurityMonitoringRuleQueryAggregation:
|
|
12724
12772
|
description: The aggregation type.
|
|
12725
12773
|
enum:
|
|
@@ -12746,7 +12794,6 @@ components:
|
|
|
12746
12794
|
oneOf:
|
|
12747
12795
|
- $ref: '#/components/schemas/SecurityMonitoringStandardRuleResponse'
|
|
12748
12796
|
- $ref: '#/components/schemas/SecurityMonitoringSignalRuleResponse'
|
|
12749
|
-
type: object
|
|
12750
12797
|
SecurityMonitoringRuleSeverity:
|
|
12751
12798
|
description: Severity of the Security Signal.
|
|
12752
12799
|
enum:
|
|
@@ -12895,6 +12942,7 @@ components:
|
|
|
12895
12942
|
- data
|
|
12896
12943
|
type: object
|
|
12897
12944
|
SecurityMonitoringSignalAttributes:
|
|
12945
|
+
additionalProperties: {}
|
|
12898
12946
|
description: 'The object containing all signal attributes and their
|
|
12899
12947
|
|
|
12900
12948
|
associated values.'
|
|
@@ -13013,6 +13061,21 @@ components:
|
|
|
13013
13061
|
maximum: 1000
|
|
13014
13062
|
type: integer
|
|
13015
13063
|
type: object
|
|
13064
|
+
SecurityMonitoringSignalMetadataType:
|
|
13065
|
+
default: signal_metadata
|
|
13066
|
+
description: The type of event.
|
|
13067
|
+
enum:
|
|
13068
|
+
- signal_metadata
|
|
13069
|
+
example: signal_metadata
|
|
13070
|
+
type: string
|
|
13071
|
+
x-enum-varnames:
|
|
13072
|
+
- SIGNAL_METADATA
|
|
13073
|
+
SecurityMonitoringSignalResponse:
|
|
13074
|
+
description: Security Signal response data object.
|
|
13075
|
+
properties:
|
|
13076
|
+
data:
|
|
13077
|
+
$ref: '#/components/schemas/SecurityMonitoringSignal'
|
|
13078
|
+
type: object
|
|
13016
13079
|
SecurityMonitoringSignalRuleCreatePayload:
|
|
13017
13080
|
description: Create a new signal correlation rule.
|
|
13018
13081
|
properties:
|
|
@@ -13181,7 +13244,7 @@ components:
|
|
|
13181
13244
|
aggregation:
|
|
13182
13245
|
$ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
|
|
13183
13246
|
correlatedByFields:
|
|
13184
|
-
description: Fields to
|
|
13247
|
+
description: Fields to correlate by.
|
|
13185
13248
|
items:
|
|
13186
13249
|
description: Field.
|
|
13187
13250
|
type: string
|
|
@@ -13195,6 +13258,18 @@ components:
|
|
|
13195
13258
|
description: Default Rule ID to match on signals.
|
|
13196
13259
|
example: d3f-ru1-e1d
|
|
13197
13260
|
type: string
|
|
13261
|
+
distinctFields:
|
|
13262
|
+
description: Field for which the cardinality is measured. Sent as an array.
|
|
13263
|
+
items:
|
|
13264
|
+
description: Field.
|
|
13265
|
+
type: string
|
|
13266
|
+
type: array
|
|
13267
|
+
groupByFields:
|
|
13268
|
+
description: Fields to group by.
|
|
13269
|
+
items:
|
|
13270
|
+
description: Field.
|
|
13271
|
+
type: string
|
|
13272
|
+
type: array
|
|
13198
13273
|
metrics:
|
|
13199
13274
|
description: Group of target fields to aggregate over.
|
|
13200
13275
|
items:
|
|
@@ -13247,6 +13322,10 @@ components:
|
|
|
13247
13322
|
properties:
|
|
13248
13323
|
attributes:
|
|
13249
13324
|
$ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes'
|
|
13325
|
+
id:
|
|
13326
|
+
description: The unique ID of the security signal.
|
|
13327
|
+
type:
|
|
13328
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalMetadataType'
|
|
13250
13329
|
required:
|
|
13251
13330
|
- attributes
|
|
13252
13331
|
type: object
|
|
@@ -13297,6 +13376,11 @@ components:
|
|
|
13297
13376
|
properties:
|
|
13298
13377
|
attributes:
|
|
13299
13378
|
$ref: '#/components/schemas/SecurityMonitoringSignalTriageAttributes'
|
|
13379
|
+
id:
|
|
13380
|
+
description: The unique ID of the security signal.
|
|
13381
|
+
type: string
|
|
13382
|
+
type:
|
|
13383
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalMetadataType'
|
|
13300
13384
|
type: object
|
|
13301
13385
|
SecurityMonitoringSignalTriageUpdateResponse:
|
|
13302
13386
|
description: The response returned after all triage operations, containing the
|
|
@@ -13472,8 +13556,6 @@ components:
|
|
|
13472
13556
|
description: Query to run on logs.
|
|
13473
13557
|
example: a > 3
|
|
13474
13558
|
type: string
|
|
13475
|
-
required:
|
|
13476
|
-
- query
|
|
13477
13559
|
type: object
|
|
13478
13560
|
SecurityMonitoringStandardRuleResponse:
|
|
13479
13561
|
description: Rule.
|
|
@@ -13554,6 +13636,11 @@ components:
|
|
|
13554
13636
|
handle:
|
|
13555
13637
|
description: The handle for this user account.
|
|
13556
13638
|
type: string
|
|
13639
|
+
icon:
|
|
13640
|
+
description: Gravatar icon associated to the user.
|
|
13641
|
+
example: /path/to/matching/gravatar/icon
|
|
13642
|
+
readOnly: true
|
|
13643
|
+
type: string
|
|
13557
13644
|
id:
|
|
13558
13645
|
description: Numerical ID assigned by Datadog to this user account.
|
|
13559
13646
|
format: int64
|
|
@@ -13643,7 +13730,6 @@ components:
|
|
|
13643
13730
|
oneOf:
|
|
13644
13731
|
- $ref: '#/components/schemas/SensitiveDataScannerRuleIncludedItem'
|
|
13645
13732
|
- $ref: '#/components/schemas/SensitiveDataScannerGroupIncludedItem'
|
|
13646
|
-
type: object
|
|
13647
13733
|
SensitiveDataScannerGetConfigResponse:
|
|
13648
13734
|
description: Get all groups response.
|
|
13649
13735
|
properties:
|
|
@@ -13657,6 +13743,10 @@ components:
|
|
|
13657
13743
|
SensitiveDataScannerGetConfigResponseData:
|
|
13658
13744
|
description: Response data related to the scanning groups.
|
|
13659
13745
|
properties:
|
|
13746
|
+
attributes:
|
|
13747
|
+
additionalProperties: {}
|
|
13748
|
+
description: Attributes of the Sensitive Data configuration.
|
|
13749
|
+
type: object
|
|
13660
13750
|
id:
|
|
13661
13751
|
description: ID of the configuration.
|
|
13662
13752
|
type: string
|
|
@@ -13841,6 +13931,9 @@ components:
|
|
|
13841
13931
|
description: Whether or not scanned events are highlighted in Logs or RUM
|
|
13842
13932
|
for the org.
|
|
13843
13933
|
type: boolean
|
|
13934
|
+
has_multi_pass_enabled:
|
|
13935
|
+
description: Whether or not scanned events have multi-pass enabled.
|
|
13936
|
+
type: boolean
|
|
13844
13937
|
is_pci_compliant:
|
|
13845
13938
|
description: Whether or not the org is compliant to the payment card industry
|
|
13846
13939
|
standard.
|
|
@@ -14076,6 +14169,9 @@ components:
|
|
|
14076
14169
|
SensitiveDataScannerStandardPatternAttributes:
|
|
14077
14170
|
description: Attributes of the Sensitive Data Scanner standard pattern.
|
|
14078
14171
|
properties:
|
|
14172
|
+
description:
|
|
14173
|
+
description: Description of the standard pattern.
|
|
14174
|
+
type: string
|
|
14079
14175
|
name:
|
|
14080
14176
|
description: Name of the standard pattern.
|
|
14081
14177
|
type: string
|
|
@@ -14362,6 +14458,7 @@ components:
|
|
|
14362
14458
|
description: "Service owner\u2019s Slack channel."
|
|
14363
14459
|
example: https://yourcompany.slack.com/archives/channel123
|
|
14364
14460
|
type: string
|
|
14461
|
+
type: object
|
|
14365
14462
|
ServiceDefinitionV1Info:
|
|
14366
14463
|
description: Basic information about a service.
|
|
14367
14464
|
properties:
|
|
@@ -15877,6 +15974,17 @@ components:
|
|
|
15877
15974
|
TeamAttributes:
|
|
15878
15975
|
description: Team attributes
|
|
15879
15976
|
properties:
|
|
15977
|
+
avatar:
|
|
15978
|
+
description: Unicode representation of the avatar for the team, limited
|
|
15979
|
+
to a single grapheme
|
|
15980
|
+
example: "\U0001F951"
|
|
15981
|
+
nullable: true
|
|
15982
|
+
type: string
|
|
15983
|
+
banner:
|
|
15984
|
+
description: Banner selection for the team
|
|
15985
|
+
format: int64
|
|
15986
|
+
nullable: true
|
|
15987
|
+
type: integer
|
|
15880
15988
|
created_at:
|
|
15881
15989
|
description: Creation date of the team
|
|
15882
15990
|
format: date-time
|
|
@@ -15890,6 +15998,12 @@ components:
|
|
|
15890
15998
|
example: example-team
|
|
15891
15999
|
maxLength: 195
|
|
15892
16000
|
type: string
|
|
16001
|
+
hidden_modules:
|
|
16002
|
+
description: Collection of hidden modules for the team
|
|
16003
|
+
items:
|
|
16004
|
+
description: String identifier of the module
|
|
16005
|
+
type: string
|
|
16006
|
+
type: array
|
|
15893
16007
|
link_count:
|
|
15894
16008
|
description: The number of links belonging to the team
|
|
15895
16009
|
format: int32
|
|
@@ -15916,6 +16030,12 @@ components:
|
|
|
15916
16030
|
maximum: 2147483647
|
|
15917
16031
|
readOnly: true
|
|
15918
16032
|
type: integer
|
|
16033
|
+
visible_modules:
|
|
16034
|
+
description: Collection of visible modules for the team
|
|
16035
|
+
items:
|
|
16036
|
+
description: String identifier of the module
|
|
16037
|
+
type: string
|
|
16038
|
+
type: array
|
|
15919
16039
|
required:
|
|
15920
16040
|
- handle
|
|
15921
16041
|
- name
|
|
@@ -15936,6 +16056,17 @@ components:
|
|
|
15936
16056
|
TeamCreateAttributes:
|
|
15937
16057
|
description: Team creation attributes
|
|
15938
16058
|
properties:
|
|
16059
|
+
avatar:
|
|
16060
|
+
description: Unicode representation of the avatar for the team, limited
|
|
16061
|
+
to a single grapheme
|
|
16062
|
+
example: "\U0001F951"
|
|
16063
|
+
nullable: true
|
|
16064
|
+
type: string
|
|
16065
|
+
banner:
|
|
16066
|
+
description: Banner selection for the team
|
|
16067
|
+
format: int64
|
|
16068
|
+
nullable: true
|
|
16069
|
+
type: integer
|
|
15939
16070
|
description:
|
|
15940
16071
|
description: Free-form markdown description/content for the team's homepage
|
|
15941
16072
|
type: string
|
|
@@ -15944,11 +16075,23 @@ components:
|
|
|
15944
16075
|
example: example-team
|
|
15945
16076
|
maxLength: 195
|
|
15946
16077
|
type: string
|
|
16078
|
+
hidden_modules:
|
|
16079
|
+
description: Collection of hidden modules for the team
|
|
16080
|
+
items:
|
|
16081
|
+
description: String identifier of the module
|
|
16082
|
+
type: string
|
|
16083
|
+
type: array
|
|
15947
16084
|
name:
|
|
15948
16085
|
description: The name of the team
|
|
15949
16086
|
example: Example Team
|
|
15950
16087
|
maxLength: 200
|
|
15951
16088
|
type: string
|
|
16089
|
+
visible_modules:
|
|
16090
|
+
description: Collection of visible modules for the team
|
|
16091
|
+
items:
|
|
16092
|
+
description: String identifier of the module
|
|
16093
|
+
type: string
|
|
16094
|
+
type: array
|
|
15952
16095
|
required:
|
|
15953
16096
|
- handle
|
|
15954
16097
|
- name
|
|
@@ -15967,30 +16110,12 @@ components:
|
|
|
15967
16110
|
required:
|
|
15968
16111
|
- data
|
|
15969
16112
|
type: object
|
|
15970
|
-
TeamData:
|
|
15971
|
-
description: A team
|
|
15972
|
-
properties:
|
|
15973
|
-
attributes:
|
|
15974
|
-
$ref: '#/components/schemas/TeamAttributes'
|
|
15975
|
-
id:
|
|
15976
|
-
description: The team's identifier
|
|
15977
|
-
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
|
|
15978
|
-
type: string
|
|
15979
|
-
type:
|
|
15980
|
-
$ref: '#/components/schemas/TeamType'
|
|
15981
|
-
required:
|
|
15982
|
-
- attributes
|
|
15983
|
-
- id
|
|
15984
|
-
- type
|
|
15985
|
-
type: object
|
|
15986
16113
|
TeamIncluded:
|
|
15987
16114
|
description: Included resources related to the team
|
|
15988
16115
|
oneOf:
|
|
15989
16116
|
- $ref: '#/components/schemas/User'
|
|
15990
16117
|
- $ref: '#/components/schemas/TeamLink'
|
|
15991
16118
|
- $ref: '#/components/schemas/UserTeamPermission'
|
|
15992
|
-
properties: {}
|
|
15993
|
-
type: object
|
|
15994
16119
|
TeamLink:
|
|
15995
16120
|
description: Team link
|
|
15996
16121
|
properties:
|
|
@@ -16196,11 +16321,19 @@ components:
|
|
|
16196
16321
|
user_team_permissions:
|
|
16197
16322
|
$ref: '#/components/schemas/RelationshipToUserTeamPermission'
|
|
16198
16323
|
type: object
|
|
16324
|
+
TeamRelationshipsLinks:
|
|
16325
|
+
description: Links attributes.
|
|
16326
|
+
properties:
|
|
16327
|
+
related:
|
|
16328
|
+
description: Related link.
|
|
16329
|
+
example: /api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links
|
|
16330
|
+
type: string
|
|
16331
|
+
type: object
|
|
16199
16332
|
TeamResponse:
|
|
16200
16333
|
description: Response with a team
|
|
16201
16334
|
properties:
|
|
16202
16335
|
data:
|
|
16203
|
-
$ref: '#/components/schemas/
|
|
16336
|
+
$ref: '#/components/schemas/Team'
|
|
16204
16337
|
type: object
|
|
16205
16338
|
TeamType:
|
|
16206
16339
|
default: team
|
|
@@ -16227,6 +16360,17 @@ components:
|
|
|
16227
16360
|
TeamUpdateAttributes:
|
|
16228
16361
|
description: Team update attributes
|
|
16229
16362
|
properties:
|
|
16363
|
+
avatar:
|
|
16364
|
+
description: Unicode representation of the avatar for the team, limited
|
|
16365
|
+
to a single grapheme
|
|
16366
|
+
example: "\U0001F951"
|
|
16367
|
+
nullable: true
|
|
16368
|
+
type: string
|
|
16369
|
+
banner:
|
|
16370
|
+
description: Banner selection for the team
|
|
16371
|
+
format: int64
|
|
16372
|
+
nullable: true
|
|
16373
|
+
type: integer
|
|
16230
16374
|
color:
|
|
16231
16375
|
description: An identifier for the color representing the team
|
|
16232
16376
|
format: int32
|
|
@@ -16241,11 +16385,23 @@ components:
|
|
|
16241
16385
|
example: example-team
|
|
16242
16386
|
maxLength: 195
|
|
16243
16387
|
type: string
|
|
16388
|
+
hidden_modules:
|
|
16389
|
+
description: Collection of hidden modules for the team
|
|
16390
|
+
items:
|
|
16391
|
+
description: String identifier of the module
|
|
16392
|
+
type: string
|
|
16393
|
+
type: array
|
|
16244
16394
|
name:
|
|
16245
16395
|
description: The name of the team
|
|
16246
16396
|
example: Example Team
|
|
16247
16397
|
maxLength: 200
|
|
16248
16398
|
type: string
|
|
16399
|
+
visible_modules:
|
|
16400
|
+
description: Collection of visible modules for the team
|
|
16401
|
+
items:
|
|
16402
|
+
description: String identifier of the module
|
|
16403
|
+
type: string
|
|
16404
|
+
type: array
|
|
16249
16405
|
required:
|
|
16250
16406
|
- handle
|
|
16251
16407
|
- name
|
|
@@ -16277,6 +16433,72 @@ components:
|
|
|
16277
16433
|
items:
|
|
16278
16434
|
$ref: '#/components/schemas/TeamIncluded'
|
|
16279
16435
|
type: array
|
|
16436
|
+
links:
|
|
16437
|
+
$ref: '#/components/schemas/TeamsResponseLinks'
|
|
16438
|
+
meta:
|
|
16439
|
+
$ref: '#/components/schemas/TeamsResponseMeta'
|
|
16440
|
+
type: object
|
|
16441
|
+
TeamsResponseLinks:
|
|
16442
|
+
description: Teams response links.
|
|
16443
|
+
properties:
|
|
16444
|
+
first:
|
|
16445
|
+
description: First link.
|
|
16446
|
+
type: string
|
|
16447
|
+
last:
|
|
16448
|
+
description: Last link.
|
|
16449
|
+
nullable: true
|
|
16450
|
+
type: string
|
|
16451
|
+
next:
|
|
16452
|
+
description: Next link.
|
|
16453
|
+
type: string
|
|
16454
|
+
prev:
|
|
16455
|
+
description: Previous link.
|
|
16456
|
+
nullable: true
|
|
16457
|
+
type: string
|
|
16458
|
+
self:
|
|
16459
|
+
description: Current link.
|
|
16460
|
+
type: string
|
|
16461
|
+
type: object
|
|
16462
|
+
TeamsResponseMeta:
|
|
16463
|
+
description: Teams response metadata.
|
|
16464
|
+
properties:
|
|
16465
|
+
pagination:
|
|
16466
|
+
$ref: '#/components/schemas/TeamsResponseMetaPagination'
|
|
16467
|
+
type: object
|
|
16468
|
+
TeamsResponseMetaPagination:
|
|
16469
|
+
description: Teams response metadata.
|
|
16470
|
+
properties:
|
|
16471
|
+
first_offset:
|
|
16472
|
+
description: The first offset.
|
|
16473
|
+
format: int64
|
|
16474
|
+
type: integer
|
|
16475
|
+
last_offset:
|
|
16476
|
+
description: The last offset.
|
|
16477
|
+
format: int64
|
|
16478
|
+
type: integer
|
|
16479
|
+
limit:
|
|
16480
|
+
description: Pagination limit.
|
|
16481
|
+
format: int64
|
|
16482
|
+
type: integer
|
|
16483
|
+
next_offset:
|
|
16484
|
+
description: The next offset.
|
|
16485
|
+
format: int64
|
|
16486
|
+
type: integer
|
|
16487
|
+
offset:
|
|
16488
|
+
description: The offset.
|
|
16489
|
+
format: int64
|
|
16490
|
+
type: integer
|
|
16491
|
+
prev_offset:
|
|
16492
|
+
description: The previous offset.
|
|
16493
|
+
format: int64
|
|
16494
|
+
type: integer
|
|
16495
|
+
total:
|
|
16496
|
+
description: Total results.
|
|
16497
|
+
format: int64
|
|
16498
|
+
type: integer
|
|
16499
|
+
type:
|
|
16500
|
+
description: Offset type.
|
|
16501
|
+
type: string
|
|
16280
16502
|
type: object
|
|
16281
16503
|
TimeseriesFormulaQueryRequest:
|
|
16282
16504
|
description: A request wrapper around a single timeseries query to be executed.
|
|
@@ -16371,10 +16593,12 @@ components:
|
|
|
16371
16593
|
TimeseriesQuery:
|
|
16372
16594
|
description: An individual timeseries query to one of the basic Datadog data
|
|
16373
16595
|
sources.
|
|
16596
|
+
example:
|
|
16597
|
+
data_source: metrics
|
|
16598
|
+
query: avg:system.cpu.user{*} by {env}
|
|
16374
16599
|
oneOf:
|
|
16375
16600
|
- $ref: '#/components/schemas/MetricsTimeseriesQuery'
|
|
16376
16601
|
- $ref: '#/components/schemas/EventsTimeseriesQuery'
|
|
16377
|
-
type: object
|
|
16378
16602
|
TimeseriesResponse:
|
|
16379
16603
|
description: A message containing the response to a timeseries query.
|
|
16380
16604
|
properties:
|
|
@@ -16451,11 +16675,6 @@ components:
|
|
|
16451
16675
|
items:
|
|
16452
16676
|
$ref: '#/components/schemas/TimeseriesResponseValues'
|
|
16453
16677
|
type: array
|
|
16454
|
-
TimestampEventAttribute:
|
|
16455
|
-
description: Timestamp of your event.
|
|
16456
|
-
example: '2019-01-02T09:42:36.320Z'
|
|
16457
|
-
format: date-time
|
|
16458
|
-
type: string
|
|
16459
16678
|
Unit:
|
|
16460
16679
|
description: Object containing the metric unit family, scale factor, name, and
|
|
16461
16680
|
short name.
|
|
@@ -16505,6 +16724,10 @@ components:
|
|
|
16505
16724
|
public_id:
|
|
16506
16725
|
description: The organization public ID.
|
|
16507
16726
|
type: string
|
|
16727
|
+
region:
|
|
16728
|
+
description: The region of the Datadog instance that the organization belongs
|
|
16729
|
+
to.
|
|
16730
|
+
type: string
|
|
16508
16731
|
timeseries:
|
|
16509
16732
|
description: List of usage data reported for each requested hour.
|
|
16510
16733
|
items:
|
|
@@ -16765,7 +16988,6 @@ components:
|
|
|
16765
16988
|
- $ref: '#/components/schemas/Organization'
|
|
16766
16989
|
- $ref: '#/components/schemas/Permission'
|
|
16767
16990
|
- $ref: '#/components/schemas/Role'
|
|
16768
|
-
type: object
|
|
16769
16991
|
UserResponseRelationships:
|
|
16770
16992
|
description: Relationships of the user object returned by the API.
|
|
16771
16993
|
properties:
|
|
@@ -16918,6 +17140,10 @@ components:
|
|
|
16918
17140
|
items:
|
|
16919
17141
|
$ref: '#/components/schemas/UserTeam'
|
|
16920
17142
|
type: array
|
|
17143
|
+
links:
|
|
17144
|
+
$ref: '#/components/schemas/TeamsResponseLinks'
|
|
17145
|
+
meta:
|
|
17146
|
+
$ref: '#/components/schemas/TeamsResponseMeta'
|
|
16921
17147
|
type: object
|
|
16922
17148
|
UserUpdateAttributes:
|
|
16923
17149
|
description: Attributes of the edited user.
|
|
@@ -16992,36 +17218,51 @@ components:
|
|
|
16992
17218
|
apm_service_catalog_read: View service catalog and service definitions.
|
|
16993
17219
|
apm_service_catalog_write: Add, modify, and delete service catalog definitions
|
|
16994
17220
|
when those definitions are maintained by Datadog.
|
|
17221
|
+
create_webhooks: Create webhooks integrations.
|
|
17222
|
+
dashboards_public_share: Generate public and authenticated links to share
|
|
17223
|
+
dashboards or embeddable graphs externally.
|
|
16995
17224
|
dashboards_read: View dashboards.
|
|
16996
17225
|
dashboards_write: Create and change dashboards.
|
|
16997
17226
|
events_read: Read Events data.
|
|
17227
|
+
incident_notification_settings_write: Configure Incidents Notification
|
|
17228
|
+
settings.
|
|
16998
17229
|
incident_read: View incidents in Datadog.
|
|
16999
|
-
incident_settings_write: Configure
|
|
17230
|
+
incident_settings_write: Configure Incident Settings.
|
|
17000
17231
|
incident_write: Create, view, and manage incidents in Datadog.
|
|
17001
|
-
metric_tags_write: Create and edit tag configurations for custom metrics.
|
|
17002
17232
|
metrics_read: View custom metrics.
|
|
17003
17233
|
monitors_downtime: Set downtimes to suppress alerts from any monitor in
|
|
17004
|
-
an organization. The ability to write monitors
|
|
17005
|
-
downtimes.
|
|
17234
|
+
an organization. Mute and unmute hosts. The ability to write monitors
|
|
17235
|
+
is not required to set downtimes.
|
|
17006
17236
|
monitors_read: View monitors.
|
|
17007
|
-
|
|
17008
|
-
and certain security preferences.
|
|
17237
|
+
monitors_write: Edit, mute, and delete individual monitors.
|
|
17009
17238
|
security_monitoring_filters_read: Read Security Filters.
|
|
17010
17239
|
security_monitoring_filters_write: Create, edit, and delete Security Filters.
|
|
17011
17240
|
security_monitoring_findings_read: View CSPM Findings.
|
|
17012
|
-
security_monitoring_findings_write: Mute CSPM Findings.
|
|
17013
17241
|
security_monitoring_rules_read: Read Detection Rules.
|
|
17014
17242
|
security_monitoring_rules_write: Create and edit Detection Rules.
|
|
17015
17243
|
security_monitoring_signals_read: View Security Signals.
|
|
17016
|
-
|
|
17017
|
-
|
|
17018
|
-
|
|
17019
|
-
|
|
17020
|
-
|
|
17244
|
+
security_monitoring_suppressions_read: Read Rule Suppressions.
|
|
17245
|
+
security_monitoring_suppressions_write: Write Rule Suppressions.
|
|
17246
|
+
slos_corrections: Apply, edit, and delete SLO status corrections. A user
|
|
17247
|
+
with this permission can make status corrections, even if they do not
|
|
17248
|
+
have permission to edit those SLOs.
|
|
17249
|
+
slos_read: View SLOs and status corrections.
|
|
17250
|
+
slos_write: Create, edit, and delete SLOs.
|
|
17251
|
+
synthetics_global_variable_read: View, search, and use Synthetics global
|
|
17252
|
+
variables.
|
|
17253
|
+
synthetics_global_variable_write: Create, edit, and delete global variables
|
|
17254
|
+
for Synthetics.
|
|
17255
|
+
synthetics_private_location_read: View, search, and use Synthetics private
|
|
17256
|
+
locations.
|
|
17257
|
+
synthetics_private_location_write: Create and delete private locations
|
|
17258
|
+
in addition to having access to the associated installation guidelines.
|
|
17259
|
+
synthetics_read: List and view configured Synthetic tests and test results.
|
|
17260
|
+
synthetics_write: Create, edit, and delete Synthetic tests.
|
|
17261
|
+
teams_manage: Manage Teams. Create, delete, rename, and edit metadata
|
|
17021
17262
|
of all Teams. To control Team membership across all Teams, use the User
|
|
17022
17263
|
Access Manage permission.
|
|
17023
|
-
teams_read: Read Teams data.
|
|
17024
|
-
are on each Team.
|
|
17264
|
+
teams_read: Read Teams data. A User with this permission can view Team
|
|
17265
|
+
names, metadata, and which Users are on each Team.
|
|
17025
17266
|
timeseries_query: Query Timeseries data.
|
|
17026
17267
|
usage_read: View your organization's usage and usage attribution.
|
|
17027
17268
|
user_access_invite: Invite other users to your organization.
|
|
@@ -17237,10 +17478,6 @@ paths:
|
|
|
17237
17478
|
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
17238
17479
|
'429':
|
|
17239
17480
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
17240
|
-
security:
|
|
17241
|
-
- apiKeyAuth: []
|
|
17242
|
-
appKeyAuth: []
|
|
17243
|
-
- AuthZ: []
|
|
17244
17481
|
summary: Get all span-based metrics
|
|
17245
17482
|
tags:
|
|
17246
17483
|
- Spans Metrics
|
|
@@ -17312,10 +17549,6 @@ paths:
|
|
|
17312
17549
|
$ref: '#/components/responses/NotFoundResponse'
|
|
17313
17550
|
'429':
|
|
17314
17551
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
17315
|
-
security:
|
|
17316
|
-
- apiKeyAuth: []
|
|
17317
|
-
appKeyAuth: []
|
|
17318
|
-
- AuthZ: []
|
|
17319
17552
|
summary: Get a span-based metric
|
|
17320
17553
|
tags:
|
|
17321
17554
|
- Spans Metrics
|
|
@@ -17839,14 +18072,11 @@ paths:
|
|
|
17839
18072
|
post:
|
|
17840
18073
|
description: 'Send your pipeline event to your Datadog platform over HTTP. For
|
|
17841
18074
|
details about how pipeline executions are modeled and what execution types
|
|
17842
|
-
we support, see
|
|
18075
|
+
we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/).
|
|
17843
18076
|
|
|
17844
18077
|
|
|
17845
18078
|
Pipeline events can be submitted with a timestamp that is up to 18 hours in
|
|
17846
|
-
the past.
|
|
17847
|
-
|
|
17848
|
-
|
|
17849
|
-
This API endpoint is in private beta.'
|
|
18079
|
+
the past.'
|
|
17850
18080
|
operationId: CreateCIAppPipelineEvent
|
|
17851
18081
|
requestBody:
|
|
17852
18082
|
content:
|
|
@@ -17913,10 +18143,12 @@ paths:
|
|
|
17913
18143
|
tags:
|
|
17914
18144
|
- CI Visibility Pipelines
|
|
17915
18145
|
x-codegen-request-body-name: body
|
|
18146
|
+
x-unstable: '**Note**: This API endpoint is in private beta. Request access
|
|
18147
|
+
[here](https://docs.google.com/forms/d/e/1FAIpQLSdNejCvhMbdBW5nnGly1yvmYMn2Wpj4JOI0zKIiEx6O6I2dbQ/viewform).'
|
|
17916
18148
|
/api/v2/ci/pipelines/analytics/aggregate:
|
|
17917
18149
|
post:
|
|
17918
|
-
description:
|
|
17919
|
-
buckets of computed metrics and timeseries.
|
|
18150
|
+
description: Use this API endpoint to aggregate CI Visibility pipeline events
|
|
18151
|
+
into buckets of computed metrics and timeseries.
|
|
17920
18152
|
operationId: AggregateCIAppPipelineEvents
|
|
17921
18153
|
requestBody:
|
|
17922
18154
|
content:
|
|
@@ -17944,7 +18176,7 @@ paths:
|
|
|
17944
18176
|
/api/v2/ci/pipelines/events:
|
|
17945
18177
|
get:
|
|
17946
18178
|
description: 'List endpoint returns CI Visibility pipeline events that match
|
|
17947
|
-
a [
|
|
18179
|
+
a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
|
17948
18180
|
|
|
17949
18181
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
17950
18182
|
|
|
@@ -18023,7 +18255,7 @@ paths:
|
|
|
18023
18255
|
/api/v2/ci/pipelines/events/search:
|
|
18024
18256
|
post:
|
|
18025
18257
|
description: 'List endpoint returns CI Visibility pipeline events that match
|
|
18026
|
-
a [
|
|
18258
|
+
a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
|
|
18027
18259
|
|
|
18028
18260
|
[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).
|
|
18029
18261
|
|
|
@@ -18584,6 +18816,16 @@ paths:
|
|
|
18584
18816
|
schema:
|
|
18585
18817
|
example: created_by,monitor
|
|
18586
18818
|
type: string
|
|
18819
|
+
- $ref: '#/components/parameters/PageOffset'
|
|
18820
|
+
- description: Maximum number of downtimes in the response.
|
|
18821
|
+
example: 100
|
|
18822
|
+
in: query
|
|
18823
|
+
name: page[limit]
|
|
18824
|
+
required: false
|
|
18825
|
+
schema:
|
|
18826
|
+
default: 30
|
|
18827
|
+
format: int64
|
|
18828
|
+
type: integer
|
|
18587
18829
|
responses:
|
|
18588
18830
|
'200':
|
|
18589
18831
|
content:
|
|
@@ -18603,13 +18845,14 @@ paths:
|
|
|
18603
18845
|
- apiKeyAuth: []
|
|
18604
18846
|
appKeyAuth: []
|
|
18605
18847
|
- AuthZ:
|
|
18606
|
-
-
|
|
18848
|
+
- monitors_downtime
|
|
18607
18849
|
summary: Get all downtimes
|
|
18608
18850
|
tags:
|
|
18609
18851
|
- Downtimes
|
|
18610
|
-
x-
|
|
18611
|
-
|
|
18612
|
-
|
|
18852
|
+
x-pagination:
|
|
18853
|
+
limitParam: page[limit]
|
|
18854
|
+
pageOffsetParam: page[offset]
|
|
18855
|
+
resultsPath: data
|
|
18613
18856
|
post:
|
|
18614
18857
|
description: Schedule a downtime.
|
|
18615
18858
|
operationId: CreateDowntime
|
|
@@ -18650,9 +18893,6 @@ paths:
|
|
|
18650
18893
|
tags:
|
|
18651
18894
|
- Downtimes
|
|
18652
18895
|
x-codegen-request-body-name: body
|
|
18653
|
-
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18654
|
-
|
|
18655
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18656
18896
|
/api/v2/downtime/{downtime_id}:
|
|
18657
18897
|
delete:
|
|
18658
18898
|
description: Cancel a downtime.
|
|
@@ -18690,9 +18930,6 @@ paths:
|
|
|
18690
18930
|
summary: Cancel a downtime
|
|
18691
18931
|
tags:
|
|
18692
18932
|
- Downtimes
|
|
18693
|
-
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18694
|
-
|
|
18695
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18696
18933
|
get:
|
|
18697
18934
|
description: Get downtime detail by `downtime_id`.
|
|
18698
18935
|
operationId: GetDowntime
|
|
@@ -18749,9 +18986,6 @@ paths:
|
|
|
18749
18986
|
summary: Get a downtime
|
|
18750
18987
|
tags:
|
|
18751
18988
|
- Downtimes
|
|
18752
|
-
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18753
|
-
|
|
18754
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18755
18989
|
patch:
|
|
18756
18990
|
description: Update a downtime by `downtime_id`.
|
|
18757
18991
|
operationId: UpdateDowntime
|
|
@@ -18806,9 +19040,6 @@ paths:
|
|
|
18806
19040
|
tags:
|
|
18807
19041
|
- Downtimes
|
|
18808
19042
|
x-codegen-request-body-name: body
|
|
18809
|
-
x-unstable: '**Note**: This endpoint is in private beta.
|
|
18810
|
-
|
|
18811
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
18812
19043
|
/api/v2/events:
|
|
18813
19044
|
get:
|
|
18814
19045
|
description: 'List endpoint returns events that match an events search query.
|
|
@@ -20549,11 +20780,6 @@ paths:
|
|
|
20549
20780
|
$ref: '#/components/responses/NotFoundResponse'
|
|
20550
20781
|
'429':
|
|
20551
20782
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
20552
|
-
security:
|
|
20553
|
-
- apiKeyAuth: []
|
|
20554
|
-
appKeyAuth: []
|
|
20555
|
-
- AuthZ:
|
|
20556
|
-
- org_management
|
|
20557
20783
|
summary: Get IP Allowlist
|
|
20558
20784
|
tags:
|
|
20559
20785
|
- IP Allowlist
|
|
@@ -20581,11 +20807,6 @@ paths:
|
|
|
20581
20807
|
$ref: '#/components/responses/NotFoundResponse'
|
|
20582
20808
|
'429':
|
|
20583
20809
|
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
20584
|
-
security:
|
|
20585
|
-
- apiKeyAuth: []
|
|
20586
|
-
appKeyAuth: []
|
|
20587
|
-
- AuthZ:
|
|
20588
|
-
- org_management
|
|
20589
20810
|
summary: Update IP Allowlist
|
|
20590
20811
|
tags:
|
|
20591
20812
|
- IP Allowlist
|
|
@@ -21573,7 +21794,7 @@ paths:
|
|
|
21573
21794
|
- description: 'The number of seconds of look back (from now) to apply to a
|
|
21574
21795
|
filter[tag] or filter[queried] query.
|
|
21575
21796
|
|
|
21576
|
-
|
|
21797
|
+
Default value is 3600 (1 hour), maximum value is 2,592,000 (30 days).'
|
|
21577
21798
|
example: 3600
|
|
21578
21799
|
in: query
|
|
21579
21800
|
name: window[seconds]
|
|
@@ -21824,7 +22045,8 @@ paths:
|
|
|
21824
22045
|
security:
|
|
21825
22046
|
- apiKeyAuth: []
|
|
21826
22047
|
appKeyAuth: []
|
|
21827
|
-
- AuthZ:
|
|
22048
|
+
- AuthZ:
|
|
22049
|
+
- metrics_read
|
|
21828
22050
|
summary: List tags by metric name
|
|
21829
22051
|
tags:
|
|
21830
22052
|
- Metrics
|
|
@@ -22377,14 +22599,11 @@ paths:
|
|
|
22377
22599
|
- apiKeyAuth: []
|
|
22378
22600
|
appKeyAuth: []
|
|
22379
22601
|
- AuthZ:
|
|
22380
|
-
-
|
|
22602
|
+
- monitors_downtime
|
|
22381
22603
|
summary: Get active downtimes for a monitor
|
|
22382
22604
|
tags:
|
|
22383
22605
|
- Downtimes
|
|
22384
22606
|
x-codegen-request-body-name: body
|
|
22385
|
-
x-unstable: '**Note**: This endpoint is in private beta.
|
|
22386
|
-
|
|
22387
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
22388
22607
|
/api/v2/permissions:
|
|
22389
22608
|
get:
|
|
22390
22609
|
description: Returns a list of all permissions, including name, description,
|
|
@@ -22414,7 +22633,8 @@ paths:
|
|
|
22414
22633
|
security:
|
|
22415
22634
|
- apiKeyAuth: []
|
|
22416
22635
|
appKeyAuth: []
|
|
22417
|
-
- AuthZ:
|
|
22636
|
+
- AuthZ:
|
|
22637
|
+
- user_access_read
|
|
22418
22638
|
summary: List permissions
|
|
22419
22639
|
tags:
|
|
22420
22640
|
- Roles
|
|
@@ -22669,8 +22889,6 @@ paths:
|
|
|
22669
22889
|
security:
|
|
22670
22890
|
- apiKeyAuth: []
|
|
22671
22891
|
appKeyAuth: []
|
|
22672
|
-
- AuthZ:
|
|
22673
|
-
- security_monitoring_findings_write
|
|
22674
22892
|
summary: Mute or unmute a finding
|
|
22675
22893
|
tags:
|
|
22676
22894
|
- Security Monitoring
|
|
@@ -22851,8 +23069,6 @@ paths:
|
|
|
22851
23069
|
appKeyAuth: []
|
|
22852
23070
|
- AuthZ:
|
|
22853
23071
|
- timeseries_query
|
|
22854
|
-
- metrics_read
|
|
22855
|
-
- metric_tags_write
|
|
22856
23072
|
summary: Query timeseries data across multiple products
|
|
22857
23073
|
tags:
|
|
22858
23074
|
- Metrics
|
|
@@ -23016,7 +23232,8 @@ paths:
|
|
|
23016
23232
|
security:
|
|
23017
23233
|
- apiKeyAuth: []
|
|
23018
23234
|
appKeyAuth: []
|
|
23019
|
-
- AuthZ:
|
|
23235
|
+
- AuthZ:
|
|
23236
|
+
- user_access_read
|
|
23020
23237
|
summary: List roles
|
|
23021
23238
|
tags:
|
|
23022
23239
|
- Roles
|
|
@@ -23120,7 +23337,8 @@ paths:
|
|
|
23120
23337
|
security:
|
|
23121
23338
|
- apiKeyAuth: []
|
|
23122
23339
|
appKeyAuth: []
|
|
23123
|
-
- AuthZ:
|
|
23340
|
+
- AuthZ:
|
|
23341
|
+
- user_access_read
|
|
23124
23342
|
summary: Get a role
|
|
23125
23343
|
tags:
|
|
23126
23344
|
- Roles
|
|
@@ -23311,7 +23529,8 @@ paths:
|
|
|
23311
23529
|
security:
|
|
23312
23530
|
- apiKeyAuth: []
|
|
23313
23531
|
appKeyAuth: []
|
|
23314
|
-
- AuthZ:
|
|
23532
|
+
- AuthZ:
|
|
23533
|
+
- user_access_read
|
|
23315
23534
|
summary: List permissions for a role
|
|
23316
23535
|
tags:
|
|
23317
23536
|
- Roles
|
|
@@ -23460,7 +23679,8 @@ paths:
|
|
|
23460
23679
|
security:
|
|
23461
23680
|
- apiKeyAuth: []
|
|
23462
23681
|
appKeyAuth: []
|
|
23463
|
-
- AuthZ:
|
|
23682
|
+
- AuthZ:
|
|
23683
|
+
- user_access_read
|
|
23464
23684
|
summary: Get all users of a role
|
|
23465
23685
|
tags:
|
|
23466
23686
|
- Roles
|
|
@@ -24416,7 +24636,7 @@ paths:
|
|
|
24416
24636
|
content:
|
|
24417
24637
|
application/json:
|
|
24418
24638
|
schema:
|
|
24419
|
-
$ref: '#/components/schemas/
|
|
24639
|
+
$ref: '#/components/schemas/SecurityMonitoringSignalResponse'
|
|
24420
24640
|
description: OK
|
|
24421
24641
|
'404':
|
|
24422
24642
|
$ref: '#/components/responses/NotFoundResponse'
|
|
@@ -25752,6 +25972,10 @@ paths:
|
|
|
25752
25972
|
summary: Get all teams
|
|
25753
25973
|
tags:
|
|
25754
25974
|
- Teams
|
|
25975
|
+
x-pagination:
|
|
25976
|
+
limitParam: page[size]
|
|
25977
|
+
pageParam: page[number]
|
|
25978
|
+
resultsPath: data
|
|
25755
25979
|
post:
|
|
25756
25980
|
description: 'Create a new team.
|
|
25757
25981
|
|
|
@@ -26858,8 +27082,8 @@ paths:
|
|
|
26858
27082
|
`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`,
|
|
26859
27083
|
`sds`, `snmp`,
|
|
26860
27084
|
|
|
26861
|
-
`synthetics_api`, `synthetics_browser`, `synthetics_parallel_testing`,
|
|
26862
|
-
`timeseries`.
|
|
27085
|
+
`synthetics_api`, `synthetics_browser`, `synthetics_mobile`, `synthetics_parallel_testing`,
|
|
27086
|
+
and `timeseries`.
|
|
26863
27087
|
|
|
26864
27088
|
The following product family has been **deprecated**: `audit_logs`.'
|
|
26865
27089
|
in: query
|
|
@@ -27222,6 +27446,10 @@ paths:
|
|
|
27222
27446
|
tags:
|
|
27223
27447
|
- Users
|
|
27224
27448
|
x-codegen-request-body-name: body
|
|
27449
|
+
x-pagination:
|
|
27450
|
+
limitParam: page[size]
|
|
27451
|
+
pageParam: page[number]
|
|
27452
|
+
resultsPath: data
|
|
27225
27453
|
post:
|
|
27226
27454
|
description: Create a user for your organization.
|
|
27227
27455
|
operationId: CreateUser
|
|
@@ -27460,6 +27688,40 @@ paths:
|
|
|
27460
27688
|
tags:
|
|
27461
27689
|
- Users
|
|
27462
27690
|
x-codegen-request-body-name: body
|
|
27691
|
+
/api/v2/users/{user_uuid}/memberships:
|
|
27692
|
+
get:
|
|
27693
|
+
description: Get a list of memberships for a user
|
|
27694
|
+
operationId: GetUserMemberships
|
|
27695
|
+
parameters:
|
|
27696
|
+
- description: None
|
|
27697
|
+
in: path
|
|
27698
|
+
name: user_uuid
|
|
27699
|
+
required: true
|
|
27700
|
+
schema:
|
|
27701
|
+
type: string
|
|
27702
|
+
responses:
|
|
27703
|
+
'200':
|
|
27704
|
+
content:
|
|
27705
|
+
application/json:
|
|
27706
|
+
schema:
|
|
27707
|
+
$ref: '#/components/schemas/UserTeamsResponse'
|
|
27708
|
+
description: Represents a user's association to a team
|
|
27709
|
+
'404':
|
|
27710
|
+
content:
|
|
27711
|
+
application/json:
|
|
27712
|
+
schema:
|
|
27713
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
27714
|
+
description: API error response.
|
|
27715
|
+
'429':
|
|
27716
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
27717
|
+
security:
|
|
27718
|
+
- apiKeyAuth: []
|
|
27719
|
+
appKeyAuth: []
|
|
27720
|
+
- AuthZ:
|
|
27721
|
+
- teams_read
|
|
27722
|
+
summary: Get user memberships
|
|
27723
|
+
tags:
|
|
27724
|
+
- Teams
|
|
27463
27725
|
security:
|
|
27464
27726
|
- apiKeyAuth: []
|
|
27465
27727
|
appKeyAuth: []
|