datadog_api_client 2.26.1 → 2.27.1

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.
Files changed (125) hide show
  1. checksums.yaml +4 -4
  2. data/.apigentools-info +4 -4
  3. data/.generator/schemas/v1/openapi.yaml +2152 -10
  4. data/.generator/schemas/v2/openapi.yaml +1771 -41
  5. data/.generator/src/generator/formatter.py +1 -1
  6. data/.github/workflows/approved_status.yml +4 -0
  7. data/.github/workflows/changelog.yml +5 -0
  8. data/.github/workflows/codeql-analysis.yml +4 -0
  9. data/.github/workflows/docs.yml +3 -0
  10. data/.github/workflows/labeler.yml +5 -0
  11. data/.github/workflows/prepare_release.yml +4 -0
  12. data/.github/workflows/publish.yml +5 -0
  13. data/.github/workflows/release.yml +4 -0
  14. data/.github/workflows/stale.yml +6 -0
  15. data/.github/workflows/test.yml +3 -0
  16. data/.github/workflows/test_integration.yml +3 -0
  17. data/CHANGELOG.md +27 -0
  18. data/examples/v1/dashboards/CreateDashboard_1433408735.rb +44 -0
  19. data/examples/v1/dashboards/CreateDashboard_794302680.rb +152 -0
  20. data/examples/v1/synthetics/CreateSyntheticsAPITest_1072503741.rb +1 -1
  21. data/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.rb +1 -1
  22. data/examples/v1/synthetics/CreateSyntheticsAPITest_1402674167.rb +1 -1
  23. data/examples/v1/synthetics/CreateSyntheticsAPITest_3829801148.rb +1 -1
  24. data/examples/v1/synthetics/CreateSyntheticsMobileTest.rb +27 -0
  25. data/examples/v1/synthetics/FetchUptimes.rb +13 -0
  26. data/examples/v1/synthetics/GetMobileTest.rb +8 -0
  27. data/examples/v1/synthetics/UpdateMobileTest.rb +30 -0
  28. data/examples/v2/logs/AggregateLogs_2955613758.rb +0 -1
  29. data/examples/v2/microsoft-teams-integration/CreateApiHandle.rb +17 -0
  30. data/examples/v2/microsoft-teams-integration/CreateApiHandle_1540689753.rb +17 -0
  31. data/examples/v2/microsoft-teams-integration/DeleteApiHandle.rb +5 -0
  32. data/examples/v2/microsoft-teams-integration/DeleteApiHandle_377884154.rb +8 -0
  33. data/examples/v2/microsoft-teams-integration/GetApiHandle.rb +5 -0
  34. data/examples/v2/microsoft-teams-integration/GetApiHandleByName.rb +5 -0
  35. data/examples/v2/microsoft-teams-integration/GetApiHandleByName_1103107145.rb +8 -0
  36. data/examples/v2/microsoft-teams-integration/GetApiHandle_2883785101.rb +8 -0
  37. data/examples/v2/microsoft-teams-integration/GetChannelByName.rb +5 -0
  38. data/examples/v2/microsoft-teams-integration/ListApiHandles.rb +5 -0
  39. data/examples/v2/microsoft-teams-integration/ListApiHandles_769592979.rb +5 -0
  40. data/examples/v2/microsoft-teams-integration/UpdateApiHandle.rb +17 -0
  41. data/examples/v2/microsoft-teams-integration/UpdateApiHandle_419892746.rb +18 -0
  42. data/examples/v2/security-monitoring/CreateSecurityMonitoringRule.rb +9 -0
  43. data/lib/datadog_api_client/inflector.rb +51 -0
  44. data/lib/datadog_api_client/v1/api/synthetics_api.rb +272 -0
  45. data/lib/datadog_api_client/v1/api/usage_metering_api.rb +3 -3
  46. data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +1 -0
  47. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +2 -0
  48. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +11 -1
  49. data/lib/datadog_api_client/v1/models/synthetics_config_variable_type.rb +1 -0
  50. data/lib/datadog_api_client/v1/models/synthetics_fetch_uptimes_payload.rb +167 -0
  51. data/lib/datadog_api_client/v1/models/synthetics_mobile_device_id.rb +251 -0
  52. data/lib/datadog_api_client/v1/models/synthetics_mobile_step.rb +203 -0
  53. data/lib/datadog_api_client/v1/models/synthetics_mobile_step_type.rb +42 -0
  54. data/lib/datadog_api_client/v1/models/synthetics_mobile_test.rb +263 -0
  55. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_binding.rb +105 -0
  56. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_binding_items.rb +117 -0
  57. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_binding_items_role.rb +27 -0
  58. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_ci_options.rb +123 -0
  59. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_config.rb +117 -0
  60. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_initial_application_arguments.rb +105 -0
  61. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_initial_application_arguments_property_names.rb +105 -0
  62. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_options.rb +354 -0
  63. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_options_monitor_options.rb +155 -0
  64. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_options_monitor_options_notification_preset_name.rb +29 -0
  65. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_type.rb +26 -0
  66. data/lib/datadog_api_client/v1/models/synthetics_mobile_tests_mobile_application.rb +154 -0
  67. data/lib/datadog_api_client/v1/models/synthetics_mobile_tests_mobile_application_reference_type.rb +27 -0
  68. data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +1 -1
  69. data/lib/datadog_api_client/v1/models/synthetics_test_request_port.rb +63 -0
  70. data/lib/datadog_api_client/v1/models/synthetics_test_uptime.rb +135 -0
  71. data/lib/datadog_api_client/v1/models/synthetics_uptime.rb +161 -0
  72. data/lib/datadog_api_client/v1/models/table_widget_request.rb +16 -4
  73. data/lib/datadog_api_client/v1/models/table_widget_text_format_match.rb +144 -0
  74. data/lib/datadog_api_client/v1/models/table_widget_text_format_match_type.rb +31 -0
  75. data/lib/datadog_api_client/v1/models/table_widget_text_format_palette.rb +36 -0
  76. data/lib/datadog_api_client/v1/models/table_widget_text_format_replace.rb +63 -0
  77. data/lib/datadog_api_client/v1/models/table_widget_text_format_replace_all.rb +144 -0
  78. data/lib/datadog_api_client/v1/models/table_widget_text_format_replace_all_type.rb +26 -0
  79. data/lib/datadog_api_client/v1/models/table_widget_text_format_replace_substring.rb +165 -0
  80. data/lib/datadog_api_client/v1/models/table_widget_text_format_replace_substring_type.rb +26 -0
  81. data/lib/datadog_api_client/v1/models/table_widget_text_format_rule.rb +163 -0
  82. data/lib/datadog_api_client/v1/models/usage_summary_date.rb +31 -1
  83. data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +31 -1
  84. data/lib/datadog_api_client/v1/models/usage_summary_response.rb +31 -1
  85. data/lib/datadog_api_client/v2/api/authn_mappings_api.rb +3 -3
  86. data/lib/datadog_api_client/v2/api/incidents_api.rb +1 -1
  87. data/lib/datadog_api_client/v2/api/metrics_api.rb +4 -4
  88. data/lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb +497 -0
  89. data/lib/datadog_api_client/v2/api/restriction_policies_api.rb +3 -3
  90. data/lib/datadog_api_client/v2/api/usage_metering_api.rb +1 -1
  91. data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +11 -1
  92. data/lib/datadog_api_client/v2/models/fastly_services_response.rb +1 -1
  93. data/lib/datadog_api_client/v2/models/incident_notification_handle.rb +1 -1
  94. data/lib/datadog_api_client/v2/models/metric_tag_configuration_attributes.rb +1 -1
  95. data/lib/datadog_api_client/v2/models/metric_tag_configuration_create_attributes.rb +1 -1
  96. data/lib/datadog_api_client/v2/models/metric_tag_configuration_metric_type_category.rb +27 -0
  97. data/lib/datadog_api_client/v2/models/metric_tag_configuration_update_attributes.rb +1 -1
  98. data/lib/datadog_api_client/v2/models/microsoft_teams_api_handle_attributes.rb +186 -0
  99. data/lib/datadog_api_client/v2/models/microsoft_teams_api_handle_info_response.rb +105 -0
  100. data/lib/datadog_api_client/v2/models/microsoft_teams_api_handle_info_response_attributes.rb +249 -0
  101. data/lib/datadog_api_client/v2/models/microsoft_teams_api_handle_info_response_data.rb +147 -0
  102. data/lib/datadog_api_client/v2/models/microsoft_teams_api_handle_info_type.rb +26 -0
  103. data/lib/datadog_api_client/v2/models/microsoft_teams_api_handle_request_attributes.rb +202 -0
  104. data/lib/datadog_api_client/v2/models/microsoft_teams_api_handle_request_data.rb +144 -0
  105. data/lib/datadog_api_client/v2/models/microsoft_teams_api_handle_response_data.rb +147 -0
  106. data/lib/datadog_api_client/v2/models/microsoft_teams_api_handle_type.rb +26 -0
  107. data/lib/datadog_api_client/v2/models/microsoft_teams_api_handles_response.rb +125 -0
  108. data/lib/datadog_api_client/v2/models/microsoft_teams_channel_info_response_attributes.rb +165 -0
  109. data/lib/datadog_api_client/v2/models/microsoft_teams_channel_info_response_data.rb +147 -0
  110. data/lib/datadog_api_client/v2/models/microsoft_teams_channel_info_type.rb +26 -0
  111. data/lib/datadog_api_client/v2/models/microsoft_teams_create_api_handle_request.rb +123 -0
  112. data/lib/datadog_api_client/v2/models/microsoft_teams_create_api_handle_response.rb +123 -0
  113. data/lib/datadog_api_client/v2/models/microsoft_teams_get_channel_by_name_response.rb +105 -0
  114. data/lib/datadog_api_client/v2/models/microsoft_teams_update_api_handle_request.rb +123 -0
  115. data/lib/datadog_api_client/v2/models/microsoft_teams_update_api_handle_request_data.rb +144 -0
  116. data/lib/datadog_api_client/v2/models/powerpack_template_variable.rb +35 -4
  117. data/lib/datadog_api_client/v2/models/security_monitoring_reference_table.rb +145 -0
  118. data/lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb +13 -1
  119. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_create_payload.rb +13 -1
  120. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_payload.rb +13 -1
  121. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_response.rb +13 -1
  122. data/lib/datadog_api_client/v2/models/security_monitoring_standard_rule_test_payload.rb +13 -1
  123. data/lib/datadog_api_client/v2/models/team_update_attributes.rb +1 -26
  124. data/lib/datadog_api_client/version.rb +1 -1
  125. metadata +72 -2
@@ -4182,6 +4182,7 @@ components:
4182
4182
  - custom_timeseries_usage
4183
4183
  - cws_containers_usage
4184
4184
  - cws_hosts_usage
4185
+ - data_jobs_monitoring_usage
4185
4186
  - dbm_hosts_usage
4186
4187
  - dbm_queries_usage
4187
4188
  - error_tracking_usage
@@ -4255,6 +4256,7 @@ components:
4255
4256
  - CUSTOM_TIMESERIES_USAGE
4256
4257
  - CWS_CONTAINERS_USAGE
4257
4258
  - CWS_HOSTS_USAGE
4259
+ - DATA_JOBS_MONITORING_USAGE
4258
4260
  - DBM_HOSTS_USAGE
4259
4261
  - DBM_QUERIES_USAGE
4260
4262
  - ERROR_TRACKING_USAGE
@@ -7935,6 +7937,8 @@ components:
7935
7937
  - cws_containers_usage
7936
7938
  - cws_hosts_percentage
7937
7939
  - cws_hosts_usage
7940
+ - data_jobs_monitoring_usage
7941
+ - data_jobs_monitoring_percentage
7938
7942
  - dbm_hosts_percentage
7939
7943
  - dbm_hosts_usage
7940
7944
  - dbm_queries_percentage
@@ -8076,6 +8080,8 @@ components:
8076
8080
  - CWS_CONTAINERS_USAGE
8077
8081
  - CWS_HOSTS_PERCENTAGE
8078
8082
  - CWS_HOSTS_USAGE
8083
+ - DATA_JOBS_MONITORING_USAGE
8084
+ - DATA_JOBS_MONITORING_PERCENTAGE
8079
8085
  - DBM_HOSTS_PERCENTAGE
8080
8086
  - DBM_HOSTS_USAGE
8081
8087
  - DBM_QUERIES_PERCENTAGE
@@ -8363,6 +8369,10 @@ components:
8363
8369
  description: The Cloud Workload Security host usage by tag(s).
8364
8370
  format: double
8365
8371
  type: number
8372
+ data_jobs_monitoring_usage:
8373
+ description: The Data Jobs Monitoring usage by tag(s).
8374
+ format: double
8375
+ type: number
8366
8376
  dbm_hosts_percentage:
8367
8377
  description: The percentage of Database Monitoring host usage by tag(s).
8368
8378
  format: double
@@ -15051,11 +15061,13 @@ components:
15051
15061
  enum:
15052
15062
  - global
15053
15063
  - text
15064
+ - email
15054
15065
  example: text
15055
15066
  type: string
15056
15067
  x-enum-varnames:
15057
15068
  - GLOBAL
15058
15069
  - TEXT
15070
+ - EMAIL
15059
15071
  SyntheticsCoreWebVitals:
15060
15072
  description: Core Web Vitals attached to a browser test step.
15061
15073
  properties:
@@ -15182,6 +15194,32 @@ components:
15182
15194
  - EDGE_LAPTOP_LARGE
15183
15195
  - EDGE_TABLET
15184
15196
  - EDGE_MOBILE_SMALL
15197
+ SyntheticsFetchUptimesPayload:
15198
+ description: Object containing IDs of Synthetic tests and a timeframe.
15199
+ properties:
15200
+ from_ts:
15201
+ description: Timestamp in seconds (Unix epoch) for the start of uptime.
15202
+ example: 0
15203
+ format: int64
15204
+ type: integer
15205
+ public_ids:
15206
+ description: An array of Synthetic test IDs you want to delete.
15207
+ example: []
15208
+ items:
15209
+ description: A Synthetic test ID.
15210
+ example: abc-def-123
15211
+ type: string
15212
+ type: array
15213
+ to_ts:
15214
+ description: Timestamp in seconds (Unix epoch) for the end of uptime.
15215
+ example: 0
15216
+ format: int64
15217
+ type: integer
15218
+ required:
15219
+ - from_ts
15220
+ - to_ts
15221
+ - public_ids
15222
+ type: object
15185
15223
  SyntheticsGetAPITestLatestResultsResponse:
15186
15224
  description: Object with the latest Synthetic API test run.
15187
15225
  properties:
@@ -15458,6 +15496,795 @@ components:
15458
15496
  $ref: '#/components/schemas/SyntheticsLocation'
15459
15497
  type: array
15460
15498
  type: object
15499
+ SyntheticsMobileDeviceID:
15500
+ description: The device ID.
15501
+ enum:
15502
+ - apple ipad (2022),16.4
15503
+ - apple ipad (2022),17.3.1
15504
+ - apple ipad 7th gen (2019),13.3
15505
+ - apple ipad 9th gen (2021),15.0.2
15506
+ - apple ipad 9th gen (2021),16.1
15507
+ - apple ipad air (2022),15.4.1
15508
+ - apple ipad mini (5th gen),14.6
15509
+ - apple ipad mini (6th gen),15.1
15510
+ - apple ipad pro 11 (2022),16.3
15511
+ - apple ipad pro 12.9 (2020),14.8
15512
+ - apple ipad pro 12.9 (2021),15.6.1
15513
+ - apple ipad pro 12.9 (2022),16.5
15514
+ - apple iphone 11 pro max,13.1.3
15515
+ - apple iphone 11 pro,13.6
15516
+ - apple iphone 11 pro,15.5
15517
+ - apple iphone 11,13.3.1
15518
+ - apple iphone 11,14.0
15519
+ - apple iphone 11,16.3
15520
+ - apple iphone 12 mini,14.2
15521
+ - apple iphone 12 mini,16.5
15522
+ - apple iphone 12 pro max,14.5.1
15523
+ - apple iphone 12 pro,14.5.1
15524
+ - apple iphone 12 pro,14.8
15525
+ - apple iphone 12 pro,15.0.2
15526
+ - apple iphone 12 pro,16.2
15527
+ - apple iphone 12,14.2
15528
+ - apple iphone 12,14.6
15529
+ - apple iphone 12,14.8
15530
+ - apple iphone 12,15.6.1
15531
+ - apple iphone 12,16.6.1
15532
+ - apple iphone 13 mini,15.0.2
15533
+ - apple iphone 13 mini,16.6
15534
+ - apple iphone 13 pro max,15.1
15535
+ - apple iphone 13 pro max,17.3
15536
+ - apple iphone 13 pro,15.0.2
15537
+ - apple iphone 13 pro,15.2
15538
+ - apple iphone 14 plus,16.1
15539
+ - apple iphone 14 pro max,16.2
15540
+ - apple iphone 14 pro,16.1
15541
+ - apple iphone 14 pro,17.3.1
15542
+ - apple iphone 14,16.1
15543
+ - apple iphone 15 pro max,17.3.1
15544
+ - apple iphone 15 pro,17.3.1
15545
+ - apple iphone 15,17.2.1
15546
+ - apple iphone se (2022),15.4.1
15547
+ - galaxy a40,9
15548
+ - galaxy a5,8.0.0
15549
+ - galaxy note 10,9
15550
+ - galaxy note5 (at&t),7.0
15551
+ - galaxy s10,9
15552
+ - galaxy s6 edge sm-g925f,7.0
15553
+ - galaxy s8 (t-mobile),8.0.0
15554
+ - galaxy s8 unlocked,8.0.0
15555
+ - galaxy s9 (unlocked),9
15556
+ - galaxy s9+ (unlocked),8.0.0
15557
+ - galaxy s9+ (unlocked),9
15558
+ - google pixel 2,8.0.0
15559
+ - google pixel 2,9
15560
+ - google pixel 3 xl,10
15561
+ - google pixel 3 xl,9
15562
+ - google pixel 3,10
15563
+ - google pixel 3,9
15564
+ - google pixel 3a xl,11
15565
+ - google pixel 3a xl,12
15566
+ - google pixel 3a,10
15567
+ - google pixel 4 (unlocked),10
15568
+ - google pixel 4 (unlocked),11
15569
+ - google pixel 4 xl (unlocked),10
15570
+ - google pixel 4a,11
15571
+ - google pixel 4a,12
15572
+ - google pixel 5a 5g,12
15573
+ - google pixel 6 pro,12
15574
+ - google pixel 6,12
15575
+ - google pixel 6a,13
15576
+ - google pixel 7 pro,13
15577
+ - google pixel 7,13
15578
+ - google pixel 7,14
15579
+ - google pixel 8 pro,14
15580
+ - google pixel 8,14
15581
+ - ipad 8th gen (2020),14.8
15582
+ - ipad air 2,13.6
15583
+ - ipad air 4th gen (2020),14.8
15584
+ - iphone 13,15.0.2
15585
+ - iphone 13,16.0.2
15586
+ - iphone 6,12.5.4
15587
+ - iphone 6s,14.4.2
15588
+ - iphone 7,14.8
15589
+ - iphone 8,13.5.1
15590
+ - iphone 8,14.4.2
15591
+ - iphone se (2020),13.6
15592
+ - iphone se (2020),14.6
15593
+ - iphone se (2020),15.0.2
15594
+ - iphone x,14.6
15595
+ - iphone xr,12.0
15596
+ - iphone xr,14.0
15597
+ - iphone xs max,12.1
15598
+ - iphone xs,13.6
15599
+ - lg stylo 5,9
15600
+ - lg stylo 6,10
15601
+ - moto g 4,7.0
15602
+ - moto g7 play,9
15603
+ - nexus 7 - 2nd gen (wifi),6.0
15604
+ - oneplus 8t,11
15605
+ - pixel 2 xl,8.1.0
15606
+ - pixel 2 xl,9
15607
+ - pixel 5,11
15608
+ - pixel 5,12
15609
+ - pixel xl,8.0.0
15610
+ - pixel,7.1.2
15611
+ - samsung a51,10
15612
+ - samsung galaxy a10s,10
15613
+ - samsung galaxy a13 5g,11
15614
+ - samsung galaxy a53 5g,12
15615
+ - samsung galaxy a7,8.0.0
15616
+ - samsung galaxy a71,11
15617
+ - samsung galaxy a73 5g,12
15618
+ - samsung galaxy j7 (2018),8.0.0
15619
+ - samsung galaxy note20,11
15620
+ - samsung galaxy s20 (unlocked),10
15621
+ - samsung galaxy s20+ (unlocked),10
15622
+ - samsung galaxy s21 ultra,11
15623
+ - samsung galaxy s21 ultra,12
15624
+ - samsung galaxy s21+,11
15625
+ - samsung galaxy s21,11
15626
+ - samsung galaxy s21,12
15627
+ - samsung galaxy s22 5g,12
15628
+ - samsung galaxy s22 5g,13
15629
+ - samsung galaxy s22 ultra 5g,12
15630
+ - samsung galaxy s22+ 5g,12
15631
+ - samsung galaxy s23 ultra,13
15632
+ - samsung galaxy s23+,13
15633
+ - samsung galaxy s23,13
15634
+ - samsung galaxy s23,14
15635
+ - samsung galaxy tab a 10.1,10
15636
+ - samsung galaxy tab a 10.1,7.0
15637
+ - samsung galaxy tab a8 (2021),11
15638
+ - samsung galaxy tab s4,8.1.0
15639
+ - samsung galaxy tab s6,9
15640
+ - samsung galaxy tab s7,11
15641
+ - samsung galaxy tab s8,12
15642
+ - samsung s20 ultra,10
15643
+ - sony xperia xz3,9
15644
+ - xiaomi redmi note 10 5g,11
15645
+ - synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16
15646
+ - synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_17
15647
+ - synthetics:mobile:device:apple_ipad_9th_gen_2021_ios_15
15648
+ - synthetics:mobile:device:apple_ipad_air_2022_ios_15
15649
+ - synthetics:mobile:device:apple_ipad_mini_5th_gen_ios_14
15650
+ - synthetics:mobile:device:apple_ipad_mini_6th_gen_ios_15
15651
+ - synthetics:mobile:device:apple_ipad_pro_11_2022_ios_16
15652
+ - synthetics:mobile:device:apple_ipad_pro_12_9_2020_ios_14
15653
+ - synthetics:mobile:device:apple_ipad_pro_12_9_2021_ios_15
15654
+ - synthetics:mobile:device:apple_ipad_pro_12_9_2022_ios_16
15655
+ - synthetics:mobile:device:apple_iphone_11_ios_14
15656
+ - synthetics:mobile:device:apple_iphone_11_ios_16
15657
+ - synthetics:mobile:device:apple_iphone_11_pro_ios_15
15658
+ - synthetics:mobile:device:apple_iphone_12_ios_14
15659
+ - synthetics:mobile:device:apple_iphone_12_ios_15
15660
+ - synthetics:mobile:device:apple_iphone_12_ios_16
15661
+ - synthetics:mobile:device:apple_iphone_12_mini_ios_14
15662
+ - synthetics:mobile:device:apple_iphone_12_mini_ios_16
15663
+ - synthetics:mobile:device:apple_iphone_12_pro_ios_14
15664
+ - synthetics:mobile:device:apple_iphone_12_pro_max_ios_14
15665
+ - synthetics:mobile:device:apple_iphone_13_mini_ios_15
15666
+ - synthetics:mobile:device:apple_iphone_13_mini_ios_16
15667
+ - synthetics:mobile:device:apple_iphone_13_pro_ios_15
15668
+ - synthetics:mobile:device:apple_iphone_13_pro_max_ios_15
15669
+ - synthetics:mobile:device:apple_iphone_13_pro_max_ios_17
15670
+ - synthetics:mobile:device:apple_iphone_14_ios_16
15671
+ - synthetics:mobile:device:apple_iphone_14_plus_ios_16
15672
+ - synthetics:mobile:device:apple_iphone_14_pro_ios_16
15673
+ - synthetics:mobile:device:apple_iphone_14_pro_ios_17
15674
+ - synthetics:mobile:device:apple_iphone_14_pro_max_ios_16
15675
+ - synthetics:mobile:device:apple_iphone_6_ios_12
15676
+ - synthetics:mobile:device:apple_iphone_8_ios_13
15677
+ - synthetics:mobile:device:apple_iphone_8_ios_14
15678
+ - synthetics:mobile:device:apple_iphone_se_2022_ios_15
15679
+ - synthetics:mobile:device:apple_iphone_se_2022_ios_16
15680
+ - synthetics:mobile:device:galaxy_a5_android_8
15681
+ - synthetics:mobile:device:galaxy_note5_android_7
15682
+ - synthetics:mobile:device:google_pixel_3a_xl_android_11
15683
+ - synthetics:mobile:device:google_pixel_4_unlocked_android_11
15684
+ - synthetics:mobile:device:google_pixel_4_xl_unlocked_android_10
15685
+ - synthetics:mobile:device:google_pixel_4a_android_11
15686
+ - synthetics:mobile:device:google_pixel_6_android_12
15687
+ - synthetics:mobile:device:google_pixel_6_pro_android_12
15688
+ - synthetics:mobile:device:google_pixel_6a_android_13
15689
+ - synthetics:mobile:device:google_pixel_7_android_13
15690
+ - synthetics:mobile:device:google_pixel_7_android_14
15691
+ - synthetics:mobile:device:google_pixel_7_pro_android_13
15692
+ - synthetics:mobile:device:google_pixel_8_android_14
15693
+ - synthetics:mobile:device:google_pixel_8_pro_android_14
15694
+ - synthetics:mobile:device:ipad_air_2_ios_13
15695
+ - synthetics:mobile:device:ipad_air_4th_gen_2020_ios_14
15696
+ - synthetics:mobile:device:iphone_13_ios_15
15697
+ - synthetics:mobile:device:iphone_13_ios_16
15698
+ - synthetics:mobile:device:iphone_15_ios_17
15699
+ - synthetics:mobile:device:iphone_15_pro_ios_17
15700
+ - synthetics:mobile:device:iphone_15_pro_max_ios_17
15701
+ - synthetics:mobile:device:iphone_se_2020_ios_13
15702
+ - synthetics:mobile:device:iphone_se_2020_ios_14
15703
+ - synthetics:mobile:device:iphone_x_ios_14
15704
+ - synthetics:mobile:device:iphone_xr_ios_14
15705
+ - synthetics:mobile:device:iphone_xs_ios_13
15706
+ - synthetics:mobile:device:lg_stylo_6_android_10
15707
+ - synthetics:mobile:device:pixel_5_android_12
15708
+ - synthetics:mobile:device:samsung_a51_android_10
15709
+ - synthetics:mobile:device:samsung_galaxy_a71_android_11
15710
+ - synthetics:mobile:device:samsung_galaxy_note20_android_11
15711
+ - synthetics:mobile:device:samsung_galaxy_s21_android_11
15712
+ - synthetics:mobile:device:samsung_galaxy_s21_android_12
15713
+ - synthetics:mobile:device:samsung_galaxy_s21_plus_android_11
15714
+ - synthetics:mobile:device:samsung_galaxy_s21_ultra_android_11
15715
+ - synthetics:mobile:device:samsung_galaxy_s22_5g_android_12
15716
+ - synthetics:mobile:device:samsung_galaxy_s22_5g_android_13
15717
+ - synthetics:mobile:device:samsung_galaxy_s22_plus_5g_android_12
15718
+ - synthetics:mobile:device:samsung_galaxy_s22_ultra_5g_android_12
15719
+ - synthetics:mobile:device:samsung_galaxy_s23_android_13
15720
+ - synthetics:mobile:device:samsung_galaxy_s23_android_14
15721
+ - synthetics:mobile:device:samsung_galaxy_s23_plus_android_13
15722
+ - synthetics:mobile:device:samsung_galaxy_s23_plus_android_14
15723
+ - synthetics:mobile:device:samsung_galaxy_s23_ultra_android_13
15724
+ - synthetics:mobile:device:samsung_galaxy_tab_a_10_1_android_7
15725
+ - synthetics:mobile:device:samsung_galaxy_tab_s7_android_11
15726
+ - synthetics:mobile:device:samsung_galaxy_tab_s8_android_12
15727
+ - synthetics:mobile:device:xiaomi_redmi_note_10_5g_android_11
15728
+ example: apple ipad (2022),16.4
15729
+ type: string
15730
+ x-enum-varnames:
15731
+ - APPLE_IPAD__2022__16_4
15732
+ - APPLE_IPAD__2022__17_3_1
15733
+ - APPLE_IPAD_7TH_GEN__2019__13_3
15734
+ - APPLE_IPAD_9TH_GEN__2021__15_0_2
15735
+ - APPLE_IPAD_9TH_GEN__2021__16_1
15736
+ - APPLE_IPAD_AIR__2022__15_4_1
15737
+ - APPLE_IPAD_MINI__5TH_GEN__14_6
15738
+ - APPLE_IPAD_MINI__6TH_GEN__15_1
15739
+ - APPLE_IPAD_PRO_11__2022__16_3
15740
+ - APPLE_IPAD_PRO_12_9__2020__14_8
15741
+ - APPLE_IPAD_PRO_12_9__2021__15_6_1
15742
+ - APPLE_IPAD_PRO_12_9__2022__16_5
15743
+ - APPLE_IPHONE_11_PRO_MAX_13_1_3
15744
+ - APPLE_IPHONE_11_PRO_13_6
15745
+ - APPLE_IPHONE_11_PRO_15_5
15746
+ - APPLE_IPHONE_11_13_3_1
15747
+ - APPLE_IPHONE_11_14_0
15748
+ - APPLE_IPHONE_11_16_3
15749
+ - APPLE_IPHONE_12_MINI_14_2
15750
+ - APPLE_IPHONE_12_MINI_16_5
15751
+ - APPLE_IPHONE_12_PRO_MAX_14_5_1
15752
+ - APPLE_IPHONE_12_PRO_14_5_1
15753
+ - APPLE_IPHONE_12_PRO_14_8
15754
+ - APPLE_IPHONE_12_PRO_15_0_2
15755
+ - APPLE_IPHONE_12_PRO_16_2
15756
+ - APPLE_IPHONE_12_14_2
15757
+ - APPLE_IPHONE_12_14_6
15758
+ - APPLE_IPHONE_12_14_8
15759
+ - APPLE_IPHONE_12_15_6_1
15760
+ - APPLE_IPHONE_12_16_6_1
15761
+ - APPLE_IPHONE_13_MINI_15_0_2
15762
+ - APPLE_IPHONE_13_MINI_16_6
15763
+ - APPLE_IPHONE_13_PRO_MAX_15_1
15764
+ - APPLE_IPHONE_13_PRO_MAX_17_3
15765
+ - APPLE_IPHONE_13_PRO_15_0_2
15766
+ - APPLE_IPHONE_13_PRO_15_2
15767
+ - APPLE_IPHONE_14_PLUS_16_1
15768
+ - APPLE_IPHONE_14_PRO_MAX_16_2
15769
+ - APPLE_IPHONE_14_PRO_16_1
15770
+ - APPLE_IPHONE_14_PRO_17_3_1
15771
+ - APPLE_IPHONE_14_16_1
15772
+ - APPLE_IPHONE_15_PRO_MAX_17_3_1
15773
+ - APPLE_IPHONE_15_PRO_17_3_1
15774
+ - APPLE_IPHONE_15_17_2_1
15775
+ - APPLE_IPHONE_SE__2022__15_4_1
15776
+ - GALAXY_A40_9
15777
+ - GALAXY_A5_8_0_0
15778
+ - GALAXY_NOTE_10_9
15779
+ - GALAXY_NOTE5__AT_T__7_0
15780
+ - GALAXY_S10_9
15781
+ - GALAXY_S6_EDGE_SMNOT_G925F_7_0
15782
+ - GALAXY_S8__TNOT_MOBILE__8_0_0
15783
+ - GALAXY_S8_UNLOCKED_8_0_0
15784
+ - GALAXY_S9__UNLOCKED__9
15785
+ - GALAXY_S9___UNLOCKED__8_0_0
15786
+ - GALAXY_S9___UNLOCKED__9
15787
+ - GOOGLE_PIXEL_2_8_0_0
15788
+ - GOOGLE_PIXEL_2_9
15789
+ - GOOGLE_PIXEL_3_XL_10
15790
+ - GOOGLE_PIXEL_3_XL_9
15791
+ - GOOGLE_PIXEL_3_10
15792
+ - GOOGLE_PIXEL_3_9
15793
+ - GOOGLE_PIXEL_3A_XL_11
15794
+ - GOOGLE_PIXEL_3A_XL_12
15795
+ - GOOGLE_PIXEL_3A_10
15796
+ - GOOGLE_PIXEL_4__UNLOCKED__10
15797
+ - GOOGLE_PIXEL_4__UNLOCKED__11
15798
+ - GOOGLE_PIXEL_4_XL__UNLOCKED__10
15799
+ - GOOGLE_PIXEL_4A_11
15800
+ - GOOGLE_PIXEL_4A_12
15801
+ - GOOGLE_PIXEL_5A_5G_12
15802
+ - GOOGLE_PIXEL_6_PRO_12
15803
+ - GOOGLE_PIXEL_6_12
15804
+ - GOOGLE_PIXEL_6A_13
15805
+ - GOOGLE_PIXEL_7_PRO_13
15806
+ - GOOGLE_PIXEL_7_13
15807
+ - GOOGLE_PIXEL_7_14
15808
+ - GOOGLE_PIXEL_8_PRO_14
15809
+ - GOOGLE_PIXEL_8_14
15810
+ - IPAD_8TH_GEN__2020__14_8
15811
+ - IPAD_AIR_2_13_6
15812
+ - IPAD_AIR_4TH_GEN__2020__14_8
15813
+ - IPHONE_13_15_0_2
15814
+ - IPHONE_13_16_0_2
15815
+ - IPHONE_6_12_5_4
15816
+ - IPHONE_6S_14_4_2
15817
+ - IPHONE_7_14_8
15818
+ - IPHONE_8_13_5_1
15819
+ - IPHONE_8_14_4_2
15820
+ - IPHONE_SE__2020__13_6
15821
+ - IPHONE_SE__2020__14_6
15822
+ - IPHONE_SE__2020__15_0_2
15823
+ - IPHONE_X_14_6
15824
+ - IPHONE_XR_12_0
15825
+ - IPHONE_XR_14_0
15826
+ - IPHONE_XS_MAX_12_1
15827
+ - IPHONE_XS_13_6
15828
+ - LG_STYLO_5_9
15829
+ - LG_STYLO_6_10
15830
+ - MOTO_G_4_7_0
15831
+ - MOTO_G7_PLAY_9
15832
+ - NEXUS_7_NOT__2ND_GEN__WIFI__6_0
15833
+ - ONEPLUS_8T_11
15834
+ - PIXEL_2_XL_8_1_0
15835
+ - PIXEL_2_XL_9
15836
+ - PIXEL_5_11
15837
+ - PIXEL_5_12
15838
+ - PIXEL_XL_8_0_0
15839
+ - PIXEL_7_1_2
15840
+ - SAMSUNG_A51_10
15841
+ - SAMSUNG_GALAXY_A10S_10
15842
+ - SAMSUNG_GALAXY_A13_5G_11
15843
+ - SAMSUNG_GALAXY_A53_5G_12
15844
+ - SAMSUNG_GALAXY_A7_8_0_0
15845
+ - SAMSUNG_GALAXY_A71_11
15846
+ - SAMSUNG_GALAXY_A73_5G_12
15847
+ - SAMSUNG_GALAXY_J7__2018__8_0_0
15848
+ - SAMSUNG_GALAXY_NOTE20_11
15849
+ - SAMSUNG_GALAXY_S20__UNLOCKED__10
15850
+ - SAMSUNG_GALAXY_S20___UNLOCKED__10
15851
+ - SAMSUNG_GALAXY_S21_ULTRA_11
15852
+ - SAMSUNG_GALAXY_S21_ULTRA_12
15853
+ - SAMSUNG_GALAXY_S21__11
15854
+ - SAMSUNG_GALAXY_S21_11
15855
+ - SAMSUNG_GALAXY_S21_12
15856
+ - SAMSUNG_GALAXY_S22_5G_12
15857
+ - SAMSUNG_GALAXY_S22_5G_13
15858
+ - SAMSUNG_GALAXY_S22_ULTRA_5G_12
15859
+ - SAMSUNG_GALAXY_S22__5G_12
15860
+ - SAMSUNG_GALAXY_S23_ULTRA_13
15861
+ - SAMSUNG_GALAXY_S23__13
15862
+ - SAMSUNG_GALAXY_S23_13
15863
+ - SAMSUNG_GALAXY_S23_14
15864
+ - SAMSUNG_GALAXY_TAB_A_10_1_10
15865
+ - SAMSUNG_GALAXY_TAB_A_10_1_7_0
15866
+ - SAMSUNG_GALAXY_TAB_A8__2021__11
15867
+ - SAMSUNG_GALAXY_TAB_S4_8_1_0
15868
+ - SAMSUNG_GALAXY_TAB_S6_9
15869
+ - SAMSUNG_GALAXY_TAB_S7_11
15870
+ - SAMSUNG_GALAXY_TAB_S8_12
15871
+ - SAMSUNG_S20_ULTRA_10
15872
+ - SONY_XPERIA_XZ3_9
15873
+ - XIAOMI_REDMI_NOTE_10_5G_11
15874
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPAD_10TH_GEN_2022_IOS_16
15875
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPAD_10TH_GEN_2022_IOS_17
15876
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPAD_9TH_GEN_2021_IOS_15
15877
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPAD_AIR_2022_IOS_15
15878
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPAD_MINI_5TH_GEN_IOS_14
15879
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPAD_MINI_6TH_GEN_IOS_15
15880
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPAD_PRO_11_2022_IOS_16
15881
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPAD_PRO_12_9_2020_IOS_14
15882
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPAD_PRO_12_9_2021_IOS_15
15883
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPAD_PRO_12_9_2022_IOS_16
15884
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_11_IOS_14
15885
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_11_IOS_16
15886
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_11_PRO_IOS_15
15887
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_12_IOS_14
15888
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_12_IOS_15
15889
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_12_IOS_16
15890
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_12_MINI_IOS_14
15891
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_12_MINI_IOS_16
15892
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_12_PRO_IOS_14
15893
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_12_PRO_MAX_IOS_14
15894
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_13_MINI_IOS_15
15895
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_13_MINI_IOS_16
15896
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_13_PRO_IOS_15
15897
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_13_PRO_MAX_IOS_15
15898
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_13_PRO_MAX_IOS_17
15899
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_14_IOS_16
15900
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_14_PLUS_IOS_16
15901
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_14_PRO_IOS_16
15902
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_14_PRO_IOS_17
15903
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_14_PRO_MAX_IOS_16
15904
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_6_IOS_12
15905
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_8_IOS_13
15906
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_8_IOS_14
15907
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_SE_2022_IOS_15
15908
+ - SYNTHETICS_MOBILE_DEVICE_APPLE_IPHONE_SE_2022_IOS_16
15909
+ - SYNTHETICS_MOBILE_DEVICE_GALAXY_A5_ANDROID_8
15910
+ - SYNTHETICS_MOBILE_DEVICE_GALAXY_NOTE5_ANDROID_7
15911
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_3A_XL_ANDROID_11
15912
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_4_UNLOCKED_ANDROID_11
15913
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_4_XL_UNLOCKED_ANDROID_10
15914
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_4A_ANDROID_11
15915
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_6_ANDROID_12
15916
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_6_PRO_ANDROID_12
15917
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_6A_ANDROID_13
15918
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_7_ANDROID_13
15919
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_7_ANDROID_14
15920
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_7_PRO_ANDROID_13
15921
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_8_ANDROID_14
15922
+ - SYNTHETICS_MOBILE_DEVICE_GOOGLE_PIXEL_8_PRO_ANDROID_14
15923
+ - SYNTHETICS_MOBILE_DEVICE_IPAD_AIR_2_IOS_13
15924
+ - SYNTHETICS_MOBILE_DEVICE_IPAD_AIR_4TH_GEN_2020_IOS_14
15925
+ - SYNTHETICS_MOBILE_DEVICE_IPHONE_13_IOS_15
15926
+ - SYNTHETICS_MOBILE_DEVICE_IPHONE_13_IOS_16
15927
+ - SYNTHETICS_MOBILE_DEVICE_IPHONE_15_IOS_17
15928
+ - SYNTHETICS_MOBILE_DEVICE_IPHONE_15_PRO_IOS_17
15929
+ - SYNTHETICS_MOBILE_DEVICE_IPHONE_15_PRO_MAX_IOS_17
15930
+ - SYNTHETICS_MOBILE_DEVICE_IPHONE_SE_2020_IOS_13
15931
+ - SYNTHETICS_MOBILE_DEVICE_IPHONE_SE_2020_IOS_14
15932
+ - SYNTHETICS_MOBILE_DEVICE_IPHONE_X_IOS_14
15933
+ - SYNTHETICS_MOBILE_DEVICE_IPHONE_XR_IOS_14
15934
+ - SYNTHETICS_MOBILE_DEVICE_IPHONE_XS_IOS_13
15935
+ - SYNTHETICS_MOBILE_DEVICE_LG_STYLO_6_ANDROID_10
15936
+ - SYNTHETICS_MOBILE_DEVICE_PIXEL_5_ANDROID_12
15937
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_A51_ANDROID_10
15938
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_A71_ANDROID_11
15939
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_NOTE20_ANDROID_11
15940
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S21_ANDROID_11
15941
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S21_ANDROID_12
15942
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S21_PLUS_ANDROID_11
15943
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S21_ULTRA_ANDROID_11
15944
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S22_5G_ANDROID_12
15945
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S22_5G_ANDROID_13
15946
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S22_PLUS_5G_ANDROID_12
15947
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S22_ULTRA_5G_ANDROID_12
15948
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S23_ANDROID_13
15949
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S23_ANDROID_14
15950
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S23_PLUS_ANDROID_13
15951
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S23_PLUS_ANDROID_14
15952
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_S23_ULTRA_ANDROID_13
15953
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_TAB_A_10_1_ANDROID_7
15954
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_TAB_S7_ANDROID_11
15955
+ - SYNTHETICS_MOBILE_DEVICE_SAMSUNG_GALAXY_TAB_S8_ANDROID_12
15956
+ - SYNTHETICS_MOBILE_DEVICE_XIAOMI_REDMI_NOTE_10_5G_ANDROID_11
15957
+ SyntheticsMobileStep:
15958
+ description: The steps used in a Synthetic mobile test.
15959
+ properties:
15960
+ allowFailure:
15961
+ description: A boolean set to allow this step to fail.
15962
+ type: boolean
15963
+ hasNewStepElement:
15964
+ description: A boolean set to determine if the step has a new step element.
15965
+ type: boolean
15966
+ isCritical:
15967
+ description: A boolean to use in addition to `allowFailure` to determine
15968
+ if the test should be marked as failed when the step fails.
15969
+ type: boolean
15970
+ name:
15971
+ description: The name of the step.
15972
+ maxLength: 1500
15973
+ type: string
15974
+ noScreenshot:
15975
+ description: A boolean set to not take a screenshot for the step.
15976
+ type: boolean
15977
+ params:
15978
+ description: The parameters of the mobile step.
15979
+ type: object
15980
+ publicId:
15981
+ description: The public ID of the step.
15982
+ example: pub-lic-id0
15983
+ type: string
15984
+ timeout:
15985
+ description: The time before declaring a step failed.
15986
+ format: int64
15987
+ type: integer
15988
+ type:
15989
+ $ref: '#/components/schemas/SyntheticsMobileStepType'
15990
+ type: object
15991
+ SyntheticsMobileStepType:
15992
+ description: Step type used in your mobile Synthetic test.
15993
+ enum:
15994
+ - assertElementContent
15995
+ - assertScreenContains
15996
+ - assertScreenLacks
15997
+ - doubleTap
15998
+ - extractVariable
15999
+ - flick
16000
+ - openDeeplink
16001
+ - playSubTest
16002
+ - pressBack
16003
+ - restartApplication
16004
+ - rotate
16005
+ - scroll
16006
+ - scrollToElement
16007
+ - tap
16008
+ - toggleWiFi
16009
+ - typeText
16010
+ - wait
16011
+ example: assertElementContent
16012
+ type: string
16013
+ x-enum-varnames:
16014
+ - ASSERTELEMENTCONTENT
16015
+ - ASSERTSCREENCONTAINS
16016
+ - ASSERTSCREENLACKS
16017
+ - DOUBLETAP
16018
+ - EXTRACTVARIABLE
16019
+ - FLICK
16020
+ - OPENDEEPLINK
16021
+ - PLAYSUBTEST
16022
+ - PRESSBACK
16023
+ - RESTARTAPPLICATION
16024
+ - ROTATE
16025
+ - SCROLL
16026
+ - SCROLLTOELEMENT
16027
+ - TAP
16028
+ - TOGGLEWIFI
16029
+ - TYPETEXT
16030
+ - WAIT
16031
+ SyntheticsMobileTest:
16032
+ description: Object containing details about a Synthetic mobile test.
16033
+ properties:
16034
+ config:
16035
+ $ref: '#/components/schemas/SyntheticsMobileTestConfig'
16036
+ device_ids:
16037
+ description: The `SyntheticsMobileTest` `device_ids`.
16038
+ items:
16039
+ $ref: '#/components/schemas/SyntheticsMobileDeviceID'
16040
+ type: array
16041
+ message:
16042
+ description: Notification message associated with the test.
16043
+ example: Notification message
16044
+ type: string
16045
+ monitor_id:
16046
+ description: The associated monitor ID.
16047
+ example: 12345678
16048
+ format: int64
16049
+ readOnly: true
16050
+ type: integer
16051
+ name:
16052
+ description: Name of the test.
16053
+ example: Example test name
16054
+ type: string
16055
+ options:
16056
+ $ref: '#/components/schemas/SyntheticsMobileTestOptions'
16057
+ public_id:
16058
+ description: The public ID of the test.
16059
+ example: 123-abc-456
16060
+ readOnly: true
16061
+ type: string
16062
+ status:
16063
+ $ref: '#/components/schemas/SyntheticsTestPauseStatus'
16064
+ steps:
16065
+ description: Array of steps for the test.
16066
+ items:
16067
+ $ref: '#/components/schemas/SyntheticsMobileStep'
16068
+ type: array
16069
+ tags:
16070
+ description: Array of tags attached to the test.
16071
+ example:
16072
+ - env:production
16073
+ items:
16074
+ description: A tag attached to the test.
16075
+ type: string
16076
+ type: array
16077
+ type:
16078
+ $ref: '#/components/schemas/SyntheticsMobileTestType'
16079
+ required:
16080
+ - config
16081
+ - name
16082
+ - options
16083
+ - type
16084
+ type: object
16085
+ SyntheticsMobileTestBinding:
16086
+ description: Objects describing the binding used for a mobile test.
16087
+ properties:
16088
+ items:
16089
+ $ref: '#/components/schemas/SyntheticsMobileTestBindingItems'
16090
+ type: object
16091
+ SyntheticsMobileTestBindingItems:
16092
+ description: Object describing the binding used for a mobile test.
16093
+ properties:
16094
+ principals:
16095
+ $ref: '#/components/schemas/SyntheticsMobileTestBindingPrincipals'
16096
+ role:
16097
+ $ref: '#/components/schemas/SyntheticsMobileTestBindingItemsRole'
16098
+ type: object
16099
+ SyntheticsMobileTestBindingItemsRole:
16100
+ description: The definition of `SyntheticsMobileTestBindingItemsRole` object.
16101
+ enum:
16102
+ - editor
16103
+ - viewer
16104
+ type: string
16105
+ x-enum-varnames:
16106
+ - EDITOR
16107
+ - VIEWER
16108
+ SyntheticsMobileTestBindingPrincipals:
16109
+ description: List of principals for a mobile test binding.
16110
+ items:
16111
+ description: A principal for a mobile test binding.
16112
+ maxLength: 1500
16113
+ type: string
16114
+ type: array
16115
+ SyntheticsMobileTestCiOptions:
16116
+ description: CI/CD options for a Synthetic test.
16117
+ properties:
16118
+ executionRule:
16119
+ $ref: '#/components/schemas/SyntheticsTestExecutionRule'
16120
+ required:
16121
+ - executionRule
16122
+ type: object
16123
+ SyntheticsMobileTestConfig:
16124
+ description: Configuration object for a Synthetic mobile test.
16125
+ properties:
16126
+ initialApplicationArguments:
16127
+ $ref: '#/components/schemas/SyntheticsMobileTestInitialApplicationArguments'
16128
+ variables:
16129
+ description: Array of variables used for the test steps.
16130
+ items:
16131
+ $ref: '#/components/schemas/SyntheticsConfigVariable'
16132
+ type: array
16133
+ type: object
16134
+ SyntheticsMobileTestInitialApplicationArguments:
16135
+ description: Initial application arguments for a mobile test.
16136
+ properties:
16137
+ propertyNames:
16138
+ $ref: '#/components/schemas/SyntheticsMobileTestInitialApplicationArgumentsPropertyNames'
16139
+ type: object
16140
+ SyntheticsMobileTestInitialApplicationArgumentsPropertyNames:
16141
+ description: Name of the property.
16142
+ properties:
16143
+ pattern:
16144
+ description: The `propertyNames` `pattern`.
16145
+ example: ^(?!_dd).*$
16146
+ type: string
16147
+ type: object
16148
+ SyntheticsMobileTestOptions:
16149
+ description: Object describing the extra options for a Synthetic test.
16150
+ properties:
16151
+ allowApplicationCrash:
16152
+ description: The `SyntheticsMobileTestOptions` `allowApplicationCrash`.
16153
+ type: boolean
16154
+ bindings:
16155
+ description: Array of bindings used for the mobile test.
16156
+ items:
16157
+ $ref: '#/components/schemas/SyntheticsMobileTestBinding'
16158
+ type: array
16159
+ ci:
16160
+ $ref: '#/components/schemas/SyntheticsMobileTestCiOptions'
16161
+ defaultStepTimeout:
16162
+ description: The `SyntheticsMobileTestOptions` `defaultStepTimeout`.
16163
+ format: int32
16164
+ maximum: 300
16165
+ minimum: 1
16166
+ type: integer
16167
+ device_ids:
16168
+ description: For mobile test, array with the different device IDs used to
16169
+ run the test.
16170
+ items:
16171
+ $ref: '#/components/schemas/SyntheticsMobileDeviceID'
16172
+ type: array
16173
+ disableAutoAcceptAlert:
16174
+ description: The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.
16175
+ type: boolean
16176
+ min_failure_duration:
16177
+ description: Minimum amount of time in failure required to trigger an alert.
16178
+ format: int64
16179
+ maximum: 7200
16180
+ minimum: 0
16181
+ type: integer
16182
+ mobileApplication:
16183
+ $ref: '#/components/schemas/SyntheticsMobileTestsMobileApplication'
16184
+ monitor_name:
16185
+ description: The monitor name is used for the alert title as well as for
16186
+ all monitor dashboard widgets and SLOs.
16187
+ type: string
16188
+ monitor_options:
16189
+ $ref: '#/components/schemas/SyntheticsMobileTestOptionsMonitorOptions'
16190
+ monitor_priority:
16191
+ description: Integer from 1 (high) to 5 (low) indicating alert severity.
16192
+ format: int32
16193
+ maximum: 5
16194
+ minimum: 1
16195
+ type: integer
16196
+ noScreenshot:
16197
+ description: The `SyntheticsMobileTestOptions` `noScreenshot`.
16198
+ type: boolean
16199
+ restricted_roles:
16200
+ $ref: '#/components/schemas/SyntheticsRestrictedRoles'
16201
+ retry:
16202
+ $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
16203
+ scheduling:
16204
+ $ref: '#/components/schemas/SyntheticsTestOptionsScheduling'
16205
+ tick_every:
16206
+ description: The frequency at which to run the Synthetic test (in seconds).
16207
+ format: int64
16208
+ maximum: 604800
16209
+ minimum: 300
16210
+ type: integer
16211
+ verbosity:
16212
+ description: The `SyntheticsMobileTestOptions` `verbosity`.
16213
+ format: int32
16214
+ maximum: 5
16215
+ minimum: 0
16216
+ type: integer
16217
+ type: object
16218
+ SyntheticsMobileTestOptionsMonitorOptions:
16219
+ description: 'Object containing the options for a mobile Synthetic test as a
16220
+ monitor
16221
+
16222
+ (for example, renotification).'
16223
+ properties:
16224
+ escalation_message:
16225
+ description: Message to include in the escalation notification.
16226
+ type: string
16227
+ notification_preset_name:
16228
+ $ref: '#/components/schemas/SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName'
16229
+ renotify_interval:
16230
+ description: 'Time interval before renotifying if the test is still failing
16231
+
16232
+ (in minutes).'
16233
+ format: int64
16234
+ minimum: 0
16235
+ type: integer
16236
+ renotify_occurrences:
16237
+ description: The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.
16238
+ format: int64
16239
+ type: integer
16240
+ type: object
16241
+ SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName:
16242
+ description: The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName`
16243
+ object.
16244
+ enum:
16245
+ - show_all
16246
+ - hide_all
16247
+ - hide_query
16248
+ - hide_handles
16249
+ type: string
16250
+ x-enum-varnames:
16251
+ - SHOW_ALL
16252
+ - HIDE_ALL
16253
+ - HIDE_QUERY
16254
+ - HIDE_HANDLES
16255
+ SyntheticsMobileTestType:
16256
+ default: mobile
16257
+ description: Type of the Synthetic test, `mobile`.
16258
+ enum:
16259
+ - mobile
16260
+ example: mobile
16261
+ type: string
16262
+ x-enum-varnames:
16263
+ - MOBILE
16264
+ SyntheticsMobileTestsMobileApplication:
16265
+ description: Mobile application for mobile synthetics test.
16266
+ properties:
16267
+ applicationId:
16268
+ description: Application ID of the mobile application.
16269
+ maxLength: 1500
16270
+ type: string
16271
+ referenceId:
16272
+ description: Reference ID of the mobile application.
16273
+ maxLength: 1500
16274
+ type: string
16275
+ referenceType:
16276
+ $ref: '#/components/schemas/SyntheticsMobileTestsMobileApplicationReferenceType'
16277
+ type: object
16278
+ SyntheticsMobileTestsMobileApplicationReferenceType:
16279
+ description: Reference type for the mobile application for a mobile synthetics
16280
+ test.
16281
+ enum:
16282
+ - latest
16283
+ - version
16284
+ type: string
16285
+ x-enum-varnames:
16286
+ - LATEST
16287
+ - VERSION
15461
16288
  SyntheticsParsingOptions:
15462
16289
  description: Parsing options for variables to extract.
15463
16290
  example: {}
@@ -16038,6 +16865,7 @@ components:
16038
16865
  - blocking
16039
16866
  - non_blocking
16040
16867
  - skipped
16868
+ example: blocking
16041
16869
  type: string
16042
16870
  x-enum-varnames:
16043
16871
  - BLOCKING
@@ -16352,8 +17180,7 @@ components:
16352
17180
  description: Persist cookies across redirects.
16353
17181
  type: boolean
16354
17182
  port:
16355
- description: Port to use when performing the test.
16356
- type: string
17183
+ $ref: '#/components/schemas/SyntheticsTestRequestPort'
16357
17184
  proxy:
16358
17185
  $ref: '#/components/schemas/SyntheticsTestRequestProxy'
16359
17186
  query:
@@ -16457,6 +17284,15 @@ components:
16457
17284
  description: Date of update of the certificate or key, ISO format.
16458
17285
  type: string
16459
17286
  type: object
17287
+ SyntheticsTestRequestNumericalPort:
17288
+ description: Integer Port number to use when performing the test.
17289
+ format: int64
17290
+ type: integer
17291
+ SyntheticsTestRequestPort:
17292
+ description: Port to use when performing the test.
17293
+ oneOf:
17294
+ - $ref: '#/components/schemas/SyntheticsTestRequestNumericalPort'
17295
+ - $ref: '#/components/schemas/SyntheticsTestRequestVariablePort'
16460
17296
  SyntheticsTestRequestProxy:
16461
17297
  description: The proxy to perform the test.
16462
17298
  properties:
@@ -16469,6 +17305,28 @@ components:
16469
17305
  required:
16470
17306
  - url
16471
17307
  type: object
17308
+ SyntheticsTestRequestVariablePort:
17309
+ description: String Port number to use when performing the test. Supports templated
17310
+ variables.
17311
+ type: string
17312
+ SyntheticsTestUptime:
17313
+ description: Object containing the uptime for a Synthetic test ID.
17314
+ properties:
17315
+ from_ts:
17316
+ description: Timestamp in seconds for the start of uptime.
17317
+ format: int64
17318
+ type: integer
17319
+ overall:
17320
+ $ref: '#/components/schemas/SyntheticsUptime'
17321
+ public_id:
17322
+ description: A Synthetic test ID.
17323
+ example: abc-def-123
17324
+ type: string
17325
+ to_ts:
17326
+ description: Timestamp in seconds for the end of uptime.
17327
+ format: int64
17328
+ type: integer
17329
+ type: object
16472
17330
  SyntheticsTiming:
16473
17331
  description: 'Object containing all metrics and their values collected for a
16474
17332
  Synthetic API test.
@@ -16592,15 +17450,71 @@ components:
16592
17450
  new_status:
16593
17451
  $ref: '#/components/schemas/SyntheticsTestPauseStatus'
16594
17452
  type: object
16595
- SyntheticsVariableParser:
16596
- description: Details of the parser to use for the global variable.
16597
- example:
16598
- type: regex
16599
- value: .*
17453
+ SyntheticsUptime:
17454
+ description: Object containing the uptime information.
16600
17455
  properties:
16601
- type:
16602
- $ref: '#/components/schemas/SyntheticsGlobalVariableParserType'
16603
- value:
17456
+ errors:
17457
+ description: An array of error objects returned while querying the history
17458
+ data for the service level objective.
17459
+ items:
17460
+ $ref: '#/components/schemas/SLOHistoryResponseErrorWithType'
17461
+ nullable: true
17462
+ type: array
17463
+ group:
17464
+ description: The location name
17465
+ example: name
17466
+ type: string
17467
+ history:
17468
+ description: 'The state transition history for the monitor, represented
17469
+ as an array of
17470
+
17471
+ pairs. Each pair is an array where the first element is the transition
17472
+ timestamp
17473
+
17474
+ in Unix epoch format (integer) and the second element is the state (integer).
17475
+
17476
+ For the state, an integer value of `0` indicates uptime, `1` indicates
17477
+ downtime,
17478
+
17479
+ and `2` indicates no data.'
17480
+ example:
17481
+ - - 1579212382
17482
+ - 0
17483
+ items:
17484
+ description: An array of transitions
17485
+ example:
17486
+ - 1579212382
17487
+ - 0
17488
+ items:
17489
+ description: A timeseries data point which is a tuple of (timestamp,
17490
+ value).
17491
+ format: double
17492
+ type: number
17493
+ maxItems: 2
17494
+ minItems: 2
17495
+ type: array
17496
+ type: array
17497
+ span_precision:
17498
+ description: The number of decimal places to which the SLI value is accurate
17499
+ for the given from-to timestamps.
17500
+ example: 2.0
17501
+ format: double
17502
+ type: number
17503
+ uptime:
17504
+ description: The overall uptime.
17505
+ example: 99.99
17506
+ format: double
17507
+ type: number
17508
+ type: object
17509
+ SyntheticsVariableParser:
17510
+ description: Details of the parser to use for the global variable.
17511
+ example:
17512
+ type: regex
17513
+ value: .*
17514
+ properties:
17515
+ type:
17516
+ $ref: '#/components/schemas/SyntheticsGlobalVariableParserType'
17517
+ value:
16604
17518
  description: Regex or JSON path used for the parser. Not used with type
16605
17519
  `raw`.
16606
17520
  type: string
@@ -16740,6 +17654,181 @@ components:
16740
17654
  $ref: '#/components/schemas/LogQueryDefinition'
16741
17655
  sort:
16742
17656
  $ref: '#/components/schemas/WidgetSortBy'
17657
+ text_formats:
17658
+ description: List of text formats for columns produced by tags.
17659
+ items:
17660
+ $ref: '#/components/schemas/TableWidgetTextFormat'
17661
+ type: array
17662
+ type: object
17663
+ TableWidgetTextFormat:
17664
+ description: Text format rules for a tag-based column within a table widget.
17665
+ example:
17666
+ - match:
17667
+ type: is
17668
+ value: fruit
17669
+ replace:
17670
+ type: all
17671
+ with: vegetable
17672
+ - match:
17673
+ type: is
17674
+ value: cake
17675
+ palette: white_on_green
17676
+ items:
17677
+ $ref: '#/components/schemas/TableWidgetTextFormatRule'
17678
+ minItems: 1
17679
+ type: array
17680
+ TableWidgetTextFormatMatch:
17681
+ description: Match rule for the table widget text format.
17682
+ example:
17683
+ type: is
17684
+ value: fruit
17685
+ properties:
17686
+ type:
17687
+ $ref: '#/components/schemas/TableWidgetTextFormatMatchType'
17688
+ value:
17689
+ description: Table Widget Match String.
17690
+ example: Match Value
17691
+ type: string
17692
+ required:
17693
+ - type
17694
+ - value
17695
+ type: object
17696
+ TableWidgetTextFormatMatchType:
17697
+ description: Match or compare option.
17698
+ enum:
17699
+ - is
17700
+ - is_not
17701
+ - contains
17702
+ - does_not_contain
17703
+ - starts_with
17704
+ - ends_with
17705
+ example: is
17706
+ type: string
17707
+ x-enum-varnames:
17708
+ - IS
17709
+ - IS_NOT
17710
+ - CONTAINS
17711
+ - DOES_NOT_CONTAIN
17712
+ - STARTS_WITH
17713
+ - ENDS_WITH
17714
+ TableWidgetTextFormatPalette:
17715
+ default: white_on_green
17716
+ description: Color-on-color palette to highlight replaced text.
17717
+ enum:
17718
+ - white_on_red
17719
+ - white_on_yellow
17720
+ - white_on_green
17721
+ - black_on_light_red
17722
+ - black_on_light_yellow
17723
+ - black_on_light_green
17724
+ - red_on_white
17725
+ - yellow_on_white
17726
+ - green_on_white
17727
+ - custom_bg
17728
+ - custom_text
17729
+ type: string
17730
+ x-enum-varnames:
17731
+ - WHITE_ON_RED
17732
+ - WHITE_ON_YELLOW
17733
+ - WHITE_ON_GREEN
17734
+ - BLACK_ON_LIGHT_RED
17735
+ - BLACK_ON_LIGHT_YELLOW
17736
+ - BLACK_ON_LIGHT_GREEN
17737
+ - RED_ON_WHITE
17738
+ - YELLOW_ON_WHITE
17739
+ - GREEN_ON_WHITE
17740
+ - CUSTOM_BG
17741
+ - CUSTOM_TEXT
17742
+ TableWidgetTextFormatReplace:
17743
+ description: Replace rule for the table widget text format.
17744
+ example:
17745
+ type: all
17746
+ with: vegetable
17747
+ oneOf:
17748
+ - $ref: '#/components/schemas/TableWidgetTextFormatReplaceAll'
17749
+ - $ref: '#/components/schemas/TableWidgetTextFormatReplaceSubstring'
17750
+ TableWidgetTextFormatReplaceAll:
17751
+ description: Match All definition.
17752
+ example:
17753
+ type: all
17754
+ with: vegetable
17755
+ properties:
17756
+ type:
17757
+ $ref: '#/components/schemas/TableWidgetTextFormatReplaceAllType'
17758
+ with:
17759
+ description: Replace All type.
17760
+ example: all
17761
+ type: string
17762
+ required:
17763
+ - type
17764
+ - with
17765
+ type: object
17766
+ TableWidgetTextFormatReplaceAllType:
17767
+ description: Table widget text format replace all type.
17768
+ enum:
17769
+ - all
17770
+ example: all
17771
+ type: string
17772
+ x-enum-varnames:
17773
+ - ALL
17774
+ TableWidgetTextFormatReplaceSubstring:
17775
+ description: Match Sub-string definition.
17776
+ example:
17777
+ substring: fruit
17778
+ type: substring
17779
+ with: vegetable
17780
+ properties:
17781
+ substring:
17782
+ description: Text that will be replaced.
17783
+ example: string to replace
17784
+ type: string
17785
+ type:
17786
+ $ref: '#/components/schemas/TableWidgetTextFormatReplaceSubstringType'
17787
+ with:
17788
+ description: Text that will replace original sub-string.
17789
+ example: replacement
17790
+ type: string
17791
+ required:
17792
+ - type
17793
+ - with
17794
+ - substring
17795
+ type: object
17796
+ TableWidgetTextFormatReplaceSubstringType:
17797
+ description: Table widget text format replace sub-string type.
17798
+ enum:
17799
+ - substring
17800
+ example: substring
17801
+ type: string
17802
+ x-enum-varnames:
17803
+ - SUBSTRING
17804
+ TableWidgetTextFormatRule:
17805
+ description: Text format rules.
17806
+ example:
17807
+ match:
17808
+ type: is
17809
+ value: apple
17810
+ replace:
17811
+ type: all
17812
+ with: vegetable
17813
+ properties:
17814
+ custom_bg_color:
17815
+ description: Hex representation of the custom background color. Used with
17816
+ custom background palette option.
17817
+ example: '#632ca6'
17818
+ type: string
17819
+ custom_fg_color:
17820
+ description: Hex representation of the custom text color. Used with custom
17821
+ text palette option.
17822
+ example: '#632ca6'
17823
+ type: string
17824
+ match:
17825
+ $ref: '#/components/schemas/TableWidgetTextFormatMatch'
17826
+ palette:
17827
+ $ref: '#/components/schemas/TableWidgetTextFormatPalette'
17828
+ replace:
17829
+ $ref: '#/components/schemas/TableWidgetTextFormatReplace'
17830
+ required:
17831
+ - match
16743
17832
  type: object
16744
17833
  TagToHosts:
16745
17834
  description: In this object, the key is the tag, the value is a list of host
@@ -19096,6 +20185,11 @@ components:
19096
20185
  over all hours in the current date for all organizations.
19097
20186
  format: int64
19098
20187
  type: integer
20188
+ data_jobs_monitoring_host_hr_sum:
20189
+ description: Shows the sum of all Data Jobs Monitoring hosts over all hours
20190
+ in the current date for the given org.
20191
+ format: int64
20192
+ type: integer
19099
20193
  date:
19100
20194
  description: The date for the usage.
19101
20195
  format: date-time
@@ -19288,6 +20382,16 @@ components:
19288
20382
  hours in the current date for the given org.
19289
20383
  format: int64
19290
20384
  type: integer
20385
+ oci_host_sum:
20386
+ description: Shows the sum of all Oracle Cloud Infrastructure hosts over
20387
+ all hours in the current date for the given org.
20388
+ format: int64
20389
+ type: integer
20390
+ oci_host_top99p:
20391
+ description: Shows the 99th percentile of all Oracle Cloud Infrastructure
20392
+ hosts over all hours in the current date for the given org.
20393
+ format: int64
20394
+ type: integer
19291
20395
  online_archive_events_count_sum:
19292
20396
  description: Sum of all online archived events over all hours in the current
19293
20397
  date for all organizations.
@@ -19831,6 +20935,11 @@ components:
19831
20935
  over all hours in the current date for the given org.
19832
20936
  format: int64
19833
20937
  type: integer
20938
+ data_jobs_monitoring_host_hr_sum:
20939
+ description: Shows the sum of all Data Jobs Monitoring hosts over all hours
20940
+ in the current date for the given org.
20941
+ format: int64
20942
+ type: integer
19834
20943
  dbm_host_top99p_sum:
19835
20944
  description: Shows the 99th percentile of all Database Monitoring hosts
19836
20945
  over all hours in the current month for the given org.
@@ -20022,6 +21131,16 @@ components:
20022
21131
  hours in the current date for the given org.
20023
21132
  format: int64
20024
21133
  type: integer
21134
+ oci_host_sum:
21135
+ description: Shows the sum of all Oracle Cloud Infrastructure hosts over
21136
+ all hours in the current date for the given org.
21137
+ format: int64
21138
+ type: integer
21139
+ oci_host_top99p:
21140
+ description: Shows the 99th percentile of all Oracle Cloud Infrastructure
21141
+ hosts over all hours in the current date for the given org.
21142
+ format: int64
21143
+ type: integer
20025
21144
  online_archive_events_count_sum:
20026
21145
  description: Sum of all online archived events over all hours in the current
20027
21146
  date for the given org.
@@ -20565,6 +21684,11 @@ components:
20565
21684
  over all hours in the current month for all organizations.
20566
21685
  format: int64
20567
21686
  type: integer
21687
+ data_jobs_monitoring_host_hr_agg_sum:
21688
+ description: Shows the sum of Data Jobs Monitoring hosts over all hours
21689
+ in the current months for all organizations
21690
+ format: int64
21691
+ type: integer
20568
21692
  dbm_host_top99p_sum:
20569
21693
  description: Shows the 99th percentile of all Database Monitoring hosts
20570
21694
  over all hours in the current month for all organizations.
@@ -20779,6 +21903,16 @@ components:
20779
21903
  hours in the current month for all organizations.
20780
21904
  format: int64
20781
21905
  type: integer
21906
+ oci_host_agg_sum:
21907
+ description: Shows the sum of Oracle Cloud Infrastructure hosts over all
21908
+ hours in the current months for all organizations
21909
+ format: int64
21910
+ type: integer
21911
+ oci_host_top99p_sum:
21912
+ description: Shows the 99th percentile of Oracle Cloud Infrastructure hosts
21913
+ over all hours in the current months for all organizations
21914
+ format: int64
21915
+ type: integer
20782
21916
  online_archive_events_count_agg_sum:
20783
21917
  description: Sum of all online archived events over all hours in the current
20784
21918
  month for all organizations.
@@ -22395,6 +23529,7 @@ components:
22395
23529
  access to the cloud cost data source in dashboards and notebooks.
22396
23530
  cloud_cost_management_write: Configure cloud cost accounts and global
22397
23531
  customizations.
23532
+ code_analysis_read: View Code Analysis.
22398
23533
  continuous_profiler_pgo_read: Read and query Continuous Profiler data
22399
23534
  for Profile-Guided Optimization (PGO).
22400
23535
  create_webhooks: Create webhooks integrations.
@@ -22430,6 +23565,8 @@ components:
22430
23565
  security_monitoring_signals_read: View Security Signals.
22431
23566
  security_monitoring_suppressions_read: Read Rule Suppressions.
22432
23567
  security_monitoring_suppressions_write: Write Rule Suppressions.
23568
+ security_pipelines_read: View Security Pipelines.
23569
+ security_pipelines_write: Create, edit, and delete CSM Security Pipelines.
22433
23570
  slos_corrections: Apply, edit, and delete SLO status corrections. A user
22434
23571
  with this permission can make status corrections, even if they do not
22435
23572
  have permission to edit those SLOs.
@@ -22565,6 +23702,10 @@ paths:
22565
23702
  summary: Get all API keys
22566
23703
  tags:
22567
23704
  - Key Management
23705
+ x-permission:
23706
+ operator: OR
23707
+ permissions:
23708
+ - api_keys_read
22568
23709
  post:
22569
23710
  description: Creates an API key with a given name.
22570
23711
  operationId: CreateAPIKey
@@ -22599,6 +23740,10 @@ paths:
22599
23740
  tags:
22600
23741
  - Key Management
22601
23742
  x-codegen-request-body-name: body
23743
+ x-permission:
23744
+ operator: OR
23745
+ permissions:
23746
+ - api_keys_write
22602
23747
  /api/v1/api_key/{key}:
22603
23748
  delete:
22604
23749
  description: Delete a given API key.
@@ -22640,6 +23785,10 @@ paths:
22640
23785
  summary: Delete an API key
22641
23786
  tags:
22642
23787
  - Key Management
23788
+ x-permission:
23789
+ operator: OR
23790
+ permissions:
23791
+ - api_keys_delete
22643
23792
  get:
22644
23793
  description: Get a given API key.
22645
23794
  operationId: GetAPIKey
@@ -22674,6 +23823,10 @@ paths:
22674
23823
  summary: Get API key
22675
23824
  tags:
22676
23825
  - Key Management
23826
+ x-permission:
23827
+ operator: OR
23828
+ permissions:
23829
+ - api_keys_read
22677
23830
  put:
22678
23831
  description: Edit an API key name.
22679
23832
  operationId: UpdateAPIKey
@@ -22721,6 +23874,10 @@ paths:
22721
23874
  tags:
22722
23875
  - Key Management
22723
23876
  x-codegen-request-body-name: body
23877
+ x-permission:
23878
+ operator: OR
23879
+ permissions:
23880
+ - api_keys_write
22724
23881
  /api/v1/application_key:
22725
23882
  get:
22726
23883
  description: Get all application keys available for your Datadog account.
@@ -22743,6 +23900,11 @@ paths:
22743
23900
  summary: Get all application keys
22744
23901
  tags:
22745
23902
  - Key Management
23903
+ x-permission:
23904
+ operator: OR
23905
+ permissions:
23906
+ - org_app_keys_read
23907
+ - user_app_keys
22746
23908
  post:
22747
23909
  description: Create an application key with a given name.
22748
23910
  operationId: CreateApplicationKey
@@ -22783,6 +23945,10 @@ paths:
22783
23945
  tags:
22784
23946
  - Key Management
22785
23947
  x-codegen-request-body-name: body
23948
+ x-permission:
23949
+ operator: OR
23950
+ permissions:
23951
+ - user_app_keys
22786
23952
  /api/v1/application_key/{key}:
22787
23953
  delete:
22788
23954
  description: Delete a given application key.
@@ -22818,6 +23984,11 @@ paths:
22818
23984
  summary: Delete an application key
22819
23985
  tags:
22820
23986
  - Key Management
23987
+ x-permission:
23988
+ operator: OR
23989
+ permissions:
23990
+ - org_app_keys_write
23991
+ - user_app_keys
22821
23992
  get:
22822
23993
  description: Get a given application key.
22823
23994
  operationId: GetApplicationKey
@@ -22852,6 +24023,11 @@ paths:
22852
24023
  summary: Get an application key
22853
24024
  tags:
22854
24025
  - Key Management
24026
+ x-permission:
24027
+ operator: OR
24028
+ permissions:
24029
+ - org_app_keys_read
24030
+ - user_app_keys
22855
24031
  put:
22856
24032
  description: Edit an application key name.
22857
24033
  operationId: UpdateApplicationKey
@@ -22905,6 +24081,11 @@ paths:
22905
24081
  tags:
22906
24082
  - Key Management
22907
24083
  x-codegen-request-body-name: body
24084
+ x-permission:
24085
+ operator: OR
24086
+ permissions:
24087
+ - org_app_keys_write
24088
+ - user_app_keys
22908
24089
  /api/v1/check_run:
22909
24090
  post:
22910
24091
  description: 'Submit a list of Service Checks.
@@ -23022,6 +24203,10 @@ paths:
23022
24203
  summary: Get the list of available daily custom reports
23023
24204
  tags:
23024
24205
  - Usage Metering
24206
+ x-permission:
24207
+ operator: OR
24208
+ permissions:
24209
+ - usage_read
23025
24210
  /api/v1/daily_custom_reports/{report_id}:
23026
24211
  get:
23027
24212
  deprecated: true
@@ -23067,6 +24252,10 @@ paths:
23067
24252
  summary: Get specified daily custom reports
23068
24253
  tags:
23069
24254
  - Usage Metering
24255
+ x-permission:
24256
+ operator: OR
24257
+ permissions:
24258
+ - usage_read
23070
24259
  /api/v1/dashboard:
23071
24260
  delete:
23072
24261
  description: Delete dashboards using the specified IDs. If there are any failures,
@@ -23119,6 +24308,10 @@ paths:
23119
24308
  tags:
23120
24309
  - Dashboards
23121
24310
  x-codegen-request-body-name: body
24311
+ x-permission:
24312
+ operator: OR
24313
+ permissions:
24314
+ - dashboards_write
23122
24315
  get:
23123
24316
  description: 'Get all dashboards.
23124
24317
 
@@ -23186,6 +24379,10 @@ paths:
23186
24379
  limitParam: count
23187
24380
  pageOffsetParam: start
23188
24381
  resultsPath: dashboards
24382
+ x-permission:
24383
+ operator: OR
24384
+ permissions:
24385
+ - dashboards_read
23189
24386
  patch:
23190
24387
  description: Restore dashboards using the specified IDs. If there are any failures,
23191
24388
  no dashboards will be restored (partial success is not allowed).
@@ -23237,6 +24434,10 @@ paths:
23237
24434
  tags:
23238
24435
  - Dashboards
23239
24436
  x-codegen-request-body-name: body
24437
+ x-permission:
24438
+ operator: OR
24439
+ permissions:
24440
+ - dashboards_write
23240
24441
  post:
23241
24442
  description: 'Create a dashboard using the specified options. When defining
23242
24443
  queries in your widgets, take note of which queries should have the `as_count()`
@@ -23282,6 +24483,10 @@ paths:
23282
24483
  tags:
23283
24484
  - Dashboards
23284
24485
  x-codegen-request-body-name: body
24486
+ x-permission:
24487
+ operator: OR
24488
+ permissions:
24489
+ - dashboards_write
23285
24490
  /api/v1/dashboard/lists/manual:
23286
24491
  get:
23287
24492
  description: Fetch all of your existing dashboard list definitions.
@@ -23309,6 +24514,10 @@ paths:
23309
24514
  summary: Get all dashboard lists
23310
24515
  tags:
23311
24516
  - Dashboard Lists
24517
+ x-permission:
24518
+ operator: OR
24519
+ permissions:
24520
+ - dashboards_read
23312
24521
  post:
23313
24522
  description: Create an empty dashboard list.
23314
24523
  operationId: CreateDashboardList
@@ -23349,6 +24558,10 @@ paths:
23349
24558
  tags:
23350
24559
  - Dashboard Lists
23351
24560
  x-codegen-request-body-name: body
24561
+ x-permission:
24562
+ operator: OR
24563
+ permissions:
24564
+ - dashboards_write
23352
24565
  /api/v1/dashboard/lists/manual/{list_id}:
23353
24566
  delete:
23354
24567
  description: Delete a dashboard list.
@@ -23390,6 +24603,10 @@ paths:
23390
24603
  summary: Delete a dashboard list
23391
24604
  tags:
23392
24605
  - Dashboard Lists
24606
+ x-permission:
24607
+ operator: OR
24608
+ permissions:
24609
+ - dashboards_write
23393
24610
  get:
23394
24611
  description: Fetch an existing dashboard list's definition.
23395
24612
  operationId: GetDashboardList
@@ -23430,6 +24647,10 @@ paths:
23430
24647
  summary: Get a dashboard list
23431
24648
  tags:
23432
24649
  - Dashboard Lists
24650
+ x-permission:
24651
+ operator: OR
24652
+ permissions:
24653
+ - dashboards_read
23433
24654
  put:
23434
24655
  description: Update the name of a dashboard list.
23435
24656
  operationId: UpdateDashboardList
@@ -23484,6 +24705,10 @@ paths:
23484
24705
  tags:
23485
24706
  - Dashboard Lists
23486
24707
  x-codegen-request-body-name: body
24708
+ x-permission:
24709
+ operator: OR
24710
+ permissions:
24711
+ - dashboards_write
23487
24712
  /api/v1/dashboard/public:
23488
24713
  post:
23489
24714
  description: Share a specified private dashboard, generating a URL at which
@@ -23538,6 +24763,10 @@ paths:
23538
24763
  tags:
23539
24764
  - Dashboards
23540
24765
  x-codegen-request-body-name: body
24766
+ x-permission:
24767
+ operator: OR
24768
+ permissions:
24769
+ - dashboards_public_share
23541
24770
  /api/v1/dashboard/public/{token}:
23542
24771
  delete:
23543
24772
  description: Revoke the public URL for a dashboard (rendering it private) associated
@@ -23579,6 +24808,10 @@ paths:
23579
24808
  summary: Revoke a shared dashboard URL
23580
24809
  tags:
23581
24810
  - Dashboards
24811
+ x-permission:
24812
+ operator: OR
24813
+ permissions:
24814
+ - dashboards_public_share
23582
24815
  get:
23583
24816
  description: Fetch an existing shared dashboard's sharing metadata associated
23584
24817
  with the specified token.
@@ -23620,6 +24853,10 @@ paths:
23620
24853
  summary: Get a shared dashboard
23621
24854
  tags:
23622
24855
  - Dashboards
24856
+ x-permission:
24857
+ operator: OR
24858
+ permissions:
24859
+ - dashboards_read
23623
24860
  put:
23624
24861
  description: Update a shared dashboard associated with the specified token.
23625
24862
  operationId: UpdatePublicDashboard
@@ -23689,6 +24926,10 @@ paths:
23689
24926
  tags:
23690
24927
  - Dashboards
23691
24928
  x-codegen-request-body-name: body
24929
+ x-permission:
24930
+ operator: OR
24931
+ permissions:
24932
+ - dashboards_public_share
23692
24933
  /api/v1/dashboard/public/{token}/invitation:
23693
24934
  delete:
23694
24935
  description: Revoke previously sent invitation emails and active sessions used
@@ -23741,6 +24982,10 @@ paths:
23741
24982
  tags:
23742
24983
  - Dashboards
23743
24984
  x-codegen-request-body-name: body
24985
+ x-permission:
24986
+ operator: OR
24987
+ permissions:
24988
+ - dashboards_public_share
23744
24989
  get:
23745
24990
  description: Describe the invitations that exist for the given shared dashboard
23746
24991
  (paginated).
@@ -23795,6 +25040,10 @@ paths:
23795
25040
  summary: Get all invitations for a shared dashboard
23796
25041
  tags:
23797
25042
  - Dashboards
25043
+ x-permission:
25044
+ operator: OR
25045
+ permissions:
25046
+ - dashboards_public_share
23798
25047
  post:
23799
25048
  description: Send emails to specified email addresses containing links to access
23800
25049
  a given authenticated shared dashboard. Email addresses must already belong
@@ -23857,6 +25106,10 @@ paths:
23857
25106
  tags:
23858
25107
  - Dashboards
23859
25108
  x-codegen-request-body-name: body
25109
+ x-permission:
25110
+ operator: OR
25111
+ permissions:
25112
+ - dashboards_public_share
23860
25113
  /api/v1/dashboard/{dashboard_id}:
23861
25114
  delete:
23862
25115
  description: Delete a dashboard using the specified ID.
@@ -23897,6 +25150,10 @@ paths:
23897
25150
  summary: Delete a dashboard
23898
25151
  tags:
23899
25152
  - Dashboards
25153
+ x-permission:
25154
+ operator: OR
25155
+ permissions:
25156
+ - dashboards_write
23900
25157
  get:
23901
25158
  description: Get a dashboard using the specified ID.
23902
25159
  operationId: GetDashboard
@@ -23936,6 +25193,10 @@ paths:
23936
25193
  summary: Get a dashboard
23937
25194
  tags:
23938
25195
  - Dashboards
25196
+ x-permission:
25197
+ operator: OR
25198
+ permissions:
25199
+ - dashboards_read
23939
25200
  put:
23940
25201
  description: Update a dashboard using the specified ID.
23941
25202
  operationId: UpdateDashboard
@@ -23989,6 +25250,10 @@ paths:
23989
25250
  tags:
23990
25251
  - Dashboards
23991
25252
  x-codegen-request-body-name: body
25253
+ x-permission:
25254
+ operator: OR
25255
+ permissions:
25256
+ - dashboards_write
23992
25257
  /api/v1/distribution_points:
23993
25258
  post:
23994
25259
  description: "The distribution points end-point allows you to post distribution
@@ -24098,6 +25363,10 @@ paths:
24098
25363
  summary: Get all downtimes
24099
25364
  tags:
24100
25365
  - Downtimes
25366
+ x-permission:
25367
+ operator: OR
25368
+ permissions:
25369
+ - monitors_read
24101
25370
  post:
24102
25371
  deprecated: true
24103
25372
  description: Schedule a downtime. **Note:** This endpoint has been deprecated.
@@ -24140,6 +25409,10 @@ paths:
24140
25409
  tags:
24141
25410
  - Downtimes
24142
25411
  x-codegen-request-body-name: body
25412
+ x-permission:
25413
+ operator: OR
25414
+ permissions:
25415
+ - monitors_downtime
24143
25416
  /api/v1/downtime/cancel/by_scope:
24144
25417
  post:
24145
25418
  deprecated: true
@@ -24191,6 +25464,10 @@ paths:
24191
25464
  tags:
24192
25465
  - Downtimes
24193
25466
  x-codegen-request-body-name: body
25467
+ x-permission:
25468
+ operator: OR
25469
+ permissions:
25470
+ - monitors_downtime
24194
25471
  /api/v1/downtime/{downtime_id}:
24195
25472
  delete:
24196
25473
  deprecated: true
@@ -24231,6 +25508,10 @@ paths:
24231
25508
  summary: Cancel a downtime
24232
25509
  tags:
24233
25510
  - Downtimes
25511
+ x-permission:
25512
+ operator: OR
25513
+ permissions:
25514
+ - monitors_downtime
24234
25515
  get:
24235
25516
  deprecated: true
24236
25517
  description: Get downtime detail by `downtime_id`. **Note:** This endpoint has
@@ -24274,6 +25555,10 @@ paths:
24274
25555
  summary: Get a downtime
24275
25556
  tags:
24276
25557
  - Downtimes
25558
+ x-permission:
25559
+ operator: OR
25560
+ permissions:
25561
+ - monitors_read
24277
25562
  put:
24278
25563
  deprecated: true
24279
25564
  description: Update a single downtime by `downtime_id`. **Note:** This endpoint
@@ -24332,6 +25617,10 @@ paths:
24332
25617
  tags:
24333
25618
  - Downtimes
24334
25619
  x-codegen-request-body-name: body
25620
+ x-permission:
25621
+ operator: OR
25622
+ permissions:
25623
+ - monitors_downtime
24335
25624
  /api/v1/events:
24336
25625
  get:
24337
25626
  description: "The event stream can be queried and filtered by time, priority,
@@ -24442,6 +25731,10 @@ paths:
24442
25731
  summary: Get a list of events
24443
25732
  tags:
24444
25733
  - Events
25734
+ x-permission:
25735
+ operator: OR
25736
+ permissions:
25737
+ - events_read
24445
25738
  post:
24446
25739
  description: 'This endpoint allows you to post events to the stream.
24447
25740
 
@@ -24518,6 +25811,10 @@ paths:
24518
25811
  summary: Get an event
24519
25812
  tags:
24520
25813
  - Events
25814
+ x-permission:
25815
+ operator: OR
25816
+ permissions:
25817
+ - events_read
24521
25818
  /api/v1/graph/snapshot:
24522
25819
  get:
24523
25820
  description: 'Take graph snapshots.
@@ -24613,6 +25910,9 @@ paths:
24613
25910
  summary: Take graph snapshots
24614
25911
  tags:
24615
25912
  - Snapshots
25913
+ x-permission:
25914
+ operator: OPEN
25915
+ permissions: []
24616
25916
  /api/v1/host/{host_name}/mute:
24617
25917
  post:
24618
25918
  description: Mute a host. **Note:** This creates a [Downtime V2](https://docs.datadoghq.com/api/latest/downtimes/#schedule-a-downtime)
@@ -24789,6 +26089,10 @@ paths:
24789
26089
  summary: Get all hosts for your organization
24790
26090
  tags:
24791
26091
  - Hosts
26092
+ x-permission:
26093
+ operator: OR
26094
+ permissions:
26095
+ - hosts_read
24792
26096
  /api/v1/hosts/totals:
24793
26097
  get:
24794
26098
  description: 'This endpoint returns the total number of active and up hosts
@@ -24835,6 +26139,10 @@ paths:
24835
26139
  summary: Get the total number of active hosts
24836
26140
  tags:
24837
26141
  - Hosts
26142
+ x-permission:
26143
+ operator: OR
26144
+ permissions:
26145
+ - hosts_read
24838
26146
  /api/v1/integration/aws:
24839
26147
  delete:
24840
26148
  description: Delete a Datadog-AWS integration matching the specified `account_id`
@@ -24878,6 +26186,10 @@ paths:
24878
26186
  tags:
24879
26187
  - AWS Integration
24880
26188
  x-codegen-request-body-name: body
26189
+ x-permission:
26190
+ operator: OR
26191
+ permissions:
26192
+ - aws_configurations_manage
24881
26193
  get:
24882
26194
  description: List all Datadog-AWS integrations available in your Datadog organization.
24883
26195
  operationId: ListAWSAccounts
@@ -24924,6 +26236,10 @@ paths:
24924
26236
  summary: List all AWS integrations
24925
26237
  tags:
24926
26238
  - AWS Integration
26239
+ x-permission:
26240
+ operator: OR
26241
+ permissions:
26242
+ - aws_configuration_read
24927
26243
  post:
24928
26244
  description: 'Create a Datadog-Amazon Web Services integration.
24929
26245
 
@@ -24971,6 +26287,10 @@ paths:
24971
26287
  tags:
24972
26288
  - AWS Integration
24973
26289
  x-codegen-request-body-name: body
26290
+ x-permission:
26291
+ operator: OR
26292
+ permissions:
26293
+ - aws_configurations_manage
24974
26294
  put:
24975
26295
  description: Update a Datadog-Amazon Web Services integration.
24976
26296
  operationId: UpdateAWSAccount
@@ -25035,6 +26355,10 @@ paths:
25035
26355
  tags:
25036
26356
  - AWS Integration
25037
26357
  x-codegen-request-body-name: body
26358
+ x-permission:
26359
+ operator: OR
26360
+ permissions:
26361
+ - aws_configuration_edit
25038
26362
  /api/v1/integration/aws/available_namespace_rules:
25039
26363
  get:
25040
26364
  description: List all namespace rules for a given Datadog-AWS integration. This
@@ -25064,6 +26388,10 @@ paths:
25064
26388
  summary: List namespace rules
25065
26389
  tags:
25066
26390
  - AWS Integration
26391
+ x-permission:
26392
+ operator: OR
26393
+ permissions:
26394
+ - aws_configuration_read
25067
26395
  /api/v1/integration/aws/event_bridge:
25068
26396
  delete:
25069
26397
  description: Delete an Amazon EventBridge source.
@@ -25101,6 +26429,10 @@ paths:
25101
26429
  tags:
25102
26430
  - AWS Integration
25103
26431
  x-codegen-request-body-name: body
26432
+ x-permission:
26433
+ operator: OR
26434
+ permissions:
26435
+ - manage_integrations
25104
26436
  get:
25105
26437
  description: Get all Amazon EventBridge sources.
25106
26438
  operationId: ListAWSEventBridgeSources
@@ -25129,6 +26461,9 @@ paths:
25129
26461
  summary: Get all Amazon EventBridge sources
25130
26462
  tags:
25131
26463
  - AWS Integration
26464
+ x-permission:
26465
+ operator: OPEN
26466
+ permissions: []
25132
26467
  post:
25133
26468
  description: Create an Amazon EventBridge source.
25134
26469
  operationId: CreateAWSEventBridgeSource
@@ -25165,6 +26500,10 @@ paths:
25165
26500
  tags:
25166
26501
  - AWS Integration
25167
26502
  x-codegen-request-body-name: body
26503
+ x-permission:
26504
+ operator: OR
26505
+ permissions:
26506
+ - manage_integrations
25168
26507
  /api/v1/integration/aws/filtering:
25169
26508
  delete:
25170
26509
  description: Delete a tag filtering entry.
@@ -25203,6 +26542,10 @@ paths:
25203
26542
  tags:
25204
26543
  - AWS Integration
25205
26544
  x-codegen-request-body-name: body
26545
+ x-permission:
26546
+ operator: OR
26547
+ permissions:
26548
+ - aws_configuration_edit
25206
26549
  get:
25207
26550
  description: Get all AWS tag filters.
25208
26551
  operationId: ListAWSTagFilters
@@ -25237,6 +26580,10 @@ paths:
25237
26580
  summary: Get all AWS tag filters
25238
26581
  tags:
25239
26582
  - AWS Integration
26583
+ x-permission:
26584
+ operator: OR
26585
+ permissions:
26586
+ - aws_configuration_read
25240
26587
  post:
25241
26588
  description: Set an AWS tag filter.
25242
26589
  operationId: CreateAWSTagFilter
@@ -25277,6 +26624,10 @@ paths:
25277
26624
  tags:
25278
26625
  - AWS Integration
25279
26626
  x-codegen-request-body-name: body
26627
+ x-permission:
26628
+ operator: OR
26629
+ permissions:
26630
+ - aws_configuration_edit
25280
26631
  /api/v1/integration/aws/generate_new_external_id:
25281
26632
  put:
25282
26633
  description: Generate a new AWS external ID for a given AWS account ID and role
@@ -25318,6 +26669,10 @@ paths:
25318
26669
  tags:
25319
26670
  - AWS Integration
25320
26671
  x-codegen-request-body-name: body
26672
+ x-permission:
26673
+ operator: OR
26674
+ permissions:
26675
+ - aws_configuration_edit
25321
26676
  /api/v1/integration/aws/logs:
25322
26677
  delete:
25323
26678
  description: Delete a Datadog-AWS logs configuration by removing the specific
@@ -25355,6 +26710,10 @@ paths:
25355
26710
  tags:
25356
26711
  - AWS Logs Integration
25357
26712
  x-codegen-request-body-name: body
26713
+ x-permission:
26714
+ operator: OR
26715
+ permissions:
26716
+ - aws_configuration_edit
25358
26717
  get:
25359
26718
  description: List all Datadog-AWS Logs integrations configured in your Datadog
25360
26719
  account.
@@ -25395,6 +26754,10 @@ paths:
25395
26754
  summary: List all AWS Logs integrations
25396
26755
  tags:
25397
26756
  - AWS Logs Integration
26757
+ x-permission:
26758
+ operator: OR
26759
+ permissions:
26760
+ - aws_configuration_read
25398
26761
  post:
25399
26762
  description: Attach the Lambda ARN of the Lambda created for the Datadog-AWS
25400
26763
  log collection to your AWS account ID to enable log collection.
@@ -25431,6 +26794,10 @@ paths:
25431
26794
  tags:
25432
26795
  - AWS Logs Integration
25433
26796
  x-codegen-request-body-name: body
26797
+ x-permission:
26798
+ operator: OR
26799
+ permissions:
26800
+ - aws_configuration_edit
25434
26801
  /api/v1/integration/aws/logs/check_async:
25435
26802
  post:
25436
26803
  description: 'Test if permissions are present to add a log-forwarding triggers
@@ -25483,6 +26850,10 @@ paths:
25483
26850
  tags:
25484
26851
  - AWS Logs Integration
25485
26852
  x-codegen-request-body-name: body
26853
+ x-permission:
26854
+ operator: OR
26855
+ permissions:
26856
+ - aws_configuration_read
25486
26857
  /api/v1/integration/aws/logs/services:
25487
26858
  get:
25488
26859
  description: Get the list of current AWS services that Datadog offers automatic
@@ -25522,6 +26893,10 @@ paths:
25522
26893
  summary: Get list of AWS log ready services
25523
26894
  tags:
25524
26895
  - AWS Logs Integration
26896
+ x-permission:
26897
+ operator: OR
26898
+ permissions:
26899
+ - aws_configuration_read
25525
26900
  post:
25526
26901
  description: Enable automatic log collection for a list of services. This should
25527
26902
  be run after running `CreateAWSLambdaARN` to save the configuration.
@@ -25558,6 +26933,10 @@ paths:
25558
26933
  tags:
25559
26934
  - AWS Logs Integration
25560
26935
  x-codegen-request-body-name: body
26936
+ x-permission:
26937
+ operator: OR
26938
+ permissions:
26939
+ - aws_configuration_edit
25561
26940
  /api/v1/integration/aws/logs/services_async:
25562
26941
  post:
25563
26942
  description: "Test if permissions are present to add log-forwarding triggers
@@ -25600,6 +26979,10 @@ paths:
25600
26979
  tags:
25601
26980
  - AWS Logs Integration
25602
26981
  x-codegen-request-body-name: body
26982
+ x-permission:
26983
+ operator: OR
26984
+ permissions:
26985
+ - aws_configuration_read
25603
26986
  /api/v1/integration/azure:
25604
26987
  delete:
25605
26988
  description: Delete a given Datadog-Azure integration from your Datadog account.
@@ -25637,6 +27020,10 @@ paths:
25637
27020
  tags:
25638
27021
  - Azure Integration
25639
27022
  x-codegen-request-body-name: body
27023
+ x-permission:
27024
+ operator: OR
27025
+ permissions:
27026
+ - azure_configurations_manage
25640
27027
  get:
25641
27028
  description: List all Datadog-Azure integrations configured in your Datadog
25642
27029
  account.
@@ -25665,6 +27052,10 @@ paths:
25665
27052
  summary: List all Azure integrations
25666
27053
  tags:
25667
27054
  - Azure Integration
27055
+ x-permission:
27056
+ operator: OR
27057
+ permissions:
27058
+ - azure_configuration_read
25668
27059
  post:
25669
27060
  description: 'Create a Datadog-Azure integration.
25670
27061
 
@@ -25714,6 +27105,10 @@ paths:
25714
27105
  tags:
25715
27106
  - Azure Integration
25716
27107
  x-codegen-request-body-name: body
27108
+ x-permission:
27109
+ operator: OR
27110
+ permissions:
27111
+ - azure_configurations_manage
25717
27112
  put:
25718
27113
  description: 'Update a Datadog-Azure integration. Requires an existing `tenant_name`
25719
27114
  and `client_id`.
@@ -25757,6 +27152,10 @@ paths:
25757
27152
  tags:
25758
27153
  - Azure Integration
25759
27154
  x-codegen-request-body-name: body
27155
+ x-permission:
27156
+ operator: OR
27157
+ permissions:
27158
+ - azure_configuration_edit
25760
27159
  /api/v1/integration/azure/host_filters:
25761
27160
  post:
25762
27161
  description: Update the defined list of host filters for a given Datadog-Azure
@@ -25795,6 +27194,10 @@ paths:
25795
27194
  tags:
25796
27195
  - Azure Integration
25797
27196
  x-codegen-request-body-name: body
27197
+ x-permission:
27198
+ operator: OR
27199
+ permissions:
27200
+ - azure_configuration_edit
25798
27201
  /api/v1/integration/gcp:
25799
27202
  delete:
25800
27203
  deprecated: true
@@ -25834,6 +27237,10 @@ paths:
25834
27237
  tags:
25835
27238
  - GCP Integration
25836
27239
  x-codegen-request-body-name: body
27240
+ x-permission:
27241
+ operator: OR
27242
+ permissions:
27243
+ - gcp_configurations_manage
25837
27244
  get:
25838
27245
  deprecated: true
25839
27246
  description: "This endpoint is deprecated \u2013 use the V2 endpoints instead.
@@ -25863,6 +27270,10 @@ paths:
25863
27270
  summary: List all GCP integrations
25864
27271
  tags:
25865
27272
  - GCP Integration
27273
+ x-permission:
27274
+ operator: OR
27275
+ permissions:
27276
+ - gcp_configuration_read
25866
27277
  post:
25867
27278
  deprecated: true
25868
27279
  description: "This endpoint is deprecated \u2013 use the V2 endpoints instead.
@@ -25901,6 +27312,10 @@ paths:
25901
27312
  tags:
25902
27313
  - GCP Integration
25903
27314
  x-codegen-request-body-name: body
27315
+ x-permission:
27316
+ operator: OR
27317
+ permissions:
27318
+ - gcp_configurations_manage
25904
27319
  put:
25905
27320
  deprecated: true
25906
27321
  description: "This endpoint is deprecated \u2013 use the V2 endpoints instead.
@@ -25942,6 +27357,10 @@ paths:
25942
27357
  tags:
25943
27358
  - GCP Integration
25944
27359
  x-codegen-request-body-name: body
27360
+ x-permission:
27361
+ operator: OR
27362
+ permissions:
27363
+ - gcp_configuration_edit
25945
27364
  /api/v1/integration/pagerduty/configuration/services:
25946
27365
  post:
25947
27366
  description: Create a new service object in the PagerDuty integration.
@@ -25978,6 +27397,10 @@ paths:
25978
27397
  tags:
25979
27398
  - PagerDuty Integration
25980
27399
  x-codegen-request-body-name: body
27400
+ x-permission:
27401
+ operator: OR
27402
+ permissions:
27403
+ - manage_integrations
25981
27404
  /api/v1/integration/pagerduty/configuration/services/{service_name}:
25982
27405
  delete:
25983
27406
  description: Delete a single service object in the Datadog-PagerDuty integration.
@@ -26009,6 +27432,10 @@ paths:
26009
27432
  summary: Delete a single service object
26010
27433
  tags:
26011
27434
  - PagerDuty Integration
27435
+ x-permission:
27436
+ operator: OR
27437
+ permissions:
27438
+ - manage_integrations
26012
27439
  get:
26013
27440
  description: Get service name in the Datadog-PagerDuty integration.
26014
27441
  operationId: GetPagerDutyIntegrationService
@@ -26043,6 +27470,10 @@ paths:
26043
27470
  summary: Get a single service object
26044
27471
  tags:
26045
27472
  - PagerDuty Integration
27473
+ x-permission:
27474
+ operator: OR
27475
+ permissions:
27476
+ - integrations_read
26046
27477
  put:
26047
27478
  description: Update a single service object in the Datadog-PagerDuty integration.
26048
27479
  operationId: UpdatePagerDutyIntegrationService
@@ -26087,6 +27518,10 @@ paths:
26087
27518
  tags:
26088
27519
  - PagerDuty Integration
26089
27520
  x-codegen-request-body-name: body
27521
+ x-permission:
27522
+ operator: OR
27523
+ permissions:
27524
+ - manage_integrations
26090
27525
  /api/v1/integration/slack/configuration/accounts/{account_name}/channels:
26091
27526
  get:
26092
27527
  description: Get a list of all channels configured for your Datadog-Slack integration.
@@ -26123,6 +27558,10 @@ paths:
26123
27558
  summary: Get all channels in a Slack integration
26124
27559
  tags:
26125
27560
  - Slack Integration
27561
+ x-permission:
27562
+ operator: OR
27563
+ permissions:
27564
+ - integrations_read
26126
27565
  post:
26127
27566
  description: Add a channel to your Datadog-Slack integration.
26128
27567
  operationId: CreateSlackIntegrationChannel
@@ -26166,6 +27605,10 @@ paths:
26166
27605
  tags:
26167
27606
  - Slack Integration
26168
27607
  x-codegen-request-body-name: body
27608
+ x-permission:
27609
+ operator: OR
27610
+ permissions:
27611
+ - manage_integrations
26169
27612
  /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name}:
26170
27613
  delete:
26171
27614
  description: Remove a channel from your Datadog-Slack integration.
@@ -26199,6 +27642,10 @@ paths:
26199
27642
  summary: Remove a Slack integration channel
26200
27643
  tags:
26201
27644
  - Slack Integration
27645
+ x-permission:
27646
+ operator: OR
27647
+ permissions:
27648
+ - manage_integrations
26202
27649
  get:
26203
27650
  description: Get a channel configured for your Datadog-Slack integration.
26204
27651
  operationId: GetSlackIntegrationChannel
@@ -26235,6 +27682,10 @@ paths:
26235
27682
  summary: Get a Slack integration channel
26236
27683
  tags:
26237
27684
  - Slack Integration
27685
+ x-permission:
27686
+ operator: OR
27687
+ permissions:
27688
+ - integrations_read
26238
27689
  patch:
26239
27690
  description: Update a channel used in your Datadog-Slack integration.
26240
27691
  operationId: UpdateSlackIntegrationChannel
@@ -26279,6 +27730,10 @@ paths:
26279
27730
  tags:
26280
27731
  - Slack Integration
26281
27732
  x-codegen-request-body-name: body
27733
+ x-permission:
27734
+ operator: OR
27735
+ permissions:
27736
+ - manage_integrations
26282
27737
  /api/v1/integration/webhooks/configuration/custom-variables:
26283
27738
  post:
26284
27739
  description: Creates an endpoint with the name `<CUSTOM_VARIABLE_NAME>`.
@@ -26315,6 +27770,10 @@ paths:
26315
27770
  tags:
26316
27771
  - Webhooks Integration
26317
27772
  x-codegen-request-body-name: body
27773
+ x-permission:
27774
+ operator: OR
27775
+ permissions:
27776
+ - manage_integrations
26318
27777
  /api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}:
26319
27778
  delete:
26320
27779
  description: Deletes the endpoint with the name `<CUSTOM_VARIABLE_NAME>`.
@@ -26346,6 +27805,10 @@ paths:
26346
27805
  summary: Delete a custom variable
26347
27806
  tags:
26348
27807
  - Webhooks Integration
27808
+ x-permission:
27809
+ operator: OR
27810
+ permissions:
27811
+ - manage_integrations
26349
27812
  get:
26350
27813
  description: 'Shows the content of the custom variable with the name `<CUSTOM_VARIABLE_NAME>`.
26351
27814
 
@@ -26391,6 +27854,10 @@ paths:
26391
27854
  summary: Get a custom variable
26392
27855
  tags:
26393
27856
  - Webhooks Integration
27857
+ x-permission:
27858
+ operator: OR
27859
+ permissions:
27860
+ - integrations_read
26394
27861
  put:
26395
27862
  description: Updates the endpoint with the name `<CUSTOM_VARIABLE_NAME>`.
26396
27863
  operationId: UpdateWebhooksIntegrationCustomVariable
@@ -26439,6 +27906,10 @@ paths:
26439
27906
  tags:
26440
27907
  - Webhooks Integration
26441
27908
  x-codegen-request-body-name: body
27909
+ x-permission:
27910
+ operator: OR
27911
+ permissions:
27912
+ - manage_integrations
26442
27913
  /api/v1/integration/webhooks/configuration/webhooks:
26443
27914
  post:
26444
27915
  description: Creates an endpoint with the name `<WEBHOOK_NAME>`.
@@ -26480,6 +27951,10 @@ paths:
26480
27951
  tags:
26481
27952
  - Webhooks Integration
26482
27953
  x-codegen-request-body-name: body
27954
+ x-permission:
27955
+ operator: OR
27956
+ permissions:
27957
+ - create_webhooks
26483
27958
  /api/v1/integration/webhooks/configuration/webhooks/{webhook_name}:
26484
27959
  delete:
26485
27960
  description: Deletes the endpoint with the name `<WEBHOOK NAME>`.
@@ -26511,6 +27986,10 @@ paths:
26511
27986
  summary: Delete a webhook
26512
27987
  tags:
26513
27988
  - Webhooks Integration
27989
+ x-permission:
27990
+ operator: OR
27991
+ permissions:
27992
+ - manage_integrations
26514
27993
  get:
26515
27994
  description: Gets the content of the webhook with the name `<WEBHOOK_NAME>`.
26516
27995
  operationId: GetWebhooksIntegration
@@ -26551,6 +28030,10 @@ paths:
26551
28030
  summary: Get a webhook integration
26552
28031
  tags:
26553
28032
  - Webhooks Integration
28033
+ x-permission:
28034
+ operator: OR
28035
+ permissions:
28036
+ - integrations_read
26554
28037
  put:
26555
28038
  description: Updates the endpoint with the name `<WEBHOOK_NAME>`.
26556
28039
  operationId: UpdateWebhooksIntegration
@@ -26599,6 +28082,10 @@ paths:
26599
28082
  tags:
26600
28083
  - Webhooks Integration
26601
28084
  x-codegen-request-body-name: body
28085
+ x-permission:
28086
+ operator: OR
28087
+ permissions:
28088
+ - manage_integrations
26602
28089
  /api/v1/logs-queries/list:
26603
28090
  post:
26604
28091
  description: 'List endpoint returns logs that match a log search query.
@@ -26649,6 +28136,10 @@ paths:
26649
28136
  tags:
26650
28137
  - Logs
26651
28138
  x-codegen-request-body-name: body
28139
+ x-permission:
28140
+ operator: OR
28141
+ permissions:
28142
+ - logs_read_data
26652
28143
  /api/v1/logs/config/index-order:
26653
28144
  get:
26654
28145
  description: Get the current order of your log indexes. This endpoint takes
@@ -26672,6 +28163,9 @@ paths:
26672
28163
  summary: Get indexes order
26673
28164
  tags:
26674
28165
  - Logs Indexes
28166
+ x-permission:
28167
+ operator: OPEN
28168
+ permissions: []
26675
28169
  put:
26676
28170
  description: 'This endpoint updates the index order of your organization.
26677
28171
 
@@ -26710,6 +28204,10 @@ paths:
26710
28204
  tags:
26711
28205
  - Logs Indexes
26712
28206
  x-codegen-request-body-name: body
28207
+ x-permission:
28208
+ operator: OR
28209
+ permissions:
28210
+ - logs_modify_indexes
26713
28211
  /api/v1/logs/config/indexes:
26714
28212
  get:
26715
28213
  description: 'The Index object describes the configuration of a log index.
@@ -26738,6 +28236,9 @@ paths:
26738
28236
  summary: Get all indexes
26739
28237
  tags:
26740
28238
  - Logs Indexes
28239
+ x-permission:
28240
+ operator: OPEN
28241
+ permissions: []
26741
28242
  post:
26742
28243
  description: Creates a new index. Returns the Index object passed in the request
26743
28244
  body when the request is successful.
@@ -26774,6 +28275,10 @@ paths:
26774
28275
  tags:
26775
28276
  - Logs Indexes
26776
28277
  x-codegen-request-body-name: body
28278
+ x-permission:
28279
+ operator: OR
28280
+ permissions:
28281
+ - logs_modify_indexes
26777
28282
  /api/v1/logs/config/indexes/{name}:
26778
28283
  get:
26779
28284
  description: Get one log index from your organization. This endpoint takes no
@@ -26883,6 +28388,9 @@ paths:
26883
28388
  summary: Get pipeline order
26884
28389
  tags:
26885
28390
  - Logs Pipelines
28391
+ x-permission:
28392
+ operator: OPEN
28393
+ permissions: []
26886
28394
  put:
26887
28395
  description: 'Update the order of your pipelines. Since logs are processed sequentially,
26888
28396
  reordering a pipeline may change
@@ -26934,6 +28442,10 @@ paths:
26934
28442
  tags:
26935
28443
  - Logs Pipelines
26936
28444
  x-codegen-request-body-name: body
28445
+ x-permission:
28446
+ operator: OR
28447
+ permissions:
28448
+ - logs_write_pipelines
26937
28449
  /api/v1/logs/config/pipelines:
26938
28450
  get:
26939
28451
  description: 'Get all pipelines from your organization.
@@ -26958,6 +28470,9 @@ paths:
26958
28470
  summary: Get all pipelines
26959
28471
  tags:
26960
28472
  - Logs Pipelines
28473
+ x-permission:
28474
+ operator: OPEN
28475
+ permissions: []
26961
28476
  post:
26962
28477
  description: Create a pipeline in your organization.
26963
28478
  operationId: CreateLogsPipeline
@@ -26993,6 +28508,10 @@ paths:
26993
28508
  tags:
26994
28509
  - Logs Pipelines
26995
28510
  x-codegen-request-body-name: body
28511
+ x-permission:
28512
+ operator: OR
28513
+ permissions:
28514
+ - logs_write_pipelines
26996
28515
  /api/v1/logs/config/pipelines/{pipeline_id}:
26997
28516
  delete:
26998
28517
  description: 'Delete a given pipeline from your organization.
@@ -27026,6 +28545,10 @@ paths:
27026
28545
  summary: Delete a pipeline
27027
28546
  tags:
27028
28547
  - Logs Pipelines
28548
+ x-permission:
28549
+ operator: OR
28550
+ permissions:
28551
+ - logs_write_pipelines
27029
28552
  get:
27030
28553
  description: 'Get a specific pipeline from your organization.
27031
28554
 
@@ -27062,6 +28585,9 @@ paths:
27062
28585
  summary: Get a pipeline
27063
28586
  tags:
27064
28587
  - Logs Pipelines
28588
+ x-permission:
28589
+ operator: OPEN
28590
+ permissions: []
27065
28591
  put:
27066
28592
  description: "Update a given pipeline configuration to change it\u2019s processors
27067
28593
  or their order.\n\n**Note**: Using this method updates your pipeline configuration
@@ -27107,6 +28633,10 @@ paths:
27107
28633
  tags:
27108
28634
  - Logs Pipelines
27109
28635
  x-codegen-request-body-name: body
28636
+ x-permission:
28637
+ operator: OR
28638
+ permissions:
28639
+ - logs_write_pipelines
27110
28640
  /api/v1/metrics:
27111
28641
  get:
27112
28642
  description: Get the list of actively reporting metrics from a given time until
@@ -27167,6 +28697,10 @@ paths:
27167
28697
  summary: Get active metrics list
27168
28698
  tags:
27169
28699
  - Metrics
28700
+ x-permission:
28701
+ operator: OR
28702
+ permissions:
28703
+ - metrics_read
27170
28704
  /api/v1/metrics/{metric_name}:
27171
28705
  get:
27172
28706
  description: Get metadata about a specific metric.
@@ -27207,6 +28741,10 @@ paths:
27207
28741
  summary: Get metric metadata
27208
28742
  tags:
27209
28743
  - Metrics
28744
+ x-permission:
28745
+ operator: OR
28746
+ permissions:
28747
+ - metrics_read
27210
28748
  put:
27211
28749
  description: Edit metadata of a specific metric. Find out more about [supported
27212
28750
  types](https://docs.datadoghq.com/developers/metrics).
@@ -27256,6 +28794,10 @@ paths:
27256
28794
  tags:
27257
28795
  - Metrics
27258
28796
  x-codegen-request-body-name: body
28797
+ x-permission:
28798
+ operator: OR
28799
+ permissions:
28800
+ - metrics_metadata_write
27259
28801
  /api/v1/monitor:
27260
28802
  get:
27261
28803
  description: Get details about the specified monitor from your organization.
@@ -27370,6 +28912,10 @@ paths:
27370
28912
  x-pagination:
27371
28913
  limitParam: page_size
27372
28914
  pageParam: page
28915
+ x-permission:
28916
+ operator: OR
28917
+ permissions:
28918
+ - monitors_read
27373
28919
  post:
27374
28920
  description: 'Create a monitor using the specified options.
27375
28921
 
@@ -27807,6 +29353,10 @@ paths:
27807
29353
  tags:
27808
29354
  - Monitors
27809
29355
  x-codegen-request-body-name: body
29356
+ x-permission:
29357
+ operator: OR
29358
+ permissions:
29359
+ - monitors_write
27810
29360
  /api/v1/monitor/can_delete:
27811
29361
  get:
27812
29362
  description: Check if the given monitors can be deleted.
@@ -27859,6 +29409,10 @@ paths:
27859
29409
  summary: Check if a monitor can be deleted
27860
29410
  tags:
27861
29411
  - Monitors
29412
+ x-permission:
29413
+ operator: OR
29414
+ permissions:
29415
+ - monitors_read
27862
29416
  /api/v1/monitor/groups/search:
27863
29417
  get:
27864
29418
  description: Search and filter your monitor groups details.
@@ -27943,6 +29497,10 @@ paths:
27943
29497
  summary: Monitors group search
27944
29498
  tags:
27945
29499
  - Monitors
29500
+ x-permission:
29501
+ operator: OR
29502
+ permissions:
29503
+ - monitors_read
27946
29504
  /api/v1/monitor/search:
27947
29505
  get:
27948
29506
  description: Search and filter your monitors details.
@@ -28029,6 +29587,10 @@ paths:
28029
29587
  summary: Monitors search
28030
29588
  tags:
28031
29589
  - Monitors
29590
+ x-permission:
29591
+ operator: OR
29592
+ permissions:
29593
+ - monitors_read
28032
29594
  /api/v1/monitor/validate:
28033
29595
  post:
28034
29596
  description: 'Validate the monitor provided in the request.
@@ -28074,6 +29636,10 @@ paths:
28074
29636
  tags:
28075
29637
  - Monitors
28076
29638
  x-codegen-request-body-name: body
29639
+ x-permission:
29640
+ operator: OR
29641
+ permissions:
29642
+ - monitors_write
28077
29643
  /api/v1/monitor/{monitor_id}:
28078
29644
  delete:
28079
29645
  description: Delete the specified monitor
@@ -28136,6 +29702,10 @@ paths:
28136
29702
  summary: Delete a monitor
28137
29703
  tags:
28138
29704
  - Monitors
29705
+ x-permission:
29706
+ operator: OR
29707
+ permissions:
29708
+ - monitors_write
28139
29709
  get:
28140
29710
  description: Get details about the specified monitor from your organization.
28141
29711
  operationId: GetMonitor
@@ -28197,6 +29767,10 @@ paths:
28197
29767
  summary: Get a monitor's details
28198
29768
  tags:
28199
29769
  - Monitors
29770
+ x-permission:
29771
+ operator: OR
29772
+ permissions:
29773
+ - monitors_read
28200
29774
  put:
28201
29775
  description: Edit the specified monitor.
28202
29776
  operationId: UpdateMonitor
@@ -28258,6 +29832,10 @@ paths:
28258
29832
  tags:
28259
29833
  - Monitors
28260
29834
  x-codegen-request-body-name: body
29835
+ x-permission:
29836
+ operator: OR
29837
+ permissions:
29838
+ - monitors_write
28261
29839
  /api/v1/monitor/{monitor_id}/downtimes:
28262
29840
  get:
28263
29841
  deprecated: true
@@ -28304,6 +29882,10 @@ paths:
28304
29882
  tags:
28305
29883
  - Downtimes
28306
29884
  x-codegen-request-body-name: body
29885
+ x-permission:
29886
+ operator: OR
29887
+ permissions:
29888
+ - monitors_read
28307
29889
  /api/v1/monitor/{monitor_id}/validate:
28308
29890
  post:
28309
29891
  description: Validate the monitor provided in the request.
@@ -28355,6 +29937,10 @@ paths:
28355
29937
  tags:
28356
29938
  - Monitors
28357
29939
  x-codegen-request-body-name: body
29940
+ x-permission:
29941
+ operator: OR
29942
+ permissions:
29943
+ - monitors_write
28358
29944
  /api/v1/monthly_custom_reports:
28359
29945
  get:
28360
29946
  deprecated: true
@@ -28415,6 +30001,10 @@ paths:
28415
30001
  summary: Get the list of available monthly custom reports
28416
30002
  tags:
28417
30003
  - Usage Metering
30004
+ x-permission:
30005
+ operator: OR
30006
+ permissions:
30007
+ - usage_read
28418
30008
  /api/v1/monthly_custom_reports/{report_id}:
28419
30009
  get:
28420
30010
  deprecated: true
@@ -28466,6 +30056,10 @@ paths:
28466
30056
  summary: Get specified monthly custom reports
28467
30057
  tags:
28468
30058
  - Usage Metering
30059
+ x-permission:
30060
+ operator: OR
30061
+ permissions:
30062
+ - usage_read
28469
30063
  /api/v1/notebooks:
28470
30064
  get:
28471
30065
  description: 'Get all notebooks. This can also be used to search for notebooks
@@ -28593,6 +30187,10 @@ paths:
28593
30187
  limitParam: count
28594
30188
  pageOffsetParam: start
28595
30189
  resultsPath: data
30190
+ x-permission:
30191
+ operator: OR
30192
+ permissions:
30193
+ - notebooks_read
28596
30194
  post:
28597
30195
  description: Create a notebook using the specified options.
28598
30196
  operationId: CreateNotebook
@@ -28665,6 +30263,10 @@ paths:
28665
30263
  tags:
28666
30264
  - Notebooks
28667
30265
  x-codegen-request-body-name: body
30266
+ x-permission:
30267
+ operator: OR
30268
+ permissions:
30269
+ - notebooks_write
28668
30270
  /api/v1/notebooks/{notebook_id}:
28669
30271
  delete:
28670
30272
  description: Delete a notebook using the specified ID.
@@ -28703,6 +30305,10 @@ paths:
28703
30305
  summary: Delete a notebook
28704
30306
  tags:
28705
30307
  - Notebooks
30308
+ x-permission:
30309
+ operator: OR
30310
+ permissions:
30311
+ - notebooks_write
28706
30312
  get:
28707
30313
  description: Get a notebook using the specified notebook ID.
28708
30314
  operationId: GetNotebook
@@ -28744,6 +30350,10 @@ paths:
28744
30350
  summary: Get a notebook
28745
30351
  tags:
28746
30352
  - Notebooks
30353
+ x-permission:
30354
+ operator: OR
30355
+ permissions:
30356
+ - notebooks_read
28747
30357
  put:
28748
30358
  description: Update a notebook using the specified ID.
28749
30359
  operationId: UpdateNotebook
@@ -28837,6 +30447,10 @@ paths:
28837
30447
  tags:
28838
30448
  - Notebooks
28839
30449
  x-codegen-request-body-name: body
30450
+ x-permission:
30451
+ operator: OR
30452
+ permissions:
30453
+ - notebooks_write
28840
30454
  /api/v1/org:
28841
30455
  get:
28842
30456
  description: This endpoint returns data on your top-level organization.
@@ -28859,6 +30473,10 @@ paths:
28859
30473
  summary: List your managed organizations
28860
30474
  tags:
28861
30475
  - Organizations
30476
+ x-permission:
30477
+ operator: OR
30478
+ permissions:
30479
+ - org_management
28862
30480
  post:
28863
30481
  description: 'Create a child organization.
28864
30482
 
@@ -28910,6 +30528,10 @@ paths:
28910
30528
  tags:
28911
30529
  - Organizations
28912
30530
  x-codegen-request-body-name: body
30531
+ x-permission:
30532
+ operator: OR
30533
+ permissions:
30534
+ - org_management
28913
30535
  /api/v1/org/{public_id}:
28914
30536
  get:
28915
30537
  description: Get organization information.
@@ -29138,6 +30760,10 @@ paths:
29138
30760
  summary: Query timeseries points
29139
30761
  tags:
29140
30762
  - Metrics
30763
+ x-permission:
30764
+ operator: OR
30765
+ permissions:
30766
+ - timeseries_query
29141
30767
  /api/v1/search:
29142
30768
  get:
29143
30769
  description: Search for metrics from the last 24 hours in Datadog.
@@ -29178,6 +30804,9 @@ paths:
29178
30804
  summary: Search metrics
29179
30805
  tags:
29180
30806
  - Metrics
30807
+ x-permission:
30808
+ operator: OPEN
30809
+ permissions: []
29181
30810
  /api/v1/security_analytics/signals/{signal_id}/add_to_incident:
29182
30811
  patch:
29183
30812
  description: Add a security signal to an incident. This makes it possible to
@@ -29224,6 +30853,10 @@ paths:
29224
30853
  tags:
29225
30854
  - Security Monitoring
29226
30855
  x-codegen-request-body-name: body
30856
+ x-permission:
30857
+ operator: OR
30858
+ permissions:
30859
+ - security_monitoring_signals_write
29227
30860
  /api/v1/security_analytics/signals/{signal_id}/assignee:
29228
30861
  patch:
29229
30862
  description: Modify the triage assignee of a security signal.
@@ -29268,6 +30901,10 @@ paths:
29268
30901
  tags:
29269
30902
  - Security Monitoring
29270
30903
  x-codegen-request-body-name: body
30904
+ x-permission:
30905
+ operator: OR
30906
+ permissions:
30907
+ - security_monitoring_signals_write
29271
30908
  /api/v1/security_analytics/signals/{signal_id}/state:
29272
30909
  patch:
29273
30910
  description: Change the triage state of a security signal.
@@ -29312,6 +30949,10 @@ paths:
29312
30949
  tags:
29313
30950
  - Security Monitoring
29314
30951
  x-codegen-request-body-name: body
30952
+ x-permission:
30953
+ operator: OR
30954
+ permissions:
30955
+ - security_monitoring_signals_write
29315
30956
  /api/v1/series:
29316
30957
  post:
29317
30958
  description: "The metrics end-point allows you to post time-series data that
@@ -29473,6 +31114,10 @@ paths:
29473
31114
  limitParam: limit
29474
31115
  pageOffsetParam: offset
29475
31116
  resultsPath: data
31117
+ x-permission:
31118
+ operator: OR
31119
+ permissions:
31120
+ - slos_read
29476
31121
  post:
29477
31122
  description: Create a service level objective object.
29478
31123
  operationId: CreateSLO
@@ -29513,6 +31158,10 @@ paths:
29513
31158
  tags:
29514
31159
  - Service Level Objectives
29515
31160
  x-codegen-request-body-name: body
31161
+ x-permission:
31162
+ operator: OR
31163
+ permissions:
31164
+ - slos_write
29516
31165
  /api/v1/slo/bulk_delete:
29517
31166
  post:
29518
31167
  description: 'Delete (or partially delete) multiple service level objective
@@ -29563,6 +31212,10 @@ paths:
29563
31212
  tags:
29564
31213
  - Service Level Objectives
29565
31214
  x-codegen-request-body-name: body
31215
+ x-permission:
31216
+ operator: OR
31217
+ permissions:
31218
+ - slos_write
29566
31219
  /api/v1/slo/can_delete:
29567
31220
  get:
29568
31221
  description: 'Check if an SLO can be safely deleted. For example,
@@ -29613,6 +31266,10 @@ paths:
29613
31266
  summary: Check if SLOs can be safely deleted
29614
31267
  tags:
29615
31268
  - Service Level Objectives
31269
+ x-permission:
31270
+ operator: OR
31271
+ permissions:
31272
+ - slos_read
29616
31273
  /api/v1/slo/correction:
29617
31274
  get:
29618
31275
  description: Get all Service Level Objective corrections.
@@ -29661,6 +31318,10 @@ paths:
29661
31318
  limitParam: limit
29662
31319
  pageOffsetParam: offset
29663
31320
  resultsPath: data
31321
+ x-permission:
31322
+ operator: OR
31323
+ permissions:
31324
+ - slos_read
29664
31325
  post:
29665
31326
  description: Create an SLO Correction.
29666
31327
  operationId: CreateSLOCorrection
@@ -29707,6 +31368,10 @@ paths:
29707
31368
  tags:
29708
31369
  - Service Level Objective Corrections
29709
31370
  x-codegen-request-body-name: body
31371
+ x-permission:
31372
+ operator: OR
31373
+ permissions:
31374
+ - slos_corrections
29710
31375
  /api/v1/slo/correction/{slo_correction_id}:
29711
31376
  delete:
29712
31377
  description: Permanently delete the specified SLO correction object.
@@ -29885,6 +31550,10 @@ paths:
29885
31550
  summary: Search for SLOs
29886
31551
  tags:
29887
31552
  - Service Level Objectives
31553
+ x-permission:
31554
+ operator: OR
31555
+ permissions:
31556
+ - slos_read
29888
31557
  /api/v1/slo/{slo_id}:
29889
31558
  delete:
29890
31559
  description: 'Permanently delete the specified service level objective object.
@@ -29943,6 +31612,10 @@ paths:
29943
31612
  summary: Delete an SLO
29944
31613
  tags:
29945
31614
  - Service Level Objectives
31615
+ x-permission:
31616
+ operator: OR
31617
+ permissions:
31618
+ - slos_write
29946
31619
  get:
29947
31620
  description: Get a service level objective object.
29948
31621
  operationId: GetSLO
@@ -29989,6 +31662,10 @@ paths:
29989
31662
  summary: Get an SLO's details
29990
31663
  tags:
29991
31664
  - Service Level Objectives
31665
+ x-permission:
31666
+ operator: OR
31667
+ permissions:
31668
+ - slos_read
29992
31669
  put:
29993
31670
  description: Update the specified service level objective object.
29994
31671
  operationId: UpdateSLO
@@ -30042,6 +31719,10 @@ paths:
30042
31719
  tags:
30043
31720
  - Service Level Objectives
30044
31721
  x-codegen-request-body-name: body
31722
+ x-permission:
31723
+ operator: OR
31724
+ permissions:
31725
+ - slos_write
30045
31726
  /api/v1/slo/{slo_id}/corrections:
30046
31727
  get:
30047
31728
  description: Get corrections applied to an SLO
@@ -30088,6 +31769,10 @@ paths:
30088
31769
  summary: Get Corrections For an SLO
30089
31770
  tags:
30090
31771
  - Service Level Objectives
31772
+ x-permission:
31773
+ operator: OR
31774
+ permissions:
31775
+ - slos_read
30091
31776
  /api/v1/slo/{slo_id}/history:
30092
31777
  get:
30093
31778
  description: "Get a specific SLO\u2019s history, regardless of its SLO type.\n\nThe
@@ -30174,6 +31859,10 @@ paths:
30174
31859
  summary: Get an SLO's history
30175
31860
  tags:
30176
31861
  - Service Level Objectives
31862
+ x-permission:
31863
+ operator: OR
31864
+ permissions:
31865
+ - slos_read
30177
31866
  /api/v1/synthetics/ci/batch/{batch_id}:
30178
31867
  get:
30179
31868
  description: Get a batch's updated details.
@@ -30208,6 +31897,10 @@ paths:
30208
31897
  summary: Get details of batch
30209
31898
  tags:
30210
31899
  - Synthetics
31900
+ x-permission:
31901
+ operator: OR
31902
+ permissions:
31903
+ - synthetics_read
30211
31904
  /api/v1/synthetics/locations:
30212
31905
  get:
30213
31906
  description: 'Get the list of public and private locations available for Synthetic
@@ -30231,6 +31924,10 @@ paths:
30231
31924
  summary: Get all locations (public and private)
30232
31925
  tags:
30233
31926
  - Synthetics
31927
+ x-permission:
31928
+ operator: OR
31929
+ permissions:
31930
+ - synthetics_private_location_read
30234
31931
  /api/v1/synthetics/private-locations:
30235
31932
  post:
30236
31933
  description: Create a new Synthetic private location.
@@ -30272,6 +31969,10 @@ paths:
30272
31969
  tags:
30273
31970
  - Synthetics
30274
31971
  x-codegen-request-body-name: body
31972
+ x-permission:
31973
+ operator: OR
31974
+ permissions:
31975
+ - synthetics_private_location_write
30275
31976
  /api/v1/synthetics/private-locations/{location_id}:
30276
31977
  delete:
30277
31978
  description: Delete a Synthetic private location.
@@ -30304,6 +32005,10 @@ paths:
30304
32005
  summary: Delete a private location
30305
32006
  tags:
30306
32007
  - Synthetics
32008
+ x-permission:
32009
+ operator: OR
32010
+ permissions:
32011
+ - synthetics_private_location_write
30307
32012
  get:
30308
32013
  description: Get a Synthetic private location.
30309
32014
  operationId: GetPrivateLocation
@@ -30339,6 +32044,10 @@ paths:
30339
32044
  summary: Get a private location
30340
32045
  tags:
30341
32046
  - Synthetics
32047
+ x-permission:
32048
+ operator: OR
32049
+ permissions:
32050
+ - synthetics_private_location_read
30342
32051
  put:
30343
32052
  description: Edit a Synthetic private location.
30344
32053
  operationId: UpdatePrivateLocation
@@ -30382,6 +32091,10 @@ paths:
30382
32091
  tags:
30383
32092
  - Synthetics
30384
32093
  x-codegen-request-body-name: body
32094
+ x-permission:
32095
+ operator: OR
32096
+ permissions:
32097
+ - synthetics_private_location_write
30385
32098
  /api/v1/synthetics/settings/default_locations:
30386
32099
  get:
30387
32100
  description: Get the default locations settings.
@@ -30398,6 +32111,10 @@ paths:
30398
32111
  summary: Get the default locations
30399
32112
  tags:
30400
32113
  - Synthetics
32114
+ x-permission:
32115
+ operator: OR
32116
+ permissions:
32117
+ - synthetics_default_settings_read
30401
32118
  /api/v1/synthetics/tests:
30402
32119
  get:
30403
32120
  description: Get the list of all Synthetic tests.
@@ -30452,6 +32169,10 @@ paths:
30452
32169
  limitParam: page_size
30453
32170
  pageParam: page_number
30454
32171
  resultsPath: tests
32172
+ x-permission:
32173
+ operator: OR
32174
+ permissions:
32175
+ - synthetics_read
30455
32176
  /api/v1/synthetics/tests/api:
30456
32177
  post:
30457
32178
  description: Create a Synthetic API test.
@@ -30620,6 +32341,10 @@ paths:
30620
32341
  tags:
30621
32342
  - Synthetics
30622
32343
  x-codegen-request-body-name: body
32344
+ x-permission:
32345
+ operator: OR
32346
+ permissions:
32347
+ - synthetics_write
30623
32348
  /api/v1/synthetics/tests/api/{public_id}:
30624
32349
  get:
30625
32350
  description: 'Get the detailed configuration associated with
@@ -30664,6 +32389,10 @@ paths:
30664
32389
  summary: Get an API test
30665
32390
  tags:
30666
32391
  - Synthetics
32392
+ x-permission:
32393
+ operator: OR
32394
+ permissions:
32395
+ - synthetics_read
30667
32396
  put:
30668
32397
  description: Edit the configuration of a Synthetic API test.
30669
32398
  operationId: UpdateAPITest
@@ -30723,6 +32452,10 @@ paths:
30723
32452
  tags:
30724
32453
  - Synthetics
30725
32454
  x-codegen-request-body-name: body
32455
+ x-permission:
32456
+ operator: OR
32457
+ permissions:
32458
+ - synthetics_write
30726
32459
  /api/v1/synthetics/tests/browser:
30727
32460
  post:
30728
32461
  description: Create a Synthetic browser test.
@@ -30772,6 +32505,10 @@ paths:
30772
32505
  tags:
30773
32506
  - Synthetics
30774
32507
  x-codegen-request-body-name: body
32508
+ x-permission:
32509
+ operator: OR
32510
+ permissions:
32511
+ - synthetics_write
30775
32512
  /api/v1/synthetics/tests/browser/{public_id}:
30776
32513
  get:
30777
32514
  description: 'Get the detailed configuration (including steps) associated with
@@ -30816,6 +32553,10 @@ paths:
30816
32553
  summary: Get a browser test
30817
32554
  tags:
30818
32555
  - Synthetics
32556
+ x-permission:
32557
+ operator: OR
32558
+ permissions:
32559
+ - synthetics_read
30819
32560
  put:
30820
32561
  description: Edit the configuration of a Synthetic browser test.
30821
32562
  operationId: UpdateBrowserTest
@@ -30875,6 +32616,10 @@ paths:
30875
32616
  tags:
30876
32617
  - Synthetics
30877
32618
  x-codegen-request-body-name: body
32619
+ x-permission:
32620
+ operator: OR
32621
+ permissions:
32622
+ - synthetics_write
30878
32623
  /api/v1/synthetics/tests/browser/{public_id}/results:
30879
32624
  get:
30880
32625
  description: Get the last 150 test results summaries for a given Synthetic browser
@@ -30943,6 +32688,10 @@ paths:
30943
32688
  tags:
30944
32689
  - Synthetics
30945
32690
  x-codegen-request-body-name: body
32691
+ x-permission:
32692
+ operator: OR
32693
+ permissions:
32694
+ - synthetics_read
30946
32695
  /api/v1/synthetics/tests/browser/{public_id}/results/{result_id}:
30947
32696
  get:
30948
32697
  description: Get a specific full result from a given Synthetic browser test.
@@ -30993,6 +32742,10 @@ paths:
30993
32742
  summary: Get a browser test result
30994
32743
  tags:
30995
32744
  - Synthetics
32745
+ x-permission:
32746
+ operator: OR
32747
+ permissions:
32748
+ - synthetics_read
30996
32749
  /api/v1/synthetics/tests/delete:
30997
32750
  post:
30998
32751
  description: Delete multiple Synthetic tests by ID.
@@ -31047,6 +32800,162 @@ paths:
31047
32800
  tags:
31048
32801
  - Synthetics
31049
32802
  x-codegen-request-body-name: body
32803
+ x-permission:
32804
+ operator: OR
32805
+ permissions:
32806
+ - synthetics_write
32807
+ /api/v1/synthetics/tests/mobile:
32808
+ post:
32809
+ description: Create a Synthetic mobile test.
32810
+ operationId: CreateSyntheticsMobileTest
32811
+ requestBody:
32812
+ content:
32813
+ application/json:
32814
+ schema:
32815
+ $ref: '#/components/schemas/SyntheticsMobileTest'
32816
+ description: Details of the test to create.
32817
+ required: true
32818
+ responses:
32819
+ '200':
32820
+ content:
32821
+ application/json:
32822
+ schema:
32823
+ $ref: '#/components/schemas/SyntheticsMobileTest'
32824
+ description: OK - Returns the created test details.
32825
+ '400':
32826
+ content:
32827
+ application/json:
32828
+ schema:
32829
+ $ref: '#/components/schemas/APIErrorResponse'
32830
+ description: '- JSON format is wrong
32831
+
32832
+ - Creation failed'
32833
+ '402':
32834
+ content:
32835
+ application/json:
32836
+ schema:
32837
+ $ref: '#/components/schemas/APIErrorResponse'
32838
+ description: Test quota is reached
32839
+ '403':
32840
+ content:
32841
+ application/json:
32842
+ schema:
32843
+ $ref: '#/components/schemas/APIErrorResponse'
32844
+ description: Forbidden
32845
+ '429':
32846
+ $ref: '#/components/responses/TooManyRequestsResponse'
32847
+ security:
32848
+ - apiKeyAuth: []
32849
+ appKeyAuth: []
32850
+ - AuthZ:
32851
+ - synthetics_write
32852
+ summary: Create a mobile test
32853
+ tags:
32854
+ - Synthetics
32855
+ x-codegen-request-body-name: body
32856
+ /api/v1/synthetics/tests/mobile/{public_id}:
32857
+ get:
32858
+ description: 'Get the detailed configuration associated with
32859
+
32860
+ a Synthetic Mobile test.'
32861
+ operationId: GetMobileTest
32862
+ parameters:
32863
+ - description: The public ID of the test to get details from.
32864
+ in: path
32865
+ name: public_id
32866
+ required: true
32867
+ schema:
32868
+ type: string
32869
+ responses:
32870
+ '200':
32871
+ content:
32872
+ application/json:
32873
+ schema:
32874
+ $ref: '#/components/schemas/SyntheticsMobileTest'
32875
+ description: OK
32876
+ '403':
32877
+ content:
32878
+ application/json:
32879
+ schema:
32880
+ $ref: '#/components/schemas/APIErrorResponse'
32881
+ description: Forbidden
32882
+ '404':
32883
+ content:
32884
+ application/json:
32885
+ schema:
32886
+ $ref: '#/components/schemas/APIErrorResponse'
32887
+ description: '- Synthetic Monitoring is not activated for the user
32888
+
32889
+ - Test is not owned by the user'
32890
+ '429':
32891
+ $ref: '#/components/responses/TooManyRequestsResponse'
32892
+ security:
32893
+ - apiKeyAuth: []
32894
+ appKeyAuth: []
32895
+ - AuthZ:
32896
+ - synthetics_read
32897
+ summary: Get a Mobile test
32898
+ tags:
32899
+ - Synthetics
32900
+ put:
32901
+ description: Edit the configuration of a Synthetic Mobile test.
32902
+ operationId: UpdateMobileTest
32903
+ parameters:
32904
+ - description: The public ID of the test to get details from.
32905
+ in: path
32906
+ name: public_id
32907
+ required: true
32908
+ schema:
32909
+ type: string
32910
+ requestBody:
32911
+ content:
32912
+ application/json:
32913
+ schema:
32914
+ $ref: '#/components/schemas/SyntheticsMobileTest'
32915
+ description: New test details to be saved.
32916
+ required: true
32917
+ responses:
32918
+ '200':
32919
+ content:
32920
+ application/json:
32921
+ schema:
32922
+ $ref: '#/components/schemas/SyntheticsMobileTest'
32923
+ description: OK
32924
+ '400':
32925
+ content:
32926
+ application/json:
32927
+ schema:
32928
+ $ref: '#/components/schemas/APIErrorResponse'
32929
+ description: '- JSON format is wrong
32930
+
32931
+ - Updating sub-type is forbidden'
32932
+ '403':
32933
+ content:
32934
+ application/json:
32935
+ schema:
32936
+ $ref: '#/components/schemas/APIErrorResponse'
32937
+ description: Forbidden
32938
+ '404':
32939
+ content:
32940
+ application/json:
32941
+ schema:
32942
+ $ref: '#/components/schemas/APIErrorResponse'
32943
+ description: '- Synthetic Monitoring is not activated for the user
32944
+
32945
+ - Test is not owned by the user
32946
+
32947
+ - Test can''t be found'
32948
+ '429':
32949
+ $ref: '#/components/responses/TooManyRequestsResponse'
32950
+ security:
32951
+ - apiKeyAuth: []
32952
+ appKeyAuth: []
32953
+ - AuthZ:
32954
+ - synthetics_write
32955
+ summary: Edit a Mobile test
32956
+ tags:
32957
+ - Synthetics
32958
+ x-codegen-request-body-name: body
31050
32959
  /api/v1/synthetics/tests/trigger:
31051
32960
  post:
31052
32961
  description: Trigger a set of Synthetic tests.
@@ -31082,6 +32991,10 @@ paths:
31082
32991
  tags:
31083
32992
  - Synthetics
31084
32993
  x-codegen-request-body-name: body
32994
+ x-permission:
32995
+ operator: OR
32996
+ permissions:
32997
+ - synthetics_write
31085
32998
  /api/v1/synthetics/tests/trigger/ci:
31086
32999
  post:
31087
33000
  description: Trigger a set of Synthetic tests for continuous integration.
@@ -31117,6 +33030,53 @@ paths:
31117
33030
  tags:
31118
33031
  - Synthetics
31119
33032
  x-codegen-request-body-name: body
33033
+ x-permission:
33034
+ operator: OR
33035
+ permissions:
33036
+ - synthetics_write
33037
+ /api/v1/synthetics/tests/uptimes:
33038
+ post:
33039
+ description: Fetch uptime for multiple Synthetic tests by ID.
33040
+ operationId: FetchUptimes
33041
+ requestBody:
33042
+ content:
33043
+ application/json:
33044
+ schema:
33045
+ $ref: '#/components/schemas/SyntheticsFetchUptimesPayload'
33046
+ description: Public ID list of the Synthetic tests and timeframe.
33047
+ required: true
33048
+ responses:
33049
+ '200':
33050
+ content:
33051
+ application/json:
33052
+ schema:
33053
+ items:
33054
+ $ref: '#/components/schemas/SyntheticsTestUptime'
33055
+ type: array
33056
+ description: OK.
33057
+ '400':
33058
+ content:
33059
+ application/json:
33060
+ schema:
33061
+ $ref: '#/components/schemas/APIErrorResponse'
33062
+ description: '- JSON format is wrong'
33063
+ '403':
33064
+ content:
33065
+ application/json:
33066
+ schema:
33067
+ $ref: '#/components/schemas/APIErrorResponse'
33068
+ description: Forbidden
33069
+ '429':
33070
+ $ref: '#/components/responses/TooManyRequestsResponse'
33071
+ security:
33072
+ - apiKeyAuth: []
33073
+ appKeyAuth: []
33074
+ - AuthZ:
33075
+ - synthetics_read
33076
+ summary: Fetch uptime for multiple tests
33077
+ tags:
33078
+ - Synthetics
33079
+ x-codegen-request-body-name: body
31120
33080
  /api/v1/synthetics/tests/{public_id}:
31121
33081
  get:
31122
33082
  description: Get the detailed configuration associated with a Synthetic test.
@@ -31159,6 +33119,10 @@ paths:
31159
33119
  summary: Get a test configuration
31160
33120
  tags:
31161
33121
  - Synthetics
33122
+ x-permission:
33123
+ operator: OR
33124
+ permissions:
33125
+ - synthetics_read
31162
33126
  patch:
31163
33127
  description: Patch the configuration of a Synthetic test with partial data.
31164
33128
  operationId: PatchTest
@@ -31218,6 +33182,10 @@ paths:
31218
33182
  tags:
31219
33183
  - Synthetics
31220
33184
  x-codegen-request-body-name: body
33185
+ x-permission:
33186
+ operator: OR
33187
+ permissions:
33188
+ - synthetics_write
31221
33189
  /api/v1/synthetics/tests/{public_id}/results:
31222
33190
  get:
31223
33191
  description: Get the last 150 test results summaries for a given Synthetic API
@@ -31284,6 +33252,10 @@ paths:
31284
33252
  tags:
31285
33253
  - Synthetics
31286
33254
  x-codegen-request-body-name: body
33255
+ x-permission:
33256
+ operator: OR
33257
+ permissions:
33258
+ - synthetics_read
31287
33259
  /api/v1/synthetics/tests/{public_id}/results/{result_id}:
31288
33260
  get:
31289
33261
  description: Get a specific full result from a given Synthetic API test.
@@ -31332,6 +33304,10 @@ paths:
31332
33304
  summary: Get an API test result
31333
33305
  tags:
31334
33306
  - Synthetics
33307
+ x-permission:
33308
+ operator: OR
33309
+ permissions:
33310
+ - synthetics_read
31335
33311
  /api/v1/synthetics/tests/{public_id}/status:
31336
33312
  put:
31337
33313
  description: Pause or start a Synthetic test by changing the status.
@@ -31388,6 +33364,10 @@ paths:
31388
33364
  tags:
31389
33365
  - Synthetics
31390
33366
  x-codegen-request-body-name: body
33367
+ x-permission:
33368
+ operator: OR
33369
+ permissions:
33370
+ - synthetics_write
31391
33371
  /api/v1/synthetics/variables:
31392
33372
  get:
31393
33373
  description: Get the list of all Synthetic global variables.
@@ -31415,6 +33395,10 @@ paths:
31415
33395
  summary: Get all global variables
31416
33396
  tags:
31417
33397
  - Synthetics
33398
+ x-permission:
33399
+ operator: OR
33400
+ permissions:
33401
+ - synthetics_global_variable_read
31418
33402
  post:
31419
33403
  description: Create a Synthetic global variable.
31420
33404
  operationId: CreateGlobalVariable
@@ -31461,6 +33445,10 @@ paths:
31461
33445
  tags:
31462
33446
  - Synthetics
31463
33447
  x-codegen-request-body-name: body
33448
+ x-permission:
33449
+ operator: OR
33450
+ permissions:
33451
+ - synthetics_global_variable_write
31464
33452
  /api/v1/synthetics/variables/{variable_id}:
31465
33453
  delete:
31466
33454
  description: Delete a Synthetic global variable.
@@ -31503,6 +33491,10 @@ paths:
31503
33491
  summary: Delete a global variable
31504
33492
  tags:
31505
33493
  - Synthetics
33494
+ x-permission:
33495
+ operator: OR
33496
+ permissions:
33497
+ - synthetics_global_variable_write
31506
33498
  get:
31507
33499
  description: Get the detailed configuration of a global variable.
31508
33500
  operationId: GetGlobalVariable
@@ -31589,6 +33581,10 @@ paths:
31589
33581
  tags:
31590
33582
  - Synthetics
31591
33583
  x-codegen-request-body-name: body
33584
+ x-permission:
33585
+ operator: OR
33586
+ permissions:
33587
+ - synthetics_global_variable_write
31592
33588
  /api/v1/tags/hosts:
31593
33589
  get:
31594
33590
  description: Return a mapping of tags to hosts for your whole infrastructure.
@@ -31629,6 +33625,9 @@ paths:
31629
33625
  summary: Get Tags
31630
33626
  tags:
31631
33627
  - Tags
33628
+ x-permission:
33629
+ operator: OPEN
33630
+ permissions: []
31632
33631
  /api/v1/tags/hosts/{host_name}:
31633
33632
  delete:
31634
33633
  description: 'This endpoint allows you to remove all user-assigned tags
@@ -31881,6 +33880,10 @@ paths:
31881
33880
  summary: Get hourly usage for analyzed logs
31882
33881
  tags:
31883
33882
  - Usage Metering
33883
+ x-permission:
33884
+ operator: OR
33885
+ permissions:
33886
+ - usage_read
31884
33887
  /api/v1/usage/audit_logs:
31885
33888
  get:
31886
33889
  deprecated: true
@@ -31940,6 +33943,10 @@ paths:
31940
33943
  summary: Get hourly usage for audit logs
31941
33944
  tags:
31942
33945
  - Usage Metering
33946
+ x-permission:
33947
+ operator: OR
33948
+ permissions:
33949
+ - usage_read
31943
33950
  /api/v1/usage/aws_lambda:
31944
33951
  get:
31945
33952
  deprecated: true
@@ -32000,6 +34007,10 @@ paths:
32000
34007
  summary: Get hourly usage for Lambda
32001
34008
  tags:
32002
34009
  - Usage Metering
34010
+ x-permission:
34011
+ operator: OR
34012
+ permissions:
34013
+ - usage_read
32003
34014
  /api/v1/usage/billable-summary:
32004
34015
  get:
32005
34016
  description: 'Get billable usage across your account.
@@ -32058,6 +34069,10 @@ paths:
32058
34069
  summary: Get billable usage across your account
32059
34070
  tags:
32060
34071
  - Usage Metering
34072
+ x-permission:
34073
+ operator: OR
34074
+ permissions:
34075
+ - usage_read
32061
34076
  /api/v1/usage/ci-app:
32062
34077
  get:
32063
34078
  deprecated: true
@@ -32120,6 +34135,10 @@ paths:
32120
34135
  summary: Get hourly usage for CI visibility
32121
34136
  tags:
32122
34137
  - Usage Metering
34138
+ x-permission:
34139
+ operator: OR
34140
+ permissions:
34141
+ - usage_read
32123
34142
  /api/v1/usage/cspm:
32124
34143
  get:
32125
34144
  deprecated: true
@@ -32182,6 +34201,10 @@ paths:
32182
34201
  summary: Get hourly usage for CSM Pro
32183
34202
  tags:
32184
34203
  - Usage Metering
34204
+ x-permission:
34205
+ operator: OR
34206
+ permissions:
34207
+ - usage_read
32185
34208
  /api/v1/usage/cws:
32186
34209
  get:
32187
34210
  deprecated: true
@@ -32244,6 +34267,10 @@ paths:
32244
34267
  summary: Get hourly usage for cloud workload security
32245
34268
  tags:
32246
34269
  - Usage Metering
34270
+ x-permission:
34271
+ operator: OR
34272
+ permissions:
34273
+ - usage_read
32247
34274
  /api/v1/usage/dbm:
32248
34275
  get:
32249
34276
  deprecated: true
@@ -32306,6 +34333,10 @@ paths:
32306
34333
  summary: Get hourly usage for database monitoring
32307
34334
  tags:
32308
34335
  - Usage Metering
34336
+ x-permission:
34337
+ operator: OR
34338
+ permissions:
34339
+ - usage_read
32309
34340
  /api/v1/usage/fargate:
32310
34341
  get:
32311
34342
  deprecated: true
@@ -32366,6 +34397,10 @@ paths:
32366
34397
  summary: Get hourly usage for Fargate
32367
34398
  tags:
32368
34399
  - Usage Metering
34400
+ x-permission:
34401
+ operator: OR
34402
+ permissions:
34403
+ - usage_read
32369
34404
  /api/v1/usage/hosts:
32370
34405
  get:
32371
34406
  deprecated: true
@@ -32426,6 +34461,10 @@ paths:
32426
34461
  summary: Get hourly usage for hosts and containers
32427
34462
  tags:
32428
34463
  - Usage Metering
34464
+ x-permission:
34465
+ operator: OR
34466
+ permissions:
34467
+ - usage_read
32429
34468
  /api/v1/usage/hourly-attribution:
32430
34469
  get:
32431
34470
  description: "Get hourly usage attribution. Multi-region data is available starting
@@ -32514,6 +34553,10 @@ paths:
32514
34553
  summary: Get hourly usage attribution
32515
34554
  tags:
32516
34555
  - Usage Metering
34556
+ x-permission:
34557
+ operator: OR
34558
+ permissions:
34559
+ - usage_read
32517
34560
  /api/v1/usage/incident-management:
32518
34561
  get:
32519
34562
  deprecated: true
@@ -32576,6 +34619,10 @@ paths:
32576
34619
  summary: Get hourly usage for incident management
32577
34620
  tags:
32578
34621
  - Usage Metering
34622
+ x-permission:
34623
+ operator: OR
34624
+ permissions:
34625
+ - usage_read
32579
34626
  /api/v1/usage/indexed-spans:
32580
34627
  get:
32581
34628
  deprecated: true
@@ -32636,6 +34683,10 @@ paths:
32636
34683
  summary: Get hourly usage for indexed spans
32637
34684
  tags:
32638
34685
  - Usage Metering
34686
+ x-permission:
34687
+ operator: OR
34688
+ permissions:
34689
+ - usage_read
32639
34690
  /api/v1/usage/ingested-spans:
32640
34691
  get:
32641
34692
  deprecated: true
@@ -32698,6 +34749,10 @@ paths:
32698
34749
  summary: Get hourly usage for ingested spans
32699
34750
  tags:
32700
34751
  - Usage Metering
34752
+ x-permission:
34753
+ operator: OR
34754
+ permissions:
34755
+ - usage_read
32701
34756
  /api/v1/usage/iot:
32702
34757
  get:
32703
34758
  deprecated: true
@@ -32760,6 +34815,10 @@ paths:
32760
34815
  summary: Get hourly usage for IoT
32761
34816
  tags:
32762
34817
  - Usage Metering
34818
+ x-permission:
34819
+ operator: OR
34820
+ permissions:
34821
+ - usage_read
32763
34822
  /api/v1/usage/logs:
32764
34823
  get:
32765
34824
  deprecated: true
@@ -32820,6 +34879,10 @@ paths:
32820
34879
  summary: Get hourly usage for logs
32821
34880
  tags:
32822
34881
  - Usage Metering
34882
+ x-permission:
34883
+ operator: OR
34884
+ permissions:
34885
+ - usage_read
32823
34886
  /api/v1/usage/logs-by-retention:
32824
34887
  get:
32825
34888
  deprecated: true
@@ -32882,6 +34945,10 @@ paths:
32882
34945
  summary: Get hourly logs usage by retention
32883
34946
  tags:
32884
34947
  - Usage Metering
34948
+ x-permission:
34949
+ operator: OR
34950
+ permissions:
34951
+ - usage_read
32885
34952
  /api/v1/usage/logs_by_index:
32886
34953
  get:
32887
34954
  description: Get hourly usage for logs by index.
@@ -32944,6 +35011,10 @@ paths:
32944
35011
  summary: Get hourly usage for logs by index
32945
35012
  tags:
32946
35013
  - Usage Metering
35014
+ x-permission:
35015
+ operator: OR
35016
+ permissions:
35017
+ - usage_read
32947
35018
  /api/v1/usage/monthly-attribution:
32948
35019
  get:
32949
35020
  description: "Get monthly usage attribution. Multi-region data is available
@@ -33045,6 +35116,10 @@ paths:
33045
35116
  summary: Get monthly usage attribution
33046
35117
  tags:
33047
35118
  - Usage Metering
35119
+ x-permission:
35120
+ operator: OR
35121
+ permissions:
35122
+ - usage_read
33048
35123
  /api/v1/usage/network_flows:
33049
35124
  get:
33050
35125
  deprecated: true
@@ -33107,6 +35182,10 @@ paths:
33107
35182
  summary: get hourly usage for network flows
33108
35183
  tags:
33109
35184
  - Usage Metering
35185
+ x-permission:
35186
+ operator: OR
35187
+ permissions:
35188
+ - usage_read
33110
35189
  /api/v1/usage/network_hosts:
33111
35190
  get:
33112
35191
  deprecated: true
@@ -33167,6 +35246,10 @@ paths:
33167
35246
  summary: Get hourly usage for network hosts
33168
35247
  tags:
33169
35248
  - Usage Metering
35249
+ x-permission:
35250
+ operator: OR
35251
+ permissions:
35252
+ - usage_read
33170
35253
  /api/v1/usage/online-archive:
33171
35254
  get:
33172
35255
  deprecated: true
@@ -33229,6 +35312,10 @@ paths:
33229
35312
  summary: Get hourly usage for online archive
33230
35313
  tags:
33231
35314
  - Usage Metering
35315
+ x-permission:
35316
+ operator: OR
35317
+ permissions:
35318
+ - usage_read
33232
35319
  /api/v1/usage/profiling:
33233
35320
  get:
33234
35321
  deprecated: true
@@ -33291,6 +35378,10 @@ paths:
33291
35378
  summary: Get hourly usage for profiled hosts
33292
35379
  tags:
33293
35380
  - Usage Metering
35381
+ x-permission:
35382
+ operator: OR
35383
+ permissions:
35384
+ - usage_read
33294
35385
  /api/v1/usage/rum:
33295
35386
  get:
33296
35387
  deprecated: true
@@ -33352,6 +35443,10 @@ paths:
33352
35443
  summary: Get hourly usage for RUM units
33353
35444
  tags:
33354
35445
  - Usage Metering
35446
+ x-permission:
35447
+ operator: OR
35448
+ permissions:
35449
+ - usage_read
33355
35450
  /api/v1/usage/rum_sessions:
33356
35451
  get:
33357
35452
  deprecated: true
@@ -33419,6 +35514,10 @@ paths:
33419
35514
  summary: Get hourly usage for RUM sessions
33420
35515
  tags:
33421
35516
  - Usage Metering
35517
+ x-permission:
35518
+ operator: OR
35519
+ permissions:
35520
+ - usage_read
33422
35521
  /api/v1/usage/sds:
33423
35522
  get:
33424
35523
  deprecated: true
@@ -33481,6 +35580,10 @@ paths:
33481
35580
  summary: Get hourly usage for sensitive data scanner
33482
35581
  tags:
33483
35582
  - Usage Metering
35583
+ x-permission:
35584
+ operator: OR
35585
+ permissions:
35586
+ - usage_read
33484
35587
  /api/v1/usage/snmp:
33485
35588
  get:
33486
35589
  deprecated: true
@@ -33543,6 +35646,10 @@ paths:
33543
35646
  summary: Get hourly usage for SNMP devices
33544
35647
  tags:
33545
35648
  - Usage Metering
35649
+ x-permission:
35650
+ operator: OR
35651
+ permissions:
35652
+ - usage_read
33546
35653
  /api/v1/usage/summary:
33547
35654
  get:
33548
35655
  description: 'Get all usage across your account.
@@ -33617,6 +35724,10 @@ paths:
33617
35724
  summary: Get usage across your account
33618
35725
  tags:
33619
35726
  - Usage Metering
35727
+ x-permission:
35728
+ operator: OR
35729
+ permissions:
35730
+ - usage_read
33620
35731
  /api/v1/usage/synthetics:
33621
35732
  get:
33622
35733
  deprecated: true
@@ -33677,6 +35788,10 @@ paths:
33677
35788
  summary: Get hourly usage for synthetics checks
33678
35789
  tags:
33679
35790
  - Usage Metering
35791
+ x-permission:
35792
+ operator: OR
35793
+ permissions:
35794
+ - usage_read
33680
35795
  /api/v1/usage/synthetics_api:
33681
35796
  get:
33682
35797
  deprecated: true
@@ -33737,6 +35852,10 @@ paths:
33737
35852
  summary: Get hourly usage for synthetics API checks
33738
35853
  tags:
33739
35854
  - Usage Metering
35855
+ x-permission:
35856
+ operator: OR
35857
+ permissions:
35858
+ - usage_read
33740
35859
  /api/v1/usage/synthetics_browser:
33741
35860
  get:
33742
35861
  deprecated: true
@@ -33797,6 +35916,10 @@ paths:
33797
35916
  summary: Get hourly usage for synthetics browser checks
33798
35917
  tags:
33799
35918
  - Usage Metering
35919
+ x-permission:
35920
+ operator: OR
35921
+ permissions:
35922
+ - usage_read
33800
35923
  /api/v1/usage/timeseries:
33801
35924
  get:
33802
35925
  deprecated: true
@@ -33857,6 +35980,10 @@ paths:
33857
35980
  summary: Get hourly usage for custom metrics
33858
35981
  tags:
33859
35982
  - Usage Metering
35983
+ x-permission:
35984
+ operator: OR
35985
+ permissions:
35986
+ - usage_read
33860
35987
  /api/v1/usage/top_avg_metrics:
33861
35988
  get:
33862
35989
  description: Get all [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/)
@@ -33940,6 +36067,10 @@ paths:
33940
36067
  summary: Get all custom metrics by hourly average
33941
36068
  tags:
33942
36069
  - Usage Metering
36070
+ x-permission:
36071
+ operator: OR
36072
+ permissions:
36073
+ - usage_read
33943
36074
  /api/v1/user:
33944
36075
  get:
33945
36076
  description: List all users for your organization.
@@ -33967,6 +36098,10 @@ paths:
33967
36098
  summary: List all users
33968
36099
  tags:
33969
36100
  - Users
36101
+ x-permission:
36102
+ operator: OR
36103
+ permissions:
36104
+ - user_access_read
33970
36105
  post:
33971
36106
  description: 'Create a user for your organization.
33972
36107
 
@@ -34013,6 +36148,10 @@ paths:
34013
36148
  tags:
34014
36149
  - Users
34015
36150
  x-codegen-request-body-name: body
36151
+ x-permission:
36152
+ operator: OR
36153
+ permissions:
36154
+ - user_access_invite
34016
36155
  /api/v1/user/{user_handle}:
34017
36156
  delete:
34018
36157
  description: 'Delete a user from an organization.
@@ -34172,6 +36311,9 @@ paths:
34172
36311
  summary: Validate API key
34173
36312
  tags:
34174
36313
  - Authentication
36314
+ x-permission:
36315
+ operator: OPEN
36316
+ permissions: []
34175
36317
  /v1/input:
34176
36318
  post:
34177
36319
  deprecated: true