datadog_api_client 2.27.1 → 2.28.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 (233) hide show
  1. checksums.yaml +4 -4
  2. data/.apigentools-info +4 -4
  3. data/.generator/conftest.py +0 -3
  4. data/.generator/schemas/v1/openapi.yaml +385 -616
  5. data/.generator/schemas/v2/openapi.yaml +1498 -386
  6. data/.generator/src/generator/formatter.py +2 -43
  7. data/.generator/src/generator/keywords.json +43 -0
  8. data/.generator/src/generator/templates/api.j2 +4 -0
  9. data/.generator/src/generator/templates/api_client.j2 +1 -0
  10. data/CHANGELOG.md +39 -0
  11. data/examples/v1/dashboards/CreateDashboard_1413226400.rb +66 -0
  12. data/examples/v1/dashboards/CreateDashboard_3298564989.rb +65 -0
  13. data/examples/v1/gcp-integration/CreateGCPIntegration.rb +1 -0
  14. data/examples/v1/gcp-integration/UpdateGCPIntegration.rb +1 -0
  15. data/examples/v1/gcp-integration/UpdateGCPIntegration_3544259255.rb +1 -0
  16. data/examples/v1/monitors/ValidateExistingMonitor.rb +0 -1
  17. data/examples/v1/monitors/ValidateMonitor.rb +0 -1
  18. data/examples/v1/monitors/ValidateMonitor_4247196452.rb +0 -1
  19. data/examples/v1/synthetics/CreateSyntheticsAPITest.rb +3 -1
  20. data/examples/v1/synthetics/CreateSyntheticsMobileTest.rb +1 -1
  21. data/examples/v1/synthetics/UpdateBrowserTest.rb +3 -1
  22. data/examples/v1/synthetics/UpdateMobileTest.rb +1 -1
  23. data/examples/v2/domain-allowlist/GetDomainAllowlist.rb +5 -0
  24. data/examples/v2/domain-allowlist/PatchDomainAllowlist.rb +17 -0
  25. data/examples/v2/gcp-integration/CreateGCPSTSAccount_2597004741.rb +1 -0
  26. data/examples/v2/incidents/CreateIncidentType.rb +19 -0
  27. data/examples/v2/incidents/DeleteIncidentType.rb +11 -0
  28. data/examples/v2/incidents/GetIncidentType.rb +8 -0
  29. data/examples/v2/incidents/ListIncidentTypes.rb +8 -0
  30. data/examples/v2/incidents/UpdateIncidentType.rb +22 -0
  31. data/examples/v2/metrics/QueryScalarData.rb +0 -3
  32. data/examples/v2/metrics/QueryScalarData_3112571352.rb +0 -3
  33. data/examples/v2/metrics/QueryTimeseriesData.rb +0 -3
  34. data/examples/v2/metrics/QueryTimeseriesData_301142940.rb +0 -3
  35. data/examples/v2/microsoft-teams-integration/CreateTenantBasedHandle.rb +17 -0
  36. data/examples/v2/microsoft-teams-integration/{CreateApiHandle_1540689753.rb → CreateTenantBasedHandle_1540689753.rb} +5 -5
  37. data/examples/v2/microsoft-teams-integration/DeleteTenantBasedHandle.rb +5 -0
  38. data/examples/v2/microsoft-teams-integration/DeleteTenantBasedHandle_377884154.rb +8 -0
  39. data/examples/v2/microsoft-teams-integration/GetTenantBasedHandle.rb +5 -0
  40. data/examples/v2/microsoft-teams-integration/GetTenantBasedHandle_2883785101.rb +8 -0
  41. data/examples/v2/microsoft-teams-integration/{ListApiHandles.rb → ListTenantBasedHandles.rb} +2 -2
  42. data/examples/v2/microsoft-teams-integration/{ListApiHandles_769592979.rb → ListTenantBasedHandles_769592979.rb} +1 -1
  43. data/examples/v2/microsoft-teams-integration/UpdateTenantBasedHandle.rb +17 -0
  44. data/examples/v2/microsoft-teams-integration/UpdateTenantBasedHandle_419892746.rb +18 -0
  45. data/examples/v2/rum-metrics/CreateRumMetric.rb +32 -0
  46. data/examples/v2/rum-metrics/DeleteRumMetric.rb +8 -0
  47. data/examples/v2/rum-metrics/GetRumMetric.rb +8 -0
  48. data/examples/v2/rum-metrics/ListRumMetrics.rb +5 -0
  49. data/examples/v2/rum-metrics/UpdateRumMetric.rb +29 -0
  50. data/examples/v2/security-monitoring/ListFindings_1668290866.rb +14 -0
  51. data/examples/v2/usage-metering/GetBillingDimensionMapping.rb +8 -0
  52. data/examples/v2/usage-metering/GetMonthlyCostAttribution.rb +4 -1
  53. data/lib/datadog_api_client/api_client.rb +1 -0
  54. data/lib/datadog_api_client/configuration.rb +6 -2
  55. data/lib/datadog_api_client/inflector.rb +81 -28
  56. data/lib/datadog_api_client/v1/api/monitors_api.rb +6 -3
  57. data/lib/datadog_api_client/v1/api/synthetics_api.rb +2 -0
  58. data/lib/datadog_api_client/v1/api/usage_metering_api.rb +5 -3
  59. data/lib/datadog_api_client/v1/models/gcp_account.rb +11 -1
  60. data/lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb +1 -3
  61. data/lib/datadog_api_client/v1/models/list_stream_source.rb +1 -0
  62. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_supported_metrics.rb +2 -6
  63. data/lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb +11 -61
  64. data/lib/datadog_api_client/v1/models/slo_history_monitor.rb +1 -1
  65. data/lib/datadog_api_client/v1/models/synthetics_batch_details_data.rb +2 -2
  66. data/lib/datadog_api_client/v1/models/synthetics_batch_result.rb +2 -2
  67. data/lib/datadog_api_client/v1/models/{synthetics_status.rb → synthetics_batch_status.rb} +4 -4
  68. data/lib/datadog_api_client/v1/models/synthetics_mobile_step.rb +32 -6
  69. data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params.rb +249 -0
  70. data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_direction.rb +29 -0
  71. data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element.rb +175 -0
  72. data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element_context_type.rb +27 -0
  73. data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element_relative_position.rb +115 -0
  74. data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element_user_locator.rb +117 -0
  75. data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element_user_locator_values_items.rb +115 -0
  76. data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_element_user_locator_values_items_type.rb +30 -0
  77. data/lib/datadog_api_client/v1/models/{synthetics_mobile_test_initial_application_arguments.rb → synthetics_mobile_step_params_positions_items.rb} +21 -11
  78. data/lib/datadog_api_client/v1/models/synthetics_mobile_step_params_value.rb +63 -0
  79. data/lib/datadog_api_client/v1/models/{synthetics_mobile_test_ci_options.rb → synthetics_mobile_step_params_variable.rb} +38 -17
  80. data/lib/datadog_api_client/v1/models/synthetics_mobile_test.rb +2 -2
  81. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_config.rb +1 -1
  82. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_options.rb +42 -16
  83. data/lib/datadog_api_client/v1/models/synthetics_mobile_tests_mobile_application.rb +24 -5
  84. data/lib/datadog_api_client/v1/models/synthetics_step.rb +22 -2
  85. data/lib/datadog_api_client/v1/models/synthetics_step_detail.rb +21 -1
  86. data/lib/datadog_api_client/v1/models/synthetics_test_ci_options.rb +19 -1
  87. data/lib/datadog_api_client/v1/models/synthetics_test_details_type.rb +1 -0
  88. data/lib/datadog_api_client/v1/models/synthetics_test_options_monitor_options.rb +34 -4
  89. data/lib/datadog_api_client/v1/models/{synthetics_mobile_test_options_monitor_options_notification_preset_name.rb → synthetics_test_options_monitor_options_notification_preset_name.rb} +2 -2
  90. data/lib/datadog_api_client/v1/models/synthetics_test_options_scheduling.rb +31 -2
  91. data/lib/datadog_api_client/v1/models/synthetics_test_options_scheduling_timeframe.rb +32 -6
  92. data/lib/datadog_api_client/v1/models/{synthetics_mobile_test_binding_items.rb → synthetics_test_restriction_policy_binding.rb} +11 -11
  93. data/lib/datadog_api_client/v1/models/{synthetics_mobile_test_binding_items_role.rb → synthetics_test_restriction_policy_binding_relation.rb} +2 -2
  94. data/lib/datadog_api_client/v1/models/toplist_widget_stacked.rb +1 -12
  95. data/lib/datadog_api_client/v1/models/usage_summary_date.rb +21 -1
  96. data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +21 -1
  97. data/lib/datadog_api_client/v1/models/usage_summary_response.rb +21 -1
  98. data/lib/datadog_api_client/v2/api/cloud_cost_management_api.rb +3 -69
  99. data/lib/datadog_api_client/v2/api/domain_allowlist_api.rb +153 -0
  100. data/lib/datadog_api_client/v2/api/incidents_api.rb +361 -0
  101. data/lib/datadog_api_client/v2/api/metrics_api.rb +1 -13
  102. data/lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb +98 -161
  103. data/lib/datadog_api_client/v2/api/rum_metrics_api.rb +357 -0
  104. data/lib/datadog_api_client/v2/api/security_monitoring_api.rb +3 -0
  105. data/lib/datadog_api_client/v2/api/software_catalog_api.rb +19 -19
  106. data/lib/datadog_api_client/v2/api/teams_api.rb +1 -0
  107. data/lib/datadog_api_client/v2/api/usage_metering_api.rb +79 -10
  108. data/lib/datadog_api_client/v2/models/billing_dimensions_mapping_body_item.rb +125 -0
  109. data/lib/datadog_api_client/v2/models/billing_dimensions_mapping_body_item_attributes.rb +127 -0
  110. data/lib/datadog_api_client/v2/models/billing_dimensions_mapping_body_item_attributes_endpoints_items.rb +127 -0
  111. data/lib/datadog_api_client/v2/models/billing_dimensions_mapping_body_item_attributes_endpoints_items_status.rb +27 -0
  112. data/lib/datadog_api_client/v2/models/billing_dimensions_mapping_response.rb +107 -0
  113. data/lib/datadog_api_client/v2/models/cloudflare_account_create_request_attributes.rb +1 -1
  114. data/lib/datadog_api_client/v2/models/cloudflare_account_response_attributes.rb +1 -1
  115. data/lib/datadog_api_client/v2/models/cloudflare_account_update_request_attributes.rb +1 -1
  116. data/lib/datadog_api_client/v2/models/domain_allowlist.rb +151 -0
  117. data/lib/datadog_api_client/v2/models/{aws_related_account_attributes.rb → domain_allowlist_attributes.rb} +20 -18
  118. data/lib/datadog_api_client/v2/models/domain_allowlist_request.rb +123 -0
  119. data/lib/datadog_api_client/{v1/models/synthetics_mobile_test_binding.rb → v2/models/domain_allowlist_response.rb} +13 -13
  120. data/lib/datadog_api_client/v2/models/domain_allowlist_response_data.rb +151 -0
  121. data/lib/datadog_api_client/v2/models/domain_allowlist_response_data_attributes.rb +117 -0
  122. data/lib/datadog_api_client/v2/models/{microsoft_teams_api_handle_type.rb → domain_allowlist_type.rb} +3 -3
  123. data/lib/datadog_api_client/v2/models/entity_attributes.rb +1 -1
  124. data/lib/datadog_api_client/v2/models/entity_data.rb +1 -1
  125. data/lib/datadog_api_client/v2/models/entity_response_included_incident.rb +1 -1
  126. data/lib/datadog_api_client/v2/models/entity_response_included_raw_schema.rb +1 -1
  127. data/lib/datadog_api_client/v2/models/entity_response_included_related_oncall_attributes.rb +1 -1
  128. data/lib/datadog_api_client/v2/models/entity_response_included_related_oncall_escalation_item.rb +1 -1
  129. data/lib/datadog_api_client/v2/models/entity_response_included_schema.rb +1 -1
  130. data/lib/datadog_api_client/v2/models/entity_v3_api_version.rb +1 -1
  131. data/lib/datadog_api_client/v2/models/entity_v3_datadog_code_location_item.rb +3 -3
  132. data/lib/datadog_api_client/v2/models/entity_v3_datadog_event_item.rb +2 -2
  133. data/lib/datadog_api_client/v2/models/entity_v3_datadog_integration_opsgenie.rb +2 -2
  134. data/lib/datadog_api_client/v2/models/entity_v3_datadog_integration_pagerduty.rb +2 -2
  135. data/lib/datadog_api_client/v2/models/entity_v3_datadog_log_item.rb +3 -3
  136. data/lib/datadog_api_client/v2/models/entity_v3_datadog_performance.rb +2 -2
  137. data/lib/datadog_api_client/v2/models/entity_v3_datadog_pipelines.rb +2 -2
  138. data/lib/datadog_api_client/v2/models/entity_v3_datastore.rb +4 -4
  139. data/lib/datadog_api_client/v2/models/entity_v3_datastore_datadog.rb +4 -4
  140. data/lib/datadog_api_client/v2/models/entity_v3_datastore_spec.rb +2 -2
  141. data/lib/datadog_api_client/v2/models/entity_v3_integrations.rb +3 -3
  142. data/lib/datadog_api_client/v2/models/entity_v3_metadata.rb +9 -9
  143. data/lib/datadog_api_client/v2/models/entity_v3_metadata_additional_owners_items.rb +2 -2
  144. data/lib/datadog_api_client/v2/models/entity_v3_metadata_contacts_items.rb +2 -2
  145. data/lib/datadog_api_client/v2/models/entity_v3_metadata_links_items.rb +2 -2
  146. data/lib/datadog_api_client/v2/models/entity_v3_metadata_owner.rb +2 -2
  147. data/lib/datadog_api_client/v2/models/entity_v3_queue.rb +5 -5
  148. data/lib/datadog_api_client/v2/models/entity_v3_queue_datadog.rb +4 -4
  149. data/lib/datadog_api_client/v2/models/entity_v3_queue_spec.rb +2 -2
  150. data/lib/datadog_api_client/v2/models/entity_v3_service.rb +5 -5
  151. data/lib/datadog_api_client/v2/models/entity_v3_service_datadog.rb +6 -6
  152. data/lib/datadog_api_client/v2/models/entity_v3_service_spec.rb +3 -3
  153. data/lib/datadog_api_client/v2/models/entity_v3_system.rb +5 -5
  154. data/lib/datadog_api_client/v2/models/entity_v3_system_datadog.rb +5 -5
  155. data/lib/datadog_api_client/v2/models/finding_attributes.rb +14 -4
  156. data/lib/datadog_api_client/v2/models/finding_vulnerability_type.rb +29 -0
  157. data/lib/datadog_api_client/v2/models/gcp_metric_namespace_config.rb +115 -0
  158. data/lib/datadog_api_client/v2/models/gcpsts_service_account_attributes.rb +23 -1
  159. data/lib/datadog_api_client/v2/models/incident_create_attributes.rb +11 -1
  160. data/lib/datadog_api_client/v2/models/incident_integration_metadata_metadata.rb +2 -1
  161. data/lib/datadog_api_client/v2/models/incident_response_attributes.rb +11 -1
  162. data/lib/datadog_api_client/v2/models/incident_response_included_item.rb +1 -1
  163. data/lib/datadog_api_client/v2/models/incident_type_attributes.rb +193 -0
  164. data/lib/datadog_api_client/v2/models/{microsoft_teams_api_handle_request_data.rb → incident_type_create_data.rb} +7 -7
  165. data/lib/datadog_api_client/v2/models/{microsoft_teams_create_api_handle_request.rb → incident_type_create_request.rb} +5 -5
  166. data/lib/datadog_api_client/v2/models/{microsoft_teams_api_handles_response.rb → incident_type_list_response.rb} +5 -5
  167. data/lib/datadog_api_client/v2/models/{aws_related_account.rb → incident_type_object.rb} +8 -8
  168. data/lib/datadog_api_client/v2/models/incident_type_patch_data.rb +165 -0
  169. data/lib/datadog_api_client/v2/models/{microsoft_teams_create_api_handle_response.rb → incident_type_patch_request.rb} +5 -5
  170. data/lib/datadog_api_client/v2/models/{microsoft_teams_update_api_handle_request.rb → incident_type_response.rb} +5 -5
  171. data/lib/datadog_api_client/v2/models/{aws_related_account_type.rb → incident_type_type.rb} +3 -3
  172. data/lib/datadog_api_client/v2/models/incident_type_update_attributes.rb +175 -0
  173. data/lib/datadog_api_client/v2/models/incident_user_attributes.rb +153 -0
  174. data/lib/datadog_api_client/v2/models/incident_user_data.rb +125 -0
  175. data/lib/datadog_api_client/v2/models/include_type.rb +1 -1
  176. data/lib/datadog_api_client/v2/models/list_entity_catalog_response_links.rb +3 -3
  177. data/lib/datadog_api_client/v2/models/microsoft_teams_create_tenant_based_handle_request.rb +123 -0
  178. data/lib/datadog_api_client/v2/models/{microsoft_teams_api_handle_attributes.rb → microsoft_teams_tenant_based_handle_attributes.rb} +4 -4
  179. data/lib/datadog_api_client/v2/models/{microsoft_teams_api_handle_info_response_attributes.rb → microsoft_teams_tenant_based_handle_info_response_attributes.rb} +4 -4
  180. data/lib/datadog_api_client/v2/models/{microsoft_teams_api_handle_response_data.rb → microsoft_teams_tenant_based_handle_info_response_data.rb} +8 -8
  181. data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_info_type.rb +26 -0
  182. data/lib/datadog_api_client/v2/models/{microsoft_teams_api_handle_request_attributes.rb → microsoft_teams_tenant_based_handle_request_attributes.rb} +4 -4
  183. data/lib/datadog_api_client/v2/models/{microsoft_teams_update_api_handle_request_data.rb → microsoft_teams_tenant_based_handle_request_data.rb} +7 -7
  184. data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_response.rb +123 -0
  185. data/lib/datadog_api_client/v2/models/{microsoft_teams_api_handle_info_response_data.rb → microsoft_teams_tenant_based_handle_response_data.rb} +8 -8
  186. data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handle_type.rb +26 -0
  187. data/lib/datadog_api_client/v2/models/microsoft_teams_tenant_based_handles_response.rb +125 -0
  188. data/lib/datadog_api_client/v2/models/microsoft_teams_update_tenant_based_handle_request.rb +123 -0
  189. data/lib/datadog_api_client/v2/models/microsoft_teams_update_tenant_based_handle_request_data.rb +144 -0
  190. data/lib/datadog_api_client/v2/models/ms_teams_integration_metadata.rb +125 -0
  191. data/lib/datadog_api_client/v2/models/ms_teams_integration_metadata_teams_item.rb +186 -0
  192. data/lib/datadog_api_client/v2/models/relation_type.rb +1 -1
  193. data/lib/datadog_api_client/v2/models/relationship_item.rb +1 -1
  194. data/lib/datadog_api_client/v2/models/rum_metric_compute.rb +145 -0
  195. data/lib/datadog_api_client/v2/models/rum_metric_compute_aggregation_type.rb +27 -0
  196. data/lib/datadog_api_client/v2/models/rum_metric_create_attributes.rb +176 -0
  197. data/lib/datadog_api_client/v2/models/rum_metric_create_data.rb +165 -0
  198. data/lib/datadog_api_client/v2/models/rum_metric_create_request.rb +123 -0
  199. data/lib/datadog_api_client/v2/models/rum_metric_event_type.rb +32 -0
  200. data/lib/datadog_api_client/v2/models/rum_metric_filter.rb +123 -0
  201. data/lib/datadog_api_client/v2/models/rum_metric_group_by.rb +133 -0
  202. data/lib/datadog_api_client/v2/models/{microsoft_teams_api_handle_info_response.rb → rum_metric_response.rb} +5 -5
  203. data/lib/datadog_api_client/v2/models/rum_metric_response_attributes.rb +147 -0
  204. data/lib/datadog_api_client/v2/models/rum_metric_response_compute.rb +127 -0
  205. data/lib/datadog_api_client/v2/models/rum_metric_response_data.rb +125 -0
  206. data/lib/datadog_api_client/{v1/models/synthetics_mobile_test_initial_application_arguments_property_names.rb → v2/models/rum_metric_response_filter.rb} +13 -13
  207. data/lib/datadog_api_client/v2/models/rum_metric_response_group_by.rb +115 -0
  208. data/lib/datadog_api_client/v2/models/rum_metric_response_uniqueness.rb +105 -0
  209. data/lib/datadog_api_client/v2/models/{microsoft_teams_api_handle_info_type.rb → rum_metric_type.rb} +3 -3
  210. data/lib/datadog_api_client/v2/models/rum_metric_uniqueness.rb +123 -0
  211. data/lib/datadog_api_client/v2/models/rum_metric_uniqueness_when.rb +27 -0
  212. data/lib/datadog_api_client/v2/models/rum_metric_update_attributes.rb +127 -0
  213. data/lib/datadog_api_client/v2/models/rum_metric_update_compute.rb +106 -0
  214. data/lib/datadog_api_client/v2/models/rum_metric_update_data.rb +154 -0
  215. data/lib/datadog_api_client/v2/models/rum_metric_update_request.rb +123 -0
  216. data/lib/datadog_api_client/v2/models/{aws_related_accounts_response.rb → rum_metrics_response.rb} +5 -5
  217. data/lib/datadog_api_client/v2/models/sensitive_data_scanner_included_keyword_configuration.rb +15 -4
  218. data/lib/datadog_api_client/v2/models/sensitive_data_scanner_meta.rb +2 -2
  219. data/lib/datadog_api_client/v2/models/upsert_catalog_entity_request.rb +1 -1
  220. data/lib/datadog_api_client/version.rb +1 -1
  221. metadata +110 -43
  222. data/examples/v2/cloud-cost-management/ListAWSRelatedAccounts.rb +0 -5
  223. data/examples/v2/microsoft-teams-integration/CreateApiHandle.rb +0 -17
  224. data/examples/v2/microsoft-teams-integration/DeleteApiHandle.rb +0 -5
  225. data/examples/v2/microsoft-teams-integration/DeleteApiHandle_377884154.rb +0 -8
  226. data/examples/v2/microsoft-teams-integration/GetApiHandle.rb +0 -5
  227. data/examples/v2/microsoft-teams-integration/GetApiHandleByName.rb +0 -5
  228. data/examples/v2/microsoft-teams-integration/GetApiHandleByName_1103107145.rb +0 -8
  229. data/examples/v2/microsoft-teams-integration/GetApiHandle_2883785101.rb +0 -8
  230. data/examples/v2/microsoft-teams-integration/UpdateApiHandle.rb +0 -17
  231. data/examples/v2/microsoft-teams-integration/UpdateApiHandle_419892746.rb +0 -18
  232. data/lib/datadog_api_client/v1/models/synthetics_mobile_device_id.rb +0 -251
  233. data/lib/datadog_api_client/v1/models/synthetics_mobile_test_options_monitor_options.rb +0 -155
data/.generator/schemas/v1/openapi.yaml CHANGED
@@ -3314,6 +3314,12 @@ components:
3314
3314
  to be set to true.'
3315
3315
  example: true
3316
3316
  type: boolean
3317
+ is_resource_change_collection_enabled:
3318
+ default: false
3319
+ description: When enabled, Datadog scans for all resource change data in
3320
+ your Google Cloud environment.
3321
+ example: true
3322
+ type: boolean
3317
3323
  is_security_command_center_enabled:
3318
3324
  default: false
3319
3325
  description: 'When enabled, Datadog will attempt to collect Security Command
@@ -4183,15 +4189,13 @@ components:
4183
4189
  - cws_containers_usage
4184
4190
  - cws_hosts_usage
4185
4191
  - data_jobs_monitoring_usage
4192
+ - data_stream_monitoring_usage
4186
4193
  - dbm_hosts_usage
4187
4194
  - dbm_queries_usage
4188
4195
  - error_tracking_usage
4189
4196
  - error_tracking_percentage
4190
- - estimated_indexed_logs_usage
4191
4197
  - estimated_indexed_spans_usage
4192
- - estimated_ingested_logs_usage
4193
4198
  - estimated_ingested_spans_usage
4194
- - estimated_rum_sessions_usage
4195
4199
  - fargate_usage
4196
4200
  - functions_usage
4197
4201
  - incident_management_monthly_active_users_usage
@@ -4257,15 +4261,13 @@ components:
4257
4261
  - CWS_CONTAINERS_USAGE
4258
4262
  - CWS_HOSTS_USAGE
4259
4263
  - DATA_JOBS_MONITORING_USAGE
4264
+ - DATA_STREAM_MONITORING_USAGE
4260
4265
  - DBM_HOSTS_USAGE
4261
4266
  - DBM_QUERIES_USAGE
4262
4267
  - ERROR_TRACKING_USAGE
4263
4268
  - ERROR_TRACKING_PERCENTAGE
4264
- - ESTIMATED_INDEXED_LOGS_USAGE
4265
4269
  - ESTIMATED_INDEXED_SPANS_USAGE
4266
- - ESTIMATED_INGESTED_LOGS_USAGE
4267
4270
  - ESTIMATED_INGESTED_SPANS_USAGE
4268
- - ESTIMATED_RUM_SESSIONS_USAGE
4269
4271
  - FARGATE_USAGE
4270
4272
  - FUNCTIONS_USAGE
4271
4273
  - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_USAGE
@@ -4788,6 +4790,7 @@ components:
4788
4790
  - logs_transaction_stream
4789
4791
  - event_stream
4790
4792
  - rum_stream
4793
+ - llm_observability_stream
4791
4794
  example: apm_issue_stream
4792
4795
  type: string
4793
4796
  x-enum-varnames:
@@ -4803,6 +4806,7 @@ components:
4803
4806
  - LOGS_TRANSACTION_STREAM
4804
4807
  - EVENT_STREAM
4805
4808
  - RUM_STREAM
4809
+ - LLM_OBSERVABILITY_STREAM
4806
4810
  ListStreamWidgetDefinition:
4807
4811
  description: 'The list stream visualization displays a table of recent events
4808
4812
  in your application that
@@ -7939,16 +7943,14 @@ components:
7939
7943
  - cws_hosts_usage
7940
7944
  - data_jobs_monitoring_usage
7941
7945
  - data_jobs_monitoring_percentage
7946
+ - data_stream_monitoring_usage
7947
+ - data_stream_monitoring_percentage
7942
7948
  - dbm_hosts_percentage
7943
7949
  - dbm_hosts_usage
7944
7950
  - dbm_queries_percentage
7945
7951
  - dbm_queries_usage
7946
7952
  - error_tracking_usage
7947
7953
  - error_tracking_percentage
7948
- - estimated_indexed_logs_usage
7949
- - estimated_indexed_logs_percentage
7950
- - estimated_ingested_logs_usage
7951
- - estimated_ingested_logs_percentage
7952
7954
  - estimated_indexed_spans_usage
7953
7955
  - estimated_indexed_spans_percentage
7954
7956
  - estimated_ingested_spans_usage
@@ -7987,8 +7989,6 @@ components:
7987
7989
  - serverless_apps_percentage
7988
7990
  - snmp_usage
7989
7991
  - snmp_percentage
7990
- - estimated_rum_sessions_usage
7991
- - estimated_rum_sessions_percentage
7992
7992
  - universal_service_monitoring_usage
7993
7993
  - universal_service_monitoring_percentage
7994
7994
  - vuln_management_hosts_usage
@@ -8082,16 +8082,14 @@ components:
8082
8082
  - CWS_HOSTS_USAGE
8083
8083
  - DATA_JOBS_MONITORING_USAGE
8084
8084
  - DATA_JOBS_MONITORING_PERCENTAGE
8085
+ - DATA_STREAM_MONITORING_USAGE
8086
+ - DATA_STREAM_MONITORING_PERCENTAGE
8085
8087
  - DBM_HOSTS_PERCENTAGE
8086
8088
  - DBM_HOSTS_USAGE
8087
8089
  - DBM_QUERIES_PERCENTAGE
8088
8090
  - DBM_QUERIES_USAGE
8089
8091
  - ERROR_TRACKING_USAGE
8090
8092
  - ERROR_TRACKING_PERCENTAGE
8091
- - ESTIMATED_INDEXED_LOGS_USAGE
8092
- - ESTIMATED_INDEXED_LOGS_PERCENTAGE
8093
- - ESTIMATED_INGESTED_LOGS_USAGE
8094
- - ESTIMATED_INGESTED_LOGS_PERCENTAGE
8095
8093
  - ESTIMATED_INDEXED_SPANS_USAGE
8096
8094
  - ESTIMATED_INDEXED_SPANS_PERCENTAGE
8097
8095
  - ESTIMATED_INGESTED_SPANS_USAGE
@@ -8130,8 +8128,6 @@ components:
8130
8128
  - SERVERLESS_APPS_PERCENTAGE
8131
8129
  - SNMP_USAGE
8132
8130
  - SNMP_PERCENTAGE
8133
- - ESTIMATED_RUM_SESSIONS_USAGE
8134
- - ESTIMATED_RUM_SESSIONS_PERCENTAGE
8135
8131
  - UNIVERSAL_SERVICE_MONITORING_USAGE
8136
8132
  - UNIVERSAL_SERVICE_MONITORING_PERCENTAGE
8137
8133
  - VULN_MANAGEMENT_HOSTS_USAGE
@@ -8373,6 +8369,10 @@ components:
8373
8369
  description: The Data Jobs Monitoring usage by tag(s).
8374
8370
  format: double
8375
8371
  type: number
8372
+ data_stream_monitoring_usage:
8373
+ description: The Data Stream Monitoring usage by tag(s).
8374
+ format: double
8375
+ type: number
8376
8376
  dbm_hosts_percentage:
8377
8377
  description: The percentage of Database Monitoring host usage by tag(s).
8378
8378
  format: double
@@ -8397,14 +8397,6 @@ components:
8397
8397
  description: The error tracking events usage by tag(s).
8398
8398
  format: double
8399
8399
  type: number
8400
- estimated_indexed_logs_percentage:
8401
- description: The percentage of estimated live indexed logs usage by tag(s).
8402
- format: double
8403
- type: number
8404
- estimated_indexed_logs_usage:
8405
- description: The estimated live indexed logs usage by tag(s).
8406
- format: double
8407
- type: number
8408
8400
  estimated_indexed_spans_percentage:
8409
8401
  description: The percentage of estimated indexed spans usage by tag(s).
8410
8402
  format: double
@@ -8413,14 +8405,6 @@ components:
8413
8405
  description: The estimated indexed spans usage by tag(s).
8414
8406
  format: double
8415
8407
  type: number
8416
- estimated_ingested_logs_percentage:
8417
- description: The percentage of estimated live ingested logs usage by tag(s).
8418
- format: double
8419
- type: number
8420
- estimated_ingested_logs_usage:
8421
- description: The estimated live ingested logs usage by tag(s).
8422
- format: double
8423
- type: number
8424
8408
  estimated_ingested_spans_percentage:
8425
8409
  description: The percentage of estimated ingested spans usage by tag(s).
8426
8410
  format: double
@@ -8429,14 +8413,6 @@ components:
8429
8413
  description: The estimated ingested spans usage by tag(s).
8430
8414
  format: double
8431
8415
  type: number
8432
- estimated_rum_sessions_percentage:
8433
- description: The percentage of estimated rum sessions usage by tag(s).
8434
- format: double
8435
- type: number
8436
- estimated_rum_sessions_usage:
8437
- description: The estimated rum sessions usage by tag(s).
8438
- format: double
8439
- type: number
8440
8416
  fargate_percentage:
8441
8417
  description: The percentage of Fargate usage by tags.
8442
8418
  format: double
@@ -10837,7 +10813,7 @@ components:
10837
10813
  Periods of no data are counted either as uptime or downtime depending
10838
10814
  on monitor settings.
10839
10815
 
10840
- See [SLO documentatio](https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data)
10816
+ See [SLO documentation](https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data)
10841
10817
 
10842
10818
  for detailed information.'
10843
10819
  example:
@@ -14442,7 +14418,7 @@ components:
14442
14418
  $ref: '#/components/schemas/SyntheticsBatchResult'
14443
14419
  type: array
14444
14420
  status:
14445
- $ref: '#/components/schemas/SyntheticsStatus'
14421
+ $ref: '#/components/schemas/SyntheticsBatchStatus'
14446
14422
  type: object
14447
14423
  SyntheticsBatchResult:
14448
14424
  description: Object with the results of a Synthetic batch.
@@ -14466,7 +14442,7 @@ components:
14466
14442
  format: double
14467
14443
  type: number
14468
14444
  status:
14469
- $ref: '#/components/schemas/SyntheticsStatus'
14445
+ $ref: '#/components/schemas/SyntheticsBatchStatus'
14470
14446
  test_name:
14471
14447
  description: Name of the test.
14472
14448
  type: string
@@ -14476,6 +14452,17 @@ components:
14476
14452
  test_type:
14477
14453
  $ref: '#/components/schemas/SyntheticsTestDetailsType'
14478
14454
  type: object
14455
+ SyntheticsBatchStatus:
14456
+ description: Determines whether the batch has passed, failed, or is in progress.
14457
+ enum:
14458
+ - passed
14459
+ - skipped
14460
+ - failed
14461
+ type: string
14462
+ x-enum-varnames:
14463
+ - PASSED
14464
+ - SKIPPED
14465
+ - FAILED
14479
14466
  SyntheticsBrowserError:
14480
14467
  description: Error response object for a browser test.
14481
14468
  properties:
@@ -15498,462 +15485,8 @@ components:
15498
15485
  type: object
15499
15486
  SyntheticsMobileDeviceID:
15500
15487
  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
15488
+ example: synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16
15729
15489
  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
15490
  SyntheticsMobileStep:
15958
15491
  description: The steps used in a Synthetic mobile test.
15959
15492
  properties:
@@ -15969,14 +15502,14 @@ components:
15969
15502
  type: boolean
15970
15503
  name:
15971
15504
  description: The name of the step.
15505
+ example: ''
15972
15506
  maxLength: 1500
15973
15507
  type: string
15974
15508
  noScreenshot:
15975
15509
  description: A boolean set to not take a screenshot for the step.
15976
15510
  type: boolean
15977
15511
  params:
15978
- description: The parameters of the mobile step.
15979
- type: object
15512
+ $ref: '#/components/schemas/SyntheticsMobileStepParams'
15980
15513
  publicId:
15981
15514
  description: The public ID of the step.
15982
15515
  example: pub-lic-id0
@@ -15987,6 +15520,199 @@ components:
15987
15520
  type: integer
15988
15521
  type:
15989
15522
  $ref: '#/components/schemas/SyntheticsMobileStepType'
15523
+ required:
15524
+ - name
15525
+ - params
15526
+ - type
15527
+ type: object
15528
+ SyntheticsMobileStepParams:
15529
+ description: The parameters of a mobile step.
15530
+ properties:
15531
+ check:
15532
+ $ref: '#/components/schemas/SyntheticsCheckType'
15533
+ delay:
15534
+ description: Number of milliseconds to wait between inputs in a `typeText`
15535
+ step type.
15536
+ format: int64
15537
+ maximum: 5000
15538
+ minimum: 0
15539
+ type: integer
15540
+ direction:
15541
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsDirection'
15542
+ element:
15543
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElement'
15544
+ enabled:
15545
+ description: Boolean to change the state of the wifi for a `toggleWiFi`
15546
+ step type.
15547
+ type: boolean
15548
+ maxScrolls:
15549
+ description: Maximum number of scrolls to do for a `scrollToElement` step
15550
+ type.
15551
+ format: int64
15552
+ type: integer
15553
+ positions:
15554
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsPositions'
15555
+ subtestPublicId:
15556
+ description: Public ID of the test to be played as part of a `playSubTest`
15557
+ step type.
15558
+ type: string
15559
+ value:
15560
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsValue'
15561
+ variable:
15562
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsVariable'
15563
+ withEnter:
15564
+ description: Boolean to indicate if `Enter` should be pressed at the end
15565
+ of the `typeText` step type.
15566
+ type: boolean
15567
+ x:
15568
+ description: Amount to scroll by on the `x` axis for a `scroll` step type.
15569
+ format: double
15570
+ type: number
15571
+ y:
15572
+ description: Amount to scroll by on the `y` axis for a `scroll` step type.
15573
+ format: double
15574
+ type: number
15575
+ type: object
15576
+ SyntheticsMobileStepParamsDirection:
15577
+ description: The direction of the scroll for a `scrollToElement` step type.
15578
+ enum:
15579
+ - up
15580
+ - down
15581
+ - left
15582
+ - right
15583
+ type: string
15584
+ x-enum-varnames:
15585
+ - UP
15586
+ - DOWN
15587
+ - LEFT
15588
+ - RIGHT
15589
+ SyntheticsMobileStepParamsElement:
15590
+ description: Information about the element used for a step.
15591
+ properties:
15592
+ context:
15593
+ description: Context of the element.
15594
+ type: string
15595
+ contextType:
15596
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementContextType'
15597
+ elementDescription:
15598
+ description: Description of the element.
15599
+ type: string
15600
+ multiLocator:
15601
+ description: Multi-locator to find the element.
15602
+ type: object
15603
+ relativePosition:
15604
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementRelativePosition'
15605
+ textContent:
15606
+ description: Text content of the element.
15607
+ type: string
15608
+ userLocator:
15609
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocator'
15610
+ viewName:
15611
+ description: Name of the view of the element.
15612
+ type: string
15613
+ type: object
15614
+ SyntheticsMobileStepParamsElementContextType:
15615
+ description: Type of the context that the element is in.
15616
+ enum:
15617
+ - native
15618
+ - web
15619
+ type: string
15620
+ x-enum-varnames:
15621
+ - NATIVE
15622
+ - WEB
15623
+ SyntheticsMobileStepParamsElementRelativePosition:
15624
+ description: Position of the action relative to the element.
15625
+ properties:
15626
+ x:
15627
+ description: The `relativePosition` on the `x` axis for the element.
15628
+ format: double
15629
+ type: number
15630
+ y:
15631
+ description: The `relativePosition` on the `y` axis for the element.
15632
+ format: double
15633
+ type: number
15634
+ type: object
15635
+ SyntheticsMobileStepParamsElementUserLocator:
15636
+ description: User locator to find the element.
15637
+ properties:
15638
+ failTestOnCannotLocate:
15639
+ description: Whether if the the test should fail if the element cannot be
15640
+ found.
15641
+ type: boolean
15642
+ values:
15643
+ description: Values of the user locator.
15644
+ items:
15645
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItems'
15646
+ type: array
15647
+ type: object
15648
+ SyntheticsMobileStepParamsElementUserLocatorValuesItems:
15649
+ description: A single user locator object.
15650
+ properties:
15651
+ type:
15652
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItemsType'
15653
+ value:
15654
+ description: Value of a user locator.
15655
+ type: string
15656
+ type: object
15657
+ SyntheticsMobileStepParamsElementUserLocatorValuesItemsType:
15658
+ description: Type of a user locator.
15659
+ enum:
15660
+ - accessibility-id
15661
+ - id
15662
+ - ios-predicate-string
15663
+ - ios-class-chain
15664
+ - xpath
15665
+ type: string
15666
+ x-enum-varnames:
15667
+ - ACCESSIBILITY_ID
15668
+ - ID
15669
+ - IOS_PREDICATE_STRING
15670
+ - IOS_CLASS_CHAIN
15671
+ - XPATH
15672
+ SyntheticsMobileStepParamsPositions:
15673
+ description: List of positions for the `flick` step type. The maximum is 10
15674
+ flicks per step
15675
+ items:
15676
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsPositionsItems'
15677
+ type: array
15678
+ SyntheticsMobileStepParamsPositionsItems:
15679
+ description: A description of a single position for a `flick` step type.
15680
+ properties:
15681
+ x:
15682
+ description: The `x` position for the flick.
15683
+ format: double
15684
+ type: number
15685
+ y:
15686
+ description: The `y` position for the flick.
15687
+ format: double
15688
+ type: number
15689
+ type: object
15690
+ SyntheticsMobileStepParamsValue:
15691
+ description: Values used in the step for in multiple step types.
15692
+ oneOf:
15693
+ - $ref: '#/components/schemas/SyntheticsMobileStepParamsValueString'
15694
+ - $ref: '#/components/schemas/SyntheticsMobileStepParamsValueNumber'
15695
+ SyntheticsMobileStepParamsValueNumber:
15696
+ description: Value used in the step for in multiple step types.
15697
+ format: int64
15698
+ type: integer
15699
+ SyntheticsMobileStepParamsValueString:
15700
+ description: Value used in the step for in multiple step types.
15701
+ type: string
15702
+ SyntheticsMobileStepParamsVariable:
15703
+ description: Variable object for `extractVariable` step type.
15704
+ properties:
15705
+ example:
15706
+ description: An example for the variable.
15707
+ example: ''
15708
+ type: string
15709
+ name:
15710
+ description: The variable name.
15711
+ example: VAR_NAME
15712
+ type: string
15713
+ required:
15714
+ - name
15715
+ - example
15990
15716
  type: object
15991
15717
  SyntheticsMobileStepType:
15992
15718
  description: Step type used in your mobile Synthetic test.
@@ -16034,7 +15760,7 @@ components:
16034
15760
  config:
16035
15761
  $ref: '#/components/schemas/SyntheticsMobileTestConfig'
16036
15762
  device_ids:
16037
- description: The `SyntheticsMobileTest` `device_ids`.
15763
+ description: Array with the different device IDs used to run the test.
16038
15764
  items:
16039
15765
  $ref: '#/components/schemas/SyntheticsMobileDeviceID'
16040
15766
  type: array
@@ -16082,44 +15808,6 @@ components:
16082
15808
  - options
16083
15809
  - type
16084
15810
  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
15811
  SyntheticsMobileTestConfig:
16124
15812
  description: Configuration object for a Synthetic mobile test.
16125
15813
  properties:
@@ -16132,34 +15820,27 @@ components:
16132
15820
  type: array
16133
15821
  type: object
16134
15822
  SyntheticsMobileTestInitialApplicationArguments:
15823
+ additionalProperties:
15824
+ description: A single application argument.
15825
+ type: string
16135
15826
  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
15827
  type: object
16148
15828
  SyntheticsMobileTestOptions:
16149
15829
  description: Object describing the extra options for a Synthetic test.
16150
15830
  properties:
16151
15831
  allowApplicationCrash:
16152
- description: The `SyntheticsMobileTestOptions` `allowApplicationCrash`.
15832
+ description: A boolean to set if an application crash would mark the test
15833
+ as failed.
16153
15834
  type: boolean
16154
15835
  bindings:
16155
15836
  description: Array of bindings used for the mobile test.
16156
15837
  items:
16157
- $ref: '#/components/schemas/SyntheticsMobileTestBinding'
15838
+ $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBinding'
16158
15839
  type: array
16159
15840
  ci:
16160
- $ref: '#/components/schemas/SyntheticsMobileTestCiOptions'
15841
+ $ref: '#/components/schemas/SyntheticsTestCiOptions'
16161
15842
  defaultStepTimeout:
16162
- description: The `SyntheticsMobileTestOptions` `defaultStepTimeout`.
15843
+ description: The default timeout for steps in the test (in seconds).
16163
15844
  format: int32
16164
15845
  maximum: 300
16165
15846
  minimum: 1
@@ -16167,11 +15848,13 @@ components:
16167
15848
  device_ids:
16168
15849
  description: For mobile test, array with the different device IDs used to
16169
15850
  run the test.
15851
+ example:
15852
+ - synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16
16170
15853
  items:
16171
15854
  $ref: '#/components/schemas/SyntheticsMobileDeviceID'
16172
15855
  type: array
16173
15856
  disableAutoAcceptAlert:
16174
- description: The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.
15857
+ description: A boolean to disable auto accepting alerts.
16175
15858
  type: boolean
16176
15859
  min_failure_duration:
16177
15860
  description: Minimum amount of time in failure required to trigger an alert.
@@ -16186,7 +15869,7 @@ components:
16186
15869
  all monitor dashboard widgets and SLOs.
16187
15870
  type: string
16188
15871
  monitor_options:
16189
- $ref: '#/components/schemas/SyntheticsMobileTestOptionsMonitorOptions'
15872
+ $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptions'
16190
15873
  monitor_priority:
16191
15874
  description: Integer from 1 (high) to 5 (low) indicating alert severity.
16192
15875
  format: int32
@@ -16194,7 +15877,7 @@ components:
16194
15877
  minimum: 1
16195
15878
  type: integer
16196
15879
  noScreenshot:
16197
- description: The `SyntheticsMobileTestOptions` `noScreenshot`.
15880
+ description: A boolean set to not take a screenshot for the step.
16198
15881
  type: boolean
16199
15882
  restricted_roles:
16200
15883
  $ref: '#/components/schemas/SyntheticsRestrictedRoles'
@@ -16204,54 +15887,22 @@ components:
16204
15887
  $ref: '#/components/schemas/SyntheticsTestOptionsScheduling'
16205
15888
  tick_every:
16206
15889
  description: The frequency at which to run the Synthetic test (in seconds).
15890
+ example: 300
16207
15891
  format: int64
16208
15892
  maximum: 604800
16209
15893
  minimum: 300
16210
15894
  type: integer
16211
15895
  verbosity:
16212
- description: The `SyntheticsMobileTestOptions` `verbosity`.
15896
+ description: The level of verbosity for the mobile test.
16213
15897
  format: int32
16214
15898
  maximum: 5
16215
15899
  minimum: 0
16216
15900
  type: integer
15901
+ required:
15902
+ - device_ids
15903
+ - tick_every
15904
+ - mobileApplication
16217
15905
  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
15906
  SyntheticsMobileTestType:
16256
15907
  default: mobile
16257
15908
  description: Type of the Synthetic test, `mobile`.
@@ -16266,14 +15917,20 @@ components:
16266
15917
  properties:
16267
15918
  applicationId:
16268
15919
  description: Application ID of the mobile application.
15920
+ example: 00000000-0000-0000-0000-aaaaaaaaaaaa
16269
15921
  maxLength: 1500
16270
15922
  type: string
16271
15923
  referenceId:
16272
15924
  description: Reference ID of the mobile application.
15925
+ example: 00000000-0000-0000-0000-aaaaaaaaaaab
16273
15926
  maxLength: 1500
16274
15927
  type: string
16275
15928
  referenceType:
16276
15929
  $ref: '#/components/schemas/SyntheticsMobileTestsMobileApplicationReferenceType'
15930
+ required:
15931
+ - applicationId
15932
+ - referenceId
15933
+ - referenceType
16277
15934
  type: object
16278
15935
  SyntheticsMobileTestsMobileApplicationReferenceType:
16279
15936
  description: Reference type for the mobile application for a mobile synthetics
@@ -16281,6 +15938,7 @@ components:
16281
15938
  enum:
16282
15939
  - latest
16283
15940
  - version
15941
+ example: latest
16284
15942
  type: string
16285
15943
  x-enum-varnames:
16286
15944
  - LATEST
@@ -16563,24 +16221,19 @@ components:
16563
16221
  description: Subject Alternative Name associated with the certificate.
16564
16222
  type: string
16565
16223
  type: object
16566
- SyntheticsStatus:
16567
- description: Determines whether or not the batch has passed, failed, or is in
16568
- progress.
16569
- enum:
16570
- - passed
16571
- - skipped
16572
- - failed
16573
- type: string
16574
- x-enum-varnames:
16575
- - PASSED
16576
- - skipped
16577
- - failed
16578
16224
  SyntheticsStep:
16579
16225
  description: The steps used in a Synthetic browser test.
16580
16226
  properties:
16581
16227
  allowFailure:
16582
16228
  description: A boolean set to allow this step to fail.
16583
16229
  type: boolean
16230
+ alwaysExecute:
16231
+ description: A boolean set to always execute this step even if the previous
16232
+ step failed or was skipped.
16233
+ type: boolean
16234
+ exitIfSucceed:
16235
+ description: A boolean set to exit the test if the step succeeds.
16236
+ type: boolean
16584
16237
  isCritical:
16585
16238
  description: A boolean to use in addition to `allowFailure` to determine
16586
16239
  if the test should be marked as failed when the step fails.
@@ -16589,7 +16242,7 @@ components:
16589
16242
  description: The name of the step.
16590
16243
  type: string
16591
16244
  noScreenshot:
16592
- description: A boolean set to not take a screenshot for the step.
16245
+ description: A boolean set to skip taking a screenshot for the step.
16593
16246
  type: boolean
16594
16247
  params:
16595
16248
  description: The parameters of the step.
@@ -16604,6 +16257,9 @@ components:
16604
16257
  SyntheticsStepDetail:
16605
16258
  description: Object describing a step for a Synthetic test.
16606
16259
  properties:
16260
+ allowFailure:
16261
+ description: Whether or not the step was allowed to fail.
16262
+ type: boolean
16607
16263
  browserErrors:
16608
16264
  description: Array of errors collected for a browser test.
16609
16265
  items:
@@ -16621,6 +16277,8 @@ components:
16621
16277
  error:
16622
16278
  description: Error returned by the test.
16623
16279
  type: string
16280
+ failure:
16281
+ $ref: '#/components/schemas/SyntheticsBrowserTestResultFailure'
16624
16282
  playingTab:
16625
16283
  $ref: '#/components/schemas/SyntheticsPlayingTab'
16626
16284
  screenshotBucketKey:
@@ -16749,6 +16407,8 @@ components:
16749
16407
  properties:
16750
16408
  executionRule:
16751
16409
  $ref: '#/components/schemas/SyntheticsTestExecutionRule'
16410
+ required:
16411
+ - executionRule
16752
16412
  type: object
16753
16413
  SyntheticsTestConfig:
16754
16414
  description: Configuration object for a Synthetic test.
@@ -16855,10 +16515,12 @@ components:
16855
16515
  enum:
16856
16516
  - api
16857
16517
  - browser
16518
+ - mobile
16858
16519
  type: string
16859
16520
  x-enum-varnames:
16860
16521
  - API
16861
16522
  - BROWSER
16523
+ - MOBILE
16862
16524
  SyntheticsTestExecutionRule:
16863
16525
  description: Execution rule for a Synthetic test.
16864
16526
  enum:
@@ -17008,6 +16670,11 @@ components:
17008
16670
 
17009
16671
  (for example, renotification).'
17010
16672
  properties:
16673
+ escalation_message:
16674
+ description: Message to include in the escalation notification.
16675
+ type: string
16676
+ notification_preset_name:
16677
+ $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName'
17011
16678
  renotify_interval:
17012
16679
  description: 'Time interval before renotifying if the test is still failing
17013
16680
 
@@ -17015,7 +16682,24 @@ components:
17015
16682
  format: int64
17016
16683
  minimum: 0
17017
16684
  type: integer
16685
+ renotify_occurrences:
16686
+ description: The number of times to renotify if the test is still failing.
16687
+ format: int64
16688
+ type: integer
17018
16689
  type: object
16690
+ SyntheticsTestOptionsMonitorOptionsNotificationPresetName:
16691
+ description: The name of the preset for the notification for the monitor.
16692
+ enum:
16693
+ - show_all
16694
+ - hide_all
16695
+ - hide_query
16696
+ - hide_handles
16697
+ type: string
16698
+ x-enum-varnames:
16699
+ - SHOW_ALL
16700
+ - HIDE_ALL
16701
+ - HIDE_QUERY
16702
+ - HIDE_HANDLES
17019
16703
  SyntheticsTestOptionsRetry:
17020
16704
  description: Object describing the retry strategy to apply to a Synthetic test.
17021
16705
  properties:
@@ -17054,6 +16738,9 @@ components:
17054
16738
  description: Timezone in which the timeframe is based.
17055
16739
  example: America/New_York
17056
16740
  type: string
16741
+ required:
16742
+ - timeframes
16743
+ - timezone
17057
16744
  type: object
17058
16745
  SyntheticsTestOptionsSchedulingTimeframe:
17059
16746
  description: Object describing a timeframe.
@@ -17073,6 +16760,10 @@ components:
17073
16760
  description: The hour of the day on which scheduling ends.
17074
16761
  example: '16:00'
17075
16762
  type: string
16763
+ required:
16764
+ - day
16765
+ - from
16766
+ - to
17076
16767
  type: object
17077
16768
  SyntheticsTestPauseStatus:
17078
16769
  description: 'Define whether you want to start (`live`) or pause (`paused`)
@@ -17309,6 +17000,30 @@ components:
17309
17000
  description: String Port number to use when performing the test. Supports templated
17310
17001
  variables.
17311
17002
  type: string
17003
+ SyntheticsTestRestrictionPolicyBinding:
17004
+ description: Objects describing the binding used for a mobile test.
17005
+ properties:
17006
+ principals:
17007
+ $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBindingPrincipals'
17008
+ relation:
17009
+ $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBindingRelation'
17010
+ type: object
17011
+ SyntheticsTestRestrictionPolicyBindingPrincipals:
17012
+ description: List of principals for a mobile test binding.
17013
+ items:
17014
+ description: A principal for a mobile test binding.
17015
+ maxLength: 1500
17016
+ type: string
17017
+ type: array
17018
+ SyntheticsTestRestrictionPolicyBindingRelation:
17019
+ description: The type of relation for the binding.
17020
+ enum:
17021
+ - editor
17022
+ - viewer
17023
+ type: string
17024
+ x-enum-varnames:
17025
+ - EDITOR
17026
+ - VIEWER
17312
17027
  SyntheticsTestUptime:
17313
17028
  description: Object containing the uptime for a Synthetic test ID.
17314
17029
  properties:
@@ -18188,7 +17903,6 @@ components:
18188
17903
  $ref: '#/components/schemas/ToplistWidgetStackedType'
18189
17904
  required:
18190
17905
  - type
18191
- - legend
18192
17906
  type: object
18193
17907
  ToplistWidgetStackedType:
18194
17908
  default: stacked
@@ -20062,6 +19776,16 @@ components:
20062
19776
  events over all hours in the current date for the given org.
20063
19777
  format: int64
20064
19778
  type: integer
19779
+ code_analysis_sa_committers_hwm:
19780
+ description: Shows the high-water mark of all Static Analysis committers
19781
+ over all hours in the current date for the given org.
19782
+ format: int64
19783
+ type: integer
19784
+ code_analysis_sca_committers_hwm:
19785
+ description: Shows the high-water mark of all static Software Composition
19786
+ Analysis committers over all hours in the current date for the given org.
19787
+ format: int64
19788
+ type: integer
20065
19789
  container_avg:
20066
19790
  description: Shows the average of all distinct containers over all hours
20067
19791
  in the current date for all organizations.
@@ -20802,6 +20526,16 @@ components:
20802
20526
  events over all hours in the current date for the given org.
20803
20527
  format: int64
20804
20528
  type: integer
20529
+ code_analysis_sa_committers_hwm:
20530
+ description: Shows the high-water mark of all Static Analysis committers
20531
+ over all hours in the current date for the given org.
20532
+ format: int64
20533
+ type: integer
20534
+ code_analysis_sca_committers_hwm:
20535
+ description: Shows the high-water mark of all static Software Composition
20536
+ Analysis committers over all hours in the current date for the given org.
20537
+ format: int64
20538
+ type: integer
20805
20539
  container_avg:
20806
20540
  description: Shows the average of all distinct containers over all hours
20807
20541
  in the current date for the given org.
@@ -21553,6 +21287,16 @@ components:
21553
21287
  events over all hours in the current month for all organizations.
21554
21288
  format: int64
21555
21289
  type: integer
21290
+ code_analysis_sa_committers_hwm_sum:
21291
+ description: Shows the high-water mark of all Static Analysis committers
21292
+ over all hours in the current month for all organizations.
21293
+ format: int64
21294
+ type: integer
21295
+ code_analysis_sca_committers_hwm_sum:
21296
+ description: Shows the high-water mark of all static Software Composition
21297
+ Analysis committers over all hours in the current month for all organizations.
21298
+ format: int64
21299
+ type: integer
21556
21300
  container_avg_sum:
21557
21301
  description: Shows the average of all distinct containers over all hours
21558
21302
  in the current month for all organizations.
@@ -23544,6 +23288,7 @@ components:
23544
23288
  incident_notification_settings_write: Configure Incidents Notification
23545
23289
  settings.
23546
23290
  incident_read: View incidents in Datadog.
23291
+ incident_settings_read: View Incident Settings.
23547
23292
  incident_settings_write: Configure Incident Settings.
23548
23293
  incident_write: Create, view, and manage incidents in Datadog.
23549
23294
  metrics_read: View custom metrics.
@@ -28968,6 +28713,8 @@ paths:
28968
28713
 
28969
28714
  - network-performance: `network-performance alert`
28970
28715
 
28716
+ - cloud cost: `cost alert`
28717
+
28971
28718
 
28972
28719
  **Notes**:
28973
28720
 
@@ -29238,21 +28985,27 @@ paths:
29238
28985
  ##### Error Tracking Alert Query
29239
28986
 
29240
28987
 
29241
- Example(RUM): `error-tracking-rum(query).rollup(rollup_method[, measure]).last(time_window)
29242
- operator #`
28988
+ "New issue" example: `error-tracking(query).source(issue_source).new().rollup(rollup_method[,
28989
+ measure]).by(group_by).last(time_window) operator #`
29243
28990
 
29244
- Example(APM Traces): `error-tracking-traces(query).rollup(rollup_method[,
29245
- measure]).last(time_window) operator #`
28991
+ "High impact issue" example: `error-tracking(query).source(issue_source).impact().rollup(rollup_method[,
28992
+ measure]).by(group_by).last(time_window) operator #`
29246
28993
 
29247
28994
 
29248
28995
  - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
29249
28996
 
28997
+ - `issue_source` The issue source - supports `all`, `browser`, `mobile` and
28998
+ `backend` and defaults to `all` if omitted.
28999
+
29250
29000
  - `rollup_method` The stats roll-up method - supports `count`, `avg`, and
29251
- `cardinality`.
29001
+ `cardinality` and defaults to `count` if omitted.
29252
29002
 
29253
29003
  - `measure` For `avg` and cardinality `rollup_method` - specify the measure
29254
29004
  or the facet name you want to use.
29255
29005
 
29006
+ - `group by` Comma-separated list of attributes to group by - should contain
29007
+ at least `issue.id`.
29008
+
29256
29009
  - `time_window` #m (between 1 and 2880), #h (between 1 and 48).
29257
29010
 
29258
29011
  - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
@@ -32853,6 +32606,10 @@ paths:
32853
32606
  tags:
32854
32607
  - Synthetics
32855
32608
  x-codegen-request-body-name: body
32609
+ x-permission:
32610
+ operator: OR
32611
+ permissions:
32612
+ - synthetics_write
32856
32613
  /api/v1/synthetics/tests/mobile/{public_id}:
32857
32614
  get:
32858
32615
  description: 'Get the detailed configuration associated with
@@ -32897,6 +32654,10 @@ paths:
32897
32654
  summary: Get a Mobile test
32898
32655
  tags:
32899
32656
  - Synthetics
32657
+ x-permission:
32658
+ operator: OR
32659
+ permissions:
32660
+ - synthetics_read
32900
32661
  put:
32901
32662
  description: Edit the configuration of a Synthetic Mobile test.
32902
32663
  operationId: UpdateMobileTest
@@ -32956,6 +32717,10 @@ paths:
32956
32717
  tags:
32957
32718
  - Synthetics
32958
32719
  x-codegen-request-body-name: body
32720
+ x-permission:
32721
+ operator: OR
32722
+ permissions:
32723
+ - synthetics_write
32959
32724
  /api/v1/synthetics/tests/trigger:
32960
32725
  post:
32961
32726
  description: Trigger a set of Synthetic tests.
@@ -33077,6 +32842,10 @@ paths:
33077
32842
  tags:
33078
32843
  - Synthetics
33079
32844
  x-codegen-request-body-name: body
32845
+ x-permission:
32846
+ operator: OR
32847
+ permissions:
32848
+ - synthetics_read
33080
32849
  /api/v1/synthetics/tests/{public_id}:
33081
32850
  get:
33082
32851
  description: Get the detailed configuration associated with a Synthetic test.