instana-client 1.0.0__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 (515) hide show
  1. instana_client/__init__.py +534 -0
  2. instana_client/api/__init__.py +58 -0
  3. instana_client/api/action_catalog_api.py +1380 -0
  4. instana_client/api/action_history_api.py +1793 -0
  5. instana_client/api/apdex_report_api.py +338 -0
  6. instana_client/api/apdex_settings_api.py +1353 -0
  7. instana_client/api/api_token_api.py +1370 -0
  8. instana_client/api/application_alert_configuration_api.py +2865 -0
  9. instana_client/api/application_analyze_api.py +2017 -0
  10. instana_client/api/application_catalog_api.py +885 -0
  11. instana_client/api/application_metrics_api.py +1211 -0
  12. instana_client/api/application_resources_api.py +1487 -0
  13. instana_client/api/application_settings_api.py +7261 -0
  14. instana_client/api/application_topology_api.py +354 -0
  15. instana_client/api/audit_log_api.py +635 -0
  16. instana_client/api/authentication_api.py +1008 -0
  17. instana_client/api/business_monitoring_api.py +2177 -0
  18. instana_client/api/custom_dashboards_api.py +1930 -0
  19. instana_client/api/event_settings_api.py +14613 -0
  20. instana_client/api/events_api.py +1654 -0
  21. instana_client/api/global_application_alert_configuration_api.py +2606 -0
  22. instana_client/api/groups_api.py +4078 -0
  23. instana_client/api/health_api.py +527 -0
  24. instana_client/api/host_agent_api.py +2120 -0
  25. instana_client/api/infrastructure_alert_configuration_api.py +2524 -0
  26. instana_client/api/infrastructure_analyze_api.py +1141 -0
  27. instana_client/api/infrastructure_catalog_api.py +1822 -0
  28. instana_client/api/infrastructure_metrics_api.py +331 -0
  29. instana_client/api/infrastructure_resources_api.py +1880 -0
  30. instana_client/api/infrastructure_topology_api.py +595 -0
  31. instana_client/api/log_alert_configuration_api.py +2524 -0
  32. instana_client/api/maintenance_configuration_api.py +2683 -0
  33. instana_client/api/mobile_app_analyze_api.py +613 -0
  34. instana_client/api/mobile_app_catalog_api.py +825 -0
  35. instana_client/api/mobile_app_configuration_api.py +2847 -0
  36. instana_client/api/mobile_app_metrics_api.py +892 -0
  37. instana_client/api/policies_api.py +1755 -0
  38. instana_client/api/releases_api.py +1408 -0
  39. instana_client/api/service_levels_alert_configuration_api.py +2577 -0
  40. instana_client/api/service_levels_objective_slo_configurations_api.py +1825 -0
  41. instana_client/api/service_levels_objective_slo_report_api.py +335 -0
  42. instana_client/api/session_settings_api.py +801 -0
  43. instana_client/api/sli_report_api.py +352 -0
  44. instana_client/api/sli_settings_api.py +2677 -0
  45. instana_client/api/synthetic_alert_configuration_api.py +2606 -0
  46. instana_client/api/synthetic_calls_api.py +789 -0
  47. instana_client/api/synthetic_catalog_api.py +543 -0
  48. instana_client/api/synthetic_metrics_api.py +322 -0
  49. instana_client/api/synthetic_settings_api.py +5144 -0
  50. instana_client/api/synthetic_test_playback_results_api.py +2142 -0
  51. instana_client/api/usage_api.py +1404 -0
  52. instana_client/api/user_api.py +2404 -0
  53. instana_client/api/website_analyze_api.py +619 -0
  54. instana_client/api/website_catalog_api.py +832 -0
  55. instana_client/api/website_configuration_api.py +3745 -0
  56. instana_client/api/website_metrics_api.py +889 -0
  57. instana_client/api_client.py +798 -0
  58. instana_client/api_response.py +21 -0
  59. instana_client/configuration.py +616 -0
  60. instana_client/exceptions.py +217 -0
  61. instana_client/models/__init__.py +464 -0
  62. instana_client/models/abstract_integration.py +155 -0
  63. instana_client/models/abstract_rule.py +124 -0
  64. instana_client/models/access_log_entry.py +105 -0
  65. instana_client/models/access_log_response.py +98 -0
  66. instana_client/models/access_rule.py +107 -0
  67. instana_client/models/action.py +135 -0
  68. instana_client/models/action_configuration.py +104 -0
  69. instana_client/models/action_instance.py +185 -0
  70. instana_client/models/action_instance_metadata_entry.py +90 -0
  71. instana_client/models/action_instance_parameter.py +94 -0
  72. instana_client/models/action_instance_request.py +108 -0
  73. instana_client/models/action_instance_request_parameters.py +92 -0
  74. instana_client/models/action_match.py +98 -0
  75. instana_client/models/action_search_space.py +94 -0
  76. instana_client/models/adaptive_baseline.py +92 -0
  77. instana_client/models/adaptive_threshold_rule.py +91 -0
  78. instana_client/models/adjusted_timeframe.py +91 -0
  79. instana_client/models/agent_configuration_update.py +93 -0
  80. instana_client/models/alerting_configuration.py +113 -0
  81. instana_client/models/alerting_configuration_with_last_updated.py +115 -0
  82. instana_client/models/alerting_time_window.py +109 -0
  83. instana_client/models/apdex_configuration.py +99 -0
  84. instana_client/models/apdex_configuration_input.py +95 -0
  85. instana_client/models/apdex_entity.py +119 -0
  86. instana_client/models/apdex_report.py +94 -0
  87. instana_client/models/api_create_group.py +104 -0
  88. instana_client/models/api_group.py +107 -0
  89. instana_client/models/api_member.py +90 -0
  90. instana_client/models/api_permission_set.py +178 -0
  91. instana_client/models/api_restricted_application_filter.py +108 -0
  92. instana_client/models/api_token.py +250 -0
  93. instana_client/models/app_data_metric_configuration.py +105 -0
  94. instana_client/models/application.py +104 -0
  95. instana_client/models/application_alert_config.py +203 -0
  96. instana_client/models/application_alert_config_with_metadata.py +213 -0
  97. instana_client/models/application_alert_rule.py +135 -0
  98. instana_client/models/application_apdex_entity.py +111 -0
  99. instana_client/models/application_config.py +131 -0
  100. instana_client/models/application_event_result.py +108 -0
  101. instana_client/models/application_item.py +94 -0
  102. instana_client/models/application_metric_result.py +109 -0
  103. instana_client/models/application_node.py +106 -0
  104. instana_client/models/application_result.py +102 -0
  105. instana_client/models/application_scope.py +89 -0
  106. instana_client/models/application_scope_with_metadata.py +90 -0
  107. instana_client/models/application_sli_entity.py +103 -0
  108. instana_client/models/application_slo_entity.py +112 -0
  109. instana_client/models/application_time_threshold.py +115 -0
  110. instana_client/models/audit_log_entry.py +102 -0
  111. instana_client/models/audit_log_ui_response.py +98 -0
  112. instana_client/models/author.py +100 -0
  113. instana_client/models/availability_blueprint_indicator.py +106 -0
  114. instana_client/models/availability_sli_entity.py +138 -0
  115. instana_client/models/available_metrics.py +96 -0
  116. instana_client/models/available_plugins.py +88 -0
  117. instana_client/models/backend_trace_reference.py +88 -0
  118. instana_client/models/binary_operator_dto.py +107 -0
  119. instana_client/models/browser_script_configuration.py +127 -0
  120. instana_client/models/built_in_event_specification.py +123 -0
  121. instana_client/models/built_in_event_specification_with_last_updated.py +125 -0
  122. instana_client/models/business_activity.py +132 -0
  123. instana_client/models/business_perspective_config.py +99 -0
  124. instana_client/models/call_groups_item.py +95 -0
  125. instana_client/models/call_groups_result.py +111 -0
  126. instana_client/models/call_relation.py +100 -0
  127. instana_client/models/change_summary.py +101 -0
  128. instana_client/models/cloudfoundry_physical_context.py +104 -0
  129. instana_client/models/condition.py +88 -0
  130. instana_client/models/config_version.py +101 -0
  131. instana_client/models/crash_mobile_app_alert_rule.py +90 -0
  132. instana_client/models/cursor_paginated_business_activity_item.py +96 -0
  133. instana_client/models/cursor_pagination.py +93 -0
  134. instana_client/models/cursor_pagination_infra_explore_cursor.py +90 -0
  135. instana_client/models/custom_blueprint_indicator.py +104 -0
  136. instana_client/models/custom_dashboard.py +111 -0
  137. instana_client/models/custom_dashboard_preview.py +103 -0
  138. instana_client/models/custom_email_subject_prefix.py +94 -0
  139. instana_client/models/custom_event_mobile_app_alert_rule.py +92 -0
  140. instana_client/models/custom_event_specification.py +133 -0
  141. instana_client/models/custom_event_specification_with_last_updated.py +143 -0
  142. instana_client/models/custom_event_website_alert_rule.py +92 -0
  143. instana_client/models/custom_payload_configuration.py +97 -0
  144. instana_client/models/custom_payload_field.py +112 -0
  145. instana_client/models/custom_payload_with_last_updated.py +99 -0
  146. instana_client/models/dashboard_api_token.py +90 -0
  147. instana_client/models/database_integration.py +90 -0
  148. instana_client/models/deprecated_tag_filter.py +111 -0
  149. instana_client/models/dns_action_configuration.py +134 -0
  150. instana_client/models/dns_action_filter_query_time.py +99 -0
  151. instana_client/models/dns_action_filter_target_value.py +106 -0
  152. instana_client/models/duration.py +98 -0
  153. instana_client/models/dynamic_field.py +95 -0
  154. instana_client/models/dynamic_field_value.py +90 -0
  155. instana_client/models/dynamic_parameter.py +94 -0
  156. instana_client/models/edit_user.py +88 -0
  157. instana_client/models/email_integration.py +98 -0
  158. instana_client/models/empty_configuration.py +92 -0
  159. instana_client/models/endpoint.py +131 -0
  160. instana_client/models/endpoint_config.py +112 -0
  161. instana_client/models/endpoint_event_result.py +112 -0
  162. instana_client/models/endpoint_item.py +94 -0
  163. instana_client/models/endpoint_metric_result.py +109 -0
  164. instana_client/models/endpoint_node.py +91 -0
  165. instana_client/models/endpoint_result.py +102 -0
  166. instana_client/models/endpoint_simple.py +102 -0
  167. instana_client/models/entity_count_rule.py +100 -0
  168. instana_client/models/entity_count_verification_rule.py +114 -0
  169. instana_client/models/entity_health_info.py +99 -0
  170. instana_client/models/entity_id.py +92 -0
  171. instana_client/models/entity_verification_rule.py +105 -0
  172. instana_client/models/error_budget_alert_rule.py +97 -0
  173. instana_client/models/errors_application_alert_rule.py +90 -0
  174. instana_client/models/event.py +127 -0
  175. instana_client/models/event_filtering_configuration.py +106 -0
  176. instana_client/models/event_result.py +145 -0
  177. instana_client/models/event_specification_info.py +114 -0
  178. instana_client/models/extended_service.py +123 -0
  179. instana_client/models/failure_synthetic_alert_rule.py +90 -0
  180. instana_client/models/fixed_http_path_segment_matching_rule.py +90 -0
  181. instana_client/models/fixed_time_window.py +93 -0
  182. instana_client/models/full_trace.py +97 -0
  183. instana_client/models/generic_infra_alert_rule.py +93 -0
  184. instana_client/models/geo_location_configuration.py +106 -0
  185. instana_client/models/geo_mapping_rule.py +120 -0
  186. instana_client/models/geo_subdivision.py +91 -0
  187. instana_client/models/get_activities.py +115 -0
  188. instana_client/models/get_application_metrics.py +112 -0
  189. instana_client/models/get_applications.py +150 -0
  190. instana_client/models/get_available_metrics_query.py +103 -0
  191. instana_client/models/get_available_plugins_query.py +98 -0
  192. instana_client/models/get_call_groups.py +141 -0
  193. instana_client/models/get_combined_metrics.py +103 -0
  194. instana_client/models/get_dynamic_parameter_values.py +100 -0
  195. instana_client/models/get_endpoints.py +150 -0
  196. instana_client/models/get_infrastructure_groups_query.py +127 -0
  197. instana_client/models/get_infrastructure_query.py +127 -0
  198. instana_client/models/get_metrics_result.py +128 -0
  199. instana_client/models/get_mobile_app_beacon_groups.py +146 -0
  200. instana_client/models/get_mobile_app_beacons.py +118 -0
  201. instana_client/models/get_mobile_app_metrics.py +122 -0
  202. instana_client/models/get_mobile_app_metrics_v2.py +118 -0
  203. instana_client/models/get_payload_keys_result.py +88 -0
  204. instana_client/models/get_services.py +147 -0
  205. instana_client/models/get_snapshots_query.py +95 -0
  206. instana_client/models/get_test_result.py +139 -0
  207. instana_client/models/get_test_result_base.py +120 -0
  208. instana_client/models/get_test_result_list.py +125 -0
  209. instana_client/models/get_test_summary_result.py +130 -0
  210. instana_client/models/get_trace_download_result_item.py +114 -0
  211. instana_client/models/get_trace_groups.py +141 -0
  212. instana_client/models/get_traces.py +125 -0
  213. instana_client/models/get_website_beacon_groups.py +146 -0
  214. instana_client/models/get_website_beacons.py +118 -0
  215. instana_client/models/get_website_metrics.py +122 -0
  216. instana_client/models/get_website_metrics_v2.py +118 -0
  217. instana_client/models/global_application_alert_config_with_metadata.py +205 -0
  218. instana_client/models/global_applications_alert_config.py +191 -0
  219. instana_client/models/google_chat_integration.py +92 -0
  220. instana_client/models/graph_edge.py +102 -0
  221. instana_client/models/graph_node.py +100 -0
  222. instana_client/models/group.py +100 -0
  223. instana_client/models/group_by_tag.py +90 -0
  224. instana_client/models/group_mapping.py +95 -0
  225. instana_client/models/health_state.py +100 -0
  226. instana_client/models/historic_baseline.py +105 -0
  227. instana_client/models/host_availability_rule.py +100 -0
  228. instana_client/models/http_action_configuration.py +127 -0
  229. instana_client/models/http_endpoint_config.py +103 -0
  230. instana_client/models/http_endpoint_rule.py +101 -0
  231. instana_client/models/http_path_segment_matching_rule.py +124 -0
  232. instana_client/models/http_script_configuration.py +113 -0
  233. instana_client/models/hyper_param.py +111 -0
  234. instana_client/models/identity_provider_patch.py +88 -0
  235. instana_client/models/infra_alert_config.py +166 -0
  236. instana_client/models/infra_alert_config_with_metadata.py +176 -0
  237. instana_client/models/infra_alert_rule.py +133 -0
  238. instana_client/models/infra_event_result.py +109 -0
  239. instana_client/models/infra_metric_configuration.py +115 -0
  240. instana_client/models/infra_time_threshold.py +109 -0
  241. instana_client/models/infrastructure_entities_result.py +109 -0
  242. instana_client/models/infrastructure_group.py +92 -0
  243. instana_client/models/infrastructure_groups_result.py +109 -0
  244. instana_client/models/infrastructure_item.py +104 -0
  245. instana_client/models/infrastructure_metric_result.py +96 -0
  246. instana_client/models/instana_version_info.py +92 -0
  247. instana_client/models/integration_overview.py +94 -0
  248. instana_client/models/invitation.py +94 -0
  249. instana_client/models/invitation_response.py +96 -0
  250. instana_client/models/invitation_result.py +100 -0
  251. instana_client/models/ip_masking_configuration.py +95 -0
  252. instana_client/models/js_stack_trace_line.py +99 -0
  253. instana_client/models/kubernetes_physical_context.py +107 -0
  254. instana_client/models/latency_blueprint_indicator.py +106 -0
  255. instana_client/models/location_status.py +96 -0
  256. instana_client/models/log_alert_config.py +154 -0
  257. instana_client/models/log_alert_config_with_metadata.py +164 -0
  258. instana_client/models/log_alert_rule.py +120 -0
  259. instana_client/models/log_count_alert_rule.py +90 -0
  260. instana_client/models/log_entry_actor.py +101 -0
  261. instana_client/models/log_event_result.py +107 -0
  262. instana_client/models/log_time_threshold.py +109 -0
  263. instana_client/models/logs_application_alert_rule.py +122 -0
  264. instana_client/models/maintenance_config.py +103 -0
  265. instana_client/models/maintenance_config_scheduling.py +118 -0
  266. instana_client/models/maintenance_config_v2.py +111 -0
  267. instana_client/models/maintenance_config_v2_with_state_and_occurrence.py +131 -0
  268. instana_client/models/maintenance_config_with_last_updated.py +105 -0
  269. instana_client/models/maintenance_window.py +93 -0
  270. instana_client/models/manual_alerting_channel_configuration.py +99 -0
  271. instana_client/models/manual_close_info.py +99 -0
  272. instana_client/models/manual_service_config.py +103 -0
  273. instana_client/models/match_all_http_path_segment_matching_rule.py +88 -0
  274. instana_client/models/match_expression_dto.py +111 -0
  275. instana_client/models/meta_data.py +96 -0
  276. instana_client/models/metric_api_result.py +94 -0
  277. instana_client/models/metric_config.py +99 -0
  278. instana_client/models/metric_configuration.py +103 -0
  279. instana_client/models/metric_description.py +116 -0
  280. instana_client/models/metric_instance.py +105 -0
  281. instana_client/models/metric_item.py +102 -0
  282. instana_client/models/metric_metadata.py +132 -0
  283. instana_client/models/metric_pattern.py +101 -0
  284. instana_client/models/metrics_result.py +96 -0
  285. instana_client/models/metrics_result_item.py +100 -0
  286. instana_client/models/metrics_test_result_item.py +102 -0
  287. instana_client/models/mobile_app.py +91 -0
  288. instana_client/models/mobile_app_alert_config.py +162 -0
  289. instana_client/models/mobile_app_alert_rule.py +129 -0
  290. instana_client/models/mobile_app_beacon_groups_item.py +95 -0
  291. instana_client/models/mobile_app_beacon_groups_result.py +111 -0
  292. instana_client/models/mobile_app_beacon_result.py +111 -0
  293. instana_client/models/mobile_app_beacon_tag_group.py +100 -0
  294. instana_client/models/mobile_app_beacons_item.py +94 -0
  295. instana_client/models/mobile_app_event_result.py +108 -0
  296. instana_client/models/mobile_app_metric_result.py +88 -0
  297. instana_client/models/mobile_app_monitoring_beacon.py +259 -0
  298. instana_client/models/mobile_app_monitoring_metric_description.py +123 -0
  299. instana_client/models/mobile_app_monitoring_metrics_configuration.py +105 -0
  300. instana_client/models/mobile_app_time_threshold.py +115 -0
  301. instana_client/models/model_field.py +96 -0
  302. instana_client/models/monitoring_state.py +92 -0
  303. instana_client/models/multiple_scripts_configuration.py +90 -0
  304. instana_client/models/new_application_config.py +129 -0
  305. instana_client/models/new_business_perspective_config.py +97 -0
  306. instana_client/models/new_manual_service_config.py +100 -0
  307. instana_client/models/occurrence.py +91 -0
  308. instana_client/models/office365_integration.py +92 -0
  309. instana_client/models/one_time_maintenance_window.py +94 -0
  310. instana_client/models/opsgenie_integration.py +105 -0
  311. instana_client/models/order.py +99 -0
  312. instana_client/models/pagerduty_integration.py +92 -0
  313. instana_client/models/paginated_result.py +95 -0
  314. instana_client/models/pagination.py +91 -0
  315. instana_client/models/parameter.py +102 -0
  316. instana_client/models/parameter_value.py +90 -0
  317. instana_client/models/path_parameter_http_path_segment_matching_rule.py +90 -0
  318. instana_client/models/physical_context.py +119 -0
  319. instana_client/models/plugin_result.py +90 -0
  320. instana_client/models/policy.py +113 -0
  321. instana_client/models/policy_runnable.py +103 -0
  322. instana_client/models/post_snapshots_result.py +98 -0
  323. instana_client/models/problem.py +95 -0
  324. instana_client/models/prometheus_webhook_integration.py +94 -0
  325. instana_client/models/recurrent_maintenance_window.py +98 -0
  326. instana_client/models/release.py +111 -0
  327. instana_client/models/release_scope.py +94 -0
  328. instana_client/models/release_with_metadata.py +125 -0
  329. instana_client/models/rolling_time_window.py +90 -0
  330. instana_client/models/rule_input.py +98 -0
  331. instana_client/models/rule_with_threshold_application_alert_rule.py +116 -0
  332. instana_client/models/rule_with_threshold_infra_alert_rule.py +116 -0
  333. instana_client/models/rule_with_threshold_log_alert_rule.py +116 -0
  334. instana_client/models/rule_with_threshold_mobile_app_alert_rule.py +116 -0
  335. instana_client/models/rule_with_threshold_website_alert_rule.py +116 -0
  336. instana_client/models/run_configuration.py +96 -0
  337. instana_client/models/salesforce_integration.py +98 -0
  338. instana_client/models/scope_binding.py +91 -0
  339. instana_client/models/search_field_result.py +116 -0
  340. instana_client/models/service.py +116 -0
  341. instana_client/models/service_config.py +107 -0
  342. instana_client/models/service_event_result.py +110 -0
  343. instana_client/models/service_item.py +94 -0
  344. instana_client/models/service_level_indicator.py +172 -0
  345. instana_client/models/service_level_objective_alert_rule.py +100 -0
  346. instana_client/models/service_level_objective_configuration.py +118 -0
  347. instana_client/models/service_levels_alert_config.py +133 -0
  348. instana_client/models/service_levels_alert_rule.py +111 -0
  349. instana_client/models/service_levels_burn_rate_time_windows.py +97 -0
  350. instana_client/models/service_levels_time_threshold.py +90 -0
  351. instana_client/models/service_levelse_alert_config_with_metadata.py +143 -0
  352. instana_client/models/service_map.py +106 -0
  353. instana_client/models/service_map_connection.py +97 -0
  354. instana_client/models/service_matching_rule.py +90 -0
  355. instana_client/models/service_metric_result.py +109 -0
  356. instana_client/models/service_node.py +106 -0
  357. instana_client/models/service_now_enhanced_integration.py +116 -0
  358. instana_client/models/service_now_integration.py +98 -0
  359. instana_client/models/service_result.py +102 -0
  360. instana_client/models/service_scope.py +95 -0
  361. instana_client/models/service_scope_with_metadata.py +96 -0
  362. instana_client/models/service_scoped_to.py +97 -0
  363. instana_client/models/service_scoped_to_with_metadata.py +97 -0
  364. instana_client/models/service_simple.py +90 -0
  365. instana_client/models/session_settings.py +91 -0
  366. instana_client/models/slack_integration.py +98 -0
  367. instana_client/models/sli_configuration.py +105 -0
  368. instana_client/models/sli_configuration_with_last_updated.py +107 -0
  369. instana_client/models/sli_entity.py +117 -0
  370. instana_client/models/sli_report.py +100 -0
  371. instana_client/models/slo_entity.py +119 -0
  372. instana_client/models/slo_report.py +112 -0
  373. instana_client/models/slowness_application_alert_rule.py +90 -0
  374. instana_client/models/slowness_website_alert_rule.py +90 -0
  375. instana_client/models/snapshot_item.py +102 -0
  376. instana_client/models/snapshot_preview.py +97 -0
  377. instana_client/models/snapshot_result.py +96 -0
  378. instana_client/models/software_user.py +94 -0
  379. instana_client/models/software_version.py +124 -0
  380. instana_client/models/source_map_file_blob.py +92 -0
  381. instana_client/models/source_map_file_meta.py +115 -0
  382. instana_client/models/source_map_upload_config.py +106 -0
  383. instana_client/models/span.py +156 -0
  384. instana_client/models/span_excerpt.py +132 -0
  385. instana_client/models/span_relation.py +114 -0
  386. instana_client/models/specific_js_errors_website_alert_rule.py +101 -0
  387. instana_client/models/splunk_integration.py +94 -0
  388. instana_client/models/ssl_certificate_configuration.py +99 -0
  389. instana_client/models/stack_trace_item.py +92 -0
  390. instana_client/models/stack_trace_line.py +99 -0
  391. instana_client/models/static_baseline_threshold_rule.py +102 -0
  392. instana_client/models/static_string_field.py +91 -0
  393. instana_client/models/static_threshold.py +94 -0
  394. instana_client/models/static_threshold_rule.py +91 -0
  395. instana_client/models/status_code_application_alert_rule.py +95 -0
  396. instana_client/models/status_code_mobile_app_alert_rule.py +101 -0
  397. instana_client/models/status_code_website_alert_rule.py +101 -0
  398. instana_client/models/synthetic_alert_config.py +127 -0
  399. instana_client/models/synthetic_alert_config_with_metadata.py +137 -0
  400. instana_client/models/synthetic_alert_rule.py +120 -0
  401. instana_client/models/synthetic_call_config.py +99 -0
  402. instana_client/models/synthetic_call_rule.py +99 -0
  403. instana_client/models/synthetic_call_with_defaults_config.py +108 -0
  404. instana_client/models/synthetic_credential.py +111 -0
  405. instana_client/models/synthetic_datacenter.py +117 -0
  406. instana_client/models/synthetic_datacenter_configuration.py +88 -0
  407. instana_client/models/synthetic_geo_point.py +94 -0
  408. instana_client/models/synthetic_location.py +129 -0
  409. instana_client/models/synthetic_location_configuration.py +102 -0
  410. instana_client/models/synthetic_metric_configuration.py +99 -0
  411. instana_client/models/synthetic_metric_tag_group.py +100 -0
  412. instana_client/models/synthetic_playback_capabilities.py +98 -0
  413. instana_client/models/synthetic_slo_entity.py +95 -0
  414. instana_client/models/synthetic_test.py +149 -0
  415. instana_client/models/synthetic_time_threshold.py +110 -0
  416. instana_client/models/synthetic_type_configuration.py +141 -0
  417. instana_client/models/synthetics_event_result.py +110 -0
  418. instana_client/models/system_rule.py +91 -0
  419. instana_client/models/system_rule_label.py +90 -0
  420. instana_client/models/tag.py +123 -0
  421. instana_client/models/tag_catalog.py +106 -0
  422. instana_client/models/tag_filter.py +113 -0
  423. instana_client/models/tag_filter_expression.py +106 -0
  424. instana_client/models/tag_filter_expression_element.py +111 -0
  425. instana_client/models/tag_matcher_dto.py +110 -0
  426. instana_client/models/tag_tree_level.py +109 -0
  427. instana_client/models/tag_tree_node.py +113 -0
  428. instana_client/models/tag_tree_tag.py +103 -0
  429. instana_client/models/test_common_properties.py +136 -0
  430. instana_client/models/test_result.py +105 -0
  431. instana_client/models/test_result_common_properties.py +108 -0
  432. instana_client/models/test_result_detail_data.py +112 -0
  433. instana_client/models/test_result_item.py +106 -0
  434. instana_client/models/test_result_list_item.py +94 -0
  435. instana_client/models/test_result_list_result.py +103 -0
  436. instana_client/models/test_result_metadata.py +94 -0
  437. instana_client/models/test_result_subtransaction.py +90 -0
  438. instana_client/models/threshold.py +122 -0
  439. instana_client/models/threshold_config_rule.py +114 -0
  440. instana_client/models/threshold_rule.py +125 -0
  441. instana_client/models/throughput_application_alert_rule.py +90 -0
  442. instana_client/models/throughput_mobile_app_alert_rule.py +90 -0
  443. instana_client/models/throughput_website_alert_rule.py +90 -0
  444. instana_client/models/time_frame.py +91 -0
  445. instana_client/models/time_window.py +120 -0
  446. instana_client/models/topology.py +106 -0
  447. instana_client/models/trace.py +109 -0
  448. instana_client/models/trace_activity_tree_node_details.py +139 -0
  449. instana_client/models/trace_download_result.py +111 -0
  450. instana_client/models/trace_groups_item.py +95 -0
  451. instana_client/models/trace_groups_result.py +111 -0
  452. instana_client/models/trace_impact_application_time_threshold.py +92 -0
  453. instana_client/models/trace_item.py +94 -0
  454. instana_client/models/trace_result.py +111 -0
  455. instana_client/models/traffic_blueprint_indicator.py +104 -0
  456. instana_client/models/trigger.py +99 -0
  457. instana_client/models/type_configuration.py +107 -0
  458. instana_client/models/unsupported_http_path_segment_matching_rule.py +90 -0
  459. instana_client/models/updated_business_perspective_config.py +97 -0
  460. instana_client/models/usage_result.py +98 -0
  461. instana_client/models/usage_result_items.py +90 -0
  462. instana_client/models/user_basic_result.py +92 -0
  463. instana_client/models/user_impact_mobile_app_time_threshold.py +103 -0
  464. instana_client/models/user_impact_website_time_threshold.py +103 -0
  465. instana_client/models/user_result.py +98 -0
  466. instana_client/models/users_result.py +106 -0
  467. instana_client/models/validated_alerting_channel_input_info.py +123 -0
  468. instana_client/models/validated_alerting_configuration.py +121 -0
  469. instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py +135 -0
  470. instana_client/models/validated_maintenance_config_with_status.py +116 -0
  471. instana_client/models/victor_ops_integration.py +94 -0
  472. instana_client/models/violations_in_period_application_time_threshold.py +92 -0
  473. instana_client/models/violations_in_period_mobile_app_time_threshold.py +92 -0
  474. instana_client/models/violations_in_period_website_time_threshold.py +92 -0
  475. instana_client/models/violations_in_sequence_application_time_threshold.py +89 -0
  476. instana_client/models/violations_in_sequence_infra_time_threshold.py +89 -0
  477. instana_client/models/violations_in_sequence_log_time_threshold.py +89 -0
  478. instana_client/models/violations_in_sequence_mobile_app_time_threshold.py +89 -0
  479. instana_client/models/violations_in_sequence_synthetic_time_threshold.py +89 -0
  480. instana_client/models/violations_in_sequence_website_time_threshold.py +89 -0
  481. instana_client/models/watson_ai_ops_webhook_integration.py +94 -0
  482. instana_client/models/webex_teams_webhook_integration.py +92 -0
  483. instana_client/models/webhook_integration.py +94 -0
  484. instana_client/models/webpage_action_configuration.py +109 -0
  485. instana_client/models/webpage_script_configuration.py +109 -0
  486. instana_client/models/website.py +92 -0
  487. instana_client/models/website_alert_config.py +166 -0
  488. instana_client/models/website_alert_config_with_metadata.py +176 -0
  489. instana_client/models/website_alert_rule.py +132 -0
  490. instana_client/models/website_apdex_entity.py +107 -0
  491. instana_client/models/website_beacon_groups_item.py +95 -0
  492. instana_client/models/website_beacon_groups_result.py +111 -0
  493. instana_client/models/website_beacon_result.py +111 -0
  494. instana_client/models/website_beacon_tag_group.py +100 -0
  495. instana_client/models/website_beacons_item.py +94 -0
  496. instana_client/models/website_event_based_sli_entity.py +110 -0
  497. instana_client/models/website_event_result.py +108 -0
  498. instana_client/models/website_metric_result.py +88 -0
  499. instana_client/models/website_monitoring_beacon.py +301 -0
  500. instana_client/models/website_monitoring_metric_description.py +123 -0
  501. instana_client/models/website_monitoring_metrics_configuration.py +99 -0
  502. instana_client/models/website_slo_entity.py +104 -0
  503. instana_client/models/website_time_based_sli_entity.py +105 -0
  504. instana_client/models/website_time_threshold.py +115 -0
  505. instana_client/models/widget.py +103 -0
  506. instana_client/models/with_metadata.py +172 -0
  507. instana_client/models/with_resolved_name.py +102 -0
  508. instana_client/models/z_chat_ops_integration.py +97 -0
  509. instana_client/py.typed +0 -0
  510. instana_client/rest.py +258 -0
  511. instana_client-1.0.0.dist-info/METADATA +25 -0
  512. instana_client-1.0.0.dist-info/RECORD +515 -0
  513. instana_client-1.0.0.dist-info/WHEEL +5 -0
  514. instana_client-1.0.0.dist-info/licenses/LICENSE +202 -0
  515. instana_client-1.0.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,2120 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Instana REST API documentation
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 ```
7
+
8
+ The version of the OpenAPI document: 1.291.1002
9
+ Contact: support@instana.com
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+ import warnings
16
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
17
+ from typing import Any, Dict, List, Optional, Tuple, Union
18
+ from typing_extensions import Annotated
19
+
20
+ from pydantic import StrictBool, StrictInt, StrictStr
21
+ from typing import List, Optional
22
+ from instana_client.models.agent_configuration_update import AgentConfigurationUpdate
23
+ from instana_client.models.snapshot_item import SnapshotItem
24
+ from instana_client.models.snapshot_result import SnapshotResult
25
+
26
+ from instana_client.api_client import ApiClient, RequestSerialized
27
+ from instana_client.api_response import ApiResponse
28
+ from instana_client.rest import RESTResponseType
29
+
30
+
31
+ class HostAgentApi:
32
+ """NOTE: This class is auto generated by OpenAPI Generator
33
+ Ref: https://openapi-generator.tech
34
+
35
+ Do not edit the class manually.
36
+ """
37
+
38
+ def __init__(self, api_client=None) -> None:
39
+ if api_client is None:
40
+ api_client = ApiClient.get_default()
41
+ self.api_client = api_client
42
+
43
+
44
+ @validate_call
45
+ def get_agent_logs(
46
+ self,
47
+ host_id: StrictStr,
48
+ file: List[StrictStr],
49
+ download: Optional[StrictBool] = None,
50
+ _request_timeout: Union[
51
+ None,
52
+ Annotated[StrictFloat, Field(gt=0)],
53
+ Tuple[
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Annotated[StrictFloat, Field(gt=0)]
56
+ ]
57
+ ] = None,
58
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
59
+ _content_type: Optional[StrictStr] = None,
60
+ _headers: Optional[Dict[StrictStr, Any]] = None,
61
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
62
+ ) -> None:
63
+ """Agent download logs
64
+
65
+
66
+ :param host_id: (required)
67
+ :type host_id: str
68
+ :param file: (required)
69
+ :type file: List[str]
70
+ :param download:
71
+ :type download: bool
72
+ :param _request_timeout: timeout setting for this request. If one
73
+ number provided, it will be total request
74
+ timeout. It can also be a pair (tuple) of
75
+ (connection, read) timeouts.
76
+ :type _request_timeout: int, tuple(int, int), optional
77
+ :param _request_auth: set to override the auth_settings for an a single
78
+ request; this effectively ignores the
79
+ authentication in the spec for a single request.
80
+ :type _request_auth: dict, optional
81
+ :param _content_type: force content-type for the request.
82
+ :type _content_type: str, Optional
83
+ :param _headers: set to override the headers for a single
84
+ request; this effectively ignores the headers
85
+ in the spec for a single request.
86
+ :type _headers: dict, optional
87
+ :param _host_index: set to override the host_index for a single
88
+ request; this effectively ignores the host_index
89
+ in the spec for a single request.
90
+ :type _host_index: int, optional
91
+ :return: Returns the result object.
92
+ """ # noqa: E501
93
+
94
+ _param = self._get_agent_logs_serialize(
95
+ host_id=host_id,
96
+ file=file,
97
+ download=download,
98
+ _request_auth=_request_auth,
99
+ _content_type=_content_type,
100
+ _headers=_headers,
101
+ _host_index=_host_index
102
+ )
103
+
104
+ _response_types_map: Dict[str, Optional[str]] = {
105
+ }
106
+ response_data = self.api_client.call_api(
107
+ *_param,
108
+ _request_timeout=_request_timeout
109
+ )
110
+ response_data.read()
111
+ return self.api_client.response_deserialize(
112
+ response_data=response_data,
113
+ response_types_map=_response_types_map,
114
+ ).data
115
+
116
+
117
+ @validate_call
118
+ def get_agent_logs_with_http_info(
119
+ self,
120
+ host_id: StrictStr,
121
+ file: List[StrictStr],
122
+ download: Optional[StrictBool] = None,
123
+ _request_timeout: Union[
124
+ None,
125
+ Annotated[StrictFloat, Field(gt=0)],
126
+ Tuple[
127
+ Annotated[StrictFloat, Field(gt=0)],
128
+ Annotated[StrictFloat, Field(gt=0)]
129
+ ]
130
+ ] = None,
131
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
132
+ _content_type: Optional[StrictStr] = None,
133
+ _headers: Optional[Dict[StrictStr, Any]] = None,
134
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
135
+ ) -> ApiResponse[None]:
136
+ """Agent download logs
137
+
138
+
139
+ :param host_id: (required)
140
+ :type host_id: str
141
+ :param file: (required)
142
+ :type file: List[str]
143
+ :param download:
144
+ :type download: bool
145
+ :param _request_timeout: timeout setting for this request. If one
146
+ number provided, it will be total request
147
+ timeout. It can also be a pair (tuple) of
148
+ (connection, read) timeouts.
149
+ :type _request_timeout: int, tuple(int, int), optional
150
+ :param _request_auth: set to override the auth_settings for an a single
151
+ request; this effectively ignores the
152
+ authentication in the spec for a single request.
153
+ :type _request_auth: dict, optional
154
+ :param _content_type: force content-type for the request.
155
+ :type _content_type: str, Optional
156
+ :param _headers: set to override the headers for a single
157
+ request; this effectively ignores the headers
158
+ in the spec for a single request.
159
+ :type _headers: dict, optional
160
+ :param _host_index: set to override the host_index for a single
161
+ request; this effectively ignores the host_index
162
+ in the spec for a single request.
163
+ :type _host_index: int, optional
164
+ :return: Returns the result object.
165
+ """ # noqa: E501
166
+
167
+ _param = self._get_agent_logs_serialize(
168
+ host_id=host_id,
169
+ file=file,
170
+ download=download,
171
+ _request_auth=_request_auth,
172
+ _content_type=_content_type,
173
+ _headers=_headers,
174
+ _host_index=_host_index
175
+ )
176
+
177
+ _response_types_map: Dict[str, Optional[str]] = {
178
+ }
179
+ response_data = self.api_client.call_api(
180
+ *_param,
181
+ _request_timeout=_request_timeout
182
+ )
183
+ response_data.read()
184
+ return self.api_client.response_deserialize(
185
+ response_data=response_data,
186
+ response_types_map=_response_types_map,
187
+ )
188
+
189
+
190
+ @validate_call
191
+ def get_agent_logs_without_preload_content(
192
+ self,
193
+ host_id: StrictStr,
194
+ file: List[StrictStr],
195
+ download: Optional[StrictBool] = None,
196
+ _request_timeout: Union[
197
+ None,
198
+ Annotated[StrictFloat, Field(gt=0)],
199
+ Tuple[
200
+ Annotated[StrictFloat, Field(gt=0)],
201
+ Annotated[StrictFloat, Field(gt=0)]
202
+ ]
203
+ ] = None,
204
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
205
+ _content_type: Optional[StrictStr] = None,
206
+ _headers: Optional[Dict[StrictStr, Any]] = None,
207
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
208
+ ) -> RESTResponseType:
209
+ """Agent download logs
210
+
211
+
212
+ :param host_id: (required)
213
+ :type host_id: str
214
+ :param file: (required)
215
+ :type file: List[str]
216
+ :param download:
217
+ :type download: bool
218
+ :param _request_timeout: timeout setting for this request. If one
219
+ number provided, it will be total request
220
+ timeout. It can also be a pair (tuple) of
221
+ (connection, read) timeouts.
222
+ :type _request_timeout: int, tuple(int, int), optional
223
+ :param _request_auth: set to override the auth_settings for an a single
224
+ request; this effectively ignores the
225
+ authentication in the spec for a single request.
226
+ :type _request_auth: dict, optional
227
+ :param _content_type: force content-type for the request.
228
+ :type _content_type: str, Optional
229
+ :param _headers: set to override the headers for a single
230
+ request; this effectively ignores the headers
231
+ in the spec for a single request.
232
+ :type _headers: dict, optional
233
+ :param _host_index: set to override the host_index for a single
234
+ request; this effectively ignores the host_index
235
+ in the spec for a single request.
236
+ :type _host_index: int, optional
237
+ :return: Returns the result object.
238
+ """ # noqa: E501
239
+
240
+ _param = self._get_agent_logs_serialize(
241
+ host_id=host_id,
242
+ file=file,
243
+ download=download,
244
+ _request_auth=_request_auth,
245
+ _content_type=_content_type,
246
+ _headers=_headers,
247
+ _host_index=_host_index
248
+ )
249
+
250
+ _response_types_map: Dict[str, Optional[str]] = {
251
+ }
252
+ response_data = self.api_client.call_api(
253
+ *_param,
254
+ _request_timeout=_request_timeout
255
+ )
256
+ return response_data.response
257
+
258
+
259
+ def _get_agent_logs_serialize(
260
+ self,
261
+ host_id,
262
+ file,
263
+ download,
264
+ _request_auth,
265
+ _content_type,
266
+ _headers,
267
+ _host_index,
268
+ ) -> RequestSerialized:
269
+
270
+ _host = None
271
+
272
+ _collection_formats: Dict[str, str] = {
273
+ 'file': 'multi',
274
+ }
275
+
276
+ _path_params: Dict[str, str] = {}
277
+ _query_params: List[Tuple[str, str]] = []
278
+ _header_params: Dict[str, Optional[str]] = _headers or {}
279
+ _form_params: List[Tuple[str, str]] = []
280
+ _files: Dict[
281
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
282
+ ] = {}
283
+ _body_params: Optional[bytes] = None
284
+
285
+ # process the path parameters
286
+ if host_id is not None:
287
+ _path_params['hostId'] = host_id
288
+ # process the query parameters
289
+ if download is not None:
290
+
291
+ _query_params.append(('download', download))
292
+
293
+ if file is not None:
294
+
295
+ _query_params.append(('file', file))
296
+
297
+ # process the header parameters
298
+ # process the form parameters
299
+ # process the body parameter
300
+
301
+
302
+ # set the HTTP header `Accept`
303
+ if 'Accept' not in _header_params:
304
+ _header_params['Accept'] = self.api_client.select_header_accept(
305
+ [
306
+ 'application/octet-stream'
307
+ ]
308
+ )
309
+
310
+
311
+ # authentication setting
312
+ _auth_settings: List[str] = [
313
+ 'ApiKeyAuth'
314
+ ]
315
+
316
+ return self.api_client.param_serialize(
317
+ method='GET',
318
+ resource_path='/api/host-agent/{hostId}/logs',
319
+ path_params=_path_params,
320
+ query_params=_query_params,
321
+ header_params=_header_params,
322
+ body=_body_params,
323
+ post_params=_form_params,
324
+ files=_files,
325
+ auth_settings=_auth_settings,
326
+ collection_formats=_collection_formats,
327
+ _host=_host,
328
+ _request_auth=_request_auth
329
+ )
330
+
331
+
332
+
333
+
334
+ @validate_call
335
+ def get_agent_snapshot(
336
+ self,
337
+ id: StrictStr,
338
+ to: Optional[StrictInt] = None,
339
+ window_size: Optional[StrictInt] = None,
340
+ _request_timeout: Union[
341
+ None,
342
+ Annotated[StrictFloat, Field(gt=0)],
343
+ Tuple[
344
+ Annotated[StrictFloat, Field(gt=0)],
345
+ Annotated[StrictFloat, Field(gt=0)]
346
+ ]
347
+ ] = None,
348
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
349
+ _content_type: Optional[StrictStr] = None,
350
+ _headers: Optional[Dict[StrictStr, Any]] = None,
351
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
352
+ ) -> SnapshotItem:
353
+ """Get host agent snapshot details
354
+
355
+
356
+ :param id: (required)
357
+ :type id: str
358
+ :param to:
359
+ :type to: int
360
+ :param window_size:
361
+ :type window_size: int
362
+ :param _request_timeout: timeout setting for this request. If one
363
+ number provided, it will be total request
364
+ timeout. It can also be a pair (tuple) of
365
+ (connection, read) timeouts.
366
+ :type _request_timeout: int, tuple(int, int), optional
367
+ :param _request_auth: set to override the auth_settings for an a single
368
+ request; this effectively ignores the
369
+ authentication in the spec for a single request.
370
+ :type _request_auth: dict, optional
371
+ :param _content_type: force content-type for the request.
372
+ :type _content_type: str, Optional
373
+ :param _headers: set to override the headers for a single
374
+ request; this effectively ignores the headers
375
+ in the spec for a single request.
376
+ :type _headers: dict, optional
377
+ :param _host_index: set to override the host_index for a single
378
+ request; this effectively ignores the host_index
379
+ in the spec for a single request.
380
+ :type _host_index: int, optional
381
+ :return: Returns the result object.
382
+ """ # noqa: E501
383
+
384
+ _param = self._get_agent_snapshot_serialize(
385
+ id=id,
386
+ to=to,
387
+ window_size=window_size,
388
+ _request_auth=_request_auth,
389
+ _content_type=_content_type,
390
+ _headers=_headers,
391
+ _host_index=_host_index
392
+ )
393
+
394
+ _response_types_map: Dict[str, Optional[str]] = {
395
+ '200': "SnapshotItem",
396
+ }
397
+ response_data = self.api_client.call_api(
398
+ *_param,
399
+ _request_timeout=_request_timeout
400
+ )
401
+ response_data.read()
402
+ return self.api_client.response_deserialize(
403
+ response_data=response_data,
404
+ response_types_map=_response_types_map,
405
+ ).data
406
+
407
+
408
+ @validate_call
409
+ def get_agent_snapshot_with_http_info(
410
+ self,
411
+ id: StrictStr,
412
+ to: Optional[StrictInt] = None,
413
+ window_size: Optional[StrictInt] = None,
414
+ _request_timeout: Union[
415
+ None,
416
+ Annotated[StrictFloat, Field(gt=0)],
417
+ Tuple[
418
+ Annotated[StrictFloat, Field(gt=0)],
419
+ Annotated[StrictFloat, Field(gt=0)]
420
+ ]
421
+ ] = None,
422
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
423
+ _content_type: Optional[StrictStr] = None,
424
+ _headers: Optional[Dict[StrictStr, Any]] = None,
425
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
426
+ ) -> ApiResponse[SnapshotItem]:
427
+ """Get host agent snapshot details
428
+
429
+
430
+ :param id: (required)
431
+ :type id: str
432
+ :param to:
433
+ :type to: int
434
+ :param window_size:
435
+ :type window_size: int
436
+ :param _request_timeout: timeout setting for this request. If one
437
+ number provided, it will be total request
438
+ timeout. It can also be a pair (tuple) of
439
+ (connection, read) timeouts.
440
+ :type _request_timeout: int, tuple(int, int), optional
441
+ :param _request_auth: set to override the auth_settings for an a single
442
+ request; this effectively ignores the
443
+ authentication in the spec for a single request.
444
+ :type _request_auth: dict, optional
445
+ :param _content_type: force content-type for the request.
446
+ :type _content_type: str, Optional
447
+ :param _headers: set to override the headers for a single
448
+ request; this effectively ignores the headers
449
+ in the spec for a single request.
450
+ :type _headers: dict, optional
451
+ :param _host_index: set to override the host_index for a single
452
+ request; this effectively ignores the host_index
453
+ in the spec for a single request.
454
+ :type _host_index: int, optional
455
+ :return: Returns the result object.
456
+ """ # noqa: E501
457
+
458
+ _param = self._get_agent_snapshot_serialize(
459
+ id=id,
460
+ to=to,
461
+ window_size=window_size,
462
+ _request_auth=_request_auth,
463
+ _content_type=_content_type,
464
+ _headers=_headers,
465
+ _host_index=_host_index
466
+ )
467
+
468
+ _response_types_map: Dict[str, Optional[str]] = {
469
+ '200': "SnapshotItem",
470
+ }
471
+ response_data = self.api_client.call_api(
472
+ *_param,
473
+ _request_timeout=_request_timeout
474
+ )
475
+ response_data.read()
476
+ return self.api_client.response_deserialize(
477
+ response_data=response_data,
478
+ response_types_map=_response_types_map,
479
+ )
480
+
481
+
482
+ @validate_call
483
+ def get_agent_snapshot_without_preload_content(
484
+ self,
485
+ id: StrictStr,
486
+ to: Optional[StrictInt] = None,
487
+ window_size: Optional[StrictInt] = None,
488
+ _request_timeout: Union[
489
+ None,
490
+ Annotated[StrictFloat, Field(gt=0)],
491
+ Tuple[
492
+ Annotated[StrictFloat, Field(gt=0)],
493
+ Annotated[StrictFloat, Field(gt=0)]
494
+ ]
495
+ ] = None,
496
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
497
+ _content_type: Optional[StrictStr] = None,
498
+ _headers: Optional[Dict[StrictStr, Any]] = None,
499
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
500
+ ) -> RESTResponseType:
501
+ """Get host agent snapshot details
502
+
503
+
504
+ :param id: (required)
505
+ :type id: str
506
+ :param to:
507
+ :type to: int
508
+ :param window_size:
509
+ :type window_size: int
510
+ :param _request_timeout: timeout setting for this request. If one
511
+ number provided, it will be total request
512
+ timeout. It can also be a pair (tuple) of
513
+ (connection, read) timeouts.
514
+ :type _request_timeout: int, tuple(int, int), optional
515
+ :param _request_auth: set to override the auth_settings for an a single
516
+ request; this effectively ignores the
517
+ authentication in the spec for a single request.
518
+ :type _request_auth: dict, optional
519
+ :param _content_type: force content-type for the request.
520
+ :type _content_type: str, Optional
521
+ :param _headers: set to override the headers for a single
522
+ request; this effectively ignores the headers
523
+ in the spec for a single request.
524
+ :type _headers: dict, optional
525
+ :param _host_index: set to override the host_index for a single
526
+ request; this effectively ignores the host_index
527
+ in the spec for a single request.
528
+ :type _host_index: int, optional
529
+ :return: Returns the result object.
530
+ """ # noqa: E501
531
+
532
+ _param = self._get_agent_snapshot_serialize(
533
+ id=id,
534
+ to=to,
535
+ window_size=window_size,
536
+ _request_auth=_request_auth,
537
+ _content_type=_content_type,
538
+ _headers=_headers,
539
+ _host_index=_host_index
540
+ )
541
+
542
+ _response_types_map: Dict[str, Optional[str]] = {
543
+ '200': "SnapshotItem",
544
+ }
545
+ response_data = self.api_client.call_api(
546
+ *_param,
547
+ _request_timeout=_request_timeout
548
+ )
549
+ return response_data.response
550
+
551
+
552
+ def _get_agent_snapshot_serialize(
553
+ self,
554
+ id,
555
+ to,
556
+ window_size,
557
+ _request_auth,
558
+ _content_type,
559
+ _headers,
560
+ _host_index,
561
+ ) -> RequestSerialized:
562
+
563
+ _host = None
564
+
565
+ _collection_formats: Dict[str, str] = {
566
+ }
567
+
568
+ _path_params: Dict[str, str] = {}
569
+ _query_params: List[Tuple[str, str]] = []
570
+ _header_params: Dict[str, Optional[str]] = _headers or {}
571
+ _form_params: List[Tuple[str, str]] = []
572
+ _files: Dict[
573
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
574
+ ] = {}
575
+ _body_params: Optional[bytes] = None
576
+
577
+ # process the path parameters
578
+ if id is not None:
579
+ _path_params['id'] = id
580
+ # process the query parameters
581
+ if to is not None:
582
+
583
+ _query_params.append(('to', to))
584
+
585
+ if window_size is not None:
586
+
587
+ _query_params.append(('windowSize', window_size))
588
+
589
+ # process the header parameters
590
+ # process the form parameters
591
+ # process the body parameter
592
+
593
+
594
+ # set the HTTP header `Accept`
595
+ if 'Accept' not in _header_params:
596
+ _header_params['Accept'] = self.api_client.select_header_accept(
597
+ [
598
+ 'application/json'
599
+ ]
600
+ )
601
+
602
+
603
+ # authentication setting
604
+ _auth_settings: List[str] = [
605
+ 'ApiKeyAuth'
606
+ ]
607
+
608
+ return self.api_client.param_serialize(
609
+ method='GET',
610
+ resource_path='/api/host-agent/{id}',
611
+ path_params=_path_params,
612
+ query_params=_query_params,
613
+ header_params=_header_params,
614
+ body=_body_params,
615
+ post_params=_form_params,
616
+ files=_files,
617
+ auth_settings=_auth_settings,
618
+ collection_formats=_collection_formats,
619
+ _host=_host,
620
+ _request_auth=_request_auth
621
+ )
622
+
623
+
624
+
625
+
626
+ @validate_call
627
+ def get_agent_support_information(
628
+ self,
629
+ host_id: StrictStr,
630
+ support_info_id: StrictStr,
631
+ _request_timeout: Union[
632
+ None,
633
+ Annotated[StrictFloat, Field(gt=0)],
634
+ Tuple[
635
+ Annotated[StrictFloat, Field(gt=0)],
636
+ Annotated[StrictFloat, Field(gt=0)]
637
+ ]
638
+ ] = None,
639
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
640
+ _content_type: Optional[StrictStr] = None,
641
+ _headers: Optional[Dict[StrictStr, Any]] = None,
642
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
643
+ ) -> None:
644
+ """Agent download support information
645
+
646
+
647
+ :param host_id: (required)
648
+ :type host_id: str
649
+ :param support_info_id: (required)
650
+ :type support_info_id: str
651
+ :param _request_timeout: timeout setting for this request. If one
652
+ number provided, it will be total request
653
+ timeout. It can also be a pair (tuple) of
654
+ (connection, read) timeouts.
655
+ :type _request_timeout: int, tuple(int, int), optional
656
+ :param _request_auth: set to override the auth_settings for an a single
657
+ request; this effectively ignores the
658
+ authentication in the spec for a single request.
659
+ :type _request_auth: dict, optional
660
+ :param _content_type: force content-type for the request.
661
+ :type _content_type: str, Optional
662
+ :param _headers: set to override the headers for a single
663
+ request; this effectively ignores the headers
664
+ in the spec for a single request.
665
+ :type _headers: dict, optional
666
+ :param _host_index: set to override the host_index for a single
667
+ request; this effectively ignores the host_index
668
+ in the spec for a single request.
669
+ :type _host_index: int, optional
670
+ :return: Returns the result object.
671
+ """ # noqa: E501
672
+
673
+ _param = self._get_agent_support_information_serialize(
674
+ host_id=host_id,
675
+ support_info_id=support_info_id,
676
+ _request_auth=_request_auth,
677
+ _content_type=_content_type,
678
+ _headers=_headers,
679
+ _host_index=_host_index
680
+ )
681
+
682
+ _response_types_map: Dict[str, Optional[str]] = {
683
+ }
684
+ response_data = self.api_client.call_api(
685
+ *_param,
686
+ _request_timeout=_request_timeout
687
+ )
688
+ response_data.read()
689
+ return self.api_client.response_deserialize(
690
+ response_data=response_data,
691
+ response_types_map=_response_types_map,
692
+ ).data
693
+
694
+
695
+ @validate_call
696
+ def get_agent_support_information_with_http_info(
697
+ self,
698
+ host_id: StrictStr,
699
+ support_info_id: StrictStr,
700
+ _request_timeout: Union[
701
+ None,
702
+ Annotated[StrictFloat, Field(gt=0)],
703
+ Tuple[
704
+ Annotated[StrictFloat, Field(gt=0)],
705
+ Annotated[StrictFloat, Field(gt=0)]
706
+ ]
707
+ ] = None,
708
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
709
+ _content_type: Optional[StrictStr] = None,
710
+ _headers: Optional[Dict[StrictStr, Any]] = None,
711
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
712
+ ) -> ApiResponse[None]:
713
+ """Agent download support information
714
+
715
+
716
+ :param host_id: (required)
717
+ :type host_id: str
718
+ :param support_info_id: (required)
719
+ :type support_info_id: str
720
+ :param _request_timeout: timeout setting for this request. If one
721
+ number provided, it will be total request
722
+ timeout. It can also be a pair (tuple) of
723
+ (connection, read) timeouts.
724
+ :type _request_timeout: int, tuple(int, int), optional
725
+ :param _request_auth: set to override the auth_settings for an a single
726
+ request; this effectively ignores the
727
+ authentication in the spec for a single request.
728
+ :type _request_auth: dict, optional
729
+ :param _content_type: force content-type for the request.
730
+ :type _content_type: str, Optional
731
+ :param _headers: set to override the headers for a single
732
+ request; this effectively ignores the headers
733
+ in the spec for a single request.
734
+ :type _headers: dict, optional
735
+ :param _host_index: set to override the host_index for a single
736
+ request; this effectively ignores the host_index
737
+ in the spec for a single request.
738
+ :type _host_index: int, optional
739
+ :return: Returns the result object.
740
+ """ # noqa: E501
741
+
742
+ _param = self._get_agent_support_information_serialize(
743
+ host_id=host_id,
744
+ support_info_id=support_info_id,
745
+ _request_auth=_request_auth,
746
+ _content_type=_content_type,
747
+ _headers=_headers,
748
+ _host_index=_host_index
749
+ )
750
+
751
+ _response_types_map: Dict[str, Optional[str]] = {
752
+ }
753
+ response_data = self.api_client.call_api(
754
+ *_param,
755
+ _request_timeout=_request_timeout
756
+ )
757
+ response_data.read()
758
+ return self.api_client.response_deserialize(
759
+ response_data=response_data,
760
+ response_types_map=_response_types_map,
761
+ )
762
+
763
+
764
+ @validate_call
765
+ def get_agent_support_information_without_preload_content(
766
+ self,
767
+ host_id: StrictStr,
768
+ support_info_id: StrictStr,
769
+ _request_timeout: Union[
770
+ None,
771
+ Annotated[StrictFloat, Field(gt=0)],
772
+ Tuple[
773
+ Annotated[StrictFloat, Field(gt=0)],
774
+ Annotated[StrictFloat, Field(gt=0)]
775
+ ]
776
+ ] = None,
777
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
778
+ _content_type: Optional[StrictStr] = None,
779
+ _headers: Optional[Dict[StrictStr, Any]] = None,
780
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
781
+ ) -> RESTResponseType:
782
+ """Agent download support information
783
+
784
+
785
+ :param host_id: (required)
786
+ :type host_id: str
787
+ :param support_info_id: (required)
788
+ :type support_info_id: str
789
+ :param _request_timeout: timeout setting for this request. If one
790
+ number provided, it will be total request
791
+ timeout. It can also be a pair (tuple) of
792
+ (connection, read) timeouts.
793
+ :type _request_timeout: int, tuple(int, int), optional
794
+ :param _request_auth: set to override the auth_settings for an a single
795
+ request; this effectively ignores the
796
+ authentication in the spec for a single request.
797
+ :type _request_auth: dict, optional
798
+ :param _content_type: force content-type for the request.
799
+ :type _content_type: str, Optional
800
+ :param _headers: set to override the headers for a single
801
+ request; this effectively ignores the headers
802
+ in the spec for a single request.
803
+ :type _headers: dict, optional
804
+ :param _host_index: set to override the host_index for a single
805
+ request; this effectively ignores the host_index
806
+ in the spec for a single request.
807
+ :type _host_index: int, optional
808
+ :return: Returns the result object.
809
+ """ # noqa: E501
810
+
811
+ _param = self._get_agent_support_information_serialize(
812
+ host_id=host_id,
813
+ support_info_id=support_info_id,
814
+ _request_auth=_request_auth,
815
+ _content_type=_content_type,
816
+ _headers=_headers,
817
+ _host_index=_host_index
818
+ )
819
+
820
+ _response_types_map: Dict[str, Optional[str]] = {
821
+ }
822
+ response_data = self.api_client.call_api(
823
+ *_param,
824
+ _request_timeout=_request_timeout
825
+ )
826
+ return response_data.response
827
+
828
+
829
+ def _get_agent_support_information_serialize(
830
+ self,
831
+ host_id,
832
+ support_info_id,
833
+ _request_auth,
834
+ _content_type,
835
+ _headers,
836
+ _host_index,
837
+ ) -> RequestSerialized:
838
+
839
+ _host = None
840
+
841
+ _collection_formats: Dict[str, str] = {
842
+ }
843
+
844
+ _path_params: Dict[str, str] = {}
845
+ _query_params: List[Tuple[str, str]] = []
846
+ _header_params: Dict[str, Optional[str]] = _headers or {}
847
+ _form_params: List[Tuple[str, str]] = []
848
+ _files: Dict[
849
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
850
+ ] = {}
851
+ _body_params: Optional[bytes] = None
852
+
853
+ # process the path parameters
854
+ if host_id is not None:
855
+ _path_params['hostId'] = host_id
856
+ # process the query parameters
857
+ if support_info_id is not None:
858
+
859
+ _query_params.append(('supportInfoId', support_info_id))
860
+
861
+ # process the header parameters
862
+ # process the form parameters
863
+ # process the body parameter
864
+
865
+
866
+ # set the HTTP header `Accept`
867
+ if 'Accept' not in _header_params:
868
+ _header_params['Accept'] = self.api_client.select_header_accept(
869
+ [
870
+ 'application/octet-stream'
871
+ ]
872
+ )
873
+
874
+
875
+ # authentication setting
876
+ _auth_settings: List[str] = [
877
+ 'ApiKeyAuth'
878
+ ]
879
+
880
+ return self.api_client.param_serialize(
881
+ method='GET',
882
+ resource_path='/api/host-agent/{hostId}/support-info',
883
+ path_params=_path_params,
884
+ query_params=_query_params,
885
+ header_params=_header_params,
886
+ body=_body_params,
887
+ post_params=_form_params,
888
+ files=_files,
889
+ auth_settings=_auth_settings,
890
+ collection_formats=_collection_formats,
891
+ _host=_host,
892
+ _request_auth=_request_auth
893
+ )
894
+
895
+
896
+
897
+
898
+ @validate_call
899
+ def search_host_agents(
900
+ self,
901
+ query: Optional[StrictStr] = None,
902
+ to: Optional[StrictInt] = None,
903
+ window_size: Optional[StrictInt] = None,
904
+ size: Optional[StrictInt] = None,
905
+ offline: Optional[StrictBool] = None,
906
+ _request_timeout: Union[
907
+ None,
908
+ Annotated[StrictFloat, Field(gt=0)],
909
+ Tuple[
910
+ Annotated[StrictFloat, Field(gt=0)],
911
+ Annotated[StrictFloat, Field(gt=0)]
912
+ ]
913
+ ] = None,
914
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
915
+ _content_type: Optional[StrictStr] = None,
916
+ _headers: Optional[Dict[StrictStr, Any]] = None,
917
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
918
+ ) -> SnapshotResult:
919
+ """Query host agent snapshots
920
+
921
+
922
+ :param query:
923
+ :type query: str
924
+ :param to:
925
+ :type to: int
926
+ :param window_size:
927
+ :type window_size: int
928
+ :param size:
929
+ :type size: int
930
+ :param offline:
931
+ :type offline: bool
932
+ :param _request_timeout: timeout setting for this request. If one
933
+ number provided, it will be total request
934
+ timeout. It can also be a pair (tuple) of
935
+ (connection, read) timeouts.
936
+ :type _request_timeout: int, tuple(int, int), optional
937
+ :param _request_auth: set to override the auth_settings for an a single
938
+ request; this effectively ignores the
939
+ authentication in the spec for a single request.
940
+ :type _request_auth: dict, optional
941
+ :param _content_type: force content-type for the request.
942
+ :type _content_type: str, Optional
943
+ :param _headers: set to override the headers for a single
944
+ request; this effectively ignores the headers
945
+ in the spec for a single request.
946
+ :type _headers: dict, optional
947
+ :param _host_index: set to override the host_index for a single
948
+ request; this effectively ignores the host_index
949
+ in the spec for a single request.
950
+ :type _host_index: int, optional
951
+ :return: Returns the result object.
952
+ """ # noqa: E501
953
+
954
+ _param = self._search_host_agents_serialize(
955
+ query=query,
956
+ to=to,
957
+ window_size=window_size,
958
+ size=size,
959
+ offline=offline,
960
+ _request_auth=_request_auth,
961
+ _content_type=_content_type,
962
+ _headers=_headers,
963
+ _host_index=_host_index
964
+ )
965
+
966
+ _response_types_map: Dict[str, Optional[str]] = {
967
+ '200': "SnapshotResult",
968
+ }
969
+ response_data = self.api_client.call_api(
970
+ *_param,
971
+ _request_timeout=_request_timeout
972
+ )
973
+ response_data.read()
974
+ return self.api_client.response_deserialize(
975
+ response_data=response_data,
976
+ response_types_map=_response_types_map,
977
+ ).data
978
+
979
+
980
+ @validate_call
981
+ def search_host_agents_with_http_info(
982
+ self,
983
+ query: Optional[StrictStr] = None,
984
+ to: Optional[StrictInt] = None,
985
+ window_size: Optional[StrictInt] = None,
986
+ size: Optional[StrictInt] = None,
987
+ offline: Optional[StrictBool] = None,
988
+ _request_timeout: Union[
989
+ None,
990
+ Annotated[StrictFloat, Field(gt=0)],
991
+ Tuple[
992
+ Annotated[StrictFloat, Field(gt=0)],
993
+ Annotated[StrictFloat, Field(gt=0)]
994
+ ]
995
+ ] = None,
996
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
997
+ _content_type: Optional[StrictStr] = None,
998
+ _headers: Optional[Dict[StrictStr, Any]] = None,
999
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1000
+ ) -> ApiResponse[SnapshotResult]:
1001
+ """Query host agent snapshots
1002
+
1003
+
1004
+ :param query:
1005
+ :type query: str
1006
+ :param to:
1007
+ :type to: int
1008
+ :param window_size:
1009
+ :type window_size: int
1010
+ :param size:
1011
+ :type size: int
1012
+ :param offline:
1013
+ :type offline: bool
1014
+ :param _request_timeout: timeout setting for this request. If one
1015
+ number provided, it will be total request
1016
+ timeout. It can also be a pair (tuple) of
1017
+ (connection, read) timeouts.
1018
+ :type _request_timeout: int, tuple(int, int), optional
1019
+ :param _request_auth: set to override the auth_settings for an a single
1020
+ request; this effectively ignores the
1021
+ authentication in the spec for a single request.
1022
+ :type _request_auth: dict, optional
1023
+ :param _content_type: force content-type for the request.
1024
+ :type _content_type: str, Optional
1025
+ :param _headers: set to override the headers for a single
1026
+ request; this effectively ignores the headers
1027
+ in the spec for a single request.
1028
+ :type _headers: dict, optional
1029
+ :param _host_index: set to override the host_index for a single
1030
+ request; this effectively ignores the host_index
1031
+ in the spec for a single request.
1032
+ :type _host_index: int, optional
1033
+ :return: Returns the result object.
1034
+ """ # noqa: E501
1035
+
1036
+ _param = self._search_host_agents_serialize(
1037
+ query=query,
1038
+ to=to,
1039
+ window_size=window_size,
1040
+ size=size,
1041
+ offline=offline,
1042
+ _request_auth=_request_auth,
1043
+ _content_type=_content_type,
1044
+ _headers=_headers,
1045
+ _host_index=_host_index
1046
+ )
1047
+
1048
+ _response_types_map: Dict[str, Optional[str]] = {
1049
+ '200': "SnapshotResult",
1050
+ }
1051
+ response_data = self.api_client.call_api(
1052
+ *_param,
1053
+ _request_timeout=_request_timeout
1054
+ )
1055
+ response_data.read()
1056
+ return self.api_client.response_deserialize(
1057
+ response_data=response_data,
1058
+ response_types_map=_response_types_map,
1059
+ )
1060
+
1061
+
1062
+ @validate_call
1063
+ def search_host_agents_without_preload_content(
1064
+ self,
1065
+ query: Optional[StrictStr] = None,
1066
+ to: Optional[StrictInt] = None,
1067
+ window_size: Optional[StrictInt] = None,
1068
+ size: Optional[StrictInt] = None,
1069
+ offline: Optional[StrictBool] = None,
1070
+ _request_timeout: Union[
1071
+ None,
1072
+ Annotated[StrictFloat, Field(gt=0)],
1073
+ Tuple[
1074
+ Annotated[StrictFloat, Field(gt=0)],
1075
+ Annotated[StrictFloat, Field(gt=0)]
1076
+ ]
1077
+ ] = None,
1078
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1079
+ _content_type: Optional[StrictStr] = None,
1080
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1081
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1082
+ ) -> RESTResponseType:
1083
+ """Query host agent snapshots
1084
+
1085
+
1086
+ :param query:
1087
+ :type query: str
1088
+ :param to:
1089
+ :type to: int
1090
+ :param window_size:
1091
+ :type window_size: int
1092
+ :param size:
1093
+ :type size: int
1094
+ :param offline:
1095
+ :type offline: bool
1096
+ :param _request_timeout: timeout setting for this request. If one
1097
+ number provided, it will be total request
1098
+ timeout. It can also be a pair (tuple) of
1099
+ (connection, read) timeouts.
1100
+ :type _request_timeout: int, tuple(int, int), optional
1101
+ :param _request_auth: set to override the auth_settings for an a single
1102
+ request; this effectively ignores the
1103
+ authentication in the spec for a single request.
1104
+ :type _request_auth: dict, optional
1105
+ :param _content_type: force content-type for the request.
1106
+ :type _content_type: str, Optional
1107
+ :param _headers: set to override the headers for a single
1108
+ request; this effectively ignores the headers
1109
+ in the spec for a single request.
1110
+ :type _headers: dict, optional
1111
+ :param _host_index: set to override the host_index for a single
1112
+ request; this effectively ignores the host_index
1113
+ in the spec for a single request.
1114
+ :type _host_index: int, optional
1115
+ :return: Returns the result object.
1116
+ """ # noqa: E501
1117
+
1118
+ _param = self._search_host_agents_serialize(
1119
+ query=query,
1120
+ to=to,
1121
+ window_size=window_size,
1122
+ size=size,
1123
+ offline=offline,
1124
+ _request_auth=_request_auth,
1125
+ _content_type=_content_type,
1126
+ _headers=_headers,
1127
+ _host_index=_host_index
1128
+ )
1129
+
1130
+ _response_types_map: Dict[str, Optional[str]] = {
1131
+ '200': "SnapshotResult",
1132
+ }
1133
+ response_data = self.api_client.call_api(
1134
+ *_param,
1135
+ _request_timeout=_request_timeout
1136
+ )
1137
+ return response_data.response
1138
+
1139
+
1140
+ def _search_host_agents_serialize(
1141
+ self,
1142
+ query,
1143
+ to,
1144
+ window_size,
1145
+ size,
1146
+ offline,
1147
+ _request_auth,
1148
+ _content_type,
1149
+ _headers,
1150
+ _host_index,
1151
+ ) -> RequestSerialized:
1152
+
1153
+ _host = None
1154
+
1155
+ _collection_formats: Dict[str, str] = {
1156
+ }
1157
+
1158
+ _path_params: Dict[str, str] = {}
1159
+ _query_params: List[Tuple[str, str]] = []
1160
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1161
+ _form_params: List[Tuple[str, str]] = []
1162
+ _files: Dict[
1163
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1164
+ ] = {}
1165
+ _body_params: Optional[bytes] = None
1166
+
1167
+ # process the path parameters
1168
+ # process the query parameters
1169
+ if query is not None:
1170
+
1171
+ _query_params.append(('query', query))
1172
+
1173
+ if to is not None:
1174
+
1175
+ _query_params.append(('to', to))
1176
+
1177
+ if window_size is not None:
1178
+
1179
+ _query_params.append(('windowSize', window_size))
1180
+
1181
+ if size is not None:
1182
+
1183
+ _query_params.append(('size', size))
1184
+
1185
+ if offline is not None:
1186
+
1187
+ _query_params.append(('offline', offline))
1188
+
1189
+ # process the header parameters
1190
+ # process the form parameters
1191
+ # process the body parameter
1192
+
1193
+
1194
+ # set the HTTP header `Accept`
1195
+ if 'Accept' not in _header_params:
1196
+ _header_params['Accept'] = self.api_client.select_header_accept(
1197
+ [
1198
+ 'application/json'
1199
+ ]
1200
+ )
1201
+
1202
+
1203
+ # authentication setting
1204
+ _auth_settings: List[str] = [
1205
+ 'ApiKeyAuth'
1206
+ ]
1207
+
1208
+ return self.api_client.param_serialize(
1209
+ method='GET',
1210
+ resource_path='/api/host-agent',
1211
+ path_params=_path_params,
1212
+ query_params=_query_params,
1213
+ header_params=_header_params,
1214
+ body=_body_params,
1215
+ post_params=_form_params,
1216
+ files=_files,
1217
+ auth_settings=_auth_settings,
1218
+ collection_formats=_collection_formats,
1219
+ _host=_host,
1220
+ _request_auth=_request_auth
1221
+ )
1222
+
1223
+
1224
+
1225
+
1226
+ @validate_call
1227
+ def update_agent(
1228
+ self,
1229
+ host_id: StrictStr,
1230
+ _request_timeout: Union[
1231
+ None,
1232
+ Annotated[StrictFloat, Field(gt=0)],
1233
+ Tuple[
1234
+ Annotated[StrictFloat, Field(gt=0)],
1235
+ Annotated[StrictFloat, Field(gt=0)]
1236
+ ]
1237
+ ] = None,
1238
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1239
+ _content_type: Optional[StrictStr] = None,
1240
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1241
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1242
+ ) -> None:
1243
+ """Agent update
1244
+
1245
+
1246
+ :param host_id: (required)
1247
+ :type host_id: str
1248
+ :param _request_timeout: timeout setting for this request. If one
1249
+ number provided, it will be total request
1250
+ timeout. It can also be a pair (tuple) of
1251
+ (connection, read) timeouts.
1252
+ :type _request_timeout: int, tuple(int, int), optional
1253
+ :param _request_auth: set to override the auth_settings for an a single
1254
+ request; this effectively ignores the
1255
+ authentication in the spec for a single request.
1256
+ :type _request_auth: dict, optional
1257
+ :param _content_type: force content-type for the request.
1258
+ :type _content_type: str, Optional
1259
+ :param _headers: set to override the headers for a single
1260
+ request; this effectively ignores the headers
1261
+ in the spec for a single request.
1262
+ :type _headers: dict, optional
1263
+ :param _host_index: set to override the host_index for a single
1264
+ request; this effectively ignores the host_index
1265
+ in the spec for a single request.
1266
+ :type _host_index: int, optional
1267
+ :return: Returns the result object.
1268
+ """ # noqa: E501
1269
+
1270
+ _param = self._update_agent_serialize(
1271
+ host_id=host_id,
1272
+ _request_auth=_request_auth,
1273
+ _content_type=_content_type,
1274
+ _headers=_headers,
1275
+ _host_index=_host_index
1276
+ )
1277
+
1278
+ _response_types_map: Dict[str, Optional[str]] = {
1279
+ }
1280
+ response_data = self.api_client.call_api(
1281
+ *_param,
1282
+ _request_timeout=_request_timeout
1283
+ )
1284
+ response_data.read()
1285
+ return self.api_client.response_deserialize(
1286
+ response_data=response_data,
1287
+ response_types_map=_response_types_map,
1288
+ ).data
1289
+
1290
+
1291
+ @validate_call
1292
+ def update_agent_with_http_info(
1293
+ self,
1294
+ host_id: StrictStr,
1295
+ _request_timeout: Union[
1296
+ None,
1297
+ Annotated[StrictFloat, Field(gt=0)],
1298
+ Tuple[
1299
+ Annotated[StrictFloat, Field(gt=0)],
1300
+ Annotated[StrictFloat, Field(gt=0)]
1301
+ ]
1302
+ ] = None,
1303
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1304
+ _content_type: Optional[StrictStr] = None,
1305
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1306
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1307
+ ) -> ApiResponse[None]:
1308
+ """Agent update
1309
+
1310
+
1311
+ :param host_id: (required)
1312
+ :type host_id: str
1313
+ :param _request_timeout: timeout setting for this request. If one
1314
+ number provided, it will be total request
1315
+ timeout. It can also be a pair (tuple) of
1316
+ (connection, read) timeouts.
1317
+ :type _request_timeout: int, tuple(int, int), optional
1318
+ :param _request_auth: set to override the auth_settings for an a single
1319
+ request; this effectively ignores the
1320
+ authentication in the spec for a single request.
1321
+ :type _request_auth: dict, optional
1322
+ :param _content_type: force content-type for the request.
1323
+ :type _content_type: str, Optional
1324
+ :param _headers: set to override the headers for a single
1325
+ request; this effectively ignores the headers
1326
+ in the spec for a single request.
1327
+ :type _headers: dict, optional
1328
+ :param _host_index: set to override the host_index for a single
1329
+ request; this effectively ignores the host_index
1330
+ in the spec for a single request.
1331
+ :type _host_index: int, optional
1332
+ :return: Returns the result object.
1333
+ """ # noqa: E501
1334
+
1335
+ _param = self._update_agent_serialize(
1336
+ host_id=host_id,
1337
+ _request_auth=_request_auth,
1338
+ _content_type=_content_type,
1339
+ _headers=_headers,
1340
+ _host_index=_host_index
1341
+ )
1342
+
1343
+ _response_types_map: Dict[str, Optional[str]] = {
1344
+ }
1345
+ response_data = self.api_client.call_api(
1346
+ *_param,
1347
+ _request_timeout=_request_timeout
1348
+ )
1349
+ response_data.read()
1350
+ return self.api_client.response_deserialize(
1351
+ response_data=response_data,
1352
+ response_types_map=_response_types_map,
1353
+ )
1354
+
1355
+
1356
+ @validate_call
1357
+ def update_agent_without_preload_content(
1358
+ self,
1359
+ host_id: StrictStr,
1360
+ _request_timeout: Union[
1361
+ None,
1362
+ Annotated[StrictFloat, Field(gt=0)],
1363
+ Tuple[
1364
+ Annotated[StrictFloat, Field(gt=0)],
1365
+ Annotated[StrictFloat, Field(gt=0)]
1366
+ ]
1367
+ ] = None,
1368
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1369
+ _content_type: Optional[StrictStr] = None,
1370
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1371
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1372
+ ) -> RESTResponseType:
1373
+ """Agent update
1374
+
1375
+
1376
+ :param host_id: (required)
1377
+ :type host_id: str
1378
+ :param _request_timeout: timeout setting for this request. If one
1379
+ number provided, it will be total request
1380
+ timeout. It can also be a pair (tuple) of
1381
+ (connection, read) timeouts.
1382
+ :type _request_timeout: int, tuple(int, int), optional
1383
+ :param _request_auth: set to override the auth_settings for an a single
1384
+ request; this effectively ignores the
1385
+ authentication in the spec for a single request.
1386
+ :type _request_auth: dict, optional
1387
+ :param _content_type: force content-type for the request.
1388
+ :type _content_type: str, Optional
1389
+ :param _headers: set to override the headers for a single
1390
+ request; this effectively ignores the headers
1391
+ in the spec for a single request.
1392
+ :type _headers: dict, optional
1393
+ :param _host_index: set to override the host_index for a single
1394
+ request; this effectively ignores the host_index
1395
+ in the spec for a single request.
1396
+ :type _host_index: int, optional
1397
+ :return: Returns the result object.
1398
+ """ # noqa: E501
1399
+
1400
+ _param = self._update_agent_serialize(
1401
+ host_id=host_id,
1402
+ _request_auth=_request_auth,
1403
+ _content_type=_content_type,
1404
+ _headers=_headers,
1405
+ _host_index=_host_index
1406
+ )
1407
+
1408
+ _response_types_map: Dict[str, Optional[str]] = {
1409
+ }
1410
+ response_data = self.api_client.call_api(
1411
+ *_param,
1412
+ _request_timeout=_request_timeout
1413
+ )
1414
+ return response_data.response
1415
+
1416
+
1417
+ def _update_agent_serialize(
1418
+ self,
1419
+ host_id,
1420
+ _request_auth,
1421
+ _content_type,
1422
+ _headers,
1423
+ _host_index,
1424
+ ) -> RequestSerialized:
1425
+
1426
+ _host = None
1427
+
1428
+ _collection_formats: Dict[str, str] = {
1429
+ }
1430
+
1431
+ _path_params: Dict[str, str] = {}
1432
+ _query_params: List[Tuple[str, str]] = []
1433
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1434
+ _form_params: List[Tuple[str, str]] = []
1435
+ _files: Dict[
1436
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1437
+ ] = {}
1438
+ _body_params: Optional[bytes] = None
1439
+
1440
+ # process the path parameters
1441
+ if host_id is not None:
1442
+ _path_params['hostId'] = host_id
1443
+ # process the query parameters
1444
+ # process the header parameters
1445
+ # process the form parameters
1446
+ # process the body parameter
1447
+
1448
+
1449
+ # set the HTTP header `Accept`
1450
+ if 'Accept' not in _header_params:
1451
+ _header_params['Accept'] = self.api_client.select_header_accept(
1452
+ [
1453
+ 'application/json'
1454
+ ]
1455
+ )
1456
+
1457
+
1458
+ # authentication setting
1459
+ _auth_settings: List[str] = [
1460
+ 'ApiKeyAuth'
1461
+ ]
1462
+
1463
+ return self.api_client.param_serialize(
1464
+ method='POST',
1465
+ resource_path='/api/host-agent/{hostId}/update',
1466
+ path_params=_path_params,
1467
+ query_params=_query_params,
1468
+ header_params=_header_params,
1469
+ body=_body_params,
1470
+ post_params=_form_params,
1471
+ files=_files,
1472
+ auth_settings=_auth_settings,
1473
+ collection_formats=_collection_formats,
1474
+ _host=_host,
1475
+ _request_auth=_request_auth
1476
+ )
1477
+
1478
+
1479
+
1480
+
1481
+ @validate_call
1482
+ def update_configuration_by_host(
1483
+ self,
1484
+ host_id: StrictStr,
1485
+ agent_configuration_update: Optional[AgentConfigurationUpdate] = None,
1486
+ _request_timeout: Union[
1487
+ None,
1488
+ Annotated[StrictFloat, Field(gt=0)],
1489
+ Tuple[
1490
+ Annotated[StrictFloat, Field(gt=0)],
1491
+ Annotated[StrictFloat, Field(gt=0)]
1492
+ ]
1493
+ ] = None,
1494
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1495
+ _content_type: Optional[StrictStr] = None,
1496
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1497
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1498
+ ) -> None:
1499
+ """Update agent configuration by host
1500
+
1501
+ This endpoint can be used to initialize or change configuration management settings for a specific host agent.
1502
+
1503
+ :param host_id: (required)
1504
+ :type host_id: str
1505
+ :param agent_configuration_update:
1506
+ :type agent_configuration_update: AgentConfigurationUpdate
1507
+ :param _request_timeout: timeout setting for this request. If one
1508
+ number provided, it will be total request
1509
+ timeout. It can also be a pair (tuple) of
1510
+ (connection, read) timeouts.
1511
+ :type _request_timeout: int, tuple(int, int), optional
1512
+ :param _request_auth: set to override the auth_settings for an a single
1513
+ request; this effectively ignores the
1514
+ authentication in the spec for a single request.
1515
+ :type _request_auth: dict, optional
1516
+ :param _content_type: force content-type for the request.
1517
+ :type _content_type: str, Optional
1518
+ :param _headers: set to override the headers for a single
1519
+ request; this effectively ignores the headers
1520
+ in the spec for a single request.
1521
+ :type _headers: dict, optional
1522
+ :param _host_index: set to override the host_index for a single
1523
+ request; this effectively ignores the host_index
1524
+ in the spec for a single request.
1525
+ :type _host_index: int, optional
1526
+ :return: Returns the result object.
1527
+ """ # noqa: E501
1528
+
1529
+ _param = self._update_configuration_by_host_serialize(
1530
+ host_id=host_id,
1531
+ agent_configuration_update=agent_configuration_update,
1532
+ _request_auth=_request_auth,
1533
+ _content_type=_content_type,
1534
+ _headers=_headers,
1535
+ _host_index=_host_index
1536
+ )
1537
+
1538
+ _response_types_map: Dict[str, Optional[str]] = {
1539
+ }
1540
+ response_data = self.api_client.call_api(
1541
+ *_param,
1542
+ _request_timeout=_request_timeout
1543
+ )
1544
+ response_data.read()
1545
+ return self.api_client.response_deserialize(
1546
+ response_data=response_data,
1547
+ response_types_map=_response_types_map,
1548
+ ).data
1549
+
1550
+
1551
+ @validate_call
1552
+ def update_configuration_by_host_with_http_info(
1553
+ self,
1554
+ host_id: StrictStr,
1555
+ agent_configuration_update: Optional[AgentConfigurationUpdate] = None,
1556
+ _request_timeout: Union[
1557
+ None,
1558
+ Annotated[StrictFloat, Field(gt=0)],
1559
+ Tuple[
1560
+ Annotated[StrictFloat, Field(gt=0)],
1561
+ Annotated[StrictFloat, Field(gt=0)]
1562
+ ]
1563
+ ] = None,
1564
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1565
+ _content_type: Optional[StrictStr] = None,
1566
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1567
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1568
+ ) -> ApiResponse[None]:
1569
+ """Update agent configuration by host
1570
+
1571
+ This endpoint can be used to initialize or change configuration management settings for a specific host agent.
1572
+
1573
+ :param host_id: (required)
1574
+ :type host_id: str
1575
+ :param agent_configuration_update:
1576
+ :type agent_configuration_update: AgentConfigurationUpdate
1577
+ :param _request_timeout: timeout setting for this request. If one
1578
+ number provided, it will be total request
1579
+ timeout. It can also be a pair (tuple) of
1580
+ (connection, read) timeouts.
1581
+ :type _request_timeout: int, tuple(int, int), optional
1582
+ :param _request_auth: set to override the auth_settings for an a single
1583
+ request; this effectively ignores the
1584
+ authentication in the spec for a single request.
1585
+ :type _request_auth: dict, optional
1586
+ :param _content_type: force content-type for the request.
1587
+ :type _content_type: str, Optional
1588
+ :param _headers: set to override the headers for a single
1589
+ request; this effectively ignores the headers
1590
+ in the spec for a single request.
1591
+ :type _headers: dict, optional
1592
+ :param _host_index: set to override the host_index for a single
1593
+ request; this effectively ignores the host_index
1594
+ in the spec for a single request.
1595
+ :type _host_index: int, optional
1596
+ :return: Returns the result object.
1597
+ """ # noqa: E501
1598
+
1599
+ _param = self._update_configuration_by_host_serialize(
1600
+ host_id=host_id,
1601
+ agent_configuration_update=agent_configuration_update,
1602
+ _request_auth=_request_auth,
1603
+ _content_type=_content_type,
1604
+ _headers=_headers,
1605
+ _host_index=_host_index
1606
+ )
1607
+
1608
+ _response_types_map: Dict[str, Optional[str]] = {
1609
+ }
1610
+ response_data = self.api_client.call_api(
1611
+ *_param,
1612
+ _request_timeout=_request_timeout
1613
+ )
1614
+ response_data.read()
1615
+ return self.api_client.response_deserialize(
1616
+ response_data=response_data,
1617
+ response_types_map=_response_types_map,
1618
+ )
1619
+
1620
+
1621
+ @validate_call
1622
+ def update_configuration_by_host_without_preload_content(
1623
+ self,
1624
+ host_id: StrictStr,
1625
+ agent_configuration_update: Optional[AgentConfigurationUpdate] = None,
1626
+ _request_timeout: Union[
1627
+ None,
1628
+ Annotated[StrictFloat, Field(gt=0)],
1629
+ Tuple[
1630
+ Annotated[StrictFloat, Field(gt=0)],
1631
+ Annotated[StrictFloat, Field(gt=0)]
1632
+ ]
1633
+ ] = None,
1634
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1635
+ _content_type: Optional[StrictStr] = None,
1636
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1637
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1638
+ ) -> RESTResponseType:
1639
+ """Update agent configuration by host
1640
+
1641
+ This endpoint can be used to initialize or change configuration management settings for a specific host agent.
1642
+
1643
+ :param host_id: (required)
1644
+ :type host_id: str
1645
+ :param agent_configuration_update:
1646
+ :type agent_configuration_update: AgentConfigurationUpdate
1647
+ :param _request_timeout: timeout setting for this request. If one
1648
+ number provided, it will be total request
1649
+ timeout. It can also be a pair (tuple) of
1650
+ (connection, read) timeouts.
1651
+ :type _request_timeout: int, tuple(int, int), optional
1652
+ :param _request_auth: set to override the auth_settings for an a single
1653
+ request; this effectively ignores the
1654
+ authentication in the spec for a single request.
1655
+ :type _request_auth: dict, optional
1656
+ :param _content_type: force content-type for the request.
1657
+ :type _content_type: str, Optional
1658
+ :param _headers: set to override the headers for a single
1659
+ request; this effectively ignores the headers
1660
+ in the spec for a single request.
1661
+ :type _headers: dict, optional
1662
+ :param _host_index: set to override the host_index for a single
1663
+ request; this effectively ignores the host_index
1664
+ in the spec for a single request.
1665
+ :type _host_index: int, optional
1666
+ :return: Returns the result object.
1667
+ """ # noqa: E501
1668
+
1669
+ _param = self._update_configuration_by_host_serialize(
1670
+ host_id=host_id,
1671
+ agent_configuration_update=agent_configuration_update,
1672
+ _request_auth=_request_auth,
1673
+ _content_type=_content_type,
1674
+ _headers=_headers,
1675
+ _host_index=_host_index
1676
+ )
1677
+
1678
+ _response_types_map: Dict[str, Optional[str]] = {
1679
+ }
1680
+ response_data = self.api_client.call_api(
1681
+ *_param,
1682
+ _request_timeout=_request_timeout
1683
+ )
1684
+ return response_data.response
1685
+
1686
+
1687
+ def _update_configuration_by_host_serialize(
1688
+ self,
1689
+ host_id,
1690
+ agent_configuration_update,
1691
+ _request_auth,
1692
+ _content_type,
1693
+ _headers,
1694
+ _host_index,
1695
+ ) -> RequestSerialized:
1696
+
1697
+ _host = None
1698
+
1699
+ _collection_formats: Dict[str, str] = {
1700
+ }
1701
+
1702
+ _path_params: Dict[str, str] = {}
1703
+ _query_params: List[Tuple[str, str]] = []
1704
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1705
+ _form_params: List[Tuple[str, str]] = []
1706
+ _files: Dict[
1707
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1708
+ ] = {}
1709
+ _body_params: Optional[bytes] = None
1710
+
1711
+ # process the path parameters
1712
+ if host_id is not None:
1713
+ _path_params['hostId'] = host_id
1714
+ # process the query parameters
1715
+ # process the header parameters
1716
+ # process the form parameters
1717
+ # process the body parameter
1718
+ if agent_configuration_update is not None:
1719
+ _body_params = agent_configuration_update
1720
+
1721
+
1722
+ # set the HTTP header `Accept`
1723
+ if 'Accept' not in _header_params:
1724
+ _header_params['Accept'] = self.api_client.select_header_accept(
1725
+ [
1726
+ 'application/json'
1727
+ ]
1728
+ )
1729
+
1730
+ # set the HTTP header `Content-Type`
1731
+ if _content_type:
1732
+ _header_params['Content-Type'] = _content_type
1733
+ else:
1734
+ _default_content_type = (
1735
+ self.api_client.select_header_content_type(
1736
+ [
1737
+ 'application/json'
1738
+ ]
1739
+ )
1740
+ )
1741
+ if _default_content_type is not None:
1742
+ _header_params['Content-Type'] = _default_content_type
1743
+
1744
+ # authentication setting
1745
+ _auth_settings: List[str] = [
1746
+ 'ApiKeyAuth'
1747
+ ]
1748
+
1749
+ return self.api_client.param_serialize(
1750
+ method='POST',
1751
+ resource_path='/api/host-agent/{hostId}/configuration',
1752
+ path_params=_path_params,
1753
+ query_params=_query_params,
1754
+ header_params=_header_params,
1755
+ body=_body_params,
1756
+ post_params=_form_params,
1757
+ files=_files,
1758
+ auth_settings=_auth_settings,
1759
+ collection_formats=_collection_formats,
1760
+ _host=_host,
1761
+ _request_auth=_request_auth
1762
+ )
1763
+
1764
+
1765
+
1766
+
1767
+ @validate_call
1768
+ def update_configuration_by_query(
1769
+ self,
1770
+ query: Optional[StrictStr] = None,
1771
+ to: Optional[StrictInt] = None,
1772
+ window_size: Optional[StrictInt] = None,
1773
+ size: Optional[StrictInt] = None,
1774
+ offline: Optional[StrictBool] = None,
1775
+ agent_configuration_update: Optional[AgentConfigurationUpdate] = None,
1776
+ _request_timeout: Union[
1777
+ None,
1778
+ Annotated[StrictFloat, Field(gt=0)],
1779
+ Tuple[
1780
+ Annotated[StrictFloat, Field(gt=0)],
1781
+ Annotated[StrictFloat, Field(gt=0)]
1782
+ ]
1783
+ ] = None,
1784
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1785
+ _content_type: Optional[StrictStr] = None,
1786
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1787
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1788
+ ) -> None:
1789
+ """Update agent configuration by query
1790
+
1791
+ This endpoint can be used to initialize or change configuration management settings for all agents selected by the given Dynamic Focus Query.
1792
+
1793
+ :param query:
1794
+ :type query: str
1795
+ :param to:
1796
+ :type to: int
1797
+ :param window_size:
1798
+ :type window_size: int
1799
+ :param size:
1800
+ :type size: int
1801
+ :param offline:
1802
+ :type offline: bool
1803
+ :param agent_configuration_update:
1804
+ :type agent_configuration_update: AgentConfigurationUpdate
1805
+ :param _request_timeout: timeout setting for this request. If one
1806
+ number provided, it will be total request
1807
+ timeout. It can also be a pair (tuple) of
1808
+ (connection, read) timeouts.
1809
+ :type _request_timeout: int, tuple(int, int), optional
1810
+ :param _request_auth: set to override the auth_settings for an a single
1811
+ request; this effectively ignores the
1812
+ authentication in the spec for a single request.
1813
+ :type _request_auth: dict, optional
1814
+ :param _content_type: force content-type for the request.
1815
+ :type _content_type: str, Optional
1816
+ :param _headers: set to override the headers for a single
1817
+ request; this effectively ignores the headers
1818
+ in the spec for a single request.
1819
+ :type _headers: dict, optional
1820
+ :param _host_index: set to override the host_index for a single
1821
+ request; this effectively ignores the host_index
1822
+ in the spec for a single request.
1823
+ :type _host_index: int, optional
1824
+ :return: Returns the result object.
1825
+ """ # noqa: E501
1826
+
1827
+ _param = self._update_configuration_by_query_serialize(
1828
+ query=query,
1829
+ to=to,
1830
+ window_size=window_size,
1831
+ size=size,
1832
+ offline=offline,
1833
+ agent_configuration_update=agent_configuration_update,
1834
+ _request_auth=_request_auth,
1835
+ _content_type=_content_type,
1836
+ _headers=_headers,
1837
+ _host_index=_host_index
1838
+ )
1839
+
1840
+ _response_types_map: Dict[str, Optional[str]] = {
1841
+ }
1842
+ response_data = self.api_client.call_api(
1843
+ *_param,
1844
+ _request_timeout=_request_timeout
1845
+ )
1846
+ response_data.read()
1847
+ return self.api_client.response_deserialize(
1848
+ response_data=response_data,
1849
+ response_types_map=_response_types_map,
1850
+ ).data
1851
+
1852
+
1853
+ @validate_call
1854
+ def update_configuration_by_query_with_http_info(
1855
+ self,
1856
+ query: Optional[StrictStr] = None,
1857
+ to: Optional[StrictInt] = None,
1858
+ window_size: Optional[StrictInt] = None,
1859
+ size: Optional[StrictInt] = None,
1860
+ offline: Optional[StrictBool] = None,
1861
+ agent_configuration_update: Optional[AgentConfigurationUpdate] = None,
1862
+ _request_timeout: Union[
1863
+ None,
1864
+ Annotated[StrictFloat, Field(gt=0)],
1865
+ Tuple[
1866
+ Annotated[StrictFloat, Field(gt=0)],
1867
+ Annotated[StrictFloat, Field(gt=0)]
1868
+ ]
1869
+ ] = None,
1870
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1871
+ _content_type: Optional[StrictStr] = None,
1872
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1873
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1874
+ ) -> ApiResponse[None]:
1875
+ """Update agent configuration by query
1876
+
1877
+ This endpoint can be used to initialize or change configuration management settings for all agents selected by the given Dynamic Focus Query.
1878
+
1879
+ :param query:
1880
+ :type query: str
1881
+ :param to:
1882
+ :type to: int
1883
+ :param window_size:
1884
+ :type window_size: int
1885
+ :param size:
1886
+ :type size: int
1887
+ :param offline:
1888
+ :type offline: bool
1889
+ :param agent_configuration_update:
1890
+ :type agent_configuration_update: AgentConfigurationUpdate
1891
+ :param _request_timeout: timeout setting for this request. If one
1892
+ number provided, it will be total request
1893
+ timeout. It can also be a pair (tuple) of
1894
+ (connection, read) timeouts.
1895
+ :type _request_timeout: int, tuple(int, int), optional
1896
+ :param _request_auth: set to override the auth_settings for an a single
1897
+ request; this effectively ignores the
1898
+ authentication in the spec for a single request.
1899
+ :type _request_auth: dict, optional
1900
+ :param _content_type: force content-type for the request.
1901
+ :type _content_type: str, Optional
1902
+ :param _headers: set to override the headers for a single
1903
+ request; this effectively ignores the headers
1904
+ in the spec for a single request.
1905
+ :type _headers: dict, optional
1906
+ :param _host_index: set to override the host_index for a single
1907
+ request; this effectively ignores the host_index
1908
+ in the spec for a single request.
1909
+ :type _host_index: int, optional
1910
+ :return: Returns the result object.
1911
+ """ # noqa: E501
1912
+
1913
+ _param = self._update_configuration_by_query_serialize(
1914
+ query=query,
1915
+ to=to,
1916
+ window_size=window_size,
1917
+ size=size,
1918
+ offline=offline,
1919
+ agent_configuration_update=agent_configuration_update,
1920
+ _request_auth=_request_auth,
1921
+ _content_type=_content_type,
1922
+ _headers=_headers,
1923
+ _host_index=_host_index
1924
+ )
1925
+
1926
+ _response_types_map: Dict[str, Optional[str]] = {
1927
+ }
1928
+ response_data = self.api_client.call_api(
1929
+ *_param,
1930
+ _request_timeout=_request_timeout
1931
+ )
1932
+ response_data.read()
1933
+ return self.api_client.response_deserialize(
1934
+ response_data=response_data,
1935
+ response_types_map=_response_types_map,
1936
+ )
1937
+
1938
+
1939
+ @validate_call
1940
+ def update_configuration_by_query_without_preload_content(
1941
+ self,
1942
+ query: Optional[StrictStr] = None,
1943
+ to: Optional[StrictInt] = None,
1944
+ window_size: Optional[StrictInt] = None,
1945
+ size: Optional[StrictInt] = None,
1946
+ offline: Optional[StrictBool] = None,
1947
+ agent_configuration_update: Optional[AgentConfigurationUpdate] = None,
1948
+ _request_timeout: Union[
1949
+ None,
1950
+ Annotated[StrictFloat, Field(gt=0)],
1951
+ Tuple[
1952
+ Annotated[StrictFloat, Field(gt=0)],
1953
+ Annotated[StrictFloat, Field(gt=0)]
1954
+ ]
1955
+ ] = None,
1956
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1957
+ _content_type: Optional[StrictStr] = None,
1958
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1959
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1960
+ ) -> RESTResponseType:
1961
+ """Update agent configuration by query
1962
+
1963
+ This endpoint can be used to initialize or change configuration management settings for all agents selected by the given Dynamic Focus Query.
1964
+
1965
+ :param query:
1966
+ :type query: str
1967
+ :param to:
1968
+ :type to: int
1969
+ :param window_size:
1970
+ :type window_size: int
1971
+ :param size:
1972
+ :type size: int
1973
+ :param offline:
1974
+ :type offline: bool
1975
+ :param agent_configuration_update:
1976
+ :type agent_configuration_update: AgentConfigurationUpdate
1977
+ :param _request_timeout: timeout setting for this request. If one
1978
+ number provided, it will be total request
1979
+ timeout. It can also be a pair (tuple) of
1980
+ (connection, read) timeouts.
1981
+ :type _request_timeout: int, tuple(int, int), optional
1982
+ :param _request_auth: set to override the auth_settings for an a single
1983
+ request; this effectively ignores the
1984
+ authentication in the spec for a single request.
1985
+ :type _request_auth: dict, optional
1986
+ :param _content_type: force content-type for the request.
1987
+ :type _content_type: str, Optional
1988
+ :param _headers: set to override the headers for a single
1989
+ request; this effectively ignores the headers
1990
+ in the spec for a single request.
1991
+ :type _headers: dict, optional
1992
+ :param _host_index: set to override the host_index for a single
1993
+ request; this effectively ignores the host_index
1994
+ in the spec for a single request.
1995
+ :type _host_index: int, optional
1996
+ :return: Returns the result object.
1997
+ """ # noqa: E501
1998
+
1999
+ _param = self._update_configuration_by_query_serialize(
2000
+ query=query,
2001
+ to=to,
2002
+ window_size=window_size,
2003
+ size=size,
2004
+ offline=offline,
2005
+ agent_configuration_update=agent_configuration_update,
2006
+ _request_auth=_request_auth,
2007
+ _content_type=_content_type,
2008
+ _headers=_headers,
2009
+ _host_index=_host_index
2010
+ )
2011
+
2012
+ _response_types_map: Dict[str, Optional[str]] = {
2013
+ }
2014
+ response_data = self.api_client.call_api(
2015
+ *_param,
2016
+ _request_timeout=_request_timeout
2017
+ )
2018
+ return response_data.response
2019
+
2020
+
2021
+ def _update_configuration_by_query_serialize(
2022
+ self,
2023
+ query,
2024
+ to,
2025
+ window_size,
2026
+ size,
2027
+ offline,
2028
+ agent_configuration_update,
2029
+ _request_auth,
2030
+ _content_type,
2031
+ _headers,
2032
+ _host_index,
2033
+ ) -> RequestSerialized:
2034
+
2035
+ _host = None
2036
+
2037
+ _collection_formats: Dict[str, str] = {
2038
+ }
2039
+
2040
+ _path_params: Dict[str, str] = {}
2041
+ _query_params: List[Tuple[str, str]] = []
2042
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2043
+ _form_params: List[Tuple[str, str]] = []
2044
+ _files: Dict[
2045
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2046
+ ] = {}
2047
+ _body_params: Optional[bytes] = None
2048
+
2049
+ # process the path parameters
2050
+ # process the query parameters
2051
+ if query is not None:
2052
+
2053
+ _query_params.append(('query', query))
2054
+
2055
+ if to is not None:
2056
+
2057
+ _query_params.append(('to', to))
2058
+
2059
+ if window_size is not None:
2060
+
2061
+ _query_params.append(('windowSize', window_size))
2062
+
2063
+ if size is not None:
2064
+
2065
+ _query_params.append(('size', size))
2066
+
2067
+ if offline is not None:
2068
+
2069
+ _query_params.append(('offline', offline))
2070
+
2071
+ # process the header parameters
2072
+ # process the form parameters
2073
+ # process the body parameter
2074
+ if agent_configuration_update is not None:
2075
+ _body_params = agent_configuration_update
2076
+
2077
+
2078
+ # set the HTTP header `Accept`
2079
+ if 'Accept' not in _header_params:
2080
+ _header_params['Accept'] = self.api_client.select_header_accept(
2081
+ [
2082
+ 'application/json'
2083
+ ]
2084
+ )
2085
+
2086
+ # set the HTTP header `Content-Type`
2087
+ if _content_type:
2088
+ _header_params['Content-Type'] = _content_type
2089
+ else:
2090
+ _default_content_type = (
2091
+ self.api_client.select_header_content_type(
2092
+ [
2093
+ 'application/json'
2094
+ ]
2095
+ )
2096
+ )
2097
+ if _default_content_type is not None:
2098
+ _header_params['Content-Type'] = _default_content_type
2099
+
2100
+ # authentication setting
2101
+ _auth_settings: List[str] = [
2102
+ 'ApiKeyAuth'
2103
+ ]
2104
+
2105
+ return self.api_client.param_serialize(
2106
+ method='POST',
2107
+ resource_path='/api/host-agent/configuration',
2108
+ path_params=_path_params,
2109
+ query_params=_query_params,
2110
+ header_params=_header_params,
2111
+ body=_body_params,
2112
+ post_params=_form_params,
2113
+ files=_files,
2114
+ auth_settings=_auth_settings,
2115
+ collection_formats=_collection_formats,
2116
+ _host=_host,
2117
+ _request_auth=_request_auth
2118
+ )
2119
+
2120
+