instana-client 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

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 (586) hide show
  1. instana_client/__init__.py +1754 -514
  2. instana_client/api/__init__.py +85 -1
  3. instana_client/api/action_catalog_api.py +329 -6
  4. instana_client/api/action_history_api.py +54 -2
  5. instana_client/api/ai_management_api.py +1973 -0
  6. instana_client/api/apdex_report_api.py +2 -2
  7. instana_client/api/apdex_settings_api.py +8 -9
  8. instana_client/api/api_token_api.py +17 -17
  9. instana_client/api/application_alert_configuration_api.py +79 -66
  10. instana_client/api/application_analyze_api.py +20 -282
  11. instana_client/api/application_catalog_api.py +11 -11
  12. instana_client/api/application_metrics_api.py +14 -14
  13. instana_client/api/application_resources_api.py +21 -21
  14. instana_client/api/application_settings_api.py +134 -104
  15. instana_client/api/application_topology_api.py +11 -2
  16. instana_client/api/audit_log_api.py +2 -2
  17. instana_client/api/authentication_api.py +2 -2
  18. instana_client/api/business_monitoring_api.py +2 -2
  19. instana_client/api/custom_dashboards_api.py +29 -19
  20. instana_client/api/custom_entities_api.py +1673 -0
  21. instana_client/api/end_user_monitoring_api.py +310 -0
  22. instana_client/api/event_settings_api.py +1251 -653
  23. instana_client/api/events_api.py +11 -26
  24. instana_client/api/global_application_alert_configuration_api.py +53 -56
  25. instana_client/api/groups_api.py +1121 -62
  26. instana_client/api/health_api.py +8 -5
  27. instana_client/api/host_agent_api.py +274 -8
  28. instana_client/api/infrastructure_alert_configuration_api.py +2 -2
  29. instana_client/api/infrastructure_analyze_api.py +14 -14
  30. instana_client/api/infrastructure_catalog_api.py +44 -13
  31. instana_client/api/infrastructure_metrics_api.py +5 -5
  32. instana_client/api/infrastructure_resources_api.py +11 -11
  33. instana_client/api/infrastructure_topology_api.py +2 -2
  34. instana_client/api/log_alert_configuration_api.py +44 -30
  35. instana_client/api/logging_analyze_api.py +343 -0
  36. instana_client/api/maintenance_configuration_api.py +32 -20
  37. instana_client/api/mobile_app_analyze_api.py +2 -2
  38. instana_client/api/mobile_app_catalog_api.py +8 -2
  39. instana_client/api/mobile_app_configuration_api.py +3058 -334
  40. instana_client/api/mobile_app_metrics_api.py +3 -6
  41. instana_client/api/policies_api.py +14 -11
  42. instana_client/api/releases_api.py +8 -11
  43. instana_client/api/roles_api.py +1394 -0
  44. instana_client/api/service_levels_alert_configuration_api.py +2 -2
  45. instana_client/api/service_levels_objective_slo_configurations_api.py +160 -89
  46. instana_client/api/service_levels_objective_slo_report_api.py +38 -2
  47. instana_client/api/session_settings_api.py +2 -2
  48. instana_client/api/sli_report_api.py +2 -2
  49. instana_client/api/sli_settings_api.py +5 -8
  50. instana_client/api/slo_correction_configurations_api.py +1528 -0
  51. instana_client/api/slo_correction_windows_api.py +392 -0
  52. instana_client/api/synthetic_alert_configuration_api.py +53 -56
  53. instana_client/api/synthetic_calls_api.py +20 -9
  54. instana_client/api/synthetic_catalog_api.py +20 -2
  55. instana_client/api/synthetic_metrics_api.py +5 -5
  56. instana_client/api/synthetic_settings_api.py +1238 -369
  57. instana_client/api/synthetic_test_playback_results_api.py +307 -20
  58. instana_client/api/teams_api.py +1380 -0
  59. instana_client/api/usage_api.py +2 -2
  60. instana_client/api/user_api.py +302 -28
  61. instana_client/api/website_analyze_api.py +8 -8
  62. instana_client/api/website_catalog_api.py +11 -8
  63. instana_client/api/website_configuration_api.py +1801 -336
  64. instana_client/api/website_metrics_api.py +3 -3
  65. instana_client/api_client.py +11 -4
  66. instana_client/configuration.py +14 -7
  67. instana_client/exceptions.py +2 -2
  68. instana_client/models/__init__.py +585 -9
  69. instana_client/models/abstract_integration.py +11 -5
  70. instana_client/models/abstract_rule.py +2 -2
  71. instana_client/models/access_log_entry.py +12 -7
  72. instana_client/models/access_log_response.py +2 -2
  73. instana_client/models/access_rule.py +2 -2
  74. instana_client/models/action.py +2 -2
  75. instana_client/models/action_configuration.py +2 -2
  76. instana_client/models/action_instance.py +2 -2
  77. instana_client/models/action_instance_metadata_entry.py +2 -2
  78. instana_client/models/action_instance_parameter.py +2 -2
  79. instana_client/models/action_instance_request.py +2 -2
  80. instana_client/models/action_instance_request_parameters.py +2 -2
  81. instana_client/models/action_match.py +19 -6
  82. instana_client/models/action_search_space.py +2 -2
  83. instana_client/models/adaptive_baseline.py +3 -3
  84. instana_client/models/adaptive_threshold_rule.py +3 -3
  85. instana_client/models/addition.py +97 -0
  86. instana_client/models/adjusted_timeframe.py +2 -2
  87. instana_client/models/agent_configuration_update.py +2 -2
  88. instana_client/models/alerting_configuration.py +2 -2
  89. instana_client/models/alerting_configuration_with_last_updated.py +2 -2
  90. instana_client/models/alerting_time_window.py +2 -2
  91. instana_client/models/apdex_configuration.py +2 -2
  92. instana_client/models/apdex_configuration_input.py +2 -2
  93. instana_client/models/apdex_entity.py +2 -2
  94. instana_client/models/apdex_report.py +2 -2
  95. instana_client/models/api_create_group.py +2 -2
  96. instana_client/models/api_create_role.py +101 -0
  97. instana_client/models/api_group.py +2 -2
  98. instana_client/models/api_member.py +5 -3
  99. instana_client/models/api_permission_set.py +12 -3
  100. instana_client/models/api_restricted_application_filter.py +2 -2
  101. instana_client/models/api_role.py +102 -0
  102. instana_client/models/api_tag.py +91 -0
  103. instana_client/models/api_team.py +113 -0
  104. instana_client/models/api_team_info.py +89 -0
  105. instana_client/models/api_team_member.py +102 -0
  106. instana_client/models/api_team_role.py +92 -0
  107. instana_client/models/api_team_scope.py +131 -0
  108. instana_client/models/api_token.py +29 -5
  109. instana_client/models/app_data_metric_configuration.py +2 -2
  110. instana_client/models/application.py +2 -2
  111. instana_client/models/application_alert_config.py +2 -2
  112. instana_client/models/application_alert_config_with_metadata.py +2 -2
  113. instana_client/models/application_alert_rule.py +2 -2
  114. instana_client/models/application_apdex_entity.py +2 -2
  115. instana_client/models/application_config.py +2 -2
  116. instana_client/models/application_event_result.py +5 -7
  117. instana_client/models/application_item.py +2 -2
  118. instana_client/models/application_metric_result.py +2 -2
  119. instana_client/models/application_node.py +2 -2
  120. instana_client/models/application_result.py +2 -2
  121. instana_client/models/application_scope.py +4 -4
  122. instana_client/models/application_scope_with_metadata.py +6 -6
  123. instana_client/models/application_sli_entity.py +2 -2
  124. instana_client/models/application_slo_entity.py +2 -2
  125. instana_client/models/application_time_threshold.py +2 -2
  126. instana_client/models/arithmetic_configuration.py +121 -0
  127. instana_client/models/arithmetic_operand.py +154 -0
  128. instana_client/models/arithmetic_operation.py +128 -0
  129. instana_client/models/audit_log_entry.py +2 -2
  130. instana_client/models/audit_log_ui_response.py +2 -2
  131. instana_client/models/author.py +2 -2
  132. instana_client/models/availability_blueprint_indicator.py +5 -16
  133. instana_client/models/availability_sli_entity.py +2 -2
  134. instana_client/models/available_metrics.py +2 -2
  135. instana_client/models/available_plugins.py +2 -2
  136. instana_client/models/backend_trace_reference.py +2 -2
  137. instana_client/models/bidirectional_ms_teams_app_integration.py +108 -0
  138. instana_client/models/bidirectional_slack_app_integration.py +102 -0
  139. instana_client/models/binary_operator_dto.py +2 -2
  140. instana_client/models/browser_script_configuration.py +5 -3
  141. instana_client/models/built_in_event_specification.py +2 -2
  142. instana_client/models/built_in_event_specification_with_last_updated.py +2 -2
  143. instana_client/models/business_activity.py +5 -3
  144. instana_client/models/business_perspective_config.py +2 -2
  145. instana_client/models/call_groups_item.py +2 -2
  146. instana_client/models/call_groups_result.py +2 -2
  147. instana_client/models/call_relation.py +2 -2
  148. instana_client/models/change_summary.py +2 -2
  149. instana_client/models/cloudfoundry_physical_context.py +4 -4
  150. instana_client/models/condition.py +2 -2
  151. instana_client/models/config_version.py +2 -2
  152. instana_client/models/correction.py +105 -0
  153. instana_client/models/correction_configuration.py +109 -0
  154. instana_client/models/correction_scheduling.py +104 -0
  155. instana_client/models/correction_window.py +95 -0
  156. instana_client/models/crash_mobile_app_alert_rule.py +2 -2
  157. instana_client/models/create_website_request_inner.py +90 -0
  158. instana_client/models/cursor_paginated_business_activity_item.py +2 -2
  159. instana_client/models/cursor_pagination.py +2 -2
  160. instana_client/models/cursor_pagination_infra_explore_cursor.py +2 -2
  161. instana_client/models/custom_blueprint_indicator.py +8 -4
  162. instana_client/models/custom_dashboard.py +2 -2
  163. instana_client/models/custom_dashboard_preview.py +2 -2
  164. instana_client/models/custom_dashboard_with_user_specific_information.py +115 -0
  165. instana_client/models/custom_dependency.py +116 -0
  166. instana_client/models/custom_email_subject_prefix.py +2 -2
  167. instana_client/models/custom_entity_model.py +126 -0
  168. instana_client/models/custom_entity_with_metadata.py +98 -0
  169. instana_client/models/custom_event_mobile_app_alert_rule.py +2 -2
  170. instana_client/models/custom_event_specification.py +9 -3
  171. instana_client/models/custom_event_specification_with_last_updated.py +9 -3
  172. instana_client/models/custom_event_website_alert_rule.py +2 -2
  173. instana_client/models/custom_metric.py +134 -0
  174. instana_client/models/custom_payload_configuration.py +2 -2
  175. instana_client/models/custom_payload_field.py +2 -2
  176. instana_client/models/custom_payload_with_last_updated.py +2 -2
  177. instana_client/models/custom_payload_with_version.py +101 -0
  178. instana_client/models/dashboard_api_token.py +2 -2
  179. instana_client/models/database_integration.py +2 -2
  180. instana_client/models/deprecated_tag_filter.py +4 -4
  181. instana_client/models/division.py +97 -0
  182. instana_client/models/dns_configuration.py +146 -0
  183. instana_client/models/dns_filter_query_time.py +99 -0
  184. instana_client/models/dns_filter_target_value.py +106 -0
  185. instana_client/models/duration.py +2 -2
  186. instana_client/models/dynamic_field.py +2 -2
  187. instana_client/models/dynamic_field_value.py +2 -2
  188. instana_client/models/dynamic_parameter.py +2 -2
  189. instana_client/models/edit_user.py +2 -2
  190. instana_client/models/email_integration.py +2 -2
  191. instana_client/models/empty_configuration.py +2 -2
  192. instana_client/models/endpoint.py +4 -4
  193. instana_client/models/endpoint_config.py +2 -2
  194. instana_client/models/endpoint_event_result.py +7 -9
  195. instana_client/models/endpoint_item.py +2 -2
  196. instana_client/models/endpoint_metric_result.py +2 -2
  197. instana_client/models/endpoint_node.py +2 -2
  198. instana_client/models/endpoint_result.py +3 -3
  199. instana_client/models/endpoint_simple.py +3 -3
  200. instana_client/models/entity_count_rule.py +2 -2
  201. instana_client/models/entity_count_verification_rule.py +3 -3
  202. instana_client/models/entity_health_info.py +2 -2
  203. instana_client/models/entity_id.py +2 -2
  204. instana_client/models/entity_verification_rule.py +3 -3
  205. instana_client/models/error_budget_alert_rule.py +5 -5
  206. instana_client/models/errors_application_alert_rule.py +2 -2
  207. instana_client/models/event.py +7 -3
  208. instana_client/models/event_filtering_configuration.py +2 -2
  209. instana_client/models/event_result.py +2 -2
  210. instana_client/models/event_specification_info.py +2 -2
  211. instana_client/models/extended_service.py +2 -2
  212. instana_client/models/failure_synthetic_alert_rule.py +2 -2
  213. instana_client/models/fixed_http_path_segment_matching_rule.py +2 -2
  214. instana_client/models/fixed_time_window.py +4 -3
  215. instana_client/models/generic_infra_alert_rule.py +12 -4
  216. instana_client/models/geo_location_configuration.py +2 -2
  217. instana_client/models/geo_mapping_rule.py +2 -2
  218. instana_client/models/geo_subdivision.py +2 -2
  219. instana_client/models/get_activities.py +2 -2
  220. instana_client/models/get_application_metrics.py +2 -2
  221. instana_client/models/get_applications.py +2 -2
  222. instana_client/models/get_available_metrics_query.py +2 -2
  223. instana_client/models/get_available_plugins_query.py +2 -2
  224. instana_client/models/get_call_groups.py +2 -2
  225. instana_client/models/get_combined_metrics.py +2 -2
  226. instana_client/models/get_dynamic_parameter_values.py +2 -2
  227. instana_client/models/get_endpoints.py +2 -2
  228. instana_client/models/get_infrastructure_groups_query.py +2 -2
  229. instana_client/models/get_infrastructure_query.py +2 -2
  230. instana_client/models/get_metrics_result.py +2 -2
  231. instana_client/models/get_mobile_app_beacon_groups.py +2 -2
  232. instana_client/models/get_mobile_app_beacons.py +2 -2
  233. instana_client/models/get_mobile_app_metrics.py +2 -2
  234. instana_client/models/get_mobile_app_metrics_v2.py +2 -2
  235. instana_client/models/get_payload_keys_result.py +2 -2
  236. instana_client/models/get_services.py +2 -2
  237. instana_client/models/get_snapshots_query.py +2 -2
  238. instana_client/models/get_test_result.py +2 -2
  239. instana_client/models/get_test_result_analytic.py +126 -0
  240. instana_client/models/get_test_result_base.py +2 -2
  241. instana_client/models/get_test_result_list.py +2 -2
  242. instana_client/models/get_test_summary_result.py +2 -2
  243. instana_client/models/get_trace_download_result_item.py +3 -3
  244. instana_client/models/get_trace_groups.py +2 -2
  245. instana_client/models/get_traces.py +4 -4
  246. instana_client/models/get_website_beacon_groups.py +2 -2
  247. instana_client/models/get_website_beacons.py +2 -2
  248. instana_client/models/get_website_metrics.py +2 -2
  249. instana_client/models/get_website_metrics_v2.py +2 -2
  250. instana_client/models/global_application_alert_config_with_metadata.py +2 -2
  251. instana_client/models/global_applications_alert_config.py +2 -2
  252. instana_client/models/google_chat_integration.py +2 -2
  253. instana_client/models/graph_edge.py +2 -2
  254. instana_client/models/graph_node.py +2 -2
  255. instana_client/models/group.py +2 -2
  256. instana_client/models/group_by_tag.py +2 -2
  257. instana_client/models/group_mapping.py +5 -3
  258. instana_client/models/group_mapping_overview.py +96 -0
  259. instana_client/models/health_state.py +2 -2
  260. instana_client/models/historic_baseline.py +3 -3
  261. instana_client/models/host_availability_rule.py +2 -2
  262. instana_client/models/http_action_configuration.py +2 -2
  263. instana_client/models/http_endpoint_config.py +2 -2
  264. instana_client/models/http_endpoint_rule.py +2 -2
  265. instana_client/models/http_path_segment_matching_rule.py +2 -2
  266. instana_client/models/http_script_configuration.py +5 -3
  267. instana_client/models/hyper_param.py +2 -2
  268. instana_client/models/identity_provider_patch.py +2 -2
  269. instana_client/models/impacted_beacon_info.py +96 -0
  270. instana_client/models/infra_alert_config.py +8 -6
  271. instana_client/models/infra_alert_config_with_metadata.py +7 -5
  272. instana_client/models/infra_alert_rule.py +9 -3
  273. instana_client/models/infra_event_result.py +6 -8
  274. instana_client/models/infra_metric_configuration.py +103 -80
  275. instana_client/models/infra_slo_entity.py +95 -0
  276. instana_client/models/infra_time_threshold.py +2 -2
  277. instana_client/models/infrastructure_entities_result.py +2 -2
  278. instana_client/models/infrastructure_group.py +5 -3
  279. instana_client/models/infrastructure_groups_result.py +2 -2
  280. instana_client/models/infrastructure_item.py +2 -2
  281. instana_client/models/infrastructure_metric_result.py +2 -2
  282. instana_client/models/instana_version_info.py +2 -2
  283. instana_client/models/integration_overview.py +14 -4
  284. instana_client/models/invitation.py +2 -2
  285. instana_client/models/invitation_response.py +2 -2
  286. instana_client/models/invitation_result.py +2 -2
  287. instana_client/models/ip_masking_configuration.py +2 -2
  288. instana_client/models/js_stack_trace_line.py +2 -2
  289. instana_client/models/kubernetes_physical_context.py +3 -3
  290. instana_client/models/latency_blueprint_indicator.py +5 -16
  291. instana_client/models/llm_egress_gateway.py +125 -0
  292. instana_client/models/location_status.py +2 -2
  293. instana_client/models/log_alert_config.py +8 -6
  294. instana_client/models/log_alert_config_with_metadata.py +8 -6
  295. instana_client/models/log_alert_rule.py +2 -2
  296. instana_client/models/log_count_alert_rule.py +2 -2
  297. instana_client/models/log_entry_actor.py +2 -2
  298. instana_client/models/log_event_result.py +5 -7
  299. instana_client/models/log_time_threshold.py +2 -2
  300. instana_client/models/log_volume_group.py +91 -0
  301. instana_client/models/log_volume_usage_item.py +101 -0
  302. instana_client/models/log_volume_usage_result.py +96 -0
  303. instana_client/models/logs_application_alert_rule.py +4 -4
  304. instana_client/models/maintenance_config.py +2 -2
  305. instana_client/models/maintenance_config_scheduling.py +2 -2
  306. instana_client/models/maintenance_config_v2.py +2 -2
  307. instana_client/models/maintenance_config_v2_with_state_and_occurrence.py +2 -2
  308. instana_client/models/maintenance_config_with_last_updated.py +2 -2
  309. instana_client/models/maintenance_window.py +2 -2
  310. instana_client/models/manual_alerting_channel_configuration.py +2 -2
  311. instana_client/models/manual_close_info.py +2 -2
  312. instana_client/models/manual_service_config.py +2 -2
  313. instana_client/models/match_all_http_path_segment_matching_rule.py +2 -2
  314. instana_client/models/match_expression_dto.py +3 -3
  315. instana_client/models/meta_data.py +2 -2
  316. instana_client/models/metric_api_result.py +2 -2
  317. instana_client/models/metric_config.py +2 -2
  318. instana_client/models/metric_configuration.py +3 -3
  319. instana_client/models/metric_description.py +2 -2
  320. instana_client/models/metric_instance.py +2 -2
  321. instana_client/models/metric_item.py +2 -2
  322. instana_client/models/metric_metadata.py +4 -4
  323. instana_client/models/metric_pattern.py +2 -2
  324. instana_client/models/metric_query.py +128 -0
  325. instana_client/models/metrics_result.py +2 -2
  326. instana_client/models/metrics_result_item.py +5 -3
  327. instana_client/models/metrics_test_result_item.py +2 -2
  328. instana_client/models/mobile_app.py +2 -2
  329. instana_client/models/mobile_app_alert_config.py +2 -2
  330. instana_client/models/mobile_app_alert_rule.py +8 -5
  331. instana_client/models/mobile_app_beacon_groups_item.py +2 -2
  332. instana_client/models/mobile_app_beacon_groups_result.py +2 -2
  333. instana_client/models/mobile_app_beacon_result.py +2 -2
  334. instana_client/models/mobile_app_beacon_tag_group.py +2 -2
  335. instana_client/models/mobile_app_beacons_item.py +11 -5
  336. instana_client/models/mobile_app_event_result.py +5 -7
  337. instana_client/models/mobile_app_metric_result.py +2 -2
  338. instana_client/models/mobile_app_monitoring_beacon.py +22 -4
  339. instana_client/models/mobile_app_monitoring_metric_description.py +5 -3
  340. instana_client/models/mobile_app_monitoring_metrics_configuration.py +2 -2
  341. instana_client/models/mobile_app_time_threshold.py +2 -2
  342. instana_client/models/model_field.py +2 -2
  343. instana_client/models/monitored_entities_stats.py +92 -0
  344. instana_client/models/monitoring_state.py +11 -3
  345. instana_client/models/multiple_scripts_configuration.py +2 -2
  346. instana_client/models/multiplication.py +97 -0
  347. instana_client/models/nested_operation.py +128 -0
  348. instana_client/models/new_application_config.py +2 -2
  349. instana_client/models/new_business_perspective_config.py +2 -2
  350. instana_client/models/new_manual_service_config.py +2 -2
  351. instana_client/models/o_auth_config.py +107 -0
  352. instana_client/models/o_auth_integration.py +98 -0
  353. instana_client/models/o_auth_token.py +121 -0
  354. instana_client/models/occurrence.py +2 -2
  355. instana_client/models/office365_integration.py +2 -2
  356. instana_client/models/one_time_maintenance_window.py +2 -2
  357. instana_client/models/opsgenie_integration.py +2 -2
  358. instana_client/models/order.py +2 -2
  359. instana_client/models/pagerduty_integration.py +2 -2
  360. instana_client/models/paginated_result.py +2 -2
  361. instana_client/models/pagination.py +2 -2
  362. instana_client/models/parameter.py +2 -2
  363. instana_client/models/parameter_value.py +2 -2
  364. instana_client/models/path_parameter_http_path_segment_matching_rule.py +2 -2
  365. instana_client/models/physical_context.py +3 -3
  366. instana_client/models/plugin_result.py +2 -2
  367. instana_client/models/policy.py +2 -2
  368. instana_client/models/policy_runnable.py +2 -2
  369. instana_client/models/policy_scheduling.py +91 -0
  370. instana_client/models/post_mobile_app_source_map_config_request.py +88 -0
  371. instana_client/models/post_snapshots_result.py +2 -2
  372. instana_client/models/problem.py +2 -2
  373. instana_client/models/prometheus_webhook_integration.py +2 -2
  374. instana_client/models/recurrent_maintenance_window.py +2 -2
  375. instana_client/models/release.py +6 -6
  376. instana_client/models/release_scope.py +2 -2
  377. instana_client/models/release_with_metadata.py +8 -8
  378. instana_client/models/retention_period.py +101 -0
  379. instana_client/models/rolling_time_window.py +4 -3
  380. instana_client/models/rule_input.py +2 -2
  381. instana_client/models/rule_with_threshold_application_alert_rule.py +2 -2
  382. instana_client/models/rule_with_threshold_infra_alert_rule.py +2 -2
  383. instana_client/models/rule_with_threshold_log_alert_rule.py +2 -2
  384. instana_client/models/rule_with_threshold_mobile_app_alert_rule.py +2 -2
  385. instana_client/models/rule_with_threshold_website_alert_rule.py +2 -2
  386. instana_client/models/run_configuration.py +2 -2
  387. instana_client/models/salesforce_integration.py +2 -2
  388. instana_client/models/saturation_blueprint_indicator.py +97 -0
  389. instana_client/models/scope_binding.py +2 -2
  390. instana_client/models/search_field_result.py +2 -2
  391. instana_client/models/service.py +3 -3
  392. instana_client/models/service_config.py +2 -2
  393. instana_client/models/service_event_result.py +5 -7
  394. instana_client/models/service_item.py +2 -2
  395. instana_client/models/service_level_indicator.py +10 -7
  396. instana_client/models/service_level_objective_alert_rule.py +2 -2
  397. instana_client/models/service_level_objective_configuration.py +3 -3
  398. instana_client/models/service_levels_alert_config.py +15 -5
  399. instana_client/models/service_levels_alert_rule.py +2 -2
  400. instana_client/models/service_levels_burn_rate_config.py +115 -0
  401. instana_client/models/service_levels_burn_rate_time_windows.py +2 -2
  402. instana_client/models/service_levels_static_threshold_config.py +100 -0
  403. instana_client/models/service_levels_time_threshold.py +5 -5
  404. instana_client/models/service_levelse_alert_config_with_metadata.py +15 -5
  405. instana_client/models/service_map.py +2 -2
  406. instana_client/models/service_map_connection.py +2 -2
  407. instana_client/models/service_matching_rule.py +2 -2
  408. instana_client/models/service_metric_result.py +2 -2
  409. instana_client/models/service_node.py +2 -2
  410. instana_client/models/service_now_enhanced_integration.py +2 -2
  411. instana_client/models/service_now_integration.py +2 -2
  412. instana_client/models/service_result.py +3 -3
  413. instana_client/models/service_scope.py +4 -4
  414. instana_client/models/service_scope_with_metadata.py +5 -5
  415. instana_client/models/service_scoped_to.py +3 -3
  416. instana_client/models/service_scoped_to_with_metadata.py +4 -4
  417. instana_client/models/service_simple.py +2 -2
  418. instana_client/models/session_settings.py +4 -4
  419. instana_client/models/simple_metric_configuration.py +121 -0
  420. instana_client/models/single_value.py +128 -0
  421. instana_client/models/slack_integration.py +2 -2
  422. instana_client/models/sli_configuration.py +2 -2
  423. instana_client/models/sli_configuration_with_last_updated.py +2 -2
  424. instana_client/models/sli_entity.py +2 -2
  425. instana_client/models/sli_report.py +2 -2
  426. instana_client/models/slo_config_with_rbac_tag.py +128 -0
  427. instana_client/models/slo_entity.py +8 -5
  428. instana_client/models/slo_report.py +2 -2
  429. instana_client/models/slowness_application_alert_rule.py +2 -2
  430. instana_client/models/slowness_mobile_app_alert_rule.py +90 -0
  431. instana_client/models/slowness_website_alert_rule.py +2 -2
  432. instana_client/models/snapshot_item.py +2 -2
  433. instana_client/models/snapshot_preview.py +7 -7
  434. instana_client/models/snapshot_result.py +2 -2
  435. instana_client/models/software_user.py +2 -2
  436. instana_client/models/software_version.py +2 -2
  437. instana_client/models/source_map_file_blob.py +2 -2
  438. instana_client/models/source_map_file_meta.py +2 -2
  439. instana_client/models/source_map_upload_config.py +2 -2
  440. instana_client/models/source_map_upload_configs.py +106 -0
  441. instana_client/models/span_excerpt.py +12 -12
  442. instana_client/models/span_relation.py +3 -3
  443. instana_client/models/specific_js_errors_website_alert_rule.py +4 -4
  444. instana_client/models/splunk_integration.py +2 -2
  445. instana_client/models/ssl_certificate_configuration.py +17 -5
  446. instana_client/models/ssl_certificate_validation.py +99 -0
  447. instana_client/models/stack_trace_item.py +7 -7
  448. instana_client/models/stack_trace_line.py +2 -2
  449. instana_client/models/static_baseline_threshold_rule.py +3 -3
  450. instana_client/models/static_string_field.py +2 -2
  451. instana_client/models/static_threshold.py +2 -2
  452. instana_client/models/static_threshold_rule.py +2 -2
  453. instana_client/models/status_code_application_alert_rule.py +2 -2
  454. instana_client/models/status_code_mobile_app_alert_rule.py +4 -4
  455. instana_client/models/status_code_website_alert_rule.py +4 -4
  456. instana_client/models/subtraction.py +97 -0
  457. instana_client/models/synthetic_alert_config.py +2 -2
  458. instana_client/models/synthetic_alert_config_with_metadata.py +2 -2
  459. instana_client/models/synthetic_alert_rule.py +2 -2
  460. instana_client/models/synthetic_call_config.py +4 -4
  461. instana_client/models/synthetic_call_rule.py +6 -6
  462. instana_client/models/synthetic_call_with_defaults_config.py +4 -4
  463. instana_client/models/synthetic_configuration.py +93 -0
  464. instana_client/models/synthetic_credential.py +23 -3
  465. instana_client/models/synthetic_datacenter.py +2 -2
  466. instana_client/models/synthetic_datacenter_configuration.py +2 -2
  467. instana_client/models/synthetic_geo_point.py +2 -2
  468. instana_client/models/synthetic_location.py +2 -2
  469. instana_client/models/synthetic_location_configuration.py +2 -2
  470. instana_client/models/synthetic_metric_configuration.py +2 -2
  471. instana_client/models/synthetic_metric_tag_group.py +2 -2
  472. instana_client/models/synthetic_playback_capabilities.py +17 -4
  473. instana_client/models/synthetic_slo_entity.py +7 -5
  474. instana_client/models/synthetic_test.py +27 -3
  475. instana_client/models/synthetic_test_cicd.py +96 -0
  476. instana_client/models/synthetic_test_cicd_customization.py +96 -0
  477. instana_client/models/synthetic_test_cicd_item.py +114 -0
  478. instana_client/models/synthetic_test_cicd_response.py +92 -0
  479. instana_client/models/synthetic_time_threshold.py +2 -2
  480. instana_client/models/synthetic_type_configuration.py +11 -11
  481. instana_client/models/synthetics_event_result.py +5 -7
  482. instana_client/models/system_rule.py +2 -2
  483. instana_client/models/system_rule_label.py +2 -2
  484. instana_client/models/tag.py +6 -6
  485. instana_client/models/tag_catalog.py +2 -2
  486. instana_client/models/tag_filter.py +4 -4
  487. instana_client/models/tag_filter_expression.py +2 -2
  488. instana_client/models/tag_filter_expression_element.py +2 -2
  489. instana_client/models/tag_matcher_dto.py +2 -2
  490. instana_client/models/tag_tree_level.py +2 -2
  491. instana_client/models/tag_tree_node.py +2 -2
  492. instana_client/models/tag_tree_tag.py +2 -2
  493. instana_client/models/test_common_properties.py +2 -2
  494. instana_client/models/test_last_error.py +90 -0
  495. instana_client/models/test_result.py +2 -2
  496. instana_client/models/test_result_common_properties.py +24 -3
  497. instana_client/models/test_result_detail_data.py +2 -2
  498. instana_client/models/test_result_item.py +2 -2
  499. instana_client/models/test_result_list_item.py +2 -2
  500. instana_client/models/test_result_list_result.py +2 -2
  501. instana_client/models/test_result_metadata.py +2 -2
  502. instana_client/models/test_result_subtransaction.py +2 -2
  503. instana_client/models/threshold.py +2 -2
  504. instana_client/models/threshold_config_rule.py +2 -2
  505. instana_client/models/threshold_rule.py +2 -2
  506. instana_client/models/throughput_application_alert_rule.py +2 -2
  507. instana_client/models/throughput_mobile_app_alert_rule.py +2 -2
  508. instana_client/models/throughput_website_alert_rule.py +2 -2
  509. instana_client/models/time_frame.py +2 -2
  510. instana_client/models/time_window.py +5 -4
  511. instana_client/models/topology.py +2 -2
  512. instana_client/models/trace.py +8 -8
  513. instana_client/models/trace_activity_tree_node_details.py +13 -13
  514. instana_client/models/trace_download_result.py +2 -2
  515. instana_client/models/trace_groups_item.py +2 -2
  516. instana_client/models/trace_groups_result.py +2 -2
  517. instana_client/models/trace_impact_application_time_threshold.py +2 -2
  518. instana_client/models/trace_item.py +2 -2
  519. instana_client/models/trace_result.py +2 -2
  520. instana_client/models/traffic_blueprint_indicator.py +3 -3
  521. instana_client/models/trigger.py +15 -7
  522. instana_client/models/type_configuration.py +2 -2
  523. instana_client/models/unsupported_http_path_segment_matching_rule.py +2 -2
  524. instana_client/models/updated_business_perspective_config.py +2 -2
  525. instana_client/models/usage_result.py +2 -2
  526. instana_client/models/usage_result_items.py +2 -2
  527. instana_client/models/user_basic_result.py +2 -2
  528. instana_client/models/user_impact_mobile_app_time_threshold.py +3 -3
  529. instana_client/models/user_impact_website_time_threshold.py +3 -3
  530. instana_client/models/user_result.py +2 -2
  531. instana_client/models/users_result.py +2 -2
  532. instana_client/models/validated_alerting_channel_input_info.py +4 -4
  533. instana_client/models/validated_alerting_configuration.py +2 -2
  534. instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py +2 -2
  535. instana_client/models/validated_maintenance_config_with_status.py +2 -2
  536. instana_client/models/victor_ops_integration.py +2 -2
  537. instana_client/models/violations_in_period_application_time_threshold.py +2 -2
  538. instana_client/models/violations_in_period_mobile_app_time_threshold.py +2 -2
  539. instana_client/models/violations_in_period_website_time_threshold.py +2 -2
  540. instana_client/models/violations_in_sequence_application_time_threshold.py +2 -2
  541. instana_client/models/violations_in_sequence_infra_time_threshold.py +2 -2
  542. instana_client/models/violations_in_sequence_log_time_threshold.py +2 -2
  543. instana_client/models/violations_in_sequence_mobile_app_time_threshold.py +2 -2
  544. instana_client/models/violations_in_sequence_synthetic_time_threshold.py +2 -2
  545. instana_client/models/violations_in_sequence_website_time_threshold.py +2 -2
  546. instana_client/models/watson_ai_ops_webhook_integration.py +2 -2
  547. instana_client/models/webex_teams_webhook_integration.py +2 -2
  548. instana_client/models/webhook_integration.py +14 -4
  549. instana_client/models/webpage_action_configuration.py +2 -2
  550. instana_client/models/webpage_script_configuration.py +5 -3
  551. instana_client/models/website.py +2 -2
  552. instana_client/models/website_alert_config.py +2 -2
  553. instana_client/models/website_alert_config_with_metadata.py +2 -2
  554. instana_client/models/website_alert_rule.py +2 -2
  555. instana_client/models/website_apdex_entity.py +2 -2
  556. instana_client/models/website_beacon_groups_item.py +2 -2
  557. instana_client/models/website_beacon_groups_result.py +2 -2
  558. instana_client/models/website_beacon_result.py +2 -2
  559. instana_client/models/website_beacon_tag_group.py +2 -2
  560. instana_client/models/website_beacons_item.py +11 -5
  561. instana_client/models/website_event_based_sli_entity.py +2 -2
  562. instana_client/models/website_event_result.py +4 -6
  563. instana_client/models/website_metric_result.py +2 -2
  564. instana_client/models/website_monitoring_beacon.py +7 -3
  565. instana_client/models/website_monitoring_metric_description.py +2 -2
  566. instana_client/models/website_monitoring_metrics_configuration.py +2 -2
  567. instana_client/models/website_slo_entity.py +2 -2
  568. instana_client/models/website_time_based_sli_entity.py +2 -2
  569. instana_client/models/website_time_threshold.py +2 -2
  570. instana_client/models/widget.py +2 -2
  571. instana_client/models/with_metadata.py +2 -2
  572. instana_client/models/with_resolved_name.py +2 -2
  573. instana_client/models/z_chat_ops_integration.py +2 -2
  574. instana_client/rest.py +3 -2
  575. instana_client-1.0.1.dist-info/METADATA +1068 -0
  576. instana_client-1.0.1.dist-info/RECORD +581 -0
  577. {instana_client-1.0.0.dist-info → instana_client-1.0.1.dist-info}/WHEEL +1 -1
  578. instana_client/models/dns_action_configuration.py +0 -134
  579. instana_client/models/dns_action_filter_query_time.py +0 -99
  580. instana_client/models/dns_action_filter_target_value.py +0 -106
  581. instana_client/models/full_trace.py +0 -97
  582. instana_client/models/span.py +0 -156
  583. instana_client-1.0.0.dist-info/METADATA +0 -25
  584. instana_client-1.0.0.dist-info/RECORD +0 -515
  585. {instana_client-1.0.0.dist-info → instana_client-1.0.1.dist-info}/licenses/LICENSE +0 -0
  586. {instana_client-1.0.0.dist-info → instana_client-1.0.1.dist-info}/top_level.txt +0 -0
@@ -3,9 +3,9 @@
3
3
  """
4
4
  Instana REST API documentation
5
5
 
6
- Searching for answers and best pratices? Check our [IBM Instana Community](https://community.ibm.com/community/user/aiops/communities/community-home?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f). ## Overview The Instana REST API provides programmatic access to the Instana platform. It can be used to retrieve data available through the Instana UI Dashboard -- metrics, events, traces, etc -- and also to automate configuration tasks such as user management. ### Navigating the API documentation The API endpoints are grouped by product area and functionality. This generally maps to how our UI Dashboard is organized, hopefully making it easier to locate which endpoints you'd use to fetch the data you see visualized in our UI. The [UI sections](https://www.ibm.com/docs/en/instana-observability/current?topic=working-user-interface#navigation-menu) include: - Websites & Mobile Apps - Applications - Infrastructure - Synthetic Monitoring - Events - Automation - Service Levels - Settings - etc ### Rate Limiting A rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server. - **X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour. - **X-RateLimit-Remaining:** How many calls may still be executed within the current hour. - **X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00. ### Further Reading We provide additional documentation for our REST API in our [product documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api). Here you'll also find some common queries for retrieving data and configuring Instana. ## Getting Started with the REST API ### API base URL The base URL for an specific instance of Instana can be determined using the tenant and unit information. - `base`: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface. - `apiToken`: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself. ### Curl Example Here is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call. ```bash curl --request GET \\ --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\ --header 'authorization: apiToken xxxxxxxxxxxxxxxx' ``` Next we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example. ```bash curl --request POST \\ --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\ --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\ --header 'content-type: application/json' \\ --data '{ \"group\":{ \"groupbyTag\":\"endpoint.name\" }, \"tagFilters\":[ { \"name\":\"call.error.count\", \"value\":\"0\", \"operator\":\"GREATER_THAN\" } ], \"metrics\":[ { \"metric\":\"errors\", \"aggregation\":\"MEAN\" } ] }' ``` ### Generating REST API clients The API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format. You can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml). OpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made. To generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator). #### Go For example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit: ```bash #!/bin/bash ### This script assumes you have the `java` and `wget` commands on the path export UNIT_NAME='myunit' # for example: prod export TENANT_NAME='mytenant' # for example: awesomecompany //Download the generator to your current working directory: wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\" //generate a client library that you can vendor into your repository java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\ -o pkg/instana/openapi \\ --skip-validate-spec //(optional) format the Go code according to the Go code standard gofmt -s -w pkg/instana/openapi ``` The generated clients contain comprehensive READMEs, and you can start right away using the client from the example above: ```go import instana \"./pkg/instana/openapi\" // readTags will read all available application monitoring tags along with their type and category func readTags() { configuration := instana.NewConfiguration() configuration.Host = \"tenant-unit.instana.io\" configuration.BasePath = \"https://tenant-unit.instana.io\" client := instana.NewAPIClient(configuration) auth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{ Key: apiKey, Prefix: \"apiToken\", }) tags, _, err := client.ApplicationCatalogApi.GetApplicationTagCatalog(auth) if err != nil { fmt.Fatalf(\"Error calling the API, aborting.\") } for _, tag := range tags { fmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name) } } ``` #### Java Follow the instructions provided in the official documentation from [OpenAPI Tools](https://github.com/OpenAPITools) to download the [openapi-generator-cli.jar](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#13---download-jar). Depending on your environment, use one of the following java http client implementations which will create a valid client for our OpenAPI specification: ``` //Nativ Java HTTP Client java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8 --library native //Spring WebClient java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient //Spring RestTemplate java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate ```
6
+ Documentation for INSTANA REST API
7
7
 
8
- The version of the OpenAPI document: 1.291.1002
8
+ The version of the OpenAPI document: 1.306.1368
9
9
  Contact: support@instana.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -24,6 +24,9 @@ from instana_client.models.synthetic_credential import SyntheticCredential
24
24
  from instana_client.models.synthetic_datacenter import SyntheticDatacenter
25
25
  from instana_client.models.synthetic_location import SyntheticLocation
26
26
  from instana_client.models.synthetic_test import SyntheticTest
27
+ from instana_client.models.synthetic_test_cicd import SyntheticTestCICD
28
+ from instana_client.models.synthetic_test_cicd_item import SyntheticTestCICDItem
29
+ from instana_client.models.synthetic_test_cicd_response import SyntheticTestCICDResponse
27
30
 
28
31
  from instana_client.api_client import ApiClient, RequestSerialized
29
32
  from instana_client.api_response import ApiResponse
@@ -60,9 +63,9 @@ class SyntheticSettingsApi:
60
63
  _headers: Optional[Dict[StrictStr, Any]] = None,
61
64
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
62
65
  ) -> None:
63
- """Create a Synthetic Credential
66
+ """Create a Synthetic credential
64
67
 
65
- API request to create Synthetic Credentials.
68
+ API request to create a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
66
69
 
67
70
  :param synthetic_credential: (required)
68
71
  :type synthetic_credential: SyntheticCredential
@@ -130,9 +133,9 @@ class SyntheticSettingsApi:
130
133
  _headers: Optional[Dict[StrictStr, Any]] = None,
131
134
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
132
135
  ) -> ApiResponse[None]:
133
- """Create a Synthetic Credential
136
+ """Create a Synthetic credential
134
137
 
135
- API request to create Synthetic Credentials.
138
+ API request to create a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
136
139
 
137
140
  :param synthetic_credential: (required)
138
141
  :type synthetic_credential: SyntheticCredential
@@ -200,9 +203,9 @@ class SyntheticSettingsApi:
200
203
  _headers: Optional[Dict[StrictStr, Any]] = None,
201
204
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
202
205
  ) -> RESTResponseType:
203
- """Create a Synthetic Credential
206
+ """Create a Synthetic credential
204
207
 
205
- API request to create Synthetic Credentials.
208
+ API request to create a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
206
209
 
207
210
  :param synthetic_credential: (required)
208
211
  :type synthetic_credential: SyntheticCredential
@@ -345,7 +348,7 @@ class SyntheticSettingsApi:
345
348
  ) -> SyntheticTest:
346
349
  """Create a Synthetic test
347
350
 
348
- This API endpoint creates a Synthetic Test. **Note:** The **DNSAction** Synthetic type is not supported. ## Optional Parameters: - **id** Users are allowed to specify their own id for the test. A test id can contain letters, numbers, underscores, colons and hyphens. Maximum length is 128. ## Sample script and payload: - A sample script to create an API Simple test ``` curl -k -v -X POST \\ https://<Host>/api/synthetics/settings/tests \\ -H 'authorization: apiToken <Token>' \\ -H 'content-type: application/json' \\ -d '{ \"id\":\"test_id:12134-89\", \"label\":\"Test_SimplePing\", \"description\":\"this is to test a simple ping API\", \"serviceId\":\"serviceId001\", \"applicationId\":\"applicationId001\", \"active\":true, \"testFrequency\":1, \"playbackMode\":\"Simultaneous\", \"locations\":[ \"saas_instana_test\" ], \"configuration\":{ \"syntheticType\":\"HTTPAction\", \"url\":\"https://httpbin.org/post\", \"operation\":\"POST\", \"headers\":{ \"Content-Type\":\"text/plain\" }, \"body\":\"Hello World!\", \"validationString\":\"Hello World!\" }, \"customProperties\":{ \"Team\":\"DevTeam\", \"Purpose\":\"Demo\" } }' ```
351
+ API request to create a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
349
352
 
350
353
  :param synthetic_test: (required)
351
354
  :type synthetic_test: SyntheticTest
@@ -380,7 +383,7 @@ class SyntheticSettingsApi:
380
383
  )
381
384
 
382
385
  _response_types_map: Dict[str, Optional[str]] = {
383
- '200': "SyntheticTest",
386
+ '201': "SyntheticTest",
384
387
  '401': None,
385
388
  '403': None,
386
389
  '500': None,
@@ -415,7 +418,7 @@ class SyntheticSettingsApi:
415
418
  ) -> ApiResponse[SyntheticTest]:
416
419
  """Create a Synthetic test
417
420
 
418
- This API endpoint creates a Synthetic Test. **Note:** The **DNSAction** Synthetic type is not supported. ## Optional Parameters: - **id** Users are allowed to specify their own id for the test. A test id can contain letters, numbers, underscores, colons and hyphens. Maximum length is 128. ## Sample script and payload: - A sample script to create an API Simple test ``` curl -k -v -X POST \\ https://<Host>/api/synthetics/settings/tests \\ -H 'authorization: apiToken <Token>' \\ -H 'content-type: application/json' \\ -d '{ \"id\":\"test_id:12134-89\", \"label\":\"Test_SimplePing\", \"description\":\"this is to test a simple ping API\", \"serviceId\":\"serviceId001\", \"applicationId\":\"applicationId001\", \"active\":true, \"testFrequency\":1, \"playbackMode\":\"Simultaneous\", \"locations\":[ \"saas_instana_test\" ], \"configuration\":{ \"syntheticType\":\"HTTPAction\", \"url\":\"https://httpbin.org/post\", \"operation\":\"POST\", \"headers\":{ \"Content-Type\":\"text/plain\" }, \"body\":\"Hello World!\", \"validationString\":\"Hello World!\" }, \"customProperties\":{ \"Team\":\"DevTeam\", \"Purpose\":\"Demo\" } }' ```
421
+ API request to create a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
419
422
 
420
423
  :param synthetic_test: (required)
421
424
  :type synthetic_test: SyntheticTest
@@ -450,7 +453,7 @@ class SyntheticSettingsApi:
450
453
  )
451
454
 
452
455
  _response_types_map: Dict[str, Optional[str]] = {
453
- '200': "SyntheticTest",
456
+ '201': "SyntheticTest",
454
457
  '401': None,
455
458
  '403': None,
456
459
  '500': None,
@@ -485,7 +488,7 @@ class SyntheticSettingsApi:
485
488
  ) -> RESTResponseType:
486
489
  """Create a Synthetic test
487
490
 
488
- This API endpoint creates a Synthetic Test. **Note:** The **DNSAction** Synthetic type is not supported. ## Optional Parameters: - **id** Users are allowed to specify their own id for the test. A test id can contain letters, numbers, underscores, colons and hyphens. Maximum length is 128. ## Sample script and payload: - A sample script to create an API Simple test ``` curl -k -v -X POST \\ https://<Host>/api/synthetics/settings/tests \\ -H 'authorization: apiToken <Token>' \\ -H 'content-type: application/json' \\ -d '{ \"id\":\"test_id:12134-89\", \"label\":\"Test_SimplePing\", \"description\":\"this is to test a simple ping API\", \"serviceId\":\"serviceId001\", \"applicationId\":\"applicationId001\", \"active\":true, \"testFrequency\":1, \"playbackMode\":\"Simultaneous\", \"locations\":[ \"saas_instana_test\" ], \"configuration\":{ \"syntheticType\":\"HTTPAction\", \"url\":\"https://httpbin.org/post\", \"operation\":\"POST\", \"headers\":{ \"Content-Type\":\"text/plain\" }, \"body\":\"Hello World!\", \"validationString\":\"Hello World!\" }, \"customProperties\":{ \"Team\":\"DevTeam\", \"Purpose\":\"Demo\" } }' ```
491
+ API request to create a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
489
492
 
490
493
  :param synthetic_test: (required)
491
494
  :type synthetic_test: SyntheticTest
@@ -520,7 +523,7 @@ class SyntheticSettingsApi:
520
523
  )
521
524
 
522
525
  _response_types_map: Dict[str, Optional[str]] = {
523
- '200': "SyntheticTest",
526
+ '201': "SyntheticTest",
524
527
  '401': None,
525
528
  '403': None,
526
529
  '500': None,
@@ -610,9 +613,9 @@ class SyntheticSettingsApi:
610
613
 
611
614
 
612
615
  @validate_call
613
- def delete_synthetic_credential(
616
+ def create_synthetic_test_cicd(
614
617
  self,
615
- name: Annotated[StrictStr, Field(description="Name of the credential to be deleted")],
618
+ synthetic_test_cicd: List[SyntheticTestCICD],
616
619
  _request_timeout: Union[
617
620
  None,
618
621
  Annotated[StrictFloat, Field(gt=0)],
@@ -625,13 +628,13 @@ class SyntheticSettingsApi:
625
628
  _content_type: Optional[StrictStr] = None,
626
629
  _headers: Optional[Dict[StrictStr, Any]] = None,
627
630
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
628
- ) -> None:
629
- """Delete Synthetic credential
631
+ ) -> List[SyntheticTestCICDResponse]:
632
+ """Create a Synthetic test CI/CD
630
633
 
631
- API request to delete a Synthetic Credential.
634
+ API request to create a Synthetic Test CI/CD. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
632
635
 
633
- :param name: Name of the credential to be deleted (required)
634
- :type name: str
636
+ :param synthetic_test_cicd: (required)
637
+ :type synthetic_test_cicd: List[SyntheticTestCICD]
635
638
  :param _request_timeout: timeout setting for this request. If one
636
639
  number provided, it will be total request
637
640
  timeout. It can also be a pair (tuple) of
@@ -654,8 +657,8 @@ class SyntheticSettingsApi:
654
657
  :return: Returns the result object.
655
658
  """ # noqa: E501
656
659
 
657
- _param = self._delete_synthetic_credential_serialize(
658
- name=name,
660
+ _param = self._create_synthetic_test_cicd_serialize(
661
+ synthetic_test_cicd=synthetic_test_cicd,
659
662
  _request_auth=_request_auth,
660
663
  _content_type=_content_type,
661
664
  _headers=_headers,
@@ -663,8 +666,7 @@ class SyntheticSettingsApi:
663
666
  )
664
667
 
665
668
  _response_types_map: Dict[str, Optional[str]] = {
666
- '200': None,
667
- '204': None,
669
+ '200': "List[SyntheticTestCICDResponse]",
668
670
  '401': None,
669
671
  '403': None,
670
672
  '500': None,
@@ -681,9 +683,9 @@ class SyntheticSettingsApi:
681
683
 
682
684
 
683
685
  @validate_call
684
- def delete_synthetic_credential_with_http_info(
686
+ def create_synthetic_test_cicd_with_http_info(
685
687
  self,
686
- name: Annotated[StrictStr, Field(description="Name of the credential to be deleted")],
688
+ synthetic_test_cicd: List[SyntheticTestCICD],
687
689
  _request_timeout: Union[
688
690
  None,
689
691
  Annotated[StrictFloat, Field(gt=0)],
@@ -696,13 +698,13 @@ class SyntheticSettingsApi:
696
698
  _content_type: Optional[StrictStr] = None,
697
699
  _headers: Optional[Dict[StrictStr, Any]] = None,
698
700
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
699
- ) -> ApiResponse[None]:
700
- """Delete Synthetic credential
701
+ ) -> ApiResponse[List[SyntheticTestCICDResponse]]:
702
+ """Create a Synthetic test CI/CD
701
703
 
702
- API request to delete a Synthetic Credential.
704
+ API request to create a Synthetic Test CI/CD. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
703
705
 
704
- :param name: Name of the credential to be deleted (required)
705
- :type name: str
706
+ :param synthetic_test_cicd: (required)
707
+ :type synthetic_test_cicd: List[SyntheticTestCICD]
706
708
  :param _request_timeout: timeout setting for this request. If one
707
709
  number provided, it will be total request
708
710
  timeout. It can also be a pair (tuple) of
@@ -725,8 +727,8 @@ class SyntheticSettingsApi:
725
727
  :return: Returns the result object.
726
728
  """ # noqa: E501
727
729
 
728
- _param = self._delete_synthetic_credential_serialize(
729
- name=name,
730
+ _param = self._create_synthetic_test_cicd_serialize(
731
+ synthetic_test_cicd=synthetic_test_cicd,
730
732
  _request_auth=_request_auth,
731
733
  _content_type=_content_type,
732
734
  _headers=_headers,
@@ -734,8 +736,7 @@ class SyntheticSettingsApi:
734
736
  )
735
737
 
736
738
  _response_types_map: Dict[str, Optional[str]] = {
737
- '200': None,
738
- '204': None,
739
+ '200': "List[SyntheticTestCICDResponse]",
739
740
  '401': None,
740
741
  '403': None,
741
742
  '500': None,
@@ -752,9 +753,9 @@ class SyntheticSettingsApi:
752
753
 
753
754
 
754
755
  @validate_call
755
- def delete_synthetic_credential_without_preload_content(
756
+ def create_synthetic_test_cicd_without_preload_content(
756
757
  self,
757
- name: Annotated[StrictStr, Field(description="Name of the credential to be deleted")],
758
+ synthetic_test_cicd: List[SyntheticTestCICD],
758
759
  _request_timeout: Union[
759
760
  None,
760
761
  Annotated[StrictFloat, Field(gt=0)],
@@ -768,12 +769,12 @@ class SyntheticSettingsApi:
768
769
  _headers: Optional[Dict[StrictStr, Any]] = None,
769
770
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
770
771
  ) -> RESTResponseType:
771
- """Delete Synthetic credential
772
+ """Create a Synthetic test CI/CD
772
773
 
773
- API request to delete a Synthetic Credential.
774
+ API request to create a Synthetic Test CI/CD. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
774
775
 
775
- :param name: Name of the credential to be deleted (required)
776
- :type name: str
776
+ :param synthetic_test_cicd: (required)
777
+ :type synthetic_test_cicd: List[SyntheticTestCICD]
777
778
  :param _request_timeout: timeout setting for this request. If one
778
779
  number provided, it will be total request
779
780
  timeout. It can also be a pair (tuple) of
@@ -796,8 +797,8 @@ class SyntheticSettingsApi:
796
797
  :return: Returns the result object.
797
798
  """ # noqa: E501
798
799
 
799
- _param = self._delete_synthetic_credential_serialize(
800
- name=name,
800
+ _param = self._create_synthetic_test_cicd_serialize(
801
+ synthetic_test_cicd=synthetic_test_cicd,
801
802
  _request_auth=_request_auth,
802
803
  _content_type=_content_type,
803
804
  _headers=_headers,
@@ -805,8 +806,7 @@ class SyntheticSettingsApi:
805
806
  )
806
807
 
807
808
  _response_types_map: Dict[str, Optional[str]] = {
808
- '200': None,
809
- '204': None,
809
+ '200': "List[SyntheticTestCICDResponse]",
810
810
  '401': None,
811
811
  '403': None,
812
812
  '500': None,
@@ -818,9 +818,9 @@ class SyntheticSettingsApi:
818
818
  return response_data.response
819
819
 
820
820
 
821
- def _delete_synthetic_credential_serialize(
821
+ def _create_synthetic_test_cicd_serialize(
822
822
  self,
823
- name,
823
+ synthetic_test_cicd,
824
824
  _request_auth,
825
825
  _content_type,
826
826
  _headers,
@@ -830,6 +830,7 @@ class SyntheticSettingsApi:
830
830
  _host = None
831
831
 
832
832
  _collection_formats: Dict[str, str] = {
833
+ 'SyntheticTestCICD': '',
833
834
  }
834
835
 
835
836
  _path_params: Dict[str, str] = {}
@@ -842,12 +843,12 @@ class SyntheticSettingsApi:
842
843
  _body_params: Optional[bytes] = None
843
844
 
844
845
  # process the path parameters
845
- if name is not None:
846
- _path_params['name'] = name
847
846
  # process the query parameters
848
847
  # process the header parameters
849
848
  # process the form parameters
850
849
  # process the body parameter
850
+ if synthetic_test_cicd is not None:
851
+ _body_params = synthetic_test_cicd
851
852
 
852
853
 
853
854
  # set the HTTP header `Accept`
@@ -858,6 +859,19 @@ class SyntheticSettingsApi:
858
859
  ]
859
860
  )
860
861
 
862
+ # set the HTTP header `Content-Type`
863
+ if _content_type:
864
+ _header_params['Content-Type'] = _content_type
865
+ else:
866
+ _default_content_type = (
867
+ self.api_client.select_header_content_type(
868
+ [
869
+ 'application/json'
870
+ ]
871
+ )
872
+ )
873
+ if _default_content_type is not None:
874
+ _header_params['Content-Type'] = _default_content_type
861
875
 
862
876
  # authentication setting
863
877
  _auth_settings: List[str] = [
@@ -865,8 +879,8 @@ class SyntheticSettingsApi:
865
879
  ]
866
880
 
867
881
  return self.api_client.param_serialize(
868
- method='DELETE',
869
- resource_path='/api/synthetics/settings/credentials/{name}',
882
+ method='POST',
883
+ resource_path='/api/synthetics/settings/tests/ci-cd',
870
884
  path_params=_path_params,
871
885
  query_params=_query_params,
872
886
  header_params=_header_params,
@@ -883,9 +897,9 @@ class SyntheticSettingsApi:
883
897
 
884
898
 
885
899
  @validate_call
886
- def delete_synthetic_location(
900
+ def delete_synthetic_credential(
887
901
  self,
888
- id: Annotated[StrictStr, Field(description="Identifier of the location to be deleted")],
902
+ name: Annotated[StrictStr, Field(description="Name of the credential to be deleted")],
889
903
  _request_timeout: Union[
890
904
  None,
891
905
  Annotated[StrictFloat, Field(gt=0)],
@@ -899,12 +913,12 @@ class SyntheticSettingsApi:
899
913
  _headers: Optional[Dict[StrictStr, Any]] = None,
900
914
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
901
915
  ) -> None:
902
- """Delete Synthetic location
916
+ """Delete a Synthetic credential
903
917
 
904
- This API endpoint deletes a synthetic location. Note: Users cannot use this API to delete managed locations.
918
+ API request to delete a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
905
919
 
906
- :param id: Identifier of the location to be deleted (required)
907
- :type id: str
920
+ :param name: Name of the credential to be deleted (required)
921
+ :type name: str
908
922
  :param _request_timeout: timeout setting for this request. If one
909
923
  number provided, it will be total request
910
924
  timeout. It can also be a pair (tuple) of
@@ -927,8 +941,8 @@ class SyntheticSettingsApi:
927
941
  :return: Returns the result object.
928
942
  """ # noqa: E501
929
943
 
930
- _param = self._delete_synthetic_location_serialize(
931
- id=id,
944
+ _param = self._delete_synthetic_credential_serialize(
945
+ name=name,
932
946
  _request_auth=_request_auth,
933
947
  _content_type=_content_type,
934
948
  _headers=_headers,
@@ -938,6 +952,7 @@ class SyntheticSettingsApi:
938
952
  _response_types_map: Dict[str, Optional[str]] = {
939
953
  '204': None,
940
954
  '401': None,
955
+ '403': None,
941
956
  '500': None,
942
957
  }
943
958
  response_data = self.api_client.call_api(
@@ -952,9 +967,9 @@ class SyntheticSettingsApi:
952
967
 
953
968
 
954
969
  @validate_call
955
- def delete_synthetic_location_with_http_info(
970
+ def delete_synthetic_credential_with_http_info(
956
971
  self,
957
- id: Annotated[StrictStr, Field(description="Identifier of the location to be deleted")],
972
+ name: Annotated[StrictStr, Field(description="Name of the credential to be deleted")],
958
973
  _request_timeout: Union[
959
974
  None,
960
975
  Annotated[StrictFloat, Field(gt=0)],
@@ -968,12 +983,12 @@ class SyntheticSettingsApi:
968
983
  _headers: Optional[Dict[StrictStr, Any]] = None,
969
984
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
970
985
  ) -> ApiResponse[None]:
971
- """Delete Synthetic location
986
+ """Delete a Synthetic credential
972
987
 
973
- This API endpoint deletes a synthetic location. Note: Users cannot use this API to delete managed locations.
988
+ API request to delete a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
974
989
 
975
- :param id: Identifier of the location to be deleted (required)
976
- :type id: str
990
+ :param name: Name of the credential to be deleted (required)
991
+ :type name: str
977
992
  :param _request_timeout: timeout setting for this request. If one
978
993
  number provided, it will be total request
979
994
  timeout. It can also be a pair (tuple) of
@@ -996,8 +1011,8 @@ class SyntheticSettingsApi:
996
1011
  :return: Returns the result object.
997
1012
  """ # noqa: E501
998
1013
 
999
- _param = self._delete_synthetic_location_serialize(
1000
- id=id,
1014
+ _param = self._delete_synthetic_credential_serialize(
1015
+ name=name,
1001
1016
  _request_auth=_request_auth,
1002
1017
  _content_type=_content_type,
1003
1018
  _headers=_headers,
@@ -1007,6 +1022,7 @@ class SyntheticSettingsApi:
1007
1022
  _response_types_map: Dict[str, Optional[str]] = {
1008
1023
  '204': None,
1009
1024
  '401': None,
1025
+ '403': None,
1010
1026
  '500': None,
1011
1027
  }
1012
1028
  response_data = self.api_client.call_api(
@@ -1021,9 +1037,9 @@ class SyntheticSettingsApi:
1021
1037
 
1022
1038
 
1023
1039
  @validate_call
1024
- def delete_synthetic_location_without_preload_content(
1040
+ def delete_synthetic_credential_without_preload_content(
1025
1041
  self,
1026
- id: Annotated[StrictStr, Field(description="Identifier of the location to be deleted")],
1042
+ name: Annotated[StrictStr, Field(description="Name of the credential to be deleted")],
1027
1043
  _request_timeout: Union[
1028
1044
  None,
1029
1045
  Annotated[StrictFloat, Field(gt=0)],
@@ -1037,12 +1053,12 @@ class SyntheticSettingsApi:
1037
1053
  _headers: Optional[Dict[StrictStr, Any]] = None,
1038
1054
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1039
1055
  ) -> RESTResponseType:
1040
- """Delete Synthetic location
1056
+ """Delete a Synthetic credential
1041
1057
 
1042
- This API endpoint deletes a synthetic location. Note: Users cannot use this API to delete managed locations.
1058
+ API request to delete a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1043
1059
 
1044
- :param id: Identifier of the location to be deleted (required)
1045
- :type id: str
1060
+ :param name: Name of the credential to be deleted (required)
1061
+ :type name: str
1046
1062
  :param _request_timeout: timeout setting for this request. If one
1047
1063
  number provided, it will be total request
1048
1064
  timeout. It can also be a pair (tuple) of
@@ -1065,8 +1081,8 @@ class SyntheticSettingsApi:
1065
1081
  :return: Returns the result object.
1066
1082
  """ # noqa: E501
1067
1083
 
1068
- _param = self._delete_synthetic_location_serialize(
1069
- id=id,
1084
+ _param = self._delete_synthetic_credential_serialize(
1085
+ name=name,
1070
1086
  _request_auth=_request_auth,
1071
1087
  _content_type=_content_type,
1072
1088
  _headers=_headers,
@@ -1076,6 +1092,7 @@ class SyntheticSettingsApi:
1076
1092
  _response_types_map: Dict[str, Optional[str]] = {
1077
1093
  '204': None,
1078
1094
  '401': None,
1095
+ '403': None,
1079
1096
  '500': None,
1080
1097
  }
1081
1098
  response_data = self.api_client.call_api(
@@ -1085,9 +1102,9 @@ class SyntheticSettingsApi:
1085
1102
  return response_data.response
1086
1103
 
1087
1104
 
1088
- def _delete_synthetic_location_serialize(
1105
+ def _delete_synthetic_credential_serialize(
1089
1106
  self,
1090
- id,
1107
+ name,
1091
1108
  _request_auth,
1092
1109
  _content_type,
1093
1110
  _headers,
@@ -1109,8 +1126,8 @@ class SyntheticSettingsApi:
1109
1126
  _body_params: Optional[bytes] = None
1110
1127
 
1111
1128
  # process the path parameters
1112
- if id is not None:
1113
- _path_params['id'] = id
1129
+ if name is not None:
1130
+ _path_params['name'] = name
1114
1131
  # process the query parameters
1115
1132
  # process the header parameters
1116
1133
  # process the form parameters
@@ -1126,7 +1143,7 @@ class SyntheticSettingsApi:
1126
1143
 
1127
1144
  return self.api_client.param_serialize(
1128
1145
  method='DELETE',
1129
- resource_path='/api/synthetics/settings/locations/{id}',
1146
+ resource_path='/api/synthetics/settings/credentials/{name}',
1130
1147
  path_params=_path_params,
1131
1148
  query_params=_query_params,
1132
1149
  header_params=_header_params,
@@ -1143,9 +1160,9 @@ class SyntheticSettingsApi:
1143
1160
 
1144
1161
 
1145
1162
  @validate_call
1146
- def delete_synthetic_test(
1163
+ def delete_synthetic_location(
1147
1164
  self,
1148
- id: Annotated[StrictStr, Field(description="Id of the synthetic test to be deleted")],
1165
+ id: Annotated[StrictStr, Field(description="Identifier of the location to be deleted")],
1149
1166
  _request_timeout: Union[
1150
1167
  None,
1151
1168
  Annotated[StrictFloat, Field(gt=0)],
@@ -1159,11 +1176,11 @@ class SyntheticSettingsApi:
1159
1176
  _headers: Optional[Dict[StrictStr, Any]] = None,
1160
1177
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1161
1178
  ) -> None:
1162
- """Delete a Synthetic test
1179
+ """Delete a Synthetic location
1163
1180
 
1164
- API request to delete a Synthetic Test.
1181
+ API request to delete a Synthetic Location with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1165
1182
 
1166
- :param id: Id of the synthetic test to be deleted (required)
1183
+ :param id: Identifier of the location to be deleted (required)
1167
1184
  :type id: str
1168
1185
  :param _request_timeout: timeout setting for this request. If one
1169
1186
  number provided, it will be total request
@@ -1187,7 +1204,7 @@ class SyntheticSettingsApi:
1187
1204
  :return: Returns the result object.
1188
1205
  """ # noqa: E501
1189
1206
 
1190
- _param = self._delete_synthetic_test_serialize(
1207
+ _param = self._delete_synthetic_location_serialize(
1191
1208
  id=id,
1192
1209
  _request_auth=_request_auth,
1193
1210
  _content_type=_content_type,
@@ -1196,10 +1213,8 @@ class SyntheticSettingsApi:
1196
1213
  )
1197
1214
 
1198
1215
  _response_types_map: Dict[str, Optional[str]] = {
1199
- '200': None,
1200
1216
  '204': None,
1201
1217
  '401': None,
1202
- '403': None,
1203
1218
  '500': None,
1204
1219
  }
1205
1220
  response_data = self.api_client.call_api(
@@ -1214,9 +1229,9 @@ class SyntheticSettingsApi:
1214
1229
 
1215
1230
 
1216
1231
  @validate_call
1217
- def delete_synthetic_test_with_http_info(
1232
+ def delete_synthetic_location_with_http_info(
1218
1233
  self,
1219
- id: Annotated[StrictStr, Field(description="Id of the synthetic test to be deleted")],
1234
+ id: Annotated[StrictStr, Field(description="Identifier of the location to be deleted")],
1220
1235
  _request_timeout: Union[
1221
1236
  None,
1222
1237
  Annotated[StrictFloat, Field(gt=0)],
@@ -1230,11 +1245,11 @@ class SyntheticSettingsApi:
1230
1245
  _headers: Optional[Dict[StrictStr, Any]] = None,
1231
1246
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1232
1247
  ) -> ApiResponse[None]:
1233
- """Delete a Synthetic test
1248
+ """Delete a Synthetic location
1234
1249
 
1235
- API request to delete a Synthetic Test.
1250
+ API request to delete a Synthetic Location with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1236
1251
 
1237
- :param id: Id of the synthetic test to be deleted (required)
1252
+ :param id: Identifier of the location to be deleted (required)
1238
1253
  :type id: str
1239
1254
  :param _request_timeout: timeout setting for this request. If one
1240
1255
  number provided, it will be total request
@@ -1258,7 +1273,7 @@ class SyntheticSettingsApi:
1258
1273
  :return: Returns the result object.
1259
1274
  """ # noqa: E501
1260
1275
 
1261
- _param = self._delete_synthetic_test_serialize(
1276
+ _param = self._delete_synthetic_location_serialize(
1262
1277
  id=id,
1263
1278
  _request_auth=_request_auth,
1264
1279
  _content_type=_content_type,
@@ -1267,10 +1282,8 @@ class SyntheticSettingsApi:
1267
1282
  )
1268
1283
 
1269
1284
  _response_types_map: Dict[str, Optional[str]] = {
1270
- '200': None,
1271
1285
  '204': None,
1272
1286
  '401': None,
1273
- '403': None,
1274
1287
  '500': None,
1275
1288
  }
1276
1289
  response_data = self.api_client.call_api(
@@ -1285,9 +1298,9 @@ class SyntheticSettingsApi:
1285
1298
 
1286
1299
 
1287
1300
  @validate_call
1288
- def delete_synthetic_test_without_preload_content(
1301
+ def delete_synthetic_location_without_preload_content(
1289
1302
  self,
1290
- id: Annotated[StrictStr, Field(description="Id of the synthetic test to be deleted")],
1303
+ id: Annotated[StrictStr, Field(description="Identifier of the location to be deleted")],
1291
1304
  _request_timeout: Union[
1292
1305
  None,
1293
1306
  Annotated[StrictFloat, Field(gt=0)],
@@ -1301,11 +1314,11 @@ class SyntheticSettingsApi:
1301
1314
  _headers: Optional[Dict[StrictStr, Any]] = None,
1302
1315
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1303
1316
  ) -> RESTResponseType:
1304
- """Delete a Synthetic test
1317
+ """Delete a Synthetic location
1305
1318
 
1306
- API request to delete a Synthetic Test.
1319
+ API request to delete a Synthetic Location with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1307
1320
 
1308
- :param id: Id of the synthetic test to be deleted (required)
1321
+ :param id: Identifier of the location to be deleted (required)
1309
1322
  :type id: str
1310
1323
  :param _request_timeout: timeout setting for this request. If one
1311
1324
  number provided, it will be total request
@@ -1329,7 +1342,7 @@ class SyntheticSettingsApi:
1329
1342
  :return: Returns the result object.
1330
1343
  """ # noqa: E501
1331
1344
 
1332
- _param = self._delete_synthetic_test_serialize(
1345
+ _param = self._delete_synthetic_location_serialize(
1333
1346
  id=id,
1334
1347
  _request_auth=_request_auth,
1335
1348
  _content_type=_content_type,
@@ -1338,10 +1351,8 @@ class SyntheticSettingsApi:
1338
1351
  )
1339
1352
 
1340
1353
  _response_types_map: Dict[str, Optional[str]] = {
1341
- '200': None,
1342
1354
  '204': None,
1343
1355
  '401': None,
1344
- '403': None,
1345
1356
  '500': None,
1346
1357
  }
1347
1358
  response_data = self.api_client.call_api(
@@ -1351,7 +1362,7 @@ class SyntheticSettingsApi:
1351
1362
  return response_data.response
1352
1363
 
1353
1364
 
1354
- def _delete_synthetic_test_serialize(
1365
+ def _delete_synthetic_location_serialize(
1355
1366
  self,
1356
1367
  id,
1357
1368
  _request_auth,
@@ -1383,13 +1394,6 @@ class SyntheticSettingsApi:
1383
1394
  # process the body parameter
1384
1395
 
1385
1396
 
1386
- # set the HTTP header `Accept`
1387
- if 'Accept' not in _header_params:
1388
- _header_params['Accept'] = self.api_client.select_header_accept(
1389
- [
1390
- 'application/json'
1391
- ]
1392
- )
1393
1397
 
1394
1398
 
1395
1399
  # authentication setting
@@ -1399,7 +1403,7 @@ class SyntheticSettingsApi:
1399
1403
 
1400
1404
  return self.api_client.param_serialize(
1401
1405
  method='DELETE',
1402
- resource_path='/api/synthetics/settings/tests/{id}',
1406
+ resource_path='/api/synthetics/settings/locations/{id}',
1403
1407
  path_params=_path_params,
1404
1408
  query_params=_query_params,
1405
1409
  header_params=_header_params,
@@ -1416,9 +1420,9 @@ class SyntheticSettingsApi:
1416
1420
 
1417
1421
 
1418
1422
  @validate_call
1419
- def get_one_synthetic_credential_associations(
1423
+ def delete_synthetic_test(
1420
1424
  self,
1421
- name: Annotated[StrictStr, Field(description="Name of the credential to be retrieved")],
1425
+ id: Annotated[StrictStr, Field(description="Id of the synthetic test to be deleted")],
1422
1426
  _request_timeout: Union[
1423
1427
  None,
1424
1428
  Annotated[StrictFloat, Field(gt=0)],
@@ -1431,13 +1435,13 @@ class SyntheticSettingsApi:
1431
1435
  _content_type: Optional[StrictStr] = None,
1432
1436
  _headers: Optional[Dict[StrictStr, Any]] = None,
1433
1437
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1434
- ) -> SyntheticCredential:
1435
- """A Synthetic Credential with Name and Associations
1438
+ ) -> None:
1439
+ """Delete a Synthetic test
1436
1440
 
1437
- API request to retrieve a Synthetic Credential with matching name.
1441
+ API request to delete a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1438
1442
 
1439
- :param name: Name of the credential to be retrieved (required)
1440
- :type name: str
1443
+ :param id: Id of the synthetic test to be deleted (required)
1444
+ :type id: str
1441
1445
  :param _request_timeout: timeout setting for this request. If one
1442
1446
  number provided, it will be total request
1443
1447
  timeout. It can also be a pair (tuple) of
@@ -1460,8 +1464,8 @@ class SyntheticSettingsApi:
1460
1464
  :return: Returns the result object.
1461
1465
  """ # noqa: E501
1462
1466
 
1463
- _param = self._get_one_synthetic_credential_associations_serialize(
1464
- name=name,
1467
+ _param = self._delete_synthetic_test_serialize(
1468
+ id=id,
1465
1469
  _request_auth=_request_auth,
1466
1470
  _content_type=_content_type,
1467
1471
  _headers=_headers,
@@ -1469,10 +1473,9 @@ class SyntheticSettingsApi:
1469
1473
  )
1470
1474
 
1471
1475
  _response_types_map: Dict[str, Optional[str]] = {
1472
- '200': "SyntheticCredential",
1476
+ '204': None,
1473
1477
  '401': None,
1474
1478
  '403': None,
1475
- '404': None,
1476
1479
  '500': None,
1477
1480
  }
1478
1481
  response_data = self.api_client.call_api(
@@ -1487,9 +1490,9 @@ class SyntheticSettingsApi:
1487
1490
 
1488
1491
 
1489
1492
  @validate_call
1490
- def get_one_synthetic_credential_associations_with_http_info(
1493
+ def delete_synthetic_test_with_http_info(
1491
1494
  self,
1492
- name: Annotated[StrictStr, Field(description="Name of the credential to be retrieved")],
1495
+ id: Annotated[StrictStr, Field(description="Id of the synthetic test to be deleted")],
1493
1496
  _request_timeout: Union[
1494
1497
  None,
1495
1498
  Annotated[StrictFloat, Field(gt=0)],
@@ -1502,13 +1505,13 @@ class SyntheticSettingsApi:
1502
1505
  _content_type: Optional[StrictStr] = None,
1503
1506
  _headers: Optional[Dict[StrictStr, Any]] = None,
1504
1507
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1505
- ) -> ApiResponse[SyntheticCredential]:
1506
- """A Synthetic Credential with Name and Associations
1508
+ ) -> ApiResponse[None]:
1509
+ """Delete a Synthetic test
1507
1510
 
1508
- API request to retrieve a Synthetic Credential with matching name.
1511
+ API request to delete a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1509
1512
 
1510
- :param name: Name of the credential to be retrieved (required)
1511
- :type name: str
1513
+ :param id: Id of the synthetic test to be deleted (required)
1514
+ :type id: str
1512
1515
  :param _request_timeout: timeout setting for this request. If one
1513
1516
  number provided, it will be total request
1514
1517
  timeout. It can also be a pair (tuple) of
@@ -1531,8 +1534,8 @@ class SyntheticSettingsApi:
1531
1534
  :return: Returns the result object.
1532
1535
  """ # noqa: E501
1533
1536
 
1534
- _param = self._get_one_synthetic_credential_associations_serialize(
1535
- name=name,
1537
+ _param = self._delete_synthetic_test_serialize(
1538
+ id=id,
1536
1539
  _request_auth=_request_auth,
1537
1540
  _content_type=_content_type,
1538
1541
  _headers=_headers,
@@ -1540,10 +1543,9 @@ class SyntheticSettingsApi:
1540
1543
  )
1541
1544
 
1542
1545
  _response_types_map: Dict[str, Optional[str]] = {
1543
- '200': "SyntheticCredential",
1546
+ '204': None,
1544
1547
  '401': None,
1545
1548
  '403': None,
1546
- '404': None,
1547
1549
  '500': None,
1548
1550
  }
1549
1551
  response_data = self.api_client.call_api(
@@ -1558,9 +1560,9 @@ class SyntheticSettingsApi:
1558
1560
 
1559
1561
 
1560
1562
  @validate_call
1561
- def get_one_synthetic_credential_associations_without_preload_content(
1563
+ def delete_synthetic_test_without_preload_content(
1562
1564
  self,
1563
- name: Annotated[StrictStr, Field(description="Name of the credential to be retrieved")],
1565
+ id: Annotated[StrictStr, Field(description="Id of the synthetic test to be deleted")],
1564
1566
  _request_timeout: Union[
1565
1567
  None,
1566
1568
  Annotated[StrictFloat, Field(gt=0)],
@@ -1574,12 +1576,12 @@ class SyntheticSettingsApi:
1574
1576
  _headers: Optional[Dict[StrictStr, Any]] = None,
1575
1577
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1576
1578
  ) -> RESTResponseType:
1577
- """A Synthetic Credential with Name and Associations
1579
+ """Delete a Synthetic test
1578
1580
 
1579
- API request to retrieve a Synthetic Credential with matching name.
1581
+ API request to delete a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1580
1582
 
1581
- :param name: Name of the credential to be retrieved (required)
1582
- :type name: str
1583
+ :param id: Id of the synthetic test to be deleted (required)
1584
+ :type id: str
1583
1585
  :param _request_timeout: timeout setting for this request. If one
1584
1586
  number provided, it will be total request
1585
1587
  timeout. It can also be a pair (tuple) of
@@ -1602,8 +1604,8 @@ class SyntheticSettingsApi:
1602
1604
  :return: Returns the result object.
1603
1605
  """ # noqa: E501
1604
1606
 
1605
- _param = self._get_one_synthetic_credential_associations_serialize(
1606
- name=name,
1607
+ _param = self._delete_synthetic_test_serialize(
1608
+ id=id,
1607
1609
  _request_auth=_request_auth,
1608
1610
  _content_type=_content_type,
1609
1611
  _headers=_headers,
@@ -1611,10 +1613,9 @@ class SyntheticSettingsApi:
1611
1613
  )
1612
1614
 
1613
1615
  _response_types_map: Dict[str, Optional[str]] = {
1614
- '200': "SyntheticCredential",
1616
+ '204': None,
1615
1617
  '401': None,
1616
1618
  '403': None,
1617
- '404': None,
1618
1619
  '500': None,
1619
1620
  }
1620
1621
  response_data = self.api_client.call_api(
@@ -1624,9 +1625,9 @@ class SyntheticSettingsApi:
1624
1625
  return response_data.response
1625
1626
 
1626
1627
 
1627
- def _get_one_synthetic_credential_associations_serialize(
1628
+ def _delete_synthetic_test_serialize(
1628
1629
  self,
1629
- name,
1630
+ id,
1630
1631
  _request_auth,
1631
1632
  _content_type,
1632
1633
  _headers,
@@ -1648,21 +1649,14 @@ class SyntheticSettingsApi:
1648
1649
  _body_params: Optional[bytes] = None
1649
1650
 
1650
1651
  # process the path parameters
1651
- if name is not None:
1652
- _path_params['name'] = name
1652
+ if id is not None:
1653
+ _path_params['id'] = id
1653
1654
  # process the query parameters
1654
1655
  # process the header parameters
1655
1656
  # process the form parameters
1656
1657
  # process the body parameter
1657
1658
 
1658
1659
 
1659
- # set the HTTP header `Accept`
1660
- if 'Accept' not in _header_params:
1661
- _header_params['Accept'] = self.api_client.select_header_accept(
1662
- [
1663
- 'application/json'
1664
- ]
1665
- )
1666
1660
 
1667
1661
 
1668
1662
  # authentication setting
@@ -1671,8 +1665,8 @@ class SyntheticSettingsApi:
1671
1665
  ]
1672
1666
 
1673
1667
  return self.api_client.param_serialize(
1674
- method='GET',
1675
- resource_path='/api/synthetics/settings/credentials/associations/{name}',
1668
+ method='DELETE',
1669
+ resource_path='/api/synthetics/settings/tests/{id}',
1676
1670
  path_params=_path_params,
1677
1671
  query_params=_query_params,
1678
1672
  header_params=_header_params,
@@ -1689,8 +1683,9 @@ class SyntheticSettingsApi:
1689
1683
 
1690
1684
 
1691
1685
  @validate_call
1692
- def get_synthetic_credential_associations(
1686
+ def get_one_synthetic_credential_associations(
1693
1687
  self,
1688
+ name: Annotated[StrictStr, Field(description="Name of the credential to be retrieved")],
1694
1689
  _request_timeout: Union[
1695
1690
  None,
1696
1691
  Annotated[StrictFloat, Field(gt=0)],
@@ -1703,11 +1698,13 @@ class SyntheticSettingsApi:
1703
1698
  _content_type: Optional[StrictStr] = None,
1704
1699
  _headers: Optional[Dict[StrictStr, Any]] = None,
1705
1700
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1706
- ) -> List[SyntheticCredential]:
1707
- """All Synthetic Credential Names and Associations
1701
+ ) -> SyntheticCredential:
1702
+ """A Synthetic credential
1708
1703
 
1709
- API request to retrieve all Synthetic Credentials.
1704
+ API request to retrieve a Synthetic Credential with matching name. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1710
1705
 
1706
+ :param name: Name of the credential to be retrieved (required)
1707
+ :type name: str
1711
1708
  :param _request_timeout: timeout setting for this request. If one
1712
1709
  number provided, it will be total request
1713
1710
  timeout. It can also be a pair (tuple) of
@@ -1730,7 +1727,8 @@ class SyntheticSettingsApi:
1730
1727
  :return: Returns the result object.
1731
1728
  """ # noqa: E501
1732
1729
 
1733
- _param = self._get_synthetic_credential_associations_serialize(
1730
+ _param = self._get_one_synthetic_credential_associations_serialize(
1731
+ name=name,
1734
1732
  _request_auth=_request_auth,
1735
1733
  _content_type=_content_type,
1736
1734
  _headers=_headers,
@@ -1738,7 +1736,7 @@ class SyntheticSettingsApi:
1738
1736
  )
1739
1737
 
1740
1738
  _response_types_map: Dict[str, Optional[str]] = {
1741
- '200': "List[SyntheticCredential]",
1739
+ '200': "SyntheticCredential",
1742
1740
  '401': None,
1743
1741
  '403': None,
1744
1742
  '404': None,
@@ -1756,8 +1754,9 @@ class SyntheticSettingsApi:
1756
1754
 
1757
1755
 
1758
1756
  @validate_call
1759
- def get_synthetic_credential_associations_with_http_info(
1757
+ def get_one_synthetic_credential_associations_with_http_info(
1760
1758
  self,
1759
+ name: Annotated[StrictStr, Field(description="Name of the credential to be retrieved")],
1761
1760
  _request_timeout: Union[
1762
1761
  None,
1763
1762
  Annotated[StrictFloat, Field(gt=0)],
@@ -1770,11 +1769,13 @@ class SyntheticSettingsApi:
1770
1769
  _content_type: Optional[StrictStr] = None,
1771
1770
  _headers: Optional[Dict[StrictStr, Any]] = None,
1772
1771
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1773
- ) -> ApiResponse[List[SyntheticCredential]]:
1774
- """All Synthetic Credential Names and Associations
1772
+ ) -> ApiResponse[SyntheticCredential]:
1773
+ """A Synthetic credential
1775
1774
 
1776
- API request to retrieve all Synthetic Credentials.
1775
+ API request to retrieve a Synthetic Credential with matching name. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1777
1776
 
1777
+ :param name: Name of the credential to be retrieved (required)
1778
+ :type name: str
1778
1779
  :param _request_timeout: timeout setting for this request. If one
1779
1780
  number provided, it will be total request
1780
1781
  timeout. It can also be a pair (tuple) of
@@ -1797,7 +1798,8 @@ class SyntheticSettingsApi:
1797
1798
  :return: Returns the result object.
1798
1799
  """ # noqa: E501
1799
1800
 
1800
- _param = self._get_synthetic_credential_associations_serialize(
1801
+ _param = self._get_one_synthetic_credential_associations_serialize(
1802
+ name=name,
1801
1803
  _request_auth=_request_auth,
1802
1804
  _content_type=_content_type,
1803
1805
  _headers=_headers,
@@ -1805,7 +1807,7 @@ class SyntheticSettingsApi:
1805
1807
  )
1806
1808
 
1807
1809
  _response_types_map: Dict[str, Optional[str]] = {
1808
- '200': "List[SyntheticCredential]",
1810
+ '200': "SyntheticCredential",
1809
1811
  '401': None,
1810
1812
  '403': None,
1811
1813
  '404': None,
@@ -1823,8 +1825,9 @@ class SyntheticSettingsApi:
1823
1825
 
1824
1826
 
1825
1827
  @validate_call
1826
- def get_synthetic_credential_associations_without_preload_content(
1828
+ def get_one_synthetic_credential_associations_without_preload_content(
1827
1829
  self,
1830
+ name: Annotated[StrictStr, Field(description="Name of the credential to be retrieved")],
1828
1831
  _request_timeout: Union[
1829
1832
  None,
1830
1833
  Annotated[StrictFloat, Field(gt=0)],
@@ -1838,10 +1841,12 @@ class SyntheticSettingsApi:
1838
1841
  _headers: Optional[Dict[StrictStr, Any]] = None,
1839
1842
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1840
1843
  ) -> RESTResponseType:
1841
- """All Synthetic Credential Names and Associations
1844
+ """A Synthetic credential
1842
1845
 
1843
- API request to retrieve all Synthetic Credentials.
1846
+ API request to retrieve a Synthetic Credential with matching name. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1844
1847
 
1848
+ :param name: Name of the credential to be retrieved (required)
1849
+ :type name: str
1845
1850
  :param _request_timeout: timeout setting for this request. If one
1846
1851
  number provided, it will be total request
1847
1852
  timeout. It can also be a pair (tuple) of
@@ -1864,7 +1869,8 @@ class SyntheticSettingsApi:
1864
1869
  :return: Returns the result object.
1865
1870
  """ # noqa: E501
1866
1871
 
1867
- _param = self._get_synthetic_credential_associations_serialize(
1872
+ _param = self._get_one_synthetic_credential_associations_serialize(
1873
+ name=name,
1868
1874
  _request_auth=_request_auth,
1869
1875
  _content_type=_content_type,
1870
1876
  _headers=_headers,
@@ -1872,7 +1878,7 @@ class SyntheticSettingsApi:
1872
1878
  )
1873
1879
 
1874
1880
  _response_types_map: Dict[str, Optional[str]] = {
1875
- '200': "List[SyntheticCredential]",
1881
+ '200': "SyntheticCredential",
1876
1882
  '401': None,
1877
1883
  '403': None,
1878
1884
  '404': None,
@@ -1885,8 +1891,9 @@ class SyntheticSettingsApi:
1885
1891
  return response_data.response
1886
1892
 
1887
1893
 
1888
- def _get_synthetic_credential_associations_serialize(
1894
+ def _get_one_synthetic_credential_associations_serialize(
1889
1895
  self,
1896
+ name,
1890
1897
  _request_auth,
1891
1898
  _content_type,
1892
1899
  _headers,
@@ -1908,6 +1915,8 @@ class SyntheticSettingsApi:
1908
1915
  _body_params: Optional[bytes] = None
1909
1916
 
1910
1917
  # process the path parameters
1918
+ if name is not None:
1919
+ _path_params['name'] = name
1911
1920
  # process the query parameters
1912
1921
  # process the header parameters
1913
1922
  # process the form parameters
@@ -1930,7 +1939,7 @@ class SyntheticSettingsApi:
1930
1939
 
1931
1940
  return self.api_client.param_serialize(
1932
1941
  method='GET',
1933
- resource_path='/api/synthetics/settings/credentials/associations',
1942
+ resource_path='/api/synthetics/settings/credentials/associations/{name}',
1934
1943
  path_params=_path_params,
1935
1944
  query_params=_query_params,
1936
1945
  header_params=_header_params,
@@ -1947,7 +1956,265 @@ class SyntheticSettingsApi:
1947
1956
 
1948
1957
 
1949
1958
  @validate_call
1950
- def get_synthetic_credential_names(
1959
+ def get_synthetic_credential_associations(
1960
+ self,
1961
+ _request_timeout: Union[
1962
+ None,
1963
+ Annotated[StrictFloat, Field(gt=0)],
1964
+ Tuple[
1965
+ Annotated[StrictFloat, Field(gt=0)],
1966
+ Annotated[StrictFloat, Field(gt=0)]
1967
+ ]
1968
+ ] = None,
1969
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1970
+ _content_type: Optional[StrictStr] = None,
1971
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1972
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1973
+ ) -> List[SyntheticCredential]:
1974
+ """All Synthetic credentials
1975
+
1976
+ API request to retrieve all Synthetic Credentials. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1977
+
1978
+ :param _request_timeout: timeout setting for this request. If one
1979
+ number provided, it will be total request
1980
+ timeout. It can also be a pair (tuple) of
1981
+ (connection, read) timeouts.
1982
+ :type _request_timeout: int, tuple(int, int), optional
1983
+ :param _request_auth: set to override the auth_settings for an a single
1984
+ request; this effectively ignores the
1985
+ authentication in the spec for a single request.
1986
+ :type _request_auth: dict, optional
1987
+ :param _content_type: force content-type for the request.
1988
+ :type _content_type: str, Optional
1989
+ :param _headers: set to override the headers for a single
1990
+ request; this effectively ignores the headers
1991
+ in the spec for a single request.
1992
+ :type _headers: dict, optional
1993
+ :param _host_index: set to override the host_index for a single
1994
+ request; this effectively ignores the host_index
1995
+ in the spec for a single request.
1996
+ :type _host_index: int, optional
1997
+ :return: Returns the result object.
1998
+ """ # noqa: E501
1999
+
2000
+ _param = self._get_synthetic_credential_associations_serialize(
2001
+ _request_auth=_request_auth,
2002
+ _content_type=_content_type,
2003
+ _headers=_headers,
2004
+ _host_index=_host_index
2005
+ )
2006
+
2007
+ _response_types_map: Dict[str, Optional[str]] = {
2008
+ '200': "List[SyntheticCredential]",
2009
+ '401': None,
2010
+ '403': None,
2011
+ '404': None,
2012
+ '500': None,
2013
+ }
2014
+ response_data = self.api_client.call_api(
2015
+ *_param,
2016
+ _request_timeout=_request_timeout
2017
+ )
2018
+ response_data.read()
2019
+ return self.api_client.response_deserialize(
2020
+ response_data=response_data,
2021
+ response_types_map=_response_types_map,
2022
+ ).data
2023
+
2024
+
2025
+ @validate_call
2026
+ def get_synthetic_credential_associations_with_http_info(
2027
+ self,
2028
+ _request_timeout: Union[
2029
+ None,
2030
+ Annotated[StrictFloat, Field(gt=0)],
2031
+ Tuple[
2032
+ Annotated[StrictFloat, Field(gt=0)],
2033
+ Annotated[StrictFloat, Field(gt=0)]
2034
+ ]
2035
+ ] = None,
2036
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2037
+ _content_type: Optional[StrictStr] = None,
2038
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2039
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2040
+ ) -> ApiResponse[List[SyntheticCredential]]:
2041
+ """All Synthetic credentials
2042
+
2043
+ API request to retrieve all Synthetic Credentials. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2044
+
2045
+ :param _request_timeout: timeout setting for this request. If one
2046
+ number provided, it will be total request
2047
+ timeout. It can also be a pair (tuple) of
2048
+ (connection, read) timeouts.
2049
+ :type _request_timeout: int, tuple(int, int), optional
2050
+ :param _request_auth: set to override the auth_settings for an a single
2051
+ request; this effectively ignores the
2052
+ authentication in the spec for a single request.
2053
+ :type _request_auth: dict, optional
2054
+ :param _content_type: force content-type for the request.
2055
+ :type _content_type: str, Optional
2056
+ :param _headers: set to override the headers for a single
2057
+ request; this effectively ignores the headers
2058
+ in the spec for a single request.
2059
+ :type _headers: dict, optional
2060
+ :param _host_index: set to override the host_index for a single
2061
+ request; this effectively ignores the host_index
2062
+ in the spec for a single request.
2063
+ :type _host_index: int, optional
2064
+ :return: Returns the result object.
2065
+ """ # noqa: E501
2066
+
2067
+ _param = self._get_synthetic_credential_associations_serialize(
2068
+ _request_auth=_request_auth,
2069
+ _content_type=_content_type,
2070
+ _headers=_headers,
2071
+ _host_index=_host_index
2072
+ )
2073
+
2074
+ _response_types_map: Dict[str, Optional[str]] = {
2075
+ '200': "List[SyntheticCredential]",
2076
+ '401': None,
2077
+ '403': None,
2078
+ '404': None,
2079
+ '500': None,
2080
+ }
2081
+ response_data = self.api_client.call_api(
2082
+ *_param,
2083
+ _request_timeout=_request_timeout
2084
+ )
2085
+ response_data.read()
2086
+ return self.api_client.response_deserialize(
2087
+ response_data=response_data,
2088
+ response_types_map=_response_types_map,
2089
+ )
2090
+
2091
+
2092
+ @validate_call
2093
+ def get_synthetic_credential_associations_without_preload_content(
2094
+ self,
2095
+ _request_timeout: Union[
2096
+ None,
2097
+ Annotated[StrictFloat, Field(gt=0)],
2098
+ Tuple[
2099
+ Annotated[StrictFloat, Field(gt=0)],
2100
+ Annotated[StrictFloat, Field(gt=0)]
2101
+ ]
2102
+ ] = None,
2103
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2104
+ _content_type: Optional[StrictStr] = None,
2105
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2106
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2107
+ ) -> RESTResponseType:
2108
+ """All Synthetic credentials
2109
+
2110
+ API request to retrieve all Synthetic Credentials. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2111
+
2112
+ :param _request_timeout: timeout setting for this request. If one
2113
+ number provided, it will be total request
2114
+ timeout. It can also be a pair (tuple) of
2115
+ (connection, read) timeouts.
2116
+ :type _request_timeout: int, tuple(int, int), optional
2117
+ :param _request_auth: set to override the auth_settings for an a single
2118
+ request; this effectively ignores the
2119
+ authentication in the spec for a single request.
2120
+ :type _request_auth: dict, optional
2121
+ :param _content_type: force content-type for the request.
2122
+ :type _content_type: str, Optional
2123
+ :param _headers: set to override the headers for a single
2124
+ request; this effectively ignores the headers
2125
+ in the spec for a single request.
2126
+ :type _headers: dict, optional
2127
+ :param _host_index: set to override the host_index for a single
2128
+ request; this effectively ignores the host_index
2129
+ in the spec for a single request.
2130
+ :type _host_index: int, optional
2131
+ :return: Returns the result object.
2132
+ """ # noqa: E501
2133
+
2134
+ _param = self._get_synthetic_credential_associations_serialize(
2135
+ _request_auth=_request_auth,
2136
+ _content_type=_content_type,
2137
+ _headers=_headers,
2138
+ _host_index=_host_index
2139
+ )
2140
+
2141
+ _response_types_map: Dict[str, Optional[str]] = {
2142
+ '200': "List[SyntheticCredential]",
2143
+ '401': None,
2144
+ '403': None,
2145
+ '404': None,
2146
+ '500': None,
2147
+ }
2148
+ response_data = self.api_client.call_api(
2149
+ *_param,
2150
+ _request_timeout=_request_timeout
2151
+ )
2152
+ return response_data.response
2153
+
2154
+
2155
+ def _get_synthetic_credential_associations_serialize(
2156
+ self,
2157
+ _request_auth,
2158
+ _content_type,
2159
+ _headers,
2160
+ _host_index,
2161
+ ) -> RequestSerialized:
2162
+
2163
+ _host = None
2164
+
2165
+ _collection_formats: Dict[str, str] = {
2166
+ }
2167
+
2168
+ _path_params: Dict[str, str] = {}
2169
+ _query_params: List[Tuple[str, str]] = []
2170
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2171
+ _form_params: List[Tuple[str, str]] = []
2172
+ _files: Dict[
2173
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2174
+ ] = {}
2175
+ _body_params: Optional[bytes] = None
2176
+
2177
+ # process the path parameters
2178
+ # process the query parameters
2179
+ # process the header parameters
2180
+ # process the form parameters
2181
+ # process the body parameter
2182
+
2183
+
2184
+ # set the HTTP header `Accept`
2185
+ if 'Accept' not in _header_params:
2186
+ _header_params['Accept'] = self.api_client.select_header_accept(
2187
+ [
2188
+ 'application/json'
2189
+ ]
2190
+ )
2191
+
2192
+
2193
+ # authentication setting
2194
+ _auth_settings: List[str] = [
2195
+ 'ApiKeyAuth'
2196
+ ]
2197
+
2198
+ return self.api_client.param_serialize(
2199
+ method='GET',
2200
+ resource_path='/api/synthetics/settings/credentials/associations',
2201
+ path_params=_path_params,
2202
+ query_params=_query_params,
2203
+ header_params=_header_params,
2204
+ body=_body_params,
2205
+ post_params=_form_params,
2206
+ files=_files,
2207
+ auth_settings=_auth_settings,
2208
+ collection_formats=_collection_formats,
2209
+ _host=_host,
2210
+ _request_auth=_request_auth
2211
+ )
2212
+
2213
+
2214
+
2215
+
2216
+ @validate_call
2217
+ def get_synthetic_credential_names(
1951
2218
  self,
1952
2219
  _request_timeout: Union[
1953
2220
  None,
@@ -1962,9 +2229,9 @@ class SyntheticSettingsApi:
1962
2229
  _headers: Optional[Dict[StrictStr, Any]] = None,
1963
2230
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1964
2231
  ) -> List[str]:
1965
- """All Synthetic Credential Names
2232
+ """All Synthetic credential names
1966
2233
 
1967
- API request to retrieve the names of all Synthetic Credentials.
2234
+ API request to retrieve the names of all Synthetic Credentials. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
1968
2235
 
1969
2236
  :param _request_timeout: timeout setting for this request. If one
1970
2237
  number provided, it will be total request
@@ -2029,9 +2296,9 @@ class SyntheticSettingsApi:
2029
2296
  _headers: Optional[Dict[StrictStr, Any]] = None,
2030
2297
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2031
2298
  ) -> ApiResponse[List[str]]:
2032
- """All Synthetic Credential Names
2299
+ """All Synthetic credential names
2033
2300
 
2034
- API request to retrieve the names of all Synthetic Credentials.
2301
+ API request to retrieve the names of all Synthetic Credentials. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2035
2302
 
2036
2303
  :param _request_timeout: timeout setting for this request. If one
2037
2304
  number provided, it will be total request
@@ -2096,9 +2363,9 @@ class SyntheticSettingsApi:
2096
2363
  _headers: Optional[Dict[StrictStr, Any]] = None,
2097
2364
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2098
2365
  ) -> RESTResponseType:
2099
- """All Synthetic Credential Names
2366
+ """All Synthetic credential names
2100
2367
 
2101
- API request to retrieve the names of all Synthetic Credentials.
2368
+ API request to retrieve the names of all Synthetic Credentials. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2102
2369
 
2103
2370
  :param _request_timeout: timeout setting for this request. If one
2104
2371
  number provided, it will be total request
@@ -2221,9 +2488,9 @@ class SyntheticSettingsApi:
2221
2488
  _headers: Optional[Dict[StrictStr, Any]] = None,
2222
2489
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2223
2490
  ) -> SyntheticDatacenter:
2224
- """Synthetic datacenter
2491
+ """A Synthetic datacenter
2225
2492
 
2226
- API request to retrieve a Synthetic Datacenter with matching id.
2493
+ API request to retrieve a Synthetic Datacenter with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2227
2494
 
2228
2495
  :param datacenter_id: Id of the datacenter to be retrieved (required)
2229
2496
  :type datacenter_id: str
@@ -2292,9 +2559,9 @@ class SyntheticSettingsApi:
2292
2559
  _headers: Optional[Dict[StrictStr, Any]] = None,
2293
2560
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2294
2561
  ) -> ApiResponse[SyntheticDatacenter]:
2295
- """Synthetic datacenter
2562
+ """A Synthetic datacenter
2296
2563
 
2297
- API request to retrieve a Synthetic Datacenter with matching id.
2564
+ API request to retrieve a Synthetic Datacenter with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2298
2565
 
2299
2566
  :param datacenter_id: Id of the datacenter to be retrieved (required)
2300
2567
  :type datacenter_id: str
@@ -2363,9 +2630,9 @@ class SyntheticSettingsApi:
2363
2630
  _headers: Optional[Dict[StrictStr, Any]] = None,
2364
2631
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2365
2632
  ) -> RESTResponseType:
2366
- """Synthetic datacenter
2633
+ """A Synthetic datacenter
2367
2634
 
2368
- API request to retrieve a Synthetic Datacenter with matching id.
2635
+ API request to retrieve a Synthetic Datacenter with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2369
2636
 
2370
2637
  :param datacenter_id: Id of the datacenter to be retrieved (required)
2371
2638
  :type datacenter_id: str
@@ -2495,7 +2762,7 @@ class SyntheticSettingsApi:
2495
2762
  ) -> List[SyntheticDatacenter]:
2496
2763
  """All Synthetic datacenters
2497
2764
 
2498
- API request to retrieve all Synthetic Datacenters.
2765
+ API request to retrieve all Synthetic Datacenters. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2499
2766
 
2500
2767
  :param _request_timeout: timeout setting for this request. If one
2501
2768
  number provided, it will be total request
@@ -2561,7 +2828,7 @@ class SyntheticSettingsApi:
2561
2828
  ) -> ApiResponse[List[SyntheticDatacenter]]:
2562
2829
  """All Synthetic datacenters
2563
2830
 
2564
- API request to retrieve all Synthetic Datacenters.
2831
+ API request to retrieve all Synthetic Datacenters. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2565
2832
 
2566
2833
  :param _request_timeout: timeout setting for this request. If one
2567
2834
  number provided, it will be total request
@@ -2595,7 +2862,562 @@ class SyntheticSettingsApi:
2595
2862
  _response_types_map: Dict[str, Optional[str]] = {
2596
2863
  '200': "List[SyntheticDatacenter]",
2597
2864
  '401': None,
2598
- '403': None,
2865
+ '403': None,
2866
+ '500': None,
2867
+ }
2868
+ response_data = self.api_client.call_api(
2869
+ *_param,
2870
+ _request_timeout=_request_timeout
2871
+ )
2872
+ response_data.read()
2873
+ return self.api_client.response_deserialize(
2874
+ response_data=response_data,
2875
+ response_types_map=_response_types_map,
2876
+ )
2877
+
2878
+
2879
+ @validate_call
2880
+ def get_synthetic_datacenters_without_preload_content(
2881
+ self,
2882
+ _request_timeout: Union[
2883
+ None,
2884
+ Annotated[StrictFloat, Field(gt=0)],
2885
+ Tuple[
2886
+ Annotated[StrictFloat, Field(gt=0)],
2887
+ Annotated[StrictFloat, Field(gt=0)]
2888
+ ]
2889
+ ] = None,
2890
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2891
+ _content_type: Optional[StrictStr] = None,
2892
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2893
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2894
+ ) -> RESTResponseType:
2895
+ """All Synthetic datacenters
2896
+
2897
+ API request to retrieve all Synthetic Datacenters. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2898
+
2899
+ :param _request_timeout: timeout setting for this request. If one
2900
+ number provided, it will be total request
2901
+ timeout. It can also be a pair (tuple) of
2902
+ (connection, read) timeouts.
2903
+ :type _request_timeout: int, tuple(int, int), optional
2904
+ :param _request_auth: set to override the auth_settings for an a single
2905
+ request; this effectively ignores the
2906
+ authentication in the spec for a single request.
2907
+ :type _request_auth: dict, optional
2908
+ :param _content_type: force content-type for the request.
2909
+ :type _content_type: str, Optional
2910
+ :param _headers: set to override the headers for a single
2911
+ request; this effectively ignores the headers
2912
+ in the spec for a single request.
2913
+ :type _headers: dict, optional
2914
+ :param _host_index: set to override the host_index for a single
2915
+ request; this effectively ignores the host_index
2916
+ in the spec for a single request.
2917
+ :type _host_index: int, optional
2918
+ :return: Returns the result object.
2919
+ """ # noqa: E501
2920
+
2921
+ _param = self._get_synthetic_datacenters_serialize(
2922
+ _request_auth=_request_auth,
2923
+ _content_type=_content_type,
2924
+ _headers=_headers,
2925
+ _host_index=_host_index
2926
+ )
2927
+
2928
+ _response_types_map: Dict[str, Optional[str]] = {
2929
+ '200': "List[SyntheticDatacenter]",
2930
+ '401': None,
2931
+ '403': None,
2932
+ '500': None,
2933
+ }
2934
+ response_data = self.api_client.call_api(
2935
+ *_param,
2936
+ _request_timeout=_request_timeout
2937
+ )
2938
+ return response_data.response
2939
+
2940
+
2941
+ def _get_synthetic_datacenters_serialize(
2942
+ self,
2943
+ _request_auth,
2944
+ _content_type,
2945
+ _headers,
2946
+ _host_index,
2947
+ ) -> RequestSerialized:
2948
+
2949
+ _host = None
2950
+
2951
+ _collection_formats: Dict[str, str] = {
2952
+ }
2953
+
2954
+ _path_params: Dict[str, str] = {}
2955
+ _query_params: List[Tuple[str, str]] = []
2956
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2957
+ _form_params: List[Tuple[str, str]] = []
2958
+ _files: Dict[
2959
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2960
+ ] = {}
2961
+ _body_params: Optional[bytes] = None
2962
+
2963
+ # process the path parameters
2964
+ # process the query parameters
2965
+ # process the header parameters
2966
+ # process the form parameters
2967
+ # process the body parameter
2968
+
2969
+
2970
+ # set the HTTP header `Accept`
2971
+ if 'Accept' not in _header_params:
2972
+ _header_params['Accept'] = self.api_client.select_header_accept(
2973
+ [
2974
+ 'application/json'
2975
+ ]
2976
+ )
2977
+
2978
+
2979
+ # authentication setting
2980
+ _auth_settings: List[str] = [
2981
+ 'ApiKeyAuth'
2982
+ ]
2983
+
2984
+ return self.api_client.param_serialize(
2985
+ method='GET',
2986
+ resource_path='/api/synthetics/settings/datacenters',
2987
+ path_params=_path_params,
2988
+ query_params=_query_params,
2989
+ header_params=_header_params,
2990
+ body=_body_params,
2991
+ post_params=_form_params,
2992
+ files=_files,
2993
+ auth_settings=_auth_settings,
2994
+ collection_formats=_collection_formats,
2995
+ _host=_host,
2996
+ _request_auth=_request_auth
2997
+ )
2998
+
2999
+
3000
+
3001
+
3002
+ @validate_call
3003
+ def get_synthetic_location(
3004
+ self,
3005
+ id: Annotated[StrictStr, Field(description="Identifier of the location to be retrieved")],
3006
+ _request_timeout: Union[
3007
+ None,
3008
+ Annotated[StrictFloat, Field(gt=0)],
3009
+ Tuple[
3010
+ Annotated[StrictFloat, Field(gt=0)],
3011
+ Annotated[StrictFloat, Field(gt=0)]
3012
+ ]
3013
+ ] = None,
3014
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3015
+ _content_type: Optional[StrictStr] = None,
3016
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3017
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3018
+ ) -> SyntheticLocation:
3019
+ """A Synthetic location
3020
+
3021
+ API request to retrieve a Synthetic Location with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3022
+
3023
+ :param id: Identifier of the location to be retrieved (required)
3024
+ :type id: str
3025
+ :param _request_timeout: timeout setting for this request. If one
3026
+ number provided, it will be total request
3027
+ timeout. It can also be a pair (tuple) of
3028
+ (connection, read) timeouts.
3029
+ :type _request_timeout: int, tuple(int, int), optional
3030
+ :param _request_auth: set to override the auth_settings for an a single
3031
+ request; this effectively ignores the
3032
+ authentication in the spec for a single request.
3033
+ :type _request_auth: dict, optional
3034
+ :param _content_type: force content-type for the request.
3035
+ :type _content_type: str, Optional
3036
+ :param _headers: set to override the headers for a single
3037
+ request; this effectively ignores the headers
3038
+ in the spec for a single request.
3039
+ :type _headers: dict, optional
3040
+ :param _host_index: set to override the host_index for a single
3041
+ request; this effectively ignores the host_index
3042
+ in the spec for a single request.
3043
+ :type _host_index: int, optional
3044
+ :return: Returns the result object.
3045
+ """ # noqa: E501
3046
+
3047
+ _param = self._get_synthetic_location_serialize(
3048
+ id=id,
3049
+ _request_auth=_request_auth,
3050
+ _content_type=_content_type,
3051
+ _headers=_headers,
3052
+ _host_index=_host_index
3053
+ )
3054
+
3055
+ _response_types_map: Dict[str, Optional[str]] = {
3056
+ '200': "SyntheticLocation",
3057
+ '401': None,
3058
+ '404': None,
3059
+ '500': None,
3060
+ }
3061
+ response_data = self.api_client.call_api(
3062
+ *_param,
3063
+ _request_timeout=_request_timeout
3064
+ )
3065
+ response_data.read()
3066
+ return self.api_client.response_deserialize(
3067
+ response_data=response_data,
3068
+ response_types_map=_response_types_map,
3069
+ ).data
3070
+
3071
+
3072
+ @validate_call
3073
+ def get_synthetic_location_with_http_info(
3074
+ self,
3075
+ id: Annotated[StrictStr, Field(description="Identifier of the location to be retrieved")],
3076
+ _request_timeout: Union[
3077
+ None,
3078
+ Annotated[StrictFloat, Field(gt=0)],
3079
+ Tuple[
3080
+ Annotated[StrictFloat, Field(gt=0)],
3081
+ Annotated[StrictFloat, Field(gt=0)]
3082
+ ]
3083
+ ] = None,
3084
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3085
+ _content_type: Optional[StrictStr] = None,
3086
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3087
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3088
+ ) -> ApiResponse[SyntheticLocation]:
3089
+ """A Synthetic location
3090
+
3091
+ API request to retrieve a Synthetic Location with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3092
+
3093
+ :param id: Identifier of the location to be retrieved (required)
3094
+ :type id: str
3095
+ :param _request_timeout: timeout setting for this request. If one
3096
+ number provided, it will be total request
3097
+ timeout. It can also be a pair (tuple) of
3098
+ (connection, read) timeouts.
3099
+ :type _request_timeout: int, tuple(int, int), optional
3100
+ :param _request_auth: set to override the auth_settings for an a single
3101
+ request; this effectively ignores the
3102
+ authentication in the spec for a single request.
3103
+ :type _request_auth: dict, optional
3104
+ :param _content_type: force content-type for the request.
3105
+ :type _content_type: str, Optional
3106
+ :param _headers: set to override the headers for a single
3107
+ request; this effectively ignores the headers
3108
+ in the spec for a single request.
3109
+ :type _headers: dict, optional
3110
+ :param _host_index: set to override the host_index for a single
3111
+ request; this effectively ignores the host_index
3112
+ in the spec for a single request.
3113
+ :type _host_index: int, optional
3114
+ :return: Returns the result object.
3115
+ """ # noqa: E501
3116
+
3117
+ _param = self._get_synthetic_location_serialize(
3118
+ id=id,
3119
+ _request_auth=_request_auth,
3120
+ _content_type=_content_type,
3121
+ _headers=_headers,
3122
+ _host_index=_host_index
3123
+ )
3124
+
3125
+ _response_types_map: Dict[str, Optional[str]] = {
3126
+ '200': "SyntheticLocation",
3127
+ '401': None,
3128
+ '404': None,
3129
+ '500': None,
3130
+ }
3131
+ response_data = self.api_client.call_api(
3132
+ *_param,
3133
+ _request_timeout=_request_timeout
3134
+ )
3135
+ response_data.read()
3136
+ return self.api_client.response_deserialize(
3137
+ response_data=response_data,
3138
+ response_types_map=_response_types_map,
3139
+ )
3140
+
3141
+
3142
+ @validate_call
3143
+ def get_synthetic_location_without_preload_content(
3144
+ self,
3145
+ id: Annotated[StrictStr, Field(description="Identifier of the location to be retrieved")],
3146
+ _request_timeout: Union[
3147
+ None,
3148
+ Annotated[StrictFloat, Field(gt=0)],
3149
+ Tuple[
3150
+ Annotated[StrictFloat, Field(gt=0)],
3151
+ Annotated[StrictFloat, Field(gt=0)]
3152
+ ]
3153
+ ] = None,
3154
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3155
+ _content_type: Optional[StrictStr] = None,
3156
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3157
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3158
+ ) -> RESTResponseType:
3159
+ """A Synthetic location
3160
+
3161
+ API request to retrieve a Synthetic Location with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3162
+
3163
+ :param id: Identifier of the location to be retrieved (required)
3164
+ :type id: str
3165
+ :param _request_timeout: timeout setting for this request. If one
3166
+ number provided, it will be total request
3167
+ timeout. It can also be a pair (tuple) of
3168
+ (connection, read) timeouts.
3169
+ :type _request_timeout: int, tuple(int, int), optional
3170
+ :param _request_auth: set to override the auth_settings for an a single
3171
+ request; this effectively ignores the
3172
+ authentication in the spec for a single request.
3173
+ :type _request_auth: dict, optional
3174
+ :param _content_type: force content-type for the request.
3175
+ :type _content_type: str, Optional
3176
+ :param _headers: set to override the headers for a single
3177
+ request; this effectively ignores the headers
3178
+ in the spec for a single request.
3179
+ :type _headers: dict, optional
3180
+ :param _host_index: set to override the host_index for a single
3181
+ request; this effectively ignores the host_index
3182
+ in the spec for a single request.
3183
+ :type _host_index: int, optional
3184
+ :return: Returns the result object.
3185
+ """ # noqa: E501
3186
+
3187
+ _param = self._get_synthetic_location_serialize(
3188
+ id=id,
3189
+ _request_auth=_request_auth,
3190
+ _content_type=_content_type,
3191
+ _headers=_headers,
3192
+ _host_index=_host_index
3193
+ )
3194
+
3195
+ _response_types_map: Dict[str, Optional[str]] = {
3196
+ '200': "SyntheticLocation",
3197
+ '401': None,
3198
+ '404': None,
3199
+ '500': None,
3200
+ }
3201
+ response_data = self.api_client.call_api(
3202
+ *_param,
3203
+ _request_timeout=_request_timeout
3204
+ )
3205
+ return response_data.response
3206
+
3207
+
3208
+ def _get_synthetic_location_serialize(
3209
+ self,
3210
+ id,
3211
+ _request_auth,
3212
+ _content_type,
3213
+ _headers,
3214
+ _host_index,
3215
+ ) -> RequestSerialized:
3216
+
3217
+ _host = None
3218
+
3219
+ _collection_formats: Dict[str, str] = {
3220
+ }
3221
+
3222
+ _path_params: Dict[str, str] = {}
3223
+ _query_params: List[Tuple[str, str]] = []
3224
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3225
+ _form_params: List[Tuple[str, str]] = []
3226
+ _files: Dict[
3227
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3228
+ ] = {}
3229
+ _body_params: Optional[bytes] = None
3230
+
3231
+ # process the path parameters
3232
+ if id is not None:
3233
+ _path_params['id'] = id
3234
+ # process the query parameters
3235
+ # process the header parameters
3236
+ # process the form parameters
3237
+ # process the body parameter
3238
+
3239
+
3240
+ # set the HTTP header `Accept`
3241
+ if 'Accept' not in _header_params:
3242
+ _header_params['Accept'] = self.api_client.select_header_accept(
3243
+ [
3244
+ 'application/json'
3245
+ ]
3246
+ )
3247
+
3248
+
3249
+ # authentication setting
3250
+ _auth_settings: List[str] = [
3251
+ 'ApiKeyAuth'
3252
+ ]
3253
+
3254
+ return self.api_client.param_serialize(
3255
+ method='GET',
3256
+ resource_path='/api/synthetics/settings/locations/{id}',
3257
+ path_params=_path_params,
3258
+ query_params=_query_params,
3259
+ header_params=_header_params,
3260
+ body=_body_params,
3261
+ post_params=_form_params,
3262
+ files=_files,
3263
+ auth_settings=_auth_settings,
3264
+ collection_formats=_collection_formats,
3265
+ _host=_host,
3266
+ _request_auth=_request_auth
3267
+ )
3268
+
3269
+
3270
+
3271
+
3272
+ @validate_call
3273
+ def get_synthetic_locations(
3274
+ self,
3275
+ sort: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC")] = None,
3276
+ offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations")] = None,
3277
+ limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic locations that will be returned by the query")] = None,
3278
+ filter: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.")] = None,
3279
+ _request_timeout: Union[
3280
+ None,
3281
+ Annotated[StrictFloat, Field(gt=0)],
3282
+ Tuple[
3283
+ Annotated[StrictFloat, Field(gt=0)],
3284
+ Annotated[StrictFloat, Field(gt=0)]
3285
+ ]
3286
+ ] = None,
3287
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3288
+ _content_type: Optional[StrictStr] = None,
3289
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3290
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3291
+ ) -> List[SyntheticLocation]:
3292
+ """All Synthetic locations
3293
+
3294
+ API request to retrieve Synthetic Locations. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3295
+
3296
+ :param sort: Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC
3297
+ :type sort: str
3298
+ :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations
3299
+ :type offset: int
3300
+ :param limit: Defines the size of a page - the number of synthetic locations that will be returned by the query
3301
+ :type limit: int
3302
+ :param filter: Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.
3303
+ :type filter: str
3304
+ :param _request_timeout: timeout setting for this request. If one
3305
+ number provided, it will be total request
3306
+ timeout. It can also be a pair (tuple) of
3307
+ (connection, read) timeouts.
3308
+ :type _request_timeout: int, tuple(int, int), optional
3309
+ :param _request_auth: set to override the auth_settings for an a single
3310
+ request; this effectively ignores the
3311
+ authentication in the spec for a single request.
3312
+ :type _request_auth: dict, optional
3313
+ :param _content_type: force content-type for the request.
3314
+ :type _content_type: str, Optional
3315
+ :param _headers: set to override the headers for a single
3316
+ request; this effectively ignores the headers
3317
+ in the spec for a single request.
3318
+ :type _headers: dict, optional
3319
+ :param _host_index: set to override the host_index for a single
3320
+ request; this effectively ignores the host_index
3321
+ in the spec for a single request.
3322
+ :type _host_index: int, optional
3323
+ :return: Returns the result object.
3324
+ """ # noqa: E501
3325
+
3326
+ _param = self._get_synthetic_locations_serialize(
3327
+ sort=sort,
3328
+ offset=offset,
3329
+ limit=limit,
3330
+ filter=filter,
3331
+ _request_auth=_request_auth,
3332
+ _content_type=_content_type,
3333
+ _headers=_headers,
3334
+ _host_index=_host_index
3335
+ )
3336
+
3337
+ _response_types_map: Dict[str, Optional[str]] = {
3338
+ '200': "List[SyntheticLocation]",
3339
+ '401': None,
3340
+ '500': None,
3341
+ }
3342
+ response_data = self.api_client.call_api(
3343
+ *_param,
3344
+ _request_timeout=_request_timeout
3345
+ )
3346
+ response_data.read()
3347
+ return self.api_client.response_deserialize(
3348
+ response_data=response_data,
3349
+ response_types_map=_response_types_map,
3350
+ ).data
3351
+
3352
+
3353
+ @validate_call
3354
+ def get_synthetic_locations_with_http_info(
3355
+ self,
3356
+ sort: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC")] = None,
3357
+ offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations")] = None,
3358
+ limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic locations that will be returned by the query")] = None,
3359
+ filter: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.")] = None,
3360
+ _request_timeout: Union[
3361
+ None,
3362
+ Annotated[StrictFloat, Field(gt=0)],
3363
+ Tuple[
3364
+ Annotated[StrictFloat, Field(gt=0)],
3365
+ Annotated[StrictFloat, Field(gt=0)]
3366
+ ]
3367
+ ] = None,
3368
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3369
+ _content_type: Optional[StrictStr] = None,
3370
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3371
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3372
+ ) -> ApiResponse[List[SyntheticLocation]]:
3373
+ """All Synthetic locations
3374
+
3375
+ API request to retrieve Synthetic Locations. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3376
+
3377
+ :param sort: Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC
3378
+ :type sort: str
3379
+ :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations
3380
+ :type offset: int
3381
+ :param limit: Defines the size of a page - the number of synthetic locations that will be returned by the query
3382
+ :type limit: int
3383
+ :param filter: Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.
3384
+ :type filter: str
3385
+ :param _request_timeout: timeout setting for this request. If one
3386
+ number provided, it will be total request
3387
+ timeout. It can also be a pair (tuple) of
3388
+ (connection, read) timeouts.
3389
+ :type _request_timeout: int, tuple(int, int), optional
3390
+ :param _request_auth: set to override the auth_settings for an a single
3391
+ request; this effectively ignores the
3392
+ authentication in the spec for a single request.
3393
+ :type _request_auth: dict, optional
3394
+ :param _content_type: force content-type for the request.
3395
+ :type _content_type: str, Optional
3396
+ :param _headers: set to override the headers for a single
3397
+ request; this effectively ignores the headers
3398
+ in the spec for a single request.
3399
+ :type _headers: dict, optional
3400
+ :param _host_index: set to override the host_index for a single
3401
+ request; this effectively ignores the host_index
3402
+ in the spec for a single request.
3403
+ :type _host_index: int, optional
3404
+ :return: Returns the result object.
3405
+ """ # noqa: E501
3406
+
3407
+ _param = self._get_synthetic_locations_serialize(
3408
+ sort=sort,
3409
+ offset=offset,
3410
+ limit=limit,
3411
+ filter=filter,
3412
+ _request_auth=_request_auth,
3413
+ _content_type=_content_type,
3414
+ _headers=_headers,
3415
+ _host_index=_host_index
3416
+ )
3417
+
3418
+ _response_types_map: Dict[str, Optional[str]] = {
3419
+ '200': "List[SyntheticLocation]",
3420
+ '401': None,
2599
3421
  '500': None,
2600
3422
  }
2601
3423
  response_data = self.api_client.call_api(
@@ -2610,8 +3432,12 @@ class SyntheticSettingsApi:
2610
3432
 
2611
3433
 
2612
3434
  @validate_call
2613
- def get_synthetic_datacenters_without_preload_content(
3435
+ def get_synthetic_locations_without_preload_content(
2614
3436
  self,
3437
+ sort: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC")] = None,
3438
+ offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations")] = None,
3439
+ limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic locations that will be returned by the query")] = None,
3440
+ filter: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.")] = None,
2615
3441
  _request_timeout: Union[
2616
3442
  None,
2617
3443
  Annotated[StrictFloat, Field(gt=0)],
@@ -2625,10 +3451,18 @@ class SyntheticSettingsApi:
2625
3451
  _headers: Optional[Dict[StrictStr, Any]] = None,
2626
3452
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2627
3453
  ) -> RESTResponseType:
2628
- """All Synthetic datacenters
3454
+ """All Synthetic locations
2629
3455
 
2630
- API request to retrieve all Synthetic Datacenters.
3456
+ API request to retrieve Synthetic Locations. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2631
3457
 
3458
+ :param sort: Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC
3459
+ :type sort: str
3460
+ :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations
3461
+ :type offset: int
3462
+ :param limit: Defines the size of a page - the number of synthetic locations that will be returned by the query
3463
+ :type limit: int
3464
+ :param filter: Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.
3465
+ :type filter: str
2632
3466
  :param _request_timeout: timeout setting for this request. If one
2633
3467
  number provided, it will be total request
2634
3468
  timeout. It can also be a pair (tuple) of
@@ -2651,7 +3485,11 @@ class SyntheticSettingsApi:
2651
3485
  :return: Returns the result object.
2652
3486
  """ # noqa: E501
2653
3487
 
2654
- _param = self._get_synthetic_datacenters_serialize(
3488
+ _param = self._get_synthetic_locations_serialize(
3489
+ sort=sort,
3490
+ offset=offset,
3491
+ limit=limit,
3492
+ filter=filter,
2655
3493
  _request_auth=_request_auth,
2656
3494
  _content_type=_content_type,
2657
3495
  _headers=_headers,
@@ -2659,9 +3497,8 @@ class SyntheticSettingsApi:
2659
3497
  )
2660
3498
 
2661
3499
  _response_types_map: Dict[str, Optional[str]] = {
2662
- '200': "List[SyntheticDatacenter]",
3500
+ '200': "List[SyntheticLocation]",
2663
3501
  '401': None,
2664
- '403': None,
2665
3502
  '500': None,
2666
3503
  }
2667
3504
  response_data = self.api_client.call_api(
@@ -2671,8 +3508,12 @@ class SyntheticSettingsApi:
2671
3508
  return response_data.response
2672
3509
 
2673
3510
 
2674
- def _get_synthetic_datacenters_serialize(
3511
+ def _get_synthetic_locations_serialize(
2675
3512
  self,
3513
+ sort,
3514
+ offset,
3515
+ limit,
3516
+ filter,
2676
3517
  _request_auth,
2677
3518
  _content_type,
2678
3519
  _headers,
@@ -2695,6 +3536,22 @@ class SyntheticSettingsApi:
2695
3536
 
2696
3537
  # process the path parameters
2697
3538
  # process the query parameters
3539
+ if sort is not None:
3540
+
3541
+ _query_params.append(('sort', sort))
3542
+
3543
+ if offset is not None:
3544
+
3545
+ _query_params.append(('offset', offset))
3546
+
3547
+ if limit is not None:
3548
+
3549
+ _query_params.append(('limit', limit))
3550
+
3551
+ if filter is not None:
3552
+
3553
+ _query_params.append(('filter', filter))
3554
+
2698
3555
  # process the header parameters
2699
3556
  # process the form parameters
2700
3557
  # process the body parameter
@@ -2716,7 +3573,7 @@ class SyntheticSettingsApi:
2716
3573
 
2717
3574
  return self.api_client.param_serialize(
2718
3575
  method='GET',
2719
- resource_path='/api/synthetics/settings/datacenters',
3576
+ resource_path='/api/synthetics/settings/locations',
2720
3577
  path_params=_path_params,
2721
3578
  query_params=_query_params,
2722
3579
  header_params=_header_params,
@@ -2733,9 +3590,9 @@ class SyntheticSettingsApi:
2733
3590
 
2734
3591
 
2735
3592
  @validate_call
2736
- def get_synthetic_location(
3593
+ def get_synthetic_test(
2737
3594
  self,
2738
- id: Annotated[StrictStr, Field(description="Identifier of the location to be retrieved")],
3595
+ id: Annotated[StrictStr, Field(description="Id of the synthetic test to be retrieved")],
2739
3596
  _request_timeout: Union[
2740
3597
  None,
2741
3598
  Annotated[StrictFloat, Field(gt=0)],
@@ -2748,12 +3605,12 @@ class SyntheticSettingsApi:
2748
3605
  _content_type: Optional[StrictStr] = None,
2749
3606
  _headers: Optional[Dict[StrictStr, Any]] = None,
2750
3607
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2751
- ) -> SyntheticLocation:
2752
- """Synthetic location
3608
+ ) -> SyntheticTest:
3609
+ """A Synthetic test
2753
3610
 
2754
- API request to retrieve a Synthetic Location with matching id.
3611
+ API request to retrieve a Synthetic Test with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2755
3612
 
2756
- :param id: Identifier of the location to be retrieved (required)
3613
+ :param id: Id of the synthetic test to be retrieved (required)
2757
3614
  :type id: str
2758
3615
  :param _request_timeout: timeout setting for this request. If one
2759
3616
  number provided, it will be total request
@@ -2777,7 +3634,7 @@ class SyntheticSettingsApi:
2777
3634
  :return: Returns the result object.
2778
3635
  """ # noqa: E501
2779
3636
 
2780
- _param = self._get_synthetic_location_serialize(
3637
+ _param = self._get_synthetic_test_serialize(
2781
3638
  id=id,
2782
3639
  _request_auth=_request_auth,
2783
3640
  _content_type=_content_type,
@@ -2786,8 +3643,9 @@ class SyntheticSettingsApi:
2786
3643
  )
2787
3644
 
2788
3645
  _response_types_map: Dict[str, Optional[str]] = {
2789
- '200': "SyntheticLocation",
3646
+ '200': "SyntheticTest",
2790
3647
  '401': None,
3648
+ '403': None,
2791
3649
  '404': None,
2792
3650
  '500': None,
2793
3651
  }
@@ -2803,9 +3661,9 @@ class SyntheticSettingsApi:
2803
3661
 
2804
3662
 
2805
3663
  @validate_call
2806
- def get_synthetic_location_with_http_info(
3664
+ def get_synthetic_test_with_http_info(
2807
3665
  self,
2808
- id: Annotated[StrictStr, Field(description="Identifier of the location to be retrieved")],
3666
+ id: Annotated[StrictStr, Field(description="Id of the synthetic test to be retrieved")],
2809
3667
  _request_timeout: Union[
2810
3668
  None,
2811
3669
  Annotated[StrictFloat, Field(gt=0)],
@@ -2818,12 +3676,12 @@ class SyntheticSettingsApi:
2818
3676
  _content_type: Optional[StrictStr] = None,
2819
3677
  _headers: Optional[Dict[StrictStr, Any]] = None,
2820
3678
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2821
- ) -> ApiResponse[SyntheticLocation]:
2822
- """Synthetic location
3679
+ ) -> ApiResponse[SyntheticTest]:
3680
+ """A Synthetic test
2823
3681
 
2824
- API request to retrieve a Synthetic Location with matching id.
3682
+ API request to retrieve a Synthetic Test with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2825
3683
 
2826
- :param id: Identifier of the location to be retrieved (required)
3684
+ :param id: Id of the synthetic test to be retrieved (required)
2827
3685
  :type id: str
2828
3686
  :param _request_timeout: timeout setting for this request. If one
2829
3687
  number provided, it will be total request
@@ -2847,7 +3705,7 @@ class SyntheticSettingsApi:
2847
3705
  :return: Returns the result object.
2848
3706
  """ # noqa: E501
2849
3707
 
2850
- _param = self._get_synthetic_location_serialize(
3708
+ _param = self._get_synthetic_test_serialize(
2851
3709
  id=id,
2852
3710
  _request_auth=_request_auth,
2853
3711
  _content_type=_content_type,
@@ -2856,8 +3714,9 @@ class SyntheticSettingsApi:
2856
3714
  )
2857
3715
 
2858
3716
  _response_types_map: Dict[str, Optional[str]] = {
2859
- '200': "SyntheticLocation",
3717
+ '200': "SyntheticTest",
2860
3718
  '401': None,
3719
+ '403': None,
2861
3720
  '404': None,
2862
3721
  '500': None,
2863
3722
  }
@@ -2873,9 +3732,9 @@ class SyntheticSettingsApi:
2873
3732
 
2874
3733
 
2875
3734
  @validate_call
2876
- def get_synthetic_location_without_preload_content(
3735
+ def get_synthetic_test_without_preload_content(
2877
3736
  self,
2878
- id: Annotated[StrictStr, Field(description="Identifier of the location to be retrieved")],
3737
+ id: Annotated[StrictStr, Field(description="Id of the synthetic test to be retrieved")],
2879
3738
  _request_timeout: Union[
2880
3739
  None,
2881
3740
  Annotated[StrictFloat, Field(gt=0)],
@@ -2889,11 +3748,11 @@ class SyntheticSettingsApi:
2889
3748
  _headers: Optional[Dict[StrictStr, Any]] = None,
2890
3749
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2891
3750
  ) -> RESTResponseType:
2892
- """Synthetic location
3751
+ """A Synthetic test
2893
3752
 
2894
- API request to retrieve a Synthetic Location with matching id.
3753
+ API request to retrieve a Synthetic Test with matching id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
2895
3754
 
2896
- :param id: Identifier of the location to be retrieved (required)
3755
+ :param id: Id of the synthetic test to be retrieved (required)
2897
3756
  :type id: str
2898
3757
  :param _request_timeout: timeout setting for this request. If one
2899
3758
  number provided, it will be total request
@@ -2917,7 +3776,7 @@ class SyntheticSettingsApi:
2917
3776
  :return: Returns the result object.
2918
3777
  """ # noqa: E501
2919
3778
 
2920
- _param = self._get_synthetic_location_serialize(
3779
+ _param = self._get_synthetic_test_serialize(
2921
3780
  id=id,
2922
3781
  _request_auth=_request_auth,
2923
3782
  _content_type=_content_type,
@@ -2926,8 +3785,9 @@ class SyntheticSettingsApi:
2926
3785
  )
2927
3786
 
2928
3787
  _response_types_map: Dict[str, Optional[str]] = {
2929
- '200': "SyntheticLocation",
3788
+ '200': "SyntheticTest",
2930
3789
  '401': None,
3790
+ '403': None,
2931
3791
  '404': None,
2932
3792
  '500': None,
2933
3793
  }
@@ -2938,7 +3798,7 @@ class SyntheticSettingsApi:
2938
3798
  return response_data.response
2939
3799
 
2940
3800
 
2941
- def _get_synthetic_location_serialize(
3801
+ def _get_synthetic_test_serialize(
2942
3802
  self,
2943
3803
  id,
2944
3804
  _request_auth,
@@ -2986,7 +3846,7 @@ class SyntheticSettingsApi:
2986
3846
 
2987
3847
  return self.api_client.param_serialize(
2988
3848
  method='GET',
2989
- resource_path='/api/synthetics/settings/locations/{id}',
3849
+ resource_path='/api/synthetics/settings/tests/{id}',
2990
3850
  path_params=_path_params,
2991
3851
  query_params=_query_params,
2992
3852
  header_params=_header_params,
@@ -3003,12 +3863,9 @@ class SyntheticSettingsApi:
3003
3863
 
3004
3864
 
3005
3865
  @validate_call
3006
- def get_synthetic_locations(
3866
+ def get_synthetic_test_cicd(
3007
3867
  self,
3008
- sort: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC")] = None,
3009
- offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations")] = None,
3010
- limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic locations that will be returned by the query")] = None,
3011
- filter: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.")] = None,
3868
+ test_result_id: Annotated[StrictStr, Field(description="The synthetic test result id of the CI/CD to be retrieved")],
3012
3869
  _request_timeout: Union[
3013
3870
  None,
3014
3871
  Annotated[StrictFloat, Field(gt=0)],
@@ -3021,19 +3878,13 @@ class SyntheticSettingsApi:
3021
3878
  _content_type: Optional[StrictStr] = None,
3022
3879
  _headers: Optional[Dict[StrictStr, Any]] = None,
3023
3880
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3024
- ) -> List[SyntheticLocation]:
3025
- """All Synthetic locations
3881
+ ) -> SyntheticTestCICDItem:
3882
+ """A Synthetic test CI/CD.
3026
3883
 
3027
- This endpoint retrieves Synthetic Locations. ## Optional Parameters: - **filter** Filters the Synthetic Locations to retrieve only the ones that match the specified filter condition. Users are allowed to specify more than one filter parameter, and they will be combined in a single expression using logical operator 'AND'. The filter parameter is formatted as '**_{\\<attribute>\\<operator>\\<value}_**'. For example, '_{label=MyPoP}_' ### Supported filter attributes and operators: | | = | != | \\> | < | \\>= | <= | Example | |-|---|----|---|---|---|-|--------------------------------------------------------| | label | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={label=MyPoP} | | displayLabel | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={displayLabel=My PoP} | | popVersion | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={popVersion=1.1.9} | | description | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={description=My Test PoP} | | locationType | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={locationType=Private} | | playbackCapabilities.syntheticType | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={playbackCapabilities.syntheticType=HTTPAction} | | playbackCapabilities.browserType | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={playbackCapabilities.browserType=chrome} | | configuration.clusterName | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={configuration.clusterName=qa_cluster} | | configuration.namespace | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={configuration.namespace=test_pop} | | customProperties.\\<all properties> | &check; | &check; | - | - | - | - | /api/ynthetics/settings/locations?filter={customProperty.usage=Test} | | createdAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/locations?filter={createdAt>1715190462000} | | modifiedAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/locations?filter={modifiedAt<=1715190462000} | | observerdAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/locations?filter={observedAt>=1715190462000} |
3884
+ API request to retrieve the Synthetic Test CI/CD identified by the given test result id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3028
3885
 
3029
- :param sort: Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC
3030
- :type sort: str
3031
- :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations
3032
- :type offset: int
3033
- :param limit: Defines the size of a page - the number of synthetic locations that will be returned by the query
3034
- :type limit: int
3035
- :param filter: Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.
3036
- :type filter: str
3886
+ :param test_result_id: The synthetic test result id of the CI/CD to be retrieved (required)
3887
+ :type test_result_id: str
3037
3888
  :param _request_timeout: timeout setting for this request. If one
3038
3889
  number provided, it will be total request
3039
3890
  timeout. It can also be a pair (tuple) of
@@ -3056,11 +3907,8 @@ class SyntheticSettingsApi:
3056
3907
  :return: Returns the result object.
3057
3908
  """ # noqa: E501
3058
3909
 
3059
- _param = self._get_synthetic_locations_serialize(
3060
- sort=sort,
3061
- offset=offset,
3062
- limit=limit,
3063
- filter=filter,
3910
+ _param = self._get_synthetic_test_cicd_serialize(
3911
+ test_result_id=test_result_id,
3064
3912
  _request_auth=_request_auth,
3065
3913
  _content_type=_content_type,
3066
3914
  _headers=_headers,
@@ -3068,8 +3916,10 @@ class SyntheticSettingsApi:
3068
3916
  )
3069
3917
 
3070
3918
  _response_types_map: Dict[str, Optional[str]] = {
3071
- '200': "List[SyntheticLocation]",
3919
+ '200': "SyntheticTestCICDItem",
3072
3920
  '401': None,
3921
+ '403': None,
3922
+ '404': None,
3073
3923
  '500': None,
3074
3924
  }
3075
3925
  response_data = self.api_client.call_api(
@@ -3084,12 +3934,9 @@ class SyntheticSettingsApi:
3084
3934
 
3085
3935
 
3086
3936
  @validate_call
3087
- def get_synthetic_locations_with_http_info(
3937
+ def get_synthetic_test_cicd_with_http_info(
3088
3938
  self,
3089
- sort: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC")] = None,
3090
- offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations")] = None,
3091
- limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic locations that will be returned by the query")] = None,
3092
- filter: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.")] = None,
3939
+ test_result_id: Annotated[StrictStr, Field(description="The synthetic test result id of the CI/CD to be retrieved")],
3093
3940
  _request_timeout: Union[
3094
3941
  None,
3095
3942
  Annotated[StrictFloat, Field(gt=0)],
@@ -3102,19 +3949,13 @@ class SyntheticSettingsApi:
3102
3949
  _content_type: Optional[StrictStr] = None,
3103
3950
  _headers: Optional[Dict[StrictStr, Any]] = None,
3104
3951
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3105
- ) -> ApiResponse[List[SyntheticLocation]]:
3106
- """All Synthetic locations
3952
+ ) -> ApiResponse[SyntheticTestCICDItem]:
3953
+ """A Synthetic test CI/CD.
3107
3954
 
3108
- This endpoint retrieves Synthetic Locations. ## Optional Parameters: - **filter** Filters the Synthetic Locations to retrieve only the ones that match the specified filter condition. Users are allowed to specify more than one filter parameter, and they will be combined in a single expression using logical operator 'AND'. The filter parameter is formatted as '**_{\\<attribute>\\<operator>\\<value}_**'. For example, '_{label=MyPoP}_' ### Supported filter attributes and operators: | | = | != | \\> | < | \\>= | <= | Example | |-|---|----|---|---|---|-|--------------------------------------------------------| | label | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={label=MyPoP} | | displayLabel | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={displayLabel=My PoP} | | popVersion | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={popVersion=1.1.9} | | description | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={description=My Test PoP} | | locationType | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={locationType=Private} | | playbackCapabilities.syntheticType | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={playbackCapabilities.syntheticType=HTTPAction} | | playbackCapabilities.browserType | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={playbackCapabilities.browserType=chrome} | | configuration.clusterName | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={configuration.clusterName=qa_cluster} | | configuration.namespace | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={configuration.namespace=test_pop} | | customProperties.\\<all properties> | &check; | &check; | - | - | - | - | /api/ynthetics/settings/locations?filter={customProperty.usage=Test} | | createdAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/locations?filter={createdAt>1715190462000} | | modifiedAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/locations?filter={modifiedAt<=1715190462000} | | observerdAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/locations?filter={observedAt>=1715190462000} |
3955
+ API request to retrieve the Synthetic Test CI/CD identified by the given test result id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3109
3956
 
3110
- :param sort: Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC
3111
- :type sort: str
3112
- :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations
3113
- :type offset: int
3114
- :param limit: Defines the size of a page - the number of synthetic locations that will be returned by the query
3115
- :type limit: int
3116
- :param filter: Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.
3117
- :type filter: str
3957
+ :param test_result_id: The synthetic test result id of the CI/CD to be retrieved (required)
3958
+ :type test_result_id: str
3118
3959
  :param _request_timeout: timeout setting for this request. If one
3119
3960
  number provided, it will be total request
3120
3961
  timeout. It can also be a pair (tuple) of
@@ -3137,11 +3978,8 @@ class SyntheticSettingsApi:
3137
3978
  :return: Returns the result object.
3138
3979
  """ # noqa: E501
3139
3980
 
3140
- _param = self._get_synthetic_locations_serialize(
3141
- sort=sort,
3142
- offset=offset,
3143
- limit=limit,
3144
- filter=filter,
3981
+ _param = self._get_synthetic_test_cicd_serialize(
3982
+ test_result_id=test_result_id,
3145
3983
  _request_auth=_request_auth,
3146
3984
  _content_type=_content_type,
3147
3985
  _headers=_headers,
@@ -3149,8 +3987,10 @@ class SyntheticSettingsApi:
3149
3987
  )
3150
3988
 
3151
3989
  _response_types_map: Dict[str, Optional[str]] = {
3152
- '200': "List[SyntheticLocation]",
3990
+ '200': "SyntheticTestCICDItem",
3153
3991
  '401': None,
3992
+ '403': None,
3993
+ '404': None,
3154
3994
  '500': None,
3155
3995
  }
3156
3996
  response_data = self.api_client.call_api(
@@ -3165,12 +4005,9 @@ class SyntheticSettingsApi:
3165
4005
 
3166
4006
 
3167
4007
  @validate_call
3168
- def get_synthetic_locations_without_preload_content(
4008
+ def get_synthetic_test_cicd_without_preload_content(
3169
4009
  self,
3170
- sort: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC")] = None,
3171
- offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations")] = None,
3172
- limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic locations that will be returned by the query")] = None,
3173
- filter: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.")] = None,
4010
+ test_result_id: Annotated[StrictStr, Field(description="The synthetic test result id of the CI/CD to be retrieved")],
3174
4011
  _request_timeout: Union[
3175
4012
  None,
3176
4013
  Annotated[StrictFloat, Field(gt=0)],
@@ -3184,18 +4021,12 @@ class SyntheticSettingsApi:
3184
4021
  _headers: Optional[Dict[StrictStr, Any]] = None,
3185
4022
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3186
4023
  ) -> RESTResponseType:
3187
- """All Synthetic locations
4024
+ """A Synthetic test CI/CD.
3188
4025
 
3189
- This endpoint retrieves Synthetic Locations. ## Optional Parameters: - **filter** Filters the Synthetic Locations to retrieve only the ones that match the specified filter condition. Users are allowed to specify more than one filter parameter, and they will be combined in a single expression using logical operator 'AND'. The filter parameter is formatted as '**_{\\<attribute>\\<operator>\\<value}_**'. For example, '_{label=MyPoP}_' ### Supported filter attributes and operators: | | = | != | \\> | < | \\>= | <= | Example | |-|---|----|---|---|---|-|--------------------------------------------------------| | label | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={label=MyPoP} | | displayLabel | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={displayLabel=My PoP} | | popVersion | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={popVersion=1.1.9} | | description | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={description=My Test PoP} | | locationType | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={locationType=Private} | | playbackCapabilities.syntheticType | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={playbackCapabilities.syntheticType=HTTPAction} | | playbackCapabilities.browserType | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={playbackCapabilities.browserType=chrome} | | configuration.clusterName | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={configuration.clusterName=qa_cluster} | | configuration.namespace | &check; | &check; | - | - | - | - | /api/synthetics/settings/locations?filter={configuration.namespace=test_pop} | | customProperties.\\<all properties> | &check; | &check; | - | - | - | - | /api/ynthetics/settings/locations?filter={customProperty.usage=Test} | | createdAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/locations?filter={createdAt>1715190462000} | | modifiedAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/locations?filter={modifiedAt<=1715190462000} | | observerdAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/locations?filter={observedAt>=1715190462000} |
4026
+ API request to retrieve the Synthetic Test CI/CD identified by the given test result id. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3190
4027
 
3191
- :param sort: Defines the attribute by which the returned synthetic locations will be ordered by. Order using '+' means ASC and '-' means DESC
3192
- :type sort: str
3193
- :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic locations
3194
- :type offset: int
3195
- :param limit: Defines the size of a page - the number of synthetic locations that will be returned by the query
3196
- :type limit: int
3197
- :param filter: Defines the attributes by which the returned synthetic locations will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.
3198
- :type filter: str
4028
+ :param test_result_id: The synthetic test result id of the CI/CD to be retrieved (required)
4029
+ :type test_result_id: str
3199
4030
  :param _request_timeout: timeout setting for this request. If one
3200
4031
  number provided, it will be total request
3201
4032
  timeout. It can also be a pair (tuple) of
@@ -3218,11 +4049,8 @@ class SyntheticSettingsApi:
3218
4049
  :return: Returns the result object.
3219
4050
  """ # noqa: E501
3220
4051
 
3221
- _param = self._get_synthetic_locations_serialize(
3222
- sort=sort,
3223
- offset=offset,
3224
- limit=limit,
3225
- filter=filter,
4052
+ _param = self._get_synthetic_test_cicd_serialize(
4053
+ test_result_id=test_result_id,
3226
4054
  _request_auth=_request_auth,
3227
4055
  _content_type=_content_type,
3228
4056
  _headers=_headers,
@@ -3230,8 +4058,10 @@ class SyntheticSettingsApi:
3230
4058
  )
3231
4059
 
3232
4060
  _response_types_map: Dict[str, Optional[str]] = {
3233
- '200': "List[SyntheticLocation]",
4061
+ '200': "SyntheticTestCICDItem",
3234
4062
  '401': None,
4063
+ '403': None,
4064
+ '404': None,
3235
4065
  '500': None,
3236
4066
  }
3237
4067
  response_data = self.api_client.call_api(
@@ -3241,12 +4071,9 @@ class SyntheticSettingsApi:
3241
4071
  return response_data.response
3242
4072
 
3243
4073
 
3244
- def _get_synthetic_locations_serialize(
4074
+ def _get_synthetic_test_cicd_serialize(
3245
4075
  self,
3246
- sort,
3247
- offset,
3248
- limit,
3249
- filter,
4076
+ test_result_id,
3250
4077
  _request_auth,
3251
4078
  _content_type,
3252
4079
  _headers,
@@ -3268,23 +4095,9 @@ class SyntheticSettingsApi:
3268
4095
  _body_params: Optional[bytes] = None
3269
4096
 
3270
4097
  # process the path parameters
4098
+ if test_result_id is not None:
4099
+ _path_params['testResultId'] = test_result_id
3271
4100
  # process the query parameters
3272
- if sort is not None:
3273
-
3274
- _query_params.append(('sort', sort))
3275
-
3276
- if offset is not None:
3277
-
3278
- _query_params.append(('offset', offset))
3279
-
3280
- if limit is not None:
3281
-
3282
- _query_params.append(('limit', limit))
3283
-
3284
- if filter is not None:
3285
-
3286
- _query_params.append(('filter', filter))
3287
-
3288
4101
  # process the header parameters
3289
4102
  # process the form parameters
3290
4103
  # process the body parameter
@@ -3306,7 +4119,7 @@ class SyntheticSettingsApi:
3306
4119
 
3307
4120
  return self.api_client.param_serialize(
3308
4121
  method='GET',
3309
- resource_path='/api/synthetics/settings/locations',
4122
+ resource_path='/api/synthetics/settings/tests/ci-cd/{testResultId}',
3310
4123
  path_params=_path_params,
3311
4124
  query_params=_query_params,
3312
4125
  header_params=_header_params,
@@ -3323,9 +4136,11 @@ class SyntheticSettingsApi:
3323
4136
 
3324
4137
 
3325
4138
  @validate_call
3326
- def get_synthetic_test(
4139
+ def get_synthetic_test_cicds(
3327
4140
  self,
3328
- id: Annotated[StrictStr, Field(description="Id of the synthetic test to be retrieved")],
4141
+ filter: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attributes by which the returned synthetic test CI/CDs will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.")] = None,
4142
+ offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic test CI/CDs")] = None,
4143
+ limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic test CI/CDs that will be returned by the query")] = None,
3329
4144
  _request_timeout: Union[
3330
4145
  None,
3331
4146
  Annotated[StrictFloat, Field(gt=0)],
@@ -3338,13 +4153,17 @@ class SyntheticSettingsApi:
3338
4153
  _content_type: Optional[StrictStr] = None,
3339
4154
  _headers: Optional[Dict[StrictStr, Any]] = None,
3340
4155
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3341
- ) -> SyntheticTest:
3342
- """A Synthetic test
4156
+ ) -> List[SyntheticTestCICDItem]:
4157
+ """All Synthetic test CI/CDs
3343
4158
 
3344
- API request to retrieve a Synthetic Test with matching id.
4159
+ API request to retrieve the Synthetic Test CI/CDs For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3345
4160
 
3346
- :param id: Id of the synthetic test to be retrieved (required)
3347
- :type id: str
4161
+ :param filter: Defines the attributes by which the returned synthetic test CI/CDs will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.
4162
+ :type filter: str
4163
+ :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic test CI/CDs
4164
+ :type offset: int
4165
+ :param limit: Defines the size of a page - the number of synthetic test CI/CDs that will be returned by the query
4166
+ :type limit: int
3348
4167
  :param _request_timeout: timeout setting for this request. If one
3349
4168
  number provided, it will be total request
3350
4169
  timeout. It can also be a pair (tuple) of
@@ -3367,8 +4186,10 @@ class SyntheticSettingsApi:
3367
4186
  :return: Returns the result object.
3368
4187
  """ # noqa: E501
3369
4188
 
3370
- _param = self._get_synthetic_test_serialize(
3371
- id=id,
4189
+ _param = self._get_synthetic_test_cicds_serialize(
4190
+ filter=filter,
4191
+ offset=offset,
4192
+ limit=limit,
3372
4193
  _request_auth=_request_auth,
3373
4194
  _content_type=_content_type,
3374
4195
  _headers=_headers,
@@ -3376,10 +4197,9 @@ class SyntheticSettingsApi:
3376
4197
  )
3377
4198
 
3378
4199
  _response_types_map: Dict[str, Optional[str]] = {
3379
- '200': "SyntheticTest",
4200
+ '200': "List[SyntheticTestCICDItem]",
3380
4201
  '401': None,
3381
4202
  '403': None,
3382
- '404': None,
3383
4203
  '500': None,
3384
4204
  }
3385
4205
  response_data = self.api_client.call_api(
@@ -3394,9 +4214,11 @@ class SyntheticSettingsApi:
3394
4214
 
3395
4215
 
3396
4216
  @validate_call
3397
- def get_synthetic_test_with_http_info(
4217
+ def get_synthetic_test_cicds_with_http_info(
3398
4218
  self,
3399
- id: Annotated[StrictStr, Field(description="Id of the synthetic test to be retrieved")],
4219
+ filter: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attributes by which the returned synthetic test CI/CDs will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.")] = None,
4220
+ offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic test CI/CDs")] = None,
4221
+ limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic test CI/CDs that will be returned by the query")] = None,
3400
4222
  _request_timeout: Union[
3401
4223
  None,
3402
4224
  Annotated[StrictFloat, Field(gt=0)],
@@ -3409,13 +4231,17 @@ class SyntheticSettingsApi:
3409
4231
  _content_type: Optional[StrictStr] = None,
3410
4232
  _headers: Optional[Dict[StrictStr, Any]] = None,
3411
4233
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3412
- ) -> ApiResponse[SyntheticTest]:
3413
- """A Synthetic test
4234
+ ) -> ApiResponse[List[SyntheticTestCICDItem]]:
4235
+ """All Synthetic test CI/CDs
3414
4236
 
3415
- API request to retrieve a Synthetic Test with matching id.
4237
+ API request to retrieve the Synthetic Test CI/CDs For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3416
4238
 
3417
- :param id: Id of the synthetic test to be retrieved (required)
3418
- :type id: str
4239
+ :param filter: Defines the attributes by which the returned synthetic test CI/CDs will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.
4240
+ :type filter: str
4241
+ :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic test CI/CDs
4242
+ :type offset: int
4243
+ :param limit: Defines the size of a page - the number of synthetic test CI/CDs that will be returned by the query
4244
+ :type limit: int
3419
4245
  :param _request_timeout: timeout setting for this request. If one
3420
4246
  number provided, it will be total request
3421
4247
  timeout. It can also be a pair (tuple) of
@@ -3438,8 +4264,10 @@ class SyntheticSettingsApi:
3438
4264
  :return: Returns the result object.
3439
4265
  """ # noqa: E501
3440
4266
 
3441
- _param = self._get_synthetic_test_serialize(
3442
- id=id,
4267
+ _param = self._get_synthetic_test_cicds_serialize(
4268
+ filter=filter,
4269
+ offset=offset,
4270
+ limit=limit,
3443
4271
  _request_auth=_request_auth,
3444
4272
  _content_type=_content_type,
3445
4273
  _headers=_headers,
@@ -3447,10 +4275,9 @@ class SyntheticSettingsApi:
3447
4275
  )
3448
4276
 
3449
4277
  _response_types_map: Dict[str, Optional[str]] = {
3450
- '200': "SyntheticTest",
4278
+ '200': "List[SyntheticTestCICDItem]",
3451
4279
  '401': None,
3452
4280
  '403': None,
3453
- '404': None,
3454
4281
  '500': None,
3455
4282
  }
3456
4283
  response_data = self.api_client.call_api(
@@ -3465,9 +4292,11 @@ class SyntheticSettingsApi:
3465
4292
 
3466
4293
 
3467
4294
  @validate_call
3468
- def get_synthetic_test_without_preload_content(
4295
+ def get_synthetic_test_cicds_without_preload_content(
3469
4296
  self,
3470
- id: Annotated[StrictStr, Field(description="Id of the synthetic test to be retrieved")],
4297
+ filter: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attributes by which the returned synthetic test CI/CDs will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.")] = None,
4298
+ offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic test CI/CDs")] = None,
4299
+ limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic test CI/CDs that will be returned by the query")] = None,
3471
4300
  _request_timeout: Union[
3472
4301
  None,
3473
4302
  Annotated[StrictFloat, Field(gt=0)],
@@ -3481,12 +4310,16 @@ class SyntheticSettingsApi:
3481
4310
  _headers: Optional[Dict[StrictStr, Any]] = None,
3482
4311
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3483
4312
  ) -> RESTResponseType:
3484
- """A Synthetic test
4313
+ """All Synthetic test CI/CDs
3485
4314
 
3486
- API request to retrieve a Synthetic Test with matching id.
4315
+ API request to retrieve the Synthetic Test CI/CDs For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3487
4316
 
3488
- :param id: Id of the synthetic test to be retrieved (required)
3489
- :type id: str
4317
+ :param filter: Defines the attributes by which the returned synthetic test CI/CDs will be filtered by. Multiple filter parameters are allowed. See 'Supported filter attributes and operators' for complete list of supported attributes and operators.
4318
+ :type filter: str
4319
+ :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic test CI/CDs
4320
+ :type offset: int
4321
+ :param limit: Defines the size of a page - the number of synthetic test CI/CDs that will be returned by the query
4322
+ :type limit: int
3490
4323
  :param _request_timeout: timeout setting for this request. If one
3491
4324
  number provided, it will be total request
3492
4325
  timeout. It can also be a pair (tuple) of
@@ -3509,8 +4342,10 @@ class SyntheticSettingsApi:
3509
4342
  :return: Returns the result object.
3510
4343
  """ # noqa: E501
3511
4344
 
3512
- _param = self._get_synthetic_test_serialize(
3513
- id=id,
4345
+ _param = self._get_synthetic_test_cicds_serialize(
4346
+ filter=filter,
4347
+ offset=offset,
4348
+ limit=limit,
3514
4349
  _request_auth=_request_auth,
3515
4350
  _content_type=_content_type,
3516
4351
  _headers=_headers,
@@ -3518,10 +4353,9 @@ class SyntheticSettingsApi:
3518
4353
  )
3519
4354
 
3520
4355
  _response_types_map: Dict[str, Optional[str]] = {
3521
- '200': "SyntheticTest",
4356
+ '200': "List[SyntheticTestCICDItem]",
3522
4357
  '401': None,
3523
4358
  '403': None,
3524
- '404': None,
3525
4359
  '500': None,
3526
4360
  }
3527
4361
  response_data = self.api_client.call_api(
@@ -3531,9 +4365,11 @@ class SyntheticSettingsApi:
3531
4365
  return response_data.response
3532
4366
 
3533
4367
 
3534
- def _get_synthetic_test_serialize(
4368
+ def _get_synthetic_test_cicds_serialize(
3535
4369
  self,
3536
- id,
4370
+ filter,
4371
+ offset,
4372
+ limit,
3537
4373
  _request_auth,
3538
4374
  _content_type,
3539
4375
  _headers,
@@ -3555,9 +4391,19 @@ class SyntheticSettingsApi:
3555
4391
  _body_params: Optional[bytes] = None
3556
4392
 
3557
4393
  # process the path parameters
3558
- if id is not None:
3559
- _path_params['id'] = id
3560
4394
  # process the query parameters
4395
+ if filter is not None:
4396
+
4397
+ _query_params.append(('filter', filter))
4398
+
4399
+ if offset is not None:
4400
+
4401
+ _query_params.append(('offset', offset))
4402
+
4403
+ if limit is not None:
4404
+
4405
+ _query_params.append(('limit', limit))
4406
+
3561
4407
  # process the header parameters
3562
4408
  # process the form parameters
3563
4409
  # process the body parameter
@@ -3579,7 +4425,7 @@ class SyntheticSettingsApi:
3579
4425
 
3580
4426
  return self.api_client.param_serialize(
3581
4427
  method='GET',
3582
- resource_path='/api/synthetics/settings/tests/{id}',
4428
+ resource_path='/api/synthetics/settings/tests/ci-cd',
3583
4429
  path_params=_path_params,
3584
4430
  query_params=_query_params,
3585
4431
  header_params=_header_params,
@@ -3600,6 +4446,7 @@ class SyntheticSettingsApi:
3600
4446
  self,
3601
4447
  application_id: Annotated[Optional[StrictStr], Field(description="Defines the application id by which the returned synthetic tests will be filtered by. ")] = None,
3602
4448
  location_id: Annotated[Optional[StrictStr], Field(description="Defines the location id by which the returned synthetic tests will be filtered by. ")] = None,
4449
+ credential_name: Annotated[Optional[StrictStr], Field(description="Defines the credential name by which the returned synthetic tests will be filtered by. ")] = None,
3603
4450
  sort: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attribute by which the returned synthetic tests will be ordered by. Order using '+' means ASC and '-' means DESC")] = None,
3604
4451
  offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic tests")] = None,
3605
4452
  limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic tests that will be returned by the query")] = None,
@@ -3619,12 +4466,14 @@ class SyntheticSettingsApi:
3619
4466
  ) -> List[SyntheticTest]:
3620
4467
  """All Synthetic tests
3621
4468
 
3622
- This endpoint retrieves Synthetic Tests. ## Optional Parameters: - **locationId** Filters the Synthetic Tests to retrieve only the ones that are associated to the specified PoP location ID. - **filter** Filters the Synthetic Tests to retrieve only the ones that match the specified filter condition. Users are allowed to specify more than one filter parameter, and they will be combined in a single expression using logical operator 'AND'. The filter parameter is formatted as '**_{\\<attribute>\\<operator>\\<value}_**'. For example, '_{label=MyTest}_' ### Supported filter attributes and operators: | | = | != | \\> | < | \\>= | <= | Example | |-|---|----|---|---|---|-|---------| | label | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={label=ABC} | | description | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={description=MyTest} | | active | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={active=true} | | testFrequency | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={testFrequency=5} | | applicationId | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={applicationId=APP_ID} | | locations | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={locations=POP_ID} | | locationLabels | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={locationLabels=MyPoP} | | locationDisplayLabels | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={locationDisplayLabels=My PoP} | | configuration.\\<any property of type string> | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={configurtion.syntheticType=HTTPAction} | | customProperties.\\<all properties> | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={customProperty.usage=Test} | | createdAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/tests?filter={createdAt>1715190462000} | | modifiedAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/tests?filter={modifiedAt<=1715190462000} |
4469
+ API request to retrieve Synthetic Tests. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3623
4470
 
3624
4471
  :param application_id: Defines the application id by which the returned synthetic tests will be filtered by.
3625
4472
  :type application_id: str
3626
4473
  :param location_id: Defines the location id by which the returned synthetic tests will be filtered by.
3627
4474
  :type location_id: str
4475
+ :param credential_name: Defines the credential name by which the returned synthetic tests will be filtered by.
4476
+ :type credential_name: str
3628
4477
  :param sort: Defines the attribute by which the returned synthetic tests will be ordered by. Order using '+' means ASC and '-' means DESC
3629
4478
  :type sort: str
3630
4479
  :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic tests
@@ -3658,6 +4507,7 @@ class SyntheticSettingsApi:
3658
4507
  _param = self._get_synthetic_tests_serialize(
3659
4508
  application_id=application_id,
3660
4509
  location_id=location_id,
4510
+ credential_name=credential_name,
3661
4511
  sort=sort,
3662
4512
  offset=offset,
3663
4513
  limit=limit,
@@ -3690,6 +4540,7 @@ class SyntheticSettingsApi:
3690
4540
  self,
3691
4541
  application_id: Annotated[Optional[StrictStr], Field(description="Defines the application id by which the returned synthetic tests will be filtered by. ")] = None,
3692
4542
  location_id: Annotated[Optional[StrictStr], Field(description="Defines the location id by which the returned synthetic tests will be filtered by. ")] = None,
4543
+ credential_name: Annotated[Optional[StrictStr], Field(description="Defines the credential name by which the returned synthetic tests will be filtered by. ")] = None,
3693
4544
  sort: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attribute by which the returned synthetic tests will be ordered by. Order using '+' means ASC and '-' means DESC")] = None,
3694
4545
  offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic tests")] = None,
3695
4546
  limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic tests that will be returned by the query")] = None,
@@ -3709,12 +4560,14 @@ class SyntheticSettingsApi:
3709
4560
  ) -> ApiResponse[List[SyntheticTest]]:
3710
4561
  """All Synthetic tests
3711
4562
 
3712
- This endpoint retrieves Synthetic Tests. ## Optional Parameters: - **locationId** Filters the Synthetic Tests to retrieve only the ones that are associated to the specified PoP location ID. - **filter** Filters the Synthetic Tests to retrieve only the ones that match the specified filter condition. Users are allowed to specify more than one filter parameter, and they will be combined in a single expression using logical operator 'AND'. The filter parameter is formatted as '**_{\\<attribute>\\<operator>\\<value}_**'. For example, '_{label=MyTest}_' ### Supported filter attributes and operators: | | = | != | \\> | < | \\>= | <= | Example | |-|---|----|---|---|---|-|---------| | label | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={label=ABC} | | description | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={description=MyTest} | | active | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={active=true} | | testFrequency | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={testFrequency=5} | | applicationId | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={applicationId=APP_ID} | | locations | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={locations=POP_ID} | | locationLabels | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={locationLabels=MyPoP} | | locationDisplayLabels | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={locationDisplayLabels=My PoP} | | configuration.\\<any property of type string> | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={configurtion.syntheticType=HTTPAction} | | customProperties.\\<all properties> | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={customProperty.usage=Test} | | createdAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/tests?filter={createdAt>1715190462000} | | modifiedAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/tests?filter={modifiedAt<=1715190462000} |
4563
+ API request to retrieve Synthetic Tests. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3713
4564
 
3714
4565
  :param application_id: Defines the application id by which the returned synthetic tests will be filtered by.
3715
4566
  :type application_id: str
3716
4567
  :param location_id: Defines the location id by which the returned synthetic tests will be filtered by.
3717
4568
  :type location_id: str
4569
+ :param credential_name: Defines the credential name by which the returned synthetic tests will be filtered by.
4570
+ :type credential_name: str
3718
4571
  :param sort: Defines the attribute by which the returned synthetic tests will be ordered by. Order using '+' means ASC and '-' means DESC
3719
4572
  :type sort: str
3720
4573
  :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic tests
@@ -3748,6 +4601,7 @@ class SyntheticSettingsApi:
3748
4601
  _param = self._get_synthetic_tests_serialize(
3749
4602
  application_id=application_id,
3750
4603
  location_id=location_id,
4604
+ credential_name=credential_name,
3751
4605
  sort=sort,
3752
4606
  offset=offset,
3753
4607
  limit=limit,
@@ -3780,6 +4634,7 @@ class SyntheticSettingsApi:
3780
4634
  self,
3781
4635
  application_id: Annotated[Optional[StrictStr], Field(description="Defines the application id by which the returned synthetic tests will be filtered by. ")] = None,
3782
4636
  location_id: Annotated[Optional[StrictStr], Field(description="Defines the location id by which the returned synthetic tests will be filtered by. ")] = None,
4637
+ credential_name: Annotated[Optional[StrictStr], Field(description="Defines the credential name by which the returned synthetic tests will be filtered by. ")] = None,
3783
4638
  sort: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Defines the attribute by which the returned synthetic tests will be ordered by. Order using '+' means ASC and '-' means DESC")] = None,
3784
4639
  offset: Annotated[Optional[StrictInt], Field(description="Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic tests")] = None,
3785
4640
  limit: Annotated[Optional[StrictInt], Field(description="Defines the size of a page - the number of synthetic tests that will be returned by the query")] = None,
@@ -3799,12 +4654,14 @@ class SyntheticSettingsApi:
3799
4654
  ) -> RESTResponseType:
3800
4655
  """All Synthetic tests
3801
4656
 
3802
- This endpoint retrieves Synthetic Tests. ## Optional Parameters: - **locationId** Filters the Synthetic Tests to retrieve only the ones that are associated to the specified PoP location ID. - **filter** Filters the Synthetic Tests to retrieve only the ones that match the specified filter condition. Users are allowed to specify more than one filter parameter, and they will be combined in a single expression using logical operator 'AND'. The filter parameter is formatted as '**_{\\<attribute>\\<operator>\\<value}_**'. For example, '_{label=MyTest}_' ### Supported filter attributes and operators: | | = | != | \\> | < | \\>= | <= | Example | |-|---|----|---|---|---|-|---------| | label | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={label=ABC} | | description | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={description=MyTest} | | active | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={active=true} | | testFrequency | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={testFrequency=5} | | applicationId | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={applicationId=APP_ID} | | locations | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={locations=POP_ID} | | locationLabels | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={locationLabels=MyPoP} | | locationDisplayLabels | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={locationDisplayLabels=My PoP} | | configuration.\\<any property of type string> | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={configurtion.syntheticType=HTTPAction} | | customProperties.\\<all properties> | &check; | &check; | - | - | - | - | /api/synthetics/settings/tests?filter={customProperty.usage=Test} | | createdAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/tests?filter={createdAt>1715190462000} | | modifiedAt | &check; | &check; | &check; | &check; | &check; | &check; | /api/synthetics/settings/tests?filter={modifiedAt<=1715190462000} |
4657
+ API request to retrieve Synthetic Tests. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3803
4658
 
3804
4659
  :param application_id: Defines the application id by which the returned synthetic tests will be filtered by.
3805
4660
  :type application_id: str
3806
4661
  :param location_id: Defines the location id by which the returned synthetic tests will be filtered by.
3807
4662
  :type location_id: str
4663
+ :param credential_name: Defines the credential name by which the returned synthetic tests will be filtered by.
4664
+ :type credential_name: str
3808
4665
  :param sort: Defines the attribute by which the returned synthetic tests will be ordered by. Order using '+' means ASC and '-' means DESC
3809
4666
  :type sort: str
3810
4667
  :param offset: Used in conjunction with limit. Defines how many pages will be skipped before returning the synthetic tests
@@ -3838,6 +4695,7 @@ class SyntheticSettingsApi:
3838
4695
  _param = self._get_synthetic_tests_serialize(
3839
4696
  application_id=application_id,
3840
4697
  location_id=location_id,
4698
+ credential_name=credential_name,
3841
4699
  sort=sort,
3842
4700
  offset=offset,
3843
4701
  limit=limit,
@@ -3865,6 +4723,7 @@ class SyntheticSettingsApi:
3865
4723
  self,
3866
4724
  application_id,
3867
4725
  location_id,
4726
+ credential_name,
3868
4727
  sort,
3869
4728
  offset,
3870
4729
  limit,
@@ -3899,6 +4758,10 @@ class SyntheticSettingsApi:
3899
4758
 
3900
4759
  _query_params.append(('locationId', location_id))
3901
4760
 
4761
+ if credential_name is not None:
4762
+
4763
+ _query_params.append(('credentialName', credential_name))
4764
+
3902
4765
  if sort is not None:
3903
4766
 
3904
4767
  _query_params.append(('sort', sort))
@@ -3970,8 +4833,9 @@ class SyntheticSettingsApi:
3970
4833
  _headers: Optional[Dict[StrictStr, Any]] = None,
3971
4834
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3972
4835
  ) -> None:
3973
- """Patch a Synthetic Credential
4836
+ """Patch a Synthetic credential
3974
4837
 
4838
+ API request to patch attributes of a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
3975
4839
 
3976
4840
  :param name: Name of the credential to be patched (required)
3977
4841
  :type name: str
@@ -4043,8 +4907,9 @@ class SyntheticSettingsApi:
4043
4907
  _headers: Optional[Dict[StrictStr, Any]] = None,
4044
4908
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4045
4909
  ) -> ApiResponse[None]:
4046
- """Patch a Synthetic Credential
4910
+ """Patch a Synthetic credential
4047
4911
 
4912
+ API request to patch attributes of a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
4048
4913
 
4049
4914
  :param name: Name of the credential to be patched (required)
4050
4915
  :type name: str
@@ -4116,8 +4981,9 @@ class SyntheticSettingsApi:
4116
4981
  _headers: Optional[Dict[StrictStr, Any]] = None,
4117
4982
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4118
4983
  ) -> RESTResponseType:
4119
- """Patch a Synthetic Credential
4984
+ """Patch a Synthetic credential
4120
4985
 
4986
+ API request to patch attributes of a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
4121
4987
 
4122
4988
  :param name: Name of the credential to be patched (required)
4123
4989
  :type name: str
@@ -4267,7 +5133,7 @@ class SyntheticSettingsApi:
4267
5133
  ) -> None:
4268
5134
  """Patch a Synthetic test
4269
5135
 
4270
- This API endpoint updates selected attributes of a Synthetic Test. - All attributes listed as in the schema, including the required ones, are optional for this call. - Synthetic Test configuration properties set to null will be removed from the configuration. - Patching an array attribute will replace the entire array with the full set of values provided. - For major updates to the Synthetic Test or to remove main attributes, see \"Update a Synthetic test\" ## Sample script and payload: - A sample script to patch a simple HTTP Script Test to enable it and to switch from multi-scripts to single script. ``` curl -k -v -X PATCH \\ https://<Host>/api/synthetics/settings/tests/Ilfs9bW97KkTxuyGtxBF \\ -H 'authorization: apiToken <Token>' \\ -H 'content-type: application/json' \\ -d '{ \"active\" : true, \"configuration\" : { \"scripts\" : null, \"script\" : \"//script goes here\" } }' ```
5136
+ API request to update a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
4271
5137
 
4272
5138
  :param id: Id of the synthetic test to be patched (required)
4273
5139
  :type id: str
@@ -4342,7 +5208,7 @@ class SyntheticSettingsApi:
4342
5208
  ) -> ApiResponse[None]:
4343
5209
  """Patch a Synthetic test
4344
5210
 
4345
- This API endpoint updates selected attributes of a Synthetic Test. - All attributes listed as in the schema, including the required ones, are optional for this call. - Synthetic Test configuration properties set to null will be removed from the configuration. - Patching an array attribute will replace the entire array with the full set of values provided. - For major updates to the Synthetic Test or to remove main attributes, see \"Update a Synthetic test\" ## Sample script and payload: - A sample script to patch a simple HTTP Script Test to enable it and to switch from multi-scripts to single script. ``` curl -k -v -X PATCH \\ https://<Host>/api/synthetics/settings/tests/Ilfs9bW97KkTxuyGtxBF \\ -H 'authorization: apiToken <Token>' \\ -H 'content-type: application/json' \\ -d '{ \"active\" : true, \"configuration\" : { \"scripts\" : null, \"script\" : \"//script goes here\" } }' ```
5211
+ API request to update a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
4346
5212
 
4347
5213
  :param id: Id of the synthetic test to be patched (required)
4348
5214
  :type id: str
@@ -4417,7 +5283,7 @@ class SyntheticSettingsApi:
4417
5283
  ) -> RESTResponseType:
4418
5284
  """Patch a Synthetic test
4419
5285
 
4420
- This API endpoint updates selected attributes of a Synthetic Test. - All attributes listed as in the schema, including the required ones, are optional for this call. - Synthetic Test configuration properties set to null will be removed from the configuration. - Patching an array attribute will replace the entire array with the full set of values provided. - For major updates to the Synthetic Test or to remove main attributes, see \"Update a Synthetic test\" ## Sample script and payload: - A sample script to patch a simple HTTP Script Test to enable it and to switch from multi-scripts to single script. ``` curl -k -v -X PATCH \\ https://<Host>/api/synthetics/settings/tests/Ilfs9bW97KkTxuyGtxBF \\ -H 'authorization: apiToken <Token>' \\ -H 'content-type: application/json' \\ -d '{ \"active\" : true, \"configuration\" : { \"scripts\" : null, \"script\" : \"//script goes here\" } }' ```
5286
+ API request to update a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
4421
5287
 
4422
5288
  :param id: Id of the synthetic test to be patched (required)
4423
5289
  :type id: str
@@ -4566,9 +5432,9 @@ class SyntheticSettingsApi:
4566
5432
  _headers: Optional[Dict[StrictStr, Any]] = None,
4567
5433
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4568
5434
  ) -> None:
4569
- """Update a Synthetic Credential
5435
+ """Update a Synthetic credential
4570
5436
 
4571
- API request to update Synthetic Credentials.
5437
+ API request to update a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
4572
5438
 
4573
5439
  :param name: Name of the credential to be updated (required)
4574
5440
  :type name: str
@@ -4606,7 +5472,7 @@ class SyntheticSettingsApi:
4606
5472
  )
4607
5473
 
4608
5474
  _response_types_map: Dict[str, Optional[str]] = {
4609
- '200': None,
5475
+ '201': None,
4610
5476
  '401': None,
4611
5477
  '403': None,
4612
5478
  '500': None,
@@ -4640,9 +5506,9 @@ class SyntheticSettingsApi:
4640
5506
  _headers: Optional[Dict[StrictStr, Any]] = None,
4641
5507
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4642
5508
  ) -> ApiResponse[None]:
4643
- """Update a Synthetic Credential
5509
+ """Update a Synthetic credential
4644
5510
 
4645
- API request to update Synthetic Credentials.
5511
+ API request to update a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
4646
5512
 
4647
5513
  :param name: Name of the credential to be updated (required)
4648
5514
  :type name: str
@@ -4680,7 +5546,7 @@ class SyntheticSettingsApi:
4680
5546
  )
4681
5547
 
4682
5548
  _response_types_map: Dict[str, Optional[str]] = {
4683
- '200': None,
5549
+ '201': None,
4684
5550
  '401': None,
4685
5551
  '403': None,
4686
5552
  '500': None,
@@ -4714,9 +5580,9 @@ class SyntheticSettingsApi:
4714
5580
  _headers: Optional[Dict[StrictStr, Any]] = None,
4715
5581
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4716
5582
  ) -> RESTResponseType:
4717
- """Update a Synthetic Credential
5583
+ """Update a Synthetic credential
4718
5584
 
4719
- API request to update Synthetic Credentials.
5585
+ API request to update a Synthetic Credential. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
4720
5586
 
4721
5587
  :param name: Name of the credential to be updated (required)
4722
5588
  :type name: str
@@ -4754,7 +5620,7 @@ class SyntheticSettingsApi:
4754
5620
  )
4755
5621
 
4756
5622
  _response_types_map: Dict[str, Optional[str]] = {
4757
- '200': None,
5623
+ '201': None,
4758
5624
  '401': None,
4759
5625
  '403': None,
4760
5626
  '500': None,
@@ -4866,6 +5732,7 @@ class SyntheticSettingsApi:
4866
5732
  ) -> None:
4867
5733
  """Update a Synthetic test
4868
5734
 
5735
+ API request to update a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
4869
5736
 
4870
5737
  :param id: Id of the synthetic test to be updated (required)
4871
5738
  :type id: str
@@ -4940,6 +5807,7 @@ class SyntheticSettingsApi:
4940
5807
  ) -> ApiResponse[None]:
4941
5808
  """Update a Synthetic test
4942
5809
 
5810
+ API request to update a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
4943
5811
 
4944
5812
  :param id: Id of the synthetic test to be updated (required)
4945
5813
  :type id: str
@@ -5014,6 +5882,7 @@ class SyntheticSettingsApi:
5014
5882
  ) -> RESTResponseType:
5015
5883
  """Update a Synthetic test
5016
5884
 
5885
+ API request to update a Synthetic Test. For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings.
5017
5886
 
5018
5887
  :param id: Id of the synthetic test to be updated (required)
5019
5888
  :type id: str