diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 5a7521e..731ff5e 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -6,11 +6,8 @@ docs/AIManagementApi.md docs/APITokenApi.md docs/AbstractIntegration.md docs/AbstractRule.md -docs/AccessLogEntry.md -docs/AccessLogResponse.md docs/AccessRule.md docs/Action.md -docs/ActionBeacon.md docs/ActionCatalogApi.md docs/ActionConfiguration.md docs/ActionHistoryApi.md @@ -23,9 +20,9 @@ docs/ActionMatch.md docs/ActionSearchSpace.md docs/AdaptiveBaseline.md docs/AdaptiveThresholdRule.md -docs/Addition.md docs/AdjustedTimeframe.md docs/AgentConfigurationUpdate.md +docs/AgentModeUpdate.md docs/AlertingConfiguration.md docs/AlertingConfigurationWithLastUpdated.md docs/AlertingTimeWindow.md @@ -74,11 +71,7 @@ docs/ApplicationSliEntity.md docs/ApplicationSloEntity.md docs/ApplicationTimeThreshold.md docs/ApplicationTopologyApi.md -docs/ArithmeticConfiguration.md -docs/ArithmeticOperand.md -docs/ArithmeticOperation.md docs/AuditLogApi.md -docs/AuditLogEntry.md docs/AuditLogUiResponse.md docs/AuthenticationApi.md docs/Author.md @@ -94,6 +87,7 @@ docs/BrowserScriptConfiguration.md docs/BrowserScriptConfigurationUpdate.md docs/BuiltInEventSpecification.md docs/BuiltInEventSpecificationWithLastUpdated.md +docs/BulkAlertConfigRequest.md docs/BusinessActivity.md docs/BusinessMonitoringApi.md docs/BusinessPerspectiveConfig.md @@ -141,7 +135,6 @@ docs/DashboardApiToken.md docs/DatabaseIntegration.md docs/DefaultApi.md docs/DeprecatedTagFilter.md -docs/Division.md docs/Duration.md docs/DynamicField.md docs/DynamicFieldValue.md @@ -180,7 +173,6 @@ docs/GenericInfraAlertRule.md docs/GeoLocationConfiguration.md docs/GeoMappingRule.md docs/GeoSubdivision.md -docs/GetActionBeaconsResult.md docs/GetActivities.md docs/GetApplicationMetrics.md docs/GetApplications.md @@ -199,7 +191,6 @@ docs/GetMobileAppMetrics.md docs/GetMobileAppMetricsV2.md docs/GetPayloadKeysResult.md docs/GetServices.md -docs/GetSessionReplayMetadataResult.md docs/GetSnapshotsQuery.md docs/GetTestResult.md docs/GetTestResultAnalytic.md @@ -237,6 +228,13 @@ docs/HttpPathSegmentMatchingRule.md docs/HttpScriptConfiguration.md docs/HttpScriptConfigurationUpdate.md docs/HyperParam.md +docs/ICMPConfiguration.md +docs/ICMPConfigurationUpdate.md +docs/ICMPValidation.md +docs/IPFiltering.md +docs/IPFilteringApi.md +docs/IPFilteringRuleDto.md +docs/IPFilteringUpsert.md docs/IdentityProviderPatch.md docs/IdpStatusUpdate.md docs/ImpactedBeaconInfo.md @@ -244,7 +242,6 @@ docs/InfraAlertConfig.md docs/InfraAlertConfigWithMetadata.md docs/InfraAlertRule.md docs/InfraEventResult.md -docs/InfraMetricConfiguration.md docs/InfraSloEntity.md docs/InfraTimeThreshold.md docs/InfrastructureAlertConfigurationApi.md @@ -281,7 +278,6 @@ docs/LogAlertConfigWithMetadata.md docs/LogAlertConfigurationApi.md docs/LogAlertRule.md docs/LogCountAlertRule.md -docs/LogEntryActor.md docs/LogEventResult.md docs/LogTimeThreshold.md docs/LogVolumeGroup.md @@ -306,11 +302,12 @@ docs/MetricAPIResult.md docs/MetricConfig.md docs/MetricConfiguration.md docs/MetricDescription.md +docs/MetricField.md +docs/MetricFieldValue.md docs/MetricInstance.md docs/MetricItem.md docs/MetricMetadata.md docs/MetricPattern.md -docs/MetricQuery.md docs/MetricsResult.md docs/MetricsResultItem.md docs/MetricsTestResultItem.md @@ -337,9 +334,7 @@ docs/ModelField.md docs/MonitoredEntitiesStats.md docs/MonitoringState.md docs/MultipleScriptsConfiguration.md -docs/Multiplication.md docs/NS1Integration.md -docs/NestedOperation.md docs/NewApplicationConfig.md docs/NewBusinessPerspectiveConfig.md docs/NewManualServiceConfig.md @@ -425,12 +420,9 @@ docs/ServiceScopeWithMetadata.md docs/ServiceScopedTo.md docs/ServiceScopedToWithMetadata.md docs/ServiceSimple.md -docs/SessionReplayMetadata.md -docs/SessionReplayTimestamps.md docs/SessionSettings.md docs/SessionSettingsApi.md docs/SimpleMetricConfiguration.md -docs/SingleValue.md docs/SlackIntegration.md docs/SliConfiguration.md docs/SliConfigurationWithLastUpdated.md @@ -463,7 +455,6 @@ docs/StaticThresholdRule.md docs/StatusCodeApplicationAlertRule.md docs/StatusCodeMobileAppAlertRule.md docs/StatusCodeWebsiteAlertRule.md -docs/Subtraction.md docs/SyntheticAlertConfig.md docs/SyntheticAlertConfigWithMetadata.md docs/SyntheticAlertConfigWithRBACTag.md @@ -488,6 +479,7 @@ docs/SyntheticMetricTagGroup.md docs/SyntheticMetricsApi.md docs/SyntheticPlaybackCapabilities.md docs/SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue.md +docs/SyntheticResourceUpdateListICMPValidationListICMPValidation.md docs/SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation.md docs/SyntheticResourceUpdateListStringListString.md docs/SyntheticResourceUpdateMapStringStringListString.md @@ -644,6 +636,7 @@ instana_client/api/infrastructure_catalog_api.py instana_client/api/infrastructure_metrics_api.py instana_client/api/infrastructure_resources_api.py instana_client/api/infrastructure_topology_api.py +instana_client/api/ip_filtering_api.py instana_client/api/llm_price_configuration_api.py instana_client/api/log_alert_configuration_api.py instana_client/api/logging_analyze_api.py @@ -683,11 +676,8 @@ instana_client/exceptions.py instana_client/models/__init__.py instana_client/models/abstract_integration.py instana_client/models/abstract_rule.py -instana_client/models/access_log_entry.py -instana_client/models/access_log_response.py instana_client/models/access_rule.py instana_client/models/action.py -instana_client/models/action_beacon.py instana_client/models/action_configuration.py instana_client/models/action_instance.py instana_client/models/action_instance_metadata_entry.py @@ -698,9 +688,9 @@ instana_client/models/action_match.py instana_client/models/action_search_space.py instana_client/models/adaptive_baseline.py instana_client/models/adaptive_threshold_rule.py -instana_client/models/addition.py instana_client/models/adjusted_timeframe.py instana_client/models/agent_configuration_update.py +instana_client/models/agent_mode_update.py instana_client/models/alerting_configuration.py instana_client/models/alerting_configuration_with_last_updated.py instana_client/models/alerting_time_window.py @@ -740,10 +730,6 @@ instana_client/models/application_scope_with_metadata.py instana_client/models/application_sli_entity.py instana_client/models/application_slo_entity.py instana_client/models/application_time_threshold.py -instana_client/models/arithmetic_configuration.py -instana_client/models/arithmetic_operand.py -instana_client/models/arithmetic_operation.py -instana_client/models/audit_log_entry.py instana_client/models/audit_log_ui_response.py instana_client/models/author.py instana_client/models/availability_blueprint_indicator.py @@ -758,6 +744,7 @@ instana_client/models/browser_script_configuration.py instana_client/models/browser_script_configuration_update.py instana_client/models/built_in_event_specification.py instana_client/models/built_in_event_specification_with_last_updated.py +instana_client/models/bulk_alert_config_request.py instana_client/models/business_activity.py instana_client/models/business_perspective_config.py instana_client/models/call_groups_item.py @@ -797,7 +784,6 @@ instana_client/models/custom_tag.py instana_client/models/dashboard_api_token.py instana_client/models/database_integration.py instana_client/models/deprecated_tag_filter.py -instana_client/models/division.py instana_client/models/dns_configuration.py instana_client/models/dns_configuration_update.py instana_client/models/dns_filter_query_time.py @@ -837,7 +823,6 @@ instana_client/models/generic_infra_alert_rule.py instana_client/models/geo_location_configuration.py instana_client/models/geo_mapping_rule.py instana_client/models/geo_subdivision.py -instana_client/models/get_action_beacons_result.py instana_client/models/get_activities.py instana_client/models/get_application_metrics.py instana_client/models/get_applications.py @@ -856,7 +841,6 @@ instana_client/models/get_mobile_app_metrics.py instana_client/models/get_mobile_app_metrics_v2.py instana_client/models/get_payload_keys_result.py instana_client/models/get_services.py -instana_client/models/get_session_replay_metadata_result.py instana_client/models/get_snapshots_query.py instana_client/models/get_test_result.py instana_client/models/get_test_result_analytic.py @@ -890,6 +874,9 @@ instana_client/models/http_path_segment_matching_rule.py instana_client/models/http_script_configuration.py instana_client/models/http_script_configuration_update.py instana_client/models/hyper_param.py +instana_client/models/icmp_configuration.py +instana_client/models/icmp_configuration_update.py +instana_client/models/icmp_validation.py instana_client/models/identity_provider_patch.py instana_client/models/idp_status_update.py instana_client/models/impacted_beacon_info.py @@ -897,7 +884,6 @@ instana_client/models/infra_alert_config.py instana_client/models/infra_alert_config_with_metadata.py instana_client/models/infra_alert_rule.py instana_client/models/infra_event_result.py -instana_client/models/infra_metric_configuration.py instana_client/models/infra_slo_entity.py instana_client/models/infra_time_threshold.py instana_client/models/infrastructure_entities_result.py @@ -910,6 +896,9 @@ instana_client/models/integration_overview.py instana_client/models/invitation.py instana_client/models/invitation_response.py instana_client/models/invitation_result.py +instana_client/models/ip_filtering.py +instana_client/models/ip_filtering_rule_dto.py +instana_client/models/ip_filtering_upsert.py instana_client/models/ip_masking_configuration.py instana_client/models/js_stack_trace_line.py instana_client/models/kubernetes_physical_context.py @@ -926,7 +915,6 @@ instana_client/models/log_alert_config.py instana_client/models/log_alert_config_with_metadata.py instana_client/models/log_alert_rule.py instana_client/models/log_count_alert_rule.py -instana_client/models/log_entry_actor.py instana_client/models/log_event_result.py instana_client/models/log_time_threshold.py instana_client/models/log_volume_group.py @@ -949,11 +937,12 @@ instana_client/models/metric_api_result.py instana_client/models/metric_config.py instana_client/models/metric_configuration.py instana_client/models/metric_description.py +instana_client/models/metric_field.py +instana_client/models/metric_field_value.py instana_client/models/metric_instance.py instana_client/models/metric_item.py instana_client/models/metric_metadata.py instana_client/models/metric_pattern.py -instana_client/models/metric_query.py instana_client/models/metrics_result.py instana_client/models/metrics_result_item.py instana_client/models/metrics_test_result_item.py @@ -976,8 +965,6 @@ instana_client/models/model_field.py instana_client/models/monitored_entities_stats.py instana_client/models/monitoring_state.py instana_client/models/multiple_scripts_configuration.py -instana_client/models/multiplication.py -instana_client/models/nested_operation.py instana_client/models/new_application_config.py instana_client/models/new_business_perspective_config.py instana_client/models/new_manual_service_config.py @@ -1050,11 +1037,8 @@ instana_client/models/service_scope_with_metadata.py instana_client/models/service_scoped_to.py instana_client/models/service_scoped_to_with_metadata.py instana_client/models/service_simple.py -instana_client/models/session_replay_metadata.py -instana_client/models/session_replay_timestamps.py instana_client/models/session_settings.py instana_client/models/simple_metric_configuration.py -instana_client/models/single_value.py instana_client/models/slack_integration.py instana_client/models/sli_configuration.py instana_client/models/sli_configuration_with_last_updated.py @@ -1091,7 +1075,6 @@ instana_client/models/static_threshold_rule.py instana_client/models/status_code_application_alert_rule.py instana_client/models/status_code_mobile_app_alert_rule.py instana_client/models/status_code_website_alert_rule.py -instana_client/models/subtraction.py instana_client/models/synthetic_alert_config.py instana_client/models/synthetic_alert_config_with_metadata.py instana_client/models/synthetic_alert_config_with_rbac_tag.py @@ -1112,6 +1095,7 @@ instana_client/models/synthetic_metric_configuration.py instana_client/models/synthetic_metric_tag_group.py instana_client/models/synthetic_playback_capabilities.py instana_client/models/synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value.py +instana_client/models/synthetic_resource_update_list_icmp_validation_list_icmp_validation.py instana_client/models/synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation.py instana_client/models/synthetic_resource_update_list_string_list_string.py instana_client/models/synthetic_resource_update_map_string_string_list_string.py @@ -1230,13 +1214,16 @@ setup.cfg setup.py test-requirements.txt test/__init__.py -test/test_action_beacon.py -test/test_apdex_level.py -test/test_cursor_pagination_with_ui_cursor_infra_explore_cursor.py -test/test_dynamic_tag.py -test/test_get_action_beacons_result.py -test/test_llm_gateway_test_connection_request.py -test/test_prefix_object.py -test/test_service_levels_alert_config_with_rbac_tag.py -test/test_test_connection_response.py +test/test_agent_mode_update.py +test/test_bulk_alert_config_request.py +test/test_icmp_configuration.py +test/test_icmp_configuration_update.py +test/test_icmp_validation.py +test/test_ip_filtering.py +test/test_ip_filtering_api.py +test/test_ip_filtering_rule_dto.py +test/test_ip_filtering_upsert.py +test/test_metric_field.py +test/test_metric_field_value.py +test/test_synthetic_resource_update_list_icmp_validation_list_icmp_validation.py tox.ini diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION index 368fd8f..eb1dc6a 100644 --- a/.openapi-generator/VERSION +++ b/.openapi-generator/VERSION @@ -1 +1 @@ -7.15.0 +7.13.0 diff --git a/README.md b/README.md index 4b97fd6..e403733 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ Documentation for INSTANA REST API This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: 1.316.2780 +- API version: 1.319.1109 - Package version: 1.0.7 -- Generator version: 7.15.0 +- Generator version: 7.13.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [http://instana.com](http://instana.com) @@ -219,10 +219,13 @@ Class | Method | HTTP request | Description *CustomEntitiesApi* | [**list_custom_entities**](docs/CustomEntitiesApi.md#list_custom_entities) | **GET** /api/custom-entitytypes | List custom Entity Type Definition *CustomEntitiesApi* | [**update_custom_entity**](docs/CustomEntitiesApi.md#update_custom_entity) | **PUT** /api/custom-entitytypes/{id} | Update a Custom Entity Type *EndUserMonitoringApi* | [**get_impacted_users_report**](docs/EndUserMonitoringApi.md#get_impacted_users_report) | **GET** /api/eum/impact/report/{eventId} | Get impacted users report +*EventSettingsApi* | [**bulk_delete_cross_type_alert_configs**](docs/EventSettingsApi.md#bulk_delete_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/delete | Bulk delete alert configurations across multiple types *EventSettingsApi* | [**bulk_delete_mobile_app_alert_configs**](docs/EventSettingsApi.md#bulk_delete_mobile_app_alert_configs) | **PUT** /api/events/settings/mobile-app-alert-configs/bulk/delete | Bulk delete Mobile Smart Alert Configs *EventSettingsApi* | [**bulk_delete_website_alert_configs**](docs/EventSettingsApi.md#bulk_delete_website_alert_configs) | **PUT** /api/events/settings/website-alert-configs/bulk/delete | Bulk Delete Website Smart Alert Configs +*EventSettingsApi* | [**bulk_disable_cross_type_alert_configs**](docs/EventSettingsApi.md#bulk_disable_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/disable | Bulk disable alert configurations across multiple types *EventSettingsApi* | [**bulk_disable_mobile_app_alert_configs**](docs/EventSettingsApi.md#bulk_disable_mobile_app_alert_configs) | **PUT** /api/events/settings/mobile-app-alert-configs/bulk/disable | Bulk disable Mobile Smart Alert Configs *EventSettingsApi* | [**bulk_disable_website_alert_configs**](docs/EventSettingsApi.md#bulk_disable_website_alert_configs) | **PUT** /api/events/settings/website-alert-configs/bulk/disable | Bulk Disable Website Smart Alert Configs +*EventSettingsApi* | [**bulk_enable_cross_type_alert_configs**](docs/EventSettingsApi.md#bulk_enable_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/enable | Bulk enable alert configurations across multiple types *EventSettingsApi* | [**bulk_enable_mobile_app_alert_configs**](docs/EventSettingsApi.md#bulk_enable_mobile_app_alert_configs) | **PUT** /api/events/settings/mobile-app-alert-configs/bulk/enable | Bulk enable Mobile Smart Alert Configs *EventSettingsApi* | [**bulk_enable_website_alert_configs**](docs/EventSettingsApi.md#bulk_enable_website_alert_configs) | **PUT** /api/events/settings/website-alert-configs/bulk/enable | Bulk Enable Website Smart Alert Configs *EventSettingsApi* | [**create_mobile_app_alert_config**](docs/EventSettingsApi.md#create_mobile_app_alert_config) | **POST** /api/events/settings/mobile-app-alert-configs | Create Mobile Smart Alert Config @@ -283,6 +286,9 @@ Class | Method | HTTP request | Description *EventSettingsApi* | [**upsert_custom_payload_configuration**](docs/EventSettingsApi.md#upsert_custom_payload_configuration) | **PUT** /api/events/settings/custom-payload-configurations | Create/Update Global Custom Payload Configuration *EventSettingsApi* | [**upsert_custom_payload_configuration_v2**](docs/EventSettingsApi.md#upsert_custom_payload_configuration_v2) | **PUT** /api/events/settings/custom-payload-configurations/v2 | Create/Update Global Custom Payload Configuration *EventsApi* | [**agent_monitoring_events**](docs/EventsApi.md#agent_monitoring_events) | **GET** /api/events/agent-monitoring-events | Get Agent Monitoring Events +*EventsApi* | [**bulk_delete_cross_type_alert_configs**](docs/EventsApi.md#bulk_delete_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/delete | Bulk delete alert configurations across multiple types +*EventsApi* | [**bulk_disable_cross_type_alert_configs**](docs/EventsApi.md#bulk_disable_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/disable | Bulk disable alert configurations across multiple types +*EventsApi* | [**bulk_enable_cross_type_alert_configs**](docs/EventsApi.md#bulk_enable_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/enable | Bulk enable alert configurations across multiple types *EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /api/events/{eventId} | Get Event *EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **GET** /api/events | Get all Events *EventsApi* | [**get_events_by_ids**](docs/EventsApi.md#get_events_by_ids) | **POST** /api/events | Get Events by IDs @@ -328,6 +334,13 @@ Class | Method | HTTP request | Description *HostAgentApi* | [**update_agent**](docs/HostAgentApi.md#update_agent) | **POST** /api/host-agent/{hostId}/update | Agent update *HostAgentApi* | [**update_configuration_by_host**](docs/HostAgentApi.md#update_configuration_by_host) | **POST** /api/host-agent/{hostId}/configuration | Update agent configuration by host *HostAgentApi* | [**update_configuration_by_query**](docs/HostAgentApi.md#update_configuration_by_query) | **POST** /api/host-agent/configuration | Update agent configuration by query +*HostAgentApi* | [**update_mode_by_host**](docs/HostAgentApi.md#update_mode_by_host) | **POST** /api/host-agent/{hostId}/mode | Update agent run mode by host +*HostAgentApi* | [**update_mode_by_query**](docs/HostAgentApi.md#update_mode_by_query) | **POST** /api/host-agent/mode | Update agent run mode by query +*IPFilteringApi* | [**delete_ip_filtering**](docs/IPFilteringApi.md#delete_ip_filtering) | **DELETE** /api/settings/ip-filtering | Delete current ip-filtering +*IPFilteringApi* | [**disable_ip_filtering**](docs/IPFilteringApi.md#disable_ip_filtering) | **PATCH** /api/settings/ip-filtering/disable | Disable the current ip-filtering +*IPFilteringApi* | [**get_ip_filtering**](docs/IPFilteringApi.md#get_ip_filtering) | **GET** /api/settings/ip-filtering | Get current ip-filtering +*IPFilteringApi* | [**upsert_ip_filtering**](docs/IPFilteringApi.md#upsert_ip_filtering) | **PUT** /api/settings/ip-filtering | Upsert ip-filtering +*IPFilteringApi* | [**verify_ip_filtering**](docs/IPFilteringApi.md#verify_ip_filtering) | **PATCH** /api/settings/ip-filtering/verify | Verify current ip-filtering *InfrastructureAlertConfigurationApi* | [**bulk_delete_infra_alert_configs**](docs/InfrastructureAlertConfigurationApi.md#bulk_delete_infra_alert_configs) | **PUT** /api/events/settings/infra-alert-configs/bulk/delete | Bulk Delete Infra Smart Alert Configs *InfrastructureAlertConfigurationApi* | [**bulk_disable_infra_alert_configs**](docs/InfrastructureAlertConfigurationApi.md#bulk_disable_infra_alert_configs) | **PUT** /api/events/settings/infra-alert-configs/bulk/disable | Bulk Disable Infra Smart Alert Configs *InfrastructureAlertConfigurationApi* | [**bulk_enable_infra_alert_configs**](docs/InfrastructureAlertConfigurationApi.md#bulk_enable_infra_alert_configs) | **PUT** /api/events/settings/infra-alert-configs/bulk/enable | Bulk Enable Infra Smart Alert Configs @@ -361,6 +374,7 @@ Class | Method | HTTP request | Description *InfrastructureTopologyApi* | [**get_related_hosts**](docs/InfrastructureTopologyApi.md#get_related_hosts) | **GET** /api/infrastructure-monitoring/graph/related-hosts/{snapshotId} | Related hosts *InfrastructureTopologyApi* | [**get_topology**](docs/InfrastructureTopologyApi.md#get_topology) | **GET** /api/infrastructure-monitoring/topology | Gets the infrastructure topology *LLMPriceConfigurationApi* | [**delete_llm_model_price**](docs/LLMPriceConfigurationApi.md#delete_llm_model_price) | **DELETE** /api/settings/llm-pricing/{provider}/{modelName} | Delete LLM model price +*LLMPriceConfigurationApi* | [**delete_llm_model_price_by_query**](docs/LLMPriceConfigurationApi.md#delete_llm_model_price_by_query) | **DELETE** /api/settings/llm-pricing | Delete LLM model price *LLMPriceConfigurationApi* | [**delete_llm_model_price_without_provider**](docs/LLMPriceConfigurationApi.md#delete_llm_model_price_without_provider) | **DELETE** /api/settings/llm-pricing/model/{modelName} | Delete LLM model price without provider *LLMPriceConfigurationApi* | [**get_all_llm_model_prices**](docs/LLMPriceConfigurationApi.md#get_all_llm_model_prices) | **GET** /api/settings/llm-pricing | Get all LLM model prices *LLMPriceConfigurationApi* | [**get_llm_model_currency**](docs/LLMPriceConfigurationApi.md#get_llm_model_currency) | **GET** /api/settings/llm-pricing/currency | Get currency for LLM model prices @@ -368,6 +382,7 @@ Class | Method | HTTP request | Description *LLMPriceConfigurationApi* | [**get_llm_model_price_without_provider**](docs/LLMPriceConfigurationApi.md#get_llm_model_price_without_provider) | **GET** /api/settings/llm-pricing/model/{modelName} | Get LLM model price without provider *LLMPriceConfigurationApi* | [**set_llm_model_currency**](docs/LLMPriceConfigurationApi.md#set_llm_model_currency) | **PUT** /api/settings/llm-pricing/currency | Set currency for LLM model prices *LLMPriceConfigurationApi* | [**upsert_llm_model_price**](docs/LLMPriceConfigurationApi.md#upsert_llm_model_price) | **PUT** /api/settings/llm-pricing/{provider}/{modelName} | Upsert LLM model price +*LLMPriceConfigurationApi* | [**upsert_llm_model_price_from_body**](docs/LLMPriceConfigurationApi.md#upsert_llm_model_price_from_body) | **PUT** /api/settings/llm-pricing | Upsert LLM model price *LLMPriceConfigurationApi* | [**upsert_llm_model_price_without_provider**](docs/LLMPriceConfigurationApi.md#upsert_llm_model_price_without_provider) | **PUT** /api/settings/llm-pricing/model/{modelName} | Upsert LLM model price without provider *LogAlertConfigurationApi* | [**bulk_delete_log_alert_configs**](docs/LogAlertConfigurationApi.md#bulk_delete_log_alert_configs) | **PUT** /api/events/settings/global-alert-configs/logs/bulk/delete | Bulk Delete Log Alert Configs *LogAlertConfigurationApi* | [**bulk_disable_log_alert_configs**](docs/LogAlertConfigurationApi.md#bulk_disable_log_alert_configs) | **PUT** /api/events/settings/global-alert-configs/logs/bulk/disable | Bulk Disable Log Alert Configs @@ -394,12 +409,9 @@ Class | Method | HTTP request | Description *MaintenanceConfigurationApi* | [**resume_recurrent_maintenance_configuration**](docs/MaintenanceConfigurationApi.md#resume_recurrent_maintenance_configuration) | **PUT** /api/settings/v2/maintenance/{id}/resume | Resume maintenance configuration *MobileAppAnalyzeApi* | [**get_mobile_app_beacon_groups**](docs/MobileAppAnalyzeApi.md#get_mobile_app_beacon_groups) | **POST** /api/mobile-app-monitoring/analyze/beacon-groups | Get grouped beacon metrics *MobileAppAnalyzeApi* | [**get_mobile_app_beacons**](docs/MobileAppAnalyzeApi.md#get_mobile_app_beacons) | **POST** /api/mobile-app-monitoring/analyze/beacons | Get all beacons -*MobileAppCatalogApi* | [**get_action_beacons**](docs/MobileAppCatalogApi.md#get_action_beacons) | **GET** /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/action-beacons | Get action beacons for a session *MobileAppCatalogApi* | [**get_all_mobile_app_catalog_tags**](docs/MobileAppCatalogApi.md#get_all_mobile_app_catalog_tags) | **GET** /api/mobile-app-monitoring/catalog/tags | Get all existing mobile app tags *MobileAppCatalogApi* | [**get_mobile_app_metric_catalog**](docs/MobileAppCatalogApi.md#get_mobile_app_metric_catalog) | **GET** /api/mobile-app-monitoring/catalog/metrics | Metric catalog *MobileAppCatalogApi* | [**get_mobile_app_tag_catalog**](docs/MobileAppCatalogApi.md#get_mobile_app_tag_catalog) | **GET** /api/mobile-app-monitoring/catalog | Get mobile app tag catalog -*MobileAppCatalogApi* | [**get_session_replay_metadata**](docs/MobileAppCatalogApi.md#get_session_replay_metadata) | **GET** /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/replay-metadata | Get session replay metadata -*MobileAppCatalogApi* | [**get_session_replay_timestamps**](docs/MobileAppCatalogApi.md#get_session_replay_timestamps) | **GET** /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/replay-timestamps | Get session replay timestamps *MobileAppConfigurationApi* | [**clear_mobile_app_source_map_upload_configuration**](docs/MobileAppConfigurationApi.md#clear_mobile_app_source_map_upload_configuration) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload/{sourceMapConfigId}/clear | Clear sourcemap files for sourcemap upload configuration *MobileAppConfigurationApi* | [**commit_mobile_app_source_map_file**](docs/MobileAppConfigurationApi.md#commit_mobile_app_source_map_file) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload/{sourceMapConfigId}/commit | Commit sourcemap file upload for mobile app *MobileAppConfigurationApi* | [**delete_mobile_app_config**](docs/MobileAppConfigurationApi.md#delete_mobile_app_config) | **DELETE** /api/mobile-app-monitoring/config/{mobileAppId} | Remove mobile app @@ -582,11 +594,8 @@ Class | Method | HTTP request | Description - [AbstractIntegration](docs/AbstractIntegration.md) - [AbstractRule](docs/AbstractRule.md) - - [AccessLogEntry](docs/AccessLogEntry.md) - - [AccessLogResponse](docs/AccessLogResponse.md) - [AccessRule](docs/AccessRule.md) - [Action](docs/Action.md) - - [ActionBeacon](docs/ActionBeacon.md) - [ActionConfiguration](docs/ActionConfiguration.md) - [ActionInstance](docs/ActionInstance.md) - [ActionInstanceMetadataEntry](docs/ActionInstanceMetadataEntry.md) @@ -597,9 +606,9 @@ Class | Method | HTTP request | Description - [ActionSearchSpace](docs/ActionSearchSpace.md) - [AdaptiveBaseline](docs/AdaptiveBaseline.md) - [AdaptiveThresholdRule](docs/AdaptiveThresholdRule.md) - - [Addition](docs/Addition.md) - [AdjustedTimeframe](docs/AdjustedTimeframe.md) - [AgentConfigurationUpdate](docs/AgentConfigurationUpdate.md) + - [AgentModeUpdate](docs/AgentModeUpdate.md) - [AlertingConfiguration](docs/AlertingConfiguration.md) - [AlertingConfigurationWithLastUpdated](docs/AlertingConfigurationWithLastUpdated.md) - [AlertingTimeWindow](docs/AlertingTimeWindow.md) @@ -639,10 +648,6 @@ Class | Method | HTTP request | Description - [ApplicationSliEntity](docs/ApplicationSliEntity.md) - [ApplicationSloEntity](docs/ApplicationSloEntity.md) - [ApplicationTimeThreshold](docs/ApplicationTimeThreshold.md) - - [ArithmeticConfiguration](docs/ArithmeticConfiguration.md) - - [ArithmeticOperand](docs/ArithmeticOperand.md) - - [ArithmeticOperation](docs/ArithmeticOperation.md) - - [AuditLogEntry](docs/AuditLogEntry.md) - [AuditLogUiResponse](docs/AuditLogUiResponse.md) - [Author](docs/Author.md) - [AvailabilityBlueprintIndicator](docs/AvailabilityBlueprintIndicator.md) @@ -657,6 +662,7 @@ Class | Method | HTTP request | Description - [BrowserScriptConfigurationUpdate](docs/BrowserScriptConfigurationUpdate.md) - [BuiltInEventSpecification](docs/BuiltInEventSpecification.md) - [BuiltInEventSpecificationWithLastUpdated](docs/BuiltInEventSpecificationWithLastUpdated.md) + - [BulkAlertConfigRequest](docs/BulkAlertConfigRequest.md) - [BusinessActivity](docs/BusinessActivity.md) - [BusinessPerspectiveConfig](docs/BusinessPerspectiveConfig.md) - [CallGroupsItem](docs/CallGroupsItem.md) @@ -700,7 +706,6 @@ Class | Method | HTTP request | Description - [DashboardApiToken](docs/DashboardApiToken.md) - [DatabaseIntegration](docs/DatabaseIntegration.md) - [DeprecatedTagFilter](docs/DeprecatedTagFilter.md) - - [Division](docs/Division.md) - [Duration](docs/Duration.md) - [DynamicField](docs/DynamicField.md) - [DynamicFieldValue](docs/DynamicFieldValue.md) @@ -736,7 +741,6 @@ Class | Method | HTTP request | Description - [GeoLocationConfiguration](docs/GeoLocationConfiguration.md) - [GeoMappingRule](docs/GeoMappingRule.md) - [GeoSubdivision](docs/GeoSubdivision.md) - - [GetActionBeaconsResult](docs/GetActionBeaconsResult.md) - [GetActivities](docs/GetActivities.md) - [GetApplicationMetrics](docs/GetApplicationMetrics.md) - [GetApplications](docs/GetApplications.md) @@ -755,7 +759,6 @@ Class | Method | HTTP request | Description - [GetMobileAppMetricsV2](docs/GetMobileAppMetricsV2.md) - [GetPayloadKeysResult](docs/GetPayloadKeysResult.md) - [GetServices](docs/GetServices.md) - - [GetSessionReplayMetadataResult](docs/GetSessionReplayMetadataResult.md) - [GetSnapshotsQuery](docs/GetSnapshotsQuery.md) - [GetTestResult](docs/GetTestResult.md) - [GetTestResultAnalytic](docs/GetTestResultAnalytic.md) @@ -789,6 +792,12 @@ Class | Method | HTTP request | Description - [HttpScriptConfiguration](docs/HttpScriptConfiguration.md) - [HttpScriptConfigurationUpdate](docs/HttpScriptConfigurationUpdate.md) - [HyperParam](docs/HyperParam.md) + - [ICMPConfiguration](docs/ICMPConfiguration.md) + - [ICMPConfigurationUpdate](docs/ICMPConfigurationUpdate.md) + - [ICMPValidation](docs/ICMPValidation.md) + - [IPFiltering](docs/IPFiltering.md) + - [IPFilteringRuleDto](docs/IPFilteringRuleDto.md) + - [IPFilteringUpsert](docs/IPFilteringUpsert.md) - [IdentityProviderPatch](docs/IdentityProviderPatch.md) - [IdpStatusUpdate](docs/IdpStatusUpdate.md) - [ImpactedBeaconInfo](docs/ImpactedBeaconInfo.md) @@ -796,7 +805,6 @@ Class | Method | HTTP request | Description - [InfraAlertConfigWithMetadata](docs/InfraAlertConfigWithMetadata.md) - [InfraAlertRule](docs/InfraAlertRule.md) - [InfraEventResult](docs/InfraEventResult.md) - - [InfraMetricConfiguration](docs/InfraMetricConfiguration.md) - [InfraSloEntity](docs/InfraSloEntity.md) - [InfraTimeThreshold](docs/InfraTimeThreshold.md) - [InfrastructureEntitiesResult](docs/InfrastructureEntitiesResult.md) @@ -825,7 +833,6 @@ Class | Method | HTTP request | Description - [LogAlertConfigWithMetadata](docs/LogAlertConfigWithMetadata.md) - [LogAlertRule](docs/LogAlertRule.md) - [LogCountAlertRule](docs/LogCountAlertRule.md) - - [LogEntryActor](docs/LogEntryActor.md) - [LogEventResult](docs/LogEventResult.md) - [LogTimeThreshold](docs/LogTimeThreshold.md) - [LogVolumeGroup](docs/LogVolumeGroup.md) @@ -848,11 +855,12 @@ Class | Method | HTTP request | Description - [MetricConfig](docs/MetricConfig.md) - [MetricConfiguration](docs/MetricConfiguration.md) - [MetricDescription](docs/MetricDescription.md) + - [MetricField](docs/MetricField.md) + - [MetricFieldValue](docs/MetricFieldValue.md) - [MetricInstance](docs/MetricInstance.md) - [MetricItem](docs/MetricItem.md) - [MetricMetadata](docs/MetricMetadata.md) - [MetricPattern](docs/MetricPattern.md) - - [MetricQuery](docs/MetricQuery.md) - [MetricsResult](docs/MetricsResult.md) - [MetricsResultItem](docs/MetricsResultItem.md) - [MetricsTestResultItem](docs/MetricsTestResultItem.md) @@ -875,9 +883,7 @@ Class | Method | HTTP request | Description - [MonitoredEntitiesStats](docs/MonitoredEntitiesStats.md) - [MonitoringState](docs/MonitoringState.md) - [MultipleScriptsConfiguration](docs/MultipleScriptsConfiguration.md) - - [Multiplication](docs/Multiplication.md) - [NS1Integration](docs/NS1Integration.md) - - [NestedOperation](docs/NestedOperation.md) - [NewApplicationConfig](docs/NewApplicationConfig.md) - [NewBusinessPerspectiveConfig](docs/NewBusinessPerspectiveConfig.md) - [NewManualServiceConfig](docs/NewManualServiceConfig.md) @@ -953,11 +959,8 @@ Class | Method | HTTP request | Description - [ServiceScopedTo](docs/ServiceScopedTo.md) - [ServiceScopedToWithMetadata](docs/ServiceScopedToWithMetadata.md) - [ServiceSimple](docs/ServiceSimple.md) - - [SessionReplayMetadata](docs/SessionReplayMetadata.md) - - [SessionReplayTimestamps](docs/SessionReplayTimestamps.md) - [SessionSettings](docs/SessionSettings.md) - [SimpleMetricConfiguration](docs/SimpleMetricConfiguration.md) - - [SingleValue](docs/SingleValue.md) - [SlackIntegration](docs/SlackIntegration.md) - [SliConfiguration](docs/SliConfiguration.md) - [SliConfigurationWithLastUpdated](docs/SliConfigurationWithLastUpdated.md) @@ -990,7 +993,6 @@ Class | Method | HTTP request | Description - [StatusCodeApplicationAlertRule](docs/StatusCodeApplicationAlertRule.md) - [StatusCodeMobileAppAlertRule](docs/StatusCodeMobileAppAlertRule.md) - [StatusCodeWebsiteAlertRule](docs/StatusCodeWebsiteAlertRule.md) - - [Subtraction](docs/Subtraction.md) - [SyntheticAlertConfig](docs/SyntheticAlertConfig.md) - [SyntheticAlertConfigWithMetadata](docs/SyntheticAlertConfigWithMetadata.md) - [SyntheticAlertConfigWithRBACTag](docs/SyntheticAlertConfigWithRBACTag.md) @@ -1011,6 +1013,7 @@ Class | Method | HTTP request | Description - [SyntheticMetricTagGroup](docs/SyntheticMetricTagGroup.md) - [SyntheticPlaybackCapabilities](docs/SyntheticPlaybackCapabilities.md) - [SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue](docs/SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue.md) + - [SyntheticResourceUpdateListICMPValidationListICMPValidation](docs/SyntheticResourceUpdateListICMPValidationListICMPValidation.md) - [SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation](docs/SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation.md) - [SyntheticResourceUpdateListStringListString](docs/SyntheticResourceUpdateListStringListString.md) - [SyntheticResourceUpdateMapStringStringListString](docs/SyntheticResourceUpdateMapStringStringListString.md) diff --git a/docs/AgentModeUpdate.md b/docs/AgentModeUpdate.md new file mode 100644 index 0000000..abedfba --- /dev/null +++ b/docs/AgentModeUpdate.md @@ -0,0 +1,30 @@ +# AgentModeUpdate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**agent_mode** | **str** | | +**mode_as_integer** | **int** | | [optional] + +## Example + +```python +from instana_client.models.agent_mode_update import AgentModeUpdate + +# TODO update the JSON string below +json = "{}" +# create an instance of AgentModeUpdate from a JSON string +agent_mode_update_instance = AgentModeUpdate.from_json(json) +# print the JSON string representation of the object +print(AgentModeUpdate.to_json()) + +# convert the object into a dict +agent_mode_update_dict = agent_mode_update_instance.to_dict() +# create an instance of AgentModeUpdate from a dict +agent_mode_update_from_dict = AgentModeUpdate.from_dict(agent_mode_update_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApiToken.md b/docs/ApiToken.md index 20890ab..1245ab3 100644 --- a/docs/ApiToken.md +++ b/docs/ApiToken.md @@ -86,6 +86,7 @@ Name | Type | Description | Notes **limited_applications_scope** | **bool** | | [optional] **limited_automation_scope** | **bool** | | [optional] **limited_biz_ops_scope** | **bool** | | [optional] +**limited_gen_ai_capabilities_scope** | **bool** | | [optional] **limited_gen_ai_scope** | **bool** | | [optional] **limited_infrastructure_scope** | **bool** | | [optional] **limited_kubernetes_scope** | **bool** | | [optional] diff --git a/docs/AuditLogApi.md b/docs/AuditLogApi.md index 5c8e35c..d86b9d5 100644 --- a/docs/AuditLogApi.md +++ b/docs/AuditLogApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **get_access_logs** -> AccessLogResponse get_access_logs(offset=offset, query=query, page_size=page_size) +> AuditLogUiResponse get_access_logs(offset=offset, query=query, page_size=page_size) Access log @@ -21,7 +21,7 @@ Retrieve all access logs using defined query. ```python import instana_client -from instana_client.models.access_log_response import AccessLogResponse +from instana_client.models.audit_log_ui_response import AuditLogUiResponse from instana_client.rest import ApiException from pprint import pprint @@ -72,7 +72,7 @@ Name | Type | Description | Notes ### Return type -[**AccessLogResponse**](AccessLogResponse.md) +[**AuditLogUiResponse**](AuditLogUiResponse.md) ### Authorization diff --git a/docs/AuditLogUiResponse.md b/docs/AuditLogUiResponse.md index 5106e4c..b582d95 100644 --- a/docs/AuditLogUiResponse.md +++ b/docs/AuditLogUiResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**entries** | [**List[AuditLogEntry]**](AuditLogEntry.md) | | [optional] +**entries** | **List[object]** | | [optional] **total** | **int** | | [optional] ## Example diff --git a/docs/BuiltInEventSpecification.md b/docs/BuiltInEventSpecification.md index 9207296..f171c20 100644 --- a/docs/BuiltInEventSpecification.md +++ b/docs/BuiltInEventSpecification.md @@ -14,6 +14,7 @@ Name | Type | Description | Notes **rule_inputs** | [**List[RuleInput]**](RuleInput.md) | List of input rules of the Built-in Event Specification | **severity** | **int** | Severity level of Built-in Event Specification | [optional] **short_plugin_id** | **str** | ID of short plugin of Built-in Event Specification | +**supported_poll_rate_seconds** | **int** | | [optional] **triggering** | **bool** | Flag to show whether the Built-in Event Specification is triggering | [optional] ## Example diff --git a/docs/BuiltInEventSpecificationWithLastUpdated.md b/docs/BuiltInEventSpecificationWithLastUpdated.md index e1ad8c1..5020db7 100644 --- a/docs/BuiltInEventSpecificationWithLastUpdated.md +++ b/docs/BuiltInEventSpecificationWithLastUpdated.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **rule_inputs** | [**List[RuleInput]**](RuleInput.md) | List of input rules of the Built-in Event Specification | **severity** | **int** | Severity level of Built-in Event Specification | [optional] **short_plugin_id** | **str** | ID of short plugin of Built-in Event Specification | +**supported_poll_rate_seconds** | **int** | | [optional] **triggering** | **bool** | Flag to show whether the Built-in Event Specification is triggering | [optional] ## Example diff --git a/docs/BulkAlertConfigRequest.md b/docs/BulkAlertConfigRequest.md new file mode 100644 index 0000000..a272bb9 --- /dev/null +++ b/docs/BulkAlertConfigRequest.md @@ -0,0 +1,29 @@ +# BulkAlertConfigRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**configs** | **Dict[str, List[str]]** | | + +## Example + +```python +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of BulkAlertConfigRequest from a JSON string +bulk_alert_config_request_instance = BulkAlertConfigRequest.from_json(json) +# print the JSON string representation of the object +print(BulkAlertConfigRequest.to_json()) + +# convert the object into a dict +bulk_alert_config_request_dict = bulk_alert_config_request_instance.to_dict() +# create an instance of BulkAlertConfigRequest from a dict +bulk_alert_config_request_from_dict = BulkAlertConfigRequest.from_dict(bulk_alert_config_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CustomEntityModel.md b/docs/CustomEntityModel.md index 10343f4..2b1de0b 100644 --- a/docs/CustomEntityModel.md +++ b/docs/CustomEntityModel.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **identifiers** | **List[str]** | | **label** | **str** | | **metrics** | [**List[CustomMetric]**](CustomMetric.md) | | [optional] +**name** | **str** | | [optional] **tag_filter_expression** | [**TagFilterExpressionElement**](TagFilterExpressionElement.md) | | **tags** | [**List[CustomTag]**](CustomTag.md) | | [optional] diff --git a/docs/Event.md b/docs/Event.md index 95308d8..2d4470d 100644 --- a/docs/Event.md +++ b/docs/Event.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes **metric_access_id** | **str** | | [optional] **plugin** | **str** | | **problem** | [**Problem**](Problem.md) | | [optional] +**rbac_tags** | [**List[ApiTag]**](ApiTag.md) | | [optional] **rca** | **Dict[str, object]** | | [optional] **short_code** | **str** | | [optional] **start** | **int** | | [optional] diff --git a/docs/EventSettingsApi.md b/docs/EventSettingsApi.md index 4afac4a..ff930fc 100644 --- a/docs/EventSettingsApi.md +++ b/docs/EventSettingsApi.md @@ -4,10 +4,13 @@ All URIs are relative to *https://unit-tenant.instana.io* Method | HTTP request | Description ------------- | ------------- | ------------- +[**bulk_delete_cross_type_alert_configs**](EventSettingsApi.md#bulk_delete_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/delete | Bulk delete alert configurations across multiple types [**bulk_delete_mobile_app_alert_configs**](EventSettingsApi.md#bulk_delete_mobile_app_alert_configs) | **PUT** /api/events/settings/mobile-app-alert-configs/bulk/delete | Bulk delete Mobile Smart Alert Configs [**bulk_delete_website_alert_configs**](EventSettingsApi.md#bulk_delete_website_alert_configs) | **PUT** /api/events/settings/website-alert-configs/bulk/delete | Bulk Delete Website Smart Alert Configs +[**bulk_disable_cross_type_alert_configs**](EventSettingsApi.md#bulk_disable_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/disable | Bulk disable alert configurations across multiple types [**bulk_disable_mobile_app_alert_configs**](EventSettingsApi.md#bulk_disable_mobile_app_alert_configs) | **PUT** /api/events/settings/mobile-app-alert-configs/bulk/disable | Bulk disable Mobile Smart Alert Configs [**bulk_disable_website_alert_configs**](EventSettingsApi.md#bulk_disable_website_alert_configs) | **PUT** /api/events/settings/website-alert-configs/bulk/disable | Bulk Disable Website Smart Alert Configs +[**bulk_enable_cross_type_alert_configs**](EventSettingsApi.md#bulk_enable_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/enable | Bulk enable alert configurations across multiple types [**bulk_enable_mobile_app_alert_configs**](EventSettingsApi.md#bulk_enable_mobile_app_alert_configs) | **PUT** /api/events/settings/mobile-app-alert-configs/bulk/enable | Bulk enable Mobile Smart Alert Configs [**bulk_enable_website_alert_configs**](EventSettingsApi.md#bulk_enable_website_alert_configs) | **PUT** /api/events/settings/website-alert-configs/bulk/enable | Bulk Enable Website Smart Alert Configs [**create_mobile_app_alert_config**](EventSettingsApi.md#create_mobile_app_alert_config) | **POST** /api/events/settings/mobile-app-alert-configs | Create Mobile Smart Alert Config @@ -69,6 +72,86 @@ Method | HTTP request | Description [**upsert_custom_payload_configuration_v2**](EventSettingsApi.md#upsert_custom_payload_configuration_v2) | **PUT** /api/events/settings/custom-payload-configurations/v2 | Create/Update Global Custom Payload Configuration +# **bulk_delete_cross_type_alert_configs** +> bulk_delete_cross_type_alert_configs(bulk_alert_config_request) + +Bulk delete alert configurations across multiple types + +Atomically deletes alert configurations across multiple types. All operations succeed or all fail. Deletion is logical (creates new version with deleted=true) to maintain audit trail. Requires appropriate permissions for each alert config type in the request. For example, deleting WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.EventSettingsApi(api_client) + bulk_alert_config_request = {"configs":{"WEBSITE":["id1","id2"],"APPLICATION":["id3","id4"],"INFRA":["id5"]}} # BulkAlertConfigRequest | Map of alert config types to sets of IDs to delete + + try: + # Bulk delete alert configurations across multiple types + api_instance.bulk_delete_cross_type_alert_configs(bulk_alert_config_request) + except Exception as e: + print("Exception when calling EventSettingsApi->bulk_delete_cross_type_alert_configs: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulk_alert_config_request** | [**BulkAlertConfigRequest**](BulkAlertConfigRequest.md)| Map of alert config types to sets of IDs to delete | + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successful - no content to return. | - | +**400** | Bad request. | - | +**401** | Unauthorized - No valid authentication provided | - | +**403** | Forbidden - Missing required permissions for one or more alert config types | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **bulk_delete_mobile_app_alert_configs** > bulk_delete_mobile_app_alert_configs(request_body) @@ -225,6 +308,86 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **bulk_disable_cross_type_alert_configs** +> bulk_disable_cross_type_alert_configs(bulk_alert_config_request) + +Bulk disable alert configurations across multiple types + +Atomically disables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, disabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.EventSettingsApi(api_client) + bulk_alert_config_request = {"configs":{"WEBSITE":["id1","id2"],"APPLICATION":["id3","id4"],"INFRA":["id5"]}} # BulkAlertConfigRequest | Map of alert config types to sets of IDs to disable + + try: + # Bulk disable alert configurations across multiple types + api_instance.bulk_disable_cross_type_alert_configs(bulk_alert_config_request) + except Exception as e: + print("Exception when calling EventSettingsApi->bulk_disable_cross_type_alert_configs: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulk_alert_config_request** | [**BulkAlertConfigRequest**](BulkAlertConfigRequest.md)| Map of alert config types to sets of IDs to disable | + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successful - no content to return. | - | +**400** | Bad request. | - | +**401** | Unauthorized - No valid authentication provided | - | +**403** | Forbidden - Missing required permissions for one or more alert config types | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **bulk_disable_mobile_app_alert_configs** > bulk_disable_mobile_app_alert_configs(request_body) @@ -381,6 +544,86 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **bulk_enable_cross_type_alert_configs** +> bulk_enable_cross_type_alert_configs(bulk_alert_config_request) + +Bulk enable alert configurations across multiple types + +Atomically enables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, enabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.EventSettingsApi(api_client) + bulk_alert_config_request = {"configs":{"WEBSITE":["id1","id2"],"APPLICATION":["id3","id4"],"INFRA":["id5"]}} # BulkAlertConfigRequest | Map of alert config types to sets of IDs to enable + + try: + # Bulk enable alert configurations across multiple types + api_instance.bulk_enable_cross_type_alert_configs(bulk_alert_config_request) + except Exception as e: + print("Exception when calling EventSettingsApi->bulk_enable_cross_type_alert_configs: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulk_alert_config_request** | [**BulkAlertConfigRequest**](BulkAlertConfigRequest.md)| Map of alert config types to sets of IDs to enable | + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successful - no content to return. | - | +**400** | Bad request. | - | +**401** | Unauthorized - No valid authentication provided | - | +**403** | Forbidden - Missing required permissions for one or more alert config types | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **bulk_enable_mobile_app_alert_configs** > bulk_enable_mobile_app_alert_configs(request_body) @@ -2937,11 +3180,11 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_built_in_event_specifications** -> List[BuiltInEventSpecificationWithLastUpdated] get_built_in_event_specifications(ids=ids) +> List[BuiltInEventSpecificationWithLastUpdated] get_built_in_event_specifications(ids=ids, plugins=plugins) All built-in event specification -Get all built-in event specifications +Get all built-in event specifications. Can be filtered by event IDs or plugin IDs. ### Example @@ -2975,10 +3218,11 @@ with instana_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = instana_client.EventSettingsApi(api_client) ids = ['ids_example'] # List[str] | (optional) + plugins = ['plugins_example'] # List[str] | (optional) try: # All built-in event specification - api_response = api_instance.get_built_in_event_specifications(ids=ids) + api_response = api_instance.get_built_in_event_specifications(ids=ids, plugins=plugins) print("The response of EventSettingsApi->get_built_in_event_specifications:\n") pprint(api_response) except Exception as e: @@ -2993,6 +3237,7 @@ with instana_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ids** | [**List[str]**](str.md)| | [optional] + **plugins** | [**List[str]**](str.md)| | [optional] ### Return type @@ -3018,11 +3263,11 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_current_prefix** -> get_current_prefix() +> PrefixObject get_current_prefix() Get current shortcode prefix. -Returns the current shortcode prefix used for events. +Returns the current shortcode prefix and enabled state used for events. ### Example @@ -3030,6 +3275,7 @@ Returns the current shortcode prefix used for events. ```python import instana_client +from instana_client.models.prefix_object import PrefixObject from instana_client.rest import ApiException from pprint import pprint @@ -3057,7 +3303,9 @@ with instana_client.ApiClient(configuration) as api_client: try: # Get current shortcode prefix. - api_instance.get_current_prefix() + api_response = api_instance.get_current_prefix() + print("The response of EventSettingsApi->get_current_prefix:\n") + pprint(api_response) except Exception as e: print("Exception when calling EventSettingsApi->get_current_prefix: %s\n" % e) ``` @@ -3070,7 +3318,7 @@ This endpoint does not need any parameter. ### Return type -void (empty response body) +[**PrefixObject**](PrefixObject.md) ### Authorization @@ -3079,13 +3327,13 @@ void (empty response body) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | The current shortcode prefix. | - | +**200** | The current shortcode prefix and enabled state. | - | **401** | Unauthorized access - requires user authentication. | - | **403** | Insufficient permissions or limited in access. | - | @@ -4727,7 +4975,7 @@ void (empty response body) Update shortcode prefix. -Updates the shortcode prefix used for events. The prefix will be applied to all new incidents created after this update. For example, setting the prefix to 'PROD-' will result in incident codes like 'PROD-1', 'PROD-2', etc. +Updates the shortcode prefix and enabled state used for events. The prefix will be applied to all new incidents created after this update. For example, setting the prefix to 'PROD-' with enabled=true will result in incident codes like 'PROD-1', 'PROD-2', etc. The enabled field allows explicit control over whether the shortcode feature is active. ### Example @@ -4760,7 +5008,7 @@ configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] with instana_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = instana_client.EventSettingsApi(api_client) - prefix_object = {"prefix":"INSTANA-"} # PrefixObject | The new prefix configuration + prefix_object = {"prefix":"","enabled":false} # PrefixObject | The new prefix configuration including the enabled state try: # Update shortcode prefix. @@ -4778,7 +5026,7 @@ with instana_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **prefix_object** | [**PrefixObject**](PrefixObject.md)| The new prefix configuration | + **prefix_object** | [**PrefixObject**](PrefixObject.md)| The new prefix configuration including the enabled state | ### Return type @@ -4797,7 +5045,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | The prefix was successfully updated. | - | +**200** | The prefix and enabled state were successfully updated. | - | **401** | Unauthorized access - requires user authentication. | - | **403** | Insufficient permissions or limited in access. | - | @@ -5052,6 +5300,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | +**400** | Bad request. | - | **401** | Unauthorized access - requires user authentication. | - | **403** | Insufficient permissions or limited in access. | - | **422** | Unable to process request, request data is invalid. | - | diff --git a/docs/EventsApi.md b/docs/EventsApi.md index d72e64e..4457389 100644 --- a/docs/EventsApi.md +++ b/docs/EventsApi.md @@ -5,6 +5,9 @@ All URIs are relative to *https://unit-tenant.instana.io* Method | HTTP request | Description ------------- | ------------- | ------------- [**agent_monitoring_events**](EventsApi.md#agent_monitoring_events) | **GET** /api/events/agent-monitoring-events | Get Agent Monitoring Events +[**bulk_delete_cross_type_alert_configs**](EventsApi.md#bulk_delete_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/delete | Bulk delete alert configurations across multiple types +[**bulk_disable_cross_type_alert_configs**](EventsApi.md#bulk_disable_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/disable | Bulk disable alert configurations across multiple types +[**bulk_enable_cross_type_alert_configs**](EventsApi.md#bulk_enable_cross_type_alert_configs) | **PUT** /api/events/settings/alert-configs/bulk/enable | Bulk enable alert configurations across multiple types [**get_event**](EventsApi.md#get_event) | **GET** /api/events/{eventId} | Get Event [**get_events**](EventsApi.md#get_events) | **GET** /api/events | Get all Events [**get_events_by_ids**](EventsApi.md#get_events_by_ids) | **POST** /api/events | Get Events by IDs @@ -99,6 +102,246 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **bulk_delete_cross_type_alert_configs** +> bulk_delete_cross_type_alert_configs(bulk_alert_config_request) + +Bulk delete alert configurations across multiple types + +Atomically deletes alert configurations across multiple types. All operations succeed or all fail. Deletion is logical (creates new version with deleted=true) to maintain audit trail. Requires appropriate permissions for each alert config type in the request. For example, deleting WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.EventsApi(api_client) + bulk_alert_config_request = {"configs":{"WEBSITE":["id1","id2"],"APPLICATION":["id3","id4"],"INFRA":["id5"]}} # BulkAlertConfigRequest | Map of alert config types to sets of IDs to delete + + try: + # Bulk delete alert configurations across multiple types + api_instance.bulk_delete_cross_type_alert_configs(bulk_alert_config_request) + except Exception as e: + print("Exception when calling EventsApi->bulk_delete_cross_type_alert_configs: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulk_alert_config_request** | [**BulkAlertConfigRequest**](BulkAlertConfigRequest.md)| Map of alert config types to sets of IDs to delete | + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successful - no content to return. | - | +**400** | Bad request. | - | +**401** | Unauthorized - No valid authentication provided | - | +**403** | Forbidden - Missing required permissions for one or more alert config types | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **bulk_disable_cross_type_alert_configs** +> bulk_disable_cross_type_alert_configs(bulk_alert_config_request) + +Bulk disable alert configurations across multiple types + +Atomically disables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, disabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.EventsApi(api_client) + bulk_alert_config_request = {"configs":{"WEBSITE":["id1","id2"],"APPLICATION":["id3","id4"],"INFRA":["id5"]}} # BulkAlertConfigRequest | Map of alert config types to sets of IDs to disable + + try: + # Bulk disable alert configurations across multiple types + api_instance.bulk_disable_cross_type_alert_configs(bulk_alert_config_request) + except Exception as e: + print("Exception when calling EventsApi->bulk_disable_cross_type_alert_configs: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulk_alert_config_request** | [**BulkAlertConfigRequest**](BulkAlertConfigRequest.md)| Map of alert config types to sets of IDs to disable | + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successful - no content to return. | - | +**400** | Bad request. | - | +**401** | Unauthorized - No valid authentication provided | - | +**403** | Forbidden - Missing required permissions for one or more alert config types | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **bulk_enable_cross_type_alert_configs** +> bulk_enable_cross_type_alert_configs(bulk_alert_config_request) + +Bulk enable alert configurations across multiple types + +Atomically enables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, enabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.EventsApi(api_client) + bulk_alert_config_request = {"configs":{"WEBSITE":["id1","id2"],"APPLICATION":["id3","id4"],"INFRA":["id5"]}} # BulkAlertConfigRequest | Map of alert config types to sets of IDs to enable + + try: + # Bulk enable alert configurations across multiple types + api_instance.bulk_enable_cross_type_alert_configs(bulk_alert_config_request) + except Exception as e: + print("Exception when calling EventsApi->bulk_enable_cross_type_alert_configs: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulk_alert_config_request** | [**BulkAlertConfigRequest**](BulkAlertConfigRequest.md)| Map of alert config types to sets of IDs to enable | + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successful - no content to return. | - | +**400** | Bad request. | - | +**401** | Unauthorized - No valid authentication provided | - | +**403** | Forbidden - Missing required permissions for one or more alert config types | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_event** > EventResult get_event(event_id) diff --git a/docs/GetInfrastructureGroupsQuery.md b/docs/GetInfrastructureGroupsQuery.md index 44c23ce..d4926ba 100644 --- a/docs/GetInfrastructureGroupsQuery.md +++ b/docs/GetInfrastructureGroupsQuery.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **group_by** | **List[str]** | Entity grouping tag. Use the Instana Analyze Infrastructure dashboard to determine the entity grouping tag name. | -**metrics** | [**List[InfraMetricConfiguration]**](InfraMetricConfiguration.md) | | [optional] +**metrics** | [**List[SimpleMetricConfiguration]**](SimpleMetricConfiguration.md) | | [optional] **missing_placeholder** | **str** | | [optional] **order** | [**Order**](Order.md) | | [optional] **pagination** | [**CursorPaginationWithUiCursorInfraExploreCursor**](CursorPaginationWithUiCursorInfraExploreCursor.md) | | diff --git a/docs/GetInfrastructureQuery.md b/docs/GetInfrastructureQuery.md index b651f34..0c1f380 100644 --- a/docs/GetInfrastructureQuery.md +++ b/docs/GetInfrastructureQuery.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**metrics** | [**List[InfraMetricConfiguration]**](InfraMetricConfiguration.md) | | [optional] +**metrics** | [**List[SimpleMetricConfiguration]**](SimpleMetricConfiguration.md) | | [optional] **missing_placeholder** | **str** | | [optional] **order** | [**Order**](Order.md) | | [optional] **pagination** | [**CursorPaginationWithUiCursorInfraExploreCursor**](CursorPaginationWithUiCursorInfraExploreCursor.md) | | diff --git a/docs/HostAgentApi.md b/docs/HostAgentApi.md index 50ae431..9a363d4 100644 --- a/docs/HostAgentApi.md +++ b/docs/HostAgentApi.md @@ -13,6 +13,8 @@ Method | HTTP request | Description [**update_agent**](HostAgentApi.md#update_agent) | **POST** /api/host-agent/{hostId}/update | Agent update [**update_configuration_by_host**](HostAgentApi.md#update_configuration_by_host) | **POST** /api/host-agent/{hostId}/configuration | Update agent configuration by host [**update_configuration_by_query**](HostAgentApi.md#update_configuration_by_query) | **POST** /api/host-agent/configuration | Update agent configuration by query +[**update_mode_by_host**](HostAgentApi.md#update_mode_by_host) | **POST** /api/host-agent/{hostId}/mode | Update agent run mode by host +[**update_mode_by_query**](HostAgentApi.md#update_mode_by_query) | **POST** /api/host-agent/mode | Update agent run mode by query # **get_agent_clr_logs** @@ -721,3 +723,159 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **update_mode_by_host** +> update_mode_by_host(host_id, agent_mode_update=agent_mode_update) + +Update agent run mode by host + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.agent_mode_update import AgentModeUpdate +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.HostAgentApi(api_client) + host_id = 'host_id_example' # str | + agent_mode_update = instana_client.AgentModeUpdate() # AgentModeUpdate | (optional) + + try: + # Update agent run mode by host + api_instance.update_mode_by_host(host_id, agent_mode_update=agent_mode_update) + except Exception as e: + print("Exception when calling HostAgentApi->update_mode_by_host: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **host_id** | **str**| | + **agent_mode_update** | [**AgentModeUpdate**](AgentModeUpdate.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_mode_by_query** +> update_mode_by_query(query, size=size, agent_mode_update=agent_mode_update) + +Update agent run mode by query + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.agent_mode_update import AgentModeUpdate +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.HostAgentApi(api_client) + query = 'query_example' # str | + size = 56 # int | (optional) + agent_mode_update = instana_client.AgentModeUpdate() # AgentModeUpdate | (optional) + + try: + # Update agent run mode by query + api_instance.update_mode_by_query(query, size=size, agent_mode_update=agent_mode_update) + except Exception as e: + print("Exception when calling HostAgentApi->update_mode_by_query: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **str**| | + **size** | **int**| | [optional] + **agent_mode_update** | [**AgentModeUpdate**](AgentModeUpdate.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | default response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ICMPConfiguration.md b/docs/ICMPConfiguration.md new file mode 100644 index 0000000..2cd1b51 --- /dev/null +++ b/docs/ICMPConfiguration.md @@ -0,0 +1,36 @@ +# ICMPConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**packet_count** | **int** | | [optional] +**packet_interval** | **str** | | [optional] +**packet_size** | **int** | | [optional] +**packet_timeout** | **str** | | [optional] +**target_host** | **str** | | +**use_dns** | **bool** | | [optional] +**use_ipv6** | **bool** | | [optional] +**validation_rules** | [**List[ICMPValidation]**](ICMPValidation.md) | | [optional] + +## Example + +```python +from instana_client.models.icmp_configuration import ICMPConfiguration + +# TODO update the JSON string below +json = "{}" +# create an instance of ICMPConfiguration from a JSON string +icmp_configuration_instance = ICMPConfiguration.from_json(json) +# print the JSON string representation of the object +print(ICMPConfiguration.to_json()) + +# convert the object into a dict +icmp_configuration_dict = icmp_configuration_instance.to_dict() +# create an instance of ICMPConfiguration from a dict +icmp_configuration_from_dict = ICMPConfiguration.from_dict(icmp_configuration_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ICMPConfigurationUpdate.md b/docs/ICMPConfigurationUpdate.md new file mode 100644 index 0000000..e7c8f58 --- /dev/null +++ b/docs/ICMPConfigurationUpdate.md @@ -0,0 +1,36 @@ +# ICMPConfigurationUpdate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**packet_count** | **int** | | [optional] +**packet_interval** | **str** | | [optional] +**packet_size** | **int** | | [optional] +**packet_timeout** | **str** | | [optional] +**target_host** | **str** | | [optional] +**use_dns** | **bool** | | [optional] +**use_ipv6** | **bool** | | [optional] +**validation_rules** | [**SyntheticResourceUpdateListICMPValidationListICMPValidation**](SyntheticResourceUpdateListICMPValidationListICMPValidation.md) | | [optional] + +## Example + +```python +from instana_client.models.icmp_configuration_update import ICMPConfigurationUpdate + +# TODO update the JSON string below +json = "{}" +# create an instance of ICMPConfigurationUpdate from a JSON string +icmp_configuration_update_instance = ICMPConfigurationUpdate.from_json(json) +# print the JSON string representation of the object +print(ICMPConfigurationUpdate.to_json()) + +# convert the object into a dict +icmp_configuration_update_dict = icmp_configuration_update_instance.to_dict() +# create an instance of ICMPConfigurationUpdate from a dict +icmp_configuration_update_from_dict = ICMPConfigurationUpdate.from_dict(icmp_configuration_update_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ICMPValidation.md b/docs/ICMPValidation.md new file mode 100644 index 0000000..471dd67 --- /dev/null +++ b/docs/ICMPValidation.md @@ -0,0 +1,31 @@ +# ICMPValidation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | | +**operator** | **str** | | +**value** | **int** | | + +## Example + +```python +from instana_client.models.icmp_validation import ICMPValidation + +# TODO update the JSON string below +json = "{}" +# create an instance of ICMPValidation from a JSON string +icmp_validation_instance = ICMPValidation.from_json(json) +# print the JSON string representation of the object +print(ICMPValidation.to_json()) + +# convert the object into a dict +icmp_validation_dict = icmp_validation_instance.to_dict() +# create an instance of ICMPValidation from a dict +icmp_validation_from_dict = ICMPValidation.from_dict(icmp_validation_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IPFiltering.md b/docs/IPFiltering.md new file mode 100644 index 0000000..9748681 --- /dev/null +++ b/docs/IPFiltering.md @@ -0,0 +1,35 @@ +# IPFiltering + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**active** | **bool** | If the configuration is currently enforced, can be permanent active (if verified), or temporary after creation (enabling the verification). | [optional] +**deny_all** | **bool** | Fallback configuration, if unmatched requests should be denied. | [optional] +**enabled** | **bool** | If the configuration should be enforced. See active status if it is actually enforced. | [optional] +**last_changed_at** | **int** | When the configuration was last changed. | [optional] +**last_verified_at** | **int** | When the configuration was last verified. Can be used to assume if a configuration needs to be verified. | [optional] +**rules** | [**List[IPFilteringRuleDto]**](IPFilteringRuleDto.md) | Actual traffic rules. Enforcing allow / block based on incoming IP address. Are evaluated in given order. | +**support_access_enabled** | **bool** | If Instana support should be able to access your environment. Instana support is still able to to deactivate the configuration for you (manual process). | [optional] + +## Example + +```python +from instana_client.models.ip_filtering import IPFiltering + +# TODO update the JSON string below +json = "{}" +# create an instance of IPFiltering from a JSON string +ip_filtering_instance = IPFiltering.from_json(json) +# print the JSON string representation of the object +print(IPFiltering.to_json()) + +# convert the object into a dict +ip_filtering_dict = ip_filtering_instance.to_dict() +# create an instance of IPFiltering from a dict +ip_filtering_from_dict = IPFiltering.from_dict(ip_filtering_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IPFilteringApi.md b/docs/IPFilteringApi.md new file mode 100644 index 0000000..7fbe443 --- /dev/null +++ b/docs/IPFilteringApi.md @@ -0,0 +1,401 @@ +# instana_client.IPFilteringApi + +All URIs are relative to *https://unit-tenant.instana.io* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_ip_filtering**](IPFilteringApi.md#delete_ip_filtering) | **DELETE** /api/settings/ip-filtering | Delete current ip-filtering +[**disable_ip_filtering**](IPFilteringApi.md#disable_ip_filtering) | **PATCH** /api/settings/ip-filtering/disable | Disable the current ip-filtering +[**get_ip_filtering**](IPFilteringApi.md#get_ip_filtering) | **GET** /api/settings/ip-filtering | Get current ip-filtering +[**upsert_ip_filtering**](IPFilteringApi.md#upsert_ip_filtering) | **PUT** /api/settings/ip-filtering | Upsert ip-filtering +[**verify_ip_filtering**](IPFilteringApi.md#verify_ip_filtering) | **PATCH** /api/settings/ip-filtering/verify | Verify current ip-filtering + + +# **delete_ip_filtering** +> delete_ip_filtering() + +Delete current ip-filtering + +Delete the currently configured ip-filtering for the current tenant unit. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.IPFilteringApi(api_client) + + try: + # Delete current ip-filtering + api_instance.delete_ip_filtering() + except Exception as e: + print("Exception when calling IPFilteringApi->delete_ip_filtering: %s\n" % e) +``` + + + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successful - no content to return. | - | +**404** | Resource not found. | - | +**500** | Internal server error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **disable_ip_filtering** +> IPFiltering disable_ip_filtering() + +Disable the current ip-filtering + +Disable and retrieve the currently configured ip-filtering for the current tenant unit. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.ip_filtering import IPFiltering +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.IPFilteringApi(api_client) + + try: + # Disable the current ip-filtering + api_response = api_instance.disable_ip_filtering() + print("The response of IPFilteringApi->disable_ip_filtering:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IPFilteringApi->disable_ip_filtering: %s\n" % e) +``` + + + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**IPFiltering**](IPFiltering.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**404** | Resource not found. | - | +**500** | Internal server error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_ip_filtering** +> IPFiltering get_ip_filtering() + +Get current ip-filtering + +Retrieve currently configured ip-filtering for the current tenant unit. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.ip_filtering import IPFiltering +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.IPFilteringApi(api_client) + + try: + # Get current ip-filtering + api_response = api_instance.get_ip_filtering() + print("The response of IPFilteringApi->get_ip_filtering:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IPFilteringApi->get_ip_filtering: %s\n" % e) +``` + + + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**IPFiltering**](IPFiltering.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**404** | Resource not found. | - | +**500** | Internal server error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upsert_ip_filtering** +> IPFiltering upsert_ip_filtering(ip_filtering_upsert) + +Upsert ip-filtering + +Update or create ip-filtering for the current tenant unit. Enabled configurations will become temporarily active (5 minutes) and need to be verified within whilst being temporarily to become permanently active. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.ip_filtering import IPFiltering +from instana_client.models.ip_filtering_upsert import IPFilteringUpsert +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.IPFilteringApi(api_client) + ip_filtering_upsert = {"denyAll":false,"enabled":true,"supportAccessEnabled":true,"rules":[{"target":"127.0.0.1","block":true},{"target":"0:0:0:0:0:0:0:1","block":false}]} # IPFilteringUpsert | + + try: + # Upsert ip-filtering + api_response = api_instance.upsert_ip_filtering(ip_filtering_upsert) + print("The response of IPFilteringApi->upsert_ip_filtering:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IPFilteringApi->upsert_ip_filtering: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ip_filtering_upsert** | [**IPFilteringUpsert**](IPFilteringUpsert.md)| | + +### Return type + +[**IPFiltering**](IPFiltering.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad request. | - | +**422** | Unprocessable request - missing/invalid data. | - | +**500** | Internal server error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **verify_ip_filtering** +> IPFiltering verify_ip_filtering() + +Verify current ip-filtering + +Verify and retrieve the currently configured ip-filtering for the current tenant unit. This action is required to promote a configuration from temporary active to permanently active. This action can only be performed whilst the configuration is temporary active. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.ip_filtering import IPFiltering +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.IPFilteringApi(api_client) + + try: + # Verify current ip-filtering + api_response = api_instance.verify_ip_filtering() + print("The response of IPFilteringApi->verify_ip_filtering:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IPFilteringApi->verify_ip_filtering: %s\n" % e) +``` + + + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**IPFiltering**](IPFiltering.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**404** | Resource not found. | - | +**500** | Internal server error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/IPFilteringRuleDto.md b/docs/IPFilteringRuleDto.md new file mode 100644 index 0000000..86bd307 --- /dev/null +++ b/docs/IPFilteringRuleDto.md @@ -0,0 +1,31 @@ +# IPFilteringRuleDto + +Actual traffic rules. Enforcing allow / block based on incoming IP address. Are evaluated in given order. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**block** | **bool** | If the traffic should be blocked or denied. | +**target** | **str** | Target of this rule, can be either a IP address or a IP address range. | + +## Example + +```python +from instana_client.models.ip_filtering_rule_dto import IPFilteringRuleDto + +# TODO update the JSON string below +json = "{}" +# create an instance of IPFilteringRuleDto from a JSON string +ip_filtering_rule_dto_instance = IPFilteringRuleDto.from_json(json) +# print the JSON string representation of the object +print(IPFilteringRuleDto.to_json()) + +# convert the object into a dict +ip_filtering_rule_dto_dict = ip_filtering_rule_dto_instance.to_dict() +# create an instance of IPFilteringRuleDto from a dict +ip_filtering_rule_dto_from_dict = IPFilteringRuleDto.from_dict(ip_filtering_rule_dto_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IPFilteringUpsert.md b/docs/IPFilteringUpsert.md new file mode 100644 index 0000000..3eccef2 --- /dev/null +++ b/docs/IPFilteringUpsert.md @@ -0,0 +1,32 @@ +# IPFilteringUpsert + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**deny_all** | **bool** | Fallback configuration, if unmatched requests should be denied. | +**enabled** | **bool** | If the configuration should be enforced. See active status if it is actually enforced. | +**rules** | [**List[IPFilteringRuleDto]**](IPFilteringRuleDto.md) | Actual traffic rules. Enforcing allow / block based on incoming IP address. Are evaluated in given order. | +**support_access_enabled** | **bool** | If Instana support should be able to access your environment. Instana support is still able to to deactivate the configuration for you (manual process). | + +## Example + +```python +from instana_client.models.ip_filtering_upsert import IPFilteringUpsert + +# TODO update the JSON string below +json = "{}" +# create an instance of IPFilteringUpsert from a JSON string +ip_filtering_upsert_instance = IPFilteringUpsert.from_json(json) +# print the JSON string representation of the object +print(IPFilteringUpsert.to_json()) + +# convert the object into a dict +ip_filtering_upsert_dict = ip_filtering_upsert_instance.to_dict() +# create an instance of IPFilteringUpsert from a dict +ip_filtering_upsert_from_dict = IPFilteringUpsert.from_dict(ip_filtering_upsert_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LLMPriceConfigurationApi.md b/docs/LLMPriceConfigurationApi.md index 770f4fa..b4912c4 100644 --- a/docs/LLMPriceConfigurationApi.md +++ b/docs/LLMPriceConfigurationApi.md @@ -5,6 +5,7 @@ All URIs are relative to *https://unit-tenant.instana.io* Method | HTTP request | Description ------------- | ------------- | ------------- [**delete_llm_model_price**](LLMPriceConfigurationApi.md#delete_llm_model_price) | **DELETE** /api/settings/llm-pricing/{provider}/{modelName} | Delete LLM model price +[**delete_llm_model_price_by_query**](LLMPriceConfigurationApi.md#delete_llm_model_price_by_query) | **DELETE** /api/settings/llm-pricing | Delete LLM model price [**delete_llm_model_price_without_provider**](LLMPriceConfigurationApi.md#delete_llm_model_price_without_provider) | **DELETE** /api/settings/llm-pricing/model/{modelName} | Delete LLM model price without provider [**get_all_llm_model_prices**](LLMPriceConfigurationApi.md#get_all_llm_model_prices) | **GET** /api/settings/llm-pricing | Get all LLM model prices [**get_llm_model_currency**](LLMPriceConfigurationApi.md#get_llm_model_currency) | **GET** /api/settings/llm-pricing/currency | Get currency for LLM model prices @@ -12,6 +13,7 @@ Method | HTTP request | Description [**get_llm_model_price_without_provider**](LLMPriceConfigurationApi.md#get_llm_model_price_without_provider) | **GET** /api/settings/llm-pricing/model/{modelName} | Get LLM model price without provider [**set_llm_model_currency**](LLMPriceConfigurationApi.md#set_llm_model_currency) | **PUT** /api/settings/llm-pricing/currency | Set currency for LLM model prices [**upsert_llm_model_price**](LLMPriceConfigurationApi.md#upsert_llm_model_price) | **PUT** /api/settings/llm-pricing/{provider}/{modelName} | Upsert LLM model price +[**upsert_llm_model_price_from_body**](LLMPriceConfigurationApi.md#upsert_llm_model_price_from_body) | **PUT** /api/settings/llm-pricing | Upsert LLM model price [**upsert_llm_model_price_without_provider**](LLMPriceConfigurationApi.md#upsert_llm_model_price_without_provider) | **PUT** /api/settings/llm-pricing/model/{modelName} | Upsert LLM model price without provider @@ -96,6 +98,87 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **delete_llm_model_price_by_query** +> delete_llm_model_price_by_query(provider=provider, model_name=model_name, platform=platform) + +Delete LLM model price + +Delete a tenant-specific price configuration for a specific provider+model. Optionally specify a platform. Only user-defined prices can be deleted. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.LLMPriceConfigurationApi(api_client) + provider = 'openai' # str | (optional) + model_name = 'gpt-4' # str | (optional) + platform = 'aws' # str | (optional) + + try: + # Delete LLM model price + api_instance.delete_llm_model_price_by_query(provider=provider, model_name=model_name, platform=platform) + except Exception as e: + print("Exception when calling LLMPriceConfigurationApi->delete_llm_model_price_by_query: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **provider** | **str**| | [optional] + **model_name** | **str**| | [optional] + **platform** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content - Successfully deleted | - | +**404** | Not Found - Price configuration does not exist | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **delete_llm_model_price_without_provider** > delete_llm_model_price_without_provider(model_name, platform=platform) @@ -654,6 +737,83 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **upsert_llm_model_price_from_body** +> upsert_llm_model_price_from_body(llm_model_price=llm_model_price) + +Upsert LLM model price + +Create or update price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import instana_client +from instana_client.models.llm_model_price import LlmModelPrice +from instana_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://unit-tenant.instana.io +# See configuration.py for a list of all supported configuration parameters. +configuration = instana_client.Configuration( + host = "https://unit-tenant.instana.io" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with instana_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = instana_client.LLMPriceConfigurationApi(api_client) + llm_model_price = {"provider":"openai","modelName":"gpt-4","inputCost":0.5,"outputCost":1.5} # LlmModelPrice | (optional) + + try: + # Upsert LLM model price + api_instance.upsert_llm_model_price_from_body(llm_model_price=llm_model_price) + except Exception as e: + print("Exception when calling LLMPriceConfigurationApi->upsert_llm_model_price_from_body: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **llm_model_price** | [**LlmModelPrice**](LlmModelPrice.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **upsert_llm_model_price_without_provider** > upsert_llm_model_price_without_provider(model_name, platform=platform, llm_model_price=llm_model_price) diff --git a/docs/LogVolumeUsageItem.md b/docs/LogVolumeUsageItem.md index 9eb48fe..5a8cfe6 100644 --- a/docs/LogVolumeUsageItem.md +++ b/docs/LogVolumeUsageItem.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**log_volume** | **int** | | +**log_volume** | **int** | Log volume in bytes | **number_of_month** | **int** | | [optional] **retention_periods** | [**List[RetentionPeriod]**](RetentionPeriod.md) | | diff --git a/docs/MetricField.md b/docs/MetricField.md new file mode 100644 index 0000000..0ce74d2 --- /dev/null +++ b/docs/MetricField.md @@ -0,0 +1,33 @@ +# MetricField + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**aggregation** | **str** | | [optional] +**entity_type** | **str** | | [optional] +**metric_id** | **str** | | [optional] +**time_window** | **object** | | [optional] +**value** | [**MetricFieldValue**](MetricFieldValue.md) | | [optional] + +## Example + +```python +from instana_client.models.metric_field import MetricField + +# TODO update the JSON string below +json = "{}" +# create an instance of MetricField from a JSON string +metric_field_instance = MetricField.from_json(json) +# print the JSON string representation of the object +print(MetricField.to_json()) + +# convert the object into a dict +metric_field_dict = metric_field_instance.to_dict() +# create an instance of MetricField from a dict +metric_field_from_dict = MetricField.from_dict(metric_field_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MetricFieldValue.md b/docs/MetricFieldValue.md new file mode 100644 index 0000000..6f6b5a9 --- /dev/null +++ b/docs/MetricFieldValue.md @@ -0,0 +1,33 @@ +# MetricFieldValue + +Configuration for a metric-based custom payload field + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**aggregation** | **str** | The aggregation type to apply to the metric | +**entity_type** | **str** | The entity type for the metric query | [optional] +**metric_id** | **str** | The metric ID to retrieve | +**time_window** | **object** | The time window in milliseconds for metric aggregation | [optional] + +## Example + +```python +from instana_client.models.metric_field_value import MetricFieldValue + +# TODO update the JSON string below +json = "{}" +# create an instance of MetricFieldValue from a JSON string +metric_field_value_instance = MetricFieldValue.from_json(json) +# print the JSON string representation of the object +print(MetricFieldValue.to_json()) + +# convert the object into a dict +metric_field_value_dict = metric_field_value_instance.to_dict() +# create an instance of MetricFieldValue from a dict +metric_field_value_from_dict = MetricFieldValue.from_dict(metric_field_value_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MobileAppCatalogApi.md b/docs/MobileAppCatalogApi.md index fcc7e0a..b2d03f3 100644 --- a/docs/MobileAppCatalogApi.md +++ b/docs/MobileAppCatalogApi.md @@ -4,93 +4,11 @@ All URIs are relative to *https://unit-tenant.instana.io* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_action_beacons**](MobileAppCatalogApi.md#get_action_beacons) | **GET** /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/action-beacons | Get action beacons for a session [**get_all_mobile_app_catalog_tags**](MobileAppCatalogApi.md#get_all_mobile_app_catalog_tags) | **GET** /api/mobile-app-monitoring/catalog/tags | Get all existing mobile app tags [**get_mobile_app_metric_catalog**](MobileAppCatalogApi.md#get_mobile_app_metric_catalog) | **GET** /api/mobile-app-monitoring/catalog/metrics | Metric catalog [**get_mobile_app_tag_catalog**](MobileAppCatalogApi.md#get_mobile_app_tag_catalog) | **GET** /api/mobile-app-monitoring/catalog | Get mobile app tag catalog -[**get_session_replay_metadata**](MobileAppCatalogApi.md#get_session_replay_metadata) | **GET** /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/replay-metadata | Get session replay metadata -[**get_session_replay_timestamps**](MobileAppCatalogApi.md#get_session_replay_timestamps) | **GET** /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/replay-timestamps | Get session replay timestamps -# **get_action_beacons** -> GetActionBeaconsResult get_action_beacons(mobile_app_id, session_id, cursor=cursor, page_size=page_size) - -Get action beacons for a session - -Retrieves action beacons (user interactions and events) for a mobile app session. Uses cursor-based pagination with offset cursors. Returns beacons starting from the cursor offset. The pageSize parameter controls the number of items returned (default 100, max 1000). Includes event types, view components, frustration signals, orientation changes, and more. - -### Example - - -```python -import instana_client -from instana_client.models.get_action_beacons_result import GetActionBeaconsResult -from instana_client.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://unit-tenant.instana.io -# See configuration.py for a list of all supported configuration parameters. -configuration = instana_client.Configuration( - host = "https://unit-tenant.instana.io" -) - - -# Enter a context with an instance of the API client -with instana_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = instana_client.MobileAppCatalogApi(api_client) - mobile_app_id = 'app-456' # str | Mobile app identifier - session_id = 'session-123' # str | Session identifier - cursor = 100 # int | Offset cursor for pagination (number of items already retrieved). Omit for first page. (optional) - page_size = 100 # int | Number of items per page (default: 100, max: 1000) (optional) (default to 100) - - try: - # Get action beacons for a session - api_response = api_instance.get_action_beacons(mobile_app_id, session_id, cursor=cursor, page_size=page_size) - print("The response of MobileAppCatalogApi->get_action_beacons:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MobileAppCatalogApi->get_action_beacons: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **mobile_app_id** | **str**| Mobile app identifier | - **session_id** | **str**| Session identifier | - **cursor** | **int**| Offset cursor for pagination (number of items already retrieved). Omit for first page. | [optional] - **page_size** | **int**| Number of items per page (default: 100, max: 1000) | [optional] [default to 100] - -### Return type - -[**GetActionBeaconsResult**](GetActionBeaconsResult.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**400** | Bad Request - Invalid mobile app ID, session ID, or pagination parameters | - | -**401** | Unauthorized access - requires user authentication. | - | -**403** | Forbidden - User doesn't have access to this mobile app | - | -**404** | Not Found - Mobile app or session not found | - | -**500** | Internal server error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **get_all_mobile_app_catalog_tags** > List[Tag] get_all_mobile_app_catalog_tags() @@ -327,157 +245,3 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_session_replay_metadata** -> GetSessionReplayMetadataResult get_session_replay_metadata(mobile_app_id, session_id, cursor=cursor, page_size=page_size) - -Get session replay metadata - -Retrieves detailed metadata for session replay captured during a mobile app session. Uses cursor-based pagination with timestamp cursors. Returns metadata within the time window from cursor to cursor + pageSize. The pageSize represents milliseconds (default 20000ms = 20 seconds). Includes all metadata fields such as event type, view components, orientation changes, etc. - -### Example - - -```python -import instana_client -from instana_client.models.get_session_replay_metadata_result import GetSessionReplayMetadataResult -from instana_client.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://unit-tenant.instana.io -# See configuration.py for a list of all supported configuration parameters. -configuration = instana_client.Configuration( - host = "https://unit-tenant.instana.io" -) - - -# Enter a context with an instance of the API client -with instana_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = instana_client.MobileAppCatalogApi(api_client) - mobile_app_id = 'app-456' # str | Mobile app identifier - session_id = 'session-123' # str | Session identifier - cursor = 1234567890 # int | Timestamp cursor for pagination (epoch milliseconds). Retrieves metadata from this timestamp onwards. (optional) - page_size = 20000 # int | Time window size in milliseconds (default: 20000ms = 20 seconds) (optional) (default to 20000) - - try: - # Get session replay metadata - api_response = api_instance.get_session_replay_metadata(mobile_app_id, session_id, cursor=cursor, page_size=page_size) - print("The response of MobileAppCatalogApi->get_session_replay_metadata:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MobileAppCatalogApi->get_session_replay_metadata: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **mobile_app_id** | **str**| Mobile app identifier | - **session_id** | **str**| Session identifier | - **cursor** | **int**| Timestamp cursor for pagination (epoch milliseconds). Retrieves metadata from this timestamp onwards. | [optional] - **page_size** | **int**| Time window size in milliseconds (default: 20000ms = 20 seconds) | [optional] [default to 20000] - -### Return type - -[**GetSessionReplayMetadataResult**](GetSessionReplayMetadataResult.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**400** | Bad Request - Invalid mobile app ID, session ID, or pagination parameters | - | -**401** | Unauthorized access - requires user authentication. | - | -**403** | Forbidden - User doesn't have access to this mobile app | - | -**404** | Not Found - Mobile app or session not found | - | -**500** | Internal server error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_session_replay_timestamps** -> SessionReplayTimestamps get_session_replay_timestamps(mobile_app_id, session_id) - -Get session replay timestamps - -Retrieves the first and last image timestamps for a mobile app session. Returns null values if the session has no images. - -### Example - - -```python -import instana_client -from instana_client.models.session_replay_timestamps import SessionReplayTimestamps -from instana_client.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://unit-tenant.instana.io -# See configuration.py for a list of all supported configuration parameters. -configuration = instana_client.Configuration( - host = "https://unit-tenant.instana.io" -) - - -# Enter a context with an instance of the API client -with instana_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = instana_client.MobileAppCatalogApi(api_client) - mobile_app_id = 'app-456' # str | Mobile app identifier - session_id = 'session-123' # str | Session identifier - - try: - # Get session replay timestamps - api_response = api_instance.get_session_replay_timestamps(mobile_app_id, session_id) - print("The response of MobileAppCatalogApi->get_session_replay_timestamps:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling MobileAppCatalogApi->get_session_replay_timestamps: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **mobile_app_id** | **str**| Mobile app identifier | - **session_id** | **str**| Session identifier | - -### Return type - -[**SessionReplayTimestamps**](SessionReplayTimestamps.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | -**400** | Bad Request - Invalid mobile app ID or session ID | - | -**401** | Unauthorized access - requires user authentication. | - | -**403** | Forbidden - User doesn't have access to this mobile app | - | -**404** | Not Found - Mobile app or session not found | - | -**500** | Internal server error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PrefixObject.md b/docs/PrefixObject.md index f6bc2a8..e17f96a 100644 --- a/docs/PrefixObject.md +++ b/docs/PrefixObject.md @@ -6,6 +6,7 @@ Shortcode prefix configuration Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether the shortcode prefix feature is enabled | [optional] **prefix** | **str** | The prefix to use for event short codes (e.g., 'INSTANA-', 'PROD-') | [optional] ## Example diff --git a/docs/RuleInput.md b/docs/RuleInput.md index 0f5327f..81ca7bf 100644 --- a/docs/RuleInput.md +++ b/docs/RuleInput.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **input_kind** | **str** | | **input_name** | **str** | | +**metric_rollup** | **int** | | [optional] ## Example diff --git a/docs/SimpleMetricConfiguration.md b/docs/SimpleMetricConfiguration.md index a40de1c..ecdaaf2 100644 --- a/docs/SimpleMetricConfiguration.md +++ b/docs/SimpleMetricConfiguration.md @@ -12,7 +12,6 @@ Name | Type | Description | Notes **missing_value** | **float** | | [optional] **regex** | **bool** | | [optional] **required** | **bool** | When true, metric must be present with values | [optional] -**operation** | [**ArithmeticOperation**](ArithmeticOperation.md) | | [optional] ## Example diff --git a/docs/SyntheticResourceUpdateListICMPValidationListICMPValidation.md b/docs/SyntheticResourceUpdateListICMPValidationListICMPValidation.md new file mode 100644 index 0000000..63b3d27 --- /dev/null +++ b/docs/SyntheticResourceUpdateListICMPValidationListICMPValidation.md @@ -0,0 +1,30 @@ +# SyntheticResourceUpdateListICMPValidationListICMPValidation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**add** | [**List[ICMPValidation]**](ICMPValidation.md) | | [optional] +**remove** | [**List[ICMPValidation]**](ICMPValidation.md) | | [optional] + +## Example + +```python +from instana_client.models.synthetic_resource_update_list_icmp_validation_list_icmp_validation import SyntheticResourceUpdateListICMPValidationListICMPValidation + +# TODO update the JSON string below +json = "{}" +# create an instance of SyntheticResourceUpdateListICMPValidationListICMPValidation from a JSON string +synthetic_resource_update_list_icmp_validation_list_icmp_validation_instance = SyntheticResourceUpdateListICMPValidationListICMPValidation.from_json(json) +# print the JSON string representation of the object +print(SyntheticResourceUpdateListICMPValidationListICMPValidation.to_json()) + +# convert the object into a dict +synthetic_resource_update_list_icmp_validation_list_icmp_validation_dict = synthetic_resource_update_list_icmp_validation_list_icmp_validation_instance.to_dict() +# create an instance of SyntheticResourceUpdateListICMPValidationListICMPValidation from a dict +synthetic_resource_update_list_icmp_validation_list_icmp_validation_from_dict = SyntheticResourceUpdateListICMPValidationListICMPValidation.from_dict(synthetic_resource_update_list_icmp_validation_list_icmp_validation_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SyntheticTypeConfigurationUpdate.md b/docs/SyntheticTypeConfigurationUpdate.md index ed644bd..d56f3a0 100644 --- a/docs/SyntheticTypeConfigurationUpdate.md +++ b/docs/SyntheticTypeConfigurationUpdate.md @@ -1,6 +1,6 @@ # SyntheticTypeConfigurationUpdate -Synthetic test configuration that is unique to a synthetic type. Valid types are BrowserScript, DNS, HTTPAction, HTTPScript, SSLCertificate, WebpageAction, and WebpageScript. +Synthetic test configuration that is unique to a synthetic type. Valid types are BrowserScript, DNS, HTTPAction, HTTPScript, ICMP, SSLCertificate, WebpageAction, and WebpageScript. ## Properties diff --git a/docs/TestCommonProperties.md b/docs/TestCommonProperties.md index a3606aa..92bd16d 100644 --- a/docs/TestCommonProperties.md +++ b/docs/TestCommonProperties.md @@ -22,6 +22,7 @@ Name | Type | Description | Notes **mobile_application_ids** | **List[str]** | | [optional] **mobile_application_labels** | **List[str]** | | [optional] **modified_at** | **int** | | [optional] +**rbac_tags** | [**List[ApiTag]**](ApiTag.md) | | [optional] **service_id** | **str** | | [optional] **type** | **str** | | **website_ids** | **List[str]** | | [optional] diff --git a/instana_client/__init__.py b/instana_client/__init__.py index f15d8a5..37972c7 100644 --- a/instana_client/__init__.py +++ b/instana_client/__init__.py @@ -7,7 +7,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,1883 +15,618 @@ """ # noqa: E501 -__version__ = "1.0.7" +__version__ = "1.0.8" -# Define package exports -__all__ = [ - "AIManagementApi", - "APITokenApi", - "ActionCatalogApi", - "ActionHistoryApi", - "ApdexReportApi", - "ApdexSettingsApi", - "ApplicationAlertConfigurationApi", - "ApplicationAnalyzeApi", - "ApplicationCatalogApi", - "ApplicationMetricsApi", - "ApplicationResourcesApi", - "ApplicationSettingsApi", - "ApplicationTopologyApi", - "AuditLogApi", - "AuthenticationApi", - "BusinessMonitoringApi", - "CustomDashboardsApi", - "CustomEntitiesApi", - "EndUserMonitoringApi", - "EventSettingsApi", - "EventsApi", - "GlobalApplicationAlertConfigurationApi", - "GroupsApi", - "HealthApi", - "HostAgentApi", - "InfrastructureAlertConfigurationApi", - "InfrastructureAnalyzeApi", - "InfrastructureCatalogApi", - "InfrastructureMetricsApi", - "InfrastructureResourcesApi", - "InfrastructureTopologyApi", - "LLMPriceConfigurationApi", - "LogAlertConfigurationApi", - "LoggingAnalyzeApi", - "MaintenanceConfigurationApi", - "MobileAppAnalyzeApi", - "MobileAppCatalogApi", - "MobileAppConfigurationApi", - "MobileAppMetricsApi", - "PoliciesApi", - "ReleasesApi", - "RolesApi", - "SLIReportApi", - "SLISettingsApi", - "SLOConfigurationsApi", - "SLOCorrectionConfigurationsApi", - "SLOCorrectionWindowsApi", - "ServiceLevelsAlertConfigurationApi", - "ServiceLevelsObjectiveSLOReportApi", - "SessionSettingsApi", - "SyntheticAlertConfigurationApi", - "SyntheticCallsApi", - "SyntheticCatalogApi", - "SyntheticMetricsApi", - "SyntheticSettingsApi", - "SyntheticTestPlaybackResultsApi", - "TeamsApi", - "UsageApi", - "UserApi", - "WebsiteAnalyzeApi", - "WebsiteCatalogApi", - "WebsiteConfigurationApi", - "WebsiteMetricsApi", - "DefaultApi", - "ApiResponse", - "ApiClient", - "Configuration", - "OpenApiException", - "ApiTypeError", - "ApiValueError", - "ApiKeyError", - "ApiAttributeError", - "ApiException", - "AbstractIntegration", - "AbstractRule", - "AccessLogEntry", - "AccessLogResponse", - "AccessRule", - "Action", - "ActionBeacon", - "ActionConfiguration", - "ActionInstance", - "ActionInstanceMetadataEntry", - "ActionInstanceParameter", - "ActionInstanceRequest", - "ActionInstanceRequestParameters", - "ActionMatch", - "ActionSearchSpace", - "AdaptiveBaseline", - "AdaptiveThresholdRule", - "Addition", - "AdjustedTimeframe", - "AgentConfigurationUpdate", - "AlertingConfiguration", - "AlertingConfigurationWithLastUpdated", - "AlertingTimeWindow", - "ApdexConfiguration", - "ApdexConfigurationInput", - "ApdexEntity", - "ApdexLevel", - "ApdexReport", - "ApiCreateGroup", - "ApiCreateRole", - "ApiGroup", - "ApiMember", - "ApiPermissionSet", - "ApiRestrictedApplicationFilter", - "ApiRole", - "ApiTag", - "ApiTeam", - "ApiTeamInfo", - "ApiTeamMember", - "ApiTeamRole", - "ApiTeamScope", - "ApiToken", - "AppDataMetricConfiguration", - "Application", - "ApplicationAlertConfig", - "ApplicationAlertConfigWithMetadata", - "ApplicationAlertRule", - "ApplicationApdexEntity", - "ApplicationConfig", - "ApplicationEventResult", - "ApplicationItem", - "ApplicationMetricResult", - "ApplicationNode", - "ApplicationResult", - "ApplicationScope", - "ApplicationScopeWithMetadata", - "ApplicationSliEntity", - "ApplicationSloEntity", - "ApplicationTimeThreshold", - "ArithmeticConfiguration", - "ArithmeticOperand", - "ArithmeticOperation", - "AuditLogEntry", - "AuditLogUiResponse", - "Author", - "AvailabilityBlueprintIndicator", - "AvailabilitySliEntity", - "AvailableMetrics", - "AvailablePlugins", - "BackendTraceReference", - "BidirectionalMsTeamsAppIntegration", - "BidirectionalSlackAppIntegration", - "BinaryOperatorDTO", - "BrowserScriptConfiguration", - "BrowserScriptConfigurationUpdate", - "BuiltInEventSpecification", - "BuiltInEventSpecificationWithLastUpdated", - "BusinessActivity", - "BusinessPerspectiveConfig", - "CallGroupsItem", - "CallGroupsResult", - "CallRelation", - "ChangeSummary", - "CloudfoundryPhysicalContext", - "Condition", - "ConfigVersion", - "Correction", - "CorrectionConfiguration", - "CorrectionScheduling", - "CorrectionWindow", - "CrashMobileAppAlertRule", - "CreateWebsiteRequestInner", - "CursorPaginatedBusinessActivityItem", - "CursorPagination", - "CursorPaginationWithUiCursorInfraExploreCursor", - "CustomBlueprintIndicator", - "CustomDashboard", - "CustomDashboardPreview", - "CustomDashboardWithUserSpecificInformation", - "CustomDependency", - "CustomEmailSubjectPrefix", - "CustomEntityModel", - "CustomEntityWithMetadata", - "CustomEventMobileAppAlertRule", - "CustomEventSpecification", - "CustomEventSpecificationWithLastUpdated", - "CustomEventWebsiteAlertRule", - "CustomMetric", - "CustomPayloadConfiguration", - "CustomPayloadField", - "CustomPayloadWithLastUpdated", - "CustomPayloadWithVersion", - "CustomTag", - "DNSConfiguration", - "DNSConfigurationUpdate", - "DNSFilterQueryTime", - "DNSFilterTargetValue", - "DashboardApiToken", - "DatabaseIntegration", - "DeprecatedTagFilter", - "Division", - "Duration", - "DynamicField", - "DynamicFieldValue", - "DynamicParameter", - "DynamicTag", - "EditUser", - "EmailIntegration", - "EmptyConfiguration", - "Endpoint", - "EndpointConfig", - "EndpointEventResult", - "EndpointItem", - "EndpointMetricResult", - "EndpointNode", - "EndpointResult", - "EndpointSimple", - "EntityCountRule", - "EntityCountVerificationRule", - "EntityHealthInfo", - "EntityId", - "EntityVerificationRule", - "ErrorBudgetAlertRule", - "ErrorsApplicationAlertRule", - "Event", - "EventFilteringConfiguration", - "EventResult", - "EventSpecificationInfo", - "ExtendedService", - "FailureSyntheticAlertRule", - "FixedHttpPathSegmentMatchingRule", - "FixedTimeWindow", - "GenericInfraAlertRule", - "GeoLocationConfiguration", - "GeoMappingRule", - "GeoSubdivision", - "GetActionBeaconsResult", - "GetActivities", - "GetApplicationMetrics", - "GetApplications", - "GetAvailableMetricsQuery", - "GetAvailablePluginsQuery", - "GetCallGroups", - "GetCombinedMetrics", - "GetDynamicParameterValues", - "GetEndpoints", - "GetInfrastructureGroupsQuery", - "GetInfrastructureQuery", - "GetMetricsResult", - "GetMobileAppBeaconGroups", - "GetMobileAppBeacons", - "GetMobileAppMetrics", - "GetMobileAppMetricsV2", - "GetPayloadKeysResult", - "GetServices", - "GetSessionReplayMetadataResult", - "GetSnapshotsQuery", - "GetTestResult", - "GetTestResultAnalytic", - "GetTestResultBase", - "GetTestResultList", - "GetTestSummaryResult", - "GetTraceDownloadResultItem", - "GetTraceGroups", - "GetTraces", - "GetWebsiteBeaconGroups", - "GetWebsiteBeacons", - "GetWebsiteMetrics", - "GetWebsiteMetricsV2", - "GlobalApplicationAlertConfigWithMetadata", - "GlobalApplicationsAlertConfig", - "GoogleChatIntegration", - "GraphEdge", - "GraphNode", - "Group", - "GroupByTag", - "GroupMapping", - "GroupMappingOverview", - "HealthState", - "HistoricBaseline", - "HostAvailabilityRule", - "HttpActionConfiguration", - "HttpActionConfigurationUpdate", - "HttpEndpointConfig", - "HttpEndpointRule", - "HttpPathSegmentMatchingRule", - "HttpScriptConfiguration", - "HttpScriptConfigurationUpdate", - "HyperParam", - "IdentityProviderPatch", - "IdpStatusUpdate", - "ImpactedBeaconInfo", - "InfraAlertConfig", - "InfraAlertConfigWithMetadata", - "InfraAlertRule", - "InfraEventResult", - "InfraMetricConfiguration", - "InfraSloEntity", - "InfraTimeThreshold", - "InfrastructureEntitiesResult", - "InfrastructureGroup", - "InfrastructureGroupsResult", - "InfrastructureItem", - "InfrastructureMetricResult", - "InstanaVersionInfo", - "IntegrationOverview", - "Invitation", - "InvitationResponse", - "InvitationResult", - "IpMaskingConfiguration", - "JsStackTraceLine", - "KubernetesPhysicalContext", - "LLMEgressGateway", - "LLMGatewayCapability", - "LLMGatewayModel", - "LLMGatewayService", - "LLMGatewayTestConnectionRequest", - "LatencyBlueprintIndicator", - "LlmModelPrice", - "LlmModelPriceMetadata", - "LocationStatus", - "LogAlertConfig", - "LogAlertConfigWithMetadata", - "LogAlertRule", - "LogCountAlertRule", - "LogEntryActor", - "LogEventResult", - "LogTimeThreshold", - "LogVolumeGroup", - "LogVolumeUsageItem", - "LogVolumeUsageResult", - "LogsApplicationAlertRule", - "MaintenanceConfig", - "MaintenanceConfigScheduling", - "MaintenanceConfigV2", - "MaintenanceConfigV2WithStateAndOccurrence", - "MaintenanceConfigWithLastUpdated", - "MaintenanceWindow", - "ManualAlertingChannelConfiguration", - "ManualCloseInfo", - "ManualServiceConfig", - "MatchAllHttpPathSegmentMatchingRule", - "MatchExpressionDTO", - "MetaData", - "MetricAPIResult", - "MetricConfig", - "MetricConfiguration", - "MetricDescription", - "MetricInstance", - "MetricItem", - "MetricMetadata", - "MetricPattern", - "MetricQuery", - "MetricsResult", - "MetricsResultItem", - "MetricsTestResultItem", - "MobileApp", - "MobileAppAlertConfig", - "MobileAppAlertConfigWithRBACTag", - "MobileAppAlertRule", - "MobileAppBeaconGroupsItem", - "MobileAppBeaconGroupsResult", - "MobileAppBeaconResult", - "MobileAppBeaconTagGroup", - "MobileAppBeaconsItem", - "MobileAppEventResult", - "MobileAppMetricResult", - "MobileAppMonitoringBeacon", - "MobileAppMonitoringMetricDescription", - "MobileAppMonitoringMetricsConfiguration", - "MobileAppTimeThreshold", - "ModelField", - "MonitoredEntitiesStats", - "MonitoringState", - "MultipleScriptsConfiguration", - "Multiplication", - "NS1Integration", - "NestedOperation", - "NewApplicationConfig", - "NewBusinessPerspectiveConfig", - "NewManualServiceConfig", - "OAuthConfig", - "OAuthIntegration", - "OAuthToken", - "Occurrence", - "Office365Integration", - "OneTimeMaintenanceWindow", - "OpsgenieIntegration", - "Order", - "PagerdutyIntegration", - "PaginatedResult", - "Pagination", - "Parameter", - "ParameterValue", - "PathParameterHttpPathSegmentMatchingRule", - "PhysicalContext", - "PluginResult", - "Policy", - "PolicyRunnable", - "PolicyScheduling", - "PostMobileAppSourceMapConfigRequest", - "PostSnapshotsResult", - "PrefixObject", - "Problem", - "PrometheusWebhookIntegration", - "RecurrentMaintenanceWindow", - "Release", - "ReleaseScope", - "ReleaseWithMetadata", - "RetentionPeriod", - "RollingTimeWindow", - "RuleInput", - "RuleWithThresholdApplicationAlertRule", - "RuleWithThresholdInfraAlertRule", - "RuleWithThresholdLogAlertRule", - "RuleWithThresholdMobileAppAlertRule", - "RuleWithThresholdWebsiteAlertRule", - "RunConfiguration", - "SLOConfigWithRBACTag", - "SSLCertificateConfiguration", - "SSLCertificateConfigurationUpdate", - "SSLCertificateValidation", - "SalesforceIntegration", - "SaturationBlueprintIndicator", - "ScopeBinding", - "SearchFieldResult", - "Service", - "ServiceConfig", - "ServiceEventResult", - "ServiceItem", - "ServiceLevelIndicator", - "ServiceLevelObjectiveAlertRule", - "ServiceLevelsAlertConfig", - "ServiceLevelsAlertConfigWithRBACTag", - "ServiceLevelsAlertRule", - "ServiceLevelsBurnRateConfig", - "ServiceLevelsBurnRateTimeWindows", - "ServiceLevelsStaticThresholdConfig", - "ServiceLevelsTimeThreshold", - "ServiceLevelseAlertConfigWithMetadata", - "ServiceMap", - "ServiceMapConnection", - "ServiceMatchingRule", - "ServiceMetricResult", - "ServiceNode", - "ServiceNowEnhancedIntegration", - "ServiceNowIntegration", - "ServiceResult", - "ServiceScope", - "ServiceScopeWithMetadata", - "ServiceScopedTo", - "ServiceScopedToWithMetadata", - "ServiceSimple", - "SessionReplayMetadata", - "SessionReplayTimestamps", - "SessionSettings", - "SimpleMetricConfiguration", - "SingleValue", - "SlackIntegration", - "SliConfiguration", - "SliConfigurationWithLastUpdated", - "SliEntity", - "SliReport", - "SloEntity", - "SloReport", - "SlownessApplicationAlertRule", - "SlownessMobileAppAlertRule", - "SlownessWebsiteAlertRule", - "SnapshotItem", - "SnapshotPreview", - "SnapshotResult", - "SoftwareUser", - "SoftwareVersion", - "SourceMapFileBlob", - "SourceMapFileMeta", - "SourceMapUploadConfig", - "SourceMapUploadConfigs", - "SpanExcerpt", - "SpanRelation", - "SpecificJsErrorsWebsiteAlertRule", - "SplunkIntegration", - "StackTraceItem", - "StackTraceLine", - "StaticBaselineThresholdRule", - "StaticStringField", - "StaticThreshold", - "StaticThresholdRule", - "StatusCodeApplicationAlertRule", - "StatusCodeMobileAppAlertRule", - "StatusCodeWebsiteAlertRule", - "Subtraction", - "SyntheticAlertConfig", - "SyntheticAlertConfigWithMetadata", - "SyntheticAlertConfigWithRBACTag", - "SyntheticAlertRule", - "SyntheticBulkResponse", - "SyntheticCallConfig", - "SyntheticCallRule", - "SyntheticCallWithDefaultsConfig", - "SyntheticConfiguration", - "SyntheticConfigurationUpdate", - "SyntheticCredential", - "SyntheticDatacenter", - "SyntheticDatacenterConfiguration", - "SyntheticGeoPoint", - "SyntheticLocation", - "SyntheticLocationConfiguration", - "SyntheticMetricConfiguration", - "SyntheticMetricTagGroup", - "SyntheticPlaybackCapabilities", - "SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue", - "SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation", - "SyntheticResourceUpdateListStringListString", - "SyntheticResourceUpdateMapStringStringListString", - "SyntheticSloEntity", - "SyntheticTest", - "SyntheticTestCICD", - "SyntheticTestCICDCustomization", - "SyntheticTestCICDItem", - "SyntheticTestCICDResponse", - "SyntheticTestDeepUpdate", - "SyntheticTestShallowUpdate", - "SyntheticTestUpdate", - "SyntheticTimeThreshold", - "SyntheticTypeConfiguration", - "SyntheticTypeConfigurationUpdate", - "SyntheticsEventResult", - "SystemRule", - "SystemRuleLabel", - "Tag", - "TagCatalog", - "TagFilter", - "TagFilterExpression", - "TagFilterExpressionElement", - "TagMatcherDTO", - "TagTreeLevel", - "TagTreeNode", - "TagTreeTag", - "TestCommonProperties", - "TestConnectionResponse", - "TestLastError", - "TestResult", - "TestResultCommonProperties", - "TestResultDetailData", - "TestResultItem", - "TestResultListItem", - "TestResultListResult", - "TestResultMetadata", - "TestResultSubtransaction", - "Threshold", - "ThresholdConfigRule", - "ThresholdRule", - "ThroughputApplicationAlertRule", - "ThroughputMobileAppAlertRule", - "ThroughputWebsiteAlertRule", - "TimeFrame", - "TimeWindow", - "Topology", - "Trace", - "TraceActivityTreeNodeDetails", - "TraceDownloadResult", - "TraceGroupsItem", - "TraceGroupsResult", - "TraceImpactApplicationTimeThreshold", - "TraceItem", - "TraceResult", - "TrafficBlueprintIndicator", - "Trigger", - "TypeConfiguration", - "UnsupportedHttpPathSegmentMatchingRule", - "UpdatedBusinessPerspectiveConfig", - "UsageResult", - "UsageResultItems", - "UserBasicResult", - "UserImpactMobileAppTimeThreshold", - "UserImpactWebsiteTimeThreshold", - "UserResult", - "UsersResult", - "ValidatedAlertingChannelInputInfo", - "ValidatedAlertingConfiguration", - "ValidatedMaintenanceConfigV2WithStateAndOccurrence", - "ValidatedMaintenanceConfigWithStatus", - "VictorOpsIntegration", - "ViolationsInPeriodApplicationTimeThreshold", - "ViolationsInPeriodMobileAppTimeThreshold", - "ViolationsInPeriodWebsiteTimeThreshold", - "ViolationsInSequenceApplicationTimeThreshold", - "ViolationsInSequenceInfraTimeThreshold", - "ViolationsInSequenceLogTimeThreshold", - "ViolationsInSequenceMobileAppTimeThreshold", - "ViolationsInSequenceSyntheticTimeThreshold", - "ViolationsInSequenceWebsiteTimeThreshold", - "WatsonAIOpsWebhookIntegration", - "WebexTeamsWebhookIntegration", - "WebhookIntegration", - "WebpageActionConfiguration", - "WebpageActionConfigurationUpdate", - "WebpageScriptConfiguration", - "WebpageScriptConfigurationUpdate", - "Website", - "WebsiteAlertConfig", - "WebsiteAlertConfigWithMetadata", - "WebsiteAlertConfigWithRBACTag", - "WebsiteAlertRule", - "WebsiteApdexEntity", - "WebsiteBeaconGroupsItem", - "WebsiteBeaconGroupsResult", - "WebsiteBeaconResult", - "WebsiteBeaconTagGroup", - "WebsiteBeaconsItem", - "WebsiteEventBasedSliEntity", - "WebsiteEventResult", - "WebsiteMetricResult", - "WebsiteMonitoringBeacon", - "WebsiteMonitoringMetricDescription", - "WebsiteMonitoringMetricsConfiguration", - "WebsiteSloEntity", - "WebsiteTimeBasedSliEntity", - "WebsiteTimeThreshold", - "Widget", - "WithMetaData", - "WithResolvedName", - "ZChatOpsIntegration", -] - -if __import__("typing").TYPE_CHECKING: - # import apis into sdk package - from instana_client.api.ai_management_api import AIManagementApi as AIManagementApi - from instana_client.api.api_token_api import APITokenApi as APITokenApi - from instana_client.api.action_catalog_api import ActionCatalogApi as ActionCatalogApi - from instana_client.api.action_history_api import ActionHistoryApi as ActionHistoryApi - from instana_client.api.apdex_report_api import ApdexReportApi as ApdexReportApi - from instana_client.api.apdex_settings_api import ApdexSettingsApi as ApdexSettingsApi - from instana_client.api.application_alert_configuration_api import ApplicationAlertConfigurationApi as ApplicationAlertConfigurationApi - from instana_client.api.application_analyze_api import ApplicationAnalyzeApi as ApplicationAnalyzeApi - from instana_client.api.application_catalog_api import ApplicationCatalogApi as ApplicationCatalogApi - from instana_client.api.application_metrics_api import ApplicationMetricsApi as ApplicationMetricsApi - from instana_client.api.application_resources_api import ApplicationResourcesApi as ApplicationResourcesApi - from instana_client.api.application_settings_api import ApplicationSettingsApi as ApplicationSettingsApi - from instana_client.api.application_topology_api import ApplicationTopologyApi as ApplicationTopologyApi - from instana_client.api.audit_log_api import AuditLogApi as AuditLogApi - from instana_client.api.authentication_api import AuthenticationApi as AuthenticationApi - from instana_client.api.business_monitoring_api import BusinessMonitoringApi as BusinessMonitoringApi - from instana_client.api.custom_dashboards_api import CustomDashboardsApi as CustomDashboardsApi - from instana_client.api.custom_entities_api import CustomEntitiesApi as CustomEntitiesApi - from instana_client.api.end_user_monitoring_api import EndUserMonitoringApi as EndUserMonitoringApi - from instana_client.api.event_settings_api import EventSettingsApi as EventSettingsApi - from instana_client.api.events_api import EventsApi as EventsApi - from instana_client.api.global_application_alert_configuration_api import GlobalApplicationAlertConfigurationApi as GlobalApplicationAlertConfigurationApi - from instana_client.api.groups_api import GroupsApi as GroupsApi - from instana_client.api.health_api import HealthApi as HealthApi - from instana_client.api.host_agent_api import HostAgentApi as HostAgentApi - from instana_client.api.infrastructure_alert_configuration_api import InfrastructureAlertConfigurationApi as InfrastructureAlertConfigurationApi - from instana_client.api.infrastructure_analyze_api import InfrastructureAnalyzeApi as InfrastructureAnalyzeApi - from instana_client.api.infrastructure_catalog_api import InfrastructureCatalogApi as InfrastructureCatalogApi - from instana_client.api.infrastructure_metrics_api import InfrastructureMetricsApi as InfrastructureMetricsApi - from instana_client.api.infrastructure_resources_api import InfrastructureResourcesApi as InfrastructureResourcesApi - from instana_client.api.infrastructure_topology_api import InfrastructureTopologyApi as InfrastructureTopologyApi - from instana_client.api.llm_price_configuration_api import LLMPriceConfigurationApi as LLMPriceConfigurationApi - from instana_client.api.log_alert_configuration_api import LogAlertConfigurationApi as LogAlertConfigurationApi - from instana_client.api.logging_analyze_api import LoggingAnalyzeApi as LoggingAnalyzeApi - from instana_client.api.maintenance_configuration_api import MaintenanceConfigurationApi as MaintenanceConfigurationApi - from instana_client.api.mobile_app_analyze_api import MobileAppAnalyzeApi as MobileAppAnalyzeApi - from instana_client.api.mobile_app_catalog_api import MobileAppCatalogApi as MobileAppCatalogApi - from instana_client.api.mobile_app_configuration_api import MobileAppConfigurationApi as MobileAppConfigurationApi - from instana_client.api.mobile_app_metrics_api import MobileAppMetricsApi as MobileAppMetricsApi - from instana_client.api.policies_api import PoliciesApi as PoliciesApi - from instana_client.api.releases_api import ReleasesApi as ReleasesApi - from instana_client.api.roles_api import RolesApi as RolesApi - from instana_client.api.sli_report_api import SLIReportApi as SLIReportApi - from instana_client.api.sli_settings_api import SLISettingsApi as SLISettingsApi - from instana_client.api.slo_configurations_api import SLOConfigurationsApi as SLOConfigurationsApi - from instana_client.api.slo_correction_configurations_api import SLOCorrectionConfigurationsApi as SLOCorrectionConfigurationsApi - from instana_client.api.slo_correction_windows_api import SLOCorrectionWindowsApi as SLOCorrectionWindowsApi - from instana_client.api.service_levels_alert_configuration_api import ServiceLevelsAlertConfigurationApi as ServiceLevelsAlertConfigurationApi - from instana_client.api.service_levels_objective_slo_report_api import ServiceLevelsObjectiveSLOReportApi as ServiceLevelsObjectiveSLOReportApi - from instana_client.api.session_settings_api import SessionSettingsApi as SessionSettingsApi - from instana_client.api.synthetic_alert_configuration_api import SyntheticAlertConfigurationApi as SyntheticAlertConfigurationApi - from instana_client.api.synthetic_calls_api import SyntheticCallsApi as SyntheticCallsApi - from instana_client.api.synthetic_catalog_api import SyntheticCatalogApi as SyntheticCatalogApi - from instana_client.api.synthetic_metrics_api import SyntheticMetricsApi as SyntheticMetricsApi - from instana_client.api.synthetic_settings_api import SyntheticSettingsApi as SyntheticSettingsApi - from instana_client.api.synthetic_test_playback_results_api import SyntheticTestPlaybackResultsApi as SyntheticTestPlaybackResultsApi - from instana_client.api.teams_api import TeamsApi as TeamsApi - from instana_client.api.usage_api import UsageApi as UsageApi - from instana_client.api.user_api import UserApi as UserApi - from instana_client.api.website_analyze_api import WebsiteAnalyzeApi as WebsiteAnalyzeApi - from instana_client.api.website_catalog_api import WebsiteCatalogApi as WebsiteCatalogApi - from instana_client.api.website_configuration_api import WebsiteConfigurationApi as WebsiteConfigurationApi - from instana_client.api.website_metrics_api import WebsiteMetricsApi as WebsiteMetricsApi - from instana_client.api.default_api import DefaultApi as DefaultApi - - # import ApiClient - from instana_client.api_response import ApiResponse as ApiResponse - from instana_client.api_client import ApiClient as ApiClient - from instana_client.configuration import Configuration as Configuration - from instana_client.exceptions import OpenApiException as OpenApiException - from instana_client.exceptions import ApiTypeError as ApiTypeError - from instana_client.exceptions import ApiValueError as ApiValueError - from instana_client.exceptions import ApiKeyError as ApiKeyError - from instana_client.exceptions import ApiAttributeError as ApiAttributeError - from instana_client.exceptions import ApiException as ApiException - - # import models into sdk package - from instana_client.models.abstract_integration import AbstractIntegration as AbstractIntegration - from instana_client.models.abstract_rule import AbstractRule as AbstractRule - from instana_client.models.access_log_entry import AccessLogEntry as AccessLogEntry - from instana_client.models.access_log_response import AccessLogResponse as AccessLogResponse - from instana_client.models.access_rule import AccessRule as AccessRule - from instana_client.models.action import Action as Action - from instana_client.models.action_beacon import ActionBeacon as ActionBeacon - from instana_client.models.action_configuration import ActionConfiguration as ActionConfiguration - from instana_client.models.action_instance import ActionInstance as ActionInstance - from instana_client.models.action_instance_metadata_entry import ActionInstanceMetadataEntry as ActionInstanceMetadataEntry - from instana_client.models.action_instance_parameter import ActionInstanceParameter as ActionInstanceParameter - from instana_client.models.action_instance_request import ActionInstanceRequest as ActionInstanceRequest - from instana_client.models.action_instance_request_parameters import ActionInstanceRequestParameters as ActionInstanceRequestParameters - from instana_client.models.action_match import ActionMatch as ActionMatch - from instana_client.models.action_search_space import ActionSearchSpace as ActionSearchSpace - from instana_client.models.adaptive_baseline import AdaptiveBaseline as AdaptiveBaseline - from instana_client.models.adaptive_threshold_rule import AdaptiveThresholdRule as AdaptiveThresholdRule - from instana_client.models.addition import Addition as Addition - from instana_client.models.adjusted_timeframe import AdjustedTimeframe as AdjustedTimeframe - from instana_client.models.agent_configuration_update import AgentConfigurationUpdate as AgentConfigurationUpdate - from instana_client.models.alerting_configuration import AlertingConfiguration as AlertingConfiguration - from instana_client.models.alerting_configuration_with_last_updated import AlertingConfigurationWithLastUpdated as AlertingConfigurationWithLastUpdated - from instana_client.models.alerting_time_window import AlertingTimeWindow as AlertingTimeWindow - from instana_client.models.apdex_configuration import ApdexConfiguration as ApdexConfiguration - from instana_client.models.apdex_configuration_input import ApdexConfigurationInput as ApdexConfigurationInput - from instana_client.models.apdex_entity import ApdexEntity as ApdexEntity - from instana_client.models.apdex_level import ApdexLevel as ApdexLevel - from instana_client.models.apdex_report import ApdexReport as ApdexReport - from instana_client.models.api_create_group import ApiCreateGroup as ApiCreateGroup - from instana_client.models.api_create_role import ApiCreateRole as ApiCreateRole - from instana_client.models.api_group import ApiGroup as ApiGroup - from instana_client.models.api_member import ApiMember as ApiMember - from instana_client.models.api_permission_set import ApiPermissionSet as ApiPermissionSet - from instana_client.models.api_restricted_application_filter import ApiRestrictedApplicationFilter as ApiRestrictedApplicationFilter - from instana_client.models.api_role import ApiRole as ApiRole - from instana_client.models.api_tag import ApiTag as ApiTag - from instana_client.models.api_team import ApiTeam as ApiTeam - from instana_client.models.api_team_info import ApiTeamInfo as ApiTeamInfo - from instana_client.models.api_team_member import ApiTeamMember as ApiTeamMember - from instana_client.models.api_team_role import ApiTeamRole as ApiTeamRole - from instana_client.models.api_team_scope import ApiTeamScope as ApiTeamScope - from instana_client.models.api_token import ApiToken as ApiToken - from instana_client.models.app_data_metric_configuration import AppDataMetricConfiguration as AppDataMetricConfiguration - from instana_client.models.application import Application as Application - from instana_client.models.application_alert_config import ApplicationAlertConfig as ApplicationAlertConfig - from instana_client.models.application_alert_config_with_metadata import ApplicationAlertConfigWithMetadata as ApplicationAlertConfigWithMetadata - from instana_client.models.application_alert_rule import ApplicationAlertRule as ApplicationAlertRule - from instana_client.models.application_apdex_entity import ApplicationApdexEntity as ApplicationApdexEntity - from instana_client.models.application_config import ApplicationConfig as ApplicationConfig - from instana_client.models.application_event_result import ApplicationEventResult as ApplicationEventResult - from instana_client.models.application_item import ApplicationItem as ApplicationItem - from instana_client.models.application_metric_result import ApplicationMetricResult as ApplicationMetricResult - from instana_client.models.application_node import ApplicationNode as ApplicationNode - from instana_client.models.application_result import ApplicationResult as ApplicationResult - from instana_client.models.application_scope import ApplicationScope as ApplicationScope - from instana_client.models.application_scope_with_metadata import ApplicationScopeWithMetadata as ApplicationScopeWithMetadata - from instana_client.models.application_sli_entity import ApplicationSliEntity as ApplicationSliEntity - from instana_client.models.application_slo_entity import ApplicationSloEntity as ApplicationSloEntity - from instana_client.models.application_time_threshold import ApplicationTimeThreshold as ApplicationTimeThreshold - from instana_client.models.arithmetic_configuration import ArithmeticConfiguration as ArithmeticConfiguration - from instana_client.models.arithmetic_operand import ArithmeticOperand as ArithmeticOperand - from instana_client.models.arithmetic_operation import ArithmeticOperation as ArithmeticOperation - from instana_client.models.audit_log_entry import AuditLogEntry as AuditLogEntry - from instana_client.models.audit_log_ui_response import AuditLogUiResponse as AuditLogUiResponse - from instana_client.models.author import Author as Author - from instana_client.models.availability_blueprint_indicator import AvailabilityBlueprintIndicator as AvailabilityBlueprintIndicator - from instana_client.models.availability_sli_entity import AvailabilitySliEntity as AvailabilitySliEntity - from instana_client.models.available_metrics import AvailableMetrics as AvailableMetrics - from instana_client.models.available_plugins import AvailablePlugins as AvailablePlugins - from instana_client.models.backend_trace_reference import BackendTraceReference as BackendTraceReference - from instana_client.models.bidirectional_ms_teams_app_integration import BidirectionalMsTeamsAppIntegration as BidirectionalMsTeamsAppIntegration - from instana_client.models.bidirectional_slack_app_integration import BidirectionalSlackAppIntegration as BidirectionalSlackAppIntegration - from instana_client.models.binary_operator_dto import BinaryOperatorDTO as BinaryOperatorDTO - from instana_client.models.browser_script_configuration import BrowserScriptConfiguration as BrowserScriptConfiguration - from instana_client.models.browser_script_configuration_update import BrowserScriptConfigurationUpdate as BrowserScriptConfigurationUpdate - from instana_client.models.built_in_event_specification import BuiltInEventSpecification as BuiltInEventSpecification - from instana_client.models.built_in_event_specification_with_last_updated import BuiltInEventSpecificationWithLastUpdated as BuiltInEventSpecificationWithLastUpdated - from instana_client.models.business_activity import BusinessActivity as BusinessActivity - from instana_client.models.business_perspective_config import BusinessPerspectiveConfig as BusinessPerspectiveConfig - from instana_client.models.call_groups_item import CallGroupsItem as CallGroupsItem - from instana_client.models.call_groups_result import CallGroupsResult as CallGroupsResult - from instana_client.models.call_relation import CallRelation as CallRelation - from instana_client.models.change_summary import ChangeSummary as ChangeSummary - from instana_client.models.cloudfoundry_physical_context import CloudfoundryPhysicalContext as CloudfoundryPhysicalContext - from instana_client.models.condition import Condition as Condition - from instana_client.models.config_version import ConfigVersion as ConfigVersion - from instana_client.models.correction import Correction as Correction - from instana_client.models.correction_configuration import CorrectionConfiguration as CorrectionConfiguration - from instana_client.models.correction_scheduling import CorrectionScheduling as CorrectionScheduling - from instana_client.models.correction_window import CorrectionWindow as CorrectionWindow - from instana_client.models.crash_mobile_app_alert_rule import CrashMobileAppAlertRule as CrashMobileAppAlertRule - from instana_client.models.create_website_request_inner import CreateWebsiteRequestInner as CreateWebsiteRequestInner - from instana_client.models.cursor_paginated_business_activity_item import CursorPaginatedBusinessActivityItem as CursorPaginatedBusinessActivityItem - from instana_client.models.cursor_pagination import CursorPagination as CursorPagination - from instana_client.models.cursor_pagination_with_ui_cursor_infra_explore_cursor import CursorPaginationWithUiCursorInfraExploreCursor as CursorPaginationWithUiCursorInfraExploreCursor - from instana_client.models.custom_blueprint_indicator import CustomBlueprintIndicator as CustomBlueprintIndicator - from instana_client.models.custom_dashboard import CustomDashboard as CustomDashboard - from instana_client.models.custom_dashboard_preview import CustomDashboardPreview as CustomDashboardPreview - from instana_client.models.custom_dashboard_with_user_specific_information import CustomDashboardWithUserSpecificInformation as CustomDashboardWithUserSpecificInformation - from instana_client.models.custom_dependency import CustomDependency as CustomDependency - from instana_client.models.custom_email_subject_prefix import CustomEmailSubjectPrefix as CustomEmailSubjectPrefix - from instana_client.models.custom_entity_model import CustomEntityModel as CustomEntityModel - from instana_client.models.custom_entity_with_metadata import CustomEntityWithMetadata as CustomEntityWithMetadata - from instana_client.models.custom_event_mobile_app_alert_rule import CustomEventMobileAppAlertRule as CustomEventMobileAppAlertRule - from instana_client.models.custom_event_specification import CustomEventSpecification as CustomEventSpecification - from instana_client.models.custom_event_specification_with_last_updated import CustomEventSpecificationWithLastUpdated as CustomEventSpecificationWithLastUpdated - from instana_client.models.custom_event_website_alert_rule import CustomEventWebsiteAlertRule as CustomEventWebsiteAlertRule - from instana_client.models.custom_metric import CustomMetric as CustomMetric - from instana_client.models.custom_payload_configuration import CustomPayloadConfiguration as CustomPayloadConfiguration - from instana_client.models.custom_payload_field import CustomPayloadField as CustomPayloadField - from instana_client.models.custom_payload_with_last_updated import CustomPayloadWithLastUpdated as CustomPayloadWithLastUpdated - from instana_client.models.custom_payload_with_version import CustomPayloadWithVersion as CustomPayloadWithVersion - from instana_client.models.custom_tag import CustomTag as CustomTag - from instana_client.models.dns_configuration import DNSConfiguration as DNSConfiguration - from instana_client.models.dns_configuration_update import DNSConfigurationUpdate as DNSConfigurationUpdate - from instana_client.models.dns_filter_query_time import DNSFilterQueryTime as DNSFilterQueryTime - from instana_client.models.dns_filter_target_value import DNSFilterTargetValue as DNSFilterTargetValue - from instana_client.models.dashboard_api_token import DashboardApiToken as DashboardApiToken - from instana_client.models.database_integration import DatabaseIntegration as DatabaseIntegration - from instana_client.models.deprecated_tag_filter import DeprecatedTagFilter as DeprecatedTagFilter - from instana_client.models.division import Division as Division - from instana_client.models.duration import Duration as Duration - from instana_client.models.dynamic_field import DynamicField as DynamicField - from instana_client.models.dynamic_field_value import DynamicFieldValue as DynamicFieldValue - from instana_client.models.dynamic_parameter import DynamicParameter as DynamicParameter - from instana_client.models.dynamic_tag import DynamicTag as DynamicTag - from instana_client.models.edit_user import EditUser as EditUser - from instana_client.models.email_integration import EmailIntegration as EmailIntegration - from instana_client.models.empty_configuration import EmptyConfiguration as EmptyConfiguration - from instana_client.models.endpoint import Endpoint as Endpoint - from instana_client.models.endpoint_config import EndpointConfig as EndpointConfig - from instana_client.models.endpoint_event_result import EndpointEventResult as EndpointEventResult - from instana_client.models.endpoint_item import EndpointItem as EndpointItem - from instana_client.models.endpoint_metric_result import EndpointMetricResult as EndpointMetricResult - from instana_client.models.endpoint_node import EndpointNode as EndpointNode - from instana_client.models.endpoint_result import EndpointResult as EndpointResult - from instana_client.models.endpoint_simple import EndpointSimple as EndpointSimple - from instana_client.models.entity_count_rule import EntityCountRule as EntityCountRule - from instana_client.models.entity_count_verification_rule import EntityCountVerificationRule as EntityCountVerificationRule - from instana_client.models.entity_health_info import EntityHealthInfo as EntityHealthInfo - from instana_client.models.entity_id import EntityId as EntityId - from instana_client.models.entity_verification_rule import EntityVerificationRule as EntityVerificationRule - from instana_client.models.error_budget_alert_rule import ErrorBudgetAlertRule as ErrorBudgetAlertRule - from instana_client.models.errors_application_alert_rule import ErrorsApplicationAlertRule as ErrorsApplicationAlertRule - from instana_client.models.event import Event as Event - from instana_client.models.event_filtering_configuration import EventFilteringConfiguration as EventFilteringConfiguration - from instana_client.models.event_result import EventResult as EventResult - from instana_client.models.event_specification_info import EventSpecificationInfo as EventSpecificationInfo - from instana_client.models.extended_service import ExtendedService as ExtendedService - from instana_client.models.failure_synthetic_alert_rule import FailureSyntheticAlertRule as FailureSyntheticAlertRule - from instana_client.models.fixed_http_path_segment_matching_rule import FixedHttpPathSegmentMatchingRule as FixedHttpPathSegmentMatchingRule - from instana_client.models.fixed_time_window import FixedTimeWindow as FixedTimeWindow - from instana_client.models.generic_infra_alert_rule import GenericInfraAlertRule as GenericInfraAlertRule - from instana_client.models.geo_location_configuration import GeoLocationConfiguration as GeoLocationConfiguration - from instana_client.models.geo_mapping_rule import GeoMappingRule as GeoMappingRule - from instana_client.models.geo_subdivision import GeoSubdivision as GeoSubdivision - from instana_client.models.get_action_beacons_result import GetActionBeaconsResult as GetActionBeaconsResult - from instana_client.models.get_activities import GetActivities as GetActivities - from instana_client.models.get_application_metrics import GetApplicationMetrics as GetApplicationMetrics - from instana_client.models.get_applications import GetApplications as GetApplications - from instana_client.models.get_available_metrics_query import GetAvailableMetricsQuery as GetAvailableMetricsQuery - from instana_client.models.get_available_plugins_query import GetAvailablePluginsQuery as GetAvailablePluginsQuery - from instana_client.models.get_call_groups import GetCallGroups as GetCallGroups - from instana_client.models.get_combined_metrics import GetCombinedMetrics as GetCombinedMetrics - from instana_client.models.get_dynamic_parameter_values import GetDynamicParameterValues as GetDynamicParameterValues - from instana_client.models.get_endpoints import GetEndpoints as GetEndpoints - from instana_client.models.get_infrastructure_groups_query import GetInfrastructureGroupsQuery as GetInfrastructureGroupsQuery - from instana_client.models.get_infrastructure_query import GetInfrastructureQuery as GetInfrastructureQuery - from instana_client.models.get_metrics_result import GetMetricsResult as GetMetricsResult - from instana_client.models.get_mobile_app_beacon_groups import GetMobileAppBeaconGroups as GetMobileAppBeaconGroups - from instana_client.models.get_mobile_app_beacons import GetMobileAppBeacons as GetMobileAppBeacons - from instana_client.models.get_mobile_app_metrics import GetMobileAppMetrics as GetMobileAppMetrics - from instana_client.models.get_mobile_app_metrics_v2 import GetMobileAppMetricsV2 as GetMobileAppMetricsV2 - from instana_client.models.get_payload_keys_result import GetPayloadKeysResult as GetPayloadKeysResult - from instana_client.models.get_services import GetServices as GetServices - from instana_client.models.get_session_replay_metadata_result import GetSessionReplayMetadataResult as GetSessionReplayMetadataResult - from instana_client.models.get_snapshots_query import GetSnapshotsQuery as GetSnapshotsQuery - from instana_client.models.get_test_result import GetTestResult as GetTestResult - from instana_client.models.get_test_result_analytic import GetTestResultAnalytic as GetTestResultAnalytic - from instana_client.models.get_test_result_base import GetTestResultBase as GetTestResultBase - from instana_client.models.get_test_result_list import GetTestResultList as GetTestResultList - from instana_client.models.get_test_summary_result import GetTestSummaryResult as GetTestSummaryResult - from instana_client.models.get_trace_download_result_item import GetTraceDownloadResultItem as GetTraceDownloadResultItem - from instana_client.models.get_trace_groups import GetTraceGroups as GetTraceGroups - from instana_client.models.get_traces import GetTraces as GetTraces - from instana_client.models.get_website_beacon_groups import GetWebsiteBeaconGroups as GetWebsiteBeaconGroups - from instana_client.models.get_website_beacons import GetWebsiteBeacons as GetWebsiteBeacons - from instana_client.models.get_website_metrics import GetWebsiteMetrics as GetWebsiteMetrics - from instana_client.models.get_website_metrics_v2 import GetWebsiteMetricsV2 as GetWebsiteMetricsV2 - from instana_client.models.global_application_alert_config_with_metadata import GlobalApplicationAlertConfigWithMetadata as GlobalApplicationAlertConfigWithMetadata - from instana_client.models.global_applications_alert_config import GlobalApplicationsAlertConfig as GlobalApplicationsAlertConfig - from instana_client.models.google_chat_integration import GoogleChatIntegration as GoogleChatIntegration - from instana_client.models.graph_edge import GraphEdge as GraphEdge - from instana_client.models.graph_node import GraphNode as GraphNode - from instana_client.models.group import Group as Group - from instana_client.models.group_by_tag import GroupByTag as GroupByTag - from instana_client.models.group_mapping import GroupMapping as GroupMapping - from instana_client.models.group_mapping_overview import GroupMappingOverview as GroupMappingOverview - from instana_client.models.health_state import HealthState as HealthState - from instana_client.models.historic_baseline import HistoricBaseline as HistoricBaseline - from instana_client.models.host_availability_rule import HostAvailabilityRule as HostAvailabilityRule - from instana_client.models.http_action_configuration import HttpActionConfiguration as HttpActionConfiguration - from instana_client.models.http_action_configuration_update import HttpActionConfigurationUpdate as HttpActionConfigurationUpdate - from instana_client.models.http_endpoint_config import HttpEndpointConfig as HttpEndpointConfig - from instana_client.models.http_endpoint_rule import HttpEndpointRule as HttpEndpointRule - from instana_client.models.http_path_segment_matching_rule import HttpPathSegmentMatchingRule as HttpPathSegmentMatchingRule - from instana_client.models.http_script_configuration import HttpScriptConfiguration as HttpScriptConfiguration - from instana_client.models.http_script_configuration_update import HttpScriptConfigurationUpdate as HttpScriptConfigurationUpdate - from instana_client.models.hyper_param import HyperParam as HyperParam - from instana_client.models.identity_provider_patch import IdentityProviderPatch as IdentityProviderPatch - from instana_client.models.idp_status_update import IdpStatusUpdate as IdpStatusUpdate - from instana_client.models.impacted_beacon_info import ImpactedBeaconInfo as ImpactedBeaconInfo - from instana_client.models.infra_alert_config import InfraAlertConfig as InfraAlertConfig - from instana_client.models.infra_alert_config_with_metadata import InfraAlertConfigWithMetadata as InfraAlertConfigWithMetadata - from instana_client.models.infra_alert_rule import InfraAlertRule as InfraAlertRule - from instana_client.models.infra_event_result import InfraEventResult as InfraEventResult - from instana_client.models.infra_metric_configuration import InfraMetricConfiguration as InfraMetricConfiguration - from instana_client.models.infra_slo_entity import InfraSloEntity as InfraSloEntity - from instana_client.models.infra_time_threshold import InfraTimeThreshold as InfraTimeThreshold - from instana_client.models.infrastructure_entities_result import InfrastructureEntitiesResult as InfrastructureEntitiesResult - from instana_client.models.infrastructure_group import InfrastructureGroup as InfrastructureGroup - from instana_client.models.infrastructure_groups_result import InfrastructureGroupsResult as InfrastructureGroupsResult - from instana_client.models.infrastructure_item import InfrastructureItem as InfrastructureItem - from instana_client.models.infrastructure_metric_result import InfrastructureMetricResult as InfrastructureMetricResult - from instana_client.models.instana_version_info import InstanaVersionInfo as InstanaVersionInfo - from instana_client.models.integration_overview import IntegrationOverview as IntegrationOverview - from instana_client.models.invitation import Invitation as Invitation - from instana_client.models.invitation_response import InvitationResponse as InvitationResponse - from instana_client.models.invitation_result import InvitationResult as InvitationResult - from instana_client.models.ip_masking_configuration import IpMaskingConfiguration as IpMaskingConfiguration - from instana_client.models.js_stack_trace_line import JsStackTraceLine as JsStackTraceLine - from instana_client.models.kubernetes_physical_context import KubernetesPhysicalContext as KubernetesPhysicalContext - from instana_client.models.llm_egress_gateway import LLMEgressGateway as LLMEgressGateway - from instana_client.models.llm_gateway_capability import LLMGatewayCapability as LLMGatewayCapability - from instana_client.models.llm_gateway_model import LLMGatewayModel as LLMGatewayModel - from instana_client.models.llm_gateway_service import LLMGatewayService as LLMGatewayService - from instana_client.models.llm_gateway_test_connection_request import LLMGatewayTestConnectionRequest as LLMGatewayTestConnectionRequest - from instana_client.models.latency_blueprint_indicator import LatencyBlueprintIndicator as LatencyBlueprintIndicator - from instana_client.models.llm_model_price import LlmModelPrice as LlmModelPrice - from instana_client.models.llm_model_price_metadata import LlmModelPriceMetadata as LlmModelPriceMetadata - from instana_client.models.location_status import LocationStatus as LocationStatus - from instana_client.models.log_alert_config import LogAlertConfig as LogAlertConfig - from instana_client.models.log_alert_config_with_metadata import LogAlertConfigWithMetadata as LogAlertConfigWithMetadata - from instana_client.models.log_alert_rule import LogAlertRule as LogAlertRule - from instana_client.models.log_count_alert_rule import LogCountAlertRule as LogCountAlertRule - from instana_client.models.log_entry_actor import LogEntryActor as LogEntryActor - from instana_client.models.log_event_result import LogEventResult as LogEventResult - from instana_client.models.log_time_threshold import LogTimeThreshold as LogTimeThreshold - from instana_client.models.log_volume_group import LogVolumeGroup as LogVolumeGroup - from instana_client.models.log_volume_usage_item import LogVolumeUsageItem as LogVolumeUsageItem - from instana_client.models.log_volume_usage_result import LogVolumeUsageResult as LogVolumeUsageResult - from instana_client.models.logs_application_alert_rule import LogsApplicationAlertRule as LogsApplicationAlertRule - from instana_client.models.maintenance_config import MaintenanceConfig as MaintenanceConfig - from instana_client.models.maintenance_config_scheduling import MaintenanceConfigScheduling as MaintenanceConfigScheduling - from instana_client.models.maintenance_config_v2 import MaintenanceConfigV2 as MaintenanceConfigV2 - from instana_client.models.maintenance_config_v2_with_state_and_occurrence import MaintenanceConfigV2WithStateAndOccurrence as MaintenanceConfigV2WithStateAndOccurrence - from instana_client.models.maintenance_config_with_last_updated import MaintenanceConfigWithLastUpdated as MaintenanceConfigWithLastUpdated - from instana_client.models.maintenance_window import MaintenanceWindow as MaintenanceWindow - from instana_client.models.manual_alerting_channel_configuration import ManualAlertingChannelConfiguration as ManualAlertingChannelConfiguration - from instana_client.models.manual_close_info import ManualCloseInfo as ManualCloseInfo - from instana_client.models.manual_service_config import ManualServiceConfig as ManualServiceConfig - from instana_client.models.match_all_http_path_segment_matching_rule import MatchAllHttpPathSegmentMatchingRule as MatchAllHttpPathSegmentMatchingRule - from instana_client.models.match_expression_dto import MatchExpressionDTO as MatchExpressionDTO - from instana_client.models.meta_data import MetaData as MetaData - from instana_client.models.metric_api_result import MetricAPIResult as MetricAPIResult - from instana_client.models.metric_config import MetricConfig as MetricConfig - from instana_client.models.metric_configuration import MetricConfiguration as MetricConfiguration - from instana_client.models.metric_description import MetricDescription as MetricDescription - from instana_client.models.metric_instance import MetricInstance as MetricInstance - from instana_client.models.metric_item import MetricItem as MetricItem - from instana_client.models.metric_metadata import MetricMetadata as MetricMetadata - from instana_client.models.metric_pattern import MetricPattern as MetricPattern - from instana_client.models.metric_query import MetricQuery as MetricQuery - from instana_client.models.metrics_result import MetricsResult as MetricsResult - from instana_client.models.metrics_result_item import MetricsResultItem as MetricsResultItem - from instana_client.models.metrics_test_result_item import MetricsTestResultItem as MetricsTestResultItem - from instana_client.models.mobile_app import MobileApp as MobileApp - from instana_client.models.mobile_app_alert_config import MobileAppAlertConfig as MobileAppAlertConfig - from instana_client.models.mobile_app_alert_config_with_rbac_tag import MobileAppAlertConfigWithRBACTag as MobileAppAlertConfigWithRBACTag - from instana_client.models.mobile_app_alert_rule import MobileAppAlertRule as MobileAppAlertRule - from instana_client.models.mobile_app_beacon_groups_item import MobileAppBeaconGroupsItem as MobileAppBeaconGroupsItem - from instana_client.models.mobile_app_beacon_groups_result import MobileAppBeaconGroupsResult as MobileAppBeaconGroupsResult - from instana_client.models.mobile_app_beacon_result import MobileAppBeaconResult as MobileAppBeaconResult - from instana_client.models.mobile_app_beacon_tag_group import MobileAppBeaconTagGroup as MobileAppBeaconTagGroup - from instana_client.models.mobile_app_beacons_item import MobileAppBeaconsItem as MobileAppBeaconsItem - from instana_client.models.mobile_app_event_result import MobileAppEventResult as MobileAppEventResult - from instana_client.models.mobile_app_metric_result import MobileAppMetricResult as MobileAppMetricResult - from instana_client.models.mobile_app_monitoring_beacon import MobileAppMonitoringBeacon as MobileAppMonitoringBeacon - from instana_client.models.mobile_app_monitoring_metric_description import MobileAppMonitoringMetricDescription as MobileAppMonitoringMetricDescription - from instana_client.models.mobile_app_monitoring_metrics_configuration import MobileAppMonitoringMetricsConfiguration as MobileAppMonitoringMetricsConfiguration - from instana_client.models.mobile_app_time_threshold import MobileAppTimeThreshold as MobileAppTimeThreshold - from instana_client.models.model_field import ModelField as ModelField - from instana_client.models.monitored_entities_stats import MonitoredEntitiesStats as MonitoredEntitiesStats - from instana_client.models.monitoring_state import MonitoringState as MonitoringState - from instana_client.models.multiple_scripts_configuration import MultipleScriptsConfiguration as MultipleScriptsConfiguration - from instana_client.models.multiplication import Multiplication as Multiplication - from instana_client.models.ns1_integration import NS1Integration as NS1Integration - from instana_client.models.nested_operation import NestedOperation as NestedOperation - from instana_client.models.new_application_config import NewApplicationConfig as NewApplicationConfig - from instana_client.models.new_business_perspective_config import NewBusinessPerspectiveConfig as NewBusinessPerspectiveConfig - from instana_client.models.new_manual_service_config import NewManualServiceConfig as NewManualServiceConfig - from instana_client.models.o_auth_config import OAuthConfig as OAuthConfig - from instana_client.models.o_auth_integration import OAuthIntegration as OAuthIntegration - from instana_client.models.o_auth_token import OAuthToken as OAuthToken - from instana_client.models.occurrence import Occurrence as Occurrence - from instana_client.models.office365_integration import Office365Integration as Office365Integration - from instana_client.models.one_time_maintenance_window import OneTimeMaintenanceWindow as OneTimeMaintenanceWindow - from instana_client.models.opsgenie_integration import OpsgenieIntegration as OpsgenieIntegration - from instana_client.models.order import Order as Order - from instana_client.models.pagerduty_integration import PagerdutyIntegration as PagerdutyIntegration - from instana_client.models.paginated_result import PaginatedResult as PaginatedResult - from instana_client.models.pagination import Pagination as Pagination - from instana_client.models.parameter import Parameter as Parameter - from instana_client.models.parameter_value import ParameterValue as ParameterValue - from instana_client.models.path_parameter_http_path_segment_matching_rule import PathParameterHttpPathSegmentMatchingRule as PathParameterHttpPathSegmentMatchingRule - from instana_client.models.physical_context import PhysicalContext as PhysicalContext - from instana_client.models.plugin_result import PluginResult as PluginResult - from instana_client.models.policy import Policy as Policy - from instana_client.models.policy_runnable import PolicyRunnable as PolicyRunnable - from instana_client.models.policy_scheduling import PolicyScheduling as PolicyScheduling - from instana_client.models.post_mobile_app_source_map_config_request import PostMobileAppSourceMapConfigRequest as PostMobileAppSourceMapConfigRequest - from instana_client.models.post_snapshots_result import PostSnapshotsResult as PostSnapshotsResult - from instana_client.models.prefix_object import PrefixObject as PrefixObject - from instana_client.models.problem import Problem as Problem - from instana_client.models.prometheus_webhook_integration import PrometheusWebhookIntegration as PrometheusWebhookIntegration - from instana_client.models.recurrent_maintenance_window import RecurrentMaintenanceWindow as RecurrentMaintenanceWindow - from instana_client.models.release import Release as Release - from instana_client.models.release_scope import ReleaseScope as ReleaseScope - from instana_client.models.release_with_metadata import ReleaseWithMetadata as ReleaseWithMetadata - from instana_client.models.retention_period import RetentionPeriod as RetentionPeriod - from instana_client.models.rolling_time_window import RollingTimeWindow as RollingTimeWindow - from instana_client.models.rule_input import RuleInput as RuleInput - from instana_client.models.rule_with_threshold_application_alert_rule import RuleWithThresholdApplicationAlertRule as RuleWithThresholdApplicationAlertRule - from instana_client.models.rule_with_threshold_infra_alert_rule import RuleWithThresholdInfraAlertRule as RuleWithThresholdInfraAlertRule - from instana_client.models.rule_with_threshold_log_alert_rule import RuleWithThresholdLogAlertRule as RuleWithThresholdLogAlertRule - from instana_client.models.rule_with_threshold_mobile_app_alert_rule import RuleWithThresholdMobileAppAlertRule as RuleWithThresholdMobileAppAlertRule - from instana_client.models.rule_with_threshold_website_alert_rule import RuleWithThresholdWebsiteAlertRule as RuleWithThresholdWebsiteAlertRule - from instana_client.models.run_configuration import RunConfiguration as RunConfiguration - from instana_client.models.slo_config_with_rbac_tag import SLOConfigWithRBACTag as SLOConfigWithRBACTag - from instana_client.models.ssl_certificate_configuration import SSLCertificateConfiguration as SSLCertificateConfiguration - from instana_client.models.ssl_certificate_configuration_update import SSLCertificateConfigurationUpdate as SSLCertificateConfigurationUpdate - from instana_client.models.ssl_certificate_validation import SSLCertificateValidation as SSLCertificateValidation - from instana_client.models.salesforce_integration import SalesforceIntegration as SalesforceIntegration - from instana_client.models.saturation_blueprint_indicator import SaturationBlueprintIndicator as SaturationBlueprintIndicator - from instana_client.models.scope_binding import ScopeBinding as ScopeBinding - from instana_client.models.search_field_result import SearchFieldResult as SearchFieldResult - from instana_client.models.service import Service as Service - from instana_client.models.service_config import ServiceConfig as ServiceConfig - from instana_client.models.service_event_result import ServiceEventResult as ServiceEventResult - from instana_client.models.service_item import ServiceItem as ServiceItem - from instana_client.models.service_level_indicator import ServiceLevelIndicator as ServiceLevelIndicator - from instana_client.models.service_level_objective_alert_rule import ServiceLevelObjectiveAlertRule as ServiceLevelObjectiveAlertRule - from instana_client.models.service_levels_alert_config import ServiceLevelsAlertConfig as ServiceLevelsAlertConfig - from instana_client.models.service_levels_alert_config_with_rbac_tag import ServiceLevelsAlertConfigWithRBACTag as ServiceLevelsAlertConfigWithRBACTag - from instana_client.models.service_levels_alert_rule import ServiceLevelsAlertRule as ServiceLevelsAlertRule - from instana_client.models.service_levels_burn_rate_config import ServiceLevelsBurnRateConfig as ServiceLevelsBurnRateConfig - from instana_client.models.service_levels_burn_rate_time_windows import ServiceLevelsBurnRateTimeWindows as ServiceLevelsBurnRateTimeWindows - from instana_client.models.service_levels_static_threshold_config import ServiceLevelsStaticThresholdConfig as ServiceLevelsStaticThresholdConfig - from instana_client.models.service_levels_time_threshold import ServiceLevelsTimeThreshold as ServiceLevelsTimeThreshold - from instana_client.models.service_levelse_alert_config_with_metadata import ServiceLevelseAlertConfigWithMetadata as ServiceLevelseAlertConfigWithMetadata - from instana_client.models.service_map import ServiceMap as ServiceMap - from instana_client.models.service_map_connection import ServiceMapConnection as ServiceMapConnection - from instana_client.models.service_matching_rule import ServiceMatchingRule as ServiceMatchingRule - from instana_client.models.service_metric_result import ServiceMetricResult as ServiceMetricResult - from instana_client.models.service_node import ServiceNode as ServiceNode - from instana_client.models.service_now_enhanced_integration import ServiceNowEnhancedIntegration as ServiceNowEnhancedIntegration - from instana_client.models.service_now_integration import ServiceNowIntegration as ServiceNowIntegration - from instana_client.models.service_result import ServiceResult as ServiceResult - from instana_client.models.service_scope import ServiceScope as ServiceScope - from instana_client.models.service_scope_with_metadata import ServiceScopeWithMetadata as ServiceScopeWithMetadata - from instana_client.models.service_scoped_to import ServiceScopedTo as ServiceScopedTo - from instana_client.models.service_scoped_to_with_metadata import ServiceScopedToWithMetadata as ServiceScopedToWithMetadata - from instana_client.models.service_simple import ServiceSimple as ServiceSimple - from instana_client.models.session_replay_metadata import SessionReplayMetadata as SessionReplayMetadata - from instana_client.models.session_replay_timestamps import SessionReplayTimestamps as SessionReplayTimestamps - from instana_client.models.session_settings import SessionSettings as SessionSettings - from instana_client.models.simple_metric_configuration import SimpleMetricConfiguration as SimpleMetricConfiguration - from instana_client.models.single_value import SingleValue as SingleValue - from instana_client.models.slack_integration import SlackIntegration as SlackIntegration - from instana_client.models.sli_configuration import SliConfiguration as SliConfiguration - from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated as SliConfigurationWithLastUpdated - from instana_client.models.sli_entity import SliEntity as SliEntity - from instana_client.models.sli_report import SliReport as SliReport - from instana_client.models.slo_entity import SloEntity as SloEntity - from instana_client.models.slo_report import SloReport as SloReport - from instana_client.models.slowness_application_alert_rule import SlownessApplicationAlertRule as SlownessApplicationAlertRule - from instana_client.models.slowness_mobile_app_alert_rule import SlownessMobileAppAlertRule as SlownessMobileAppAlertRule - from instana_client.models.slowness_website_alert_rule import SlownessWebsiteAlertRule as SlownessWebsiteAlertRule - from instana_client.models.snapshot_item import SnapshotItem as SnapshotItem - from instana_client.models.snapshot_preview import SnapshotPreview as SnapshotPreview - from instana_client.models.snapshot_result import SnapshotResult as SnapshotResult - from instana_client.models.software_user import SoftwareUser as SoftwareUser - from instana_client.models.software_version import SoftwareVersion as SoftwareVersion - from instana_client.models.source_map_file_blob import SourceMapFileBlob as SourceMapFileBlob - from instana_client.models.source_map_file_meta import SourceMapFileMeta as SourceMapFileMeta - from instana_client.models.source_map_upload_config import SourceMapUploadConfig as SourceMapUploadConfig - from instana_client.models.source_map_upload_configs import SourceMapUploadConfigs as SourceMapUploadConfigs - from instana_client.models.span_excerpt import SpanExcerpt as SpanExcerpt - from instana_client.models.span_relation import SpanRelation as SpanRelation - from instana_client.models.specific_js_errors_website_alert_rule import SpecificJsErrorsWebsiteAlertRule as SpecificJsErrorsWebsiteAlertRule - from instana_client.models.splunk_integration import SplunkIntegration as SplunkIntegration - from instana_client.models.stack_trace_item import StackTraceItem as StackTraceItem - from instana_client.models.stack_trace_line import StackTraceLine as StackTraceLine - from instana_client.models.static_baseline_threshold_rule import StaticBaselineThresholdRule as StaticBaselineThresholdRule - from instana_client.models.static_string_field import StaticStringField as StaticStringField - from instana_client.models.static_threshold import StaticThreshold as StaticThreshold - from instana_client.models.static_threshold_rule import StaticThresholdRule as StaticThresholdRule - from instana_client.models.status_code_application_alert_rule import StatusCodeApplicationAlertRule as StatusCodeApplicationAlertRule - from instana_client.models.status_code_mobile_app_alert_rule import StatusCodeMobileAppAlertRule as StatusCodeMobileAppAlertRule - from instana_client.models.status_code_website_alert_rule import StatusCodeWebsiteAlertRule as StatusCodeWebsiteAlertRule - from instana_client.models.subtraction import Subtraction as Subtraction - from instana_client.models.synthetic_alert_config import SyntheticAlertConfig as SyntheticAlertConfig - from instana_client.models.synthetic_alert_config_with_metadata import SyntheticAlertConfigWithMetadata as SyntheticAlertConfigWithMetadata - from instana_client.models.synthetic_alert_config_with_rbac_tag import SyntheticAlertConfigWithRBACTag as SyntheticAlertConfigWithRBACTag - from instana_client.models.synthetic_alert_rule import SyntheticAlertRule as SyntheticAlertRule - from instana_client.models.synthetic_bulk_response import SyntheticBulkResponse as SyntheticBulkResponse - from instana_client.models.synthetic_call_config import SyntheticCallConfig as SyntheticCallConfig - from instana_client.models.synthetic_call_rule import SyntheticCallRule as SyntheticCallRule - from instana_client.models.synthetic_call_with_defaults_config import SyntheticCallWithDefaultsConfig as SyntheticCallWithDefaultsConfig - from instana_client.models.synthetic_configuration import SyntheticConfiguration as SyntheticConfiguration - from instana_client.models.synthetic_configuration_update import SyntheticConfigurationUpdate as SyntheticConfigurationUpdate - from instana_client.models.synthetic_credential import SyntheticCredential as SyntheticCredential - from instana_client.models.synthetic_datacenter import SyntheticDatacenter as SyntheticDatacenter - from instana_client.models.synthetic_datacenter_configuration import SyntheticDatacenterConfiguration as SyntheticDatacenterConfiguration - from instana_client.models.synthetic_geo_point import SyntheticGeoPoint as SyntheticGeoPoint - from instana_client.models.synthetic_location import SyntheticLocation as SyntheticLocation - from instana_client.models.synthetic_location_configuration import SyntheticLocationConfiguration as SyntheticLocationConfiguration - from instana_client.models.synthetic_metric_configuration import SyntheticMetricConfiguration as SyntheticMetricConfiguration - from instana_client.models.synthetic_metric_tag_group import SyntheticMetricTagGroup as SyntheticMetricTagGroup - from instana_client.models.synthetic_playback_capabilities import SyntheticPlaybackCapabilities as SyntheticPlaybackCapabilities - from instana_client.models.synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value import SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue as SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue - from instana_client.models.synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation import SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation as SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation - from instana_client.models.synthetic_resource_update_list_string_list_string import SyntheticResourceUpdateListStringListString as SyntheticResourceUpdateListStringListString - from instana_client.models.synthetic_resource_update_map_string_string_list_string import SyntheticResourceUpdateMapStringStringListString as SyntheticResourceUpdateMapStringStringListString - from instana_client.models.synthetic_slo_entity import SyntheticSloEntity as SyntheticSloEntity - from instana_client.models.synthetic_test import SyntheticTest as SyntheticTest - from instana_client.models.synthetic_test_cicd import SyntheticTestCICD as SyntheticTestCICD - from instana_client.models.synthetic_test_cicd_customization import SyntheticTestCICDCustomization as SyntheticTestCICDCustomization - from instana_client.models.synthetic_test_cicd_item import SyntheticTestCICDItem as SyntheticTestCICDItem - from instana_client.models.synthetic_test_cicd_response import SyntheticTestCICDResponse as SyntheticTestCICDResponse - from instana_client.models.synthetic_test_deep_update import SyntheticTestDeepUpdate as SyntheticTestDeepUpdate - from instana_client.models.synthetic_test_shallow_update import SyntheticTestShallowUpdate as SyntheticTestShallowUpdate - from instana_client.models.synthetic_test_update import SyntheticTestUpdate as SyntheticTestUpdate - from instana_client.models.synthetic_time_threshold import SyntheticTimeThreshold as SyntheticTimeThreshold - from instana_client.models.synthetic_type_configuration import SyntheticTypeConfiguration as SyntheticTypeConfiguration - from instana_client.models.synthetic_type_configuration_update import SyntheticTypeConfigurationUpdate as SyntheticTypeConfigurationUpdate - from instana_client.models.synthetics_event_result import SyntheticsEventResult as SyntheticsEventResult - from instana_client.models.system_rule import SystemRule as SystemRule - from instana_client.models.system_rule_label import SystemRuleLabel as SystemRuleLabel - from instana_client.models.tag import Tag as Tag - from instana_client.models.tag_catalog import TagCatalog as TagCatalog - from instana_client.models.tag_filter import TagFilter as TagFilter - from instana_client.models.tag_filter_expression import TagFilterExpression as TagFilterExpression - from instana_client.models.tag_filter_expression_element import TagFilterExpressionElement as TagFilterExpressionElement - from instana_client.models.tag_matcher_dto import TagMatcherDTO as TagMatcherDTO - from instana_client.models.tag_tree_level import TagTreeLevel as TagTreeLevel - from instana_client.models.tag_tree_node import TagTreeNode as TagTreeNode - from instana_client.models.tag_tree_tag import TagTreeTag as TagTreeTag - from instana_client.models.test_common_properties import TestCommonProperties as TestCommonProperties - from instana_client.models.test_connection_response import TestConnectionResponse as TestConnectionResponse - from instana_client.models.test_last_error import TestLastError as TestLastError - from instana_client.models.test_result import TestResult as TestResult - from instana_client.models.test_result_common_properties import TestResultCommonProperties as TestResultCommonProperties - from instana_client.models.test_result_detail_data import TestResultDetailData as TestResultDetailData - from instana_client.models.test_result_item import TestResultItem as TestResultItem - from instana_client.models.test_result_list_item import TestResultListItem as TestResultListItem - from instana_client.models.test_result_list_result import TestResultListResult as TestResultListResult - from instana_client.models.test_result_metadata import TestResultMetadata as TestResultMetadata - from instana_client.models.test_result_subtransaction import TestResultSubtransaction as TestResultSubtransaction - from instana_client.models.threshold import Threshold as Threshold - from instana_client.models.threshold_config_rule import ThresholdConfigRule as ThresholdConfigRule - from instana_client.models.threshold_rule import ThresholdRule as ThresholdRule - from instana_client.models.throughput_application_alert_rule import ThroughputApplicationAlertRule as ThroughputApplicationAlertRule - from instana_client.models.throughput_mobile_app_alert_rule import ThroughputMobileAppAlertRule as ThroughputMobileAppAlertRule - from instana_client.models.throughput_website_alert_rule import ThroughputWebsiteAlertRule as ThroughputWebsiteAlertRule - from instana_client.models.time_frame import TimeFrame as TimeFrame - from instana_client.models.time_window import TimeWindow as TimeWindow - from instana_client.models.topology import Topology as Topology - from instana_client.models.trace import Trace as Trace - from instana_client.models.trace_activity_tree_node_details import TraceActivityTreeNodeDetails as TraceActivityTreeNodeDetails - from instana_client.models.trace_download_result import TraceDownloadResult as TraceDownloadResult - from instana_client.models.trace_groups_item import TraceGroupsItem as TraceGroupsItem - from instana_client.models.trace_groups_result import TraceGroupsResult as TraceGroupsResult - from instana_client.models.trace_impact_application_time_threshold import TraceImpactApplicationTimeThreshold as TraceImpactApplicationTimeThreshold - from instana_client.models.trace_item import TraceItem as TraceItem - from instana_client.models.trace_result import TraceResult as TraceResult - from instana_client.models.traffic_blueprint_indicator import TrafficBlueprintIndicator as TrafficBlueprintIndicator - from instana_client.models.trigger import Trigger as Trigger - from instana_client.models.type_configuration import TypeConfiguration as TypeConfiguration - from instana_client.models.unsupported_http_path_segment_matching_rule import UnsupportedHttpPathSegmentMatchingRule as UnsupportedHttpPathSegmentMatchingRule - from instana_client.models.updated_business_perspective_config import UpdatedBusinessPerspectiveConfig as UpdatedBusinessPerspectiveConfig - from instana_client.models.usage_result import UsageResult as UsageResult - from instana_client.models.usage_result_items import UsageResultItems as UsageResultItems - from instana_client.models.user_basic_result import UserBasicResult as UserBasicResult - from instana_client.models.user_impact_mobile_app_time_threshold import UserImpactMobileAppTimeThreshold as UserImpactMobileAppTimeThreshold - from instana_client.models.user_impact_website_time_threshold import UserImpactWebsiteTimeThreshold as UserImpactWebsiteTimeThreshold - from instana_client.models.user_result import UserResult as UserResult - from instana_client.models.users_result import UsersResult as UsersResult - from instana_client.models.validated_alerting_channel_input_info import ValidatedAlertingChannelInputInfo as ValidatedAlertingChannelInputInfo - from instana_client.models.validated_alerting_configuration import ValidatedAlertingConfiguration as ValidatedAlertingConfiguration - from instana_client.models.validated_maintenance_config_v2_with_state_and_occurrence import ValidatedMaintenanceConfigV2WithStateAndOccurrence as ValidatedMaintenanceConfigV2WithStateAndOccurrence - from instana_client.models.validated_maintenance_config_with_status import ValidatedMaintenanceConfigWithStatus as ValidatedMaintenanceConfigWithStatus - from instana_client.models.victor_ops_integration import VictorOpsIntegration as VictorOpsIntegration - from instana_client.models.violations_in_period_application_time_threshold import ViolationsInPeriodApplicationTimeThreshold as ViolationsInPeriodApplicationTimeThreshold - from instana_client.models.violations_in_period_mobile_app_time_threshold import ViolationsInPeriodMobileAppTimeThreshold as ViolationsInPeriodMobileAppTimeThreshold - from instana_client.models.violations_in_period_website_time_threshold import ViolationsInPeriodWebsiteTimeThreshold as ViolationsInPeriodWebsiteTimeThreshold - from instana_client.models.violations_in_sequence_application_time_threshold import ViolationsInSequenceApplicationTimeThreshold as ViolationsInSequenceApplicationTimeThreshold - from instana_client.models.violations_in_sequence_infra_time_threshold import ViolationsInSequenceInfraTimeThreshold as ViolationsInSequenceInfraTimeThreshold - from instana_client.models.violations_in_sequence_log_time_threshold import ViolationsInSequenceLogTimeThreshold as ViolationsInSequenceLogTimeThreshold - from instana_client.models.violations_in_sequence_mobile_app_time_threshold import ViolationsInSequenceMobileAppTimeThreshold as ViolationsInSequenceMobileAppTimeThreshold - from instana_client.models.violations_in_sequence_synthetic_time_threshold import ViolationsInSequenceSyntheticTimeThreshold as ViolationsInSequenceSyntheticTimeThreshold - from instana_client.models.violations_in_sequence_website_time_threshold import ViolationsInSequenceWebsiteTimeThreshold as ViolationsInSequenceWebsiteTimeThreshold - from instana_client.models.watson_ai_ops_webhook_integration import WatsonAIOpsWebhookIntegration as WatsonAIOpsWebhookIntegration - from instana_client.models.webex_teams_webhook_integration import WebexTeamsWebhookIntegration as WebexTeamsWebhookIntegration - from instana_client.models.webhook_integration import WebhookIntegration as WebhookIntegration - from instana_client.models.webpage_action_configuration import WebpageActionConfiguration as WebpageActionConfiguration - from instana_client.models.webpage_action_configuration_update import WebpageActionConfigurationUpdate as WebpageActionConfigurationUpdate - from instana_client.models.webpage_script_configuration import WebpageScriptConfiguration as WebpageScriptConfiguration - from instana_client.models.webpage_script_configuration_update import WebpageScriptConfigurationUpdate as WebpageScriptConfigurationUpdate - from instana_client.models.website import Website as Website - from instana_client.models.website_alert_config import WebsiteAlertConfig as WebsiteAlertConfig - from instana_client.models.website_alert_config_with_metadata import WebsiteAlertConfigWithMetadata as WebsiteAlertConfigWithMetadata - from instana_client.models.website_alert_config_with_rbac_tag import WebsiteAlertConfigWithRBACTag as WebsiteAlertConfigWithRBACTag - from instana_client.models.website_alert_rule import WebsiteAlertRule as WebsiteAlertRule - from instana_client.models.website_apdex_entity import WebsiteApdexEntity as WebsiteApdexEntity - from instana_client.models.website_beacon_groups_item import WebsiteBeaconGroupsItem as WebsiteBeaconGroupsItem - from instana_client.models.website_beacon_groups_result import WebsiteBeaconGroupsResult as WebsiteBeaconGroupsResult - from instana_client.models.website_beacon_result import WebsiteBeaconResult as WebsiteBeaconResult - from instana_client.models.website_beacon_tag_group import WebsiteBeaconTagGroup as WebsiteBeaconTagGroup - from instana_client.models.website_beacons_item import WebsiteBeaconsItem as WebsiteBeaconsItem - from instana_client.models.website_event_based_sli_entity import WebsiteEventBasedSliEntity as WebsiteEventBasedSliEntity - from instana_client.models.website_event_result import WebsiteEventResult as WebsiteEventResult - from instana_client.models.website_metric_result import WebsiteMetricResult as WebsiteMetricResult - from instana_client.models.website_monitoring_beacon import WebsiteMonitoringBeacon as WebsiteMonitoringBeacon - from instana_client.models.website_monitoring_metric_description import WebsiteMonitoringMetricDescription as WebsiteMonitoringMetricDescription - from instana_client.models.website_monitoring_metrics_configuration import WebsiteMonitoringMetricsConfiguration as WebsiteMonitoringMetricsConfiguration - from instana_client.models.website_slo_entity import WebsiteSloEntity as WebsiteSloEntity - from instana_client.models.website_time_based_sli_entity import WebsiteTimeBasedSliEntity as WebsiteTimeBasedSliEntity - from instana_client.models.website_time_threshold import WebsiteTimeThreshold as WebsiteTimeThreshold - from instana_client.models.widget import Widget as Widget - from instana_client.models.with_meta_data import WithMetaData as WithMetaData - from instana_client.models.with_resolved_name import WithResolvedName as WithResolvedName - from instana_client.models.z_chat_ops_integration import ZChatOpsIntegration as ZChatOpsIntegration - -else: - from lazy_imports import LazyModule, as_package, load - - load( - LazyModule( - *as_package(__file__), - ("__version__", __version__), - ("__all__", __all__), - """# import apis into sdk package -from instana_client.api.ai_management_api import AIManagementApi as AIManagementApi -from instana_client.api.api_token_api import APITokenApi as APITokenApi -from instana_client.api.action_catalog_api import ActionCatalogApi as ActionCatalogApi -from instana_client.api.action_history_api import ActionHistoryApi as ActionHistoryApi -from instana_client.api.apdex_report_api import ApdexReportApi as ApdexReportApi -from instana_client.api.apdex_settings_api import ApdexSettingsApi as ApdexSettingsApi -from instana_client.api.application_alert_configuration_api import ApplicationAlertConfigurationApi as ApplicationAlertConfigurationApi -from instana_client.api.application_analyze_api import ApplicationAnalyzeApi as ApplicationAnalyzeApi -from instana_client.api.application_catalog_api import ApplicationCatalogApi as ApplicationCatalogApi -from instana_client.api.application_metrics_api import ApplicationMetricsApi as ApplicationMetricsApi -from instana_client.api.application_resources_api import ApplicationResourcesApi as ApplicationResourcesApi -from instana_client.api.application_settings_api import ApplicationSettingsApi as ApplicationSettingsApi -from instana_client.api.application_topology_api import ApplicationTopologyApi as ApplicationTopologyApi -from instana_client.api.audit_log_api import AuditLogApi as AuditLogApi -from instana_client.api.authentication_api import AuthenticationApi as AuthenticationApi -from instana_client.api.business_monitoring_api import BusinessMonitoringApi as BusinessMonitoringApi -from instana_client.api.custom_dashboards_api import CustomDashboardsApi as CustomDashboardsApi -from instana_client.api.custom_entities_api import CustomEntitiesApi as CustomEntitiesApi -from instana_client.api.end_user_monitoring_api import EndUserMonitoringApi as EndUserMonitoringApi -from instana_client.api.event_settings_api import EventSettingsApi as EventSettingsApi -from instana_client.api.events_api import EventsApi as EventsApi -from instana_client.api.global_application_alert_configuration_api import GlobalApplicationAlertConfigurationApi as GlobalApplicationAlertConfigurationApi -from instana_client.api.groups_api import GroupsApi as GroupsApi -from instana_client.api.health_api import HealthApi as HealthApi -from instana_client.api.host_agent_api import HostAgentApi as HostAgentApi -from instana_client.api.infrastructure_alert_configuration_api import InfrastructureAlertConfigurationApi as InfrastructureAlertConfigurationApi -from instana_client.api.infrastructure_analyze_api import InfrastructureAnalyzeApi as InfrastructureAnalyzeApi -from instana_client.api.infrastructure_catalog_api import InfrastructureCatalogApi as InfrastructureCatalogApi -from instana_client.api.infrastructure_metrics_api import InfrastructureMetricsApi as InfrastructureMetricsApi -from instana_client.api.infrastructure_resources_api import InfrastructureResourcesApi as InfrastructureResourcesApi -from instana_client.api.infrastructure_topology_api import InfrastructureTopologyApi as InfrastructureTopologyApi -from instana_client.api.llm_price_configuration_api import LLMPriceConfigurationApi as LLMPriceConfigurationApi -from instana_client.api.log_alert_configuration_api import LogAlertConfigurationApi as LogAlertConfigurationApi -from instana_client.api.logging_analyze_api import LoggingAnalyzeApi as LoggingAnalyzeApi -from instana_client.api.maintenance_configuration_api import MaintenanceConfigurationApi as MaintenanceConfigurationApi -from instana_client.api.mobile_app_analyze_api import MobileAppAnalyzeApi as MobileAppAnalyzeApi -from instana_client.api.mobile_app_catalog_api import MobileAppCatalogApi as MobileAppCatalogApi -from instana_client.api.mobile_app_configuration_api import MobileAppConfigurationApi as MobileAppConfigurationApi -from instana_client.api.mobile_app_metrics_api import MobileAppMetricsApi as MobileAppMetricsApi -from instana_client.api.policies_api import PoliciesApi as PoliciesApi -from instana_client.api.releases_api import ReleasesApi as ReleasesApi -from instana_client.api.roles_api import RolesApi as RolesApi -from instana_client.api.sli_report_api import SLIReportApi as SLIReportApi -from instana_client.api.sli_settings_api import SLISettingsApi as SLISettingsApi -from instana_client.api.slo_configurations_api import SLOConfigurationsApi as SLOConfigurationsApi -from instana_client.api.slo_correction_configurations_api import SLOCorrectionConfigurationsApi as SLOCorrectionConfigurationsApi -from instana_client.api.slo_correction_windows_api import SLOCorrectionWindowsApi as SLOCorrectionWindowsApi -from instana_client.api.service_levels_alert_configuration_api import ServiceLevelsAlertConfigurationApi as ServiceLevelsAlertConfigurationApi -from instana_client.api.service_levels_objective_slo_report_api import ServiceLevelsObjectiveSLOReportApi as ServiceLevelsObjectiveSLOReportApi -from instana_client.api.session_settings_api import SessionSettingsApi as SessionSettingsApi -from instana_client.api.synthetic_alert_configuration_api import SyntheticAlertConfigurationApi as SyntheticAlertConfigurationApi -from instana_client.api.synthetic_calls_api import SyntheticCallsApi as SyntheticCallsApi -from instana_client.api.synthetic_catalog_api import SyntheticCatalogApi as SyntheticCatalogApi -from instana_client.api.synthetic_metrics_api import SyntheticMetricsApi as SyntheticMetricsApi -from instana_client.api.synthetic_settings_api import SyntheticSettingsApi as SyntheticSettingsApi -from instana_client.api.synthetic_test_playback_results_api import SyntheticTestPlaybackResultsApi as SyntheticTestPlaybackResultsApi -from instana_client.api.teams_api import TeamsApi as TeamsApi -from instana_client.api.usage_api import UsageApi as UsageApi -from instana_client.api.user_api import UserApi as UserApi -from instana_client.api.website_analyze_api import WebsiteAnalyzeApi as WebsiteAnalyzeApi -from instana_client.api.website_catalog_api import WebsiteCatalogApi as WebsiteCatalogApi -from instana_client.api.website_configuration_api import WebsiteConfigurationApi as WebsiteConfigurationApi -from instana_client.api.website_metrics_api import WebsiteMetricsApi as WebsiteMetricsApi -from instana_client.api.default_api import DefaultApi as DefaultApi +# import apis into sdk package +from instana_client.api.ai_management_api import AIManagementApi +from instana_client.api.api_token_api import APITokenApi +from instana_client.api.action_catalog_api import ActionCatalogApi +from instana_client.api.action_history_api import ActionHistoryApi +from instana_client.api.apdex_report_api import ApdexReportApi +from instana_client.api.apdex_settings_api import ApdexSettingsApi +from instana_client.api.application_alert_configuration_api import ApplicationAlertConfigurationApi +from instana_client.api.application_analyze_api import ApplicationAnalyzeApi +from instana_client.api.application_catalog_api import ApplicationCatalogApi +from instana_client.api.application_metrics_api import ApplicationMetricsApi +from instana_client.api.application_resources_api import ApplicationResourcesApi +from instana_client.api.application_settings_api import ApplicationSettingsApi +from instana_client.api.application_topology_api import ApplicationTopologyApi +from instana_client.api.audit_log_api import AuditLogApi +from instana_client.api.authentication_api import AuthenticationApi +from instana_client.api.business_monitoring_api import BusinessMonitoringApi +from instana_client.api.custom_dashboards_api import CustomDashboardsApi +from instana_client.api.custom_entities_api import CustomEntitiesApi +from instana_client.api.end_user_monitoring_api import EndUserMonitoringApi +from instana_client.api.event_settings_api import EventSettingsApi +from instana_client.api.events_api import EventsApi +from instana_client.api.global_application_alert_configuration_api import GlobalApplicationAlertConfigurationApi +from instana_client.api.groups_api import GroupsApi +from instana_client.api.health_api import HealthApi +from instana_client.api.host_agent_api import HostAgentApi +from instana_client.api.ip_filtering_api import IPFilteringApi +from instana_client.api.infrastructure_alert_configuration_api import InfrastructureAlertConfigurationApi +from instana_client.api.infrastructure_analyze_api import InfrastructureAnalyzeApi +from instana_client.api.infrastructure_catalog_api import InfrastructureCatalogApi +from instana_client.api.infrastructure_metrics_api import InfrastructureMetricsApi +from instana_client.api.infrastructure_resources_api import InfrastructureResourcesApi +from instana_client.api.infrastructure_topology_api import InfrastructureTopologyApi +from instana_client.api.llm_price_configuration_api import LLMPriceConfigurationApi +from instana_client.api.log_alert_configuration_api import LogAlertConfigurationApi +from instana_client.api.logging_analyze_api import LoggingAnalyzeApi +from instana_client.api.maintenance_configuration_api import MaintenanceConfigurationApi +from instana_client.api.mobile_app_analyze_api import MobileAppAnalyzeApi +from instana_client.api.mobile_app_catalog_api import MobileAppCatalogApi +from instana_client.api.mobile_app_configuration_api import MobileAppConfigurationApi +from instana_client.api.mobile_app_metrics_api import MobileAppMetricsApi +from instana_client.api.policies_api import PoliciesApi +from instana_client.api.releases_api import ReleasesApi +from instana_client.api.roles_api import RolesApi +from instana_client.api.sli_report_api import SLIReportApi +from instana_client.api.sli_settings_api import SLISettingsApi +from instana_client.api.slo_configurations_api import SLOConfigurationsApi +from instana_client.api.slo_correction_configurations_api import SLOCorrectionConfigurationsApi +from instana_client.api.slo_correction_windows_api import SLOCorrectionWindowsApi +from instana_client.api.service_levels_alert_configuration_api import ServiceLevelsAlertConfigurationApi +from instana_client.api.service_levels_objective_slo_report_api import ServiceLevelsObjectiveSLOReportApi +from instana_client.api.session_settings_api import SessionSettingsApi +from instana_client.api.synthetic_alert_configuration_api import SyntheticAlertConfigurationApi +from instana_client.api.synthetic_calls_api import SyntheticCallsApi +from instana_client.api.synthetic_catalog_api import SyntheticCatalogApi +from instana_client.api.synthetic_metrics_api import SyntheticMetricsApi +from instana_client.api.synthetic_settings_api import SyntheticSettingsApi +from instana_client.api.synthetic_test_playback_results_api import SyntheticTestPlaybackResultsApi +from instana_client.api.teams_api import TeamsApi +from instana_client.api.usage_api import UsageApi +from instana_client.api.user_api import UserApi +from instana_client.api.website_analyze_api import WebsiteAnalyzeApi +from instana_client.api.website_catalog_api import WebsiteCatalogApi +from instana_client.api.website_configuration_api import WebsiteConfigurationApi +from instana_client.api.website_metrics_api import WebsiteMetricsApi +from instana_client.api.default_api import DefaultApi # import ApiClient -from instana_client.api_response import ApiResponse as ApiResponse -from instana_client.api_client import ApiClient as ApiClient -from instana_client.configuration import Configuration as Configuration -from instana_client.exceptions import OpenApiException as OpenApiException -from instana_client.exceptions import ApiTypeError as ApiTypeError -from instana_client.exceptions import ApiValueError as ApiValueError -from instana_client.exceptions import ApiKeyError as ApiKeyError -from instana_client.exceptions import ApiAttributeError as ApiAttributeError -from instana_client.exceptions import ApiException as ApiException +from instana_client.api_response import ApiResponse +from instana_client.api_client import ApiClient +from instana_client.configuration import Configuration +from instana_client.exceptions import OpenApiException +from instana_client.exceptions import ApiTypeError +from instana_client.exceptions import ApiValueError +from instana_client.exceptions import ApiKeyError +from instana_client.exceptions import ApiAttributeError +from instana_client.exceptions import ApiException # import models into sdk package -from instana_client.models.abstract_integration import AbstractIntegration as AbstractIntegration -from instana_client.models.abstract_rule import AbstractRule as AbstractRule -from instana_client.models.access_log_entry import AccessLogEntry as AccessLogEntry -from instana_client.models.access_log_response import AccessLogResponse as AccessLogResponse -from instana_client.models.access_rule import AccessRule as AccessRule -from instana_client.models.action import Action as Action -from instana_client.models.action_beacon import ActionBeacon as ActionBeacon -from instana_client.models.action_configuration import ActionConfiguration as ActionConfiguration -from instana_client.models.action_instance import ActionInstance as ActionInstance -from instana_client.models.action_instance_metadata_entry import ActionInstanceMetadataEntry as ActionInstanceMetadataEntry -from instana_client.models.action_instance_parameter import ActionInstanceParameter as ActionInstanceParameter -from instana_client.models.action_instance_request import ActionInstanceRequest as ActionInstanceRequest -from instana_client.models.action_instance_request_parameters import ActionInstanceRequestParameters as ActionInstanceRequestParameters -from instana_client.models.action_match import ActionMatch as ActionMatch -from instana_client.models.action_search_space import ActionSearchSpace as ActionSearchSpace -from instana_client.models.adaptive_baseline import AdaptiveBaseline as AdaptiveBaseline -from instana_client.models.adaptive_threshold_rule import AdaptiveThresholdRule as AdaptiveThresholdRule -from instana_client.models.addition import Addition as Addition -from instana_client.models.adjusted_timeframe import AdjustedTimeframe as AdjustedTimeframe -from instana_client.models.agent_configuration_update import AgentConfigurationUpdate as AgentConfigurationUpdate -from instana_client.models.alerting_configuration import AlertingConfiguration as AlertingConfiguration -from instana_client.models.alerting_configuration_with_last_updated import AlertingConfigurationWithLastUpdated as AlertingConfigurationWithLastUpdated -from instana_client.models.alerting_time_window import AlertingTimeWindow as AlertingTimeWindow -from instana_client.models.apdex_configuration import ApdexConfiguration as ApdexConfiguration -from instana_client.models.apdex_configuration_input import ApdexConfigurationInput as ApdexConfigurationInput -from instana_client.models.apdex_entity import ApdexEntity as ApdexEntity -from instana_client.models.apdex_level import ApdexLevel as ApdexLevel -from instana_client.models.apdex_report import ApdexReport as ApdexReport -from instana_client.models.api_create_group import ApiCreateGroup as ApiCreateGroup -from instana_client.models.api_create_role import ApiCreateRole as ApiCreateRole -from instana_client.models.api_group import ApiGroup as ApiGroup -from instana_client.models.api_member import ApiMember as ApiMember -from instana_client.models.api_permission_set import ApiPermissionSet as ApiPermissionSet -from instana_client.models.api_restricted_application_filter import ApiRestrictedApplicationFilter as ApiRestrictedApplicationFilter -from instana_client.models.api_role import ApiRole as ApiRole -from instana_client.models.api_tag import ApiTag as ApiTag -from instana_client.models.api_team import ApiTeam as ApiTeam -from instana_client.models.api_team_info import ApiTeamInfo as ApiTeamInfo -from instana_client.models.api_team_member import ApiTeamMember as ApiTeamMember -from instana_client.models.api_team_role import ApiTeamRole as ApiTeamRole -from instana_client.models.api_team_scope import ApiTeamScope as ApiTeamScope -from instana_client.models.api_token import ApiToken as ApiToken -from instana_client.models.app_data_metric_configuration import AppDataMetricConfiguration as AppDataMetricConfiguration -from instana_client.models.application import Application as Application -from instana_client.models.application_alert_config import ApplicationAlertConfig as ApplicationAlertConfig -from instana_client.models.application_alert_config_with_metadata import ApplicationAlertConfigWithMetadata as ApplicationAlertConfigWithMetadata -from instana_client.models.application_alert_rule import ApplicationAlertRule as ApplicationAlertRule -from instana_client.models.application_apdex_entity import ApplicationApdexEntity as ApplicationApdexEntity -from instana_client.models.application_config import ApplicationConfig as ApplicationConfig -from instana_client.models.application_event_result import ApplicationEventResult as ApplicationEventResult -from instana_client.models.application_item import ApplicationItem as ApplicationItem -from instana_client.models.application_metric_result import ApplicationMetricResult as ApplicationMetricResult -from instana_client.models.application_node import ApplicationNode as ApplicationNode -from instana_client.models.application_result import ApplicationResult as ApplicationResult -from instana_client.models.application_scope import ApplicationScope as ApplicationScope -from instana_client.models.application_scope_with_metadata import ApplicationScopeWithMetadata as ApplicationScopeWithMetadata -from instana_client.models.application_sli_entity import ApplicationSliEntity as ApplicationSliEntity -from instana_client.models.application_slo_entity import ApplicationSloEntity as ApplicationSloEntity -from instana_client.models.application_time_threshold import ApplicationTimeThreshold as ApplicationTimeThreshold -from instana_client.models.arithmetic_configuration import ArithmeticConfiguration as ArithmeticConfiguration -from instana_client.models.arithmetic_operand import ArithmeticOperand as ArithmeticOperand -from instana_client.models.arithmetic_operation import ArithmeticOperation as ArithmeticOperation -from instana_client.models.audit_log_entry import AuditLogEntry as AuditLogEntry -from instana_client.models.audit_log_ui_response import AuditLogUiResponse as AuditLogUiResponse -from instana_client.models.author import Author as Author -from instana_client.models.availability_blueprint_indicator import AvailabilityBlueprintIndicator as AvailabilityBlueprintIndicator -from instana_client.models.availability_sli_entity import AvailabilitySliEntity as AvailabilitySliEntity -from instana_client.models.available_metrics import AvailableMetrics as AvailableMetrics -from instana_client.models.available_plugins import AvailablePlugins as AvailablePlugins -from instana_client.models.backend_trace_reference import BackendTraceReference as BackendTraceReference -from instana_client.models.bidirectional_ms_teams_app_integration import BidirectionalMsTeamsAppIntegration as BidirectionalMsTeamsAppIntegration -from instana_client.models.bidirectional_slack_app_integration import BidirectionalSlackAppIntegration as BidirectionalSlackAppIntegration -from instana_client.models.binary_operator_dto import BinaryOperatorDTO as BinaryOperatorDTO -from instana_client.models.browser_script_configuration import BrowserScriptConfiguration as BrowserScriptConfiguration -from instana_client.models.browser_script_configuration_update import BrowserScriptConfigurationUpdate as BrowserScriptConfigurationUpdate -from instana_client.models.built_in_event_specification import BuiltInEventSpecification as BuiltInEventSpecification -from instana_client.models.built_in_event_specification_with_last_updated import BuiltInEventSpecificationWithLastUpdated as BuiltInEventSpecificationWithLastUpdated -from instana_client.models.business_activity import BusinessActivity as BusinessActivity -from instana_client.models.business_perspective_config import BusinessPerspectiveConfig as BusinessPerspectiveConfig -from instana_client.models.call_groups_item import CallGroupsItem as CallGroupsItem -from instana_client.models.call_groups_result import CallGroupsResult as CallGroupsResult -from instana_client.models.call_relation import CallRelation as CallRelation -from instana_client.models.change_summary import ChangeSummary as ChangeSummary -from instana_client.models.cloudfoundry_physical_context import CloudfoundryPhysicalContext as CloudfoundryPhysicalContext -from instana_client.models.condition import Condition as Condition -from instana_client.models.config_version import ConfigVersion as ConfigVersion -from instana_client.models.correction import Correction as Correction -from instana_client.models.correction_configuration import CorrectionConfiguration as CorrectionConfiguration -from instana_client.models.correction_scheduling import CorrectionScheduling as CorrectionScheduling -from instana_client.models.correction_window import CorrectionWindow as CorrectionWindow -from instana_client.models.crash_mobile_app_alert_rule import CrashMobileAppAlertRule as CrashMobileAppAlertRule -from instana_client.models.create_website_request_inner import CreateWebsiteRequestInner as CreateWebsiteRequestInner -from instana_client.models.cursor_paginated_business_activity_item import CursorPaginatedBusinessActivityItem as CursorPaginatedBusinessActivityItem -from instana_client.models.cursor_pagination import CursorPagination as CursorPagination -from instana_client.models.cursor_pagination_with_ui_cursor_infra_explore_cursor import CursorPaginationWithUiCursorInfraExploreCursor as CursorPaginationWithUiCursorInfraExploreCursor -from instana_client.models.custom_blueprint_indicator import CustomBlueprintIndicator as CustomBlueprintIndicator -from instana_client.models.custom_dashboard import CustomDashboard as CustomDashboard -from instana_client.models.custom_dashboard_preview import CustomDashboardPreview as CustomDashboardPreview -from instana_client.models.custom_dashboard_with_user_specific_information import CustomDashboardWithUserSpecificInformation as CustomDashboardWithUserSpecificInformation -from instana_client.models.custom_dependency import CustomDependency as CustomDependency -from instana_client.models.custom_email_subject_prefix import CustomEmailSubjectPrefix as CustomEmailSubjectPrefix -from instana_client.models.custom_entity_model import CustomEntityModel as CustomEntityModel -from instana_client.models.custom_entity_with_metadata import CustomEntityWithMetadata as CustomEntityWithMetadata -from instana_client.models.custom_event_mobile_app_alert_rule import CustomEventMobileAppAlertRule as CustomEventMobileAppAlertRule -from instana_client.models.custom_event_specification import CustomEventSpecification as CustomEventSpecification -from instana_client.models.custom_event_specification_with_last_updated import CustomEventSpecificationWithLastUpdated as CustomEventSpecificationWithLastUpdated -from instana_client.models.custom_event_website_alert_rule import CustomEventWebsiteAlertRule as CustomEventWebsiteAlertRule -from instana_client.models.custom_metric import CustomMetric as CustomMetric -from instana_client.models.custom_payload_configuration import CustomPayloadConfiguration as CustomPayloadConfiguration -from instana_client.models.custom_payload_field import CustomPayloadField as CustomPayloadField -from instana_client.models.custom_payload_with_last_updated import CustomPayloadWithLastUpdated as CustomPayloadWithLastUpdated -from instana_client.models.custom_payload_with_version import CustomPayloadWithVersion as CustomPayloadWithVersion -from instana_client.models.custom_tag import CustomTag as CustomTag -from instana_client.models.dns_configuration import DNSConfiguration as DNSConfiguration -from instana_client.models.dns_configuration_update import DNSConfigurationUpdate as DNSConfigurationUpdate -from instana_client.models.dns_filter_query_time import DNSFilterQueryTime as DNSFilterQueryTime -from instana_client.models.dns_filter_target_value import DNSFilterTargetValue as DNSFilterTargetValue -from instana_client.models.dashboard_api_token import DashboardApiToken as DashboardApiToken -from instana_client.models.database_integration import DatabaseIntegration as DatabaseIntegration -from instana_client.models.deprecated_tag_filter import DeprecatedTagFilter as DeprecatedTagFilter -from instana_client.models.division import Division as Division -from instana_client.models.duration import Duration as Duration -from instana_client.models.dynamic_field import DynamicField as DynamicField -from instana_client.models.dynamic_field_value import DynamicFieldValue as DynamicFieldValue -from instana_client.models.dynamic_parameter import DynamicParameter as DynamicParameter -from instana_client.models.dynamic_tag import DynamicTag as DynamicTag -from instana_client.models.edit_user import EditUser as EditUser -from instana_client.models.email_integration import EmailIntegration as EmailIntegration -from instana_client.models.empty_configuration import EmptyConfiguration as EmptyConfiguration -from instana_client.models.endpoint import Endpoint as Endpoint -from instana_client.models.endpoint_config import EndpointConfig as EndpointConfig -from instana_client.models.endpoint_event_result import EndpointEventResult as EndpointEventResult -from instana_client.models.endpoint_item import EndpointItem as EndpointItem -from instana_client.models.endpoint_metric_result import EndpointMetricResult as EndpointMetricResult -from instana_client.models.endpoint_node import EndpointNode as EndpointNode -from instana_client.models.endpoint_result import EndpointResult as EndpointResult -from instana_client.models.endpoint_simple import EndpointSimple as EndpointSimple -from instana_client.models.entity_count_rule import EntityCountRule as EntityCountRule -from instana_client.models.entity_count_verification_rule import EntityCountVerificationRule as EntityCountVerificationRule -from instana_client.models.entity_health_info import EntityHealthInfo as EntityHealthInfo -from instana_client.models.entity_id import EntityId as EntityId -from instana_client.models.entity_verification_rule import EntityVerificationRule as EntityVerificationRule -from instana_client.models.error_budget_alert_rule import ErrorBudgetAlertRule as ErrorBudgetAlertRule -from instana_client.models.errors_application_alert_rule import ErrorsApplicationAlertRule as ErrorsApplicationAlertRule -from instana_client.models.event import Event as Event -from instana_client.models.event_filtering_configuration import EventFilteringConfiguration as EventFilteringConfiguration -from instana_client.models.event_result import EventResult as EventResult -from instana_client.models.event_specification_info import EventSpecificationInfo as EventSpecificationInfo -from instana_client.models.extended_service import ExtendedService as ExtendedService -from instana_client.models.failure_synthetic_alert_rule import FailureSyntheticAlertRule as FailureSyntheticAlertRule -from instana_client.models.fixed_http_path_segment_matching_rule import FixedHttpPathSegmentMatchingRule as FixedHttpPathSegmentMatchingRule -from instana_client.models.fixed_time_window import FixedTimeWindow as FixedTimeWindow -from instana_client.models.generic_infra_alert_rule import GenericInfraAlertRule as GenericInfraAlertRule -from instana_client.models.geo_location_configuration import GeoLocationConfiguration as GeoLocationConfiguration -from instana_client.models.geo_mapping_rule import GeoMappingRule as GeoMappingRule -from instana_client.models.geo_subdivision import GeoSubdivision as GeoSubdivision -from instana_client.models.get_action_beacons_result import GetActionBeaconsResult as GetActionBeaconsResult -from instana_client.models.get_activities import GetActivities as GetActivities -from instana_client.models.get_application_metrics import GetApplicationMetrics as GetApplicationMetrics -from instana_client.models.get_applications import GetApplications as GetApplications -from instana_client.models.get_available_metrics_query import GetAvailableMetricsQuery as GetAvailableMetricsQuery -from instana_client.models.get_available_plugins_query import GetAvailablePluginsQuery as GetAvailablePluginsQuery -from instana_client.models.get_call_groups import GetCallGroups as GetCallGroups -from instana_client.models.get_combined_metrics import GetCombinedMetrics as GetCombinedMetrics -from instana_client.models.get_dynamic_parameter_values import GetDynamicParameterValues as GetDynamicParameterValues -from instana_client.models.get_endpoints import GetEndpoints as GetEndpoints -from instana_client.models.get_infrastructure_groups_query import GetInfrastructureGroupsQuery as GetInfrastructureGroupsQuery -from instana_client.models.get_infrastructure_query import GetInfrastructureQuery as GetInfrastructureQuery -from instana_client.models.get_metrics_result import GetMetricsResult as GetMetricsResult -from instana_client.models.get_mobile_app_beacon_groups import GetMobileAppBeaconGroups as GetMobileAppBeaconGroups -from instana_client.models.get_mobile_app_beacons import GetMobileAppBeacons as GetMobileAppBeacons -from instana_client.models.get_mobile_app_metrics import GetMobileAppMetrics as GetMobileAppMetrics -from instana_client.models.get_mobile_app_metrics_v2 import GetMobileAppMetricsV2 as GetMobileAppMetricsV2 -from instana_client.models.get_payload_keys_result import GetPayloadKeysResult as GetPayloadKeysResult -from instana_client.models.get_services import GetServices as GetServices -from instana_client.models.get_session_replay_metadata_result import GetSessionReplayMetadataResult as GetSessionReplayMetadataResult -from instana_client.models.get_snapshots_query import GetSnapshotsQuery as GetSnapshotsQuery -from instana_client.models.get_test_result import GetTestResult as GetTestResult -from instana_client.models.get_test_result_analytic import GetTestResultAnalytic as GetTestResultAnalytic -from instana_client.models.get_test_result_base import GetTestResultBase as GetTestResultBase -from instana_client.models.get_test_result_list import GetTestResultList as GetTestResultList -from instana_client.models.get_test_summary_result import GetTestSummaryResult as GetTestSummaryResult -from instana_client.models.get_trace_download_result_item import GetTraceDownloadResultItem as GetTraceDownloadResultItem -from instana_client.models.get_trace_groups import GetTraceGroups as GetTraceGroups -from instana_client.models.get_traces import GetTraces as GetTraces -from instana_client.models.get_website_beacon_groups import GetWebsiteBeaconGroups as GetWebsiteBeaconGroups -from instana_client.models.get_website_beacons import GetWebsiteBeacons as GetWebsiteBeacons -from instana_client.models.get_website_metrics import GetWebsiteMetrics as GetWebsiteMetrics -from instana_client.models.get_website_metrics_v2 import GetWebsiteMetricsV2 as GetWebsiteMetricsV2 -from instana_client.models.global_application_alert_config_with_metadata import GlobalApplicationAlertConfigWithMetadata as GlobalApplicationAlertConfigWithMetadata -from instana_client.models.global_applications_alert_config import GlobalApplicationsAlertConfig as GlobalApplicationsAlertConfig -from instana_client.models.google_chat_integration import GoogleChatIntegration as GoogleChatIntegration -from instana_client.models.graph_edge import GraphEdge as GraphEdge -from instana_client.models.graph_node import GraphNode as GraphNode -from instana_client.models.group import Group as Group -from instana_client.models.group_by_tag import GroupByTag as GroupByTag -from instana_client.models.group_mapping import GroupMapping as GroupMapping -from instana_client.models.group_mapping_overview import GroupMappingOverview as GroupMappingOverview -from instana_client.models.health_state import HealthState as HealthState -from instana_client.models.historic_baseline import HistoricBaseline as HistoricBaseline -from instana_client.models.host_availability_rule import HostAvailabilityRule as HostAvailabilityRule -from instana_client.models.http_action_configuration import HttpActionConfiguration as HttpActionConfiguration -from instana_client.models.http_action_configuration_update import HttpActionConfigurationUpdate as HttpActionConfigurationUpdate -from instana_client.models.http_endpoint_config import HttpEndpointConfig as HttpEndpointConfig -from instana_client.models.http_endpoint_rule import HttpEndpointRule as HttpEndpointRule -from instana_client.models.http_path_segment_matching_rule import HttpPathSegmentMatchingRule as HttpPathSegmentMatchingRule -from instana_client.models.http_script_configuration import HttpScriptConfiguration as HttpScriptConfiguration -from instana_client.models.http_script_configuration_update import HttpScriptConfigurationUpdate as HttpScriptConfigurationUpdate -from instana_client.models.hyper_param import HyperParam as HyperParam -from instana_client.models.identity_provider_patch import IdentityProviderPatch as IdentityProviderPatch -from instana_client.models.idp_status_update import IdpStatusUpdate as IdpStatusUpdate -from instana_client.models.impacted_beacon_info import ImpactedBeaconInfo as ImpactedBeaconInfo -from instana_client.models.infra_alert_config import InfraAlertConfig as InfraAlertConfig -from instana_client.models.infra_alert_config_with_metadata import InfraAlertConfigWithMetadata as InfraAlertConfigWithMetadata -from instana_client.models.infra_alert_rule import InfraAlertRule as InfraAlertRule -from instana_client.models.infra_event_result import InfraEventResult as InfraEventResult -from instana_client.models.infra_metric_configuration import InfraMetricConfiguration as InfraMetricConfiguration -from instana_client.models.infra_slo_entity import InfraSloEntity as InfraSloEntity -from instana_client.models.infra_time_threshold import InfraTimeThreshold as InfraTimeThreshold -from instana_client.models.infrastructure_entities_result import InfrastructureEntitiesResult as InfrastructureEntitiesResult -from instana_client.models.infrastructure_group import InfrastructureGroup as InfrastructureGroup -from instana_client.models.infrastructure_groups_result import InfrastructureGroupsResult as InfrastructureGroupsResult -from instana_client.models.infrastructure_item import InfrastructureItem as InfrastructureItem -from instana_client.models.infrastructure_metric_result import InfrastructureMetricResult as InfrastructureMetricResult -from instana_client.models.instana_version_info import InstanaVersionInfo as InstanaVersionInfo -from instana_client.models.integration_overview import IntegrationOverview as IntegrationOverview -from instana_client.models.invitation import Invitation as Invitation -from instana_client.models.invitation_response import InvitationResponse as InvitationResponse -from instana_client.models.invitation_result import InvitationResult as InvitationResult -from instana_client.models.ip_masking_configuration import IpMaskingConfiguration as IpMaskingConfiguration -from instana_client.models.js_stack_trace_line import JsStackTraceLine as JsStackTraceLine -from instana_client.models.kubernetes_physical_context import KubernetesPhysicalContext as KubernetesPhysicalContext -from instana_client.models.llm_egress_gateway import LLMEgressGateway as LLMEgressGateway -from instana_client.models.llm_gateway_capability import LLMGatewayCapability as LLMGatewayCapability -from instana_client.models.llm_gateway_model import LLMGatewayModel as LLMGatewayModel -from instana_client.models.llm_gateway_service import LLMGatewayService as LLMGatewayService -from instana_client.models.llm_gateway_test_connection_request import LLMGatewayTestConnectionRequest as LLMGatewayTestConnectionRequest -from instana_client.models.latency_blueprint_indicator import LatencyBlueprintIndicator as LatencyBlueprintIndicator -from instana_client.models.llm_model_price import LlmModelPrice as LlmModelPrice -from instana_client.models.llm_model_price_metadata import LlmModelPriceMetadata as LlmModelPriceMetadata -from instana_client.models.location_status import LocationStatus as LocationStatus -from instana_client.models.log_alert_config import LogAlertConfig as LogAlertConfig -from instana_client.models.log_alert_config_with_metadata import LogAlertConfigWithMetadata as LogAlertConfigWithMetadata -from instana_client.models.log_alert_rule import LogAlertRule as LogAlertRule -from instana_client.models.log_count_alert_rule import LogCountAlertRule as LogCountAlertRule -from instana_client.models.log_entry_actor import LogEntryActor as LogEntryActor -from instana_client.models.log_event_result import LogEventResult as LogEventResult -from instana_client.models.log_time_threshold import LogTimeThreshold as LogTimeThreshold -from instana_client.models.log_volume_group import LogVolumeGroup as LogVolumeGroup -from instana_client.models.log_volume_usage_item import LogVolumeUsageItem as LogVolumeUsageItem -from instana_client.models.log_volume_usage_result import LogVolumeUsageResult as LogVolumeUsageResult -from instana_client.models.logs_application_alert_rule import LogsApplicationAlertRule as LogsApplicationAlertRule -from instana_client.models.maintenance_config import MaintenanceConfig as MaintenanceConfig -from instana_client.models.maintenance_config_scheduling import MaintenanceConfigScheduling as MaintenanceConfigScheduling -from instana_client.models.maintenance_config_v2 import MaintenanceConfigV2 as MaintenanceConfigV2 -from instana_client.models.maintenance_config_v2_with_state_and_occurrence import MaintenanceConfigV2WithStateAndOccurrence as MaintenanceConfigV2WithStateAndOccurrence -from instana_client.models.maintenance_config_with_last_updated import MaintenanceConfigWithLastUpdated as MaintenanceConfigWithLastUpdated -from instana_client.models.maintenance_window import MaintenanceWindow as MaintenanceWindow -from instana_client.models.manual_alerting_channel_configuration import ManualAlertingChannelConfiguration as ManualAlertingChannelConfiguration -from instana_client.models.manual_close_info import ManualCloseInfo as ManualCloseInfo -from instana_client.models.manual_service_config import ManualServiceConfig as ManualServiceConfig -from instana_client.models.match_all_http_path_segment_matching_rule import MatchAllHttpPathSegmentMatchingRule as MatchAllHttpPathSegmentMatchingRule -from instana_client.models.match_expression_dto import MatchExpressionDTO as MatchExpressionDTO -from instana_client.models.meta_data import MetaData as MetaData -from instana_client.models.metric_api_result import MetricAPIResult as MetricAPIResult -from instana_client.models.metric_config import MetricConfig as MetricConfig -from instana_client.models.metric_configuration import MetricConfiguration as MetricConfiguration -from instana_client.models.metric_description import MetricDescription as MetricDescription -from instana_client.models.metric_instance import MetricInstance as MetricInstance -from instana_client.models.metric_item import MetricItem as MetricItem -from instana_client.models.metric_metadata import MetricMetadata as MetricMetadata -from instana_client.models.metric_pattern import MetricPattern as MetricPattern -from instana_client.models.metric_query import MetricQuery as MetricQuery -from instana_client.models.metrics_result import MetricsResult as MetricsResult -from instana_client.models.metrics_result_item import MetricsResultItem as MetricsResultItem -from instana_client.models.metrics_test_result_item import MetricsTestResultItem as MetricsTestResultItem -from instana_client.models.mobile_app import MobileApp as MobileApp -from instana_client.models.mobile_app_alert_config import MobileAppAlertConfig as MobileAppAlertConfig -from instana_client.models.mobile_app_alert_config_with_rbac_tag import MobileAppAlertConfigWithRBACTag as MobileAppAlertConfigWithRBACTag -from instana_client.models.mobile_app_alert_rule import MobileAppAlertRule as MobileAppAlertRule -from instana_client.models.mobile_app_beacon_groups_item import MobileAppBeaconGroupsItem as MobileAppBeaconGroupsItem -from instana_client.models.mobile_app_beacon_groups_result import MobileAppBeaconGroupsResult as MobileAppBeaconGroupsResult -from instana_client.models.mobile_app_beacon_result import MobileAppBeaconResult as MobileAppBeaconResult -from instana_client.models.mobile_app_beacon_tag_group import MobileAppBeaconTagGroup as MobileAppBeaconTagGroup -from instana_client.models.mobile_app_beacons_item import MobileAppBeaconsItem as MobileAppBeaconsItem -from instana_client.models.mobile_app_event_result import MobileAppEventResult as MobileAppEventResult -from instana_client.models.mobile_app_metric_result import MobileAppMetricResult as MobileAppMetricResult -from instana_client.models.mobile_app_monitoring_beacon import MobileAppMonitoringBeacon as MobileAppMonitoringBeacon -from instana_client.models.mobile_app_monitoring_metric_description import MobileAppMonitoringMetricDescription as MobileAppMonitoringMetricDescription -from instana_client.models.mobile_app_monitoring_metrics_configuration import MobileAppMonitoringMetricsConfiguration as MobileAppMonitoringMetricsConfiguration -from instana_client.models.mobile_app_time_threshold import MobileAppTimeThreshold as MobileAppTimeThreshold -from instana_client.models.model_field import ModelField as ModelField -from instana_client.models.monitored_entities_stats import MonitoredEntitiesStats as MonitoredEntitiesStats -from instana_client.models.monitoring_state import MonitoringState as MonitoringState -from instana_client.models.multiple_scripts_configuration import MultipleScriptsConfiguration as MultipleScriptsConfiguration -from instana_client.models.multiplication import Multiplication as Multiplication -from instana_client.models.ns1_integration import NS1Integration as NS1Integration -from instana_client.models.nested_operation import NestedOperation as NestedOperation -from instana_client.models.new_application_config import NewApplicationConfig as NewApplicationConfig -from instana_client.models.new_business_perspective_config import NewBusinessPerspectiveConfig as NewBusinessPerspectiveConfig -from instana_client.models.new_manual_service_config import NewManualServiceConfig as NewManualServiceConfig -from instana_client.models.o_auth_config import OAuthConfig as OAuthConfig -from instana_client.models.o_auth_integration import OAuthIntegration as OAuthIntegration -from instana_client.models.o_auth_token import OAuthToken as OAuthToken -from instana_client.models.occurrence import Occurrence as Occurrence -from instana_client.models.office365_integration import Office365Integration as Office365Integration -from instana_client.models.one_time_maintenance_window import OneTimeMaintenanceWindow as OneTimeMaintenanceWindow -from instana_client.models.opsgenie_integration import OpsgenieIntegration as OpsgenieIntegration -from instana_client.models.order import Order as Order -from instana_client.models.pagerduty_integration import PagerdutyIntegration as PagerdutyIntegration -from instana_client.models.paginated_result import PaginatedResult as PaginatedResult -from instana_client.models.pagination import Pagination as Pagination -from instana_client.models.parameter import Parameter as Parameter -from instana_client.models.parameter_value import ParameterValue as ParameterValue -from instana_client.models.path_parameter_http_path_segment_matching_rule import PathParameterHttpPathSegmentMatchingRule as PathParameterHttpPathSegmentMatchingRule -from instana_client.models.physical_context import PhysicalContext as PhysicalContext -from instana_client.models.plugin_result import PluginResult as PluginResult -from instana_client.models.policy import Policy as Policy -from instana_client.models.policy_runnable import PolicyRunnable as PolicyRunnable -from instana_client.models.policy_scheduling import PolicyScheduling as PolicyScheduling -from instana_client.models.post_mobile_app_source_map_config_request import PostMobileAppSourceMapConfigRequest as PostMobileAppSourceMapConfigRequest -from instana_client.models.post_snapshots_result import PostSnapshotsResult as PostSnapshotsResult -from instana_client.models.prefix_object import PrefixObject as PrefixObject -from instana_client.models.problem import Problem as Problem -from instana_client.models.prometheus_webhook_integration import PrometheusWebhookIntegration as PrometheusWebhookIntegration -from instana_client.models.recurrent_maintenance_window import RecurrentMaintenanceWindow as RecurrentMaintenanceWindow -from instana_client.models.release import Release as Release -from instana_client.models.release_scope import ReleaseScope as ReleaseScope -from instana_client.models.release_with_metadata import ReleaseWithMetadata as ReleaseWithMetadata -from instana_client.models.retention_period import RetentionPeriod as RetentionPeriod -from instana_client.models.rolling_time_window import RollingTimeWindow as RollingTimeWindow -from instana_client.models.rule_input import RuleInput as RuleInput -from instana_client.models.rule_with_threshold_application_alert_rule import RuleWithThresholdApplicationAlertRule as RuleWithThresholdApplicationAlertRule -from instana_client.models.rule_with_threshold_infra_alert_rule import RuleWithThresholdInfraAlertRule as RuleWithThresholdInfraAlertRule -from instana_client.models.rule_with_threshold_log_alert_rule import RuleWithThresholdLogAlertRule as RuleWithThresholdLogAlertRule -from instana_client.models.rule_with_threshold_mobile_app_alert_rule import RuleWithThresholdMobileAppAlertRule as RuleWithThresholdMobileAppAlertRule -from instana_client.models.rule_with_threshold_website_alert_rule import RuleWithThresholdWebsiteAlertRule as RuleWithThresholdWebsiteAlertRule -from instana_client.models.run_configuration import RunConfiguration as RunConfiguration -from instana_client.models.slo_config_with_rbac_tag import SLOConfigWithRBACTag as SLOConfigWithRBACTag -from instana_client.models.ssl_certificate_configuration import SSLCertificateConfiguration as SSLCertificateConfiguration -from instana_client.models.ssl_certificate_configuration_update import SSLCertificateConfigurationUpdate as SSLCertificateConfigurationUpdate -from instana_client.models.ssl_certificate_validation import SSLCertificateValidation as SSLCertificateValidation -from instana_client.models.salesforce_integration import SalesforceIntegration as SalesforceIntegration -from instana_client.models.saturation_blueprint_indicator import SaturationBlueprintIndicator as SaturationBlueprintIndicator -from instana_client.models.scope_binding import ScopeBinding as ScopeBinding -from instana_client.models.search_field_result import SearchFieldResult as SearchFieldResult -from instana_client.models.service import Service as Service -from instana_client.models.service_config import ServiceConfig as ServiceConfig -from instana_client.models.service_event_result import ServiceEventResult as ServiceEventResult -from instana_client.models.service_item import ServiceItem as ServiceItem -from instana_client.models.service_level_indicator import ServiceLevelIndicator as ServiceLevelIndicator -from instana_client.models.service_level_objective_alert_rule import ServiceLevelObjectiveAlertRule as ServiceLevelObjectiveAlertRule -from instana_client.models.service_levels_alert_config import ServiceLevelsAlertConfig as ServiceLevelsAlertConfig -from instana_client.models.service_levels_alert_config_with_rbac_tag import ServiceLevelsAlertConfigWithRBACTag as ServiceLevelsAlertConfigWithRBACTag -from instana_client.models.service_levels_alert_rule import ServiceLevelsAlertRule as ServiceLevelsAlertRule -from instana_client.models.service_levels_burn_rate_config import ServiceLevelsBurnRateConfig as ServiceLevelsBurnRateConfig -from instana_client.models.service_levels_burn_rate_time_windows import ServiceLevelsBurnRateTimeWindows as ServiceLevelsBurnRateTimeWindows -from instana_client.models.service_levels_static_threshold_config import ServiceLevelsStaticThresholdConfig as ServiceLevelsStaticThresholdConfig -from instana_client.models.service_levels_time_threshold import ServiceLevelsTimeThreshold as ServiceLevelsTimeThreshold -from instana_client.models.service_levelse_alert_config_with_metadata import ServiceLevelseAlertConfigWithMetadata as ServiceLevelseAlertConfigWithMetadata -from instana_client.models.service_map import ServiceMap as ServiceMap -from instana_client.models.service_map_connection import ServiceMapConnection as ServiceMapConnection -from instana_client.models.service_matching_rule import ServiceMatchingRule as ServiceMatchingRule -from instana_client.models.service_metric_result import ServiceMetricResult as ServiceMetricResult -from instana_client.models.service_node import ServiceNode as ServiceNode -from instana_client.models.service_now_enhanced_integration import ServiceNowEnhancedIntegration as ServiceNowEnhancedIntegration -from instana_client.models.service_now_integration import ServiceNowIntegration as ServiceNowIntegration -from instana_client.models.service_result import ServiceResult as ServiceResult -from instana_client.models.service_scope import ServiceScope as ServiceScope -from instana_client.models.service_scope_with_metadata import ServiceScopeWithMetadata as ServiceScopeWithMetadata -from instana_client.models.service_scoped_to import ServiceScopedTo as ServiceScopedTo -from instana_client.models.service_scoped_to_with_metadata import ServiceScopedToWithMetadata as ServiceScopedToWithMetadata -from instana_client.models.service_simple import ServiceSimple as ServiceSimple -from instana_client.models.session_replay_metadata import SessionReplayMetadata as SessionReplayMetadata -from instana_client.models.session_replay_timestamps import SessionReplayTimestamps as SessionReplayTimestamps -from instana_client.models.session_settings import SessionSettings as SessionSettings -from instana_client.models.simple_metric_configuration import SimpleMetricConfiguration as SimpleMetricConfiguration -from instana_client.models.single_value import SingleValue as SingleValue -from instana_client.models.slack_integration import SlackIntegration as SlackIntegration -from instana_client.models.sli_configuration import SliConfiguration as SliConfiguration -from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated as SliConfigurationWithLastUpdated -from instana_client.models.sli_entity import SliEntity as SliEntity -from instana_client.models.sli_report import SliReport as SliReport -from instana_client.models.slo_entity import SloEntity as SloEntity -from instana_client.models.slo_report import SloReport as SloReport -from instana_client.models.slowness_application_alert_rule import SlownessApplicationAlertRule as SlownessApplicationAlertRule -from instana_client.models.slowness_mobile_app_alert_rule import SlownessMobileAppAlertRule as SlownessMobileAppAlertRule -from instana_client.models.slowness_website_alert_rule import SlownessWebsiteAlertRule as SlownessWebsiteAlertRule -from instana_client.models.snapshot_item import SnapshotItem as SnapshotItem -from instana_client.models.snapshot_preview import SnapshotPreview as SnapshotPreview -from instana_client.models.snapshot_result import SnapshotResult as SnapshotResult -from instana_client.models.software_user import SoftwareUser as SoftwareUser -from instana_client.models.software_version import SoftwareVersion as SoftwareVersion -from instana_client.models.source_map_file_blob import SourceMapFileBlob as SourceMapFileBlob -from instana_client.models.source_map_file_meta import SourceMapFileMeta as SourceMapFileMeta -from instana_client.models.source_map_upload_config import SourceMapUploadConfig as SourceMapUploadConfig -from instana_client.models.source_map_upload_configs import SourceMapUploadConfigs as SourceMapUploadConfigs -from instana_client.models.span_excerpt import SpanExcerpt as SpanExcerpt -from instana_client.models.span_relation import SpanRelation as SpanRelation -from instana_client.models.specific_js_errors_website_alert_rule import SpecificJsErrorsWebsiteAlertRule as SpecificJsErrorsWebsiteAlertRule -from instana_client.models.splunk_integration import SplunkIntegration as SplunkIntegration -from instana_client.models.stack_trace_item import StackTraceItem as StackTraceItem -from instana_client.models.stack_trace_line import StackTraceLine as StackTraceLine -from instana_client.models.static_baseline_threshold_rule import StaticBaselineThresholdRule as StaticBaselineThresholdRule -from instana_client.models.static_string_field import StaticStringField as StaticStringField -from instana_client.models.static_threshold import StaticThreshold as StaticThreshold -from instana_client.models.static_threshold_rule import StaticThresholdRule as StaticThresholdRule -from instana_client.models.status_code_application_alert_rule import StatusCodeApplicationAlertRule as StatusCodeApplicationAlertRule -from instana_client.models.status_code_mobile_app_alert_rule import StatusCodeMobileAppAlertRule as StatusCodeMobileAppAlertRule -from instana_client.models.status_code_website_alert_rule import StatusCodeWebsiteAlertRule as StatusCodeWebsiteAlertRule -from instana_client.models.subtraction import Subtraction as Subtraction -from instana_client.models.synthetic_alert_config import SyntheticAlertConfig as SyntheticAlertConfig -from instana_client.models.synthetic_alert_config_with_metadata import SyntheticAlertConfigWithMetadata as SyntheticAlertConfigWithMetadata -from instana_client.models.synthetic_alert_config_with_rbac_tag import SyntheticAlertConfigWithRBACTag as SyntheticAlertConfigWithRBACTag -from instana_client.models.synthetic_alert_rule import SyntheticAlertRule as SyntheticAlertRule -from instana_client.models.synthetic_bulk_response import SyntheticBulkResponse as SyntheticBulkResponse -from instana_client.models.synthetic_call_config import SyntheticCallConfig as SyntheticCallConfig -from instana_client.models.synthetic_call_rule import SyntheticCallRule as SyntheticCallRule -from instana_client.models.synthetic_call_with_defaults_config import SyntheticCallWithDefaultsConfig as SyntheticCallWithDefaultsConfig -from instana_client.models.synthetic_configuration import SyntheticConfiguration as SyntheticConfiguration -from instana_client.models.synthetic_configuration_update import SyntheticConfigurationUpdate as SyntheticConfigurationUpdate -from instana_client.models.synthetic_credential import SyntheticCredential as SyntheticCredential -from instana_client.models.synthetic_datacenter import SyntheticDatacenter as SyntheticDatacenter -from instana_client.models.synthetic_datacenter_configuration import SyntheticDatacenterConfiguration as SyntheticDatacenterConfiguration -from instana_client.models.synthetic_geo_point import SyntheticGeoPoint as SyntheticGeoPoint -from instana_client.models.synthetic_location import SyntheticLocation as SyntheticLocation -from instana_client.models.synthetic_location_configuration import SyntheticLocationConfiguration as SyntheticLocationConfiguration -from instana_client.models.synthetic_metric_configuration import SyntheticMetricConfiguration as SyntheticMetricConfiguration -from instana_client.models.synthetic_metric_tag_group import SyntheticMetricTagGroup as SyntheticMetricTagGroup -from instana_client.models.synthetic_playback_capabilities import SyntheticPlaybackCapabilities as SyntheticPlaybackCapabilities -from instana_client.models.synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value import SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue as SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue -from instana_client.models.synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation import SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation as SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation -from instana_client.models.synthetic_resource_update_list_string_list_string import SyntheticResourceUpdateListStringListString as SyntheticResourceUpdateListStringListString -from instana_client.models.synthetic_resource_update_map_string_string_list_string import SyntheticResourceUpdateMapStringStringListString as SyntheticResourceUpdateMapStringStringListString -from instana_client.models.synthetic_slo_entity import SyntheticSloEntity as SyntheticSloEntity -from instana_client.models.synthetic_test import SyntheticTest as SyntheticTest -from instana_client.models.synthetic_test_cicd import SyntheticTestCICD as SyntheticTestCICD -from instana_client.models.synthetic_test_cicd_customization import SyntheticTestCICDCustomization as SyntheticTestCICDCustomization -from instana_client.models.synthetic_test_cicd_item import SyntheticTestCICDItem as SyntheticTestCICDItem -from instana_client.models.synthetic_test_cicd_response import SyntheticTestCICDResponse as SyntheticTestCICDResponse -from instana_client.models.synthetic_test_deep_update import SyntheticTestDeepUpdate as SyntheticTestDeepUpdate -from instana_client.models.synthetic_test_shallow_update import SyntheticTestShallowUpdate as SyntheticTestShallowUpdate -from instana_client.models.synthetic_test_update import SyntheticTestUpdate as SyntheticTestUpdate -from instana_client.models.synthetic_time_threshold import SyntheticTimeThreshold as SyntheticTimeThreshold -from instana_client.models.synthetic_type_configuration import SyntheticTypeConfiguration as SyntheticTypeConfiguration -from instana_client.models.synthetic_type_configuration_update import SyntheticTypeConfigurationUpdate as SyntheticTypeConfigurationUpdate -from instana_client.models.synthetics_event_result import SyntheticsEventResult as SyntheticsEventResult -from instana_client.models.system_rule import SystemRule as SystemRule -from instana_client.models.system_rule_label import SystemRuleLabel as SystemRuleLabel -from instana_client.models.tag import Tag as Tag -from instana_client.models.tag_catalog import TagCatalog as TagCatalog -from instana_client.models.tag_filter import TagFilter as TagFilter -from instana_client.models.tag_filter_expression import TagFilterExpression as TagFilterExpression -from instana_client.models.tag_filter_expression_element import TagFilterExpressionElement as TagFilterExpressionElement -from instana_client.models.tag_matcher_dto import TagMatcherDTO as TagMatcherDTO -from instana_client.models.tag_tree_level import TagTreeLevel as TagTreeLevel -from instana_client.models.tag_tree_node import TagTreeNode as TagTreeNode -from instana_client.models.tag_tree_tag import TagTreeTag as TagTreeTag -from instana_client.models.test_common_properties import TestCommonProperties as TestCommonProperties -from instana_client.models.test_connection_response import TestConnectionResponse as TestConnectionResponse -from instana_client.models.test_last_error import TestLastError as TestLastError -from instana_client.models.test_result import TestResult as TestResult -from instana_client.models.test_result_common_properties import TestResultCommonProperties as TestResultCommonProperties -from instana_client.models.test_result_detail_data import TestResultDetailData as TestResultDetailData -from instana_client.models.test_result_item import TestResultItem as TestResultItem -from instana_client.models.test_result_list_item import TestResultListItem as TestResultListItem -from instana_client.models.test_result_list_result import TestResultListResult as TestResultListResult -from instana_client.models.test_result_metadata import TestResultMetadata as TestResultMetadata -from instana_client.models.test_result_subtransaction import TestResultSubtransaction as TestResultSubtransaction -from instana_client.models.threshold import Threshold as Threshold -from instana_client.models.threshold_config_rule import ThresholdConfigRule as ThresholdConfigRule -from instana_client.models.threshold_rule import ThresholdRule as ThresholdRule -from instana_client.models.throughput_application_alert_rule import ThroughputApplicationAlertRule as ThroughputApplicationAlertRule -from instana_client.models.throughput_mobile_app_alert_rule import ThroughputMobileAppAlertRule as ThroughputMobileAppAlertRule -from instana_client.models.throughput_website_alert_rule import ThroughputWebsiteAlertRule as ThroughputWebsiteAlertRule -from instana_client.models.time_frame import TimeFrame as TimeFrame -from instana_client.models.time_window import TimeWindow as TimeWindow -from instana_client.models.topology import Topology as Topology -from instana_client.models.trace import Trace as Trace -from instana_client.models.trace_activity_tree_node_details import TraceActivityTreeNodeDetails as TraceActivityTreeNodeDetails -from instana_client.models.trace_download_result import TraceDownloadResult as TraceDownloadResult -from instana_client.models.trace_groups_item import TraceGroupsItem as TraceGroupsItem -from instana_client.models.trace_groups_result import TraceGroupsResult as TraceGroupsResult -from instana_client.models.trace_impact_application_time_threshold import TraceImpactApplicationTimeThreshold as TraceImpactApplicationTimeThreshold -from instana_client.models.trace_item import TraceItem as TraceItem -from instana_client.models.trace_result import TraceResult as TraceResult -from instana_client.models.traffic_blueprint_indicator import TrafficBlueprintIndicator as TrafficBlueprintIndicator -from instana_client.models.trigger import Trigger as Trigger -from instana_client.models.type_configuration import TypeConfiguration as TypeConfiguration -from instana_client.models.unsupported_http_path_segment_matching_rule import UnsupportedHttpPathSegmentMatchingRule as UnsupportedHttpPathSegmentMatchingRule -from instana_client.models.updated_business_perspective_config import UpdatedBusinessPerspectiveConfig as UpdatedBusinessPerspectiveConfig -from instana_client.models.usage_result import UsageResult as UsageResult -from instana_client.models.usage_result_items import UsageResultItems as UsageResultItems -from instana_client.models.user_basic_result import UserBasicResult as UserBasicResult -from instana_client.models.user_impact_mobile_app_time_threshold import UserImpactMobileAppTimeThreshold as UserImpactMobileAppTimeThreshold -from instana_client.models.user_impact_website_time_threshold import UserImpactWebsiteTimeThreshold as UserImpactWebsiteTimeThreshold -from instana_client.models.user_result import UserResult as UserResult -from instana_client.models.users_result import UsersResult as UsersResult -from instana_client.models.validated_alerting_channel_input_info import ValidatedAlertingChannelInputInfo as ValidatedAlertingChannelInputInfo -from instana_client.models.validated_alerting_configuration import ValidatedAlertingConfiguration as ValidatedAlertingConfiguration -from instana_client.models.validated_maintenance_config_v2_with_state_and_occurrence import ValidatedMaintenanceConfigV2WithStateAndOccurrence as ValidatedMaintenanceConfigV2WithStateAndOccurrence -from instana_client.models.validated_maintenance_config_with_status import ValidatedMaintenanceConfigWithStatus as ValidatedMaintenanceConfigWithStatus -from instana_client.models.victor_ops_integration import VictorOpsIntegration as VictorOpsIntegration -from instana_client.models.violations_in_period_application_time_threshold import ViolationsInPeriodApplicationTimeThreshold as ViolationsInPeriodApplicationTimeThreshold -from instana_client.models.violations_in_period_mobile_app_time_threshold import ViolationsInPeriodMobileAppTimeThreshold as ViolationsInPeriodMobileAppTimeThreshold -from instana_client.models.violations_in_period_website_time_threshold import ViolationsInPeriodWebsiteTimeThreshold as ViolationsInPeriodWebsiteTimeThreshold -from instana_client.models.violations_in_sequence_application_time_threshold import ViolationsInSequenceApplicationTimeThreshold as ViolationsInSequenceApplicationTimeThreshold -from instana_client.models.violations_in_sequence_infra_time_threshold import ViolationsInSequenceInfraTimeThreshold as ViolationsInSequenceInfraTimeThreshold -from instana_client.models.violations_in_sequence_log_time_threshold import ViolationsInSequenceLogTimeThreshold as ViolationsInSequenceLogTimeThreshold -from instana_client.models.violations_in_sequence_mobile_app_time_threshold import ViolationsInSequenceMobileAppTimeThreshold as ViolationsInSequenceMobileAppTimeThreshold -from instana_client.models.violations_in_sequence_synthetic_time_threshold import ViolationsInSequenceSyntheticTimeThreshold as ViolationsInSequenceSyntheticTimeThreshold -from instana_client.models.violations_in_sequence_website_time_threshold import ViolationsInSequenceWebsiteTimeThreshold as ViolationsInSequenceWebsiteTimeThreshold -from instana_client.models.watson_ai_ops_webhook_integration import WatsonAIOpsWebhookIntegration as WatsonAIOpsWebhookIntegration -from instana_client.models.webex_teams_webhook_integration import WebexTeamsWebhookIntegration as WebexTeamsWebhookIntegration -from instana_client.models.webhook_integration import WebhookIntegration as WebhookIntegration -from instana_client.models.webpage_action_configuration import WebpageActionConfiguration as WebpageActionConfiguration -from instana_client.models.webpage_action_configuration_update import WebpageActionConfigurationUpdate as WebpageActionConfigurationUpdate -from instana_client.models.webpage_script_configuration import WebpageScriptConfiguration as WebpageScriptConfiguration -from instana_client.models.webpage_script_configuration_update import WebpageScriptConfigurationUpdate as WebpageScriptConfigurationUpdate -from instana_client.models.website import Website as Website -from instana_client.models.website_alert_config import WebsiteAlertConfig as WebsiteAlertConfig -from instana_client.models.website_alert_config_with_metadata import WebsiteAlertConfigWithMetadata as WebsiteAlertConfigWithMetadata -from instana_client.models.website_alert_config_with_rbac_tag import WebsiteAlertConfigWithRBACTag as WebsiteAlertConfigWithRBACTag -from instana_client.models.website_alert_rule import WebsiteAlertRule as WebsiteAlertRule -from instana_client.models.website_apdex_entity import WebsiteApdexEntity as WebsiteApdexEntity -from instana_client.models.website_beacon_groups_item import WebsiteBeaconGroupsItem as WebsiteBeaconGroupsItem -from instana_client.models.website_beacon_groups_result import WebsiteBeaconGroupsResult as WebsiteBeaconGroupsResult -from instana_client.models.website_beacon_result import WebsiteBeaconResult as WebsiteBeaconResult -from instana_client.models.website_beacon_tag_group import WebsiteBeaconTagGroup as WebsiteBeaconTagGroup -from instana_client.models.website_beacons_item import WebsiteBeaconsItem as WebsiteBeaconsItem -from instana_client.models.website_event_based_sli_entity import WebsiteEventBasedSliEntity as WebsiteEventBasedSliEntity -from instana_client.models.website_event_result import WebsiteEventResult as WebsiteEventResult -from instana_client.models.website_metric_result import WebsiteMetricResult as WebsiteMetricResult -from instana_client.models.website_monitoring_beacon import WebsiteMonitoringBeacon as WebsiteMonitoringBeacon -from instana_client.models.website_monitoring_metric_description import WebsiteMonitoringMetricDescription as WebsiteMonitoringMetricDescription -from instana_client.models.website_monitoring_metrics_configuration import WebsiteMonitoringMetricsConfiguration as WebsiteMonitoringMetricsConfiguration -from instana_client.models.website_slo_entity import WebsiteSloEntity as WebsiteSloEntity -from instana_client.models.website_time_based_sli_entity import WebsiteTimeBasedSliEntity as WebsiteTimeBasedSliEntity -from instana_client.models.website_time_threshold import WebsiteTimeThreshold as WebsiteTimeThreshold -from instana_client.models.widget import Widget as Widget -from instana_client.models.with_meta_data import WithMetaData as WithMetaData -from instana_client.models.with_resolved_name import WithResolvedName as WithResolvedName -from instana_client.models.z_chat_ops_integration import ZChatOpsIntegration as ZChatOpsIntegration - -""", - name=__name__, - doc=__doc__, - ) - ) +from instana_client.models.abstract_integration import AbstractIntegration +from instana_client.models.abstract_rule import AbstractRule +from instana_client.models.access_rule import AccessRule +from instana_client.models.action import Action +from instana_client.models.action_configuration import ActionConfiguration +from instana_client.models.action_instance import ActionInstance +from instana_client.models.action_instance_metadata_entry import ActionInstanceMetadataEntry +from instana_client.models.action_instance_parameter import ActionInstanceParameter +from instana_client.models.action_instance_request import ActionInstanceRequest +from instana_client.models.action_instance_request_parameters import ActionInstanceRequestParameters +from instana_client.models.action_match import ActionMatch +from instana_client.models.action_search_space import ActionSearchSpace +from instana_client.models.adaptive_baseline import AdaptiveBaseline +from instana_client.models.adaptive_threshold_rule import AdaptiveThresholdRule +from instana_client.models.adjusted_timeframe import AdjustedTimeframe +from instana_client.models.agent_configuration_update import AgentConfigurationUpdate +from instana_client.models.agent_mode_update import AgentModeUpdate +from instana_client.models.alerting_configuration import AlertingConfiguration +from instana_client.models.alerting_configuration_with_last_updated import AlertingConfigurationWithLastUpdated +from instana_client.models.alerting_time_window import AlertingTimeWindow +from instana_client.models.apdex_configuration import ApdexConfiguration +from instana_client.models.apdex_configuration_input import ApdexConfigurationInput +from instana_client.models.apdex_entity import ApdexEntity +from instana_client.models.apdex_level import ApdexLevel +from instana_client.models.apdex_report import ApdexReport +from instana_client.models.api_create_group import ApiCreateGroup +from instana_client.models.api_create_role import ApiCreateRole +from instana_client.models.api_group import ApiGroup +from instana_client.models.api_member import ApiMember +from instana_client.models.api_permission_set import ApiPermissionSet +from instana_client.models.api_restricted_application_filter import ApiRestrictedApplicationFilter +from instana_client.models.api_role import ApiRole +from instana_client.models.api_tag import ApiTag +from instana_client.models.api_team import ApiTeam +from instana_client.models.api_team_info import ApiTeamInfo +from instana_client.models.api_team_member import ApiTeamMember +from instana_client.models.api_team_role import ApiTeamRole +from instana_client.models.api_team_scope import ApiTeamScope +from instana_client.models.api_token import ApiToken +from instana_client.models.app_data_metric_configuration import AppDataMetricConfiguration +from instana_client.models.application import Application +from instana_client.models.application_alert_config import ApplicationAlertConfig +from instana_client.models.application_alert_config_with_metadata import ApplicationAlertConfigWithMetadata +from instana_client.models.application_alert_rule import ApplicationAlertRule +from instana_client.models.application_apdex_entity import ApplicationApdexEntity +from instana_client.models.application_config import ApplicationConfig +from instana_client.models.application_event_result import ApplicationEventResult +from instana_client.models.application_item import ApplicationItem +from instana_client.models.application_metric_result import ApplicationMetricResult +from instana_client.models.application_node import ApplicationNode +from instana_client.models.application_result import ApplicationResult +from instana_client.models.application_scope import ApplicationScope +from instana_client.models.application_scope_with_metadata import ApplicationScopeWithMetadata +from instana_client.models.application_sli_entity import ApplicationSliEntity +from instana_client.models.application_slo_entity import ApplicationSloEntity +from instana_client.models.application_time_threshold import ApplicationTimeThreshold +from instana_client.models.audit_log_ui_response import AuditLogUiResponse +from instana_client.models.author import Author +from instana_client.models.availability_blueprint_indicator import AvailabilityBlueprintIndicator +from instana_client.models.availability_sli_entity import AvailabilitySliEntity +from instana_client.models.available_metrics import AvailableMetrics +from instana_client.models.available_plugins import AvailablePlugins +from instana_client.models.backend_trace_reference import BackendTraceReference +from instana_client.models.bidirectional_ms_teams_app_integration import BidirectionalMsTeamsAppIntegration +from instana_client.models.bidirectional_slack_app_integration import BidirectionalSlackAppIntegration +from instana_client.models.binary_operator_dto import BinaryOperatorDTO +from instana_client.models.browser_script_configuration import BrowserScriptConfiguration +from instana_client.models.browser_script_configuration_update import BrowserScriptConfigurationUpdate +from instana_client.models.built_in_event_specification import BuiltInEventSpecification +from instana_client.models.built_in_event_specification_with_last_updated import BuiltInEventSpecificationWithLastUpdated +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest +from instana_client.models.business_activity import BusinessActivity +from instana_client.models.business_perspective_config import BusinessPerspectiveConfig +from instana_client.models.call_groups_item import CallGroupsItem +from instana_client.models.call_groups_result import CallGroupsResult +from instana_client.models.call_relation import CallRelation +from instana_client.models.change_summary import ChangeSummary +from instana_client.models.cloudfoundry_physical_context import CloudfoundryPhysicalContext +from instana_client.models.condition import Condition +from instana_client.models.config_version import ConfigVersion +from instana_client.models.correction import Correction +from instana_client.models.correction_configuration import CorrectionConfiguration +from instana_client.models.correction_scheduling import CorrectionScheduling +from instana_client.models.correction_window import CorrectionWindow +from instana_client.models.crash_mobile_app_alert_rule import CrashMobileAppAlertRule +from instana_client.models.create_website_request_inner import CreateWebsiteRequestInner +from instana_client.models.cursor_paginated_business_activity_item import CursorPaginatedBusinessActivityItem +from instana_client.models.cursor_pagination import CursorPagination +from instana_client.models.cursor_pagination_with_ui_cursor_infra_explore_cursor import CursorPaginationWithUiCursorInfraExploreCursor +from instana_client.models.custom_blueprint_indicator import CustomBlueprintIndicator +from instana_client.models.custom_dashboard import CustomDashboard +from instana_client.models.custom_dashboard_preview import CustomDashboardPreview +from instana_client.models.custom_dashboard_with_user_specific_information import CustomDashboardWithUserSpecificInformation +from instana_client.models.custom_dependency import CustomDependency +from instana_client.models.custom_email_subject_prefix import CustomEmailSubjectPrefix +from instana_client.models.custom_entity_model import CustomEntityModel +from instana_client.models.custom_entity_with_metadata import CustomEntityWithMetadata +from instana_client.models.custom_event_mobile_app_alert_rule import CustomEventMobileAppAlertRule +from instana_client.models.custom_event_specification import CustomEventSpecification +from instana_client.models.custom_event_specification_with_last_updated import CustomEventSpecificationWithLastUpdated +from instana_client.models.custom_event_website_alert_rule import CustomEventWebsiteAlertRule +from instana_client.models.custom_metric import CustomMetric +from instana_client.models.custom_payload_configuration import CustomPayloadConfiguration +from instana_client.models.custom_payload_field import CustomPayloadField +from instana_client.models.custom_payload_with_last_updated import CustomPayloadWithLastUpdated +from instana_client.models.custom_payload_with_version import CustomPayloadWithVersion +from instana_client.models.custom_tag import CustomTag +from instana_client.models.dns_configuration import DNSConfiguration +from instana_client.models.dns_configuration_update import DNSConfigurationUpdate +from instana_client.models.dns_filter_query_time import DNSFilterQueryTime +from instana_client.models.dns_filter_target_value import DNSFilterTargetValue +from instana_client.models.dashboard_api_token import DashboardApiToken +from instana_client.models.database_integration import DatabaseIntegration +from instana_client.models.deprecated_tag_filter import DeprecatedTagFilter +from instana_client.models.duration import Duration +from instana_client.models.dynamic_field import DynamicField +from instana_client.models.dynamic_field_value import DynamicFieldValue +from instana_client.models.dynamic_parameter import DynamicParameter +from instana_client.models.dynamic_tag import DynamicTag +from instana_client.models.edit_user import EditUser +from instana_client.models.email_integration import EmailIntegration +from instana_client.models.empty_configuration import EmptyConfiguration +from instana_client.models.endpoint import Endpoint +from instana_client.models.endpoint_config import EndpointConfig +from instana_client.models.endpoint_event_result import EndpointEventResult +from instana_client.models.endpoint_item import EndpointItem +from instana_client.models.endpoint_metric_result import EndpointMetricResult +from instana_client.models.endpoint_node import EndpointNode +from instana_client.models.endpoint_result import EndpointResult +from instana_client.models.endpoint_simple import EndpointSimple +from instana_client.models.entity_count_rule import EntityCountRule +from instana_client.models.entity_count_verification_rule import EntityCountVerificationRule +from instana_client.models.entity_health_info import EntityHealthInfo +from instana_client.models.entity_id import EntityId +from instana_client.models.entity_verification_rule import EntityVerificationRule +from instana_client.models.error_budget_alert_rule import ErrorBudgetAlertRule +from instana_client.models.errors_application_alert_rule import ErrorsApplicationAlertRule +from instana_client.models.event import Event +from instana_client.models.event_filtering_configuration import EventFilteringConfiguration +from instana_client.models.event_result import EventResult +from instana_client.models.event_specification_info import EventSpecificationInfo +from instana_client.models.extended_service import ExtendedService +from instana_client.models.failure_synthetic_alert_rule import FailureSyntheticAlertRule +from instana_client.models.fixed_http_path_segment_matching_rule import FixedHttpPathSegmentMatchingRule +from instana_client.models.fixed_time_window import FixedTimeWindow +from instana_client.models.generic_infra_alert_rule import GenericInfraAlertRule +from instana_client.models.geo_location_configuration import GeoLocationConfiguration +from instana_client.models.geo_mapping_rule import GeoMappingRule +from instana_client.models.geo_subdivision import GeoSubdivision +from instana_client.models.get_activities import GetActivities +from instana_client.models.get_application_metrics import GetApplicationMetrics +from instana_client.models.get_applications import GetApplications +from instana_client.models.get_available_metrics_query import GetAvailableMetricsQuery +from instana_client.models.get_available_plugins_query import GetAvailablePluginsQuery +from instana_client.models.get_call_groups import GetCallGroups +from instana_client.models.get_combined_metrics import GetCombinedMetrics +from instana_client.models.get_dynamic_parameter_values import GetDynamicParameterValues +from instana_client.models.get_endpoints import GetEndpoints +from instana_client.models.get_infrastructure_groups_query import GetInfrastructureGroupsQuery +from instana_client.models.get_infrastructure_query import GetInfrastructureQuery +from instana_client.models.get_metrics_result import GetMetricsResult +from instana_client.models.get_mobile_app_beacon_groups import GetMobileAppBeaconGroups +from instana_client.models.get_mobile_app_beacons import GetMobileAppBeacons +from instana_client.models.get_mobile_app_metrics import GetMobileAppMetrics +from instana_client.models.get_mobile_app_metrics_v2 import GetMobileAppMetricsV2 +from instana_client.models.get_payload_keys_result import GetPayloadKeysResult +from instana_client.models.get_services import GetServices +from instana_client.models.get_snapshots_query import GetSnapshotsQuery +from instana_client.models.get_test_result import GetTestResult +from instana_client.models.get_test_result_analytic import GetTestResultAnalytic +from instana_client.models.get_test_result_base import GetTestResultBase +from instana_client.models.get_test_result_list import GetTestResultList +from instana_client.models.get_test_summary_result import GetTestSummaryResult +from instana_client.models.get_trace_download_result_item import GetTraceDownloadResultItem +from instana_client.models.get_trace_groups import GetTraceGroups +from instana_client.models.get_traces import GetTraces +from instana_client.models.get_website_beacon_groups import GetWebsiteBeaconGroups +from instana_client.models.get_website_beacons import GetWebsiteBeacons +from instana_client.models.get_website_metrics import GetWebsiteMetrics +from instana_client.models.get_website_metrics_v2 import GetWebsiteMetricsV2 +from instana_client.models.global_application_alert_config_with_metadata import GlobalApplicationAlertConfigWithMetadata +from instana_client.models.global_applications_alert_config import GlobalApplicationsAlertConfig +from instana_client.models.google_chat_integration import GoogleChatIntegration +from instana_client.models.graph_edge import GraphEdge +from instana_client.models.graph_node import GraphNode +from instana_client.models.group import Group +from instana_client.models.group_by_tag import GroupByTag +from instana_client.models.group_mapping import GroupMapping +from instana_client.models.group_mapping_overview import GroupMappingOverview +from instana_client.models.health_state import HealthState +from instana_client.models.historic_baseline import HistoricBaseline +from instana_client.models.host_availability_rule import HostAvailabilityRule +from instana_client.models.http_action_configuration import HttpActionConfiguration +from instana_client.models.http_action_configuration_update import HttpActionConfigurationUpdate +from instana_client.models.http_endpoint_config import HttpEndpointConfig +from instana_client.models.http_endpoint_rule import HttpEndpointRule +from instana_client.models.http_path_segment_matching_rule import HttpPathSegmentMatchingRule +from instana_client.models.http_script_configuration import HttpScriptConfiguration +from instana_client.models.http_script_configuration_update import HttpScriptConfigurationUpdate +from instana_client.models.hyper_param import HyperParam +from instana_client.models.icmp_configuration import ICMPConfiguration +from instana_client.models.icmp_configuration_update import ICMPConfigurationUpdate +from instana_client.models.icmp_validation import ICMPValidation +from instana_client.models.ip_filtering import IPFiltering +from instana_client.models.ip_filtering_rule_dto import IPFilteringRuleDto +from instana_client.models.ip_filtering_upsert import IPFilteringUpsert +from instana_client.models.identity_provider_patch import IdentityProviderPatch +from instana_client.models.idp_status_update import IdpStatusUpdate +from instana_client.models.impacted_beacon_info import ImpactedBeaconInfo +from instana_client.models.infra_alert_config import InfraAlertConfig +from instana_client.models.infra_alert_config_with_metadata import InfraAlertConfigWithMetadata +from instana_client.models.infra_alert_rule import InfraAlertRule +from instana_client.models.infra_event_result import InfraEventResult +from instana_client.models.infra_slo_entity import InfraSloEntity +from instana_client.models.infra_time_threshold import InfraTimeThreshold +from instana_client.models.infrastructure_entities_result import InfrastructureEntitiesResult +from instana_client.models.infrastructure_group import InfrastructureGroup +from instana_client.models.infrastructure_groups_result import InfrastructureGroupsResult +from instana_client.models.infrastructure_item import InfrastructureItem +from instana_client.models.infrastructure_metric_result import InfrastructureMetricResult +from instana_client.models.instana_version_info import InstanaVersionInfo +from instana_client.models.integration_overview import IntegrationOverview +from instana_client.models.invitation import Invitation +from instana_client.models.invitation_response import InvitationResponse +from instana_client.models.invitation_result import InvitationResult +from instana_client.models.ip_masking_configuration import IpMaskingConfiguration +from instana_client.models.js_stack_trace_line import JsStackTraceLine +from instana_client.models.kubernetes_physical_context import KubernetesPhysicalContext +from instana_client.models.llm_egress_gateway import LLMEgressGateway +from instana_client.models.llm_gateway_capability import LLMGatewayCapability +from instana_client.models.llm_gateway_model import LLMGatewayModel +from instana_client.models.llm_gateway_service import LLMGatewayService +from instana_client.models.llm_gateway_test_connection_request import LLMGatewayTestConnectionRequest +from instana_client.models.latency_blueprint_indicator import LatencyBlueprintIndicator +from instana_client.models.llm_model_price import LlmModelPrice +from instana_client.models.llm_model_price_metadata import LlmModelPriceMetadata +from instana_client.models.location_status import LocationStatus +from instana_client.models.log_alert_config import LogAlertConfig +from instana_client.models.log_alert_config_with_metadata import LogAlertConfigWithMetadata +from instana_client.models.log_alert_rule import LogAlertRule +from instana_client.models.log_count_alert_rule import LogCountAlertRule +from instana_client.models.log_event_result import LogEventResult +from instana_client.models.log_time_threshold import LogTimeThreshold +from instana_client.models.log_volume_group import LogVolumeGroup +from instana_client.models.log_volume_usage_item import LogVolumeUsageItem +from instana_client.models.log_volume_usage_result import LogVolumeUsageResult +from instana_client.models.logs_application_alert_rule import LogsApplicationAlertRule +from instana_client.models.maintenance_config import MaintenanceConfig +from instana_client.models.maintenance_config_scheduling import MaintenanceConfigScheduling +from instana_client.models.maintenance_config_v2 import MaintenanceConfigV2 +from instana_client.models.maintenance_config_v2_with_state_and_occurrence import MaintenanceConfigV2WithStateAndOccurrence +from instana_client.models.maintenance_config_with_last_updated import MaintenanceConfigWithLastUpdated +from instana_client.models.maintenance_window import MaintenanceWindow +from instana_client.models.manual_alerting_channel_configuration import ManualAlertingChannelConfiguration +from instana_client.models.manual_close_info import ManualCloseInfo +from instana_client.models.manual_service_config import ManualServiceConfig +from instana_client.models.match_all_http_path_segment_matching_rule import MatchAllHttpPathSegmentMatchingRule +from instana_client.models.match_expression_dto import MatchExpressionDTO +from instana_client.models.meta_data import MetaData +from instana_client.models.metric_api_result import MetricAPIResult +from instana_client.models.metric_config import MetricConfig +from instana_client.models.metric_configuration import MetricConfiguration +from instana_client.models.metric_description import MetricDescription +from instana_client.models.metric_field import MetricField +from instana_client.models.metric_field_value import MetricFieldValue +from instana_client.models.metric_instance import MetricInstance +from instana_client.models.metric_item import MetricItem +from instana_client.models.metric_metadata import MetricMetadata +from instana_client.models.metric_pattern import MetricPattern +from instana_client.models.metrics_result import MetricsResult +from instana_client.models.metrics_result_item import MetricsResultItem +from instana_client.models.metrics_test_result_item import MetricsTestResultItem +from instana_client.models.mobile_app import MobileApp +from instana_client.models.mobile_app_alert_config import MobileAppAlertConfig +from instana_client.models.mobile_app_alert_config_with_rbac_tag import MobileAppAlertConfigWithRBACTag +from instana_client.models.mobile_app_alert_rule import MobileAppAlertRule +from instana_client.models.mobile_app_beacon_groups_item import MobileAppBeaconGroupsItem +from instana_client.models.mobile_app_beacon_groups_result import MobileAppBeaconGroupsResult +from instana_client.models.mobile_app_beacon_result import MobileAppBeaconResult +from instana_client.models.mobile_app_beacon_tag_group import MobileAppBeaconTagGroup +from instana_client.models.mobile_app_beacons_item import MobileAppBeaconsItem +from instana_client.models.mobile_app_event_result import MobileAppEventResult +from instana_client.models.mobile_app_metric_result import MobileAppMetricResult +from instana_client.models.mobile_app_monitoring_beacon import MobileAppMonitoringBeacon +from instana_client.models.mobile_app_monitoring_metric_description import MobileAppMonitoringMetricDescription +from instana_client.models.mobile_app_monitoring_metrics_configuration import MobileAppMonitoringMetricsConfiguration +from instana_client.models.mobile_app_time_threshold import MobileAppTimeThreshold +from instana_client.models.model_field import ModelField +from instana_client.models.monitored_entities_stats import MonitoredEntitiesStats +from instana_client.models.monitoring_state import MonitoringState +from instana_client.models.multiple_scripts_configuration import MultipleScriptsConfiguration +from instana_client.models.ns1_integration import NS1Integration +from instana_client.models.new_application_config import NewApplicationConfig +from instana_client.models.new_business_perspective_config import NewBusinessPerspectiveConfig +from instana_client.models.new_manual_service_config import NewManualServiceConfig +from instana_client.models.o_auth_config import OAuthConfig +from instana_client.models.o_auth_integration import OAuthIntegration +from instana_client.models.o_auth_token import OAuthToken +from instana_client.models.occurrence import Occurrence +from instana_client.models.office365_integration import Office365Integration +from instana_client.models.one_time_maintenance_window import OneTimeMaintenanceWindow +from instana_client.models.opsgenie_integration import OpsgenieIntegration +from instana_client.models.order import Order +from instana_client.models.pagerduty_integration import PagerdutyIntegration +from instana_client.models.paginated_result import PaginatedResult +from instana_client.models.pagination import Pagination +from instana_client.models.parameter import Parameter +from instana_client.models.parameter_value import ParameterValue +from instana_client.models.path_parameter_http_path_segment_matching_rule import PathParameterHttpPathSegmentMatchingRule +from instana_client.models.physical_context import PhysicalContext +from instana_client.models.plugin_result import PluginResult +from instana_client.models.policy import Policy +from instana_client.models.policy_runnable import PolicyRunnable +from instana_client.models.policy_scheduling import PolicyScheduling +from instana_client.models.post_mobile_app_source_map_config_request import PostMobileAppSourceMapConfigRequest +from instana_client.models.post_snapshots_result import PostSnapshotsResult +from instana_client.models.prefix_object import PrefixObject +from instana_client.models.problem import Problem +from instana_client.models.prometheus_webhook_integration import PrometheusWebhookIntegration +from instana_client.models.recurrent_maintenance_window import RecurrentMaintenanceWindow +from instana_client.models.release import Release +from instana_client.models.release_scope import ReleaseScope +from instana_client.models.release_with_metadata import ReleaseWithMetadata +from instana_client.models.retention_period import RetentionPeriod +from instana_client.models.rolling_time_window import RollingTimeWindow +from instana_client.models.rule_input import RuleInput +from instana_client.models.rule_with_threshold_application_alert_rule import RuleWithThresholdApplicationAlertRule +from instana_client.models.rule_with_threshold_infra_alert_rule import RuleWithThresholdInfraAlertRule +from instana_client.models.rule_with_threshold_log_alert_rule import RuleWithThresholdLogAlertRule +from instana_client.models.rule_with_threshold_mobile_app_alert_rule import RuleWithThresholdMobileAppAlertRule +from instana_client.models.rule_with_threshold_website_alert_rule import RuleWithThresholdWebsiteAlertRule +from instana_client.models.run_configuration import RunConfiguration +from instana_client.models.slo_config_with_rbac_tag import SLOConfigWithRBACTag +from instana_client.models.ssl_certificate_configuration import SSLCertificateConfiguration +from instana_client.models.ssl_certificate_configuration_update import SSLCertificateConfigurationUpdate +from instana_client.models.ssl_certificate_validation import SSLCertificateValidation +from instana_client.models.salesforce_integration import SalesforceIntegration +from instana_client.models.saturation_blueprint_indicator import SaturationBlueprintIndicator +from instana_client.models.scope_binding import ScopeBinding +from instana_client.models.search_field_result import SearchFieldResult +from instana_client.models.service import Service +from instana_client.models.service_config import ServiceConfig +from instana_client.models.service_event_result import ServiceEventResult +from instana_client.models.service_item import ServiceItem +from instana_client.models.service_level_indicator import ServiceLevelIndicator +from instana_client.models.service_level_objective_alert_rule import ServiceLevelObjectiveAlertRule +from instana_client.models.service_levels_alert_config import ServiceLevelsAlertConfig +from instana_client.models.service_levels_alert_config_with_rbac_tag import ServiceLevelsAlertConfigWithRBACTag +from instana_client.models.service_levels_alert_rule import ServiceLevelsAlertRule +from instana_client.models.service_levels_burn_rate_config import ServiceLevelsBurnRateConfig +from instana_client.models.service_levels_burn_rate_time_windows import ServiceLevelsBurnRateTimeWindows +from instana_client.models.service_levels_static_threshold_config import ServiceLevelsStaticThresholdConfig +from instana_client.models.service_levels_time_threshold import ServiceLevelsTimeThreshold +from instana_client.models.service_levelse_alert_config_with_metadata import ServiceLevelseAlertConfigWithMetadata +from instana_client.models.service_map import ServiceMap +from instana_client.models.service_map_connection import ServiceMapConnection +from instana_client.models.service_matching_rule import ServiceMatchingRule +from instana_client.models.service_metric_result import ServiceMetricResult +from instana_client.models.service_node import ServiceNode +from instana_client.models.service_now_enhanced_integration import ServiceNowEnhancedIntegration +from instana_client.models.service_now_integration import ServiceNowIntegration +from instana_client.models.service_result import ServiceResult +from instana_client.models.service_scope import ServiceScope +from instana_client.models.service_scope_with_metadata import ServiceScopeWithMetadata +from instana_client.models.service_scoped_to import ServiceScopedTo +from instana_client.models.service_scoped_to_with_metadata import ServiceScopedToWithMetadata +from instana_client.models.service_simple import ServiceSimple +from instana_client.models.session_settings import SessionSettings +from instana_client.models.simple_metric_configuration import SimpleMetricConfiguration +from instana_client.models.slack_integration import SlackIntegration +from instana_client.models.sli_configuration import SliConfiguration +from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated +from instana_client.models.sli_entity import SliEntity +from instana_client.models.sli_report import SliReport +from instana_client.models.slo_entity import SloEntity +from instana_client.models.slo_report import SloReport +from instana_client.models.slowness_application_alert_rule import SlownessApplicationAlertRule +from instana_client.models.slowness_mobile_app_alert_rule import SlownessMobileAppAlertRule +from instana_client.models.slowness_website_alert_rule import SlownessWebsiteAlertRule +from instana_client.models.snapshot_item import SnapshotItem +from instana_client.models.snapshot_preview import SnapshotPreview +from instana_client.models.snapshot_result import SnapshotResult +from instana_client.models.software_user import SoftwareUser +from instana_client.models.software_version import SoftwareVersion +from instana_client.models.source_map_file_blob import SourceMapFileBlob +from instana_client.models.source_map_file_meta import SourceMapFileMeta +from instana_client.models.source_map_upload_config import SourceMapUploadConfig +from instana_client.models.source_map_upload_configs import SourceMapUploadConfigs +from instana_client.models.span_excerpt import SpanExcerpt +from instana_client.models.span_relation import SpanRelation +from instana_client.models.specific_js_errors_website_alert_rule import SpecificJsErrorsWebsiteAlertRule +from instana_client.models.splunk_integration import SplunkIntegration +from instana_client.models.stack_trace_item import StackTraceItem +from instana_client.models.stack_trace_line import StackTraceLine +from instana_client.models.static_baseline_threshold_rule import StaticBaselineThresholdRule +from instana_client.models.static_string_field import StaticStringField +from instana_client.models.static_threshold import StaticThreshold +from instana_client.models.static_threshold_rule import StaticThresholdRule +from instana_client.models.status_code_application_alert_rule import StatusCodeApplicationAlertRule +from instana_client.models.status_code_mobile_app_alert_rule import StatusCodeMobileAppAlertRule +from instana_client.models.status_code_website_alert_rule import StatusCodeWebsiteAlertRule +from instana_client.models.synthetic_alert_config import SyntheticAlertConfig +from instana_client.models.synthetic_alert_config_with_metadata import SyntheticAlertConfigWithMetadata +from instana_client.models.synthetic_alert_config_with_rbac_tag import SyntheticAlertConfigWithRBACTag +from instana_client.models.synthetic_alert_rule import SyntheticAlertRule +from instana_client.models.synthetic_bulk_response import SyntheticBulkResponse +from instana_client.models.synthetic_call_config import SyntheticCallConfig +from instana_client.models.synthetic_call_rule import SyntheticCallRule +from instana_client.models.synthetic_call_with_defaults_config import SyntheticCallWithDefaultsConfig +from instana_client.models.synthetic_configuration import SyntheticConfiguration +from instana_client.models.synthetic_configuration_update import SyntheticConfigurationUpdate +from instana_client.models.synthetic_credential import SyntheticCredential +from instana_client.models.synthetic_datacenter import SyntheticDatacenter +from instana_client.models.synthetic_datacenter_configuration import SyntheticDatacenterConfiguration +from instana_client.models.synthetic_geo_point import SyntheticGeoPoint +from instana_client.models.synthetic_location import SyntheticLocation +from instana_client.models.synthetic_location_configuration import SyntheticLocationConfiguration +from instana_client.models.synthetic_metric_configuration import SyntheticMetricConfiguration +from instana_client.models.synthetic_metric_tag_group import SyntheticMetricTagGroup +from instana_client.models.synthetic_playback_capabilities import SyntheticPlaybackCapabilities +from instana_client.models.synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value import SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue +from instana_client.models.synthetic_resource_update_list_icmp_validation_list_icmp_validation import SyntheticResourceUpdateListICMPValidationListICMPValidation +from instana_client.models.synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation import SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation +from instana_client.models.synthetic_resource_update_list_string_list_string import SyntheticResourceUpdateListStringListString +from instana_client.models.synthetic_resource_update_map_string_string_list_string import SyntheticResourceUpdateMapStringStringListString +from instana_client.models.synthetic_slo_entity import SyntheticSloEntity +from instana_client.models.synthetic_test import SyntheticTest +from instana_client.models.synthetic_test_cicd import SyntheticTestCICD +from instana_client.models.synthetic_test_cicd_customization import SyntheticTestCICDCustomization +from instana_client.models.synthetic_test_cicd_item import SyntheticTestCICDItem +from instana_client.models.synthetic_test_cicd_response import SyntheticTestCICDResponse +from instana_client.models.synthetic_test_deep_update import SyntheticTestDeepUpdate +from instana_client.models.synthetic_test_shallow_update import SyntheticTestShallowUpdate +from instana_client.models.synthetic_test_update import SyntheticTestUpdate +from instana_client.models.synthetic_time_threshold import SyntheticTimeThreshold +from instana_client.models.synthetic_type_configuration import SyntheticTypeConfiguration +from instana_client.models.synthetic_type_configuration_update import SyntheticTypeConfigurationUpdate +from instana_client.models.synthetics_event_result import SyntheticsEventResult +from instana_client.models.system_rule import SystemRule +from instana_client.models.system_rule_label import SystemRuleLabel +from instana_client.models.tag import Tag +from instana_client.models.tag_catalog import TagCatalog +from instana_client.models.tag_filter import TagFilter +from instana_client.models.tag_filter_expression import TagFilterExpression +from instana_client.models.tag_filter_expression_element import TagFilterExpressionElement +from instana_client.models.tag_matcher_dto import TagMatcherDTO +from instana_client.models.tag_tree_level import TagTreeLevel +from instana_client.models.tag_tree_node import TagTreeNode +from instana_client.models.tag_tree_tag import TagTreeTag +from instana_client.models.test_common_properties import TestCommonProperties +from instana_client.models.test_connection_response import TestConnectionResponse +from instana_client.models.test_last_error import TestLastError +from instana_client.models.test_result import TestResult +from instana_client.models.test_result_common_properties import TestResultCommonProperties +from instana_client.models.test_result_detail_data import TestResultDetailData +from instana_client.models.test_result_item import TestResultItem +from instana_client.models.test_result_list_item import TestResultListItem +from instana_client.models.test_result_list_result import TestResultListResult +from instana_client.models.test_result_metadata import TestResultMetadata +from instana_client.models.test_result_subtransaction import TestResultSubtransaction +from instana_client.models.threshold import Threshold +from instana_client.models.threshold_config_rule import ThresholdConfigRule +from instana_client.models.threshold_rule import ThresholdRule +from instana_client.models.throughput_application_alert_rule import ThroughputApplicationAlertRule +from instana_client.models.throughput_mobile_app_alert_rule import ThroughputMobileAppAlertRule +from instana_client.models.throughput_website_alert_rule import ThroughputWebsiteAlertRule +from instana_client.models.time_frame import TimeFrame +from instana_client.models.time_window import TimeWindow +from instana_client.models.topology import Topology +from instana_client.models.trace import Trace +from instana_client.models.trace_activity_tree_node_details import TraceActivityTreeNodeDetails +from instana_client.models.trace_download_result import TraceDownloadResult +from instana_client.models.trace_groups_item import TraceGroupsItem +from instana_client.models.trace_groups_result import TraceGroupsResult +from instana_client.models.trace_impact_application_time_threshold import TraceImpactApplicationTimeThreshold +from instana_client.models.trace_item import TraceItem +from instana_client.models.trace_result import TraceResult +from instana_client.models.traffic_blueprint_indicator import TrafficBlueprintIndicator +from instana_client.models.trigger import Trigger +from instana_client.models.type_configuration import TypeConfiguration +from instana_client.models.unsupported_http_path_segment_matching_rule import UnsupportedHttpPathSegmentMatchingRule +from instana_client.models.updated_business_perspective_config import UpdatedBusinessPerspectiveConfig +from instana_client.models.usage_result import UsageResult +from instana_client.models.usage_result_items import UsageResultItems +from instana_client.models.user_basic_result import UserBasicResult +from instana_client.models.user_impact_mobile_app_time_threshold import UserImpactMobileAppTimeThreshold +from instana_client.models.user_impact_website_time_threshold import UserImpactWebsiteTimeThreshold +from instana_client.models.user_result import UserResult +from instana_client.models.users_result import UsersResult +from instana_client.models.validated_alerting_channel_input_info import ValidatedAlertingChannelInputInfo +from instana_client.models.validated_alerting_configuration import ValidatedAlertingConfiguration +from instana_client.models.validated_maintenance_config_v2_with_state_and_occurrence import ValidatedMaintenanceConfigV2WithStateAndOccurrence +from instana_client.models.validated_maintenance_config_with_status import ValidatedMaintenanceConfigWithStatus +from instana_client.models.victor_ops_integration import VictorOpsIntegration +from instana_client.models.violations_in_period_application_time_threshold import ViolationsInPeriodApplicationTimeThreshold +from instana_client.models.violations_in_period_mobile_app_time_threshold import ViolationsInPeriodMobileAppTimeThreshold +from instana_client.models.violations_in_period_website_time_threshold import ViolationsInPeriodWebsiteTimeThreshold +from instana_client.models.violations_in_sequence_application_time_threshold import ViolationsInSequenceApplicationTimeThreshold +from instana_client.models.violations_in_sequence_infra_time_threshold import ViolationsInSequenceInfraTimeThreshold +from instana_client.models.violations_in_sequence_log_time_threshold import ViolationsInSequenceLogTimeThreshold +from instana_client.models.violations_in_sequence_mobile_app_time_threshold import ViolationsInSequenceMobileAppTimeThreshold +from instana_client.models.violations_in_sequence_synthetic_time_threshold import ViolationsInSequenceSyntheticTimeThreshold +from instana_client.models.violations_in_sequence_website_time_threshold import ViolationsInSequenceWebsiteTimeThreshold +from instana_client.models.watson_ai_ops_webhook_integration import WatsonAIOpsWebhookIntegration +from instana_client.models.webex_teams_webhook_integration import WebexTeamsWebhookIntegration +from instana_client.models.webhook_integration import WebhookIntegration +from instana_client.models.webpage_action_configuration import WebpageActionConfiguration +from instana_client.models.webpage_action_configuration_update import WebpageActionConfigurationUpdate +from instana_client.models.webpage_script_configuration import WebpageScriptConfiguration +from instana_client.models.webpage_script_configuration_update import WebpageScriptConfigurationUpdate +from instana_client.models.website import Website +from instana_client.models.website_alert_config import WebsiteAlertConfig +from instana_client.models.website_alert_config_with_metadata import WebsiteAlertConfigWithMetadata +from instana_client.models.website_alert_config_with_rbac_tag import WebsiteAlertConfigWithRBACTag +from instana_client.models.website_alert_rule import WebsiteAlertRule +from instana_client.models.website_apdex_entity import WebsiteApdexEntity +from instana_client.models.website_beacon_groups_item import WebsiteBeaconGroupsItem +from instana_client.models.website_beacon_groups_result import WebsiteBeaconGroupsResult +from instana_client.models.website_beacon_result import WebsiteBeaconResult +from instana_client.models.website_beacon_tag_group import WebsiteBeaconTagGroup +from instana_client.models.website_beacons_item import WebsiteBeaconsItem +from instana_client.models.website_event_based_sli_entity import WebsiteEventBasedSliEntity +from instana_client.models.website_event_result import WebsiteEventResult +from instana_client.models.website_metric_result import WebsiteMetricResult +from instana_client.models.website_monitoring_beacon import WebsiteMonitoringBeacon +from instana_client.models.website_monitoring_metric_description import WebsiteMonitoringMetricDescription +from instana_client.models.website_monitoring_metrics_configuration import WebsiteMonitoringMetricsConfiguration +from instana_client.models.website_slo_entity import WebsiteSloEntity +from instana_client.models.website_time_based_sli_entity import WebsiteTimeBasedSliEntity +from instana_client.models.website_time_threshold import WebsiteTimeThreshold +from instana_client.models.widget import Widget +from instana_client.models.with_meta_data import WithMetaData +from instana_client.models.with_resolved_name import WithResolvedName +from instana_client.models.z_chat_ops_integration import ZChatOpsIntegration diff --git a/instana_client/api/__init__.py b/instana_client/api/__init__.py index dd59c2c..ea4749e 100644 --- a/instana_client/api/__init__.py +++ b/instana_client/api/__init__.py @@ -1,79 +1,6 @@ # flake8: noqa -if __import__("typing").TYPE_CHECKING: - # import apis into api package - from instana_client.api.ai_management_api import AIManagementApi - from instana_client.api.api_token_api import APITokenApi - from instana_client.api.action_catalog_api import ActionCatalogApi - from instana_client.api.action_history_api import ActionHistoryApi - from instana_client.api.apdex_report_api import ApdexReportApi - from instana_client.api.apdex_settings_api import ApdexSettingsApi - from instana_client.api.application_alert_configuration_api import ApplicationAlertConfigurationApi - from instana_client.api.application_analyze_api import ApplicationAnalyzeApi - from instana_client.api.application_catalog_api import ApplicationCatalogApi - from instana_client.api.application_metrics_api import ApplicationMetricsApi - from instana_client.api.application_resources_api import ApplicationResourcesApi - from instana_client.api.application_settings_api import ApplicationSettingsApi - from instana_client.api.application_topology_api import ApplicationTopologyApi - from instana_client.api.audit_log_api import AuditLogApi - from instana_client.api.authentication_api import AuthenticationApi - from instana_client.api.business_monitoring_api import BusinessMonitoringApi - from instana_client.api.custom_dashboards_api import CustomDashboardsApi - from instana_client.api.custom_entities_api import CustomEntitiesApi - from instana_client.api.end_user_monitoring_api import EndUserMonitoringApi - from instana_client.api.event_settings_api import EventSettingsApi - from instana_client.api.events_api import EventsApi - from instana_client.api.global_application_alert_configuration_api import GlobalApplicationAlertConfigurationApi - from instana_client.api.groups_api import GroupsApi - from instana_client.api.health_api import HealthApi - from instana_client.api.host_agent_api import HostAgentApi - from instana_client.api.infrastructure_alert_configuration_api import InfrastructureAlertConfigurationApi - from instana_client.api.infrastructure_analyze_api import InfrastructureAnalyzeApi - from instana_client.api.infrastructure_catalog_api import InfrastructureCatalogApi - from instana_client.api.infrastructure_metrics_api import InfrastructureMetricsApi - from instana_client.api.infrastructure_resources_api import InfrastructureResourcesApi - from instana_client.api.infrastructure_topology_api import InfrastructureTopologyApi - from instana_client.api.llm_price_configuration_api import LLMPriceConfigurationApi - from instana_client.api.log_alert_configuration_api import LogAlertConfigurationApi - from instana_client.api.logging_analyze_api import LoggingAnalyzeApi - from instana_client.api.maintenance_configuration_api import MaintenanceConfigurationApi - from instana_client.api.mobile_app_analyze_api import MobileAppAnalyzeApi - from instana_client.api.mobile_app_catalog_api import MobileAppCatalogApi - from instana_client.api.mobile_app_configuration_api import MobileAppConfigurationApi - from instana_client.api.mobile_app_metrics_api import MobileAppMetricsApi - from instana_client.api.policies_api import PoliciesApi - from instana_client.api.releases_api import ReleasesApi - from instana_client.api.roles_api import RolesApi - from instana_client.api.sli_report_api import SLIReportApi - from instana_client.api.sli_settings_api import SLISettingsApi - from instana_client.api.slo_configurations_api import SLOConfigurationsApi - from instana_client.api.slo_correction_configurations_api import SLOCorrectionConfigurationsApi - from instana_client.api.slo_correction_windows_api import SLOCorrectionWindowsApi - from instana_client.api.service_levels_alert_configuration_api import ServiceLevelsAlertConfigurationApi - from instana_client.api.service_levels_objective_slo_report_api import ServiceLevelsObjectiveSLOReportApi - from instana_client.api.session_settings_api import SessionSettingsApi - from instana_client.api.synthetic_alert_configuration_api import SyntheticAlertConfigurationApi - from instana_client.api.synthetic_calls_api import SyntheticCallsApi - from instana_client.api.synthetic_catalog_api import SyntheticCatalogApi - from instana_client.api.synthetic_metrics_api import SyntheticMetricsApi - from instana_client.api.synthetic_settings_api import SyntheticSettingsApi - from instana_client.api.synthetic_test_playback_results_api import SyntheticTestPlaybackResultsApi - from instana_client.api.teams_api import TeamsApi - from instana_client.api.usage_api import UsageApi - from instana_client.api.user_api import UserApi - from instana_client.api.website_analyze_api import WebsiteAnalyzeApi - from instana_client.api.website_catalog_api import WebsiteCatalogApi - from instana_client.api.website_configuration_api import WebsiteConfigurationApi - from instana_client.api.website_metrics_api import WebsiteMetricsApi - from instana_client.api.default_api import DefaultApi - -else: - from lazy_imports import LazyModule, as_package, load - - load( - LazyModule( - *as_package(__file__), - """# import apis into api package +# import apis into api package from instana_client.api.ai_management_api import AIManagementApi from instana_client.api.api_token_api import APITokenApi from instana_client.api.action_catalog_api import ActionCatalogApi @@ -99,6 +26,7 @@ from instana_client.api.groups_api import GroupsApi from instana_client.api.health_api import HealthApi from instana_client.api.host_agent_api import HostAgentApi +from instana_client.api.ip_filtering_api import IPFilteringApi from instana_client.api.infrastructure_alert_configuration_api import InfrastructureAlertConfigurationApi from instana_client.api.infrastructure_analyze_api import InfrastructureAnalyzeApi from instana_client.api.infrastructure_catalog_api import InfrastructureCatalogApi @@ -139,8 +67,3 @@ from instana_client.api.website_metrics_api import WebsiteMetricsApi from instana_client.api.default_api import DefaultApi -""", - name=__name__, - doc=__doc__, - ) - ) diff --git a/instana_client/api/action_catalog_api.py b/instana_client/api/action_catalog_api.py index e566f09..a8ab05e 100644 --- a/instana_client/api/action_catalog_api.py +++ b/instana_client/api/action_catalog_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/action_history_api.py b/instana_client/api/action_history_api.py index 3f26be4..3d2bb14 100644 --- a/instana_client/api/action_history_api.py +++ b/instana_client/api/action_history_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/ai_management_api.py b/instana_client/api/ai_management_api.py index 2b83957..e0d6a36 100644 --- a/instana_client/api/ai_management_api.py +++ b/instana_client/api/ai_management_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/apdex_report_api.py b/instana_client/api/apdex_report_api.py index 51db9c3..7ed6fb0 100644 --- a/instana_client/api/apdex_report_api.py +++ b/instana_client/api/apdex_report_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/apdex_settings_api.py b/instana_client/api/apdex_settings_api.py index a5540ed..8a737c1 100644 --- a/instana_client/api/apdex_settings_api.py +++ b/instana_client/api/apdex_settings_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/api_token_api.py b/instana_client/api/api_token_api.py index c8dca71..77f6942 100644 --- a/instana_client/api/api_token_api.py +++ b/instana_client/api/api_token_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/application_alert_configuration_api.py b/instana_client/api/application_alert_configuration_api.py index cff289f..dc43773 100644 --- a/instana_client/api/application_alert_configuration_api.py +++ b/instana_client/api/application_alert_configuration_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/application_analyze_api.py b/instana_client/api/application_analyze_api.py index f140590..274d96b 100644 --- a/instana_client/api/application_analyze_api.py +++ b/instana_client/api/application_analyze_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/application_catalog_api.py b/instana_client/api/application_catalog_api.py index 1c8f4a8..7f4623e 100644 --- a/instana_client/api/application_catalog_api.py +++ b/instana_client/api/application_catalog_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/application_metrics_api.py b/instana_client/api/application_metrics_api.py index f541f6a..64b7857 100644 --- a/instana_client/api/application_metrics_api.py +++ b/instana_client/api/application_metrics_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/application_resources_api.py b/instana_client/api/application_resources_api.py index 3025dde..4f278e2 100644 --- a/instana_client/api/application_resources_api.py +++ b/instana_client/api/application_resources_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/application_settings_api.py b/instana_client/api/application_settings_api.py index 67aa89d..ffe0d52 100644 --- a/instana_client/api/application_settings_api.py +++ b/instana_client/api/application_settings_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/application_topology_api.py b/instana_client/api/application_topology_api.py index 579577b..3a3d968 100644 --- a/instana_client/api/application_topology_api.py +++ b/instana_client/api/application_topology_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/audit_log_api.py b/instana_client/api/audit_log_api.py index 5e68699..c541570 100644 --- a/instana_client/api/audit_log_api.py +++ b/instana_client/api/audit_log_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -20,7 +20,6 @@ from pydantic import Field, StrictInt, StrictStr from typing import Optional from typing_extensions import Annotated -from instana_client.models.access_log_response import AccessLogResponse from instana_client.models.audit_log_ui_response import AuditLogUiResponse from instana_client.api_client import ApiClient, RequestSerialized @@ -59,7 +58,7 @@ def get_access_logs( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> AccessLogResponse: + ) -> AuditLogUiResponse: """Access log Retrieve all access logs using defined query. @@ -103,7 +102,7 @@ def get_access_logs( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AccessLogResponse", + '200': "AuditLogUiResponse", } response_data = self.api_client.call_api( *_param, @@ -134,7 +133,7 @@ def get_access_logs_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[AccessLogResponse]: + ) -> ApiResponse[AuditLogUiResponse]: """Access log Retrieve all access logs using defined query. @@ -178,7 +177,7 @@ def get_access_logs_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AccessLogResponse", + '200': "AuditLogUiResponse", } response_data = self.api_client.call_api( *_param, @@ -253,7 +252,7 @@ def get_access_logs_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AccessLogResponse", + '200': "AuditLogUiResponse", } response_data = self.api_client.call_api( *_param, diff --git a/instana_client/api/authentication_api.py b/instana_client/api/authentication_api.py index eeeb911..6b6103c 100644 --- a/instana_client/api/authentication_api.py +++ b/instana_client/api/authentication_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/business_monitoring_api.py b/instana_client/api/business_monitoring_api.py index 47d6820..b6678d7 100644 --- a/instana_client/api/business_monitoring_api.py +++ b/instana_client/api/business_monitoring_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/custom_dashboards_api.py b/instana_client/api/custom_dashboards_api.py index 08abdc0..792295c 100644 --- a/instana_client/api/custom_dashboards_api.py +++ b/instana_client/api/custom_dashboards_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/custom_entities_api.py b/instana_client/api/custom_entities_api.py index 692f047..4b4e22f 100644 --- a/instana_client/api/custom_entities_api.py +++ b/instana_client/api/custom_entities_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/default_api.py b/instana_client/api/default_api.py index e2be6b3..3f0fa7b 100644 --- a/instana_client/api/default_api.py +++ b/instana_client/api/default_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/end_user_monitoring_api.py b/instana_client/api/end_user_monitoring_api.py index ac12dd9..5dec551 100644 --- a/instana_client/api/end_user_monitoring_api.py +++ b/instana_client/api/end_user_monitoring_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/event_settings_api.py b/instana_client/api/event_settings_api.py index 64e82c2..d059190 100644 --- a/instana_client/api/event_settings_api.py +++ b/instana_client/api/event_settings_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -25,6 +25,7 @@ from instana_client.models.alerting_configuration_with_last_updated import AlertingConfigurationWithLastUpdated from instana_client.models.built_in_event_specification import BuiltInEventSpecification from instana_client.models.built_in_event_specification_with_last_updated import BuiltInEventSpecificationWithLastUpdated +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest from instana_client.models.config_version import ConfigVersion from instana_client.models.custom_event_specification import CustomEventSpecification from instana_client.models.custom_event_specification_with_last_updated import CustomEventSpecificationWithLastUpdated @@ -66,10 +67,833 @@ def __init__(self, api_client=None) -> None: self.api_client = api_client + @validate_call + def bulk_delete_cross_type_alert_configs( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to delete")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Bulk delete alert configurations across multiple types + + Atomically deletes alert configurations across multiple types. All operations succeed or all fail. Deletion is logical (creates new version with deleted=true) to maintain audit trail. Requires appropriate permissions for each alert config type in the request. For example, deleting WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to delete (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def bulk_delete_cross_type_alert_configs_with_http_info( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to delete")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Bulk delete alert configurations across multiple types + + Atomically deletes alert configurations across multiple types. All operations succeed or all fail. Deletion is logical (creates new version with deleted=true) to maintain audit trail. Requires appropriate permissions for each alert config type in the request. For example, deleting WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to delete (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def bulk_delete_cross_type_alert_configs_without_preload_content( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to delete")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Bulk delete alert configurations across multiple types + + Atomically deletes alert configurations across multiple types. All operations succeed or all fail. Deletion is logical (creates new version with deleted=true) to maintain audit trail. Requires appropriate permissions for each alert config type in the request. For example, deleting WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to delete (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _bulk_delete_cross_type_alert_configs_serialize( + self, + bulk_alert_config_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if bulk_alert_config_request is not None: + _body_params = bulk_alert_config_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/events/settings/alert-configs/bulk/delete', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def bulk_delete_mobile_app_alert_configs( self, - request_body: List[StrictStr], + request_body: List[StrictStr], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Bulk delete Mobile Smart Alert Configs + + Deletes multiple Mobile Smart Alert Configurations in a single request. + + :param request_body: (required) + :type request_body: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_mobile_app_alert_configs_serialize( + request_body=request_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def bulk_delete_mobile_app_alert_configs_with_http_info( + self, + request_body: List[StrictStr], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Bulk delete Mobile Smart Alert Configs + + Deletes multiple Mobile Smart Alert Configurations in a single request. + + :param request_body: (required) + :type request_body: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_mobile_app_alert_configs_serialize( + request_body=request_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def bulk_delete_mobile_app_alert_configs_without_preload_content( + self, + request_body: List[StrictStr], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Bulk delete Mobile Smart Alert Configs + + Deletes multiple Mobile Smart Alert Configurations in a single request. + + :param request_body: (required) + :type request_body: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_mobile_app_alert_configs_serialize( + request_body=request_body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _bulk_delete_mobile_app_alert_configs_serialize( + self, + request_body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + 'request_body': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if request_body is not None: + _body_params = request_body + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/events/settings/mobile-app-alert-configs/bulk/delete', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def bulk_delete_website_alert_configs( + self, + body: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Bulk Delete Website Smart Alert Configs + + Deletes multiple website alert configurations. Creates new revisions for all specified alerts with deleted=true. All revisions share the same timestamp. Maximum 1000 IDs per request. + + :param body: (required) + :type body: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_website_alert_configs_serialize( + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def bulk_delete_website_alert_configs_with_http_info( + self, + body: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Bulk Delete Website Smart Alert Configs + + Deletes multiple website alert configurations. Creates new revisions for all specified alerts with deleted=true. All revisions share the same timestamp. Maximum 1000 IDs per request. + + :param body: (required) + :type body: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_website_alert_configs_serialize( + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def bulk_delete_website_alert_configs_without_preload_content( + self, + body: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Bulk Delete Website Smart Alert Configs + + Deletes multiple website alert configurations. Creates new revisions for all specified alerts with deleted=true. All revisions share the same timestamp. Maximum 1000 IDs per request. + + :param body: (required) + :type body: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_website_alert_configs_serialize( + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _bulk_delete_website_alert_configs_serialize( + self, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/events/settings/website-alert-configs/bulk/delete', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def bulk_disable_cross_type_alert_configs( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to disable")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -83,12 +907,12 @@ def bulk_delete_mobile_app_alert_configs( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> None: - """Bulk delete Mobile Smart Alert Configs + """Bulk disable alert configurations across multiple types - Deletes multiple Mobile Smart Alert Configurations in a single request. + Atomically disables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, disabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. - :param request_body: (required) - :type request_body: List[str] + :param bulk_alert_config_request: Map of alert config types to sets of IDs to disable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -111,8 +935,8 @@ def bulk_delete_mobile_app_alert_configs( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_delete_mobile_app_alert_configs_serialize( - request_body=request_body, + _param = self._bulk_disable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -122,6 +946,7 @@ def bulk_delete_mobile_app_alert_configs( _response_types_map: Dict[str, Optional[str]] = { '204': None, '400': None, + '401': None, '403': None, } response_data = self.api_client.call_api( @@ -136,9 +961,9 @@ def bulk_delete_mobile_app_alert_configs( @validate_call - def bulk_delete_mobile_app_alert_configs_with_http_info( + def bulk_disable_cross_type_alert_configs_with_http_info( self, - request_body: List[StrictStr], + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to disable")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -152,12 +977,12 @@ def bulk_delete_mobile_app_alert_configs_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[None]: - """Bulk delete Mobile Smart Alert Configs + """Bulk disable alert configurations across multiple types - Deletes multiple Mobile Smart Alert Configurations in a single request. + Atomically disables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, disabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. - :param request_body: (required) - :type request_body: List[str] + :param bulk_alert_config_request: Map of alert config types to sets of IDs to disable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -180,8 +1005,8 @@ def bulk_delete_mobile_app_alert_configs_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_delete_mobile_app_alert_configs_serialize( - request_body=request_body, + _param = self._bulk_disable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -191,6 +1016,7 @@ def bulk_delete_mobile_app_alert_configs_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, '400': None, + '401': None, '403': None, } response_data = self.api_client.call_api( @@ -205,9 +1031,9 @@ def bulk_delete_mobile_app_alert_configs_with_http_info( @validate_call - def bulk_delete_mobile_app_alert_configs_without_preload_content( + def bulk_disable_cross_type_alert_configs_without_preload_content( self, - request_body: List[StrictStr], + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to disable")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -221,12 +1047,12 @@ def bulk_delete_mobile_app_alert_configs_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Bulk delete Mobile Smart Alert Configs + """Bulk disable alert configurations across multiple types - Deletes multiple Mobile Smart Alert Configurations in a single request. + Atomically disables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, disabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. - :param request_body: (required) - :type request_body: List[str] + :param bulk_alert_config_request: Map of alert config types to sets of IDs to disable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -249,8 +1075,8 @@ def bulk_delete_mobile_app_alert_configs_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_delete_mobile_app_alert_configs_serialize( - request_body=request_body, + _param = self._bulk_disable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -260,6 +1086,7 @@ def bulk_delete_mobile_app_alert_configs_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, '400': None, + '401': None, '403': None, } response_data = self.api_client.call_api( @@ -269,9 +1096,9 @@ def bulk_delete_mobile_app_alert_configs_without_preload_content( return response_data.response - def _bulk_delete_mobile_app_alert_configs_serialize( + def _bulk_disable_cross_type_alert_configs_serialize( self, - request_body, + bulk_alert_config_request, _request_auth, _content_type, _headers, @@ -281,7 +1108,6 @@ def _bulk_delete_mobile_app_alert_configs_serialize( _host = None _collection_formats: Dict[str, str] = { - 'request_body': '', } _path_params: Dict[str, str] = {} @@ -298,8 +1124,8 @@ def _bulk_delete_mobile_app_alert_configs_serialize( # process the header parameters # process the form parameters # process the body parameter - if request_body is not None: - _body_params = request_body + if bulk_alert_config_request is not None: + _body_params = bulk_alert_config_request @@ -324,7 +1150,7 @@ def _bulk_delete_mobile_app_alert_configs_serialize( return self.api_client.param_serialize( method='PUT', - resource_path='/api/events/settings/mobile-app-alert-configs/bulk/delete', + resource_path='/api/events/settings/alert-configs/bulk/disable', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -341,9 +1167,9 @@ def _bulk_delete_mobile_app_alert_configs_serialize( @validate_call - def bulk_delete_website_alert_configs( + def bulk_disable_mobile_app_alert_configs( self, - body: StrictStr, + request_body: List[StrictStr], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -357,12 +1183,12 @@ def bulk_delete_website_alert_configs( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> None: - """Bulk Delete Website Smart Alert Configs + """Bulk disable Mobile Smart Alert Configs - Deletes multiple website alert configurations. Creates new revisions for all specified alerts with deleted=true. All revisions share the same timestamp. Maximum 1000 IDs per request. + Disables multiple Mobile Smart Alert Configurations in a single request. - :param body: (required) - :type body: str + :param request_body: (required) + :type request_body: List[str] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -385,8 +1211,8 @@ def bulk_delete_website_alert_configs( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_delete_website_alert_configs_serialize( - body=body, + _param = self._bulk_disable_mobile_app_alert_configs_serialize( + request_body=request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -410,9 +1236,9 @@ def bulk_delete_website_alert_configs( @validate_call - def bulk_delete_website_alert_configs_with_http_info( + def bulk_disable_mobile_app_alert_configs_with_http_info( self, - body: StrictStr, + request_body: List[StrictStr], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -426,12 +1252,12 @@ def bulk_delete_website_alert_configs_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[None]: - """Bulk Delete Website Smart Alert Configs + """Bulk disable Mobile Smart Alert Configs - Deletes multiple website alert configurations. Creates new revisions for all specified alerts with deleted=true. All revisions share the same timestamp. Maximum 1000 IDs per request. + Disables multiple Mobile Smart Alert Configurations in a single request. - :param body: (required) - :type body: str + :param request_body: (required) + :type request_body: List[str] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -454,8 +1280,8 @@ def bulk_delete_website_alert_configs_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_delete_website_alert_configs_serialize( - body=body, + _param = self._bulk_disable_mobile_app_alert_configs_serialize( + request_body=request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -479,9 +1305,9 @@ def bulk_delete_website_alert_configs_with_http_info( @validate_call - def bulk_delete_website_alert_configs_without_preload_content( + def bulk_disable_mobile_app_alert_configs_without_preload_content( self, - body: StrictStr, + request_body: List[StrictStr], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -495,12 +1321,12 @@ def bulk_delete_website_alert_configs_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Bulk Delete Website Smart Alert Configs + """Bulk disable Mobile Smart Alert Configs - Deletes multiple website alert configurations. Creates new revisions for all specified alerts with deleted=true. All revisions share the same timestamp. Maximum 1000 IDs per request. + Disables multiple Mobile Smart Alert Configurations in a single request. - :param body: (required) - :type body: str + :param request_body: (required) + :type request_body: List[str] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -523,8 +1349,8 @@ def bulk_delete_website_alert_configs_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_delete_website_alert_configs_serialize( - body=body, + _param = self._bulk_disable_mobile_app_alert_configs_serialize( + request_body=request_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -543,9 +1369,9 @@ def bulk_delete_website_alert_configs_without_preload_content( return response_data.response - def _bulk_delete_website_alert_configs_serialize( + def _bulk_disable_mobile_app_alert_configs_serialize( self, - body, + request_body, _request_auth, _content_type, _headers, @@ -555,6 +1381,7 @@ def _bulk_delete_website_alert_configs_serialize( _host = None _collection_formats: Dict[str, str] = { + 'request_body': '', } _path_params: Dict[str, str] = {} @@ -571,8 +1398,8 @@ def _bulk_delete_website_alert_configs_serialize( # process the header parameters # process the form parameters # process the body parameter - if body is not None: - _body_params = body + if request_body is not None: + _body_params = request_body @@ -597,7 +1424,7 @@ def _bulk_delete_website_alert_configs_serialize( return self.api_client.param_serialize( method='PUT', - resource_path='/api/events/settings/website-alert-configs/bulk/delete', + resource_path='/api/events/settings/mobile-app-alert-configs/bulk/disable', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -614,9 +1441,9 @@ def _bulk_delete_website_alert_configs_serialize( @validate_call - def bulk_disable_mobile_app_alert_configs( + def bulk_disable_website_alert_configs( self, - request_body: List[StrictStr], + body: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -630,12 +1457,12 @@ def bulk_disable_mobile_app_alert_configs( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> None: - """Bulk disable Mobile Smart Alert Configs + """Bulk Disable Website Smart Alert Configs - Disables multiple Mobile Smart Alert Configurations in a single request. + Disables multiple website alert configurations. Creates new revisions for all specified alerts with enabled=false. All revisions share the same timestamp. Maximum 1000 IDs per request. - :param request_body: (required) - :type request_body: List[str] + :param body: (required) + :type body: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -658,8 +1485,8 @@ def bulk_disable_mobile_app_alert_configs( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_disable_mobile_app_alert_configs_serialize( - request_body=request_body, + _param = self._bulk_disable_website_alert_configs_serialize( + body=body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -683,9 +1510,9 @@ def bulk_disable_mobile_app_alert_configs( @validate_call - def bulk_disable_mobile_app_alert_configs_with_http_info( + def bulk_disable_website_alert_configs_with_http_info( self, - request_body: List[StrictStr], + body: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -699,12 +1526,12 @@ def bulk_disable_mobile_app_alert_configs_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[None]: - """Bulk disable Mobile Smart Alert Configs + """Bulk Disable Website Smart Alert Configs - Disables multiple Mobile Smart Alert Configurations in a single request. + Disables multiple website alert configurations. Creates new revisions for all specified alerts with enabled=false. All revisions share the same timestamp. Maximum 1000 IDs per request. - :param request_body: (required) - :type request_body: List[str] + :param body: (required) + :type body: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -727,8 +1554,8 @@ def bulk_disable_mobile_app_alert_configs_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_disable_mobile_app_alert_configs_serialize( - request_body=request_body, + _param = self._bulk_disable_website_alert_configs_serialize( + body=body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -752,9 +1579,9 @@ def bulk_disable_mobile_app_alert_configs_with_http_info( @validate_call - def bulk_disable_mobile_app_alert_configs_without_preload_content( + def bulk_disable_website_alert_configs_without_preload_content( self, - request_body: List[StrictStr], + body: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -768,12 +1595,12 @@ def bulk_disable_mobile_app_alert_configs_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Bulk disable Mobile Smart Alert Configs + """Bulk Disable Website Smart Alert Configs - Disables multiple Mobile Smart Alert Configurations in a single request. + Disables multiple website alert configurations. Creates new revisions for all specified alerts with enabled=false. All revisions share the same timestamp. Maximum 1000 IDs per request. - :param request_body: (required) - :type request_body: List[str] + :param body: (required) + :type body: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -796,8 +1623,8 @@ def bulk_disable_mobile_app_alert_configs_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_disable_mobile_app_alert_configs_serialize( - request_body=request_body, + _param = self._bulk_disable_website_alert_configs_serialize( + body=body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -816,9 +1643,9 @@ def bulk_disable_mobile_app_alert_configs_without_preload_content( return response_data.response - def _bulk_disable_mobile_app_alert_configs_serialize( + def _bulk_disable_website_alert_configs_serialize( self, - request_body, + body, _request_auth, _content_type, _headers, @@ -828,7 +1655,6 @@ def _bulk_disable_mobile_app_alert_configs_serialize( _host = None _collection_formats: Dict[str, str] = { - 'request_body': '', } _path_params: Dict[str, str] = {} @@ -845,8 +1671,8 @@ def _bulk_disable_mobile_app_alert_configs_serialize( # process the header parameters # process the form parameters # process the body parameter - if request_body is not None: - _body_params = request_body + if body is not None: + _body_params = body @@ -871,7 +1697,7 @@ def _bulk_disable_mobile_app_alert_configs_serialize( return self.api_client.param_serialize( method='PUT', - resource_path='/api/events/settings/mobile-app-alert-configs/bulk/disable', + resource_path='/api/events/settings/website-alert-configs/bulk/disable', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -888,9 +1714,9 @@ def _bulk_disable_mobile_app_alert_configs_serialize( @validate_call - def bulk_disable_website_alert_configs( + def bulk_enable_cross_type_alert_configs( self, - body: StrictStr, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to enable")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -904,12 +1730,12 @@ def bulk_disable_website_alert_configs( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> None: - """Bulk Disable Website Smart Alert Configs + """Bulk enable alert configurations across multiple types - Disables multiple website alert configurations. Creates new revisions for all specified alerts with enabled=false. All revisions share the same timestamp. Maximum 1000 IDs per request. + Atomically enables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, enabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. - :param body: (required) - :type body: str + :param bulk_alert_config_request: Map of alert config types to sets of IDs to enable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -932,8 +1758,8 @@ def bulk_disable_website_alert_configs( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_disable_website_alert_configs_serialize( - body=body, + _param = self._bulk_enable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -943,6 +1769,7 @@ def bulk_disable_website_alert_configs( _response_types_map: Dict[str, Optional[str]] = { '204': None, '400': None, + '401': None, '403': None, } response_data = self.api_client.call_api( @@ -957,9 +1784,9 @@ def bulk_disable_website_alert_configs( @validate_call - def bulk_disable_website_alert_configs_with_http_info( + def bulk_enable_cross_type_alert_configs_with_http_info( self, - body: StrictStr, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to enable")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -973,12 +1800,12 @@ def bulk_disable_website_alert_configs_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[None]: - """Bulk Disable Website Smart Alert Configs + """Bulk enable alert configurations across multiple types - Disables multiple website alert configurations. Creates new revisions for all specified alerts with enabled=false. All revisions share the same timestamp. Maximum 1000 IDs per request. + Atomically enables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, enabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. - :param body: (required) - :type body: str + :param bulk_alert_config_request: Map of alert config types to sets of IDs to enable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1001,8 +1828,8 @@ def bulk_disable_website_alert_configs_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_disable_website_alert_configs_serialize( - body=body, + _param = self._bulk_enable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1012,6 +1839,7 @@ def bulk_disable_website_alert_configs_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, '400': None, + '401': None, '403': None, } response_data = self.api_client.call_api( @@ -1026,9 +1854,9 @@ def bulk_disable_website_alert_configs_with_http_info( @validate_call - def bulk_disable_website_alert_configs_without_preload_content( + def bulk_enable_cross_type_alert_configs_without_preload_content( self, - body: StrictStr, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to enable")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1042,12 +1870,12 @@ def bulk_disable_website_alert_configs_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Bulk Disable Website Smart Alert Configs + """Bulk enable alert configurations across multiple types - Disables multiple website alert configurations. Creates new revisions for all specified alerts with enabled=false. All revisions share the same timestamp. Maximum 1000 IDs per request. + Atomically enables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, enabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. - :param body: (required) - :type body: str + :param bulk_alert_config_request: Map of alert config types to sets of IDs to enable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1070,8 +1898,8 @@ def bulk_disable_website_alert_configs_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._bulk_disable_website_alert_configs_serialize( - body=body, + _param = self._bulk_enable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1081,6 +1909,7 @@ def bulk_disable_website_alert_configs_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, '400': None, + '401': None, '403': None, } response_data = self.api_client.call_api( @@ -1090,9 +1919,9 @@ def bulk_disable_website_alert_configs_without_preload_content( return response_data.response - def _bulk_disable_website_alert_configs_serialize( + def _bulk_enable_cross_type_alert_configs_serialize( self, - body, + bulk_alert_config_request, _request_auth, _content_type, _headers, @@ -1118,8 +1947,8 @@ def _bulk_disable_website_alert_configs_serialize( # process the header parameters # process the form parameters # process the body parameter - if body is not None: - _body_params = body + if bulk_alert_config_request is not None: + _body_params = bulk_alert_config_request @@ -1144,7 +1973,7 @@ def _bulk_disable_website_alert_configs_serialize( return self.api_client.param_serialize( method='PUT', - resource_path='/api/events/settings/website-alert-configs/bulk/disable', + resource_path='/api/events/settings/alert-configs/bulk/enable', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -9919,6 +10748,7 @@ def _get_built_in_event_specification_serialize( def get_built_in_event_specifications( self, ids: Optional[List[StrictStr]] = None, + plugins: Optional[List[StrictStr]] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9934,10 +10764,12 @@ def get_built_in_event_specifications( ) -> List[BuiltInEventSpecificationWithLastUpdated]: """All built-in event specification - Get all built-in event specifications + Get all built-in event specifications. Can be filtered by event IDs or plugin IDs. :param ids: :type ids: List[str] + :param plugins: + :type plugins: List[str] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -9962,6 +10794,7 @@ def get_built_in_event_specifications( _param = self._get_built_in_event_specifications_serialize( ids=ids, + plugins=plugins, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9988,6 +10821,7 @@ def get_built_in_event_specifications( def get_built_in_event_specifications_with_http_info( self, ids: Optional[List[StrictStr]] = None, + plugins: Optional[List[StrictStr]] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10003,10 +10837,12 @@ def get_built_in_event_specifications_with_http_info( ) -> ApiResponse[List[BuiltInEventSpecificationWithLastUpdated]]: """All built-in event specification - Get all built-in event specifications + Get all built-in event specifications. Can be filtered by event IDs or plugin IDs. :param ids: :type ids: List[str] + :param plugins: + :type plugins: List[str] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -10031,6 +10867,7 @@ def get_built_in_event_specifications_with_http_info( _param = self._get_built_in_event_specifications_serialize( ids=ids, + plugins=plugins, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10057,6 +10894,7 @@ def get_built_in_event_specifications_with_http_info( def get_built_in_event_specifications_without_preload_content( self, ids: Optional[List[StrictStr]] = None, + plugins: Optional[List[StrictStr]] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10072,10 +10910,12 @@ def get_built_in_event_specifications_without_preload_content( ) -> RESTResponseType: """All built-in event specification - Get all built-in event specifications + Get all built-in event specifications. Can be filtered by event IDs or plugin IDs. :param ids: :type ids: List[str] + :param plugins: + :type plugins: List[str] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -10100,6 +10940,7 @@ def get_built_in_event_specifications_without_preload_content( _param = self._get_built_in_event_specifications_serialize( ids=ids, + plugins=plugins, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10121,6 +10962,7 @@ def get_built_in_event_specifications_without_preload_content( def _get_built_in_event_specifications_serialize( self, ids, + plugins, _request_auth, _content_type, _headers, @@ -10131,6 +10973,7 @@ def _get_built_in_event_specifications_serialize( _collection_formats: Dict[str, str] = { 'ids': 'multi', + 'plugins': 'multi', } _path_params: Dict[str, str] = {} @@ -10148,6 +10991,10 @@ def _get_built_in_event_specifications_serialize( _query_params.append(('ids', ids)) + if plugins is not None: + + _query_params.append(('plugins', plugins)) + # process the header parameters # process the form parameters # process the body parameter @@ -10200,10 +11047,10 @@ def get_current_prefix( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: + ) -> PrefixObject: """Get current shortcode prefix. - Returns the current shortcode prefix used for events. + Returns the current shortcode prefix and enabled state used for events. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -10235,7 +11082,7 @@ def get_current_prefix( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "PrefixObject", '401': None, '403': None, } @@ -10265,10 +11112,10 @@ def get_current_prefix_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: + ) -> ApiResponse[PrefixObject]: """Get current shortcode prefix. - Returns the current shortcode prefix used for events. + Returns the current shortcode prefix and enabled state used for events. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -10300,7 +11147,7 @@ def get_current_prefix_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "PrefixObject", '401': None, '403': None, } @@ -10333,7 +11180,7 @@ def get_current_prefix_without_preload_content( ) -> RESTResponseType: """Get current shortcode prefix. - Returns the current shortcode prefix used for events. + Returns the current shortcode prefix and enabled state used for events. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -10365,7 +11212,7 @@ def get_current_prefix_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "PrefixObject", '401': None, '403': None, } @@ -10405,6 +11252,13 @@ def _get_current_prefix_serialize( # process the body parameter + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) # authentication setting @@ -16106,7 +16960,7 @@ def _update_mobile_app_historic_baseline_serialize( @validate_call def update_prefix( self, - prefix_object: Annotated[PrefixObject, Field(description="The new prefix configuration")], + prefix_object: Annotated[PrefixObject, Field(description="The new prefix configuration including the enabled state")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16122,9 +16976,9 @@ def update_prefix( ) -> PrefixObject: """Update shortcode prefix. - Updates the shortcode prefix used for events. The prefix will be applied to all new incidents created after this update. For example, setting the prefix to 'PROD-' will result in incident codes like 'PROD-1', 'PROD-2', etc. + Updates the shortcode prefix and enabled state used for events. The prefix will be applied to all new incidents created after this update. For example, setting the prefix to 'PROD-' with enabled=true will result in incident codes like 'PROD-1', 'PROD-2', etc. The enabled field allows explicit control over whether the shortcode feature is active. - :param prefix_object: The new prefix configuration (required) + :param prefix_object: The new prefix configuration including the enabled state (required) :type prefix_object: PrefixObject :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -16175,7 +17029,7 @@ def update_prefix( @validate_call def update_prefix_with_http_info( self, - prefix_object: Annotated[PrefixObject, Field(description="The new prefix configuration")], + prefix_object: Annotated[PrefixObject, Field(description="The new prefix configuration including the enabled state")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16191,9 +17045,9 @@ def update_prefix_with_http_info( ) -> ApiResponse[PrefixObject]: """Update shortcode prefix. - Updates the shortcode prefix used for events. The prefix will be applied to all new incidents created after this update. For example, setting the prefix to 'PROD-' will result in incident codes like 'PROD-1', 'PROD-2', etc. + Updates the shortcode prefix and enabled state used for events. The prefix will be applied to all new incidents created after this update. For example, setting the prefix to 'PROD-' with enabled=true will result in incident codes like 'PROD-1', 'PROD-2', etc. The enabled field allows explicit control over whether the shortcode feature is active. - :param prefix_object: The new prefix configuration (required) + :param prefix_object: The new prefix configuration including the enabled state (required) :type prefix_object: PrefixObject :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -16244,7 +17098,7 @@ def update_prefix_with_http_info( @validate_call def update_prefix_without_preload_content( self, - prefix_object: Annotated[PrefixObject, Field(description="The new prefix configuration")], + prefix_object: Annotated[PrefixObject, Field(description="The new prefix configuration including the enabled state")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16260,9 +17114,9 @@ def update_prefix_without_preload_content( ) -> RESTResponseType: """Update shortcode prefix. - Updates the shortcode prefix used for events. The prefix will be applied to all new incidents created after this update. For example, setting the prefix to 'PROD-' will result in incident codes like 'PROD-1', 'PROD-2', etc. + Updates the shortcode prefix and enabled state used for events. The prefix will be applied to all new incidents created after this update. For example, setting the prefix to 'PROD-' with enabled=true will result in incident codes like 'PROD-1', 'PROD-2', etc. The enabled field allows explicit control over whether the shortcode feature is active. - :param prefix_object: The new prefix configuration (required) + :param prefix_object: The new prefix configuration including the enabled state (required) :type prefix_object: PrefixObject :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -17045,6 +17899,7 @@ def upsert_custom_payload_configuration( _response_types_map: Dict[str, Optional[str]] = { '200': "List[CustomPayloadWithLastUpdated]", + '400': None, '401': None, '403': None, '422': None, @@ -17115,6 +17970,7 @@ def upsert_custom_payload_configuration_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "List[CustomPayloadWithLastUpdated]", + '400': None, '401': None, '403': None, '422': None, @@ -17185,6 +18041,7 @@ def upsert_custom_payload_configuration_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "List[CustomPayloadWithLastUpdated]", + '400': None, '401': None, '403': None, '422': None, diff --git a/instana_client/api/events_api.py b/instana_client/api/events_api.py index 15728fe..0449357 100644 --- a/instana_client/api/events_api.py +++ b/instana_client/api/events_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -20,6 +20,7 @@ from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator from typing import List, Optional from typing_extensions import Annotated +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest from instana_client.models.event_result import EventResult from instana_client.api_client import ApiClient, RequestSerialized @@ -374,6 +375,834 @@ def _agent_monitoring_events_serialize( + @validate_call + def bulk_delete_cross_type_alert_configs( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to delete")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Bulk delete alert configurations across multiple types + + Atomically deletes alert configurations across multiple types. All operations succeed or all fail. Deletion is logical (creates new version with deleted=true) to maintain audit trail. Requires appropriate permissions for each alert config type in the request. For example, deleting WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to delete (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def bulk_delete_cross_type_alert_configs_with_http_info( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to delete")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Bulk delete alert configurations across multiple types + + Atomically deletes alert configurations across multiple types. All operations succeed or all fail. Deletion is logical (creates new version with deleted=true) to maintain audit trail. Requires appropriate permissions for each alert config type in the request. For example, deleting WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to delete (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def bulk_delete_cross_type_alert_configs_without_preload_content( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to delete")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Bulk delete alert configurations across multiple types + + Atomically deletes alert configurations across multiple types. All operations succeed or all fail. Deletion is logical (creates new version with deleted=true) to maintain audit trail. Requires appropriate permissions for each alert config type in the request. For example, deleting WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to delete (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_delete_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _bulk_delete_cross_type_alert_configs_serialize( + self, + bulk_alert_config_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if bulk_alert_config_request is not None: + _body_params = bulk_alert_config_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/events/settings/alert-configs/bulk/delete', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def bulk_disable_cross_type_alert_configs( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to disable")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Bulk disable alert configurations across multiple types + + Atomically disables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, disabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to disable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_disable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def bulk_disable_cross_type_alert_configs_with_http_info( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to disable")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Bulk disable alert configurations across multiple types + + Atomically disables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, disabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to disable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_disable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def bulk_disable_cross_type_alert_configs_without_preload_content( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to disable")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Bulk disable alert configurations across multiple types + + Atomically disables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, disabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to disable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_disable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _bulk_disable_cross_type_alert_configs_serialize( + self, + bulk_alert_config_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if bulk_alert_config_request is not None: + _body_params = bulk_alert_config_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/events/settings/alert-configs/bulk/disable', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def bulk_enable_cross_type_alert_configs( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to enable")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Bulk enable alert configurations across multiple types + + Atomically enables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, enabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to enable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_enable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def bulk_enable_cross_type_alert_configs_with_http_info( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to enable")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Bulk enable alert configurations across multiple types + + Atomically enables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, enabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to enable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_enable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def bulk_enable_cross_type_alert_configs_without_preload_content( + self, + bulk_alert_config_request: Annotated[BulkAlertConfigRequest, Field(description="Map of alert config types to sets of IDs to enable")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Bulk enable alert configurations across multiple types + + Atomically enables alert configurations across multiple types. All operations succeed or all fail. Requires appropriate permissions for each alert config type in the request. For example, enabling WEBSITE and APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS permissions. + + :param bulk_alert_config_request: Map of alert config types to sets of IDs to enable (required) + :type bulk_alert_config_request: BulkAlertConfigRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._bulk_enable_cross_type_alert_configs_serialize( + bulk_alert_config_request=bulk_alert_config_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '400': None, + '401': None, + '403': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _bulk_enable_cross_type_alert_configs_serialize( + self, + bulk_alert_config_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if bulk_alert_config_request is not None: + _body_params = bulk_alert_config_request + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/events/settings/alert-configs/bulk/enable', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + @validate_call def get_event( self, diff --git a/instana_client/api/global_application_alert_configuration_api.py b/instana_client/api/global_application_alert_configuration_api.py index 5f34e96..410d5cf 100644 --- a/instana_client/api/global_application_alert_configuration_api.py +++ b/instana_client/api/global_application_alert_configuration_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/groups_api.py b/instana_client/api/groups_api.py index e9dc967..a95d9dc 100644 --- a/instana_client/api/groups_api.py +++ b/instana_client/api/groups_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/health_api.py b/instana_client/api/health_api.py index 5b9e4a3..66761dc 100644 --- a/instana_client/api/health_api.py +++ b/instana_client/api/health_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/host_agent_api.py b/instana_client/api/host_agent_api.py index df41b00..9386e5a 100644 --- a/instana_client/api/host_agent_api.py +++ b/instana_client/api/host_agent_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -21,6 +21,7 @@ from typing import List, Optional from typing_extensions import Annotated from instana_client.models.agent_configuration_update import AgentConfigurationUpdate +from instana_client.models.agent_mode_update import AgentModeUpdate from instana_client.models.snapshot_item import SnapshotItem from instana_client.models.snapshot_result import SnapshotResult @@ -2640,3 +2641,588 @@ def _update_configuration_by_query_serialize( ) + + + @validate_call + def update_mode_by_host( + self, + host_id: Annotated[str, Field(min_length=1, strict=True)], + agent_mode_update: Optional[AgentModeUpdate] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Update agent run mode by host + + + :param host_id: (required) + :type host_id: str + :param agent_mode_update: + :type agent_mode_update: AgentModeUpdate + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_mode_by_host_serialize( + host_id=host_id, + agent_mode_update=agent_mode_update, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_mode_by_host_with_http_info( + self, + host_id: Annotated[str, Field(min_length=1, strict=True)], + agent_mode_update: Optional[AgentModeUpdate] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Update agent run mode by host + + + :param host_id: (required) + :type host_id: str + :param agent_mode_update: + :type agent_mode_update: AgentModeUpdate + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_mode_by_host_serialize( + host_id=host_id, + agent_mode_update=agent_mode_update, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_mode_by_host_without_preload_content( + self, + host_id: Annotated[str, Field(min_length=1, strict=True)], + agent_mode_update: Optional[AgentModeUpdate] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update agent run mode by host + + + :param host_id: (required) + :type host_id: str + :param agent_mode_update: + :type agent_mode_update: AgentModeUpdate + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_mode_by_host_serialize( + host_id=host_id, + agent_mode_update=agent_mode_update, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_mode_by_host_serialize( + self, + host_id, + agent_mode_update, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if host_id is not None: + _path_params['hostId'] = host_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if agent_mode_update is not None: + _body_params = agent_mode_update + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/host-agent/{hostId}/mode', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def update_mode_by_query( + self, + query: Annotated[str, Field(min_length=1, strict=True)], + size: Optional[StrictInt] = None, + agent_mode_update: Optional[AgentModeUpdate] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Update agent run mode by query + + + :param query: (required) + :type query: str + :param size: + :type size: int + :param agent_mode_update: + :type agent_mode_update: AgentModeUpdate + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_mode_by_query_serialize( + query=query, + size=size, + agent_mode_update=agent_mode_update, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def update_mode_by_query_with_http_info( + self, + query: Annotated[str, Field(min_length=1, strict=True)], + size: Optional[StrictInt] = None, + agent_mode_update: Optional[AgentModeUpdate] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Update agent run mode by query + + + :param query: (required) + :type query: str + :param size: + :type size: int + :param agent_mode_update: + :type agent_mode_update: AgentModeUpdate + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_mode_by_query_serialize( + query=query, + size=size, + agent_mode_update=agent_mode_update, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def update_mode_by_query_without_preload_content( + self, + query: Annotated[str, Field(min_length=1, strict=True)], + size: Optional[StrictInt] = None, + agent_mode_update: Optional[AgentModeUpdate] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update agent run mode by query + + + :param query: (required) + :type query: str + :param size: + :type size: int + :param agent_mode_update: + :type agent_mode_update: AgentModeUpdate + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_mode_by_query_serialize( + query=query, + size=size, + agent_mode_update=agent_mode_update, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_mode_by_query_serialize( + self, + query, + size, + agent_mode_update, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if query is not None: + + _query_params.append(('query', query)) + + if size is not None: + + _query_params.append(('size', size)) + + # process the header parameters + # process the form parameters + # process the body parameter + if agent_mode_update is not None: + _body_params = agent_mode_update + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/api/host-agent/mode', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/instana_client/api/infrastructure_alert_configuration_api.py b/instana_client/api/infrastructure_alert_configuration_api.py index 0461e97..2862ed2 100644 --- a/instana_client/api/infrastructure_alert_configuration_api.py +++ b/instana_client/api/infrastructure_alert_configuration_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/infrastructure_analyze_api.py b/instana_client/api/infrastructure_analyze_api.py index 7a66ad2..935b9dd 100644 --- a/instana_client/api/infrastructure_analyze_api.py +++ b/instana_client/api/infrastructure_analyze_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/infrastructure_catalog_api.py b/instana_client/api/infrastructure_catalog_api.py index 4ab1b57..4ba162a 100644 --- a/instana_client/api/infrastructure_catalog_api.py +++ b/instana_client/api/infrastructure_catalog_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/infrastructure_metrics_api.py b/instana_client/api/infrastructure_metrics_api.py index 1a69290..8bfb985 100644 --- a/instana_client/api/infrastructure_metrics_api.py +++ b/instana_client/api/infrastructure_metrics_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/infrastructure_resources_api.py b/instana_client/api/infrastructure_resources_api.py index 99c5031..8ada906 100644 --- a/instana_client/api/infrastructure_resources_api.py +++ b/instana_client/api/infrastructure_resources_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/infrastructure_topology_api.py b/instana_client/api/infrastructure_topology_api.py index f39caff..1c3b5de 100644 --- a/instana_client/api/infrastructure_topology_api.py +++ b/instana_client/api/infrastructure_topology_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/ip_filtering_api.py b/instana_client/api/ip_filtering_api.py new file mode 100644 index 0000000..eade135 --- /dev/null +++ b/instana_client/api/ip_filtering_api.py @@ -0,0 +1,1329 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from instana_client.models.ip_filtering import IPFiltering +from instana_client.models.ip_filtering_upsert import IPFilteringUpsert + +from instana_client.api_client import ApiClient, RequestSerialized +from instana_client.api_response import ApiResponse +from instana_client.rest import RESTResponseType + + +class IPFilteringApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def delete_ip_filtering( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete current ip-filtering + + Delete the currently configured ip-filtering for the current tenant unit. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def delete_ip_filtering_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete current ip-filtering + + Delete the currently configured ip-filtering for the current tenant unit. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def delete_ip_filtering_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete current ip-filtering + + Delete the currently configured ip-filtering for the current tenant unit. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _delete_ip_filtering_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/api/settings/ip-filtering', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def disable_ip_filtering( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> IPFiltering: + """Disable the current ip-filtering + + Disable and retrieve the currently configured ip-filtering for the current tenant unit. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._disable_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def disable_ip_filtering_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[IPFiltering]: + """Disable the current ip-filtering + + Disable and retrieve the currently configured ip-filtering for the current tenant unit. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._disable_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def disable_ip_filtering_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Disable the current ip-filtering + + Disable and retrieve the currently configured ip-filtering for the current tenant unit. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._disable_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _disable_ip_filtering_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/settings/ip-filtering/disable', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def get_ip_filtering( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> IPFiltering: + """Get current ip-filtering + + Retrieve currently configured ip-filtering for the current tenant unit. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def get_ip_filtering_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[IPFiltering]: + """Get current ip-filtering + + Retrieve currently configured ip-filtering for the current tenant unit. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def get_ip_filtering_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get current ip-filtering + + Retrieve currently configured ip-filtering for the current tenant unit. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_ip_filtering_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/settings/ip-filtering', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def upsert_ip_filtering( + self, + ip_filtering_upsert: IPFilteringUpsert, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> IPFiltering: + """Upsert ip-filtering + + Update or create ip-filtering for the current tenant unit. Enabled configurations will become temporarily active (5 minutes) and need to be verified within whilst being temporarily to become permanently active. + + :param ip_filtering_upsert: (required) + :type ip_filtering_upsert: IPFilteringUpsert + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upsert_ip_filtering_serialize( + ip_filtering_upsert=ip_filtering_upsert, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '400': "str", + '422': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def upsert_ip_filtering_with_http_info( + self, + ip_filtering_upsert: IPFilteringUpsert, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[IPFiltering]: + """Upsert ip-filtering + + Update or create ip-filtering for the current tenant unit. Enabled configurations will become temporarily active (5 minutes) and need to be verified within whilst being temporarily to become permanently active. + + :param ip_filtering_upsert: (required) + :type ip_filtering_upsert: IPFilteringUpsert + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upsert_ip_filtering_serialize( + ip_filtering_upsert=ip_filtering_upsert, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '400': "str", + '422': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def upsert_ip_filtering_without_preload_content( + self, + ip_filtering_upsert: IPFilteringUpsert, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Upsert ip-filtering + + Update or create ip-filtering for the current tenant unit. Enabled configurations will become temporarily active (5 minutes) and need to be verified within whilst being temporarily to become permanently active. + + :param ip_filtering_upsert: (required) + :type ip_filtering_upsert: IPFilteringUpsert + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upsert_ip_filtering_serialize( + ip_filtering_upsert=ip_filtering_upsert, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '400': "str", + '422': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _upsert_ip_filtering_serialize( + self, + ip_filtering_upsert, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ip_filtering_upsert is not None: + _body_params = ip_filtering_upsert + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/settings/ip-filtering', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def verify_ip_filtering( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> IPFiltering: + """Verify current ip-filtering + + Verify and retrieve the currently configured ip-filtering for the current tenant unit. This action is required to promote a configuration from temporary active to permanently active. This action can only be performed whilst the configuration is temporary active. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._verify_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def verify_ip_filtering_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[IPFiltering]: + """Verify current ip-filtering + + Verify and retrieve the currently configured ip-filtering for the current tenant unit. This action is required to promote a configuration from temporary active to permanently active. This action can only be performed whilst the configuration is temporary active. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._verify_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def verify_ip_filtering_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Verify current ip-filtering + + Verify and retrieve the currently configured ip-filtering for the current tenant unit. This action is required to promote a configuration from temporary active to permanently active. This action can only be performed whilst the configuration is temporary active. + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._verify_ip_filtering_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "IPFiltering", + '404': "str", + '500': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _verify_ip_filtering_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/api/settings/ip-filtering/verify', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/instana_client/api/llm_price_configuration_api.py b/instana_client/api/llm_price_configuration_api.py index d7f299e..af1fc7c 100644 --- a/instana_client/api/llm_price_configuration_api.py +++ b/instana_client/api/llm_price_configuration_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -330,9 +330,10 @@ def _delete_llm_model_price_serialize( @validate_call - def delete_llm_model_price_without_provider( + def delete_llm_model_price_by_query( self, - model_name: StrictStr, + provider: Optional[StrictStr] = None, + model_name: Optional[StrictStr] = None, platform: Optional[StrictStr] = None, _request_timeout: Union[ None, @@ -347,11 +348,13 @@ def delete_llm_model_price_without_provider( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> None: - """Delete LLM model price without provider + """Delete LLM model price - Delete a tenant-specific price configuration for a model without specifying provider. Optionally specify a platform. Only user-defined prices can be deleted. + Delete a tenant-specific price configuration for a specific provider+model. Optionally specify a platform. Only user-defined prices can be deleted. - :param model_name: (required) + :param provider: + :type provider: str + :param model_name: :type model_name: str :param platform: :type platform: str @@ -377,7 +380,8 @@ def delete_llm_model_price_without_provider( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_llm_model_price_without_provider_serialize( + _param = self._delete_llm_model_price_by_query_serialize( + provider=provider, model_name=model_name, platform=platform, _request_auth=_request_auth, @@ -402,9 +406,10 @@ def delete_llm_model_price_without_provider( @validate_call - def delete_llm_model_price_without_provider_with_http_info( + def delete_llm_model_price_by_query_with_http_info( self, - model_name: StrictStr, + provider: Optional[StrictStr] = None, + model_name: Optional[StrictStr] = None, platform: Optional[StrictStr] = None, _request_timeout: Union[ None, @@ -419,11 +424,13 @@ def delete_llm_model_price_without_provider_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[None]: - """Delete LLM model price without provider + """Delete LLM model price - Delete a tenant-specific price configuration for a model without specifying provider. Optionally specify a platform. Only user-defined prices can be deleted. + Delete a tenant-specific price configuration for a specific provider+model. Optionally specify a platform. Only user-defined prices can be deleted. - :param model_name: (required) + :param provider: + :type provider: str + :param model_name: :type model_name: str :param platform: :type platform: str @@ -449,7 +456,8 @@ def delete_llm_model_price_without_provider_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_llm_model_price_without_provider_serialize( + _param = self._delete_llm_model_price_by_query_serialize( + provider=provider, model_name=model_name, platform=platform, _request_auth=_request_auth, @@ -474,9 +482,10 @@ def delete_llm_model_price_without_provider_with_http_info( @validate_call - def delete_llm_model_price_without_provider_without_preload_content( + def delete_llm_model_price_by_query_without_preload_content( self, - model_name: StrictStr, + provider: Optional[StrictStr] = None, + model_name: Optional[StrictStr] = None, platform: Optional[StrictStr] = None, _request_timeout: Union[ None, @@ -491,11 +500,13 @@ def delete_llm_model_price_without_provider_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Delete LLM model price without provider + """Delete LLM model price - Delete a tenant-specific price configuration for a model without specifying provider. Optionally specify a platform. Only user-defined prices can be deleted. + Delete a tenant-specific price configuration for a specific provider+model. Optionally specify a platform. Only user-defined prices can be deleted. - :param model_name: (required) + :param provider: + :type provider: str + :param model_name: :type model_name: str :param platform: :type platform: str @@ -521,7 +532,8 @@ def delete_llm_model_price_without_provider_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_llm_model_price_without_provider_serialize( + _param = self._delete_llm_model_price_by_query_serialize( + provider=provider, model_name=model_name, platform=platform, _request_auth=_request_auth, @@ -541,8 +553,9 @@ def delete_llm_model_price_without_provider_without_preload_content( return response_data.response - def _delete_llm_model_price_without_provider_serialize( + def _delete_llm_model_price_by_query_serialize( self, + provider, model_name, platform, _request_auth, @@ -566,9 +579,15 @@ def _delete_llm_model_price_without_provider_serialize( _body_params: Optional[bytes] = None # process the path parameters - if model_name is not None: - _path_params['modelName'] = model_name # process the query parameters + if provider is not None: + + _query_params.append(('provider', provider)) + + if model_name is not None: + + _query_params.append(('modelName', model_name)) + if platform is not None: _query_params.append(('platform', platform)) @@ -587,7 +606,7 @@ def _delete_llm_model_price_without_provider_serialize( return self.api_client.param_serialize( method='DELETE', - resource_path='/api/settings/llm-pricing/model/{modelName}', + resource_path='/api/settings/llm-pricing', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -604,8 +623,10 @@ def _delete_llm_model_price_without_provider_serialize( @validate_call - def get_all_llm_model_prices( + def delete_llm_model_price_without_provider( self, + model_name: StrictStr, + platform: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -618,11 +639,15 @@ def get_all_llm_model_prices( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> LlmModelPrice: - """Get all LLM model prices + ) -> None: + """Delete LLM model price without provider - Fetch all LLM price configurations for the current tenant unit. + Delete a tenant-specific price configuration for a model without specifying provider. Optionally specify a platform. Only user-defined prices can be deleted. + :param model_name: (required) + :type model_name: str + :param platform: + :type platform: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -645,7 +670,9 @@ def get_all_llm_model_prices( :return: Returns the result object. """ # noqa: E501 - _param = self._get_all_llm_model_prices_serialize( + _param = self._delete_llm_model_price_without_provider_serialize( + model_name=model_name, + platform=platform, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -653,7 +680,8 @@ def get_all_llm_model_prices( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPrice", + '204': None, + '404': None, } response_data = self.api_client.call_api( *_param, @@ -667,8 +695,10 @@ def get_all_llm_model_prices( @validate_call - def get_all_llm_model_prices_with_http_info( + def delete_llm_model_price_without_provider_with_http_info( self, + model_name: StrictStr, + platform: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -681,11 +711,15 @@ def get_all_llm_model_prices_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[LlmModelPrice]: - """Get all LLM model prices + ) -> ApiResponse[None]: + """Delete LLM model price without provider - Fetch all LLM price configurations for the current tenant unit. + Delete a tenant-specific price configuration for a model without specifying provider. Optionally specify a platform. Only user-defined prices can be deleted. + :param model_name: (required) + :type model_name: str + :param platform: + :type platform: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -708,7 +742,9 @@ def get_all_llm_model_prices_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._get_all_llm_model_prices_serialize( + _param = self._delete_llm_model_price_without_provider_serialize( + model_name=model_name, + platform=platform, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -716,7 +752,8 @@ def get_all_llm_model_prices_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPrice", + '204': None, + '404': None, } response_data = self.api_client.call_api( *_param, @@ -730,8 +767,10 @@ def get_all_llm_model_prices_with_http_info( @validate_call - def get_all_llm_model_prices_without_preload_content( + def delete_llm_model_price_without_provider_without_preload_content( self, + model_name: StrictStr, + platform: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -745,10 +784,14 @@ def get_all_llm_model_prices_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Get all LLM model prices + """Delete LLM model price without provider - Fetch all LLM price configurations for the current tenant unit. + Delete a tenant-specific price configuration for a model without specifying provider. Optionally specify a platform. Only user-defined prices can be deleted. + :param model_name: (required) + :type model_name: str + :param platform: + :type platform: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -771,7 +814,9 @@ def get_all_llm_model_prices_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._get_all_llm_model_prices_serialize( + _param = self._delete_llm_model_price_without_provider_serialize( + model_name=model_name, + platform=platform, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -779,7 +824,8 @@ def get_all_llm_model_prices_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPrice", + '204': None, + '404': None, } response_data = self.api_client.call_api( *_param, @@ -788,8 +834,10 @@ def get_all_llm_model_prices_without_preload_content( return response_data.response - def _get_all_llm_model_prices_serialize( + def _delete_llm_model_price_without_provider_serialize( self, + model_name, + platform, _request_auth, _content_type, _headers, @@ -811,19 +859,18 @@ def _get_all_llm_model_prices_serialize( _body_params: Optional[bytes] = None # process the path parameters + if model_name is not None: + _path_params['modelName'] = model_name # process the query parameters + if platform is not None: + + _query_params.append(('platform', platform)) + # process the header parameters # process the form parameters # process the body parameter - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) # authentication setting @@ -832,8 +879,8 @@ def _get_all_llm_model_prices_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/api/settings/llm-pricing', + method='DELETE', + resource_path='/api/settings/llm-pricing/model/{modelName}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -850,7 +897,7 @@ def _get_all_llm_model_prices_serialize( @validate_call - def get_llm_model_currency( + def get_all_llm_model_prices( self, _request_timeout: Union[ None, @@ -864,10 +911,10 @@ def get_llm_model_currency( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> LlmModelPriceMetadata: - """Get currency for LLM model prices + ) -> LlmModelPrice: + """Get all LLM model prices - Fetch the currency code used for LLM model pricing. + Fetch all LLM price configurations for the current tenant unit. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -891,7 +938,7 @@ def get_llm_model_currency( :return: Returns the result object. """ # noqa: E501 - _param = self._get_llm_model_currency_serialize( + _param = self._get_all_llm_model_prices_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -899,8 +946,7 @@ def get_llm_model_currency( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPriceMetadata", - '404': None, + '200': "LlmModelPrice", } response_data = self.api_client.call_api( *_param, @@ -914,7 +960,7 @@ def get_llm_model_currency( @validate_call - def get_llm_model_currency_with_http_info( + def get_all_llm_model_prices_with_http_info( self, _request_timeout: Union[ None, @@ -928,10 +974,10 @@ def get_llm_model_currency_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[LlmModelPriceMetadata]: - """Get currency for LLM model prices + ) -> ApiResponse[LlmModelPrice]: + """Get all LLM model prices - Fetch the currency code used for LLM model pricing. + Fetch all LLM price configurations for the current tenant unit. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -955,7 +1001,7 @@ def get_llm_model_currency_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._get_llm_model_currency_serialize( + _param = self._get_all_llm_model_prices_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -963,8 +1009,7 @@ def get_llm_model_currency_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPriceMetadata", - '404': None, + '200': "LlmModelPrice", } response_data = self.api_client.call_api( *_param, @@ -978,7 +1023,7 @@ def get_llm_model_currency_with_http_info( @validate_call - def get_llm_model_currency_without_preload_content( + def get_all_llm_model_prices_without_preload_content( self, _request_timeout: Union[ None, @@ -993,9 +1038,9 @@ def get_llm_model_currency_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Get currency for LLM model prices + """Get all LLM model prices - Fetch the currency code used for LLM model pricing. + Fetch all LLM price configurations for the current tenant unit. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1019,7 +1064,7 @@ def get_llm_model_currency_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._get_llm_model_currency_serialize( + _param = self._get_all_llm_model_prices_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1027,8 +1072,7 @@ def get_llm_model_currency_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPriceMetadata", - '404': None, + '200': "LlmModelPrice", } response_data = self.api_client.call_api( *_param, @@ -1037,7 +1081,7 @@ def get_llm_model_currency_without_preload_content( return response_data.response - def _get_llm_model_currency_serialize( + def _get_all_llm_model_prices_serialize( self, _request_auth, _content_type, @@ -1082,7 +1126,7 @@ def _get_llm_model_currency_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/settings/llm-pricing/currency', + resource_path='/api/settings/llm-pricing', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1099,11 +1143,8 @@ def _get_llm_model_currency_serialize( @validate_call - def get_llm_model_price( + def get_llm_model_currency( self, - provider: StrictStr, - model_name: StrictStr, - platform: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1116,17 +1157,11 @@ def get_llm_model_price( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> LlmModelPrice: - """Get LLM model price + ) -> LlmModelPriceMetadata: + """Get currency for LLM model prices - Fetch the price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + Fetch the currency code used for LLM model pricing. - :param provider: (required) - :type provider: str - :param model_name: (required) - :type model_name: str - :param platform: - :type platform: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1149,10 +1184,7 @@ def get_llm_model_price( :return: Returns the result object. """ # noqa: E501 - _param = self._get_llm_model_price_serialize( - provider=provider, - model_name=model_name, - platform=platform, + _param = self._get_llm_model_currency_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1160,7 +1192,7 @@ def get_llm_model_price( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPrice", + '200': "LlmModelPriceMetadata", '404': None, } response_data = self.api_client.call_api( @@ -1175,11 +1207,8 @@ def get_llm_model_price( @validate_call - def get_llm_model_price_with_http_info( + def get_llm_model_currency_with_http_info( self, - provider: StrictStr, - model_name: StrictStr, - platform: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1192,17 +1221,11 @@ def get_llm_model_price_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[LlmModelPrice]: - """Get LLM model price + ) -> ApiResponse[LlmModelPriceMetadata]: + """Get currency for LLM model prices - Fetch the price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + Fetch the currency code used for LLM model pricing. - :param provider: (required) - :type provider: str - :param model_name: (required) - :type model_name: str - :param platform: - :type platform: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1225,10 +1248,7 @@ def get_llm_model_price_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._get_llm_model_price_serialize( - provider=provider, - model_name=model_name, - platform=platform, + _param = self._get_llm_model_currency_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1236,7 +1256,7 @@ def get_llm_model_price_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPrice", + '200': "LlmModelPriceMetadata", '404': None, } response_data = self.api_client.call_api( @@ -1251,11 +1271,8 @@ def get_llm_model_price_with_http_info( @validate_call - def get_llm_model_price_without_preload_content( + def get_llm_model_currency_without_preload_content( self, - provider: StrictStr, - model_name: StrictStr, - platform: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1269,16 +1286,10 @@ def get_llm_model_price_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Get LLM model price + """Get currency for LLM model prices - Fetch the price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + Fetch the currency code used for LLM model pricing. - :param provider: (required) - :type provider: str - :param model_name: (required) - :type model_name: str - :param platform: - :type platform: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1301,10 +1312,7 @@ def get_llm_model_price_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._get_llm_model_price_serialize( - provider=provider, - model_name=model_name, - platform=platform, + _param = self._get_llm_model_currency_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1312,7 +1320,7 @@ def get_llm_model_price_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPrice", + '200': "LlmModelPriceMetadata", '404': None, } response_data = self.api_client.call_api( @@ -1322,11 +1330,8 @@ def get_llm_model_price_without_preload_content( return response_data.response - def _get_llm_model_price_serialize( + def _get_llm_model_currency_serialize( self, - provider, - model_name, - platform, _request_auth, _content_type, _headers, @@ -1348,15 +1353,7 @@ def _get_llm_model_price_serialize( _body_params: Optional[bytes] = None # process the path parameters - if provider is not None: - _path_params['provider'] = provider - if model_name is not None: - _path_params['modelName'] = model_name # process the query parameters - if platform is not None: - - _query_params.append(('platform', platform)) - # process the header parameters # process the form parameters # process the body parameter @@ -1378,7 +1375,7 @@ def _get_llm_model_price_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/settings/llm-pricing/{provider}/{modelName}', + resource_path='/api/settings/llm-pricing/currency', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1395,8 +1392,9 @@ def _get_llm_model_price_serialize( @validate_call - def get_llm_model_price_without_provider( + def get_llm_model_price( self, + provider: StrictStr, model_name: StrictStr, platform: Optional[StrictStr] = None, _request_timeout: Union[ @@ -1412,10 +1410,12 @@ def get_llm_model_price_without_provider( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> LlmModelPrice: - """Get LLM model price without provider + """Get LLM model price - Fetch the price for a model without specifying provider. Optionally specify a platform for platform-specific pricing. + Fetch the price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + :param provider: (required) + :type provider: str :param model_name: (required) :type model_name: str :param platform: @@ -1442,7 +1442,8 @@ def get_llm_model_price_without_provider( :return: Returns the result object. """ # noqa: E501 - _param = self._get_llm_model_price_without_provider_serialize( + _param = self._get_llm_model_price_serialize( + provider=provider, model_name=model_name, platform=platform, _request_auth=_request_auth, @@ -1467,8 +1468,9 @@ def get_llm_model_price_without_provider( @validate_call - def get_llm_model_price_without_provider_with_http_info( + def get_llm_model_price_with_http_info( self, + provider: StrictStr, model_name: StrictStr, platform: Optional[StrictStr] = None, _request_timeout: Union[ @@ -1484,10 +1486,12 @@ def get_llm_model_price_without_provider_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[LlmModelPrice]: - """Get LLM model price without provider + """Get LLM model price - Fetch the price for a model without specifying provider. Optionally specify a platform for platform-specific pricing. + Fetch the price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + :param provider: (required) + :type provider: str :param model_name: (required) :type model_name: str :param platform: @@ -1514,7 +1518,8 @@ def get_llm_model_price_without_provider_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._get_llm_model_price_without_provider_serialize( + _param = self._get_llm_model_price_serialize( + provider=provider, model_name=model_name, platform=platform, _request_auth=_request_auth, @@ -1539,8 +1544,9 @@ def get_llm_model_price_without_provider_with_http_info( @validate_call - def get_llm_model_price_without_provider_without_preload_content( + def get_llm_model_price_without_preload_content( self, + provider: StrictStr, model_name: StrictStr, platform: Optional[StrictStr] = None, _request_timeout: Union[ @@ -1556,10 +1562,12 @@ def get_llm_model_price_without_provider_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Get LLM model price without provider + """Get LLM model price - Fetch the price for a model without specifying provider. Optionally specify a platform for platform-specific pricing. + Fetch the price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + :param provider: (required) + :type provider: str :param model_name: (required) :type model_name: str :param platform: @@ -1586,7 +1594,8 @@ def get_llm_model_price_without_provider_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._get_llm_model_price_without_provider_serialize( + _param = self._get_llm_model_price_serialize( + provider=provider, model_name=model_name, platform=platform, _request_auth=_request_auth, @@ -1606,8 +1615,9 @@ def get_llm_model_price_without_provider_without_preload_content( return response_data.response - def _get_llm_model_price_without_provider_serialize( + def _get_llm_model_price_serialize( self, + provider, model_name, platform, _request_auth, @@ -1631,6 +1641,8 @@ def _get_llm_model_price_without_provider_serialize( _body_params: Optional[bytes] = None # process the path parameters + if provider is not None: + _path_params['provider'] = provider if model_name is not None: _path_params['modelName'] = model_name # process the query parameters @@ -1659,7 +1671,7 @@ def _get_llm_model_price_without_provider_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/settings/llm-pricing/model/{modelName}', + resource_path='/api/settings/llm-pricing/{provider}/{modelName}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1676,9 +1688,10 @@ def _get_llm_model_price_without_provider_serialize( @validate_call - def set_llm_model_currency( + def get_llm_model_price_without_provider( self, - llm_model_price_metadata: Optional[LlmModelPriceMetadata] = None, + model_name: StrictStr, + platform: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1691,13 +1704,15 @@ def set_llm_model_currency( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> LlmModelPriceMetadata: - """Set currency for LLM model prices + ) -> LlmModelPrice: + """Get LLM model price without provider - Set the currency code used for LLM model pricing. + Fetch the price for a model without specifying provider. Optionally specify a platform for platform-specific pricing. - :param llm_model_price_metadata: - :type llm_model_price_metadata: LlmModelPriceMetadata + :param model_name: (required) + :type model_name: str + :param platform: + :type platform: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1720,8 +1735,9 @@ def set_llm_model_currency( :return: Returns the result object. """ # noqa: E501 - _param = self._set_llm_model_currency_serialize( - llm_model_price_metadata=llm_model_price_metadata, + _param = self._get_llm_model_price_without_provider_serialize( + model_name=model_name, + platform=platform, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1729,7 +1745,8 @@ def set_llm_model_currency( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPriceMetadata", + '200': "LlmModelPrice", + '404': None, } response_data = self.api_client.call_api( *_param, @@ -1743,9 +1760,10 @@ def set_llm_model_currency( @validate_call - def set_llm_model_currency_with_http_info( + def get_llm_model_price_without_provider_with_http_info( self, - llm_model_price_metadata: Optional[LlmModelPriceMetadata] = None, + model_name: StrictStr, + platform: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1758,13 +1776,15 @@ def set_llm_model_currency_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[LlmModelPriceMetadata]: - """Set currency for LLM model prices + ) -> ApiResponse[LlmModelPrice]: + """Get LLM model price without provider - Set the currency code used for LLM model pricing. + Fetch the price for a model without specifying provider. Optionally specify a platform for platform-specific pricing. - :param llm_model_price_metadata: - :type llm_model_price_metadata: LlmModelPriceMetadata + :param model_name: (required) + :type model_name: str + :param platform: + :type platform: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1787,8 +1807,9 @@ def set_llm_model_currency_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._set_llm_model_currency_serialize( - llm_model_price_metadata=llm_model_price_metadata, + _param = self._get_llm_model_price_without_provider_serialize( + model_name=model_name, + platform=platform, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1796,7 +1817,8 @@ def set_llm_model_currency_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPriceMetadata", + '200': "LlmModelPrice", + '404': None, } response_data = self.api_client.call_api( *_param, @@ -1810,9 +1832,10 @@ def set_llm_model_currency_with_http_info( @validate_call - def set_llm_model_currency_without_preload_content( + def get_llm_model_price_without_provider_without_preload_content( self, - llm_model_price_metadata: Optional[LlmModelPriceMetadata] = None, + model_name: StrictStr, + platform: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1826,12 +1849,14 @@ def set_llm_model_currency_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Set currency for LLM model prices + """Get LLM model price without provider - Set the currency code used for LLM model pricing. + Fetch the price for a model without specifying provider. Optionally specify a platform for platform-specific pricing. - :param llm_model_price_metadata: - :type llm_model_price_metadata: LlmModelPriceMetadata + :param model_name: (required) + :type model_name: str + :param platform: + :type platform: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1854,8 +1879,9 @@ def set_llm_model_currency_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._set_llm_model_currency_serialize( - llm_model_price_metadata=llm_model_price_metadata, + _param = self._get_llm_model_price_without_provider_serialize( + model_name=model_name, + platform=platform, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1863,7 +1889,8 @@ def set_llm_model_currency_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LlmModelPriceMetadata", + '200': "LlmModelPrice", + '404': None, } response_data = self.api_client.call_api( *_param, @@ -1872,9 +1899,10 @@ def set_llm_model_currency_without_preload_content( return response_data.response - def _set_llm_model_currency_serialize( + def _get_llm_model_price_without_provider_serialize( self, - llm_model_price_metadata, + model_name, + platform, _request_auth, _content_type, _headers, @@ -1896,12 +1924,16 @@ def _set_llm_model_currency_serialize( _body_params: Optional[bytes] = None # process the path parameters + if model_name is not None: + _path_params['modelName'] = model_name # process the query parameters + if platform is not None: + + _query_params.append(('platform', platform)) + # process the header parameters # process the form parameters # process the body parameter - if llm_model_price_metadata is not None: - _body_params = llm_model_price_metadata # set the HTTP header `Accept` @@ -1912,19 +1944,6 @@ def _set_llm_model_currency_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -1932,8 +1951,8 @@ def _set_llm_model_currency_serialize( ] return self.api_client.param_serialize( - method='PUT', - resource_path='/api/settings/llm-pricing/currency', + method='GET', + resource_path='/api/settings/llm-pricing/model/{modelName}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1950,12 +1969,9 @@ def _set_llm_model_currency_serialize( @validate_call - def upsert_llm_model_price( + def set_llm_model_currency( self, - provider: StrictStr, - model_name: StrictStr, - platform: Optional[StrictStr] = None, - llm_model_price: Optional[LlmModelPrice] = None, + llm_model_price_metadata: Optional[LlmModelPriceMetadata] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1968,19 +1984,13 @@ def upsert_llm_model_price( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: - """Upsert LLM model price + ) -> LlmModelPriceMetadata: + """Set currency for LLM model prices - Create or update price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + Set the currency code used for LLM model pricing. - :param provider: (required) - :type provider: str - :param model_name: (required) - :type model_name: str - :param platform: - :type platform: str - :param llm_model_price: - :type llm_model_price: LlmModelPrice + :param llm_model_price_metadata: + :type llm_model_price_metadata: LlmModelPriceMetadata :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2003,11 +2013,8 @@ def upsert_llm_model_price( :return: Returns the result object. """ # noqa: E501 - _param = self._upsert_llm_model_price_serialize( - provider=provider, - model_name=model_name, - platform=platform, - llm_model_price=llm_model_price, + _param = self._set_llm_model_currency_serialize( + llm_model_price_metadata=llm_model_price_metadata, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2015,7 +2022,7 @@ def upsert_llm_model_price( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "LlmModelPriceMetadata", } response_data = self.api_client.call_api( *_param, @@ -2029,12 +2036,9 @@ def upsert_llm_model_price( @validate_call - def upsert_llm_model_price_with_http_info( + def set_llm_model_currency_with_http_info( self, - provider: StrictStr, - model_name: StrictStr, - platform: Optional[StrictStr] = None, - llm_model_price: Optional[LlmModelPrice] = None, + llm_model_price_metadata: Optional[LlmModelPriceMetadata] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2047,19 +2051,13 @@ def upsert_llm_model_price_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: - """Upsert LLM model price + ) -> ApiResponse[LlmModelPriceMetadata]: + """Set currency for LLM model prices - Create or update price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + Set the currency code used for LLM model pricing. - :param provider: (required) - :type provider: str - :param model_name: (required) - :type model_name: str - :param platform: - :type platform: str - :param llm_model_price: - :type llm_model_price: LlmModelPrice + :param llm_model_price_metadata: + :type llm_model_price_metadata: LlmModelPriceMetadata :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2082,11 +2080,8 @@ def upsert_llm_model_price_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._upsert_llm_model_price_serialize( - provider=provider, - model_name=model_name, - platform=platform, - llm_model_price=llm_model_price, + _param = self._set_llm_model_currency_serialize( + llm_model_price_metadata=llm_model_price_metadata, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2094,7 +2089,7 @@ def upsert_llm_model_price_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "LlmModelPriceMetadata", } response_data = self.api_client.call_api( *_param, @@ -2108,12 +2103,9 @@ def upsert_llm_model_price_with_http_info( @validate_call - def upsert_llm_model_price_without_preload_content( + def set_llm_model_currency_without_preload_content( self, - provider: StrictStr, - model_name: StrictStr, - platform: Optional[StrictStr] = None, - llm_model_price: Optional[LlmModelPrice] = None, + llm_model_price_metadata: Optional[LlmModelPriceMetadata] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2127,18 +2119,12 @@ def upsert_llm_model_price_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Upsert LLM model price + """Set currency for LLM model prices - Create or update price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + Set the currency code used for LLM model pricing. - :param provider: (required) - :type provider: str - :param model_name: (required) - :type model_name: str - :param platform: - :type platform: str - :param llm_model_price: - :type llm_model_price: LlmModelPrice + :param llm_model_price_metadata: + :type llm_model_price_metadata: LlmModelPriceMetadata :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2161,11 +2147,8 @@ def upsert_llm_model_price_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._upsert_llm_model_price_serialize( - provider=provider, - model_name=model_name, - platform=platform, - llm_model_price=llm_model_price, + _param = self._set_llm_model_currency_serialize( + llm_model_price_metadata=llm_model_price_metadata, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2173,7 +2156,7 @@ def upsert_llm_model_price_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': None, + '200': "LlmModelPriceMetadata", } response_data = self.api_client.call_api( *_param, @@ -2182,12 +2165,9 @@ def upsert_llm_model_price_without_preload_content( return response_data.response - def _upsert_llm_model_price_serialize( + def _set_llm_model_currency_serialize( self, - provider, - model_name, - platform, - llm_model_price, + llm_model_price_metadata, _request_auth, _content_type, _headers, @@ -2209,25 +2189,605 @@ def _upsert_llm_model_price_serialize( _body_params: Optional[bytes] = None # process the path parameters - if provider is not None: - _path_params['provider'] = provider - if model_name is not None: - _path_params['modelName'] = model_name # process the query parameters - if platform is not None: - - _query_params.append(('platform', platform)) - # process the header parameters # process the form parameters # process the body parameter - if llm_model_price is not None: - _body_params = llm_model_price - + if llm_model_price_metadata is not None: + _body_params = llm_model_price_metadata - # set the HTTP header `Content-Type` - if _content_type: + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/settings/llm-pricing/currency', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def upsert_llm_model_price( + self, + provider: StrictStr, + model_name: StrictStr, + platform: Optional[StrictStr] = None, + llm_model_price: Optional[LlmModelPrice] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Upsert LLM model price + + Create or update price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + + :param provider: (required) + :type provider: str + :param model_name: (required) + :type model_name: str + :param platform: + :type platform: str + :param llm_model_price: + :type llm_model_price: LlmModelPrice + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upsert_llm_model_price_serialize( + provider=provider, + model_name=model_name, + platform=platform, + llm_model_price=llm_model_price, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def upsert_llm_model_price_with_http_info( + self, + provider: StrictStr, + model_name: StrictStr, + platform: Optional[StrictStr] = None, + llm_model_price: Optional[LlmModelPrice] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Upsert LLM model price + + Create or update price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + + :param provider: (required) + :type provider: str + :param model_name: (required) + :type model_name: str + :param platform: + :type platform: str + :param llm_model_price: + :type llm_model_price: LlmModelPrice + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upsert_llm_model_price_serialize( + provider=provider, + model_name=model_name, + platform=platform, + llm_model_price=llm_model_price, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def upsert_llm_model_price_without_preload_content( + self, + provider: StrictStr, + model_name: StrictStr, + platform: Optional[StrictStr] = None, + llm_model_price: Optional[LlmModelPrice] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Upsert LLM model price + + Create or update price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + + :param provider: (required) + :type provider: str + :param model_name: (required) + :type model_name: str + :param platform: + :type platform: str + :param llm_model_price: + :type llm_model_price: LlmModelPrice + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upsert_llm_model_price_serialize( + provider=provider, + model_name=model_name, + platform=platform, + llm_model_price=llm_model_price, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _upsert_llm_model_price_serialize( + self, + provider, + model_name, + platform, + llm_model_price, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if provider is not None: + _path_params['provider'] = provider + if model_name is not None: + _path_params['modelName'] = model_name + # process the query parameters + if platform is not None: + + _query_params.append(('platform', platform)) + + # process the header parameters + # process the form parameters + # process the body parameter + if llm_model_price is not None: + _body_params = llm_model_price + + + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/settings/llm-pricing/{provider}/{modelName}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def upsert_llm_model_price_from_body( + self, + llm_model_price: Optional[LlmModelPrice] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Upsert LLM model price + + Create or update price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + + :param llm_model_price: + :type llm_model_price: LlmModelPrice + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upsert_llm_model_price_from_body_serialize( + llm_model_price=llm_model_price, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def upsert_llm_model_price_from_body_with_http_info( + self, + llm_model_price: Optional[LlmModelPrice] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Upsert LLM model price + + Create or update price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + + :param llm_model_price: + :type llm_model_price: LlmModelPrice + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upsert_llm_model_price_from_body_serialize( + llm_model_price=llm_model_price, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def upsert_llm_model_price_from_body_without_preload_content( + self, + llm_model_price: Optional[LlmModelPrice] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Upsert LLM model price + + Create or update price for a specific provider+model. Optionally specify a platform for platform-specific pricing. + + :param llm_model_price: + :type llm_model_price: LlmModelPrice + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._upsert_llm_model_price_from_body_serialize( + llm_model_price=llm_model_price, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _upsert_llm_model_price_from_body_serialize( + self, + llm_model_price, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if llm_model_price is not None: + _body_params = llm_model_price + + + + # set the HTTP header `Content-Type` + if _content_type: _header_params['Content-Type'] = _content_type else: _default_content_type = ( @@ -2247,7 +2807,7 @@ def _upsert_llm_model_price_serialize( return self.api_client.param_serialize( method='PUT', - resource_path='/api/settings/llm-pricing/{provider}/{modelName}', + resource_path='/api/settings/llm-pricing', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/instana_client/api/log_alert_configuration_api.py b/instana_client/api/log_alert_configuration_api.py index a48eb13..ded7f64 100644 --- a/instana_client/api/log_alert_configuration_api.py +++ b/instana_client/api/log_alert_configuration_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/logging_analyze_api.py b/instana_client/api/logging_analyze_api.py index 3e867ce..c3385c5 100644 --- a/instana_client/api/logging_analyze_api.py +++ b/instana_client/api/logging_analyze_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/maintenance_configuration_api.py b/instana_client/api/maintenance_configuration_api.py index f6393de..6399f8a 100644 --- a/instana_client/api/maintenance_configuration_api.py +++ b/instana_client/api/maintenance_configuration_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/mobile_app_analyze_api.py b/instana_client/api/mobile_app_analyze_api.py index 53cf152..3fe61f5 100644 --- a/instana_client/api/mobile_app_analyze_api.py +++ b/instana_client/api/mobile_app_analyze_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/mobile_app_catalog_api.py b/instana_client/api/mobile_app_catalog_api.py index 116b64e..364f3d7 100644 --- a/instana_client/api/mobile_app_catalog_api.py +++ b/instana_client/api/mobile_app_catalog_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,13 +17,10 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated -from pydantic import Field, StrictInt, StrictStr, field_validator -from typing import List, Optional +from pydantic import Field, StrictStr, field_validator +from typing import List from typing_extensions import Annotated -from instana_client.models.get_action_beacons_result import GetActionBeaconsResult -from instana_client.models.get_session_replay_metadata_result import GetSessionReplayMetadataResult from instana_client.models.mobile_app_monitoring_metric_description import MobileAppMonitoringMetricDescription -from instana_client.models.session_replay_timestamps import SessionReplayTimestamps from instana_client.models.tag import Tag from instana_client.models.tag_catalog import TagCatalog @@ -45,330 +42,6 @@ def __init__(self, api_client=None) -> None: self.api_client = api_client - @validate_call - def get_action_beacons( - self, - mobile_app_id: Annotated[str, Field(min_length=1, strict=True, description="Mobile app identifier")], - session_id: Annotated[str, Field(min_length=1, strict=True, description="Session identifier")], - cursor: Annotated[Optional[StrictInt], Field(description="Offset cursor for pagination (number of items already retrieved). Omit for first page.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="Number of items per page (default: 100, max: 1000)")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> GetActionBeaconsResult: - """Get action beacons for a session - - Retrieves action beacons (user interactions and events) for a mobile app session. Uses cursor-based pagination with offset cursors. Returns beacons starting from the cursor offset. The pageSize parameter controls the number of items returned (default 100, max 1000). Includes event types, view components, frustration signals, orientation changes, and more. - - :param mobile_app_id: Mobile app identifier (required) - :type mobile_app_id: str - :param session_id: Session identifier (required) - :type session_id: str - :param cursor: Offset cursor for pagination (number of items already retrieved). Omit for first page. - :type cursor: int - :param page_size: Number of items per page (default: 100, max: 1000) - :type page_size: int - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_action_beacons_serialize( - mobile_app_id=mobile_app_id, - session_id=session_id, - cursor=cursor, - page_size=page_size, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetActionBeaconsResult", - '400': None, - '401': None, - '403': None, - '404': None, - '500': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ).data - - - @validate_call - def get_action_beacons_with_http_info( - self, - mobile_app_id: Annotated[str, Field(min_length=1, strict=True, description="Mobile app identifier")], - session_id: Annotated[str, Field(min_length=1, strict=True, description="Session identifier")], - cursor: Annotated[Optional[StrictInt], Field(description="Offset cursor for pagination (number of items already retrieved). Omit for first page.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="Number of items per page (default: 100, max: 1000)")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[GetActionBeaconsResult]: - """Get action beacons for a session - - Retrieves action beacons (user interactions and events) for a mobile app session. Uses cursor-based pagination with offset cursors. Returns beacons starting from the cursor offset. The pageSize parameter controls the number of items returned (default 100, max 1000). Includes event types, view components, frustration signals, orientation changes, and more. - - :param mobile_app_id: Mobile app identifier (required) - :type mobile_app_id: str - :param session_id: Session identifier (required) - :type session_id: str - :param cursor: Offset cursor for pagination (number of items already retrieved). Omit for first page. - :type cursor: int - :param page_size: Number of items per page (default: 100, max: 1000) - :type page_size: int - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_action_beacons_serialize( - mobile_app_id=mobile_app_id, - session_id=session_id, - cursor=cursor, - page_size=page_size, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetActionBeaconsResult", - '400': None, - '401': None, - '403': None, - '404': None, - '500': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ) - - - @validate_call - def get_action_beacons_without_preload_content( - self, - mobile_app_id: Annotated[str, Field(min_length=1, strict=True, description="Mobile app identifier")], - session_id: Annotated[str, Field(min_length=1, strict=True, description="Session identifier")], - cursor: Annotated[Optional[StrictInt], Field(description="Offset cursor for pagination (number of items already retrieved). Omit for first page.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="Number of items per page (default: 100, max: 1000)")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> RESTResponseType: - """Get action beacons for a session - - Retrieves action beacons (user interactions and events) for a mobile app session. Uses cursor-based pagination with offset cursors. Returns beacons starting from the cursor offset. The pageSize parameter controls the number of items returned (default 100, max 1000). Includes event types, view components, frustration signals, orientation changes, and more. - - :param mobile_app_id: Mobile app identifier (required) - :type mobile_app_id: str - :param session_id: Session identifier (required) - :type session_id: str - :param cursor: Offset cursor for pagination (number of items already retrieved). Omit for first page. - :type cursor: int - :param page_size: Number of items per page (default: 100, max: 1000) - :type page_size: int - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_action_beacons_serialize( - mobile_app_id=mobile_app_id, - session_id=session_id, - cursor=cursor, - page_size=page_size, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetActionBeaconsResult", - '400': None, - '401': None, - '403': None, - '404': None, - '500': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_action_beacons_serialize( - self, - mobile_app_id, - session_id, - cursor, - page_size, - _request_auth, - _content_type, - _headers, - _host_index, - ) -> RequestSerialized: - - _host = None - - _collection_formats: Dict[str, str] = { - } - - _path_params: Dict[str, str] = {} - _query_params: List[Tuple[str, str]] = [] - _header_params: Dict[str, Optional[str]] = _headers or {} - _form_params: List[Tuple[str, str]] = [] - _files: Dict[ - str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if mobile_app_id is not None: - _path_params['mobileAppId'] = mobile_app_id - if session_id is not None: - _path_params['sessionId'] = session_id - # process the query parameters - if cursor is not None: - - _query_params.append(('cursor', cursor)) - - if page_size is not None: - - _query_params.append(('pageSize', page_size)) - - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/action-beacons', - path_params=_path_params, - query_params=_query_params, - header_params=_header_params, - body=_body_params, - post_params=_form_params, - files=_files, - auth_settings=_auth_settings, - collection_formats=_collection_formats, - _host=_host, - _request_auth=_request_auth - ) - - - - @validate_call def get_all_mobile_app_catalog_tags( self, @@ -1157,617 +830,3 @@ def _get_mobile_app_tag_catalog_serialize( ) - - - @validate_call - def get_session_replay_metadata( - self, - mobile_app_id: Annotated[str, Field(min_length=1, strict=True, description="Mobile app identifier")], - session_id: Annotated[str, Field(min_length=1, strict=True, description="Session identifier")], - cursor: Annotated[Optional[StrictInt], Field(description="Timestamp cursor for pagination (epoch milliseconds). Retrieves metadata from this timestamp onwards.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="Time window size in milliseconds (default: 20000ms = 20 seconds)")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> GetSessionReplayMetadataResult: - """Get session replay metadata - - Retrieves detailed metadata for session replay captured during a mobile app session. Uses cursor-based pagination with timestamp cursors. Returns metadata within the time window from cursor to cursor + pageSize. The pageSize represents milliseconds (default 20000ms = 20 seconds). Includes all metadata fields such as event type, view components, orientation changes, etc. - - :param mobile_app_id: Mobile app identifier (required) - :type mobile_app_id: str - :param session_id: Session identifier (required) - :type session_id: str - :param cursor: Timestamp cursor for pagination (epoch milliseconds). Retrieves metadata from this timestamp onwards. - :type cursor: int - :param page_size: Time window size in milliseconds (default: 20000ms = 20 seconds) - :type page_size: int - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_session_replay_metadata_serialize( - mobile_app_id=mobile_app_id, - session_id=session_id, - cursor=cursor, - page_size=page_size, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetSessionReplayMetadataResult", - '400': None, - '401': None, - '403': None, - '404': None, - '500': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ).data - - - @validate_call - def get_session_replay_metadata_with_http_info( - self, - mobile_app_id: Annotated[str, Field(min_length=1, strict=True, description="Mobile app identifier")], - session_id: Annotated[str, Field(min_length=1, strict=True, description="Session identifier")], - cursor: Annotated[Optional[StrictInt], Field(description="Timestamp cursor for pagination (epoch milliseconds). Retrieves metadata from this timestamp onwards.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="Time window size in milliseconds (default: 20000ms = 20 seconds)")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[GetSessionReplayMetadataResult]: - """Get session replay metadata - - Retrieves detailed metadata for session replay captured during a mobile app session. Uses cursor-based pagination with timestamp cursors. Returns metadata within the time window from cursor to cursor + pageSize. The pageSize represents milliseconds (default 20000ms = 20 seconds). Includes all metadata fields such as event type, view components, orientation changes, etc. - - :param mobile_app_id: Mobile app identifier (required) - :type mobile_app_id: str - :param session_id: Session identifier (required) - :type session_id: str - :param cursor: Timestamp cursor for pagination (epoch milliseconds). Retrieves metadata from this timestamp onwards. - :type cursor: int - :param page_size: Time window size in milliseconds (default: 20000ms = 20 seconds) - :type page_size: int - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_session_replay_metadata_serialize( - mobile_app_id=mobile_app_id, - session_id=session_id, - cursor=cursor, - page_size=page_size, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetSessionReplayMetadataResult", - '400': None, - '401': None, - '403': None, - '404': None, - '500': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ) - - - @validate_call - def get_session_replay_metadata_without_preload_content( - self, - mobile_app_id: Annotated[str, Field(min_length=1, strict=True, description="Mobile app identifier")], - session_id: Annotated[str, Field(min_length=1, strict=True, description="Session identifier")], - cursor: Annotated[Optional[StrictInt], Field(description="Timestamp cursor for pagination (epoch milliseconds). Retrieves metadata from this timestamp onwards.")] = None, - page_size: Annotated[Optional[StrictInt], Field(description="Time window size in milliseconds (default: 20000ms = 20 seconds)")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> RESTResponseType: - """Get session replay metadata - - Retrieves detailed metadata for session replay captured during a mobile app session. Uses cursor-based pagination with timestamp cursors. Returns metadata within the time window from cursor to cursor + pageSize. The pageSize represents milliseconds (default 20000ms = 20 seconds). Includes all metadata fields such as event type, view components, orientation changes, etc. - - :param mobile_app_id: Mobile app identifier (required) - :type mobile_app_id: str - :param session_id: Session identifier (required) - :type session_id: str - :param cursor: Timestamp cursor for pagination (epoch milliseconds). Retrieves metadata from this timestamp onwards. - :type cursor: int - :param page_size: Time window size in milliseconds (default: 20000ms = 20 seconds) - :type page_size: int - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_session_replay_metadata_serialize( - mobile_app_id=mobile_app_id, - session_id=session_id, - cursor=cursor, - page_size=page_size, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "GetSessionReplayMetadataResult", - '400': None, - '401': None, - '403': None, - '404': None, - '500': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_session_replay_metadata_serialize( - self, - mobile_app_id, - session_id, - cursor, - page_size, - _request_auth, - _content_type, - _headers, - _host_index, - ) -> RequestSerialized: - - _host = None - - _collection_formats: Dict[str, str] = { - } - - _path_params: Dict[str, str] = {} - _query_params: List[Tuple[str, str]] = [] - _header_params: Dict[str, Optional[str]] = _headers or {} - _form_params: List[Tuple[str, str]] = [] - _files: Dict[ - str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if mobile_app_id is not None: - _path_params['mobileAppId'] = mobile_app_id - if session_id is not None: - _path_params['sessionId'] = session_id - # process the query parameters - if cursor is not None: - - _query_params.append(('cursor', cursor)) - - if page_size is not None: - - _query_params.append(('pageSize', page_size)) - - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/replay-metadata', - path_params=_path_params, - query_params=_query_params, - header_params=_header_params, - body=_body_params, - post_params=_form_params, - files=_files, - auth_settings=_auth_settings, - collection_formats=_collection_formats, - _host=_host, - _request_auth=_request_auth - ) - - - - - @validate_call - def get_session_replay_timestamps( - self, - mobile_app_id: Annotated[str, Field(min_length=1, strict=True, description="Mobile app identifier")], - session_id: Annotated[str, Field(min_length=1, strict=True, description="Session identifier")], - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> SessionReplayTimestamps: - """Get session replay timestamps - - Retrieves the first and last image timestamps for a mobile app session. Returns null values if the session has no images. - - :param mobile_app_id: Mobile app identifier (required) - :type mobile_app_id: str - :param session_id: Session identifier (required) - :type session_id: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_session_replay_timestamps_serialize( - mobile_app_id=mobile_app_id, - session_id=session_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SessionReplayTimestamps", - '400': None, - '401': None, - '403': None, - '404': None, - '500': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ).data - - - @validate_call - def get_session_replay_timestamps_with_http_info( - self, - mobile_app_id: Annotated[str, Field(min_length=1, strict=True, description="Mobile app identifier")], - session_id: Annotated[str, Field(min_length=1, strict=True, description="Session identifier")], - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[SessionReplayTimestamps]: - """Get session replay timestamps - - Retrieves the first and last image timestamps for a mobile app session. Returns null values if the session has no images. - - :param mobile_app_id: Mobile app identifier (required) - :type mobile_app_id: str - :param session_id: Session identifier (required) - :type session_id: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_session_replay_timestamps_serialize( - mobile_app_id=mobile_app_id, - session_id=session_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SessionReplayTimestamps", - '400': None, - '401': None, - '403': None, - '404': None, - '500': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ) - - - @validate_call - def get_session_replay_timestamps_without_preload_content( - self, - mobile_app_id: Annotated[str, Field(min_length=1, strict=True, description="Mobile app identifier")], - session_id: Annotated[str, Field(min_length=1, strict=True, description="Session identifier")], - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> RESTResponseType: - """Get session replay timestamps - - Retrieves the first and last image timestamps for a mobile app session. Returns null values if the session has no images. - - :param mobile_app_id: Mobile app identifier (required) - :type mobile_app_id: str - :param session_id: Session identifier (required) - :type session_id: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_session_replay_timestamps_serialize( - mobile_app_id=mobile_app_id, - session_id=session_id, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "SessionReplayTimestamps", - '400': None, - '401': None, - '403': None, - '404': None, - '500': None, - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_session_replay_timestamps_serialize( - self, - mobile_app_id, - session_id, - _request_auth, - _content_type, - _headers, - _host_index, - ) -> RequestSerialized: - - _host = None - - _collection_formats: Dict[str, str] = { - } - - _path_params: Dict[str, str] = {} - _query_params: List[Tuple[str, str]] = [] - _header_params: Dict[str, Optional[str]] = _headers or {} - _form_params: List[Tuple[str, str]] = [] - _files: Dict[ - str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] - ] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - if mobile_app_id is not None: - _path_params['mobileAppId'] = mobile_app_id - if session_id is not None: - _path_params['sessionId'] = session_id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/replay-timestamps', - path_params=_path_params, - query_params=_query_params, - header_params=_header_params, - body=_body_params, - post_params=_form_params, - files=_files, - auth_settings=_auth_settings, - collection_formats=_collection_formats, - _host=_host, - _request_auth=_request_auth - ) - - diff --git a/instana_client/api/mobile_app_configuration_api.py b/instana_client/api/mobile_app_configuration_api.py index 5539a6d..a81010d 100644 --- a/instana_client/api/mobile_app_configuration_api.py +++ b/instana_client/api/mobile_app_configuration_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/mobile_app_metrics_api.py b/instana_client/api/mobile_app_metrics_api.py index a6855d7..7c52650 100644 --- a/instana_client/api/mobile_app_metrics_api.py +++ b/instana_client/api/mobile_app_metrics_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/policies_api.py b/instana_client/api/policies_api.py index 7244954..2bad564 100644 --- a/instana_client/api/policies_api.py +++ b/instana_client/api/policies_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/releases_api.py b/instana_client/api/releases_api.py index e52d115..8162bf9 100644 --- a/instana_client/api/releases_api.py +++ b/instana_client/api/releases_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/roles_api.py b/instana_client/api/roles_api.py index 56266b9..33a754f 100644 --- a/instana_client/api/roles_api.py +++ b/instana_client/api/roles_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/service_levels_alert_configuration_api.py b/instana_client/api/service_levels_alert_configuration_api.py index 614b8fd..3ae05c9 100644 --- a/instana_client/api/service_levels_alert_configuration_api.py +++ b/instana_client/api/service_levels_alert_configuration_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/service_levels_objective_slo_report_api.py b/instana_client/api/service_levels_objective_slo_report_api.py index cdbff8e..41ed6ce 100644 --- a/instana_client/api/service_levels_objective_slo_report_api.py +++ b/instana_client/api/service_levels_objective_slo_report_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/session_settings_api.py b/instana_client/api/session_settings_api.py index e254a4f..df35a3f 100644 --- a/instana_client/api/session_settings_api.py +++ b/instana_client/api/session_settings_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/sli_report_api.py b/instana_client/api/sli_report_api.py index 5ee5522..a6951b4 100644 --- a/instana_client/api/sli_report_api.py +++ b/instana_client/api/sli_report_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/sli_settings_api.py b/instana_client/api/sli_settings_api.py index 973a320..c91d7c8 100644 --- a/instana_client/api/sli_settings_api.py +++ b/instana_client/api/sli_settings_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/slo_configurations_api.py b/instana_client/api/slo_configurations_api.py index be3a052..a14befd 100644 --- a/instana_client/api/slo_configurations_api.py +++ b/instana_client/api/slo_configurations_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/slo_correction_configurations_api.py b/instana_client/api/slo_correction_configurations_api.py index 14a2d54..9dc467f 100644 --- a/instana_client/api/slo_correction_configurations_api.py +++ b/instana_client/api/slo_correction_configurations_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/slo_correction_windows_api.py b/instana_client/api/slo_correction_windows_api.py index 9ad6731..1030aaf 100644 --- a/instana_client/api/slo_correction_windows_api.py +++ b/instana_client/api/slo_correction_windows_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/synthetic_alert_configuration_api.py b/instana_client/api/synthetic_alert_configuration_api.py index c0b3020..f76ad7b 100644 --- a/instana_client/api/synthetic_alert_configuration_api.py +++ b/instana_client/api/synthetic_alert_configuration_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/synthetic_calls_api.py b/instana_client/api/synthetic_calls_api.py index 50502d3..8dc68a5 100644 --- a/instana_client/api/synthetic_calls_api.py +++ b/instana_client/api/synthetic_calls_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/synthetic_catalog_api.py b/instana_client/api/synthetic_catalog_api.py index 900918c..e97e6e3 100644 --- a/instana_client/api/synthetic_catalog_api.py +++ b/instana_client/api/synthetic_catalog_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/synthetic_metrics_api.py b/instana_client/api/synthetic_metrics_api.py index 759bb31..be74644 100644 --- a/instana_client/api/synthetic_metrics_api.py +++ b/instana_client/api/synthetic_metrics_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/synthetic_settings_api.py b/instana_client/api/synthetic_settings_api.py index bb4c413..c22d48b 100644 --- a/instana_client/api/synthetic_settings_api.py +++ b/instana_client/api/synthetic_settings_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/synthetic_test_playback_results_api.py b/instana_client/api/synthetic_test_playback_results_api.py index 2fd1099..064820a 100644 --- a/instana_client/api/synthetic_test_playback_results_api.py +++ b/instana_client/api/synthetic_test_playback_results_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/teams_api.py b/instana_client/api/teams_api.py index 43bee1d..425ab1e 100644 --- a/instana_client/api/teams_api.py +++ b/instana_client/api/teams_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/usage_api.py b/instana_client/api/usage_api.py index 772346f..5697418 100644 --- a/instana_client/api/usage_api.py +++ b/instana_client/api/usage_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/user_api.py b/instana_client/api/user_api.py index 17c0f37..ba67184 100644 --- a/instana_client/api/user_api.py +++ b/instana_client/api/user_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/website_analyze_api.py b/instana_client/api/website_analyze_api.py index ba7b1c9..dfc21ea 100644 --- a/instana_client/api/website_analyze_api.py +++ b/instana_client/api/website_analyze_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/website_catalog_api.py b/instana_client/api/website_catalog_api.py index 6e834cb..29588b8 100644 --- a/instana_client/api/website_catalog_api.py +++ b/instana_client/api/website_catalog_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/website_configuration_api.py b/instana_client/api/website_configuration_api.py index ed2bbbd..5cfa162 100644 --- a/instana_client/api/website_configuration_api.py +++ b/instana_client/api/website_configuration_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/website_metrics_api.py b/instana_client/api/website_metrics_api.py index e9fe619..6927c7e 100644 --- a/instana_client/api/website_metrics_api.py +++ b/instana_client/api/website_metrics_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api_client.py b/instana_client/api_client.py index 9afb807..07062f9 100644 --- a/instana_client/api_client.py +++ b/instana_client/api_client.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -22,7 +22,6 @@ import os import re import tempfile -import uuid from urllib.parse import quote from typing import Tuple, Optional, List, Dict, Union @@ -358,8 +357,6 @@ def sanitize_for_serialization(self, obj): return obj.get_secret_value() elif isinstance(obj, self.PRIMITIVE_TYPES): return obj - elif isinstance(obj, uuid.UUID): - return str(obj) elif isinstance(obj, list): return [ self.sanitize_for_serialization(sub_obj) for sub_obj in obj @@ -386,10 +383,6 @@ def sanitize_for_serialization(self, obj): else: obj_dict = obj.__dict__ - if isinstance(obj_dict, list): - # here we handle instances that can either be a list or something else, and only became a real list by calling to_dict() - return self.sanitize_for_serialization(obj_dict) - return { key: self.sanitize_for_serialization(val) for key, val in obj_dict.items() @@ -412,7 +405,7 @@ def deserialize(self, response_text: str, response_type: str, content_type: Opti data = json.loads(response_text) except ValueError: data = response_text - elif re.match(r'^application/(json|[\w!#$&.+\-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE): + elif re.match(r'^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE): if response_text == "": data = "" else: diff --git a/instana_client/configuration.py b/instana_client/configuration.py index 7e2c8b7..a4e3c7c 100644 --- a/instana_client/configuration.py +++ b/instana_client/configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -531,7 +531,7 @@ def to_debug_report(self) -> str: return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.316.2780\n"\ + "Version of the API: 1.319.1109\n"\ "SDK Package Version: 1.0.7".\ format(env=sys.platform, pyversion=sys.version) diff --git a/instana_client/exceptions.py b/instana_client/exceptions.py index 4f55ec1..74717d7 100644 --- a/instana_client/exceptions.py +++ b/instana_client/exceptions.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/__init__.py b/instana_client/models/__init__.py index e377850..cbf058a 100644 --- a/instana_client/models/__init__.py +++ b/instana_client/models/__init__.py @@ -6,7 +6,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -14,566 +14,11 @@ """ # noqa: E501 -if __import__("typing").TYPE_CHECKING: - # import models into model package - from instana_client.models.abstract_integration import AbstractIntegration - from instana_client.models.abstract_rule import AbstractRule - from instana_client.models.access_log_entry import AccessLogEntry - from instana_client.models.access_log_response import AccessLogResponse - from instana_client.models.access_rule import AccessRule - from instana_client.models.action import Action - from instana_client.models.action_beacon import ActionBeacon - from instana_client.models.action_configuration import ActionConfiguration - from instana_client.models.action_instance import ActionInstance - from instana_client.models.action_instance_metadata_entry import ActionInstanceMetadataEntry - from instana_client.models.action_instance_parameter import ActionInstanceParameter - from instana_client.models.action_instance_request import ActionInstanceRequest - from instana_client.models.action_instance_request_parameters import ActionInstanceRequestParameters - from instana_client.models.action_match import ActionMatch - from instana_client.models.action_search_space import ActionSearchSpace - from instana_client.models.adaptive_baseline import AdaptiveBaseline - from instana_client.models.adaptive_threshold_rule import AdaptiveThresholdRule - from instana_client.models.addition import Addition - from instana_client.models.adjusted_timeframe import AdjustedTimeframe - from instana_client.models.agent_configuration_update import AgentConfigurationUpdate - from instana_client.models.alerting_configuration import AlertingConfiguration - from instana_client.models.alerting_configuration_with_last_updated import AlertingConfigurationWithLastUpdated - from instana_client.models.alerting_time_window import AlertingTimeWindow - from instana_client.models.apdex_configuration import ApdexConfiguration - from instana_client.models.apdex_configuration_input import ApdexConfigurationInput - from instana_client.models.apdex_entity import ApdexEntity - from instana_client.models.apdex_level import ApdexLevel - from instana_client.models.apdex_report import ApdexReport - from instana_client.models.api_create_group import ApiCreateGroup - from instana_client.models.api_create_role import ApiCreateRole - from instana_client.models.api_group import ApiGroup - from instana_client.models.api_member import ApiMember - from instana_client.models.api_permission_set import ApiPermissionSet - from instana_client.models.api_restricted_application_filter import ApiRestrictedApplicationFilter - from instana_client.models.api_role import ApiRole - from instana_client.models.api_tag import ApiTag - from instana_client.models.api_team import ApiTeam - from instana_client.models.api_team_info import ApiTeamInfo - from instana_client.models.api_team_member import ApiTeamMember - from instana_client.models.api_team_role import ApiTeamRole - from instana_client.models.api_team_scope import ApiTeamScope - from instana_client.models.api_token import ApiToken - from instana_client.models.app_data_metric_configuration import AppDataMetricConfiguration - from instana_client.models.application import Application - from instana_client.models.application_alert_config import ApplicationAlertConfig - from instana_client.models.application_alert_config_with_metadata import ApplicationAlertConfigWithMetadata - from instana_client.models.application_alert_rule import ApplicationAlertRule - from instana_client.models.application_apdex_entity import ApplicationApdexEntity - from instana_client.models.application_config import ApplicationConfig - from instana_client.models.application_event_result import ApplicationEventResult - from instana_client.models.application_item import ApplicationItem - from instana_client.models.application_metric_result import ApplicationMetricResult - from instana_client.models.application_node import ApplicationNode - from instana_client.models.application_result import ApplicationResult - from instana_client.models.application_scope import ApplicationScope - from instana_client.models.application_scope_with_metadata import ApplicationScopeWithMetadata - from instana_client.models.application_sli_entity import ApplicationSliEntity - from instana_client.models.application_slo_entity import ApplicationSloEntity - from instana_client.models.application_time_threshold import ApplicationTimeThreshold - from instana_client.models.arithmetic_configuration import ArithmeticConfiguration - from instana_client.models.arithmetic_operand import ArithmeticOperand - from instana_client.models.arithmetic_operation import ArithmeticOperation - from instana_client.models.audit_log_entry import AuditLogEntry - from instana_client.models.audit_log_ui_response import AuditLogUiResponse - from instana_client.models.author import Author - from instana_client.models.availability_blueprint_indicator import AvailabilityBlueprintIndicator - from instana_client.models.availability_sli_entity import AvailabilitySliEntity - from instana_client.models.available_metrics import AvailableMetrics - from instana_client.models.available_plugins import AvailablePlugins - from instana_client.models.backend_trace_reference import BackendTraceReference - from instana_client.models.bidirectional_ms_teams_app_integration import BidirectionalMsTeamsAppIntegration - from instana_client.models.bidirectional_slack_app_integration import BidirectionalSlackAppIntegration - from instana_client.models.binary_operator_dto import BinaryOperatorDTO - from instana_client.models.browser_script_configuration import BrowserScriptConfiguration - from instana_client.models.browser_script_configuration_update import BrowserScriptConfigurationUpdate - from instana_client.models.built_in_event_specification import BuiltInEventSpecification - from instana_client.models.built_in_event_specification_with_last_updated import BuiltInEventSpecificationWithLastUpdated - from instana_client.models.business_activity import BusinessActivity - from instana_client.models.business_perspective_config import BusinessPerspectiveConfig - from instana_client.models.call_groups_item import CallGroupsItem - from instana_client.models.call_groups_result import CallGroupsResult - from instana_client.models.call_relation import CallRelation - from instana_client.models.change_summary import ChangeSummary - from instana_client.models.cloudfoundry_physical_context import CloudfoundryPhysicalContext - from instana_client.models.condition import Condition - from instana_client.models.config_version import ConfigVersion - from instana_client.models.correction import Correction - from instana_client.models.correction_configuration import CorrectionConfiguration - from instana_client.models.correction_scheduling import CorrectionScheduling - from instana_client.models.correction_window import CorrectionWindow - from instana_client.models.crash_mobile_app_alert_rule import CrashMobileAppAlertRule - from instana_client.models.create_website_request_inner import CreateWebsiteRequestInner - from instana_client.models.cursor_paginated_business_activity_item import CursorPaginatedBusinessActivityItem - from instana_client.models.cursor_pagination import CursorPagination - from instana_client.models.cursor_pagination_with_ui_cursor_infra_explore_cursor import CursorPaginationWithUiCursorInfraExploreCursor - from instana_client.models.custom_blueprint_indicator import CustomBlueprintIndicator - from instana_client.models.custom_dashboard import CustomDashboard - from instana_client.models.custom_dashboard_preview import CustomDashboardPreview - from instana_client.models.custom_dashboard_with_user_specific_information import CustomDashboardWithUserSpecificInformation - from instana_client.models.custom_dependency import CustomDependency - from instana_client.models.custom_email_subject_prefix import CustomEmailSubjectPrefix - from instana_client.models.custom_entity_model import CustomEntityModel - from instana_client.models.custom_entity_with_metadata import CustomEntityWithMetadata - from instana_client.models.custom_event_mobile_app_alert_rule import CustomEventMobileAppAlertRule - from instana_client.models.custom_event_specification import CustomEventSpecification - from instana_client.models.custom_event_specification_with_last_updated import CustomEventSpecificationWithLastUpdated - from instana_client.models.custom_event_website_alert_rule import CustomEventWebsiteAlertRule - from instana_client.models.custom_metric import CustomMetric - from instana_client.models.custom_payload_configuration import CustomPayloadConfiguration - from instana_client.models.custom_payload_field import CustomPayloadField - from instana_client.models.custom_payload_with_last_updated import CustomPayloadWithLastUpdated - from instana_client.models.custom_payload_with_version import CustomPayloadWithVersion - from instana_client.models.custom_tag import CustomTag - from instana_client.models.dns_configuration import DNSConfiguration - from instana_client.models.dns_configuration_update import DNSConfigurationUpdate - from instana_client.models.dns_filter_query_time import DNSFilterQueryTime - from instana_client.models.dns_filter_target_value import DNSFilterTargetValue - from instana_client.models.dashboard_api_token import DashboardApiToken - from instana_client.models.database_integration import DatabaseIntegration - from instana_client.models.deprecated_tag_filter import DeprecatedTagFilter - from instana_client.models.division import Division - from instana_client.models.duration import Duration - from instana_client.models.dynamic_field import DynamicField - from instana_client.models.dynamic_field_value import DynamicFieldValue - from instana_client.models.dynamic_parameter import DynamicParameter - from instana_client.models.dynamic_tag import DynamicTag - from instana_client.models.edit_user import EditUser - from instana_client.models.email_integration import EmailIntegration - from instana_client.models.empty_configuration import EmptyConfiguration - from instana_client.models.endpoint import Endpoint - from instana_client.models.endpoint_config import EndpointConfig - from instana_client.models.endpoint_event_result import EndpointEventResult - from instana_client.models.endpoint_item import EndpointItem - from instana_client.models.endpoint_metric_result import EndpointMetricResult - from instana_client.models.endpoint_node import EndpointNode - from instana_client.models.endpoint_result import EndpointResult - from instana_client.models.endpoint_simple import EndpointSimple - from instana_client.models.entity_count_rule import EntityCountRule - from instana_client.models.entity_count_verification_rule import EntityCountVerificationRule - from instana_client.models.entity_health_info import EntityHealthInfo - from instana_client.models.entity_id import EntityId - from instana_client.models.entity_verification_rule import EntityVerificationRule - from instana_client.models.error_budget_alert_rule import ErrorBudgetAlertRule - from instana_client.models.errors_application_alert_rule import ErrorsApplicationAlertRule - from instana_client.models.event import Event - from instana_client.models.event_filtering_configuration import EventFilteringConfiguration - from instana_client.models.event_result import EventResult - from instana_client.models.event_specification_info import EventSpecificationInfo - from instana_client.models.extended_service import ExtendedService - from instana_client.models.failure_synthetic_alert_rule import FailureSyntheticAlertRule - from instana_client.models.fixed_http_path_segment_matching_rule import FixedHttpPathSegmentMatchingRule - from instana_client.models.fixed_time_window import FixedTimeWindow - from instana_client.models.generic_infra_alert_rule import GenericInfraAlertRule - from instana_client.models.geo_location_configuration import GeoLocationConfiguration - from instana_client.models.geo_mapping_rule import GeoMappingRule - from instana_client.models.geo_subdivision import GeoSubdivision - from instana_client.models.get_action_beacons_result import GetActionBeaconsResult - from instana_client.models.get_activities import GetActivities - from instana_client.models.get_application_metrics import GetApplicationMetrics - from instana_client.models.get_applications import GetApplications - from instana_client.models.get_available_metrics_query import GetAvailableMetricsQuery - from instana_client.models.get_available_plugins_query import GetAvailablePluginsQuery - from instana_client.models.get_call_groups import GetCallGroups - from instana_client.models.get_combined_metrics import GetCombinedMetrics - from instana_client.models.get_dynamic_parameter_values import GetDynamicParameterValues - from instana_client.models.get_endpoints import GetEndpoints - from instana_client.models.get_infrastructure_groups_query import GetInfrastructureGroupsQuery - from instana_client.models.get_infrastructure_query import GetInfrastructureQuery - from instana_client.models.get_metrics_result import GetMetricsResult - from instana_client.models.get_mobile_app_beacon_groups import GetMobileAppBeaconGroups - from instana_client.models.get_mobile_app_beacons import GetMobileAppBeacons - from instana_client.models.get_mobile_app_metrics import GetMobileAppMetrics - from instana_client.models.get_mobile_app_metrics_v2 import GetMobileAppMetricsV2 - from instana_client.models.get_payload_keys_result import GetPayloadKeysResult - from instana_client.models.get_services import GetServices - from instana_client.models.get_session_replay_metadata_result import GetSessionReplayMetadataResult - from instana_client.models.get_snapshots_query import GetSnapshotsQuery - from instana_client.models.get_test_result import GetTestResult - from instana_client.models.get_test_result_analytic import GetTestResultAnalytic - from instana_client.models.get_test_result_base import GetTestResultBase - from instana_client.models.get_test_result_list import GetTestResultList - from instana_client.models.get_test_summary_result import GetTestSummaryResult - from instana_client.models.get_trace_download_result_item import GetTraceDownloadResultItem - from instana_client.models.get_trace_groups import GetTraceGroups - from instana_client.models.get_traces import GetTraces - from instana_client.models.get_website_beacon_groups import GetWebsiteBeaconGroups - from instana_client.models.get_website_beacons import GetWebsiteBeacons - from instana_client.models.get_website_metrics import GetWebsiteMetrics - from instana_client.models.get_website_metrics_v2 import GetWebsiteMetricsV2 - from instana_client.models.global_application_alert_config_with_metadata import GlobalApplicationAlertConfigWithMetadata - from instana_client.models.global_applications_alert_config import GlobalApplicationsAlertConfig - from instana_client.models.google_chat_integration import GoogleChatIntegration - from instana_client.models.graph_edge import GraphEdge - from instana_client.models.graph_node import GraphNode - from instana_client.models.group import Group - from instana_client.models.group_by_tag import GroupByTag - from instana_client.models.group_mapping import GroupMapping - from instana_client.models.group_mapping_overview import GroupMappingOverview - from instana_client.models.health_state import HealthState - from instana_client.models.historic_baseline import HistoricBaseline - from instana_client.models.host_availability_rule import HostAvailabilityRule - from instana_client.models.http_action_configuration import HttpActionConfiguration - from instana_client.models.http_action_configuration_update import HttpActionConfigurationUpdate - from instana_client.models.http_endpoint_config import HttpEndpointConfig - from instana_client.models.http_endpoint_rule import HttpEndpointRule - from instana_client.models.http_path_segment_matching_rule import HttpPathSegmentMatchingRule - from instana_client.models.http_script_configuration import HttpScriptConfiguration - from instana_client.models.http_script_configuration_update import HttpScriptConfigurationUpdate - from instana_client.models.hyper_param import HyperParam - from instana_client.models.identity_provider_patch import IdentityProviderPatch - from instana_client.models.idp_status_update import IdpStatusUpdate - from instana_client.models.impacted_beacon_info import ImpactedBeaconInfo - from instana_client.models.infra_alert_config import InfraAlertConfig - from instana_client.models.infra_alert_config_with_metadata import InfraAlertConfigWithMetadata - from instana_client.models.infra_alert_rule import InfraAlertRule - from instana_client.models.infra_event_result import InfraEventResult - from instana_client.models.infra_metric_configuration import InfraMetricConfiguration - from instana_client.models.infra_slo_entity import InfraSloEntity - from instana_client.models.infra_time_threshold import InfraTimeThreshold - from instana_client.models.infrastructure_entities_result import InfrastructureEntitiesResult - from instana_client.models.infrastructure_group import InfrastructureGroup - from instana_client.models.infrastructure_groups_result import InfrastructureGroupsResult - from instana_client.models.infrastructure_item import InfrastructureItem - from instana_client.models.infrastructure_metric_result import InfrastructureMetricResult - from instana_client.models.instana_version_info import InstanaVersionInfo - from instana_client.models.integration_overview import IntegrationOverview - from instana_client.models.invitation import Invitation - from instana_client.models.invitation_response import InvitationResponse - from instana_client.models.invitation_result import InvitationResult - from instana_client.models.ip_masking_configuration import IpMaskingConfiguration - from instana_client.models.js_stack_trace_line import JsStackTraceLine - from instana_client.models.kubernetes_physical_context import KubernetesPhysicalContext - from instana_client.models.llm_egress_gateway import LLMEgressGateway - from instana_client.models.llm_gateway_capability import LLMGatewayCapability - from instana_client.models.llm_gateway_model import LLMGatewayModel - from instana_client.models.llm_gateway_service import LLMGatewayService - from instana_client.models.llm_gateway_test_connection_request import LLMGatewayTestConnectionRequest - from instana_client.models.latency_blueprint_indicator import LatencyBlueprintIndicator - from instana_client.models.llm_model_price import LlmModelPrice - from instana_client.models.llm_model_price_metadata import LlmModelPriceMetadata - from instana_client.models.location_status import LocationStatus - from instana_client.models.log_alert_config import LogAlertConfig - from instana_client.models.log_alert_config_with_metadata import LogAlertConfigWithMetadata - from instana_client.models.log_alert_rule import LogAlertRule - from instana_client.models.log_count_alert_rule import LogCountAlertRule - from instana_client.models.log_entry_actor import LogEntryActor - from instana_client.models.log_event_result import LogEventResult - from instana_client.models.log_time_threshold import LogTimeThreshold - from instana_client.models.log_volume_group import LogVolumeGroup - from instana_client.models.log_volume_usage_item import LogVolumeUsageItem - from instana_client.models.log_volume_usage_result import LogVolumeUsageResult - from instana_client.models.logs_application_alert_rule import LogsApplicationAlertRule - from instana_client.models.maintenance_config import MaintenanceConfig - from instana_client.models.maintenance_config_scheduling import MaintenanceConfigScheduling - from instana_client.models.maintenance_config_v2 import MaintenanceConfigV2 - from instana_client.models.maintenance_config_v2_with_state_and_occurrence import MaintenanceConfigV2WithStateAndOccurrence - from instana_client.models.maintenance_config_with_last_updated import MaintenanceConfigWithLastUpdated - from instana_client.models.maintenance_window import MaintenanceWindow - from instana_client.models.manual_alerting_channel_configuration import ManualAlertingChannelConfiguration - from instana_client.models.manual_close_info import ManualCloseInfo - from instana_client.models.manual_service_config import ManualServiceConfig - from instana_client.models.match_all_http_path_segment_matching_rule import MatchAllHttpPathSegmentMatchingRule - from instana_client.models.match_expression_dto import MatchExpressionDTO - from instana_client.models.meta_data import MetaData - from instana_client.models.metric_api_result import MetricAPIResult - from instana_client.models.metric_config import MetricConfig - from instana_client.models.metric_configuration import MetricConfiguration - from instana_client.models.metric_description import MetricDescription - from instana_client.models.metric_instance import MetricInstance - from instana_client.models.metric_item import MetricItem - from instana_client.models.metric_metadata import MetricMetadata - from instana_client.models.metric_pattern import MetricPattern - from instana_client.models.metric_query import MetricQuery - from instana_client.models.metrics_result import MetricsResult - from instana_client.models.metrics_result_item import MetricsResultItem - from instana_client.models.metrics_test_result_item import MetricsTestResultItem - from instana_client.models.mobile_app import MobileApp - from instana_client.models.mobile_app_alert_config import MobileAppAlertConfig - from instana_client.models.mobile_app_alert_config_with_rbac_tag import MobileAppAlertConfigWithRBACTag - from instana_client.models.mobile_app_alert_rule import MobileAppAlertRule - from instana_client.models.mobile_app_beacon_groups_item import MobileAppBeaconGroupsItem - from instana_client.models.mobile_app_beacon_groups_result import MobileAppBeaconGroupsResult - from instana_client.models.mobile_app_beacon_result import MobileAppBeaconResult - from instana_client.models.mobile_app_beacon_tag_group import MobileAppBeaconTagGroup - from instana_client.models.mobile_app_beacons_item import MobileAppBeaconsItem - from instana_client.models.mobile_app_event_result import MobileAppEventResult - from instana_client.models.mobile_app_metric_result import MobileAppMetricResult - from instana_client.models.mobile_app_monitoring_beacon import MobileAppMonitoringBeacon - from instana_client.models.mobile_app_monitoring_metric_description import MobileAppMonitoringMetricDescription - from instana_client.models.mobile_app_monitoring_metrics_configuration import MobileAppMonitoringMetricsConfiguration - from instana_client.models.mobile_app_time_threshold import MobileAppTimeThreshold - from instana_client.models.model_field import ModelField - from instana_client.models.monitored_entities_stats import MonitoredEntitiesStats - from instana_client.models.monitoring_state import MonitoringState - from instana_client.models.multiple_scripts_configuration import MultipleScriptsConfiguration - from instana_client.models.multiplication import Multiplication - from instana_client.models.ns1_integration import NS1Integration - from instana_client.models.nested_operation import NestedOperation - from instana_client.models.new_application_config import NewApplicationConfig - from instana_client.models.new_business_perspective_config import NewBusinessPerspectiveConfig - from instana_client.models.new_manual_service_config import NewManualServiceConfig - from instana_client.models.o_auth_config import OAuthConfig - from instana_client.models.o_auth_integration import OAuthIntegration - from instana_client.models.o_auth_token import OAuthToken - from instana_client.models.occurrence import Occurrence - from instana_client.models.office365_integration import Office365Integration - from instana_client.models.one_time_maintenance_window import OneTimeMaintenanceWindow - from instana_client.models.opsgenie_integration import OpsgenieIntegration - from instana_client.models.order import Order - from instana_client.models.pagerduty_integration import PagerdutyIntegration - from instana_client.models.paginated_result import PaginatedResult - from instana_client.models.pagination import Pagination - from instana_client.models.parameter import Parameter - from instana_client.models.parameter_value import ParameterValue - from instana_client.models.path_parameter_http_path_segment_matching_rule import PathParameterHttpPathSegmentMatchingRule - from instana_client.models.physical_context import PhysicalContext - from instana_client.models.plugin_result import PluginResult - from instana_client.models.policy import Policy - from instana_client.models.policy_runnable import PolicyRunnable - from instana_client.models.policy_scheduling import PolicyScheduling - from instana_client.models.post_mobile_app_source_map_config_request import PostMobileAppSourceMapConfigRequest - from instana_client.models.post_snapshots_result import PostSnapshotsResult - from instana_client.models.prefix_object import PrefixObject - from instana_client.models.problem import Problem - from instana_client.models.prometheus_webhook_integration import PrometheusWebhookIntegration - from instana_client.models.recurrent_maintenance_window import RecurrentMaintenanceWindow - from instana_client.models.release import Release - from instana_client.models.release_scope import ReleaseScope - from instana_client.models.release_with_metadata import ReleaseWithMetadata - from instana_client.models.retention_period import RetentionPeriod - from instana_client.models.rolling_time_window import RollingTimeWindow - from instana_client.models.rule_input import RuleInput - from instana_client.models.rule_with_threshold_application_alert_rule import RuleWithThresholdApplicationAlertRule - from instana_client.models.rule_with_threshold_infra_alert_rule import RuleWithThresholdInfraAlertRule - from instana_client.models.rule_with_threshold_log_alert_rule import RuleWithThresholdLogAlertRule - from instana_client.models.rule_with_threshold_mobile_app_alert_rule import RuleWithThresholdMobileAppAlertRule - from instana_client.models.rule_with_threshold_website_alert_rule import RuleWithThresholdWebsiteAlertRule - from instana_client.models.run_configuration import RunConfiguration - from instana_client.models.slo_config_with_rbac_tag import SLOConfigWithRBACTag - from instana_client.models.ssl_certificate_configuration import SSLCertificateConfiguration - from instana_client.models.ssl_certificate_configuration_update import SSLCertificateConfigurationUpdate - from instana_client.models.ssl_certificate_validation import SSLCertificateValidation - from instana_client.models.salesforce_integration import SalesforceIntegration - from instana_client.models.saturation_blueprint_indicator import SaturationBlueprintIndicator - from instana_client.models.scope_binding import ScopeBinding - from instana_client.models.search_field_result import SearchFieldResult - from instana_client.models.service import Service - from instana_client.models.service_config import ServiceConfig - from instana_client.models.service_event_result import ServiceEventResult - from instana_client.models.service_item import ServiceItem - from instana_client.models.service_level_indicator import ServiceLevelIndicator - from instana_client.models.service_level_objective_alert_rule import ServiceLevelObjectiveAlertRule - from instana_client.models.service_levels_alert_config import ServiceLevelsAlertConfig - from instana_client.models.service_levels_alert_config_with_rbac_tag import ServiceLevelsAlertConfigWithRBACTag - from instana_client.models.service_levels_alert_rule import ServiceLevelsAlertRule - from instana_client.models.service_levels_burn_rate_config import ServiceLevelsBurnRateConfig - from instana_client.models.service_levels_burn_rate_time_windows import ServiceLevelsBurnRateTimeWindows - from instana_client.models.service_levels_static_threshold_config import ServiceLevelsStaticThresholdConfig - from instana_client.models.service_levels_time_threshold import ServiceLevelsTimeThreshold - from instana_client.models.service_levelse_alert_config_with_metadata import ServiceLevelseAlertConfigWithMetadata - from instana_client.models.service_map import ServiceMap - from instana_client.models.service_map_connection import ServiceMapConnection - from instana_client.models.service_matching_rule import ServiceMatchingRule - from instana_client.models.service_metric_result import ServiceMetricResult - from instana_client.models.service_node import ServiceNode - from instana_client.models.service_now_enhanced_integration import ServiceNowEnhancedIntegration - from instana_client.models.service_now_integration import ServiceNowIntegration - from instana_client.models.service_result import ServiceResult - from instana_client.models.service_scope import ServiceScope - from instana_client.models.service_scope_with_metadata import ServiceScopeWithMetadata - from instana_client.models.service_scoped_to import ServiceScopedTo - from instana_client.models.service_scoped_to_with_metadata import ServiceScopedToWithMetadata - from instana_client.models.service_simple import ServiceSimple - from instana_client.models.session_replay_metadata import SessionReplayMetadata - from instana_client.models.session_replay_timestamps import SessionReplayTimestamps - from instana_client.models.session_settings import SessionSettings - from instana_client.models.simple_metric_configuration import SimpleMetricConfiguration - from instana_client.models.single_value import SingleValue - from instana_client.models.slack_integration import SlackIntegration - from instana_client.models.sli_configuration import SliConfiguration - from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated - from instana_client.models.sli_entity import SliEntity - from instana_client.models.sli_report import SliReport - from instana_client.models.slo_entity import SloEntity - from instana_client.models.slo_report import SloReport - from instana_client.models.slowness_application_alert_rule import SlownessApplicationAlertRule - from instana_client.models.slowness_mobile_app_alert_rule import SlownessMobileAppAlertRule - from instana_client.models.slowness_website_alert_rule import SlownessWebsiteAlertRule - from instana_client.models.snapshot_item import SnapshotItem - from instana_client.models.snapshot_preview import SnapshotPreview - from instana_client.models.snapshot_result import SnapshotResult - from instana_client.models.software_user import SoftwareUser - from instana_client.models.software_version import SoftwareVersion - from instana_client.models.source_map_file_blob import SourceMapFileBlob - from instana_client.models.source_map_file_meta import SourceMapFileMeta - from instana_client.models.source_map_upload_config import SourceMapUploadConfig - from instana_client.models.source_map_upload_configs import SourceMapUploadConfigs - from instana_client.models.span_excerpt import SpanExcerpt - from instana_client.models.span_relation import SpanRelation - from instana_client.models.specific_js_errors_website_alert_rule import SpecificJsErrorsWebsiteAlertRule - from instana_client.models.splunk_integration import SplunkIntegration - from instana_client.models.stack_trace_item import StackTraceItem - from instana_client.models.stack_trace_line import StackTraceLine - from instana_client.models.static_baseline_threshold_rule import StaticBaselineThresholdRule - from instana_client.models.static_string_field import StaticStringField - from instana_client.models.static_threshold import StaticThreshold - from instana_client.models.static_threshold_rule import StaticThresholdRule - from instana_client.models.status_code_application_alert_rule import StatusCodeApplicationAlertRule - from instana_client.models.status_code_mobile_app_alert_rule import StatusCodeMobileAppAlertRule - from instana_client.models.status_code_website_alert_rule import StatusCodeWebsiteAlertRule - from instana_client.models.subtraction import Subtraction - from instana_client.models.synthetic_alert_config import SyntheticAlertConfig - from instana_client.models.synthetic_alert_config_with_metadata import SyntheticAlertConfigWithMetadata - from instana_client.models.synthetic_alert_config_with_rbac_tag import SyntheticAlertConfigWithRBACTag - from instana_client.models.synthetic_alert_rule import SyntheticAlertRule - from instana_client.models.synthetic_bulk_response import SyntheticBulkResponse - from instana_client.models.synthetic_call_config import SyntheticCallConfig - from instana_client.models.synthetic_call_rule import SyntheticCallRule - from instana_client.models.synthetic_call_with_defaults_config import SyntheticCallWithDefaultsConfig - from instana_client.models.synthetic_configuration import SyntheticConfiguration - from instana_client.models.synthetic_configuration_update import SyntheticConfigurationUpdate - from instana_client.models.synthetic_credential import SyntheticCredential - from instana_client.models.synthetic_datacenter import SyntheticDatacenter - from instana_client.models.synthetic_datacenter_configuration import SyntheticDatacenterConfiguration - from instana_client.models.synthetic_geo_point import SyntheticGeoPoint - from instana_client.models.synthetic_location import SyntheticLocation - from instana_client.models.synthetic_location_configuration import SyntheticLocationConfiguration - from instana_client.models.synthetic_metric_configuration import SyntheticMetricConfiguration - from instana_client.models.synthetic_metric_tag_group import SyntheticMetricTagGroup - from instana_client.models.synthetic_playback_capabilities import SyntheticPlaybackCapabilities - from instana_client.models.synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value import SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue - from instana_client.models.synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation import SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation - from instana_client.models.synthetic_resource_update_list_string_list_string import SyntheticResourceUpdateListStringListString - from instana_client.models.synthetic_resource_update_map_string_string_list_string import SyntheticResourceUpdateMapStringStringListString - from instana_client.models.synthetic_slo_entity import SyntheticSloEntity - from instana_client.models.synthetic_test import SyntheticTest - from instana_client.models.synthetic_test_cicd import SyntheticTestCICD - from instana_client.models.synthetic_test_cicd_customization import SyntheticTestCICDCustomization - from instana_client.models.synthetic_test_cicd_item import SyntheticTestCICDItem - from instana_client.models.synthetic_test_cicd_response import SyntheticTestCICDResponse - from instana_client.models.synthetic_test_deep_update import SyntheticTestDeepUpdate - from instana_client.models.synthetic_test_shallow_update import SyntheticTestShallowUpdate - from instana_client.models.synthetic_test_update import SyntheticTestUpdate - from instana_client.models.synthetic_time_threshold import SyntheticTimeThreshold - from instana_client.models.synthetic_type_configuration import SyntheticTypeConfiguration - from instana_client.models.synthetic_type_configuration_update import SyntheticTypeConfigurationUpdate - from instana_client.models.synthetics_event_result import SyntheticsEventResult - from instana_client.models.system_rule import SystemRule - from instana_client.models.system_rule_label import SystemRuleLabel - from instana_client.models.tag import Tag - from instana_client.models.tag_catalog import TagCatalog - from instana_client.models.tag_filter import TagFilter - from instana_client.models.tag_filter_expression import TagFilterExpression - from instana_client.models.tag_filter_expression_element import TagFilterExpressionElement - from instana_client.models.tag_matcher_dto import TagMatcherDTO - from instana_client.models.tag_tree_level import TagTreeLevel - from instana_client.models.tag_tree_node import TagTreeNode - from instana_client.models.tag_tree_tag import TagTreeTag - from instana_client.models.test_common_properties import TestCommonProperties - from instana_client.models.test_connection_response import TestConnectionResponse - from instana_client.models.test_last_error import TestLastError - from instana_client.models.test_result import TestResult - from instana_client.models.test_result_common_properties import TestResultCommonProperties - from instana_client.models.test_result_detail_data import TestResultDetailData - from instana_client.models.test_result_item import TestResultItem - from instana_client.models.test_result_list_item import TestResultListItem - from instana_client.models.test_result_list_result import TestResultListResult - from instana_client.models.test_result_metadata import TestResultMetadata - from instana_client.models.test_result_subtransaction import TestResultSubtransaction - from instana_client.models.threshold import Threshold - from instana_client.models.threshold_config_rule import ThresholdConfigRule - from instana_client.models.threshold_rule import ThresholdRule - from instana_client.models.throughput_application_alert_rule import ThroughputApplicationAlertRule - from instana_client.models.throughput_mobile_app_alert_rule import ThroughputMobileAppAlertRule - from instana_client.models.throughput_website_alert_rule import ThroughputWebsiteAlertRule - from instana_client.models.time_frame import TimeFrame - from instana_client.models.time_window import TimeWindow - from instana_client.models.topology import Topology - from instana_client.models.trace import Trace - from instana_client.models.trace_activity_tree_node_details import TraceActivityTreeNodeDetails - from instana_client.models.trace_download_result import TraceDownloadResult - from instana_client.models.trace_groups_item import TraceGroupsItem - from instana_client.models.trace_groups_result import TraceGroupsResult - from instana_client.models.trace_impact_application_time_threshold import TraceImpactApplicationTimeThreshold - from instana_client.models.trace_item import TraceItem - from instana_client.models.trace_result import TraceResult - from instana_client.models.traffic_blueprint_indicator import TrafficBlueprintIndicator - from instana_client.models.trigger import Trigger - from instana_client.models.type_configuration import TypeConfiguration - from instana_client.models.unsupported_http_path_segment_matching_rule import UnsupportedHttpPathSegmentMatchingRule - from instana_client.models.updated_business_perspective_config import UpdatedBusinessPerspectiveConfig - from instana_client.models.usage_result import UsageResult - from instana_client.models.usage_result_items import UsageResultItems - from instana_client.models.user_basic_result import UserBasicResult - from instana_client.models.user_impact_mobile_app_time_threshold import UserImpactMobileAppTimeThreshold - from instana_client.models.user_impact_website_time_threshold import UserImpactWebsiteTimeThreshold - from instana_client.models.user_result import UserResult - from instana_client.models.users_result import UsersResult - from instana_client.models.validated_alerting_channel_input_info import ValidatedAlertingChannelInputInfo - from instana_client.models.validated_alerting_configuration import ValidatedAlertingConfiguration - from instana_client.models.validated_maintenance_config_v2_with_state_and_occurrence import ValidatedMaintenanceConfigV2WithStateAndOccurrence - from instana_client.models.validated_maintenance_config_with_status import ValidatedMaintenanceConfigWithStatus - from instana_client.models.victor_ops_integration import VictorOpsIntegration - from instana_client.models.violations_in_period_application_time_threshold import ViolationsInPeriodApplicationTimeThreshold - from instana_client.models.violations_in_period_mobile_app_time_threshold import ViolationsInPeriodMobileAppTimeThreshold - from instana_client.models.violations_in_period_website_time_threshold import ViolationsInPeriodWebsiteTimeThreshold - from instana_client.models.violations_in_sequence_application_time_threshold import ViolationsInSequenceApplicationTimeThreshold - from instana_client.models.violations_in_sequence_infra_time_threshold import ViolationsInSequenceInfraTimeThreshold - from instana_client.models.violations_in_sequence_log_time_threshold import ViolationsInSequenceLogTimeThreshold - from instana_client.models.violations_in_sequence_mobile_app_time_threshold import ViolationsInSequenceMobileAppTimeThreshold - from instana_client.models.violations_in_sequence_synthetic_time_threshold import ViolationsInSequenceSyntheticTimeThreshold - from instana_client.models.violations_in_sequence_website_time_threshold import ViolationsInSequenceWebsiteTimeThreshold - from instana_client.models.watson_ai_ops_webhook_integration import WatsonAIOpsWebhookIntegration - from instana_client.models.webex_teams_webhook_integration import WebexTeamsWebhookIntegration - from instana_client.models.webhook_integration import WebhookIntegration - from instana_client.models.webpage_action_configuration import WebpageActionConfiguration - from instana_client.models.webpage_action_configuration_update import WebpageActionConfigurationUpdate - from instana_client.models.webpage_script_configuration import WebpageScriptConfiguration - from instana_client.models.webpage_script_configuration_update import WebpageScriptConfigurationUpdate - from instana_client.models.website import Website - from instana_client.models.website_alert_config import WebsiteAlertConfig - from instana_client.models.website_alert_config_with_metadata import WebsiteAlertConfigWithMetadata - from instana_client.models.website_alert_config_with_rbac_tag import WebsiteAlertConfigWithRBACTag - from instana_client.models.website_alert_rule import WebsiteAlertRule - from instana_client.models.website_apdex_entity import WebsiteApdexEntity - from instana_client.models.website_beacon_groups_item import WebsiteBeaconGroupsItem - from instana_client.models.website_beacon_groups_result import WebsiteBeaconGroupsResult - from instana_client.models.website_beacon_result import WebsiteBeaconResult - from instana_client.models.website_beacon_tag_group import WebsiteBeaconTagGroup - from instana_client.models.website_beacons_item import WebsiteBeaconsItem - from instana_client.models.website_event_based_sli_entity import WebsiteEventBasedSliEntity - from instana_client.models.website_event_result import WebsiteEventResult - from instana_client.models.website_metric_result import WebsiteMetricResult - from instana_client.models.website_monitoring_beacon import WebsiteMonitoringBeacon - from instana_client.models.website_monitoring_metric_description import WebsiteMonitoringMetricDescription - from instana_client.models.website_monitoring_metrics_configuration import WebsiteMonitoringMetricsConfiguration - from instana_client.models.website_slo_entity import WebsiteSloEntity - from instana_client.models.website_time_based_sli_entity import WebsiteTimeBasedSliEntity - from instana_client.models.website_time_threshold import WebsiteTimeThreshold - from instana_client.models.widget import Widget - from instana_client.models.with_meta_data import WithMetaData - from instana_client.models.with_resolved_name import WithResolvedName - from instana_client.models.z_chat_ops_integration import ZChatOpsIntegration - -else: - from lazy_imports import LazyModule, as_package, load - - load( - LazyModule( - *as_package(__file__), - """# import models into model package +# import models into model package from instana_client.models.abstract_integration import AbstractIntegration from instana_client.models.abstract_rule import AbstractRule -from instana_client.models.access_log_entry import AccessLogEntry -from instana_client.models.access_log_response import AccessLogResponse from instana_client.models.access_rule import AccessRule from instana_client.models.action import Action -from instana_client.models.action_beacon import ActionBeacon from instana_client.models.action_configuration import ActionConfiguration from instana_client.models.action_instance import ActionInstance from instana_client.models.action_instance_metadata_entry import ActionInstanceMetadataEntry @@ -584,9 +29,9 @@ from instana_client.models.action_search_space import ActionSearchSpace from instana_client.models.adaptive_baseline import AdaptiveBaseline from instana_client.models.adaptive_threshold_rule import AdaptiveThresholdRule -from instana_client.models.addition import Addition from instana_client.models.adjusted_timeframe import AdjustedTimeframe from instana_client.models.agent_configuration_update import AgentConfigurationUpdate +from instana_client.models.agent_mode_update import AgentModeUpdate from instana_client.models.alerting_configuration import AlertingConfiguration from instana_client.models.alerting_configuration_with_last_updated import AlertingConfigurationWithLastUpdated from instana_client.models.alerting_time_window import AlertingTimeWindow @@ -626,10 +71,6 @@ from instana_client.models.application_sli_entity import ApplicationSliEntity from instana_client.models.application_slo_entity import ApplicationSloEntity from instana_client.models.application_time_threshold import ApplicationTimeThreshold -from instana_client.models.arithmetic_configuration import ArithmeticConfiguration -from instana_client.models.arithmetic_operand import ArithmeticOperand -from instana_client.models.arithmetic_operation import ArithmeticOperation -from instana_client.models.audit_log_entry import AuditLogEntry from instana_client.models.audit_log_ui_response import AuditLogUiResponse from instana_client.models.author import Author from instana_client.models.availability_blueprint_indicator import AvailabilityBlueprintIndicator @@ -644,6 +85,7 @@ from instana_client.models.browser_script_configuration_update import BrowserScriptConfigurationUpdate from instana_client.models.built_in_event_specification import BuiltInEventSpecification from instana_client.models.built_in_event_specification_with_last_updated import BuiltInEventSpecificationWithLastUpdated +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest from instana_client.models.business_activity import BusinessActivity from instana_client.models.business_perspective_config import BusinessPerspectiveConfig from instana_client.models.call_groups_item import CallGroupsItem @@ -687,7 +129,6 @@ from instana_client.models.dashboard_api_token import DashboardApiToken from instana_client.models.database_integration import DatabaseIntegration from instana_client.models.deprecated_tag_filter import DeprecatedTagFilter -from instana_client.models.division import Division from instana_client.models.duration import Duration from instana_client.models.dynamic_field import DynamicField from instana_client.models.dynamic_field_value import DynamicFieldValue @@ -723,7 +164,6 @@ from instana_client.models.geo_location_configuration import GeoLocationConfiguration from instana_client.models.geo_mapping_rule import GeoMappingRule from instana_client.models.geo_subdivision import GeoSubdivision -from instana_client.models.get_action_beacons_result import GetActionBeaconsResult from instana_client.models.get_activities import GetActivities from instana_client.models.get_application_metrics import GetApplicationMetrics from instana_client.models.get_applications import GetApplications @@ -742,7 +182,6 @@ from instana_client.models.get_mobile_app_metrics_v2 import GetMobileAppMetricsV2 from instana_client.models.get_payload_keys_result import GetPayloadKeysResult from instana_client.models.get_services import GetServices -from instana_client.models.get_session_replay_metadata_result import GetSessionReplayMetadataResult from instana_client.models.get_snapshots_query import GetSnapshotsQuery from instana_client.models.get_test_result import GetTestResult from instana_client.models.get_test_result_analytic import GetTestResultAnalytic @@ -776,6 +215,12 @@ from instana_client.models.http_script_configuration import HttpScriptConfiguration from instana_client.models.http_script_configuration_update import HttpScriptConfigurationUpdate from instana_client.models.hyper_param import HyperParam +from instana_client.models.icmp_configuration import ICMPConfiguration +from instana_client.models.icmp_configuration_update import ICMPConfigurationUpdate +from instana_client.models.icmp_validation import ICMPValidation +from instana_client.models.ip_filtering import IPFiltering +from instana_client.models.ip_filtering_rule_dto import IPFilteringRuleDto +from instana_client.models.ip_filtering_upsert import IPFilteringUpsert from instana_client.models.identity_provider_patch import IdentityProviderPatch from instana_client.models.idp_status_update import IdpStatusUpdate from instana_client.models.impacted_beacon_info import ImpactedBeaconInfo @@ -783,7 +228,6 @@ from instana_client.models.infra_alert_config_with_metadata import InfraAlertConfigWithMetadata from instana_client.models.infra_alert_rule import InfraAlertRule from instana_client.models.infra_event_result import InfraEventResult -from instana_client.models.infra_metric_configuration import InfraMetricConfiguration from instana_client.models.infra_slo_entity import InfraSloEntity from instana_client.models.infra_time_threshold import InfraTimeThreshold from instana_client.models.infrastructure_entities_result import InfrastructureEntitiesResult @@ -812,7 +256,6 @@ from instana_client.models.log_alert_config_with_metadata import LogAlertConfigWithMetadata from instana_client.models.log_alert_rule import LogAlertRule from instana_client.models.log_count_alert_rule import LogCountAlertRule -from instana_client.models.log_entry_actor import LogEntryActor from instana_client.models.log_event_result import LogEventResult from instana_client.models.log_time_threshold import LogTimeThreshold from instana_client.models.log_volume_group import LogVolumeGroup @@ -835,11 +278,12 @@ from instana_client.models.metric_config import MetricConfig from instana_client.models.metric_configuration import MetricConfiguration from instana_client.models.metric_description import MetricDescription +from instana_client.models.metric_field import MetricField +from instana_client.models.metric_field_value import MetricFieldValue from instana_client.models.metric_instance import MetricInstance from instana_client.models.metric_item import MetricItem from instana_client.models.metric_metadata import MetricMetadata from instana_client.models.metric_pattern import MetricPattern -from instana_client.models.metric_query import MetricQuery from instana_client.models.metrics_result import MetricsResult from instana_client.models.metrics_result_item import MetricsResultItem from instana_client.models.metrics_test_result_item import MetricsTestResultItem @@ -862,9 +306,7 @@ from instana_client.models.monitored_entities_stats import MonitoredEntitiesStats from instana_client.models.monitoring_state import MonitoringState from instana_client.models.multiple_scripts_configuration import MultipleScriptsConfiguration -from instana_client.models.multiplication import Multiplication from instana_client.models.ns1_integration import NS1Integration -from instana_client.models.nested_operation import NestedOperation from instana_client.models.new_application_config import NewApplicationConfig from instana_client.models.new_business_perspective_config import NewBusinessPerspectiveConfig from instana_client.models.new_manual_service_config import NewManualServiceConfig @@ -940,11 +382,8 @@ from instana_client.models.service_scoped_to import ServiceScopedTo from instana_client.models.service_scoped_to_with_metadata import ServiceScopedToWithMetadata from instana_client.models.service_simple import ServiceSimple -from instana_client.models.session_replay_metadata import SessionReplayMetadata -from instana_client.models.session_replay_timestamps import SessionReplayTimestamps from instana_client.models.session_settings import SessionSettings from instana_client.models.simple_metric_configuration import SimpleMetricConfiguration -from instana_client.models.single_value import SingleValue from instana_client.models.slack_integration import SlackIntegration from instana_client.models.sli_configuration import SliConfiguration from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated @@ -977,7 +416,6 @@ from instana_client.models.status_code_application_alert_rule import StatusCodeApplicationAlertRule from instana_client.models.status_code_mobile_app_alert_rule import StatusCodeMobileAppAlertRule from instana_client.models.status_code_website_alert_rule import StatusCodeWebsiteAlertRule -from instana_client.models.subtraction import Subtraction from instana_client.models.synthetic_alert_config import SyntheticAlertConfig from instana_client.models.synthetic_alert_config_with_metadata import SyntheticAlertConfigWithMetadata from instana_client.models.synthetic_alert_config_with_rbac_tag import SyntheticAlertConfigWithRBACTag @@ -998,6 +436,7 @@ from instana_client.models.synthetic_metric_tag_group import SyntheticMetricTagGroup from instana_client.models.synthetic_playback_capabilities import SyntheticPlaybackCapabilities from instana_client.models.synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value import SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue +from instana_client.models.synthetic_resource_update_list_icmp_validation_list_icmp_validation import SyntheticResourceUpdateListICMPValidationListICMPValidation from instana_client.models.synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation import SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation from instana_client.models.synthetic_resource_update_list_string_list_string import SyntheticResourceUpdateListStringListString from instana_client.models.synthetic_resource_update_map_string_string_list_string import SyntheticResourceUpdateMapStringStringListString @@ -1110,9 +549,3 @@ from instana_client.models.with_meta_data import WithMetaData from instana_client.models.with_resolved_name import WithResolvedName from instana_client.models.z_chat_ops_integration import ZChatOpsIntegration - -""", - name=__name__, - doc=__doc__, - ) - ) diff --git a/instana_client/models/abstract_integration.py b/instana_client/models/abstract_integration.py index c06ccfa..deaa6ba 100644 --- a/instana_client/models/abstract_integration.py +++ b/instana_client/models/abstract_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/abstract_rule.py b/instana_client/models/abstract_rule.py index 42f60aa..d4f8148 100644 --- a/instana_client/models/abstract_rule.py +++ b/instana_client/models/abstract_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/access_rule.py b/instana_client/models/access_rule.py index a01ad8a..755c49e 100644 --- a/instana_client/models/access_rule.py +++ b/instana_client/models/access_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/action.py b/instana_client/models/action.py index d54de87..eb9e775 100644 --- a/instana_client/models/action.py +++ b/instana_client/models/action.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/action_configuration.py b/instana_client/models/action_configuration.py index c463596..32143aa 100644 --- a/instana_client/models/action_configuration.py +++ b/instana_client/models/action_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/action_instance.py b/instana_client/models/action_instance.py index ada9c1b..d9d8ca7 100644 --- a/instana_client/models/action_instance.py +++ b/instana_client/models/action_instance.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/action_instance_metadata_entry.py b/instana_client/models/action_instance_metadata_entry.py index a810f82..da56a86 100644 --- a/instana_client/models/action_instance_metadata_entry.py +++ b/instana_client/models/action_instance_metadata_entry.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/action_instance_parameter.py b/instana_client/models/action_instance_parameter.py index e29f14d..e4e803f 100644 --- a/instana_client/models/action_instance_parameter.py +++ b/instana_client/models/action_instance_parameter.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/action_instance_request.py b/instana_client/models/action_instance_request.py index 5e87606..4e6de14 100644 --- a/instana_client/models/action_instance_request.py +++ b/instana_client/models/action_instance_request.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/action_instance_request_parameters.py b/instana_client/models/action_instance_request_parameters.py index 3f80f9c..83edd10 100644 --- a/instana_client/models/action_instance_request_parameters.py +++ b/instana_client/models/action_instance_request_parameters.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/action_match.py b/instana_client/models/action_match.py index b01262a..58fddf7 100644 --- a/instana_client/models/action_match.py +++ b/instana_client/models/action_match.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/action_search_space.py b/instana_client/models/action_search_space.py index 6ff2803..875ccb2 100644 --- a/instana_client/models/action_search_space.py +++ b/instana_client/models/action_search_space.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/adaptive_baseline.py b/instana_client/models/adaptive_baseline.py index 891ebcf..08100c4 100644 --- a/instana_client/models/adaptive_baseline.py +++ b/instana_client/models/adaptive_baseline.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/adaptive_threshold_rule.py b/instana_client/models/adaptive_threshold_rule.py index 2c46390..cc03b2f 100644 --- a/instana_client/models/adaptive_threshold_rule.py +++ b/instana_client/models/adaptive_threshold_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/adjusted_timeframe.py b/instana_client/models/adjusted_timeframe.py index 3d67e02..6a2f14d 100644 --- a/instana_client/models/adjusted_timeframe.py +++ b/instana_client/models/adjusted_timeframe.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/agent_configuration_update.py b/instana_client/models/agent_configuration_update.py index 3035c43..acf4cfb 100644 --- a/instana_client/models/agent_configuration_update.py +++ b/instana_client/models/agent_configuration_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/agent_mode_update.py b/instana_client/models/agent_mode_update.py new file mode 100644 index 0000000..87df612 --- /dev/null +++ b/instana_client/models/agent_mode_update.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class AgentModeUpdate(BaseModel): + """ + AgentModeUpdate + """ # noqa: E501 + agent_mode: Annotated[str, Field(min_length=1, strict=True)] = Field(alias="agent-mode") + mode_as_integer: Optional[StrictInt] = Field(default=None, alias="modeAsInteger") + __properties: ClassVar[List[str]] = ["agent-mode", "modeAsInteger"] + + @field_validator('agent_mode') + def agent_mode_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"APM|INFRASTRUCTURE|INFRA|OFF", value): + raise ValueError(r"must validate the regular expression /APM|INFRASTRUCTURE|INFRA|OFF/") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of AgentModeUpdate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of AgentModeUpdate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "agent-mode": obj.get("agent-mode"), + "modeAsInteger": obj.get("modeAsInteger") + }) + return _obj + + diff --git a/instana_client/models/alerting_configuration.py b/instana_client/models/alerting_configuration.py index 49315c9..5017aef 100644 --- a/instana_client/models/alerting_configuration.py +++ b/instana_client/models/alerting_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/alerting_configuration_with_last_updated.py b/instana_client/models/alerting_configuration_with_last_updated.py index b1d62c8..2091049 100644 --- a/instana_client/models/alerting_configuration_with_last_updated.py +++ b/instana_client/models/alerting_configuration_with_last_updated.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/alerting_time_window.py b/instana_client/models/alerting_time_window.py index 21b9fbd..a4efad8 100644 --- a/instana_client/models/alerting_time_window.py +++ b/instana_client/models/alerting_time_window.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/apdex_configuration.py b/instana_client/models/apdex_configuration.py index 5503f15..0eb620a 100644 --- a/instana_client/models/apdex_configuration.py +++ b/instana_client/models/apdex_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/apdex_configuration_input.py b/instana_client/models/apdex_configuration_input.py index 937fb81..1640390 100644 --- a/instana_client/models/apdex_configuration_input.py +++ b/instana_client/models/apdex_configuration_input.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/apdex_entity.py b/instana_client/models/apdex_entity.py index 0caf197..7669b8d 100644 --- a/instana_client/models/apdex_entity.py +++ b/instana_client/models/apdex_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/apdex_level.py b/instana_client/models/apdex_level.py index bb716e2..eda3f2b 100644 --- a/instana_client/models/apdex_level.py +++ b/instana_client/models/apdex_level.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/apdex_report.py b/instana_client/models/apdex_report.py index 425a052..ddea623 100644 --- a/instana_client/models/apdex_report.py +++ b/instana_client/models/apdex_report.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_create_group.py b/instana_client/models/api_create_group.py index 3fe99b5..b546b2a 100644 --- a/instana_client/models/api_create_group.py +++ b/instana_client/models/api_create_group.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_create_role.py b/instana_client/models/api_create_role.py index a1047e4..3e4907b 100644 --- a/instana_client/models/api_create_role.py +++ b/instana_client/models/api_create_role.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_group.py b/instana_client/models/api_group.py index 81b55d6..9680941 100644 --- a/instana_client/models/api_group.py +++ b/instana_client/models/api_group.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_member.py b/instana_client/models/api_member.py index 5f58820..8db53ae 100644 --- a/instana_client/models/api_member.py +++ b/instana_client/models/api_member.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_permission_set.py b/instana_client/models/api_permission_set.py index 8db169e..afa30a4 100644 --- a/instana_client/models/api_permission_set.py +++ b/instana_client/models/api_permission_set.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_restricted_application_filter.py b/instana_client/models/api_restricted_application_filter.py index f64c49c..55ea9b3 100644 --- a/instana_client/models/api_restricted_application_filter.py +++ b/instana_client/models/api_restricted_application_filter.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_role.py b/instana_client/models/api_role.py index 3c81926..6ac2217 100644 --- a/instana_client/models/api_role.py +++ b/instana_client/models/api_role.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_tag.py b/instana_client/models/api_tag.py index d165514..8912864 100644 --- a/instana_client/models/api_tag.py +++ b/instana_client/models/api_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_team.py b/instana_client/models/api_team.py index a84e45f..d88629a 100644 --- a/instana_client/models/api_team.py +++ b/instana_client/models/api_team.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_team_info.py b/instana_client/models/api_team_info.py index 44c4a28..274eed1 100644 --- a/instana_client/models/api_team_info.py +++ b/instana_client/models/api_team_info.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_team_member.py b/instana_client/models/api_team_member.py index 43a9c4b..f263baf 100644 --- a/instana_client/models/api_team_member.py +++ b/instana_client/models/api_team_member.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_team_role.py b/instana_client/models/api_team_role.py index 2e24d20..42eff56 100644 --- a/instana_client/models/api_team_role.py +++ b/instana_client/models/api_team_role.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_team_scope.py b/instana_client/models/api_team_scope.py index 0897658..4d38598 100644 --- a/instana_client/models/api_team_scope.py +++ b/instana_client/models/api_team_scope.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -52,8 +52,8 @@ def access_permissions_validate_enum(cls, value): return value for i in value: - if i not in set(['LIMITED_APPLICATIONS_SCOPE', 'LIMITED_WEBSITES_SCOPE', 'LIMITED_KUBERNETES_SCOPE', 'LIMITED_MOBILE_APPS_SCOPE', 'LIMITED_INFRASTRUCTURE_SCOPE', 'LIMITED_SYNTHETICS_SCOPE', 'LIMITED_BIZOPS_SCOPE', 'LIMITED_GEN_AI_SCOPE', 'LIMITED_AUTOMATION_SCOPE', 'LIMITED_LOGS_SCOPE', 'LIMITED_ALERT_CHANNELS_SCOPE', 'LIMITED_VSPHERE_SCOPE', 'LIMITED_PHMC_SCOPE', 'LIMITED_POWERVC_SCOPE', 'LIMITED_ZHMC_SCOPE', 'LIMITED_PCF_SCOPE', 'LIMITED_OPENSTACK_SCOPE', 'LIMITED_SAP_SCOPE', 'LIMITED_NUTANIX_SCOPE', 'LIMITED_XENSERVER_SCOPE', 'LIMITED_WINDOWS_HYPERVISOR_SCOPE', 'LIMITED_LINUX_KVM_HYPERVISOR_SCOPE', 'LIMITED_AI_GATEWAY_SCOPE', 'LIMITED_SERVICE_LEVEL_SCOPE']): - raise ValueError("each list item must be one of ('LIMITED_APPLICATIONS_SCOPE', 'LIMITED_WEBSITES_SCOPE', 'LIMITED_KUBERNETES_SCOPE', 'LIMITED_MOBILE_APPS_SCOPE', 'LIMITED_INFRASTRUCTURE_SCOPE', 'LIMITED_SYNTHETICS_SCOPE', 'LIMITED_BIZOPS_SCOPE', 'LIMITED_GEN_AI_SCOPE', 'LIMITED_AUTOMATION_SCOPE', 'LIMITED_LOGS_SCOPE', 'LIMITED_ALERT_CHANNELS_SCOPE', 'LIMITED_VSPHERE_SCOPE', 'LIMITED_PHMC_SCOPE', 'LIMITED_POWERVC_SCOPE', 'LIMITED_ZHMC_SCOPE', 'LIMITED_PCF_SCOPE', 'LIMITED_OPENSTACK_SCOPE', 'LIMITED_SAP_SCOPE', 'LIMITED_NUTANIX_SCOPE', 'LIMITED_XENSERVER_SCOPE', 'LIMITED_WINDOWS_HYPERVISOR_SCOPE', 'LIMITED_LINUX_KVM_HYPERVISOR_SCOPE', 'LIMITED_AI_GATEWAY_SCOPE', 'LIMITED_SERVICE_LEVEL_SCOPE')") + if i not in set(['LIMITED_APPLICATIONS_SCOPE', 'LIMITED_WEBSITES_SCOPE', 'LIMITED_KUBERNETES_SCOPE', 'LIMITED_MOBILE_APPS_SCOPE', 'LIMITED_INFRASTRUCTURE_SCOPE', 'LIMITED_SYNTHETICS_SCOPE', 'LIMITED_BIZOPS_SCOPE', 'LIMITED_GEN_AI_SCOPE', 'LIMITED_AUTOMATION_SCOPE', 'LIMITED_LOGS_SCOPE', 'LIMITED_ALERT_CHANNELS_SCOPE', 'LIMITED_VSPHERE_SCOPE', 'LIMITED_PHMC_SCOPE', 'LIMITED_POWERVC_SCOPE', 'LIMITED_ZHMC_SCOPE', 'LIMITED_PCF_SCOPE', 'LIMITED_OPENSTACK_SCOPE', 'LIMITED_SAP_SCOPE', 'LIMITED_NUTANIX_SCOPE', 'LIMITED_XENSERVER_SCOPE', 'LIMITED_WINDOWS_HYPERVISOR_SCOPE', 'LIMITED_LINUX_KVM_HYPERVISOR_SCOPE', 'LIMITED_AI_GATEWAY_SCOPE', 'LIMITED_SERVICE_LEVEL_SCOPE', 'LIMITED_GEN_AI_CAPABILITIES_SCOPE']): + raise ValueError("each list item must be one of ('LIMITED_APPLICATIONS_SCOPE', 'LIMITED_WEBSITES_SCOPE', 'LIMITED_KUBERNETES_SCOPE', 'LIMITED_MOBILE_APPS_SCOPE', 'LIMITED_INFRASTRUCTURE_SCOPE', 'LIMITED_SYNTHETICS_SCOPE', 'LIMITED_BIZOPS_SCOPE', 'LIMITED_GEN_AI_SCOPE', 'LIMITED_AUTOMATION_SCOPE', 'LIMITED_LOGS_SCOPE', 'LIMITED_ALERT_CHANNELS_SCOPE', 'LIMITED_VSPHERE_SCOPE', 'LIMITED_PHMC_SCOPE', 'LIMITED_POWERVC_SCOPE', 'LIMITED_ZHMC_SCOPE', 'LIMITED_PCF_SCOPE', 'LIMITED_OPENSTACK_SCOPE', 'LIMITED_SAP_SCOPE', 'LIMITED_NUTANIX_SCOPE', 'LIMITED_XENSERVER_SCOPE', 'LIMITED_WINDOWS_HYPERVISOR_SCOPE', 'LIMITED_LINUX_KVM_HYPERVISOR_SCOPE', 'LIMITED_AI_GATEWAY_SCOPE', 'LIMITED_SERVICE_LEVEL_SCOPE', 'LIMITED_GEN_AI_CAPABILITIES_SCOPE')") return value model_config = ConfigDict( diff --git a/instana_client/models/api_token.py b/instana_client/models/api_token.py index 9c3b9f8..9d458a6 100644 --- a/instana_client/models/api_token.py +++ b/instana_client/models/api_token.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -109,6 +109,7 @@ class ApiToken(BaseModel): limited_applications_scope: Optional[StrictBool] = Field(default=None, alias="limitedApplicationsScope") limited_automation_scope: Optional[StrictBool] = Field(default=None, alias="limitedAutomationScope") limited_biz_ops_scope: Optional[StrictBool] = Field(default=None, alias="limitedBizOpsScope") + limited_gen_ai_capabilities_scope: Optional[StrictBool] = Field(default=None, alias="limitedGenAICapabilitiesScope") limited_gen_ai_scope: Optional[StrictBool] = Field(default=None, alias="limitedGenAIScope") limited_infrastructure_scope: Optional[StrictBool] = Field(default=None, alias="limitedInfrastructureScope") limited_kubernetes_scope: Optional[StrictBool] = Field(default=None, alias="limitedKubernetesScope") @@ -129,7 +130,7 @@ class ApiToken(BaseModel): limited_xen_server_scope: Optional[StrictBool] = Field(default=None, alias="limitedXenServerScope") limited_zhmc_scope: Optional[StrictBool] = Field(default=None, alias="limitedZhmcScope") name: Annotated[str, Field(min_length=1, strict=True)] - __properties: ClassVar[List[str]] = ["accessGrantingToken", "canConfigureAgentRunMode", "canConfigureAgents", "canConfigureAiAgents", "canConfigureApdex", "canConfigureApiTokens", "canConfigureApplicationSmartAlerts", "canConfigureApplications", "canConfigureAuthenticationMethods", "canConfigureAutomationActions", "canConfigureAutomationPolicies", "canConfigureBizops", "canConfigureCustomEntities", "canConfigureDatabaseManagement", "canConfigureEumApplications", "canConfigureEventsAndAlerts", "canConfigureGlobalAlertPayload", "canConfigureGlobalApplicationSmartAlerts", "canConfigureGlobalInfraSmartAlerts", "canConfigureGlobalLogSmartAlerts", "canConfigureGlobalSyntheticSmartAlerts", "canConfigureIPFiltering", "canConfigureIntegrations", "canConfigureLLM", "canConfigureLLMModelPrice", "canConfigureLogManagement", "canConfigureLogRetentionPeriod", "canConfigureMaintenanceWindows", "canConfigureMobileAppMonitoring", "canConfigureMobileAppSmartAlerts", "canConfigurePersonalApiTokens", "canConfigurePersonallyIdentifiableInformationMasking", "canConfigureReleases", "canConfigureServiceLevelCorrectionWindows", "canConfigureServiceLevelSmartAlerts", "canConfigureServiceLevels", "canConfigureServiceMapping", "canConfigureSessionSettings", "canConfigureSubtraces", "canConfigureSyntheticCredentials", "canConfigureSyntheticLocations", "canConfigureSyntheticTests", "canConfigureTeams", "canConfigureUsers", "canConfigureWebsiteConversions", "canConfigureWebsiteSmartAlerts", "canCreateHeapDump", "canCreatePublicCustomDashboards", "canCreateThreadDump", "canDeleteAutomationActionHistory", "canDeleteLogs", "canDownloadAgentConfiguration", "canEditAllAccessibleCustomDashboards", "canInstallNewAgents", "canInvokeAlertChannel", "canManuallyCloseIssue", "canRunAutomationActions", "canUseSyntheticCredentials", "canViewAccountAndBillingInformation", "canViewAuditLog", "canViewBizAlerts", "canViewBusinessActivities", "canViewBusinessProcessDetails", "canViewBusinessProcesses", "canViewLogVolume", "canViewLogs", "canViewSyntheticLocations", "canViewSyntheticTestResults", "canViewSyntheticTests", "canViewTraceDetails", "createdBy", "createdOn", "expiresOn", "id", "internalId", "lastUsedOn", "limitedAiGatewayScope", "limitedAlertChannelsScope", "limitedApplicationsScope", "limitedAutomationScope", "limitedBizOpsScope", "limitedGenAIScope", "limitedInfrastructureScope", "limitedKubernetesScope", "limitedLinuxKVMHypervisorScope", "limitedLogsScope", "limitedMobileAppsScope", "limitedNutanixScope", "limitedOpenstackScope", "limitedPcfScope", "limitedPhmcScope", "limitedPvcScope", "limitedSAPScope", "limitedServiceLevelScope", "limitedSyntheticsScope", "limitedVsphereScope", "limitedWebsitesScope", "limitedWindowsHypervisorScope", "limitedXenServerScope", "limitedZhmcScope", "name"] + __properties: ClassVar[List[str]] = ["accessGrantingToken", "canConfigureAgentRunMode", "canConfigureAgents", "canConfigureAiAgents", "canConfigureApdex", "canConfigureApiTokens", "canConfigureApplicationSmartAlerts", "canConfigureApplications", "canConfigureAuthenticationMethods", "canConfigureAutomationActions", "canConfigureAutomationPolicies", "canConfigureBizops", "canConfigureCustomEntities", "canConfigureDatabaseManagement", "canConfigureEumApplications", "canConfigureEventsAndAlerts", "canConfigureGlobalAlertPayload", "canConfigureGlobalApplicationSmartAlerts", "canConfigureGlobalInfraSmartAlerts", "canConfigureGlobalLogSmartAlerts", "canConfigureGlobalSyntheticSmartAlerts", "canConfigureIPFiltering", "canConfigureIntegrations", "canConfigureLLM", "canConfigureLLMModelPrice", "canConfigureLogManagement", "canConfigureLogRetentionPeriod", "canConfigureMaintenanceWindows", "canConfigureMobileAppMonitoring", "canConfigureMobileAppSmartAlerts", "canConfigurePersonalApiTokens", "canConfigurePersonallyIdentifiableInformationMasking", "canConfigureReleases", "canConfigureServiceLevelCorrectionWindows", "canConfigureServiceLevelSmartAlerts", "canConfigureServiceLevels", "canConfigureServiceMapping", "canConfigureSessionSettings", "canConfigureSubtraces", "canConfigureSyntheticCredentials", "canConfigureSyntheticLocations", "canConfigureSyntheticTests", "canConfigureTeams", "canConfigureUsers", "canConfigureWebsiteConversions", "canConfigureWebsiteSmartAlerts", "canCreateHeapDump", "canCreatePublicCustomDashboards", "canCreateThreadDump", "canDeleteAutomationActionHistory", "canDeleteLogs", "canDownloadAgentConfiguration", "canEditAllAccessibleCustomDashboards", "canInstallNewAgents", "canInvokeAlertChannel", "canManuallyCloseIssue", "canRunAutomationActions", "canUseSyntheticCredentials", "canViewAccountAndBillingInformation", "canViewAuditLog", "canViewBizAlerts", "canViewBusinessActivities", "canViewBusinessProcessDetails", "canViewBusinessProcesses", "canViewLogVolume", "canViewLogs", "canViewSyntheticLocations", "canViewSyntheticTestResults", "canViewSyntheticTests", "canViewTraceDetails", "createdBy", "createdOn", "expiresOn", "id", "internalId", "lastUsedOn", "limitedAiGatewayScope", "limitedAlertChannelsScope", "limitedApplicationsScope", "limitedAutomationScope", "limitedBizOpsScope", "limitedGenAICapabilitiesScope", "limitedGenAIScope", "limitedInfrastructureScope", "limitedKubernetesScope", "limitedLinuxKVMHypervisorScope", "limitedLogsScope", "limitedMobileAppsScope", "limitedNutanixScope", "limitedOpenstackScope", "limitedPcfScope", "limitedPhmcScope", "limitedPvcScope", "limitedSAPScope", "limitedServiceLevelScope", "limitedSyntheticsScope", "limitedVsphereScope", "limitedWebsitesScope", "limitedWindowsHypervisorScope", "limitedXenServerScope", "limitedZhmcScope", "name"] model_config = ConfigDict( populate_by_name=True, @@ -263,6 +264,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "limitedApplicationsScope": obj.get("limitedApplicationsScope"), "limitedAutomationScope": obj.get("limitedAutomationScope"), "limitedBizOpsScope": obj.get("limitedBizOpsScope"), + "limitedGenAICapabilitiesScope": obj.get("limitedGenAICapabilitiesScope"), "limitedGenAIScope": obj.get("limitedGenAIScope"), "limitedInfrastructureScope": obj.get("limitedInfrastructureScope"), "limitedKubernetesScope": obj.get("limitedKubernetesScope"), diff --git a/instana_client/models/app_data_metric_configuration.py b/instana_client/models/app_data_metric_configuration.py index 7482718..ddc7097 100644 --- a/instana_client/models/app_data_metric_configuration.py +++ b/instana_client/models/app_data_metric_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application.py b/instana_client/models/application.py index be1db7a..6c80671 100644 --- a/instana_client/models/application.py +++ b/instana_client/models/application.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_alert_config.py b/instana_client/models/application_alert_config.py index 14d623e..c28fce0 100644 --- a/instana_client/models/application_alert_config.py +++ b/instana_client/models/application_alert_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_alert_config_with_metadata.py b/instana_client/models/application_alert_config_with_metadata.py index 4defa53..ac8131a 100644 --- a/instana_client/models/application_alert_config_with_metadata.py +++ b/instana_client/models/application_alert_config_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_alert_rule.py b/instana_client/models/application_alert_rule.py index 49f7f4f..d8d99eb 100644 --- a/instana_client/models/application_alert_rule.py +++ b/instana_client/models/application_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_apdex_entity.py b/instana_client/models/application_apdex_entity.py index b58dbdb..4d90fcd 100644 --- a/instana_client/models/application_apdex_entity.py +++ b/instana_client/models/application_apdex_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_config.py b/instana_client/models/application_config.py index 9ec5861..0cc8354 100644 --- a/instana_client/models/application_config.py +++ b/instana_client/models/application_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_event_result.py b/instana_client/models/application_event_result.py index 3d5a9ce..a3a9fbe 100644 --- a/instana_client/models/application_event_result.py +++ b/instana_client/models/application_event_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_item.py b/instana_client/models/application_item.py index 096182d..2b01d96 100644 --- a/instana_client/models/application_item.py +++ b/instana_client/models/application_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_metric_result.py b/instana_client/models/application_metric_result.py index a283306..2d56aa1 100644 --- a/instana_client/models/application_metric_result.py +++ b/instana_client/models/application_metric_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_node.py b/instana_client/models/application_node.py index 90682b6..67d10af 100644 --- a/instana_client/models/application_node.py +++ b/instana_client/models/application_node.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_result.py b/instana_client/models/application_result.py index c76aa93..b7152a1 100644 --- a/instana_client/models/application_result.py +++ b/instana_client/models/application_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_scope.py b/instana_client/models/application_scope.py index 79d99a5..8d832ec 100644 --- a/instana_client/models/application_scope.py +++ b/instana_client/models/application_scope.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_scope_with_metadata.py b/instana_client/models/application_scope_with_metadata.py index b2d6ab3..3907758 100644 --- a/instana_client/models/application_scope_with_metadata.py +++ b/instana_client/models/application_scope_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_sli_entity.py b/instana_client/models/application_sli_entity.py index f0274a7..5423d93 100644 --- a/instana_client/models/application_sli_entity.py +++ b/instana_client/models/application_sli_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_slo_entity.py b/instana_client/models/application_slo_entity.py index 98d0bf5..1c76aad 100644 --- a/instana_client/models/application_slo_entity.py +++ b/instana_client/models/application_slo_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/application_time_threshold.py b/instana_client/models/application_time_threshold.py index f2f014b..2ef8aae 100644 --- a/instana_client/models/application_time_threshold.py +++ b/instana_client/models/application_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/audit_log_ui_response.py b/instana_client/models/audit_log_ui_response.py index c40dad5..c60b215 100644 --- a/instana_client/models/audit_log_ui_response.py +++ b/instana_client/models/audit_log_ui_response.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -20,7 +20,6 @@ from pydantic import BaseModel, ConfigDict, StrictInt from typing import Any, ClassVar, Dict, List, Optional -from instana_client.models.audit_log_entry import AuditLogEntry from typing import Optional, Set from typing_extensions import Self @@ -28,7 +27,7 @@ class AuditLogUiResponse(BaseModel): """ AuditLogUiResponse """ # noqa: E501 - entries: Optional[List[AuditLogEntry]] = None + entries: Optional[List[Dict[str, Any]]] = None total: Optional[StrictInt] = None __properties: ClassVar[List[str]] = ["entries", "total"] @@ -71,13 +70,6 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of each item in entries (list) - _items = [] - if self.entries: - for _item_entries in self.entries: - if _item_entries: - _items.append(_item_entries.to_dict()) - _dict['entries'] = _items return _dict @classmethod @@ -90,7 +82,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "entries": [AuditLogEntry.from_dict(_item) for _item in obj["entries"]] if obj.get("entries") is not None else None, + "entries": obj.get("entries"), "total": obj.get("total") }) return _obj diff --git a/instana_client/models/author.py b/instana_client/models/author.py index 4f5a2bd..815fc5b 100644 --- a/instana_client/models/author.py +++ b/instana_client/models/author.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/availability_blueprint_indicator.py b/instana_client/models/availability_blueprint_indicator.py index fcb2179..4bd4182 100644 --- a/instana_client/models/availability_blueprint_indicator.py +++ b/instana_client/models/availability_blueprint_indicator.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/availability_sli_entity.py b/instana_client/models/availability_sli_entity.py index 3459c40..cc637a9 100644 --- a/instana_client/models/availability_sli_entity.py +++ b/instana_client/models/availability_sli_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/available_metrics.py b/instana_client/models/available_metrics.py index ceea67b..95737b6 100644 --- a/instana_client/models/available_metrics.py +++ b/instana_client/models/available_metrics.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/available_plugins.py b/instana_client/models/available_plugins.py index 630d49e..93614fc 100644 --- a/instana_client/models/available_plugins.py +++ b/instana_client/models/available_plugins.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/backend_trace_reference.py b/instana_client/models/backend_trace_reference.py index b62a0ad..5cb6459 100644 --- a/instana_client/models/backend_trace_reference.py +++ b/instana_client/models/backend_trace_reference.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/bidirectional_ms_teams_app_integration.py b/instana_client/models/bidirectional_ms_teams_app_integration.py index 30ab587..a5b23cb 100644 --- a/instana_client/models/bidirectional_ms_teams_app_integration.py +++ b/instana_client/models/bidirectional_ms_teams_app_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/bidirectional_slack_app_integration.py b/instana_client/models/bidirectional_slack_app_integration.py index 9355988..374cf1a 100644 --- a/instana_client/models/bidirectional_slack_app_integration.py +++ b/instana_client/models/bidirectional_slack_app_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/binary_operator_dto.py b/instana_client/models/binary_operator_dto.py index ad97f42..482dd23 100644 --- a/instana_client/models/binary_operator_dto.py +++ b/instana_client/models/binary_operator_dto.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/browser_script_configuration.py b/instana_client/models/browser_script_configuration.py index dd65547..25f4f04 100644 --- a/instana_client/models/browser_script_configuration.py +++ b/instana_client/models/browser_script_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/browser_script_configuration_update.py b/instana_client/models/browser_script_configuration_update.py index 3219b10..da9bed6 100644 --- a/instana_client/models/browser_script_configuration_update.py +++ b/instana_client/models/browser_script_configuration_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/built_in_event_specification.py b/instana_client/models/built_in_event_specification.py index 456460a..56050aa 100644 --- a/instana_client/models/built_in_event_specification.py +++ b/instana_client/models/built_in_event_specification.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -39,8 +39,9 @@ class BuiltInEventSpecification(BaseModel): rule_inputs: Annotated[List[RuleInput], Field(min_length=0, max_length=32)] = Field(description="List of input rules of the Built-in Event Specification", alias="ruleInputs") severity: Optional[StrictInt] = Field(default=None, description="Severity level of Built-in Event Specification") short_plugin_id: Annotated[str, Field(min_length=0, strict=True, max_length=64)] = Field(description="ID of short plugin of Built-in Event Specification", alias="shortPluginId") + supported_poll_rate_seconds: Optional[StrictInt] = Field(default=None, alias="supportedPollRateSeconds") triggering: Optional[StrictBool] = Field(default=None, description="Flag to show whether the Built-in Event Specification is triggering") - __properties: ClassVar[List[str]] = ["description", "enabled", "hidden", "hyperParams", "id", "name", "ruleInputs", "severity", "shortPluginId", "triggering"] + __properties: ClassVar[List[str]] = ["description", "enabled", "hidden", "hyperParams", "id", "name", "ruleInputs", "severity", "shortPluginId", "supportedPollRateSeconds", "triggering"] model_config = ConfigDict( populate_by_name=True, @@ -116,6 +117,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "ruleInputs": [RuleInput.from_dict(_item) for _item in obj["ruleInputs"]] if obj.get("ruleInputs") is not None else None, "severity": obj.get("severity"), "shortPluginId": obj.get("shortPluginId"), + "supportedPollRateSeconds": obj.get("supportedPollRateSeconds"), "triggering": obj.get("triggering") }) return _obj diff --git a/instana_client/models/built_in_event_specification_with_last_updated.py b/instana_client/models/built_in_event_specification_with_last_updated.py index 4e07584..2cb138c 100644 --- a/instana_client/models/built_in_event_specification_with_last_updated.py +++ b/instana_client/models/built_in_event_specification_with_last_updated.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -40,8 +40,9 @@ class BuiltInEventSpecificationWithLastUpdated(BaseModel): rule_inputs: Annotated[List[RuleInput], Field(min_length=0, max_length=32)] = Field(description="List of input rules of the Built-in Event Specification", alias="ruleInputs") severity: Optional[StrictInt] = Field(default=None, description="Severity level of Built-in Event Specification") short_plugin_id: Annotated[str, Field(min_length=0, strict=True, max_length=64)] = Field(description="ID of short plugin of Built-in Event Specification", alias="shortPluginId") + supported_poll_rate_seconds: Optional[StrictInt] = Field(default=None, alias="supportedPollRateSeconds") triggering: Optional[StrictBool] = Field(default=None, description="Flag to show whether the Built-in Event Specification is triggering") - __properties: ClassVar[List[str]] = ["description", "enabled", "hidden", "hyperParams", "id", "lastUpdated", "name", "ruleInputs", "severity", "shortPluginId", "triggering"] + __properties: ClassVar[List[str]] = ["description", "enabled", "hidden", "hyperParams", "id", "lastUpdated", "name", "ruleInputs", "severity", "shortPluginId", "supportedPollRateSeconds", "triggering"] model_config = ConfigDict( populate_by_name=True, @@ -118,6 +119,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "ruleInputs": [RuleInput.from_dict(_item) for _item in obj["ruleInputs"]] if obj.get("ruleInputs") is not None else None, "severity": obj.get("severity"), "shortPluginId": obj.get("shortPluginId"), + "supportedPollRateSeconds": obj.get("supportedPollRateSeconds"), "triggering": obj.get("triggering") }) return _obj diff --git a/instana_client/models/bulk_alert_config_request.py b/instana_client/models/bulk_alert_config_request.py new file mode 100644 index 0000000..6312e2c --- /dev/null +++ b/instana_client/models/bulk_alert_config_request.py @@ -0,0 +1,88 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class BulkAlertConfigRequest(BaseModel): + """ + BulkAlertConfigRequest + """ # noqa: E501 + configs: Dict[str, List[StrictStr]] + __properties: ClassVar[List[str]] = ["configs"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of BulkAlertConfigRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of BulkAlertConfigRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "configs": obj.get("configs") + }) + return _obj + + diff --git a/instana_client/models/business_activity.py b/instana_client/models/business_activity.py index fcd9d20..1765743 100644 --- a/instana_client/models/business_activity.py +++ b/instana_client/models/business_activity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/business_perspective_config.py b/instana_client/models/business_perspective_config.py index a2ea918..9f32663 100644 --- a/instana_client/models/business_perspective_config.py +++ b/instana_client/models/business_perspective_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/call_groups_item.py b/instana_client/models/call_groups_item.py index fb063ee..c9b1068 100644 --- a/instana_client/models/call_groups_item.py +++ b/instana_client/models/call_groups_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/call_groups_result.py b/instana_client/models/call_groups_result.py index d815938..d98e417 100644 --- a/instana_client/models/call_groups_result.py +++ b/instana_client/models/call_groups_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/call_relation.py b/instana_client/models/call_relation.py index 3284f48..9fde79f 100644 --- a/instana_client/models/call_relation.py +++ b/instana_client/models/call_relation.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/change_summary.py b/instana_client/models/change_summary.py index f27c8a9..8306007 100644 --- a/instana_client/models/change_summary.py +++ b/instana_client/models/change_summary.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/cloudfoundry_physical_context.py b/instana_client/models/cloudfoundry_physical_context.py index f7a50d7..3af347b 100644 --- a/instana_client/models/cloudfoundry_physical_context.py +++ b/instana_client/models/cloudfoundry_physical_context.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/condition.py b/instana_client/models/condition.py index 76402d2..adfa8a8 100644 --- a/instana_client/models/condition.py +++ b/instana_client/models/condition.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/config_version.py b/instana_client/models/config_version.py index e0045cb..967a02c 100644 --- a/instana_client/models/config_version.py +++ b/instana_client/models/config_version.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/correction.py b/instana_client/models/correction.py index dd820bf..b5868c4 100644 --- a/instana_client/models/correction.py +++ b/instana_client/models/correction.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/correction_configuration.py b/instana_client/models/correction_configuration.py index 70f780f..0f1ab68 100644 --- a/instana_client/models/correction_configuration.py +++ b/instana_client/models/correction_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/correction_scheduling.py b/instana_client/models/correction_scheduling.py index 2bd45f1..6327760 100644 --- a/instana_client/models/correction_scheduling.py +++ b/instana_client/models/correction_scheduling.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/correction_window.py b/instana_client/models/correction_window.py index 4f3b0e0..4fae657 100644 --- a/instana_client/models/correction_window.py +++ b/instana_client/models/correction_window.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/crash_mobile_app_alert_rule.py b/instana_client/models/crash_mobile_app_alert_rule.py index f69117b..f4f4d9f 100644 --- a/instana_client/models/crash_mobile_app_alert_rule.py +++ b/instana_client/models/crash_mobile_app_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/create_website_request_inner.py b/instana_client/models/create_website_request_inner.py index bdf2972..29a0547 100644 --- a/instana_client/models/create_website_request_inner.py +++ b/instana_client/models/create_website_request_inner.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/cursor_paginated_business_activity_item.py b/instana_client/models/cursor_paginated_business_activity_item.py index 240d28d..28db88b 100644 --- a/instana_client/models/cursor_paginated_business_activity_item.py +++ b/instana_client/models/cursor_paginated_business_activity_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/cursor_pagination.py b/instana_client/models/cursor_pagination.py index 05e0f87..de64cd8 100644 --- a/instana_client/models/cursor_pagination.py +++ b/instana_client/models/cursor_pagination.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/cursor_pagination_with_ui_cursor_infra_explore_cursor.py b/instana_client/models/cursor_pagination_with_ui_cursor_infra_explore_cursor.py index 3213259..67f6ecf 100644 --- a/instana_client/models/cursor_pagination_with_ui_cursor_infra_explore_cursor.py +++ b/instana_client/models/cursor_pagination_with_ui_cursor_infra_explore_cursor.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_blueprint_indicator.py b/instana_client/models/custom_blueprint_indicator.py index c9d7dd5..a1af3c6 100644 --- a/instana_client/models/custom_blueprint_indicator.py +++ b/instana_client/models/custom_blueprint_indicator.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_dashboard.py b/instana_client/models/custom_dashboard.py index 6dcdf7e..fca8ed7 100644 --- a/instana_client/models/custom_dashboard.py +++ b/instana_client/models/custom_dashboard.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_dashboard_preview.py b/instana_client/models/custom_dashboard_preview.py index 18a7da4..ee6431e 100644 --- a/instana_client/models/custom_dashboard_preview.py +++ b/instana_client/models/custom_dashboard_preview.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_dashboard_with_user_specific_information.py b/instana_client/models/custom_dashboard_with_user_specific_information.py index fb8cb41..21654bd 100644 --- a/instana_client/models/custom_dashboard_with_user_specific_information.py +++ b/instana_client/models/custom_dashboard_with_user_specific_information.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_dependency.py b/instana_client/models/custom_dependency.py index cfa3bb7..696db54 100644 --- a/instana_client/models/custom_dependency.py +++ b/instana_client/models/custom_dependency.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_email_subject_prefix.py b/instana_client/models/custom_email_subject_prefix.py index b850bd1..42756f3 100644 --- a/instana_client/models/custom_email_subject_prefix.py +++ b/instana_client/models/custom_email_subject_prefix.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_entity_model.py b/instana_client/models/custom_entity_model.py index 1977497..a0f6b38 100644 --- a/instana_client/models/custom_entity_model.py +++ b/instana_client/models/custom_entity_model.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -38,9 +38,10 @@ class CustomEntityModel(BaseModel): identifiers: List[StrictStr] label: Annotated[str, Field(min_length=1, strict=True)] metrics: Optional[List[CustomMetric]] = None + name: Optional[StrictStr] = None tag_filter_expression: TagFilterExpressionElement = Field(alias="tagFilterExpression") tags: Optional[List[CustomTag]] = None - __properties: ClassVar[List[str]] = ["dashboards", "dependencies", "identifiers", "label", "metrics", "tagFilterExpression", "tags"] + __properties: ClassVar[List[str]] = ["dashboards", "dependencies", "identifiers", "label", "metrics", "name", "tagFilterExpression", "tags"] model_config = ConfigDict( populate_by_name=True, @@ -129,6 +130,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "identifiers": obj.get("identifiers"), "label": obj.get("label"), "metrics": [CustomMetric.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None, + "name": obj.get("name"), "tagFilterExpression": TagFilterExpressionElement.from_dict(obj["tagFilterExpression"]) if obj.get("tagFilterExpression") is not None else None, "tags": [CustomTag.from_dict(_item) for _item in obj["tags"]] if obj.get("tags") is not None else None }) diff --git a/instana_client/models/custom_entity_with_metadata.py b/instana_client/models/custom_entity_with_metadata.py index 3ea250e..ade1676 100644 --- a/instana_client/models/custom_entity_with_metadata.py +++ b/instana_client/models/custom_entity_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_event_mobile_app_alert_rule.py b/instana_client/models/custom_event_mobile_app_alert_rule.py index 2f20f55..4f5e5c5 100644 --- a/instana_client/models/custom_event_mobile_app_alert_rule.py +++ b/instana_client/models/custom_event_mobile_app_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_event_specification.py b/instana_client/models/custom_event_specification.py index f614d6f..a5e0221 100644 --- a/instana_client/models/custom_event_specification.py +++ b/instana_client/models/custom_event_specification.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_event_specification_with_last_updated.py b/instana_client/models/custom_event_specification_with_last_updated.py index df2e818..7433a57 100644 --- a/instana_client/models/custom_event_specification_with_last_updated.py +++ b/instana_client/models/custom_event_specification_with_last_updated.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_event_website_alert_rule.py b/instana_client/models/custom_event_website_alert_rule.py index 142a12c..1f63e43 100644 --- a/instana_client/models/custom_event_website_alert_rule.py +++ b/instana_client/models/custom_event_website_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_metric.py b/instana_client/models/custom_metric.py index aca95ce..0651a34 100644 --- a/instana_client/models/custom_metric.py +++ b/instana_client/models/custom_metric.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_payload_configuration.py b/instana_client/models/custom_payload_configuration.py index 7abb075..d87322c 100644 --- a/instana_client/models/custom_payload_configuration.py +++ b/instana_client/models/custom_payload_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_payload_field.py b/instana_client/models/custom_payload_field.py index 3b73ecf..d2b810d 100644 --- a/instana_client/models/custom_payload_field.py +++ b/instana_client/models/custom_payload_field.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -28,6 +28,7 @@ from typing import TYPE_CHECKING if TYPE_CHECKING: from instana_client.models.dynamic_field import DynamicField + from instana_client.models.metric_field import MetricField from instana_client.models.static_string_field import StaticStringField class CustomPayloadField(BaseModel): @@ -50,7 +51,7 @@ class CustomPayloadField(BaseModel): # discriminator mappings __discriminator_value_class_map: ClassVar[Dict[str, str]] = { - 'dynamic': 'DynamicField','staticString': 'StaticStringField' + 'dynamic': 'DynamicField','metricField': 'MetricField','staticString': 'StaticStringField' } @classmethod @@ -72,7 +73,7 @@ def to_json(self) -> str: return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> Optional[Union[DynamicField, StaticStringField]]: + def from_json(cls, json_str: str) -> Optional[Union[DynamicField, MetricField, StaticStringField]]: """Create an instance of CustomPayloadField from a JSON string""" return cls.from_dict(json.loads(json_str)) @@ -97,12 +98,14 @@ def to_dict(self) -> Dict[str, Any]: return _dict @classmethod - def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[DynamicField, StaticStringField]]: + def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[DynamicField, MetricField, StaticStringField]]: """Create an instance of CustomPayloadField from a dict""" # look up the object type based on discriminator mapping object_type = cls.get_discriminator_value(obj) if object_type == 'DynamicField': return import_module("instana_client.models.dynamic_field").DynamicField.from_dict(obj) + if object_type == 'MetricField': + return import_module("instana_client.models.metric_field").MetricField.from_dict(obj) if object_type == 'StaticStringField': return import_module("instana_client.models.static_string_field").StaticStringField.from_dict(obj) diff --git a/instana_client/models/custom_payload_with_last_updated.py b/instana_client/models/custom_payload_with_last_updated.py index 0781abb..7759e48 100644 --- a/instana_client/models/custom_payload_with_last_updated.py +++ b/instana_client/models/custom_payload_with_last_updated.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_payload_with_version.py b/instana_client/models/custom_payload_with_version.py index 56bc5f7..2fb3a28 100644 --- a/instana_client/models/custom_payload_with_version.py +++ b/instana_client/models/custom_payload_with_version.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_tag.py b/instana_client/models/custom_tag.py index c9d9a08..c4056e8 100644 --- a/instana_client/models/custom_tag.py +++ b/instana_client/models/custom_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/dashboard_api_token.py b/instana_client/models/dashboard_api_token.py index c3d3701..38c36e3 100644 --- a/instana_client/models/dashboard_api_token.py +++ b/instana_client/models/dashboard_api_token.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/database_integration.py b/instana_client/models/database_integration.py index b2f35f0..965dcb9 100644 --- a/instana_client/models/database_integration.py +++ b/instana_client/models/database_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/deprecated_tag_filter.py b/instana_client/models/deprecated_tag_filter.py index 7dbb593..76e852a 100644 --- a/instana_client/models/deprecated_tag_filter.py +++ b/instana_client/models/deprecated_tag_filter.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/dns_configuration.py b/instana_client/models/dns_configuration.py index dcea8c4..8cc5188 100644 --- a/instana_client/models/dns_configuration.py +++ b/instana_client/models/dns_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/dns_configuration_update.py b/instana_client/models/dns_configuration_update.py index 14c9ab0..1e60cf4 100644 --- a/instana_client/models/dns_configuration_update.py +++ b/instana_client/models/dns_configuration_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/dns_filter_query_time.py b/instana_client/models/dns_filter_query_time.py index f8751d4..83d94ef 100644 --- a/instana_client/models/dns_filter_query_time.py +++ b/instana_client/models/dns_filter_query_time.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -35,8 +35,8 @@ class DNSFilterQueryTime(BaseModel): @field_validator('operator') def operator_validate_enum(cls, value): """Validates the enum""" - if value not in set(['CONTAINS', 'EQUALS', 'GREATER_THAN', 'IS', 'LESS_THAN', 'MATCHES', 'NOT_MATCHES']): - raise ValueError("must be one of enum values ('CONTAINS', 'EQUALS', 'GREATER_THAN', 'IS', 'LESS_THAN', 'MATCHES', 'NOT_MATCHES')") + if value not in set(['CONTAINS', 'EQUALS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'IS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'MATCHES', 'NOT_MATCHES']): + raise ValueError("must be one of enum values ('CONTAINS', 'EQUALS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'IS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'MATCHES', 'NOT_MATCHES')") return value model_config = ConfigDict( diff --git a/instana_client/models/dns_filter_target_value.py b/instana_client/models/dns_filter_target_value.py index 95b8d35..0d9e6b7 100644 --- a/instana_client/models/dns_filter_target_value.py +++ b/instana_client/models/dns_filter_target_value.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -42,8 +42,8 @@ def key_validate_enum(cls, value): @field_validator('operator') def operator_validate_enum(cls, value): """Validates the enum""" - if value not in set(['CONTAINS', 'EQUALS', 'GREATER_THAN', 'IS', 'LESS_THAN', 'MATCHES', 'NOT_MATCHES']): - raise ValueError("must be one of enum values ('CONTAINS', 'EQUALS', 'GREATER_THAN', 'IS', 'LESS_THAN', 'MATCHES', 'NOT_MATCHES')") + if value not in set(['CONTAINS', 'EQUALS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'IS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'MATCHES', 'NOT_MATCHES']): + raise ValueError("must be one of enum values ('CONTAINS', 'EQUALS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'IS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'MATCHES', 'NOT_MATCHES')") return value model_config = ConfigDict( diff --git a/instana_client/models/duration.py b/instana_client/models/duration.py index a3d0191..429e2fb 100644 --- a/instana_client/models/duration.py +++ b/instana_client/models/duration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/dynamic_field.py b/instana_client/models/dynamic_field.py index 7783a09..b502187 100644 --- a/instana_client/models/dynamic_field.py +++ b/instana_client/models/dynamic_field.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/dynamic_field_value.py b/instana_client/models/dynamic_field_value.py index 5334a33..f52bb2c 100644 --- a/instana_client/models/dynamic_field_value.py +++ b/instana_client/models/dynamic_field_value.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/dynamic_parameter.py b/instana_client/models/dynamic_parameter.py index 1e87ff1..09c38f9 100644 --- a/instana_client/models/dynamic_parameter.py +++ b/instana_client/models/dynamic_parameter.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/dynamic_tag.py b/instana_client/models/dynamic_tag.py index ca31053..fbb771a 100644 --- a/instana_client/models/dynamic_tag.py +++ b/instana_client/models/dynamic_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/edit_user.py b/instana_client/models/edit_user.py index dd296eb..a2a723e 100644 --- a/instana_client/models/edit_user.py +++ b/instana_client/models/edit_user.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/email_integration.py b/instana_client/models/email_integration.py index f323ee0..f230057 100644 --- a/instana_client/models/email_integration.py +++ b/instana_client/models/email_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/empty_configuration.py b/instana_client/models/empty_configuration.py index cc2c0c4..c3859db 100644 --- a/instana_client/models/empty_configuration.py +++ b/instana_client/models/empty_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/endpoint.py b/instana_client/models/endpoint.py index 178a8f2..8adb747 100644 --- a/instana_client/models/endpoint.py +++ b/instana_client/models/endpoint.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/endpoint_config.py b/instana_client/models/endpoint_config.py index a6a3860..43218fe 100644 --- a/instana_client/models/endpoint_config.py +++ b/instana_client/models/endpoint_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/endpoint_event_result.py b/instana_client/models/endpoint_event_result.py index 2189002..ae91978 100644 --- a/instana_client/models/endpoint_event_result.py +++ b/instana_client/models/endpoint_event_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/endpoint_item.py b/instana_client/models/endpoint_item.py index 5b0333d..defcee2 100644 --- a/instana_client/models/endpoint_item.py +++ b/instana_client/models/endpoint_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/endpoint_metric_result.py b/instana_client/models/endpoint_metric_result.py index cb2a5d6..fda35c5 100644 --- a/instana_client/models/endpoint_metric_result.py +++ b/instana_client/models/endpoint_metric_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/endpoint_node.py b/instana_client/models/endpoint_node.py index b33fb24..7940bbd 100644 --- a/instana_client/models/endpoint_node.py +++ b/instana_client/models/endpoint_node.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/endpoint_result.py b/instana_client/models/endpoint_result.py index 668e007..bfce305 100644 --- a/instana_client/models/endpoint_result.py +++ b/instana_client/models/endpoint_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/endpoint_simple.py b/instana_client/models/endpoint_simple.py index 19db068..0a7ba0e 100644 --- a/instana_client/models/endpoint_simple.py +++ b/instana_client/models/endpoint_simple.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/entity_count_rule.py b/instana_client/models/entity_count_rule.py index d0d89f9..b2b42c6 100644 --- a/instana_client/models/entity_count_rule.py +++ b/instana_client/models/entity_count_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/entity_count_verification_rule.py b/instana_client/models/entity_count_verification_rule.py index 7c6c729..d6d6eb9 100644 --- a/instana_client/models/entity_count_verification_rule.py +++ b/instana_client/models/entity_count_verification_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/entity_health_info.py b/instana_client/models/entity_health_info.py index 84ea038..2e8419b 100644 --- a/instana_client/models/entity_health_info.py +++ b/instana_client/models/entity_health_info.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/entity_id.py b/instana_client/models/entity_id.py index f975980..65feefa 100644 --- a/instana_client/models/entity_id.py +++ b/instana_client/models/entity_id.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/entity_verification_rule.py b/instana_client/models/entity_verification_rule.py index ebd131d..9c94f0f 100644 --- a/instana_client/models/entity_verification_rule.py +++ b/instana_client/models/entity_verification_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/error_budget_alert_rule.py b/instana_client/models/error_budget_alert_rule.py index 3409c54..8542008 100644 --- a/instana_client/models/error_budget_alert_rule.py +++ b/instana_client/models/error_budget_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/errors_application_alert_rule.py b/instana_client/models/errors_application_alert_rule.py index 09a3c6a..d288a53 100644 --- a/instana_client/models/errors_application_alert_rule.py +++ b/instana_client/models/errors_application_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/event.py b/instana_client/models/event.py index 4b70f6f..091f490 100644 --- a/instana_client/models/event.py +++ b/instana_client/models/event.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -21,6 +21,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated +from instana_client.models.api_tag import ApiTag from instana_client.models.problem import Problem from typing import Optional, Set from typing_extensions import Self @@ -41,12 +42,13 @@ class Event(BaseModel): metric_access_id: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=64)]] = Field(default=None, alias="metricAccessId") plugin: Annotated[str, Field(min_length=0, strict=True, max_length=256)] problem: Optional[Problem] = None + rbac_tags: Optional[List[ApiTag]] = Field(default=None, alias="rbacTags") rca: Optional[Dict[str, Dict[str, Any]]] = None short_code: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=64)]] = Field(default=None, alias="shortCode") start: Optional[Annotated[int, Field(strict=True, ge=1)]] = None state: Annotated[str, Field(min_length=0, strict=True, max_length=8)] type: Annotated[str, Field(min_length=0, strict=True, max_length=64)] - __properties: ClassVar[List[str]] = ["affectedEntities", "end", "endpointServiceId", "entityId", "entityType", "eventConfigurationType", "id", "longFormPluginId", "metadata", "metricAccessId", "plugin", "problem", "rca", "shortCode", "start", "state", "type"] + __properties: ClassVar[List[str]] = ["affectedEntities", "end", "endpointServiceId", "entityId", "entityType", "eventConfigurationType", "id", "longFormPluginId", "metadata", "metricAccessId", "plugin", "problem", "rbacTags", "rca", "shortCode", "start", "state", "type"] @field_validator('entity_type') def entity_type_validate_enum(cls, value): @@ -100,6 +102,13 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of problem if self.problem: _dict['problem'] = self.problem.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in rbac_tags (list) + _items = [] + if self.rbac_tags: + for _item_rbac_tags in self.rbac_tags: + if _item_rbac_tags: + _items.append(_item_rbac_tags.to_dict()) + _dict['rbacTags'] = _items return _dict @classmethod @@ -124,6 +133,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "metricAccessId": obj.get("metricAccessId"), "plugin": obj.get("plugin"), "problem": Problem.from_dict(obj["problem"]) if obj.get("problem") is not None else None, + "rbacTags": [ApiTag.from_dict(_item) for _item in obj["rbacTags"]] if obj.get("rbacTags") is not None else None, "rca": obj.get("rca"), "shortCode": obj.get("shortCode"), "start": obj.get("start"), diff --git a/instana_client/models/event_filtering_configuration.py b/instana_client/models/event_filtering_configuration.py index 3c4df6d..bb1c5e6 100644 --- a/instana_client/models/event_filtering_configuration.py +++ b/instana_client/models/event_filtering_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/event_result.py b/instana_client/models/event_result.py index 0102dd4..bd09ffc 100644 --- a/instana_client/models/event_result.py +++ b/instana_client/models/event_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/event_specification_info.py b/instana_client/models/event_specification_info.py index 12b69d5..5e3d19b 100644 --- a/instana_client/models/event_specification_info.py +++ b/instana_client/models/event_specification_info.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/extended_service.py b/instana_client/models/extended_service.py index 153952d..eb10419 100644 --- a/instana_client/models/extended_service.py +++ b/instana_client/models/extended_service.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/failure_synthetic_alert_rule.py b/instana_client/models/failure_synthetic_alert_rule.py index ec2a2eb..d569c5d 100644 --- a/instana_client/models/failure_synthetic_alert_rule.py +++ b/instana_client/models/failure_synthetic_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/fixed_http_path_segment_matching_rule.py b/instana_client/models/fixed_http_path_segment_matching_rule.py index 6a2877d..baf61f6 100644 --- a/instana_client/models/fixed_http_path_segment_matching_rule.py +++ b/instana_client/models/fixed_http_path_segment_matching_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/fixed_time_window.py b/instana_client/models/fixed_time_window.py index 00bc745..6bbf58a 100644 --- a/instana_client/models/fixed_time_window.py +++ b/instana_client/models/fixed_time_window.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/generic_infra_alert_rule.py b/instana_client/models/generic_infra_alert_rule.py index 8bc28f9..9937357 100644 --- a/instana_client/models/generic_infra_alert_rule.py +++ b/instana_client/models/generic_infra_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/geo_location_configuration.py b/instana_client/models/geo_location_configuration.py index 02f40e0..c54effb 100644 --- a/instana_client/models/geo_location_configuration.py +++ b/instana_client/models/geo_location_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/geo_mapping_rule.py b/instana_client/models/geo_mapping_rule.py index e8310de..a3deea2 100644 --- a/instana_client/models/geo_mapping_rule.py +++ b/instana_client/models/geo_mapping_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/geo_subdivision.py b/instana_client/models/geo_subdivision.py index 8f14cd1..0652a23 100644 --- a/instana_client/models/geo_subdivision.py +++ b/instana_client/models/geo_subdivision.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_activities.py b/instana_client/models/get_activities.py index c53dd0e..4141d40 100644 --- a/instana_client/models/get_activities.py +++ b/instana_client/models/get_activities.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_application_metrics.py b/instana_client/models/get_application_metrics.py index 26c7923..8254f91 100644 --- a/instana_client/models/get_application_metrics.py +++ b/instana_client/models/get_application_metrics.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_applications.py b/instana_client/models/get_applications.py index c31886c..334a9bc 100644 --- a/instana_client/models/get_applications.py +++ b/instana_client/models/get_applications.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_available_metrics_query.py b/instana_client/models/get_available_metrics_query.py index 44ac1d2..eb68cf7 100644 --- a/instana_client/models/get_available_metrics_query.py +++ b/instana_client/models/get_available_metrics_query.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_available_plugins_query.py b/instana_client/models/get_available_plugins_query.py index 13c63db..48d9458 100644 --- a/instana_client/models/get_available_plugins_query.py +++ b/instana_client/models/get_available_plugins_query.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_call_groups.py b/instana_client/models/get_call_groups.py index 849ff5e..3ec7fa6 100644 --- a/instana_client/models/get_call_groups.py +++ b/instana_client/models/get_call_groups.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_combined_metrics.py b/instana_client/models/get_combined_metrics.py index a8155cb..a4daac1 100644 --- a/instana_client/models/get_combined_metrics.py +++ b/instana_client/models/get_combined_metrics.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -29,11 +29,11 @@ class GetCombinedMetrics(BaseModel): """ GetCombinedMetrics """ # noqa: E501 - metrics: Annotated[List[Annotated[str, Field(min_length=1, strict=True)]], Field(min_length=1, max_length=5)] = Field(description="Id of the exact metric you want to retrieve, eg. \"cpu.user\", \"clientrequests.read.mean\"") + metrics: Annotated[List[Annotated[str, Field(min_length=1, strict=True)]], Field(min_length=1, max_length=15)] = Field(description="Id of the exact metric you want to retrieve, eg. \"cpu.user\", \"clientrequests.read.mean\"") plugin: StrictStr = Field(description="Plugin name") query: Optional[StrictStr] = Field(default=None, description="Dynamic Focus Query") rollup: Optional[StrictInt] = Field(default=None, description="Rollup value in seconds") - snapshot_ids: Optional[Annotated[List[Annotated[str, Field(min_length=1, strict=True)]], Field(min_length=1, max_length=30)]] = Field(default=None, description="Unique identifier the metrics are assigned to", alias="snapshotIds") + snapshot_ids: Optional[Annotated[List[Annotated[str, Field(min_length=1, strict=True)]], Field(min_length=1, max_length=60)]] = Field(default=None, description="Unique identifier the metrics are assigned to", alias="snapshotIds") time_frame: Optional[TimeFrame] = Field(default=None, alias="timeFrame") __properties: ClassVar[List[str]] = ["metrics", "plugin", "query", "rollup", "snapshotIds", "timeFrame"] diff --git a/instana_client/models/get_dynamic_parameter_values.py b/instana_client/models/get_dynamic_parameter_values.py index 44148af..943cae0 100644 --- a/instana_client/models/get_dynamic_parameter_values.py +++ b/instana_client/models/get_dynamic_parameter_values.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_endpoints.py b/instana_client/models/get_endpoints.py index d5730b9..989dd98 100644 --- a/instana_client/models/get_endpoints.py +++ b/instana_client/models/get_endpoints.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_infrastructure_groups_query.py b/instana_client/models/get_infrastructure_groups_query.py index 43fd664..3ffa836 100644 --- a/instana_client/models/get_infrastructure_groups_query.py +++ b/instana_client/models/get_infrastructure_groups_query.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -22,8 +22,8 @@ from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated from instana_client.models.cursor_pagination_with_ui_cursor_infra_explore_cursor import CursorPaginationWithUiCursorInfraExploreCursor -from instana_client.models.infra_metric_configuration import InfraMetricConfiguration from instana_client.models.order import Order +from instana_client.models.simple_metric_configuration import SimpleMetricConfiguration from instana_client.models.tag_filter_expression_element import TagFilterExpressionElement from instana_client.models.time_frame import TimeFrame from typing import Optional, Set @@ -34,7 +34,7 @@ class GetInfrastructureGroupsQuery(BaseModel): GetInfrastructureGroupsQuery """ # noqa: E501 group_by: Annotated[List[StrictStr], Field(min_length=0, max_length=5)] = Field(description="Entity grouping tag. Use the Instana Analyze Infrastructure dashboard to determine the entity grouping tag name.", alias="groupBy") - metrics: Optional[Annotated[List[InfraMetricConfiguration], Field(min_length=0, max_length=10)]] = None + metrics: Optional[Annotated[List[SimpleMetricConfiguration], Field(min_length=0, max_length=10)]] = None missing_placeholder: Optional[StrictStr] = Field(default=None, alias="missingPlaceholder") order: Optional[Order] = None pagination: CursorPaginationWithUiCursorInfraExploreCursor @@ -114,7 +114,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "groupBy": obj.get("groupBy"), - "metrics": [InfraMetricConfiguration.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None, + "metrics": [SimpleMetricConfiguration.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None, "missingPlaceholder": obj.get("missingPlaceholder"), "order": Order.from_dict(obj["order"]) if obj.get("order") is not None else None, "pagination": CursorPaginationWithUiCursorInfraExploreCursor.from_dict(obj["pagination"]) if obj.get("pagination") is not None else None, diff --git a/instana_client/models/get_infrastructure_query.py b/instana_client/models/get_infrastructure_query.py index 57dbda0..bc9d870 100644 --- a/instana_client/models/get_infrastructure_query.py +++ b/instana_client/models/get_infrastructure_query.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -22,8 +22,8 @@ from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated from instana_client.models.cursor_pagination_with_ui_cursor_infra_explore_cursor import CursorPaginationWithUiCursorInfraExploreCursor -from instana_client.models.infra_metric_configuration import InfraMetricConfiguration from instana_client.models.order import Order +from instana_client.models.simple_metric_configuration import SimpleMetricConfiguration from instana_client.models.tag_filter_expression_element import TagFilterExpressionElement from instana_client.models.time_frame import TimeFrame from typing import Optional, Set @@ -33,7 +33,7 @@ class GetInfrastructureQuery(BaseModel): """ GetInfrastructureQuery """ # noqa: E501 - metrics: Optional[Annotated[List[InfraMetricConfiguration], Field(min_length=0, max_length=10)]] = None + metrics: Optional[Annotated[List[SimpleMetricConfiguration], Field(min_length=0, max_length=10)]] = None missing_placeholder: Optional[StrictStr] = Field(default=None, alias="missingPlaceholder") order: Optional[Order] = None pagination: CursorPaginationWithUiCursorInfraExploreCursor @@ -113,7 +113,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "metrics": [InfraMetricConfiguration.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None, + "metrics": [SimpleMetricConfiguration.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None, "missingPlaceholder": obj.get("missingPlaceholder"), "order": Order.from_dict(obj["order"]) if obj.get("order") is not None else None, "pagination": CursorPaginationWithUiCursorInfraExploreCursor.from_dict(obj["pagination"]) if obj.get("pagination") is not None else None, diff --git a/instana_client/models/get_metrics_result.py b/instana_client/models/get_metrics_result.py index f279136..4b05fef 100644 --- a/instana_client/models/get_metrics_result.py +++ b/instana_client/models/get_metrics_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_mobile_app_beacon_groups.py b/instana_client/models/get_mobile_app_beacon_groups.py index 4750dde..a00dfe1 100644 --- a/instana_client/models/get_mobile_app_beacon_groups.py +++ b/instana_client/models/get_mobile_app_beacon_groups.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_mobile_app_beacons.py b/instana_client/models/get_mobile_app_beacons.py index 8f34a92..c8cfa75 100644 --- a/instana_client/models/get_mobile_app_beacons.py +++ b/instana_client/models/get_mobile_app_beacons.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_mobile_app_metrics.py b/instana_client/models/get_mobile_app_metrics.py index 789a08b..e3118ad 100644 --- a/instana_client/models/get_mobile_app_metrics.py +++ b/instana_client/models/get_mobile_app_metrics.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_mobile_app_metrics_v2.py b/instana_client/models/get_mobile_app_metrics_v2.py index 24a7e5a..dec779d 100644 --- a/instana_client/models/get_mobile_app_metrics_v2.py +++ b/instana_client/models/get_mobile_app_metrics_v2.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_payload_keys_result.py b/instana_client/models/get_payload_keys_result.py index 5aa0de9..6271375 100644 --- a/instana_client/models/get_payload_keys_result.py +++ b/instana_client/models/get_payload_keys_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_services.py b/instana_client/models/get_services.py index a53a223..d32fbc1 100644 --- a/instana_client/models/get_services.py +++ b/instana_client/models/get_services.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_snapshots_query.py b/instana_client/models/get_snapshots_query.py index efff020..06c4a71 100644 --- a/instana_client/models/get_snapshots_query.py +++ b/instana_client/models/get_snapshots_query.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_test_result.py b/instana_client/models/get_test_result.py index 6c32bc3..4875189 100644 --- a/instana_client/models/get_test_result.py +++ b/instana_client/models/get_test_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_test_result_analytic.py b/instana_client/models/get_test_result_analytic.py index 697a467..977ac15 100644 --- a/instana_client/models/get_test_result_analytic.py +++ b/instana_client/models/get_test_result_analytic.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_test_result_base.py b/instana_client/models/get_test_result_base.py index a7d06f2..6ec924e 100644 --- a/instana_client/models/get_test_result_base.py +++ b/instana_client/models/get_test_result_base.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_test_result_list.py b/instana_client/models/get_test_result_list.py index 296c347..f4835a8 100644 --- a/instana_client/models/get_test_result_list.py +++ b/instana_client/models/get_test_result_list.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_test_summary_result.py b/instana_client/models/get_test_summary_result.py index f803d8f..e9080e6 100644 --- a/instana_client/models/get_test_summary_result.py +++ b/instana_client/models/get_test_summary_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_trace_download_result_item.py b/instana_client/models/get_trace_download_result_item.py index 13dad36..bfca163 100644 --- a/instana_client/models/get_trace_download_result_item.py +++ b/instana_client/models/get_trace_download_result_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_trace_groups.py b/instana_client/models/get_trace_groups.py index 0d66427..edf152d 100644 --- a/instana_client/models/get_trace_groups.py +++ b/instana_client/models/get_trace_groups.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_traces.py b/instana_client/models/get_traces.py index 21e751c..3514b4a 100644 --- a/instana_client/models/get_traces.py +++ b/instana_client/models/get_traces.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_website_beacon_groups.py b/instana_client/models/get_website_beacon_groups.py index e1e3350..f589da5 100644 --- a/instana_client/models/get_website_beacon_groups.py +++ b/instana_client/models/get_website_beacon_groups.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_website_beacons.py b/instana_client/models/get_website_beacons.py index c5770d4..ed733c2 100644 --- a/instana_client/models/get_website_beacons.py +++ b/instana_client/models/get_website_beacons.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_website_metrics.py b/instana_client/models/get_website_metrics.py index 76eb6e6..4c6015c 100644 --- a/instana_client/models/get_website_metrics.py +++ b/instana_client/models/get_website_metrics.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_website_metrics_v2.py b/instana_client/models/get_website_metrics_v2.py index 80e9e4d..f01cdbc 100644 --- a/instana_client/models/get_website_metrics_v2.py +++ b/instana_client/models/get_website_metrics_v2.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/global_application_alert_config_with_metadata.py b/instana_client/models/global_application_alert_config_with_metadata.py index 028cbad..d010bc7 100644 --- a/instana_client/models/global_application_alert_config_with_metadata.py +++ b/instana_client/models/global_application_alert_config_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/global_applications_alert_config.py b/instana_client/models/global_applications_alert_config.py index c3634fb..007e68b 100644 --- a/instana_client/models/global_applications_alert_config.py +++ b/instana_client/models/global_applications_alert_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/google_chat_integration.py b/instana_client/models/google_chat_integration.py index 45eccaa..4622fdf 100644 --- a/instana_client/models/google_chat_integration.py +++ b/instana_client/models/google_chat_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/graph_edge.py b/instana_client/models/graph_edge.py index 6661b6e..a5f2765 100644 --- a/instana_client/models/graph_edge.py +++ b/instana_client/models/graph_edge.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/graph_node.py b/instana_client/models/graph_node.py index ed82f39..db7d838 100644 --- a/instana_client/models/graph_node.py +++ b/instana_client/models/graph_node.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/group.py b/instana_client/models/group.py index 31b9a31..9bc4b9c 100644 --- a/instana_client/models/group.py +++ b/instana_client/models/group.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/group_by_tag.py b/instana_client/models/group_by_tag.py index a3d34a3..1efa5c8 100644 --- a/instana_client/models/group_by_tag.py +++ b/instana_client/models/group_by_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/group_mapping.py b/instana_client/models/group_mapping.py index 262c08d..eec8223 100644 --- a/instana_client/models/group_mapping.py +++ b/instana_client/models/group_mapping.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/group_mapping_overview.py b/instana_client/models/group_mapping_overview.py index b029e9d..bdcaf95 100644 --- a/instana_client/models/group_mapping_overview.py +++ b/instana_client/models/group_mapping_overview.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/health_state.py b/instana_client/models/health_state.py index e9e921b..07fb24c 100644 --- a/instana_client/models/health_state.py +++ b/instana_client/models/health_state.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/historic_baseline.py b/instana_client/models/historic_baseline.py index 842f0b1..e319761 100644 --- a/instana_client/models/historic_baseline.py +++ b/instana_client/models/historic_baseline.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/host_availability_rule.py b/instana_client/models/host_availability_rule.py index be1fdd4..66bf02b 100644 --- a/instana_client/models/host_availability_rule.py +++ b/instana_client/models/host_availability_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/http_action_configuration.py b/instana_client/models/http_action_configuration.py index 7977cf8..7d0d150 100644 --- a/instana_client/models/http_action_configuration.py +++ b/instana_client/models/http_action_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/http_action_configuration_update.py b/instana_client/models/http_action_configuration_update.py index 093ecba..a5ae39f 100644 --- a/instana_client/models/http_action_configuration_update.py +++ b/instana_client/models/http_action_configuration_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/http_endpoint_config.py b/instana_client/models/http_endpoint_config.py index 7fa7018..c0fbc0c 100644 --- a/instana_client/models/http_endpoint_config.py +++ b/instana_client/models/http_endpoint_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/http_endpoint_rule.py b/instana_client/models/http_endpoint_rule.py index c52eb53..b639d9d 100644 --- a/instana_client/models/http_endpoint_rule.py +++ b/instana_client/models/http_endpoint_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/http_path_segment_matching_rule.py b/instana_client/models/http_path_segment_matching_rule.py index 67bf0d3..2689055 100644 --- a/instana_client/models/http_path_segment_matching_rule.py +++ b/instana_client/models/http_path_segment_matching_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/http_script_configuration.py b/instana_client/models/http_script_configuration.py index 8eb875d..bd91f48 100644 --- a/instana_client/models/http_script_configuration.py +++ b/instana_client/models/http_script_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/http_script_configuration_update.py b/instana_client/models/http_script_configuration_update.py index 2dd0121..e26be57 100644 --- a/instana_client/models/http_script_configuration_update.py +++ b/instana_client/models/http_script_configuration_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/hyper_param.py b/instana_client/models/hyper_param.py index fe5cb35..2134d14 100644 --- a/instana_client/models/hyper_param.py +++ b/instana_client/models/hyper_param.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/icmp_configuration.py b/instana_client/models/icmp_configuration.py new file mode 100644 index 0000000..e2bb04c --- /dev/null +++ b/instana_client/models/icmp_configuration.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from instana_client.models.icmp_validation import ICMPValidation +from instana_client.models.synthetic_type_configuration import SyntheticTypeConfiguration +from typing import Optional, Set +from typing_extensions import Self + +class ICMPConfiguration(SyntheticTypeConfiguration): + """ + ICMPConfiguration + """ # noqa: E501 + packet_count: Optional[StrictInt] = Field(default=None, alias="packetCount") + packet_interval: Optional[StrictStr] = Field(default=None, alias="packetInterval") + packet_size: Optional[StrictInt] = Field(default=None, alias="packetSize") + packet_timeout: Optional[StrictStr] = Field(default=None, alias="packetTimeout") + target_host: StrictStr = Field(alias="targetHost") + use_dns: Optional[StrictBool] = Field(default=None, alias="useDNS") + use_ipv6: Optional[StrictBool] = Field(default=None, alias="useIPv6") + validation_rules: Optional[List[ICMPValidation]] = Field(default=None, alias="validationRules") + __properties: ClassVar[List[str]] = ["markSyntheticCall", "retries", "retryInterval", "syntheticType", "timeout", "packetCount", "packetInterval", "packetSize", "packetTimeout", "targetHost", "useDNS", "useIPv6", "validationRules"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ICMPConfiguration from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in validation_rules (list) + _items = [] + if self.validation_rules: + for _item_validation_rules in self.validation_rules: + if _item_validation_rules: + _items.append(_item_validation_rules.to_dict()) + _dict['validationRules'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ICMPConfiguration from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "markSyntheticCall": obj.get("markSyntheticCall"), + "retries": obj.get("retries"), + "retryInterval": obj.get("retryInterval"), + "syntheticType": obj.get("syntheticType"), + "timeout": obj.get("timeout"), + "packetCount": obj.get("packetCount"), + "packetInterval": obj.get("packetInterval"), + "packetSize": obj.get("packetSize"), + "packetTimeout": obj.get("packetTimeout"), + "targetHost": obj.get("targetHost"), + "useDNS": obj.get("useDNS"), + "useIPv6": obj.get("useIPv6"), + "validationRules": [ICMPValidation.from_dict(_item) for _item in obj["validationRules"]] if obj.get("validationRules") is not None else None + }) + return _obj + + diff --git a/instana_client/models/icmp_configuration_update.py b/instana_client/models/icmp_configuration_update.py new file mode 100644 index 0000000..7c7ba01 --- /dev/null +++ b/instana_client/models/icmp_configuration_update.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from instana_client.models.synthetic_resource_update_list_icmp_validation_list_icmp_validation import SyntheticResourceUpdateListICMPValidationListICMPValidation +from instana_client.models.synthetic_type_configuration_update import SyntheticTypeConfigurationUpdate +from typing import Optional, Set +from typing_extensions import Self + +class ICMPConfigurationUpdate(SyntheticTypeConfigurationUpdate): + """ + ICMPConfigurationUpdate + """ # noqa: E501 + packet_count: Optional[StrictInt] = Field(default=None, alias="packetCount") + packet_interval: Optional[StrictStr] = Field(default=None, alias="packetInterval") + packet_size: Optional[StrictInt] = Field(default=None, alias="packetSize") + packet_timeout: Optional[StrictStr] = Field(default=None, alias="packetTimeout") + target_host: Optional[StrictStr] = Field(default=None, alias="targetHost") + use_dns: Optional[StrictBool] = Field(default=None, alias="useDNS") + use_ipv6: Optional[StrictBool] = Field(default=None, alias="useIPv6") + validation_rules: Optional[SyntheticResourceUpdateListICMPValidationListICMPValidation] = Field(default=None, alias="validationRules") + __properties: ClassVar[List[str]] = ["markSyntheticCall", "retries", "retryInterval", "syntheticTest", "syntheticType", "timeout", "packetCount", "packetInterval", "packetSize", "packetTimeout", "targetHost", "useDNS", "useIPv6", "validationRules"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ICMPConfigurationUpdate from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of validation_rules + if self.validation_rules: + _dict['validationRules'] = self.validation_rules.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ICMPConfigurationUpdate from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "markSyntheticCall": obj.get("markSyntheticCall"), + "retries": obj.get("retries"), + "retryInterval": obj.get("retryInterval"), + "syntheticTest": obj.get("syntheticTest"), + "syntheticType": obj.get("syntheticType"), + "timeout": obj.get("timeout"), + "packetCount": obj.get("packetCount"), + "packetInterval": obj.get("packetInterval"), + "packetSize": obj.get("packetSize"), + "packetTimeout": obj.get("packetTimeout"), + "targetHost": obj.get("targetHost"), + "useDNS": obj.get("useDNS"), + "useIPv6": obj.get("useIPv6"), + "validationRules": SyntheticResourceUpdateListICMPValidationListICMPValidation.from_dict(obj["validationRules"]) if obj.get("validationRules") is not None else None + }) + return _obj + + diff --git a/instana_client/models/icmp_validation.py b/instana_client/models/icmp_validation.py new file mode 100644 index 0000000..39f6dcc --- /dev/null +++ b/instana_client/models/icmp_validation.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class ICMPValidation(BaseModel): + """ + ICMPValidation + """ # noqa: E501 + key: StrictStr + operator: StrictStr + value: StrictInt + __properties: ClassVar[List[str]] = ["key", "operator", "value"] + + @field_validator('operator') + def operator_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['CONTAINS', 'EQUALS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'IS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'MATCHES', 'NOT_MATCHES']): + raise ValueError("must be one of enum values ('CONTAINS', 'EQUALS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'IS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'MATCHES', 'NOT_MATCHES')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ICMPValidation from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ICMPValidation from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "operator": obj.get("operator"), + "value": obj.get("value") + }) + return _obj + + diff --git a/instana_client/models/identity_provider_patch.py b/instana_client/models/identity_provider_patch.py index b8d1b1f..88b0408 100644 --- a/instana_client/models/identity_provider_patch.py +++ b/instana_client/models/identity_provider_patch.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/idp_status_update.py b/instana_client/models/idp_status_update.py index 8e3dbf9..37c8be2 100644 --- a/instana_client/models/idp_status_update.py +++ b/instana_client/models/idp_status_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/impacted_beacon_info.py b/instana_client/models/impacted_beacon_info.py index 9586ad3..b81316e 100644 --- a/instana_client/models/impacted_beacon_info.py +++ b/instana_client/models/impacted_beacon_info.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/infra_alert_config.py b/instana_client/models/infra_alert_config.py index db9ab27..b9939c1 100644 --- a/instana_client/models/infra_alert_config.py +++ b/instana_client/models/infra_alert_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/infra_alert_config_with_metadata.py b/instana_client/models/infra_alert_config_with_metadata.py index 54c2417..2d710d3 100644 --- a/instana_client/models/infra_alert_config_with_metadata.py +++ b/instana_client/models/infra_alert_config_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/infra_alert_rule.py b/instana_client/models/infra_alert_rule.py index 0c16bc9..2275baa 100644 --- a/instana_client/models/infra_alert_rule.py +++ b/instana_client/models/infra_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/infra_event_result.py b/instana_client/models/infra_event_result.py index 91b3384..e2f9d58 100644 --- a/instana_client/models/infra_event_result.py +++ b/instana_client/models/infra_event_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/infra_slo_entity.py b/instana_client/models/infra_slo_entity.py index f22a776..ccae0af 100644 --- a/instana_client/models/infra_slo_entity.py +++ b/instana_client/models/infra_slo_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/infra_time_threshold.py b/instana_client/models/infra_time_threshold.py index bb687d7..1418841 100644 --- a/instana_client/models/infra_time_threshold.py +++ b/instana_client/models/infra_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/infrastructure_entities_result.py b/instana_client/models/infrastructure_entities_result.py index e3e14f3..a025dbf 100644 --- a/instana_client/models/infrastructure_entities_result.py +++ b/instana_client/models/infrastructure_entities_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/infrastructure_group.py b/instana_client/models/infrastructure_group.py index 3e1b285..6be3234 100644 --- a/instana_client/models/infrastructure_group.py +++ b/instana_client/models/infrastructure_group.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/infrastructure_groups_result.py b/instana_client/models/infrastructure_groups_result.py index d64a8c7..f4f62cd 100644 --- a/instana_client/models/infrastructure_groups_result.py +++ b/instana_client/models/infrastructure_groups_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/infrastructure_item.py b/instana_client/models/infrastructure_item.py index 6945d28..30484e0 100644 --- a/instana_client/models/infrastructure_item.py +++ b/instana_client/models/infrastructure_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/infrastructure_metric_result.py b/instana_client/models/infrastructure_metric_result.py index 2e3876c..83b6b46 100644 --- a/instana_client/models/infrastructure_metric_result.py +++ b/instana_client/models/infrastructure_metric_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/instana_version_info.py b/instana_client/models/instana_version_info.py index 90d2cb9..11c2fb4 100644 --- a/instana_client/models/instana_version_info.py +++ b/instana_client/models/instana_version_info.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/integration_overview.py b/instana_client/models/integration_overview.py index 0be4f0d..4a673f5 100644 --- a/instana_client/models/integration_overview.py +++ b/instana_client/models/integration_overview.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/invitation.py b/instana_client/models/invitation.py index 5ddf192..660e160 100644 --- a/instana_client/models/invitation.py +++ b/instana_client/models/invitation.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/invitation_response.py b/instana_client/models/invitation_response.py index a286d2d..458e626 100644 --- a/instana_client/models/invitation_response.py +++ b/instana_client/models/invitation_response.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/invitation_result.py b/instana_client/models/invitation_result.py index 3eb6bd0..db47450 100644 --- a/instana_client/models/invitation_result.py +++ b/instana_client/models/invitation_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/ip_filtering.py b/instana_client/models/ip_filtering.py new file mode 100644 index 0000000..68c6bb6 --- /dev/null +++ b/instana_client/models/ip_filtering.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from instana_client.models.ip_filtering_rule_dto import IPFilteringRuleDto +from typing import Optional, Set +from typing_extensions import Self + +class IPFiltering(BaseModel): + """ + IPFiltering + """ # noqa: E501 + active: Optional[StrictBool] = Field(default=None, description="If the configuration is currently enforced, can be permanent active (if verified), or temporary after creation (enabling the verification).") + deny_all: Optional[StrictBool] = Field(default=None, description="Fallback configuration, if unmatched requests should be denied.", alias="denyAll") + enabled: Optional[StrictBool] = Field(default=None, description="If the configuration should be enforced. See active status if it is actually enforced.") + last_changed_at: Optional[StrictInt] = Field(default=None, description="When the configuration was last changed.", alias="lastChangedAt") + last_verified_at: Optional[StrictInt] = Field(default=None, description="When the configuration was last verified. Can be used to assume if a configuration needs to be verified.", alias="lastVerifiedAt") + rules: List[IPFilteringRuleDto] = Field(description="Actual traffic rules. Enforcing allow / block based on incoming IP address. Are evaluated in given order.") + support_access_enabled: Optional[StrictBool] = Field(default=None, description="If Instana support should be able to access your environment. Instana support is still able to to deactivate the configuration for you (manual process).", alias="supportAccessEnabled") + __properties: ClassVar[List[str]] = ["active", "denyAll", "enabled", "lastChangedAt", "lastVerifiedAt", "rules", "supportAccessEnabled"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IPFiltering from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in rules (list) + _items = [] + if self.rules: + for _item_rules in self.rules: + if _item_rules: + _items.append(_item_rules.to_dict()) + _dict['rules'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IPFiltering from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "active": obj.get("active"), + "denyAll": obj.get("denyAll"), + "enabled": obj.get("enabled"), + "lastChangedAt": obj.get("lastChangedAt"), + "lastVerifiedAt": obj.get("lastVerifiedAt"), + "rules": [IPFilteringRuleDto.from_dict(_item) for _item in obj["rules"]] if obj.get("rules") is not None else None, + "supportAccessEnabled": obj.get("supportAccessEnabled") + }) + return _obj + + diff --git a/instana_client/models/ip_filtering_rule_dto.py b/instana_client/models/ip_filtering_rule_dto.py new file mode 100644 index 0000000..2abab73 --- /dev/null +++ b/instana_client/models/ip_filtering_rule_dto.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class IPFilteringRuleDto(BaseModel): + """ + Actual traffic rules. Enforcing allow / block based on incoming IP address. Are evaluated in given order. + """ # noqa: E501 + block: StrictBool = Field(description="If the traffic should be blocked or denied.") + target: StrictStr = Field(description="Target of this rule, can be either a IP address or a IP address range.") + __properties: ClassVar[List[str]] = ["block", "target"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IPFilteringRuleDto from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IPFilteringRuleDto from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "block": obj.get("block"), + "target": obj.get("target") + }) + return _obj + + diff --git a/instana_client/models/ip_filtering_upsert.py b/instana_client/models/ip_filtering_upsert.py new file mode 100644 index 0000000..f832197 --- /dev/null +++ b/instana_client/models/ip_filtering_upsert.py @@ -0,0 +1,103 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from instana_client.models.ip_filtering_rule_dto import IPFilteringRuleDto +from typing import Optional, Set +from typing_extensions import Self + +class IPFilteringUpsert(BaseModel): + """ + IPFilteringUpsert + """ # noqa: E501 + deny_all: StrictBool = Field(description="Fallback configuration, if unmatched requests should be denied.", alias="denyAll") + enabled: StrictBool = Field(description="If the configuration should be enforced. See active status if it is actually enforced.") + rules: Annotated[List[IPFilteringRuleDto], Field(min_length=1, max_length=75)] = Field(description="Actual traffic rules. Enforcing allow / block based on incoming IP address. Are evaluated in given order.") + support_access_enabled: StrictBool = Field(description="If Instana support should be able to access your environment. Instana support is still able to to deactivate the configuration for you (manual process).", alias="supportAccessEnabled") + __properties: ClassVar[List[str]] = ["denyAll", "enabled", "rules", "supportAccessEnabled"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of IPFilteringUpsert from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in rules (list) + _items = [] + if self.rules: + for _item_rules in self.rules: + if _item_rules: + _items.append(_item_rules.to_dict()) + _dict['rules'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of IPFilteringUpsert from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "denyAll": obj.get("denyAll"), + "enabled": obj.get("enabled"), + "rules": [IPFilteringRuleDto.from_dict(_item) for _item in obj["rules"]] if obj.get("rules") is not None else None, + "supportAccessEnabled": obj.get("supportAccessEnabled") + }) + return _obj + + diff --git a/instana_client/models/ip_masking_configuration.py b/instana_client/models/ip_masking_configuration.py index 1e485fd..e36c8e6 100644 --- a/instana_client/models/ip_masking_configuration.py +++ b/instana_client/models/ip_masking_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/js_stack_trace_line.py b/instana_client/models/js_stack_trace_line.py index f292e7a..87b40ea 100644 --- a/instana_client/models/js_stack_trace_line.py +++ b/instana_client/models/js_stack_trace_line.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/kubernetes_physical_context.py b/instana_client/models/kubernetes_physical_context.py index 634a0f1..5853d97 100644 --- a/instana_client/models/kubernetes_physical_context.py +++ b/instana_client/models/kubernetes_physical_context.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/latency_blueprint_indicator.py b/instana_client/models/latency_blueprint_indicator.py index 90a8f8c..ea1aa5c 100644 --- a/instana_client/models/latency_blueprint_indicator.py +++ b/instana_client/models/latency_blueprint_indicator.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/llm_egress_gateway.py b/instana_client/models/llm_egress_gateway.py index 34edde1..292e9f5 100644 --- a/instana_client/models/llm_egress_gateway.py +++ b/instana_client/models/llm_egress_gateway.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -21,7 +21,6 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated -from uuid import UUID from instana_client.models.llm_gateway_capability import LLMGatewayCapability from instana_client.models.llm_gateway_model import LLMGatewayModel from instana_client.models.llm_gateway_service import LLMGatewayService @@ -36,7 +35,7 @@ class LLMEgressGateway(BaseModel): created_at: Optional[StrictStr] = Field(default=None, alias="createdAt") description: Optional[StrictStr] = None enabled: Optional[StrictBool] = None - id: UUID + id: StrictStr instana_agents: Optional[Dict[str, Any]] = Field(default=None, alias="instanaAgents") metadata: Optional[Dict[str, Any]] = None model: LLMGatewayModel diff --git a/instana_client/models/llm_gateway_capability.py b/instana_client/models/llm_gateway_capability.py index 12ede8b..048ea33 100644 --- a/instana_client/models/llm_gateway_capability.py +++ b/instana_client/models/llm_gateway_capability.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/llm_gateway_model.py b/instana_client/models/llm_gateway_model.py index cc8ac17..58e63bd 100644 --- a/instana_client/models/llm_gateway_model.py +++ b/instana_client/models/llm_gateway_model.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/llm_gateway_service.py b/instana_client/models/llm_gateway_service.py index 83787fb..816cabc 100644 --- a/instana_client/models/llm_gateway_service.py +++ b/instana_client/models/llm_gateway_service.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/llm_gateway_test_connection_request.py b/instana_client/models/llm_gateway_test_connection_request.py index fefe19a..cedb86c 100644 --- a/instana_client/models/llm_gateway_test_connection_request.py +++ b/instana_client/models/llm_gateway_test_connection_request.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/llm_model_price.py b/instana_client/models/llm_model_price.py index 8d1036d..9148325 100644 --- a/instana_client/models/llm_model_price.py +++ b/instana_client/models/llm_model_price.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/llm_model_price_metadata.py b/instana_client/models/llm_model_price_metadata.py index f3913c3..0b82243 100644 --- a/instana_client/models/llm_model_price_metadata.py +++ b/instana_client/models/llm_model_price_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/location_status.py b/instana_client/models/location_status.py index fc26f74..a3f6243 100644 --- a/instana_client/models/location_status.py +++ b/instana_client/models/location_status.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/log_alert_config.py b/instana_client/models/log_alert_config.py index b8092bd..99db6e0 100644 --- a/instana_client/models/log_alert_config.py +++ b/instana_client/models/log_alert_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/log_alert_config_with_metadata.py b/instana_client/models/log_alert_config_with_metadata.py index 3a53e16..fd7ce6a 100644 --- a/instana_client/models/log_alert_config_with_metadata.py +++ b/instana_client/models/log_alert_config_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/log_alert_rule.py b/instana_client/models/log_alert_rule.py index 87d02ce..e99eac6 100644 --- a/instana_client/models/log_alert_rule.py +++ b/instana_client/models/log_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/log_count_alert_rule.py b/instana_client/models/log_count_alert_rule.py index ba97ef4..b0e4e5b 100644 --- a/instana_client/models/log_count_alert_rule.py +++ b/instana_client/models/log_count_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/log_event_result.py b/instana_client/models/log_event_result.py index aff2d97..6a1829d 100644 --- a/instana_client/models/log_event_result.py +++ b/instana_client/models/log_event_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/log_time_threshold.py b/instana_client/models/log_time_threshold.py index 2532faf..bb5540b 100644 --- a/instana_client/models/log_time_threshold.py +++ b/instana_client/models/log_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/log_volume_group.py b/instana_client/models/log_volume_group.py index cc065d6..334a746 100644 --- a/instana_client/models/log_volume_group.py +++ b/instana_client/models/log_volume_group.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/log_volume_usage_item.py b/instana_client/models/log_volume_usage_item.py index 3eab1e2..5dcf16c 100644 --- a/instana_client/models/log_volume_usage_item.py +++ b/instana_client/models/log_volume_usage_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -29,7 +29,7 @@ class LogVolumeUsageItem(BaseModel): """ LogVolumeUsageItem """ # noqa: E501 - log_volume: StrictInt = Field(alias="logVolume") + log_volume: StrictInt = Field(description="Log volume in bytes", alias="logVolume") number_of_month: Optional[Annotated[int, Field(le=12, strict=True, ge=1)]] = Field(default=None, alias="numberOfMonth") retention_periods: List[RetentionPeriod] = Field(alias="retentionPeriods") __properties: ClassVar[List[str]] = ["logVolume", "numberOfMonth", "retentionPeriods"] diff --git a/instana_client/models/log_volume_usage_result.py b/instana_client/models/log_volume_usage_result.py index 85da604..20d130d 100644 --- a/instana_client/models/log_volume_usage_result.py +++ b/instana_client/models/log_volume_usage_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/logs_application_alert_rule.py b/instana_client/models/logs_application_alert_rule.py index 9244c97..e4bf3c5 100644 --- a/instana_client/models/logs_application_alert_rule.py +++ b/instana_client/models/logs_application_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/maintenance_config.py b/instana_client/models/maintenance_config.py index 8ec0b27..8a45ce1 100644 --- a/instana_client/models/maintenance_config.py +++ b/instana_client/models/maintenance_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/maintenance_config_scheduling.py b/instana_client/models/maintenance_config_scheduling.py index 823fa84..f7a52cb 100644 --- a/instana_client/models/maintenance_config_scheduling.py +++ b/instana_client/models/maintenance_config_scheduling.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/maintenance_config_v2.py b/instana_client/models/maintenance_config_v2.py index 5e08aab..84b6d87 100644 --- a/instana_client/models/maintenance_config_v2.py +++ b/instana_client/models/maintenance_config_v2.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/maintenance_config_v2_with_state_and_occurrence.py b/instana_client/models/maintenance_config_v2_with_state_and_occurrence.py index a624138..f1650fe 100644 --- a/instana_client/models/maintenance_config_v2_with_state_and_occurrence.py +++ b/instana_client/models/maintenance_config_v2_with_state_and_occurrence.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/maintenance_config_with_last_updated.py b/instana_client/models/maintenance_config_with_last_updated.py index b00cbe1..a8da055 100644 --- a/instana_client/models/maintenance_config_with_last_updated.py +++ b/instana_client/models/maintenance_config_with_last_updated.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/maintenance_window.py b/instana_client/models/maintenance_window.py index bf00743..32e2469 100644 --- a/instana_client/models/maintenance_window.py +++ b/instana_client/models/maintenance_window.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/manual_alerting_channel_configuration.py b/instana_client/models/manual_alerting_channel_configuration.py index 47b7ec9..721f849 100644 --- a/instana_client/models/manual_alerting_channel_configuration.py +++ b/instana_client/models/manual_alerting_channel_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/manual_close_info.py b/instana_client/models/manual_close_info.py index 6881ed7..7d7a48b 100644 --- a/instana_client/models/manual_close_info.py +++ b/instana_client/models/manual_close_info.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/manual_service_config.py b/instana_client/models/manual_service_config.py index bc706a6..3e6b2e6 100644 --- a/instana_client/models/manual_service_config.py +++ b/instana_client/models/manual_service_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/match_all_http_path_segment_matching_rule.py b/instana_client/models/match_all_http_path_segment_matching_rule.py index 33121ed..9ce10a9 100644 --- a/instana_client/models/match_all_http_path_segment_matching_rule.py +++ b/instana_client/models/match_all_http_path_segment_matching_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/match_expression_dto.py b/instana_client/models/match_expression_dto.py index bddc6d6..b1b6981 100644 --- a/instana_client/models/match_expression_dto.py +++ b/instana_client/models/match_expression_dto.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/meta_data.py b/instana_client/models/meta_data.py index 907b6b0..2dcd2c6 100644 --- a/instana_client/models/meta_data.py +++ b/instana_client/models/meta_data.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metric_api_result.py b/instana_client/models/metric_api_result.py index 399ca78..b89616c 100644 --- a/instana_client/models/metric_api_result.py +++ b/instana_client/models/metric_api_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metric_config.py b/instana_client/models/metric_config.py index 31392aa..f433db9 100644 --- a/instana_client/models/metric_config.py +++ b/instana_client/models/metric_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metric_configuration.py b/instana_client/models/metric_configuration.py index 537c48f..5584a48 100644 --- a/instana_client/models/metric_configuration.py +++ b/instana_client/models/metric_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metric_description.py b/instana_client/models/metric_description.py index af8505f..ff57885 100644 --- a/instana_client/models/metric_description.py +++ b/instana_client/models/metric_description.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metric_field.py b/instana_client/models/metric_field.py new file mode 100644 index 0000000..10d9a7b --- /dev/null +++ b/instana_client/models/metric_field.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from instana_client.models.custom_payload_field import CustomPayloadField +from instana_client.models.metric_field_value import MetricFieldValue +from typing import Optional, Set +from typing_extensions import Self + +class MetricField(CustomPayloadField): + """ + MetricField + """ # noqa: E501 + aggregation: Optional[StrictStr] = None + entity_type: Optional[StrictStr] = Field(default=None, alias="entityType") + metric_id: Optional[StrictStr] = Field(default=None, alias="metricId") + time_window: Optional[Dict[str, Any]] = Field(default=None, alias="timeWindow") + value: Optional[MetricFieldValue] = None + __properties: ClassVar[List[str]] = ["key", "type", "aggregation", "entityType", "metricId", "timeWindow", "value"] + + @field_validator('aggregation') + def aggregation_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(['SUM', 'MEAN', 'MIN', 'MAX']): + raise ValueError("must be one of enum values ('SUM', 'MEAN', 'MIN', 'MAX')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MetricField from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of value + if self.value: + _dict['value'] = self.value.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MetricField from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "type": obj.get("type"), + "aggregation": obj.get("aggregation"), + "entityType": obj.get("entityType"), + "metricId": obj.get("metricId"), + "timeWindow": obj.get("timeWindow"), + "value": MetricFieldValue.from_dict(obj["value"]) if obj.get("value") is not None else None + }) + return _obj + + diff --git a/instana_client/models/metric_field_value.py b/instana_client/models/metric_field_value.py new file mode 100644 index 0000000..51cc6fb --- /dev/null +++ b/instana_client/models/metric_field_value.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class MetricFieldValue(BaseModel): + """ + Configuration for a metric-based custom payload field + """ # noqa: E501 + aggregation: StrictStr = Field(description="The aggregation type to apply to the metric") + entity_type: Optional[StrictStr] = Field(default=None, description="The entity type for the metric query", alias="entityType") + metric_id: StrictStr = Field(description="The metric ID to retrieve", alias="metricId") + time_window: Optional[Dict[str, Any]] = Field(default=None, description="The time window in milliseconds for metric aggregation", alias="timeWindow") + __properties: ClassVar[List[str]] = ["aggregation", "entityType", "metricId", "timeWindow"] + + @field_validator('aggregation') + def aggregation_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['SUM', 'MEAN', 'MIN', 'MAX']): + raise ValueError("must be one of enum values ('SUM', 'MEAN', 'MIN', 'MAX')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MetricFieldValue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MetricFieldValue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "aggregation": obj.get("aggregation"), + "entityType": obj.get("entityType"), + "metricId": obj.get("metricId"), + "timeWindow": obj.get("timeWindow") + }) + return _obj + + diff --git a/instana_client/models/metric_instance.py b/instana_client/models/metric_instance.py index 0444ce0..29c6ad2 100644 --- a/instana_client/models/metric_instance.py +++ b/instana_client/models/metric_instance.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metric_item.py b/instana_client/models/metric_item.py index 45ee3ee..a8420f5 100644 --- a/instana_client/models/metric_item.py +++ b/instana_client/models/metric_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metric_metadata.py b/instana_client/models/metric_metadata.py index bcaf957..47fcbe4 100644 --- a/instana_client/models/metric_metadata.py +++ b/instana_client/models/metric_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metric_pattern.py b/instana_client/models/metric_pattern.py index 485dac6..1a3c8b8 100644 --- a/instana_client/models/metric_pattern.py +++ b/instana_client/models/metric_pattern.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metrics_result.py b/instana_client/models/metrics_result.py index 3ff836f..980b0f8 100644 --- a/instana_client/models/metrics_result.py +++ b/instana_client/models/metrics_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metrics_result_item.py b/instana_client/models/metrics_result_item.py index e57a4d4..2f124a9 100644 --- a/instana_client/models/metrics_result_item.py +++ b/instana_client/models/metrics_result_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metrics_test_result_item.py b/instana_client/models/metrics_test_result_item.py index d771211..bb0ab30 100644 --- a/instana_client/models/metrics_test_result_item.py +++ b/instana_client/models/metrics_test_result_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app.py b/instana_client/models/mobile_app.py index 6818bb7..0cfa90d 100644 --- a/instana_client/models/mobile_app.py +++ b/instana_client/models/mobile_app.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_alert_config.py b/instana_client/models/mobile_app_alert_config.py index 5b73171..16a11d6 100644 --- a/instana_client/models/mobile_app_alert_config.py +++ b/instana_client/models/mobile_app_alert_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_alert_config_with_rbac_tag.py b/instana_client/models/mobile_app_alert_config_with_rbac_tag.py index b0ce7bb..62a4b29 100644 --- a/instana_client/models/mobile_app_alert_config_with_rbac_tag.py +++ b/instana_client/models/mobile_app_alert_config_with_rbac_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_alert_rule.py b/instana_client/models/mobile_app_alert_rule.py index 0f290f0..8a8bb23 100644 --- a/instana_client/models/mobile_app_alert_rule.py +++ b/instana_client/models/mobile_app_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_beacon_groups_item.py b/instana_client/models/mobile_app_beacon_groups_item.py index be35e87..5faed3e 100644 --- a/instana_client/models/mobile_app_beacon_groups_item.py +++ b/instana_client/models/mobile_app_beacon_groups_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_beacon_groups_result.py b/instana_client/models/mobile_app_beacon_groups_result.py index a8a2815..c17995e 100644 --- a/instana_client/models/mobile_app_beacon_groups_result.py +++ b/instana_client/models/mobile_app_beacon_groups_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_beacon_result.py b/instana_client/models/mobile_app_beacon_result.py index 78e0ed4..2fed81d 100644 --- a/instana_client/models/mobile_app_beacon_result.py +++ b/instana_client/models/mobile_app_beacon_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_beacon_tag_group.py b/instana_client/models/mobile_app_beacon_tag_group.py index fb5c0de..5c52af4 100644 --- a/instana_client/models/mobile_app_beacon_tag_group.py +++ b/instana_client/models/mobile_app_beacon_tag_group.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_beacons_item.py b/instana_client/models/mobile_app_beacons_item.py index 91a100c..8b13b0e 100644 --- a/instana_client/models/mobile_app_beacons_item.py +++ b/instana_client/models/mobile_app_beacons_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_event_result.py b/instana_client/models/mobile_app_event_result.py index ae6b454..4fc913e 100644 --- a/instana_client/models/mobile_app_event_result.py +++ b/instana_client/models/mobile_app_event_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_metric_result.py b/instana_client/models/mobile_app_metric_result.py index 9e55ee8..21d6739 100644 --- a/instana_client/models/mobile_app_metric_result.py +++ b/instana_client/models/mobile_app_metric_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_monitoring_beacon.py b/instana_client/models/mobile_app_monitoring_beacon.py index 0865d17..1286fc2 100644 --- a/instana_client/models/mobile_app_monitoring_beacon.py +++ b/instana_client/models/mobile_app_monitoring_beacon.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_monitoring_metric_description.py b/instana_client/models/mobile_app_monitoring_metric_description.py index 9e7bd80..2cb5b1a 100644 --- a/instana_client/models/mobile_app_monitoring_metric_description.py +++ b/instana_client/models/mobile_app_monitoring_metric_description.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_monitoring_metrics_configuration.py b/instana_client/models/mobile_app_monitoring_metrics_configuration.py index 7c16bb1..412a8e8 100644 --- a/instana_client/models/mobile_app_monitoring_metrics_configuration.py +++ b/instana_client/models/mobile_app_monitoring_metrics_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_app_time_threshold.py b/instana_client/models/mobile_app_time_threshold.py index ecc7ffd..e8d67f6 100644 --- a/instana_client/models/mobile_app_time_threshold.py +++ b/instana_client/models/mobile_app_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/model_field.py b/instana_client/models/model_field.py index 5c78939..13863be 100644 --- a/instana_client/models/model_field.py +++ b/instana_client/models/model_field.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/monitored_entities_stats.py b/instana_client/models/monitored_entities_stats.py index b3d4d5e..290d7ad 100644 --- a/instana_client/models/monitored_entities_stats.py +++ b/instana_client/models/monitored_entities_stats.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/monitoring_state.py b/instana_client/models/monitoring_state.py index 864235a..b45ea75 100644 --- a/instana_client/models/monitoring_state.py +++ b/instana_client/models/monitoring_state.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/multiple_scripts_configuration.py b/instana_client/models/multiple_scripts_configuration.py index a6ca8e5..4cb0120 100644 --- a/instana_client/models/multiple_scripts_configuration.py +++ b/instana_client/models/multiple_scripts_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/new_application_config.py b/instana_client/models/new_application_config.py index ba570de..88a32e8 100644 --- a/instana_client/models/new_application_config.py +++ b/instana_client/models/new_application_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/new_business_perspective_config.py b/instana_client/models/new_business_perspective_config.py index 9fb443d..842f277 100644 --- a/instana_client/models/new_business_perspective_config.py +++ b/instana_client/models/new_business_perspective_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/new_manual_service_config.py b/instana_client/models/new_manual_service_config.py index 0680523..f9023ad 100644 --- a/instana_client/models/new_manual_service_config.py +++ b/instana_client/models/new_manual_service_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/ns1_integration.py b/instana_client/models/ns1_integration.py index f1f1201..4fb570e 100644 --- a/instana_client/models/ns1_integration.py +++ b/instana_client/models/ns1_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/o_auth_config.py b/instana_client/models/o_auth_config.py index b2d4206..65d4837 100644 --- a/instana_client/models/o_auth_config.py +++ b/instana_client/models/o_auth_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/o_auth_integration.py b/instana_client/models/o_auth_integration.py index 5fb6b36..52c3e9e 100644 --- a/instana_client/models/o_auth_integration.py +++ b/instana_client/models/o_auth_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/o_auth_token.py b/instana_client/models/o_auth_token.py index 3439166..58a0cf9 100644 --- a/instana_client/models/o_auth_token.py +++ b/instana_client/models/o_auth_token.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/occurrence.py b/instana_client/models/occurrence.py index 156cff7..211479c 100644 --- a/instana_client/models/occurrence.py +++ b/instana_client/models/occurrence.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/office365_integration.py b/instana_client/models/office365_integration.py index 5fd1779..86b7b2b 100644 --- a/instana_client/models/office365_integration.py +++ b/instana_client/models/office365_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/one_time_maintenance_window.py b/instana_client/models/one_time_maintenance_window.py index 150ab1b..ed9e12c 100644 --- a/instana_client/models/one_time_maintenance_window.py +++ b/instana_client/models/one_time_maintenance_window.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/opsgenie_integration.py b/instana_client/models/opsgenie_integration.py index 250745e..34be971 100644 --- a/instana_client/models/opsgenie_integration.py +++ b/instana_client/models/opsgenie_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/order.py b/instana_client/models/order.py index d7e7083..4522b9a 100644 --- a/instana_client/models/order.py +++ b/instana_client/models/order.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/pagerduty_integration.py b/instana_client/models/pagerduty_integration.py index 871dd2b..285cd8c 100644 --- a/instana_client/models/pagerduty_integration.py +++ b/instana_client/models/pagerduty_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/paginated_result.py b/instana_client/models/paginated_result.py index fa09fed..a7a9b8e 100644 --- a/instana_client/models/paginated_result.py +++ b/instana_client/models/paginated_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/pagination.py b/instana_client/models/pagination.py index 61b8412..97eae06 100644 --- a/instana_client/models/pagination.py +++ b/instana_client/models/pagination.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/parameter.py b/instana_client/models/parameter.py index 62330e1..855c0b4 100644 --- a/instana_client/models/parameter.py +++ b/instana_client/models/parameter.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/parameter_value.py b/instana_client/models/parameter_value.py index 3043122..7e491ca 100644 --- a/instana_client/models/parameter_value.py +++ b/instana_client/models/parameter_value.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/path_parameter_http_path_segment_matching_rule.py b/instana_client/models/path_parameter_http_path_segment_matching_rule.py index 83f086e..37def15 100644 --- a/instana_client/models/path_parameter_http_path_segment_matching_rule.py +++ b/instana_client/models/path_parameter_http_path_segment_matching_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/physical_context.py b/instana_client/models/physical_context.py index a885e36..a8bd27b 100644 --- a/instana_client/models/physical_context.py +++ b/instana_client/models/physical_context.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/plugin_result.py b/instana_client/models/plugin_result.py index 2c13491..2cedd24 100644 --- a/instana_client/models/plugin_result.py +++ b/instana_client/models/plugin_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/policy.py b/instana_client/models/policy.py index f621fd1..b19ff63 100644 --- a/instana_client/models/policy.py +++ b/instana_client/models/policy.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/policy_runnable.py b/instana_client/models/policy_runnable.py index efb5afb..36672c9 100644 --- a/instana_client/models/policy_runnable.py +++ b/instana_client/models/policy_runnable.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/policy_scheduling.py b/instana_client/models/policy_scheduling.py index cc20929..d159719 100644 --- a/instana_client/models/policy_scheduling.py +++ b/instana_client/models/policy_scheduling.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/post_mobile_app_source_map_config_request.py b/instana_client/models/post_mobile_app_source_map_config_request.py index 751ab27..6b0f654 100644 --- a/instana_client/models/post_mobile_app_source_map_config_request.py +++ b/instana_client/models/post_mobile_app_source_map_config_request.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/post_snapshots_result.py b/instana_client/models/post_snapshots_result.py index 2a7b592..d28d29d 100644 --- a/instana_client/models/post_snapshots_result.py +++ b/instana_client/models/post_snapshots_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/prefix_object.py b/instana_client/models/prefix_object.py index 09854a2..94fd081 100644 --- a/instana_client/models/prefix_object.py +++ b/instana_client/models/prefix_object.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -18,7 +18,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set from typing_extensions import Self @@ -27,8 +27,9 @@ class PrefixObject(BaseModel): """ Shortcode prefix configuration """ # noqa: E501 + enabled: Optional[StrictBool] = Field(default=None, description="Whether the shortcode prefix feature is enabled") prefix: Optional[StrictStr] = Field(default=None, description="The prefix to use for event short codes (e.g., 'INSTANA-', 'PROD-')") - __properties: ClassVar[List[str]] = ["prefix"] + __properties: ClassVar[List[str]] = ["enabled", "prefix"] model_config = ConfigDict( populate_by_name=True, @@ -81,6 +82,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ + "enabled": obj.get("enabled"), "prefix": obj.get("prefix") }) return _obj diff --git a/instana_client/models/problem.py b/instana_client/models/problem.py index 008bdab..4ac613c 100644 --- a/instana_client/models/problem.py +++ b/instana_client/models/problem.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/prometheus_webhook_integration.py b/instana_client/models/prometheus_webhook_integration.py index b924f88..f438271 100644 --- a/instana_client/models/prometheus_webhook_integration.py +++ b/instana_client/models/prometheus_webhook_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/recurrent_maintenance_window.py b/instana_client/models/recurrent_maintenance_window.py index b14eb6b..02e9eba 100644 --- a/instana_client/models/recurrent_maintenance_window.py +++ b/instana_client/models/recurrent_maintenance_window.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/release.py b/instana_client/models/release.py index 1be455e..b913484 100644 --- a/instana_client/models/release.py +++ b/instana_client/models/release.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/release_scope.py b/instana_client/models/release_scope.py index b1b644c..f30e1c9 100644 --- a/instana_client/models/release_scope.py +++ b/instana_client/models/release_scope.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/release_with_metadata.py b/instana_client/models/release_with_metadata.py index fbfb196..5260f41 100644 --- a/instana_client/models/release_with_metadata.py +++ b/instana_client/models/release_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/retention_period.py b/instana_client/models/retention_period.py index 0900fa0..c0a045b 100644 --- a/instana_client/models/retention_period.py +++ b/instana_client/models/retention_period.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/rolling_time_window.py b/instana_client/models/rolling_time_window.py index 31f9389..6428cf7 100644 --- a/instana_client/models/rolling_time_window.py +++ b/instana_client/models/rolling_time_window.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/rule_input.py b/instana_client/models/rule_input.py index de53adf..b9d62d2 100644 --- a/instana_client/models/rule_input.py +++ b/instana_client/models/rule_input.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -18,8 +18,8 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator -from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -30,7 +30,8 @@ class RuleInput(BaseModel): """ # noqa: E501 input_kind: StrictStr = Field(alias="inputKind") input_name: Annotated[str, Field(min_length=0, strict=True, max_length=256)] = Field(alias="inputName") - __properties: ClassVar[List[str]] = ["inputKind", "inputName"] + metric_rollup: Optional[StrictInt] = Field(default=None, alias="metricRollup") + __properties: ClassVar[List[str]] = ["inputKind", "inputName", "metricRollup"] @field_validator('input_kind') def input_kind_validate_enum(cls, value): @@ -91,7 +92,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "inputKind": obj.get("inputKind"), - "inputName": obj.get("inputName") + "inputName": obj.get("inputName"), + "metricRollup": obj.get("metricRollup") }) return _obj diff --git a/instana_client/models/rule_with_threshold_application_alert_rule.py b/instana_client/models/rule_with_threshold_application_alert_rule.py index f6bf8d5..e419596 100644 --- a/instana_client/models/rule_with_threshold_application_alert_rule.py +++ b/instana_client/models/rule_with_threshold_application_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/rule_with_threshold_infra_alert_rule.py b/instana_client/models/rule_with_threshold_infra_alert_rule.py index eade5e0..162e914 100644 --- a/instana_client/models/rule_with_threshold_infra_alert_rule.py +++ b/instana_client/models/rule_with_threshold_infra_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/rule_with_threshold_log_alert_rule.py b/instana_client/models/rule_with_threshold_log_alert_rule.py index ae8dca9..35f055d 100644 --- a/instana_client/models/rule_with_threshold_log_alert_rule.py +++ b/instana_client/models/rule_with_threshold_log_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/rule_with_threshold_mobile_app_alert_rule.py b/instana_client/models/rule_with_threshold_mobile_app_alert_rule.py index 1cba53e..a1a08d4 100644 --- a/instana_client/models/rule_with_threshold_mobile_app_alert_rule.py +++ b/instana_client/models/rule_with_threshold_mobile_app_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/rule_with_threshold_website_alert_rule.py b/instana_client/models/rule_with_threshold_website_alert_rule.py index f86ef2b..92dde16 100644 --- a/instana_client/models/rule_with_threshold_website_alert_rule.py +++ b/instana_client/models/rule_with_threshold_website_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/run_configuration.py b/instana_client/models/run_configuration.py index ddacf06..f4f7086 100644 --- a/instana_client/models/run_configuration.py +++ b/instana_client/models/run_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/salesforce_integration.py b/instana_client/models/salesforce_integration.py index aa126a9..302a5f0 100644 --- a/instana_client/models/salesforce_integration.py +++ b/instana_client/models/salesforce_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/saturation_blueprint_indicator.py b/instana_client/models/saturation_blueprint_indicator.py index dc08cc3..8e57696 100644 --- a/instana_client/models/saturation_blueprint_indicator.py +++ b/instana_client/models/saturation_blueprint_indicator.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/scope_binding.py b/instana_client/models/scope_binding.py index a7e293a..be172da 100644 --- a/instana_client/models/scope_binding.py +++ b/instana_client/models/scope_binding.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/search_field_result.py b/instana_client/models/search_field_result.py index dd6fb20..c8d3754 100644 --- a/instana_client/models/search_field_result.py +++ b/instana_client/models/search_field_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service.py b/instana_client/models/service.py index a7b84ca..4cd5672 100644 --- a/instana_client/models/service.py +++ b/instana_client/models/service.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_config.py b/instana_client/models/service_config.py index 5a3be8a..2c891ee 100644 --- a/instana_client/models/service_config.py +++ b/instana_client/models/service_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_event_result.py b/instana_client/models/service_event_result.py index 4f83bec..5a70ee3 100644 --- a/instana_client/models/service_event_result.py +++ b/instana_client/models/service_event_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_item.py b/instana_client/models/service_item.py index 03922a6..778b6a9 100644 --- a/instana_client/models/service_item.py +++ b/instana_client/models/service_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_level_indicator.py b/instana_client/models/service_level_indicator.py index 5a9cfae..2f67518 100644 --- a/instana_client/models/service_level_indicator.py +++ b/instana_client/models/service_level_indicator.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_level_objective_alert_rule.py b/instana_client/models/service_level_objective_alert_rule.py index 88e212e..5555c09 100644 --- a/instana_client/models/service_level_objective_alert_rule.py +++ b/instana_client/models/service_level_objective_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_levels_alert_config.py b/instana_client/models/service_levels_alert_config.py index bb7a996..ad78a1e 100644 --- a/instana_client/models/service_levels_alert_config.py +++ b/instana_client/models/service_levels_alert_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_levels_alert_config_with_rbac_tag.py b/instana_client/models/service_levels_alert_config_with_rbac_tag.py index 9317884..d97d2cc 100644 --- a/instana_client/models/service_levels_alert_config_with_rbac_tag.py +++ b/instana_client/models/service_levels_alert_config_with_rbac_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_levels_alert_rule.py b/instana_client/models/service_levels_alert_rule.py index 5c73669..8a69033 100644 --- a/instana_client/models/service_levels_alert_rule.py +++ b/instana_client/models/service_levels_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_levels_burn_rate_config.py b/instana_client/models/service_levels_burn_rate_config.py index a5af0b9..2315354 100644 --- a/instana_client/models/service_levels_burn_rate_config.py +++ b/instana_client/models/service_levels_burn_rate_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_levels_burn_rate_time_windows.py b/instana_client/models/service_levels_burn_rate_time_windows.py index d725196..4f90f0a 100644 --- a/instana_client/models/service_levels_burn_rate_time_windows.py +++ b/instana_client/models/service_levels_burn_rate_time_windows.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_levels_static_threshold_config.py b/instana_client/models/service_levels_static_threshold_config.py index e10f083..afd1541 100644 --- a/instana_client/models/service_levels_static_threshold_config.py +++ b/instana_client/models/service_levels_static_threshold_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_levels_time_threshold.py b/instana_client/models/service_levels_time_threshold.py index b5e91b3..207cb79 100644 --- a/instana_client/models/service_levels_time_threshold.py +++ b/instana_client/models/service_levels_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_levelse_alert_config_with_metadata.py b/instana_client/models/service_levelse_alert_config_with_metadata.py index a50b818..d23d2ef 100644 --- a/instana_client/models/service_levelse_alert_config_with_metadata.py +++ b/instana_client/models/service_levelse_alert_config_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_map.py b/instana_client/models/service_map.py index 1d9b2b5..e9cadee 100644 --- a/instana_client/models/service_map.py +++ b/instana_client/models/service_map.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_map_connection.py b/instana_client/models/service_map_connection.py index e0457ef..e6e0374 100644 --- a/instana_client/models/service_map_connection.py +++ b/instana_client/models/service_map_connection.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_matching_rule.py b/instana_client/models/service_matching_rule.py index 6919833..961b0be 100644 --- a/instana_client/models/service_matching_rule.py +++ b/instana_client/models/service_matching_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_metric_result.py b/instana_client/models/service_metric_result.py index 78ab62d..e5afddd 100644 --- a/instana_client/models/service_metric_result.py +++ b/instana_client/models/service_metric_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_node.py b/instana_client/models/service_node.py index fb224fd..1185daa 100644 --- a/instana_client/models/service_node.py +++ b/instana_client/models/service_node.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_now_enhanced_integration.py b/instana_client/models/service_now_enhanced_integration.py index 11ccb0e..ce60a36 100644 --- a/instana_client/models/service_now_enhanced_integration.py +++ b/instana_client/models/service_now_enhanced_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_now_integration.py b/instana_client/models/service_now_integration.py index db6e58f..0201ed4 100644 --- a/instana_client/models/service_now_integration.py +++ b/instana_client/models/service_now_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_result.py b/instana_client/models/service_result.py index 5ca0f0b..c906b57 100644 --- a/instana_client/models/service_result.py +++ b/instana_client/models/service_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_scope.py b/instana_client/models/service_scope.py index 5fda3b3..819cf6e 100644 --- a/instana_client/models/service_scope.py +++ b/instana_client/models/service_scope.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_scope_with_metadata.py b/instana_client/models/service_scope_with_metadata.py index d647fb5..d733c80 100644 --- a/instana_client/models/service_scope_with_metadata.py +++ b/instana_client/models/service_scope_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_scoped_to.py b/instana_client/models/service_scoped_to.py index 2aaa8e5..12bb83e 100644 --- a/instana_client/models/service_scoped_to.py +++ b/instana_client/models/service_scoped_to.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_scoped_to_with_metadata.py b/instana_client/models/service_scoped_to_with_metadata.py index a1e1373..f3640bb 100644 --- a/instana_client/models/service_scoped_to_with_metadata.py +++ b/instana_client/models/service_scoped_to_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/service_simple.py b/instana_client/models/service_simple.py index 484880b..b0e494c 100644 --- a/instana_client/models/service_simple.py +++ b/instana_client/models/service_simple.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/session_settings.py b/instana_client/models/session_settings.py index c7788d6..23609d8 100644 --- a/instana_client/models/session_settings.py +++ b/instana_client/models/session_settings.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/simple_metric_configuration.py b/instana_client/models/simple_metric_configuration.py index fa222dd..491da08 100644 --- a/instana_client/models/simple_metric_configuration.py +++ b/instana_client/models/simple_metric_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -21,7 +21,6 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional, Union from typing_extensions import Annotated -from instana_client.models.arithmetic_operation import ArithmeticOperation from typing import Optional, Set from typing_extensions import Self @@ -36,8 +35,7 @@ class SimpleMetricConfiguration(BaseModel): missing_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="missingValue") regex: Optional[StrictBool] = None required: Optional[StrictBool] = Field(default=None, description="When true, metric must be present with values") - operation: Optional[ArithmeticOperation] = None - __properties: ClassVar[List[str]] = ["aggregation", "crossSeriesAggregation", "granularity", "metric", "missingValue", "regex", "required", "operation"] + __properties: ClassVar[List[str]] = ["aggregation", "crossSeriesAggregation", "granularity", "metric", "missingValue", "regex", "required"] @field_validator('aggregation') def aggregation_validate_enum(cls, value): @@ -95,9 +93,6 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of operation - if self.operation: - _dict['operation'] = self.operation.to_dict() return _dict @classmethod @@ -116,8 +111,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "metric": obj.get("metric"), "missingValue": obj.get("missingValue"), "regex": obj.get("regex"), - "required": obj.get("required"), - "operation": ArithmeticOperation.from_dict(obj["operation"]) if obj.get("operation") is not None else None + "required": obj.get("required") }) return _obj diff --git a/instana_client/models/slack_integration.py b/instana_client/models/slack_integration.py index c3f1be4..b60e44a 100644 --- a/instana_client/models/slack_integration.py +++ b/instana_client/models/slack_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/sli_configuration.py b/instana_client/models/sli_configuration.py index 1cbd618..d1679d9 100644 --- a/instana_client/models/sli_configuration.py +++ b/instana_client/models/sli_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/sli_configuration_with_last_updated.py b/instana_client/models/sli_configuration_with_last_updated.py index 17a178c..c0e98ff 100644 --- a/instana_client/models/sli_configuration_with_last_updated.py +++ b/instana_client/models/sli_configuration_with_last_updated.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/sli_entity.py b/instana_client/models/sli_entity.py index b3ca15e..5eecfe8 100644 --- a/instana_client/models/sli_entity.py +++ b/instana_client/models/sli_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/sli_report.py b/instana_client/models/sli_report.py index 1694fb4..f39d79c 100644 --- a/instana_client/models/sli_report.py +++ b/instana_client/models/sli_report.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/slo_config_with_rbac_tag.py b/instana_client/models/slo_config_with_rbac_tag.py index 4ce6f6d..a9bb51a 100644 --- a/instana_client/models/slo_config_with_rbac_tag.py +++ b/instana_client/models/slo_config_with_rbac_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/slo_entity.py b/instana_client/models/slo_entity.py index 5d98ca1..950e355 100644 --- a/instana_client/models/slo_entity.py +++ b/instana_client/models/slo_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/slo_report.py b/instana_client/models/slo_report.py index 77df40d..dde842c 100644 --- a/instana_client/models/slo_report.py +++ b/instana_client/models/slo_report.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/slowness_application_alert_rule.py b/instana_client/models/slowness_application_alert_rule.py index d4ba790..9648168 100644 --- a/instana_client/models/slowness_application_alert_rule.py +++ b/instana_client/models/slowness_application_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/slowness_mobile_app_alert_rule.py b/instana_client/models/slowness_mobile_app_alert_rule.py index 1738690..01f2c01 100644 --- a/instana_client/models/slowness_mobile_app_alert_rule.py +++ b/instana_client/models/slowness_mobile_app_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/slowness_website_alert_rule.py b/instana_client/models/slowness_website_alert_rule.py index 944064c..0f3b381 100644 --- a/instana_client/models/slowness_website_alert_rule.py +++ b/instana_client/models/slowness_website_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/snapshot_item.py b/instana_client/models/snapshot_item.py index d263cc9..eb7329d 100644 --- a/instana_client/models/snapshot_item.py +++ b/instana_client/models/snapshot_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/snapshot_preview.py b/instana_client/models/snapshot_preview.py index f2249f8..7837dc5 100644 --- a/instana_client/models/snapshot_preview.py +++ b/instana_client/models/snapshot_preview.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/snapshot_result.py b/instana_client/models/snapshot_result.py index 8145a97..2d69094 100644 --- a/instana_client/models/snapshot_result.py +++ b/instana_client/models/snapshot_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/software_user.py b/instana_client/models/software_user.py index bf6be58..9952013 100644 --- a/instana_client/models/software_user.py +++ b/instana_client/models/software_user.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/software_version.py b/instana_client/models/software_version.py index 25f608f..79c2cb8 100644 --- a/instana_client/models/software_version.py +++ b/instana_client/models/software_version.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/source_map_file_blob.py b/instana_client/models/source_map_file_blob.py index 4880ade..ce623c1 100644 --- a/instana_client/models/source_map_file_blob.py +++ b/instana_client/models/source_map_file_blob.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/source_map_file_meta.py b/instana_client/models/source_map_file_meta.py index 19d4068..722a3b2 100644 --- a/instana_client/models/source_map_file_meta.py +++ b/instana_client/models/source_map_file_meta.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/source_map_upload_config.py b/instana_client/models/source_map_upload_config.py index 0eb65d4..ec2655d 100644 --- a/instana_client/models/source_map_upload_config.py +++ b/instana_client/models/source_map_upload_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/source_map_upload_configs.py b/instana_client/models/source_map_upload_configs.py index 63c3e2b..3dab896 100644 --- a/instana_client/models/source_map_upload_configs.py +++ b/instana_client/models/source_map_upload_configs.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/span_excerpt.py b/instana_client/models/span_excerpt.py index cc6f00f..df7ebde 100644 --- a/instana_client/models/span_excerpt.py +++ b/instana_client/models/span_excerpt.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/span_relation.py b/instana_client/models/span_relation.py index 0a15bbc..6ce3317 100644 --- a/instana_client/models/span_relation.py +++ b/instana_client/models/span_relation.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/specific_js_errors_website_alert_rule.py b/instana_client/models/specific_js_errors_website_alert_rule.py index 80916f1..e278d4e 100644 --- a/instana_client/models/specific_js_errors_website_alert_rule.py +++ b/instana_client/models/specific_js_errors_website_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/splunk_integration.py b/instana_client/models/splunk_integration.py index 2527a6a..ed6fcba 100644 --- a/instana_client/models/splunk_integration.py +++ b/instana_client/models/splunk_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/ssl_certificate_configuration.py b/instana_client/models/ssl_certificate_configuration.py index eb28c0f..7161ac6 100644 --- a/instana_client/models/ssl_certificate_configuration.py +++ b/instana_client/models/ssl_certificate_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/ssl_certificate_configuration_update.py b/instana_client/models/ssl_certificate_configuration_update.py index 8fdc1e3..3fd5cb8 100644 --- a/instana_client/models/ssl_certificate_configuration_update.py +++ b/instana_client/models/ssl_certificate_configuration_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/ssl_certificate_validation.py b/instana_client/models/ssl_certificate_validation.py index f8a6e2e..4500eaa 100644 --- a/instana_client/models/ssl_certificate_validation.py +++ b/instana_client/models/ssl_certificate_validation.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -35,8 +35,8 @@ class SSLCertificateValidation(BaseModel): @field_validator('operator') def operator_validate_enum(cls, value): """Validates the enum""" - if value not in set(['CONTAINS', 'EQUALS', 'GREATER_THAN', 'IS', 'LESS_THAN', 'MATCHES', 'NOT_MATCHES']): - raise ValueError("must be one of enum values ('CONTAINS', 'EQUALS', 'GREATER_THAN', 'IS', 'LESS_THAN', 'MATCHES', 'NOT_MATCHES')") + if value not in set(['CONTAINS', 'EQUALS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'IS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'MATCHES', 'NOT_MATCHES']): + raise ValueError("must be one of enum values ('CONTAINS', 'EQUALS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'IS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'MATCHES', 'NOT_MATCHES')") return value model_config = ConfigDict( diff --git a/instana_client/models/stack_trace_item.py b/instana_client/models/stack_trace_item.py index d00a48e..facfd8c 100644 --- a/instana_client/models/stack_trace_item.py +++ b/instana_client/models/stack_trace_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/stack_trace_line.py b/instana_client/models/stack_trace_line.py index 80aa538..a4f860c 100644 --- a/instana_client/models/stack_trace_line.py +++ b/instana_client/models/stack_trace_line.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/static_baseline_threshold_rule.py b/instana_client/models/static_baseline_threshold_rule.py index f6d918b..825d867 100644 --- a/instana_client/models/static_baseline_threshold_rule.py +++ b/instana_client/models/static_baseline_threshold_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/static_string_field.py b/instana_client/models/static_string_field.py index e41bfc6..3bf38da 100644 --- a/instana_client/models/static_string_field.py +++ b/instana_client/models/static_string_field.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/static_threshold.py b/instana_client/models/static_threshold.py index bd85563..3c90d1d 100644 --- a/instana_client/models/static_threshold.py +++ b/instana_client/models/static_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/static_threshold_rule.py b/instana_client/models/static_threshold_rule.py index 2954c88..42c700a 100644 --- a/instana_client/models/static_threshold_rule.py +++ b/instana_client/models/static_threshold_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/status_code_application_alert_rule.py b/instana_client/models/status_code_application_alert_rule.py index c2f7b08..1fad905 100644 --- a/instana_client/models/status_code_application_alert_rule.py +++ b/instana_client/models/status_code_application_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/status_code_mobile_app_alert_rule.py b/instana_client/models/status_code_mobile_app_alert_rule.py index 91e1579..a9d494b 100644 --- a/instana_client/models/status_code_mobile_app_alert_rule.py +++ b/instana_client/models/status_code_mobile_app_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/status_code_website_alert_rule.py b/instana_client/models/status_code_website_alert_rule.py index 19bb567..918824d 100644 --- a/instana_client/models/status_code_website_alert_rule.py +++ b/instana_client/models/status_code_website_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_alert_config.py b/instana_client/models/synthetic_alert_config.py index 7726d62..9ea158b 100644 --- a/instana_client/models/synthetic_alert_config.py +++ b/instana_client/models/synthetic_alert_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_alert_config_with_metadata.py b/instana_client/models/synthetic_alert_config_with_metadata.py index 1db181c..966baaa 100644 --- a/instana_client/models/synthetic_alert_config_with_metadata.py +++ b/instana_client/models/synthetic_alert_config_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_alert_config_with_rbac_tag.py b/instana_client/models/synthetic_alert_config_with_rbac_tag.py index 9422a67..649e5af 100644 --- a/instana_client/models/synthetic_alert_config_with_rbac_tag.py +++ b/instana_client/models/synthetic_alert_config_with_rbac_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_alert_rule.py b/instana_client/models/synthetic_alert_rule.py index 12b8d64..18233c2 100644 --- a/instana_client/models/synthetic_alert_rule.py +++ b/instana_client/models/synthetic_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_bulk_response.py b/instana_client/models/synthetic_bulk_response.py index 35f37ed..11ea822 100644 --- a/instana_client/models/synthetic_bulk_response.py +++ b/instana_client/models/synthetic_bulk_response.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_call_config.py b/instana_client/models/synthetic_call_config.py index e45d2e5..0bb0c60 100644 --- a/instana_client/models/synthetic_call_config.py +++ b/instana_client/models/synthetic_call_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_call_rule.py b/instana_client/models/synthetic_call_rule.py index c992ee5..7268707 100644 --- a/instana_client/models/synthetic_call_rule.py +++ b/instana_client/models/synthetic_call_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_call_with_defaults_config.py b/instana_client/models/synthetic_call_with_defaults_config.py index 3ecd29b..77294f0 100644 --- a/instana_client/models/synthetic_call_with_defaults_config.py +++ b/instana_client/models/synthetic_call_with_defaults_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_configuration.py b/instana_client/models/synthetic_configuration.py index 287bece..8ec9ea3 100644 --- a/instana_client/models/synthetic_configuration.py +++ b/instana_client/models/synthetic_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_configuration_update.py b/instana_client/models/synthetic_configuration_update.py index cdfdab2..3057d7a 100644 --- a/instana_client/models/synthetic_configuration_update.py +++ b/instana_client/models/synthetic_configuration_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_credential.py b/instana_client/models/synthetic_credential.py index 211f982..558960d 100644 --- a/instana_client/models/synthetic_credential.py +++ b/instana_client/models/synthetic_credential.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_datacenter.py b/instana_client/models/synthetic_datacenter.py index e05fbae..1b642b6 100644 --- a/instana_client/models/synthetic_datacenter.py +++ b/instana_client/models/synthetic_datacenter.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_datacenter_configuration.py b/instana_client/models/synthetic_datacenter_configuration.py index 50b63e5..5dc3574 100644 --- a/instana_client/models/synthetic_datacenter_configuration.py +++ b/instana_client/models/synthetic_datacenter_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_geo_point.py b/instana_client/models/synthetic_geo_point.py index 96456db..b31d2e8 100644 --- a/instana_client/models/synthetic_geo_point.py +++ b/instana_client/models/synthetic_geo_point.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_location.py b/instana_client/models/synthetic_location.py index 11e2432..1f5b4d3 100644 --- a/instana_client/models/synthetic_location.py +++ b/instana_client/models/synthetic_location.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_location_configuration.py b/instana_client/models/synthetic_location_configuration.py index 680f254..f376666 100644 --- a/instana_client/models/synthetic_location_configuration.py +++ b/instana_client/models/synthetic_location_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_metric_configuration.py b/instana_client/models/synthetic_metric_configuration.py index 8a1b028..c595d10 100644 --- a/instana_client/models/synthetic_metric_configuration.py +++ b/instana_client/models/synthetic_metric_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_metric_tag_group.py b/instana_client/models/synthetic_metric_tag_group.py index 81d0fa8..802da32 100644 --- a/instana_client/models/synthetic_metric_tag_group.py +++ b/instana_client/models/synthetic_metric_tag_group.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_playback_capabilities.py b/instana_client/models/synthetic_playback_capabilities.py index 9003fdb..4b4f94b 100644 --- a/instana_client/models/synthetic_playback_capabilities.py +++ b/instana_client/models/synthetic_playback_capabilities.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value.py b/instana_client/models/synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value.py index 924efb2..06647ef 100644 --- a/instana_client/models/synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value.py +++ b/instana_client/models/synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_resource_update_list_icmp_validation_list_icmp_validation.py b/instana_client/models/synthetic_resource_update_list_icmp_validation_list_icmp_validation.py new file mode 100644 index 0000000..30fc517 --- /dev/null +++ b/instana_client/models/synthetic_resource_update_list_icmp_validation_list_icmp_validation.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from instana_client.models.icmp_validation import ICMPValidation +from typing import Optional, Set +from typing_extensions import Self + +class SyntheticResourceUpdateListICMPValidationListICMPValidation(BaseModel): + """ + SyntheticResourceUpdateListICMPValidationListICMPValidation + """ # noqa: E501 + add: Optional[List[ICMPValidation]] = None + remove: Optional[List[ICMPValidation]] = None + __properties: ClassVar[List[str]] = ["add", "remove"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SyntheticResourceUpdateListICMPValidationListICMPValidation from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in add (list) + _items = [] + if self.add: + for _item_add in self.add: + if _item_add: + _items.append(_item_add.to_dict()) + _dict['add'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in remove (list) + _items = [] + if self.remove: + for _item_remove in self.remove: + if _item_remove: + _items.append(_item_remove.to_dict()) + _dict['remove'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SyntheticResourceUpdateListICMPValidationListICMPValidation from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "add": [ICMPValidation.from_dict(_item) for _item in obj["add"]] if obj.get("add") is not None else None, + "remove": [ICMPValidation.from_dict(_item) for _item in obj["remove"]] if obj.get("remove") is not None else None + }) + return _obj + + diff --git a/instana_client/models/synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation.py b/instana_client/models/synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation.py index d0cf56e..cb931fb 100644 --- a/instana_client/models/synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation.py +++ b/instana_client/models/synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_resource_update_list_string_list_string.py b/instana_client/models/synthetic_resource_update_list_string_list_string.py index 9e9b932..95ab369 100644 --- a/instana_client/models/synthetic_resource_update_list_string_list_string.py +++ b/instana_client/models/synthetic_resource_update_list_string_list_string.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_resource_update_map_string_string_list_string.py b/instana_client/models/synthetic_resource_update_map_string_string_list_string.py index 0770c27..573ba06 100644 --- a/instana_client/models/synthetic_resource_update_map_string_string_list_string.py +++ b/instana_client/models/synthetic_resource_update_map_string_string_list_string.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_slo_entity.py b/instana_client/models/synthetic_slo_entity.py index 0c5b7ef..1519bde 100644 --- a/instana_client/models/synthetic_slo_entity.py +++ b/instana_client/models/synthetic_slo_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_test.py b/instana_client/models/synthetic_test.py index b876368..6999f78 100644 --- a/instana_client/models/synthetic_test.py +++ b/instana_client/models/synthetic_test.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_test_cicd.py b/instana_client/models/synthetic_test_cicd.py index 980b387..58f5208 100644 --- a/instana_client/models/synthetic_test_cicd.py +++ b/instana_client/models/synthetic_test_cicd.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_test_cicd_customization.py b/instana_client/models/synthetic_test_cicd_customization.py index 2da69ae..a832e55 100644 --- a/instana_client/models/synthetic_test_cicd_customization.py +++ b/instana_client/models/synthetic_test_cicd_customization.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_test_cicd_item.py b/instana_client/models/synthetic_test_cicd_item.py index 637db85..3f3c2ec 100644 --- a/instana_client/models/synthetic_test_cicd_item.py +++ b/instana_client/models/synthetic_test_cicd_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_test_cicd_response.py b/instana_client/models/synthetic_test_cicd_response.py index 8d7b6a0..a7855ad 100644 --- a/instana_client/models/synthetic_test_cicd_response.py +++ b/instana_client/models/synthetic_test_cicd_response.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_test_deep_update.py b/instana_client/models/synthetic_test_deep_update.py index aa70834..8a70606 100644 --- a/instana_client/models/synthetic_test_deep_update.py +++ b/instana_client/models/synthetic_test_deep_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_test_shallow_update.py b/instana_client/models/synthetic_test_shallow_update.py index 83c1634..d7c8da7 100644 --- a/instana_client/models/synthetic_test_shallow_update.py +++ b/instana_client/models/synthetic_test_shallow_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_test_update.py b/instana_client/models/synthetic_test_update.py index 2528354..1c0f0d0 100644 --- a/instana_client/models/synthetic_test_update.py +++ b/instana_client/models/synthetic_test_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_time_threshold.py b/instana_client/models/synthetic_time_threshold.py index 4aba1f2..ba1039d 100644 --- a/instana_client/models/synthetic_time_threshold.py +++ b/instana_client/models/synthetic_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_type_configuration.py b/instana_client/models/synthetic_type_configuration.py index 01dd845..9c23923 100644 --- a/instana_client/models/synthetic_type_configuration.py +++ b/instana_client/models/synthetic_type_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -31,6 +31,7 @@ from instana_client.models.dns_configuration import DNSConfiguration from instana_client.models.http_action_configuration import HttpActionConfiguration from instana_client.models.http_script_configuration import HttpScriptConfiguration + from instana_client.models.icmp_configuration import ICMPConfiguration from instana_client.models.empty_configuration import EmptyConfiguration from instana_client.models.ssl_certificate_configuration import SSLCertificateConfiguration from instana_client.models.webpage_action_configuration import WebpageActionConfiguration @@ -50,8 +51,8 @@ class SyntheticTypeConfiguration(BaseModel): @field_validator('synthetic_type') def synthetic_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured']): - raise ValueError("must be one of enum values ('BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured')") + if value not in set(['BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'ICMP', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured']): + raise ValueError("must be one of enum values ('BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'ICMP', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured')") return value model_config = ConfigDict( @@ -66,7 +67,7 @@ def synthetic_type_validate_enum(cls, value): # discriminator mappings __discriminator_value_class_map: ClassVar[Dict[str, str]] = { - 'BrowserScript': 'BrowserScriptConfiguration','DNS': 'DNSConfiguration','HTTPAction': 'HttpActionConfiguration','HTTPScript': 'HttpScriptConfiguration','NotConfigured': 'EmptyConfiguration','SSLCertificate': 'SSLCertificateConfiguration','WebpageAction': 'WebpageActionConfiguration','WebpageScript': 'WebpageScriptConfiguration' + 'BrowserScript': 'BrowserScriptConfiguration','DNS': 'DNSConfiguration','HTTPAction': 'HttpActionConfiguration','HTTPScript': 'HttpScriptConfiguration','ICMP': 'ICMPConfiguration','NotConfigured': 'EmptyConfiguration','SSLCertificate': 'SSLCertificateConfiguration','WebpageAction': 'WebpageActionConfiguration','WebpageScript': 'WebpageScriptConfiguration' } @classmethod @@ -88,7 +89,7 @@ def to_json(self) -> str: return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> Optional[Union[BrowserScriptConfiguration, DNSConfiguration, HttpActionConfiguration, HttpScriptConfiguration, EmptyConfiguration, SSLCertificateConfiguration, WebpageActionConfiguration, WebpageScriptConfiguration]]: + def from_json(cls, json_str: str) -> Optional[Union[BrowserScriptConfiguration, DNSConfiguration, HttpActionConfiguration, HttpScriptConfiguration, ICMPConfiguration, EmptyConfiguration, SSLCertificateConfiguration, WebpageActionConfiguration, WebpageScriptConfiguration]]: """Create an instance of SyntheticTypeConfiguration from a JSON string""" return cls.from_dict(json.loads(json_str)) @@ -113,7 +114,7 @@ def to_dict(self) -> Dict[str, Any]: return _dict @classmethod - def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[BrowserScriptConfiguration, DNSConfiguration, HttpActionConfiguration, HttpScriptConfiguration, EmptyConfiguration, SSLCertificateConfiguration, WebpageActionConfiguration, WebpageScriptConfiguration]]: + def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[BrowserScriptConfiguration, DNSConfiguration, HttpActionConfiguration, HttpScriptConfiguration, ICMPConfiguration, EmptyConfiguration, SSLCertificateConfiguration, WebpageActionConfiguration, WebpageScriptConfiguration]]: """Create an instance of SyntheticTypeConfiguration from a dict""" # look up the object type based on discriminator mapping object_type = cls.get_discriminator_value(obj) @@ -125,6 +126,8 @@ def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[BrowserScriptConfigura return import_module("instana_client.models.http_action_configuration").HttpActionConfiguration.from_dict(obj) if object_type == 'HttpScriptConfiguration': return import_module("instana_client.models.http_script_configuration").HttpScriptConfiguration.from_dict(obj) + if object_type == 'ICMPConfiguration': + return import_module("instana_client.models.icmp_configuration").ICMPConfiguration.from_dict(obj) if object_type == 'EmptyConfiguration': return import_module("instana_client.models.empty_configuration").EmptyConfiguration.from_dict(obj) if object_type == 'SSLCertificateConfiguration': diff --git a/instana_client/models/synthetic_type_configuration_update.py b/instana_client/models/synthetic_type_configuration_update.py index 2e8c5fd..7d2c2a0 100644 --- a/instana_client/models/synthetic_type_configuration_update.py +++ b/instana_client/models/synthetic_type_configuration_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -31,13 +31,14 @@ from instana_client.models.dns_configuration_update import DNSConfigurationUpdate from instana_client.models.http_action_configuration_update import HttpActionConfigurationUpdate from instana_client.models.http_script_configuration_update import HttpScriptConfigurationUpdate + from instana_client.models.icmp_configuration_update import ICMPConfigurationUpdate from instana_client.models.ssl_certificate_configuration_update import SSLCertificateConfigurationUpdate from instana_client.models.webpage_action_configuration_update import WebpageActionConfigurationUpdate from instana_client.models.webpage_script_configuration_update import WebpageScriptConfigurationUpdate class SyntheticTypeConfigurationUpdate(BaseModel): """ - Synthetic test configuration that is unique to a synthetic type. Valid types are BrowserScript, DNS, HTTPAction, HTTPScript, SSLCertificate, WebpageAction, and WebpageScript. + Synthetic test configuration that is unique to a synthetic type. Valid types are BrowserScript, DNS, HTTPAction, HTTPScript, ICMP, SSLCertificate, WebpageAction, and WebpageScript. """ # noqa: E501 mark_synthetic_call: Optional[StrictBool] = Field(default=None, alias="markSyntheticCall") retries: Optional[Annotated[int, Field(le=2, strict=True, ge=0)]] = None @@ -53,8 +54,8 @@ def synthetic_test_validate_enum(cls, value): if value is None: return value - if value not in set(['BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured']): - raise ValueError("must be one of enum values ('BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured')") + if value not in set(['BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'ICMP', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured']): + raise ValueError("must be one of enum values ('BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'ICMP', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured')") return value @field_validator('synthetic_type') @@ -63,8 +64,8 @@ def synthetic_type_validate_enum(cls, value): if value is None: return value - if value not in set(['BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured']): - raise ValueError("must be one of enum values ('BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured')") + if value not in set(['BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'ICMP', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured']): + raise ValueError("must be one of enum values ('BrowserScript', 'DNS', 'HTTPAction', 'HTTPScript', 'ICMP', 'SSLCertificate', 'WebpageAction', 'WebpageScript', 'NotConfigured')") return value model_config = ConfigDict( @@ -79,7 +80,7 @@ def synthetic_type_validate_enum(cls, value): # discriminator mappings __discriminator_value_class_map: ClassVar[Dict[str, str]] = { - 'BrowserScript': 'BrowserScriptConfigurationUpdate','DNS': 'DNSConfigurationUpdate','HTTPAction': 'HttpActionConfigurationUpdate','HTTPScript': 'HttpScriptConfigurationUpdate','SSLCertificate': 'SSLCertificateConfigurationUpdate','WebpageAction': 'WebpageActionConfigurationUpdate','WebpageScript': 'WebpageScriptConfigurationUpdate' + 'BrowserScript': 'BrowserScriptConfigurationUpdate','DNS': 'DNSConfigurationUpdate','HTTPAction': 'HttpActionConfigurationUpdate','HTTPScript': 'HttpScriptConfigurationUpdate','ICMP': 'ICMPConfigurationUpdate','SSLCertificate': 'SSLCertificateConfigurationUpdate','WebpageAction': 'WebpageActionConfigurationUpdate','WebpageScript': 'WebpageScriptConfigurationUpdate' } @classmethod @@ -101,7 +102,7 @@ def to_json(self) -> str: return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> Optional[Union[BrowserScriptConfigurationUpdate, DNSConfigurationUpdate, HttpActionConfigurationUpdate, HttpScriptConfigurationUpdate, SSLCertificateConfigurationUpdate, WebpageActionConfigurationUpdate, WebpageScriptConfigurationUpdate]]: + def from_json(cls, json_str: str) -> Optional[Union[BrowserScriptConfigurationUpdate, DNSConfigurationUpdate, HttpActionConfigurationUpdate, HttpScriptConfigurationUpdate, ICMPConfigurationUpdate, SSLCertificateConfigurationUpdate, WebpageActionConfigurationUpdate, WebpageScriptConfigurationUpdate]]: """Create an instance of SyntheticTypeConfigurationUpdate from a JSON string""" return cls.from_dict(json.loads(json_str)) @@ -126,7 +127,7 @@ def to_dict(self) -> Dict[str, Any]: return _dict @classmethod - def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[BrowserScriptConfigurationUpdate, DNSConfigurationUpdate, HttpActionConfigurationUpdate, HttpScriptConfigurationUpdate, SSLCertificateConfigurationUpdate, WebpageActionConfigurationUpdate, WebpageScriptConfigurationUpdate]]: + def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[BrowserScriptConfigurationUpdate, DNSConfigurationUpdate, HttpActionConfigurationUpdate, HttpScriptConfigurationUpdate, ICMPConfigurationUpdate, SSLCertificateConfigurationUpdate, WebpageActionConfigurationUpdate, WebpageScriptConfigurationUpdate]]: """Create an instance of SyntheticTypeConfigurationUpdate from a dict""" # look up the object type based on discriminator mapping object_type = cls.get_discriminator_value(obj) @@ -138,6 +139,8 @@ def from_dict(cls, obj: Dict[str, Any]) -> Optional[Union[BrowserScriptConfigura return import_module("instana_client.models.http_action_configuration_update").HttpActionConfigurationUpdate.from_dict(obj) if object_type == 'HttpScriptConfigurationUpdate': return import_module("instana_client.models.http_script_configuration_update").HttpScriptConfigurationUpdate.from_dict(obj) + if object_type == 'ICMPConfigurationUpdate': + return import_module("instana_client.models.icmp_configuration_update").ICMPConfigurationUpdate.from_dict(obj) if object_type == 'SSLCertificateConfigurationUpdate': return import_module("instana_client.models.ssl_certificate_configuration_update").SSLCertificateConfigurationUpdate.from_dict(obj) if object_type == 'WebpageActionConfigurationUpdate': diff --git a/instana_client/models/synthetics_event_result.py b/instana_client/models/synthetics_event_result.py index e405d0b..ea8bad2 100644 --- a/instana_client/models/synthetics_event_result.py +++ b/instana_client/models/synthetics_event_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/system_rule.py b/instana_client/models/system_rule.py index 4085e21..c65b8f9 100644 --- a/instana_client/models/system_rule.py +++ b/instana_client/models/system_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/system_rule_label.py b/instana_client/models/system_rule_label.py index 27959d2..ccb12c2 100644 --- a/instana_client/models/system_rule_label.py +++ b/instana_client/models/system_rule_label.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/tag.py b/instana_client/models/tag.py index f91e81c..e728773 100644 --- a/instana_client/models/tag.py +++ b/instana_client/models/tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/tag_catalog.py b/instana_client/models/tag_catalog.py index 68c74f3..57b250d 100644 --- a/instana_client/models/tag_catalog.py +++ b/instana_client/models/tag_catalog.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/tag_filter_expression.py b/instana_client/models/tag_filter_expression.py index 408b450..ee604ea 100644 --- a/instana_client/models/tag_filter_expression.py +++ b/instana_client/models/tag_filter_expression.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/tag_filter_expression_element.py b/instana_client/models/tag_filter_expression_element.py index fe10d69..c708578 100644 --- a/instana_client/models/tag_filter_expression_element.py +++ b/instana_client/models/tag_filter_expression_element.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/tag_matcher_dto.py b/instana_client/models/tag_matcher_dto.py index 7ea1a4f..1a03528 100644 --- a/instana_client/models/tag_matcher_dto.py +++ b/instana_client/models/tag_matcher_dto.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/tag_tree_level.py b/instana_client/models/tag_tree_level.py index 64cf950..49613d9 100644 --- a/instana_client/models/tag_tree_level.py +++ b/instana_client/models/tag_tree_level.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/tag_tree_node.py b/instana_client/models/tag_tree_node.py index 17bcab4..53e7e51 100644 --- a/instana_client/models/tag_tree_node.py +++ b/instana_client/models/tag_tree_node.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/tag_tree_tag.py b/instana_client/models/tag_tree_tag.py index 1d5330a..002120b 100644 --- a/instana_client/models/tag_tree_tag.py +++ b/instana_client/models/tag_tree_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/test_common_properties.py b/instana_client/models/test_common_properties.py index 082add0..14d029f 100644 --- a/instana_client/models/test_common_properties.py +++ b/instana_client/models/test_common_properties.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -21,6 +21,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated +from instana_client.models.api_tag import ApiTag from instana_client.models.location_status import LocationStatus from typing import Optional, Set from typing_extensions import Self @@ -46,11 +47,12 @@ class TestCommonProperties(BaseModel): mobile_application_ids: Optional[List[StrictStr]] = Field(default=None, alias="mobileApplicationIds") mobile_application_labels: Optional[List[StrictStr]] = Field(default=None, alias="mobileApplicationLabels") modified_at: Optional[StrictInt] = Field(default=None, alias="modifiedAt") + rbac_tags: Optional[List[ApiTag]] = Field(default=None, alias="rbacTags") service_id: Optional[StrictStr] = Field(default=None, alias="serviceId") type: Annotated[str, Field(min_length=1, strict=True)] website_ids: Optional[List[StrictStr]] = Field(default=None, alias="websiteIds") website_labels: Optional[List[StrictStr]] = Field(default=None, alias="websiteLabels") - __properties: ClassVar[List[str]] = ["active", "applicationId", "applicationIds", "applicationLabel", "applicationLabels", "createdAt", "frequency", "getWebsiteLabels", "id", "label", "locationDisplayLabels", "locationIds", "locationLabels", "locationStatusList", "mobileApplicationIds", "mobileApplicationLabels", "modifiedAt", "serviceId", "type", "websiteIds", "websiteLabels"] + __properties: ClassVar[List[str]] = ["active", "applicationId", "applicationIds", "applicationLabel", "applicationLabels", "createdAt", "frequency", "getWebsiteLabels", "id", "label", "locationDisplayLabels", "locationIds", "locationLabels", "locationStatusList", "mobileApplicationIds", "mobileApplicationLabels", "modifiedAt", "rbacTags", "serviceId", "type", "websiteIds", "websiteLabels"] model_config = ConfigDict( populate_by_name=True, @@ -98,6 +100,13 @@ def to_dict(self) -> Dict[str, Any]: if _item_location_status_list: _items.append(_item_location_status_list.to_dict()) _dict['locationStatusList'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in rbac_tags (list) + _items = [] + if self.rbac_tags: + for _item_rbac_tags in self.rbac_tags: + if _item_rbac_tags: + _items.append(_item_rbac_tags.to_dict()) + _dict['rbacTags'] = _items return _dict @classmethod @@ -127,6 +136,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "mobileApplicationIds": obj.get("mobileApplicationIds"), "mobileApplicationLabels": obj.get("mobileApplicationLabels"), "modifiedAt": obj.get("modifiedAt"), + "rbacTags": [ApiTag.from_dict(_item) for _item in obj["rbacTags"]] if obj.get("rbacTags") is not None else None, "serviceId": obj.get("serviceId"), "type": obj.get("type"), "websiteIds": obj.get("websiteIds"), diff --git a/instana_client/models/test_connection_response.py b/instana_client/models/test_connection_response.py index 0f7b28b..f584856 100644 --- a/instana_client/models/test_connection_response.py +++ b/instana_client/models/test_connection_response.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/test_last_error.py b/instana_client/models/test_last_error.py index 10976e4..3b8fe5f 100644 --- a/instana_client/models/test_last_error.py +++ b/instana_client/models/test_last_error.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/test_result.py b/instana_client/models/test_result.py index adfaabe..b477956 100644 --- a/instana_client/models/test_result.py +++ b/instana_client/models/test_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/test_result_common_properties.py b/instana_client/models/test_result_common_properties.py index b442b46..13c37ee 100644 --- a/instana_client/models/test_result_common_properties.py +++ b/instana_client/models/test_result_common_properties.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/test_result_detail_data.py b/instana_client/models/test_result_detail_data.py index ad8b46d..bd20178 100644 --- a/instana_client/models/test_result_detail_data.py +++ b/instana_client/models/test_result_detail_data.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/test_result_item.py b/instana_client/models/test_result_item.py index 0974aa7..1762a34 100644 --- a/instana_client/models/test_result_item.py +++ b/instana_client/models/test_result_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/test_result_list_item.py b/instana_client/models/test_result_list_item.py index f9cd3a5..5a0ed96 100644 --- a/instana_client/models/test_result_list_item.py +++ b/instana_client/models/test_result_list_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/test_result_list_result.py b/instana_client/models/test_result_list_result.py index 63652ee..3061489 100644 --- a/instana_client/models/test_result_list_result.py +++ b/instana_client/models/test_result_list_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/test_result_metadata.py b/instana_client/models/test_result_metadata.py index 7c02d58..7311598 100644 --- a/instana_client/models/test_result_metadata.py +++ b/instana_client/models/test_result_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/test_result_subtransaction.py b/instana_client/models/test_result_subtransaction.py index 445cb60..2f94392 100644 --- a/instana_client/models/test_result_subtransaction.py +++ b/instana_client/models/test_result_subtransaction.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/threshold.py b/instana_client/models/threshold.py index a123a48..8383632 100644 --- a/instana_client/models/threshold.py +++ b/instana_client/models/threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/threshold_config_rule.py b/instana_client/models/threshold_config_rule.py index 7fe8f49..6c8afa4 100644 --- a/instana_client/models/threshold_config_rule.py +++ b/instana_client/models/threshold_config_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/threshold_rule.py b/instana_client/models/threshold_rule.py index 51ae505..255caf7 100644 --- a/instana_client/models/threshold_rule.py +++ b/instana_client/models/threshold_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/throughput_application_alert_rule.py b/instana_client/models/throughput_application_alert_rule.py index f562644..7d1b5ee 100644 --- a/instana_client/models/throughput_application_alert_rule.py +++ b/instana_client/models/throughput_application_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/throughput_mobile_app_alert_rule.py b/instana_client/models/throughput_mobile_app_alert_rule.py index 3e0b3fc..7c405aa 100644 --- a/instana_client/models/throughput_mobile_app_alert_rule.py +++ b/instana_client/models/throughput_mobile_app_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/throughput_website_alert_rule.py b/instana_client/models/throughput_website_alert_rule.py index b2599ef..1bfce54 100644 --- a/instana_client/models/throughput_website_alert_rule.py +++ b/instana_client/models/throughput_website_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/time_frame.py b/instana_client/models/time_frame.py index bb9c27f..8f0e7bd 100644 --- a/instana_client/models/time_frame.py +++ b/instana_client/models/time_frame.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/time_window.py b/instana_client/models/time_window.py index 65a1146..1d6ed62 100644 --- a/instana_client/models/time_window.py +++ b/instana_client/models/time_window.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/topology.py b/instana_client/models/topology.py index 022ed64..639fff9 100644 --- a/instana_client/models/topology.py +++ b/instana_client/models/topology.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/trace.py b/instana_client/models/trace.py index a3621b9..1024a9d 100644 --- a/instana_client/models/trace.py +++ b/instana_client/models/trace.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/trace_activity_tree_node_details.py b/instana_client/models/trace_activity_tree_node_details.py index 85dda50..308c67e 100644 --- a/instana_client/models/trace_activity_tree_node_details.py +++ b/instana_client/models/trace_activity_tree_node_details.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/trace_download_result.py b/instana_client/models/trace_download_result.py index 952f0d4..7984fb3 100644 --- a/instana_client/models/trace_download_result.py +++ b/instana_client/models/trace_download_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/trace_groups_item.py b/instana_client/models/trace_groups_item.py index 09090aa..221468e 100644 --- a/instana_client/models/trace_groups_item.py +++ b/instana_client/models/trace_groups_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/trace_groups_result.py b/instana_client/models/trace_groups_result.py index 8ea6149..3cade71 100644 --- a/instana_client/models/trace_groups_result.py +++ b/instana_client/models/trace_groups_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/trace_impact_application_time_threshold.py b/instana_client/models/trace_impact_application_time_threshold.py index ee076e9..1b9c3d3 100644 --- a/instana_client/models/trace_impact_application_time_threshold.py +++ b/instana_client/models/trace_impact_application_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/trace_item.py b/instana_client/models/trace_item.py index c896922..68d1539 100644 --- a/instana_client/models/trace_item.py +++ b/instana_client/models/trace_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/trace_result.py b/instana_client/models/trace_result.py index fa26784..f4d6d00 100644 --- a/instana_client/models/trace_result.py +++ b/instana_client/models/trace_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/traffic_blueprint_indicator.py b/instana_client/models/traffic_blueprint_indicator.py index ce66297..a96fe30 100644 --- a/instana_client/models/traffic_blueprint_indicator.py +++ b/instana_client/models/traffic_blueprint_indicator.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/trigger.py b/instana_client/models/trigger.py index 71142b5..55cf260 100644 --- a/instana_client/models/trigger.py +++ b/instana_client/models/trigger.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/type_configuration.py b/instana_client/models/type_configuration.py index 484f261..883de79 100644 --- a/instana_client/models/type_configuration.py +++ b/instana_client/models/type_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/unsupported_http_path_segment_matching_rule.py b/instana_client/models/unsupported_http_path_segment_matching_rule.py index 302f526..0b2237d 100644 --- a/instana_client/models/unsupported_http_path_segment_matching_rule.py +++ b/instana_client/models/unsupported_http_path_segment_matching_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/updated_business_perspective_config.py b/instana_client/models/updated_business_perspective_config.py index 7be2b93..d38701e 100644 --- a/instana_client/models/updated_business_perspective_config.py +++ b/instana_client/models/updated_business_perspective_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/usage_result.py b/instana_client/models/usage_result.py index 04dd799..c58f66a 100644 --- a/instana_client/models/usage_result.py +++ b/instana_client/models/usage_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/usage_result_items.py b/instana_client/models/usage_result_items.py index c69a736..b51f306 100644 --- a/instana_client/models/usage_result_items.py +++ b/instana_client/models/usage_result_items.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/user_basic_result.py b/instana_client/models/user_basic_result.py index 1fc852f..4e0dd21 100644 --- a/instana_client/models/user_basic_result.py +++ b/instana_client/models/user_basic_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/user_impact_mobile_app_time_threshold.py b/instana_client/models/user_impact_mobile_app_time_threshold.py index 830cdcc..078985d 100644 --- a/instana_client/models/user_impact_mobile_app_time_threshold.py +++ b/instana_client/models/user_impact_mobile_app_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/user_impact_website_time_threshold.py b/instana_client/models/user_impact_website_time_threshold.py index 2311e13..609e7cf 100644 --- a/instana_client/models/user_impact_website_time_threshold.py +++ b/instana_client/models/user_impact_website_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/user_result.py b/instana_client/models/user_result.py index cf63234..c9b613c 100644 --- a/instana_client/models/user_result.py +++ b/instana_client/models/user_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/users_result.py b/instana_client/models/users_result.py index 759036c..e088b7b 100644 --- a/instana_client/models/users_result.py +++ b/instana_client/models/users_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/validated_alerting_channel_input_info.py b/instana_client/models/validated_alerting_channel_input_info.py index 6ae26da..b8595e9 100644 --- a/instana_client/models/validated_alerting_channel_input_info.py +++ b/instana_client/models/validated_alerting_channel_input_info.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/validated_alerting_configuration.py b/instana_client/models/validated_alerting_configuration.py index a1c7b57..bfbd550 100644 --- a/instana_client/models/validated_alerting_configuration.py +++ b/instana_client/models/validated_alerting_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py b/instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py index 7192558..bb6864e 100644 --- a/instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py +++ b/instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/validated_maintenance_config_with_status.py b/instana_client/models/validated_maintenance_config_with_status.py index 7321914..0da299a 100644 --- a/instana_client/models/validated_maintenance_config_with_status.py +++ b/instana_client/models/validated_maintenance_config_with_status.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/victor_ops_integration.py b/instana_client/models/victor_ops_integration.py index c29afe6..aaa4048 100644 --- a/instana_client/models/victor_ops_integration.py +++ b/instana_client/models/victor_ops_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/violations_in_period_application_time_threshold.py b/instana_client/models/violations_in_period_application_time_threshold.py index 507dbf6..73323d1 100644 --- a/instana_client/models/violations_in_period_application_time_threshold.py +++ b/instana_client/models/violations_in_period_application_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/violations_in_period_mobile_app_time_threshold.py b/instana_client/models/violations_in_period_mobile_app_time_threshold.py index 8202861..b65421a 100644 --- a/instana_client/models/violations_in_period_mobile_app_time_threshold.py +++ b/instana_client/models/violations_in_period_mobile_app_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/violations_in_period_website_time_threshold.py b/instana_client/models/violations_in_period_website_time_threshold.py index 7456de5..3bfef37 100644 --- a/instana_client/models/violations_in_period_website_time_threshold.py +++ b/instana_client/models/violations_in_period_website_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/violations_in_sequence_application_time_threshold.py b/instana_client/models/violations_in_sequence_application_time_threshold.py index 7884534..8f96e4c 100644 --- a/instana_client/models/violations_in_sequence_application_time_threshold.py +++ b/instana_client/models/violations_in_sequence_application_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/violations_in_sequence_infra_time_threshold.py b/instana_client/models/violations_in_sequence_infra_time_threshold.py index cf6fadc..a96e174 100644 --- a/instana_client/models/violations_in_sequence_infra_time_threshold.py +++ b/instana_client/models/violations_in_sequence_infra_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/violations_in_sequence_log_time_threshold.py b/instana_client/models/violations_in_sequence_log_time_threshold.py index bb02a04..4fa63a0 100644 --- a/instana_client/models/violations_in_sequence_log_time_threshold.py +++ b/instana_client/models/violations_in_sequence_log_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/violations_in_sequence_mobile_app_time_threshold.py b/instana_client/models/violations_in_sequence_mobile_app_time_threshold.py index ee2a515..1a72c79 100644 --- a/instana_client/models/violations_in_sequence_mobile_app_time_threshold.py +++ b/instana_client/models/violations_in_sequence_mobile_app_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/violations_in_sequence_synthetic_time_threshold.py b/instana_client/models/violations_in_sequence_synthetic_time_threshold.py index 40ef0b3..167177a 100644 --- a/instana_client/models/violations_in_sequence_synthetic_time_threshold.py +++ b/instana_client/models/violations_in_sequence_synthetic_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/violations_in_sequence_website_time_threshold.py b/instana_client/models/violations_in_sequence_website_time_threshold.py index bc2a270..ca29758 100644 --- a/instana_client/models/violations_in_sequence_website_time_threshold.py +++ b/instana_client/models/violations_in_sequence_website_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/watson_ai_ops_webhook_integration.py b/instana_client/models/watson_ai_ops_webhook_integration.py index 4fb1b32..b857c88 100644 --- a/instana_client/models/watson_ai_ops_webhook_integration.py +++ b/instana_client/models/watson_ai_ops_webhook_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/webex_teams_webhook_integration.py b/instana_client/models/webex_teams_webhook_integration.py index 75fc6b1..f89f7e4 100644 --- a/instana_client/models/webex_teams_webhook_integration.py +++ b/instana_client/models/webex_teams_webhook_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/webhook_integration.py b/instana_client/models/webhook_integration.py index 2bbdd2b..7ca8ebc 100644 --- a/instana_client/models/webhook_integration.py +++ b/instana_client/models/webhook_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/webpage_action_configuration.py b/instana_client/models/webpage_action_configuration.py index 914f233..be1dd6e 100644 --- a/instana_client/models/webpage_action_configuration.py +++ b/instana_client/models/webpage_action_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/webpage_action_configuration_update.py b/instana_client/models/webpage_action_configuration_update.py index e9867f8..dac4e2e 100644 --- a/instana_client/models/webpage_action_configuration_update.py +++ b/instana_client/models/webpage_action_configuration_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/webpage_script_configuration.py b/instana_client/models/webpage_script_configuration.py index e6c2534..4c466c5 100644 --- a/instana_client/models/webpage_script_configuration.py +++ b/instana_client/models/webpage_script_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/webpage_script_configuration_update.py b/instana_client/models/webpage_script_configuration_update.py index 1e257b4..e441c24 100644 --- a/instana_client/models/webpage_script_configuration_update.py +++ b/instana_client/models/webpage_script_configuration_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website.py b/instana_client/models/website.py index a34392b..c0fa4f6 100644 --- a/instana_client/models/website.py +++ b/instana_client/models/website.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_alert_config.py b/instana_client/models/website_alert_config.py index 602bd47..3bd6e64 100644 --- a/instana_client/models/website_alert_config.py +++ b/instana_client/models/website_alert_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_alert_config_with_metadata.py b/instana_client/models/website_alert_config_with_metadata.py index 3a5bdbc..616dc72 100644 --- a/instana_client/models/website_alert_config_with_metadata.py +++ b/instana_client/models/website_alert_config_with_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_alert_config_with_rbac_tag.py b/instana_client/models/website_alert_config_with_rbac_tag.py index 4403297..2586af7 100644 --- a/instana_client/models/website_alert_config_with_rbac_tag.py +++ b/instana_client/models/website_alert_config_with_rbac_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_alert_rule.py b/instana_client/models/website_alert_rule.py index 52c7cea..ca9aea8 100644 --- a/instana_client/models/website_alert_rule.py +++ b/instana_client/models/website_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_apdex_entity.py b/instana_client/models/website_apdex_entity.py index 856f662..938d833 100644 --- a/instana_client/models/website_apdex_entity.py +++ b/instana_client/models/website_apdex_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_beacon_groups_item.py b/instana_client/models/website_beacon_groups_item.py index a3dbfaf..687d4ee 100644 --- a/instana_client/models/website_beacon_groups_item.py +++ b/instana_client/models/website_beacon_groups_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_beacon_groups_result.py b/instana_client/models/website_beacon_groups_result.py index c773f6c..6c30e6f 100644 --- a/instana_client/models/website_beacon_groups_result.py +++ b/instana_client/models/website_beacon_groups_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_beacon_result.py b/instana_client/models/website_beacon_result.py index b93f1b2..8b6ff00 100644 --- a/instana_client/models/website_beacon_result.py +++ b/instana_client/models/website_beacon_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_beacon_tag_group.py b/instana_client/models/website_beacon_tag_group.py index c10a144..60da1ba 100644 --- a/instana_client/models/website_beacon_tag_group.py +++ b/instana_client/models/website_beacon_tag_group.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_beacons_item.py b/instana_client/models/website_beacons_item.py index f31f188..1ece5af 100644 --- a/instana_client/models/website_beacons_item.py +++ b/instana_client/models/website_beacons_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_event_based_sli_entity.py b/instana_client/models/website_event_based_sli_entity.py index 8a1b018..5541db0 100644 --- a/instana_client/models/website_event_based_sli_entity.py +++ b/instana_client/models/website_event_based_sli_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_event_result.py b/instana_client/models/website_event_result.py index f5f8693..bea31b3 100644 --- a/instana_client/models/website_event_result.py +++ b/instana_client/models/website_event_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_metric_result.py b/instana_client/models/website_metric_result.py index a5a2a9a..862e9bf 100644 --- a/instana_client/models/website_metric_result.py +++ b/instana_client/models/website_metric_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_monitoring_beacon.py b/instana_client/models/website_monitoring_beacon.py index b59016b..e29a804 100644 --- a/instana_client/models/website_monitoring_beacon.py +++ b/instana_client/models/website_monitoring_beacon.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_monitoring_metric_description.py b/instana_client/models/website_monitoring_metric_description.py index 2b7739f..20aee30 100644 --- a/instana_client/models/website_monitoring_metric_description.py +++ b/instana_client/models/website_monitoring_metric_description.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_monitoring_metrics_configuration.py b/instana_client/models/website_monitoring_metrics_configuration.py index 185b143..276c7d7 100644 --- a/instana_client/models/website_monitoring_metrics_configuration.py +++ b/instana_client/models/website_monitoring_metrics_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_slo_entity.py b/instana_client/models/website_slo_entity.py index a06bb34..ac71584 100644 --- a/instana_client/models/website_slo_entity.py +++ b/instana_client/models/website_slo_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_time_based_sli_entity.py b/instana_client/models/website_time_based_sli_entity.py index ac292f6..47a7d38 100644 --- a/instana_client/models/website_time_based_sli_entity.py +++ b/instana_client/models/website_time_based_sli_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/website_time_threshold.py b/instana_client/models/website_time_threshold.py index b3eac80..9e87225 100644 --- a/instana_client/models/website_time_threshold.py +++ b/instana_client/models/website_time_threshold.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/widget.py b/instana_client/models/widget.py index ddbf058..815a60d 100644 --- a/instana_client/models/widget.py +++ b/instana_client/models/widget.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/with_meta_data.py b/instana_client/models/with_meta_data.py index 90d1c1a..cfbcddc 100644 --- a/instana_client/models/with_meta_data.py +++ b/instana_client/models/with_meta_data.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/with_resolved_name.py b/instana_client/models/with_resolved_name.py index 02db7d9..3e0bf6c 100644 --- a/instana_client/models/with_resolved_name.py +++ b/instana_client/models/with_resolved_name.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/z_chat_ops_integration.py b/instana_client/models/z_chat_ops_integration.py index 929cc57..1988741 100644 --- a/instana_client/models/z_chat_ops_integration.py +++ b/instana_client/models/z_chat_ops_integration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/rest.py b/instana_client/rest.py index f8cc76b..c4d89e6 100644 --- a/instana_client/rest.py +++ b/instana_client/rest.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/openapi-generator-config.json b/openapi-generator-config.json index 336f817..3e23ca3 100644 --- a/openapi-generator-config.json +++ b/openapi-generator-config.json @@ -1,6 +1,6 @@ { "packageName": "instana_client", "projectName": "instana-client", - "packageVersion": "1.0.7", + "packageVersion": "1.0.8", "packageUrl": "https://github.com/instana/client-python" } diff --git a/openapi.yaml b/openapi.yaml index 7011485..fb86881 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -7,7 +7,7 @@ info: description: Documentation for INSTANA REST API termsOfService: https://www.instana.com/terms-of-use/ title: Instana REST API documentation - version: 1.309.1268 + version: 1.319.1109 x-description: info x-ibm-ahub-try: true x-logo: @@ -91,7 +91,7 @@ tags: x-description: tagGroups - name: Teams x-description: tagTeams -- name: Role +- name: Roles x-description: tagRoles - name: Audit Log x-description: tagAuditLog @@ -559,7 +559,7 @@ paths: tags: - Application Resources x-ibm-ahub-byok: true - /api/application-monitoring/applications;id=/services: + /api/application-monitoring/applications;id={applicationId}/services;id={serviceId}: get: description: |- Use this API endpoint if one wants to retrieve a list of services in an Application Perspective. @@ -568,6 +568,16 @@ paths: For more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources. operationId: getApplicationServices parameters: + - in: path + name: applicationId + required: true + schema: + type: string + - in: path + name: serviceId + required: true + schema: + type: string - description: Name of service (partial match allowed) in: query name: nameFilter @@ -639,7 +649,7 @@ paths: tags: - Application Resources x-ibm-ahub-byok: true - /api/application-monitoring/applications/services/endpoints: + /api/application-monitoring/applications;id={applicationId}/services;id={serviceId}/endpoints;id={endpointId}: get: description: |- Use this API endpoint if one wants to retrieve a list of Endpoints. @@ -648,6 +658,21 @@ paths: For more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources. operationId: getApplicationEndpoints parameters: + - in: path + name: applicationId + required: true + schema: + type: string + - in: path + name: serviceId + required: true + schema: + type: string + - in: path + name: endpointId + required: true + schema: + type: string - description: Name of service in: query name: nameFilter @@ -801,6 +826,17 @@ paths: canApplyToSource: true canApplyToDestination: true idTag: false + dynamicTags: + - icon: otel + prefix: otel_resource + aliases: + - otel.resource + type: STRING_SET + categoryLabels: + - OpenTelemetry + - Resource + canApplyToSource: true + canApplyToDestination: true schema: $ref: '#/components/schemas/TagCatalog' description: OK @@ -1418,7 +1454,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - ConfigureServiceMapping @@ -1727,7 +1763,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureServiceMapping @@ -2597,7 +2633,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. security: @@ -2756,6 +2792,7 @@ paths: schema: type: string description: An Instana generated unique identifier for a trace. + minLength: 1 - in: query name: retrievalSize schema: @@ -2843,6 +2880,7 @@ paths: schema: type: string description: An Instana generated unique identifier for a trace. + minLength: 1 - in: path name: callId required: true @@ -2850,6 +2888,7 @@ paths: type: string description: 'The call ID. A unique identifier for an individual call. For example: `1bcad5c82338deaf`.' + minLength: 1 responses: '200': content: @@ -4004,8 +4043,8 @@ paths: description: Automation policy successfully deleted '403': description: Insufficient permissions. - '412': - description: Automation policy does not exist + '404': + description: Automation policy not found. security: - ApiKeyAuth: - canConfigureAutomationPolicies @@ -4171,6 +4210,8 @@ paths: description: Automation policy successfully updated. '403': description: Insufficient permissions. + '404': + description: Automation policy not found. '412': description: Invalid input value. '500': @@ -4938,6 +4979,7 @@ paths: { "id": "alHaYV5aSkKku_wcg53teQ", "title": "{string}", + "rbacTags": [{"id":"0xHKaxfaS161Al6Qc23g4w","displayName":"team 1"}], "accessRules": [ { "accessType": "READ_WRITE", @@ -5179,7 +5221,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -5567,6 +5609,136 @@ paths: tags: - Events x-ibm-ahub-byok: true + /api/events/settings/alert-configs/bulk/delete: + put: + description: Atomically deletes alert configurations across multiple types. + All operations succeed or all fail. Deletion is logical (creates new version + with deleted=true) to maintain audit trail. Requires appropriate permissions + for each alert config type in the request. For example, deleting WEBSITE and + APPLICATION configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS + permissions. + operationId: bulkDeleteCrossTypeAlertConfigs + requestBody: + content: + application/json: + example: + configs: + WEBSITE: + - id1 + - id2 + APPLICATION: + - id3 + - id4 + INFRA: + - id5 + schema: + $ref: '#/components/schemas/BulkAlertConfigRequest' + description: Map of alert config types to sets of IDs to delete + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '401': + description: Unauthorized - No valid authentication provided + '403': + description: Forbidden - Missing required permissions for one or more alert + config types + security: + - ApiKeyAuth: [ + ] + summary: Bulk delete alert configurations across multiple types + tags: + - Event Settings + - Events + x-ibm-ahub-byok: true + /api/events/settings/alert-configs/bulk/disable: + put: + description: Atomically disables alert configurations across multiple types. + All operations succeed or all fail. Requires appropriate permissions for each + alert config type in the request. For example, disabling WEBSITE and APPLICATION + configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS + permissions. + operationId: bulkDisableCrossTypeAlertConfigs + requestBody: + content: + application/json: + example: + configs: + WEBSITE: + - id1 + - id2 + APPLICATION: + - id3 + - id4 + INFRA: + - id5 + schema: + $ref: '#/components/schemas/BulkAlertConfigRequest' + description: Map of alert config types to sets of IDs to disable + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '401': + description: Unauthorized - No valid authentication provided + '403': + description: Forbidden - Missing required permissions for one or more alert + config types + security: + - ApiKeyAuth: [ + ] + summary: Bulk disable alert configurations across multiple types + tags: + - Event Settings + - Events + x-ibm-ahub-byok: true + /api/events/settings/alert-configs/bulk/enable: + put: + description: Atomically enables alert configurations across multiple types. + All operations succeed or all fail. Requires appropriate permissions for each + alert config type in the request. For example, enabling WEBSITE and APPLICATION + configs requires both CAN_CONFIGURE_WEBSITE_SMART_ALERTS and CAN_CONFIGURE_APPLICATION_SMART_ALERTS + permissions. + operationId: bulkEnableCrossTypeAlertConfigs + requestBody: + content: + application/json: + example: + configs: + WEBSITE: + - id1 + - id2 + APPLICATION: + - id3 + - id4 + INFRA: + - id5 + schema: + $ref: '#/components/schemas/BulkAlertConfigRequest' + description: Map of alert config types to sets of IDs to enable + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '401': + description: Unauthorized - No valid authentication provided + '403': + description: Forbidden - Missing required permissions for one or more alert + config types + security: + - ApiKeyAuth: [ + ] + summary: Bulk enable alert configurations across multiple types + tags: + - Event Settings + - Events + x-ibm-ahub-byok: true /api/events/settings/alertingChannels: get: description: Gets all the alerting channels. Requires the permission called @@ -5575,7 +5747,10 @@ paths: parameters: - description: List of IDs of alert channels defined in Instana. Can be left empty. - example: '[YbcFlaG8k5oIkxD0, OYcbU9gdP6OTBThJ, qbhfsL9vTtlaBOAt]' + example: + - YbcFlaG8k5oIkxD0 + - OYcbU9gdP6OTBThJ + - qbhfsL9vTtlaBOAt in: query name: ids schema: @@ -5660,7 +5835,10 @@ paths: parameters: - description: List of IDs of alert channels defined in Instana. Can be left empty. - example: '[YbcFlaG8k5oIkxD0, OYcbU9gdP6OTBThJ, qbhfsL9vTtlaBOAt]' + example: + - YbcFlaG8k5oIkxD0 + - OYcbU9gdP6OTBThJ + - qbhfsL9vTtlaBOAt in: query name: ids schema: @@ -5953,7 +6131,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureCustomAlerts @@ -6005,7 +6183,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureCustomAlerts @@ -6078,7 +6256,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. security: @@ -6187,7 +6365,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '422': description: Unprocessable request - missing/invalid data. security: @@ -6276,9 +6454,7 @@ paths: type: array items: $ref: '#/components/schemas/ApplicationAlertConfigWithMetadata' - description: OK - Returns an empty list if no configurations match the criteria - '403': - description: Insufficient permissions. + description: OK security: - ApiKeyAuth: - Default @@ -6413,13 +6589,13 @@ paths: derivedFromGlobalAlert: false schema: $ref: '#/components/schemas/ApplicationAlertConfigWithMetadata' - description: Smart Alert Configuration created. + description: OK '400': - description: Invalid Configuration. + description: Bad request. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '422': - description: Unprocessable entity. + description: Unprocessable request - missing/invalid data. '428': description: Baseline calculation failed due to insufficient data. security: @@ -6429,6 +6605,96 @@ paths: tags: - Application Alert Configuration x-ibm-ahub-byok: true + /api/events/settings/application-alert-configs/bulk/delete: + put: + description: Deletes multiple application alert configurations. Creates new + revisions for all specified alerts with deleted=true. All revisions share + the same timestamp. Maximum 1000 IDs per request. + operationId: bulkDeleteApplicationAlertConfigs + requestBody: + content: + application/json: + example: + - alert-id-1 + - alert-id-2 + - alert-id-3 + schema: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts + summary: Bulk Delete Application Smart Alert Configs + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/application-alert-configs/bulk/disable: + put: + description: Disables multiple application alert configurations. Creates new + revisions for all specified alerts with enabled=false. All revisions share + the same timestamp. Maximum 1000 IDs per request. + operationId: bulkDisableApplicationAlertConfigs + requestBody: + content: + application/json: + example: + - alert-id-1 + - alert-id-2 + - alert-id-3 + schema: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts + summary: Bulk Disable Application Smart Alert Configs + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/application-alert-configs/bulk/enable: + put: + description: Enables multiple application alert configurations. Creates new + revisions for all specified alerts with enabled=true. All revisions share + the same timestamp. Maximum 1000 IDs per request. + operationId: bulkEnableApplicationAlertConfigs + requestBody: + content: + application/json: + example: + - alert-id-1 + - alert-id-2 + - alert-id-3 + schema: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts + summary: Bulk Enable Application Smart Alert Configs + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true /api/events/settings/application-alert-configs/{id}: delete: description: |- @@ -6445,11 +6711,11 @@ paths: type: string responses: '204': - description: Smart Alert Configuration deleted. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureApplicationSmartAlerts @@ -6545,9 +6811,9 @@ paths: $ref: '#/components/schemas/ApplicationAlertConfigWithMetadata' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: The requested Configuration does not exist. + description: Resource not found. security: - ApiKeyAuth: - Default @@ -6690,19 +6956,19 @@ paths: derivedFromGlobalAlert: false schema: $ref: '#/components/schemas/ApplicationAlertConfigWithMetadata' - description: Smart Alert Configuration updated. + description: OK '204': description: Smart Alert Configuration did not change. '400': - description: Invalid Application ID provided. + description: Bad request. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '422': - description: Unprocessable entity. + description: Unprocessable request - missing/invalid data. '428': description: Baseline calculation failed due to insufficient data. '500': - description: Internal error. + description: Bad request. security: - ApiKeyAuth: - CanConfigureApplicationSmartAlerts @@ -6732,11 +6998,11 @@ paths: nullable: true responses: '204': - description: Smart Alert Configuration disabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureApplicationSmartAlerts @@ -6766,11 +7032,11 @@ paths: nullable: true responses: '204': - description: Smart Alert Configuration enabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureApplicationSmartAlerts @@ -6809,11 +7075,11 @@ paths: nullable: true responses: '204': - description: Smart Alert Configuration restored. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureApplicationSmartAlerts @@ -6835,6 +7101,12 @@ paths: required: true schema: type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true responses: '200': description: Smart Alert Configuration baseline successfully recalculated @@ -6844,9 +7116,9 @@ paths: '400': description: Invalid configuration type or configuration is read-only. '403': - description: Insufficient permissions to access this configuration. + description: Insufficient permissions or limited in access. '404': - description: Smart Alert Configuration not found. + description: Resource not found. '428': description: Baseline calculation failed due to insufficient data. security: @@ -6891,9 +7163,9 @@ paths: $ref: '#/components/schemas/ConfigVersion' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: The requested Configuration does not exist. + description: Resource not found. security: - ApiKeyAuth: - Default @@ -6911,7 +7183,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureGlobalAlertPayload @@ -6938,6 +7210,10 @@ paths: - MOBILE_APP - INFRA - LOG + - in: query + name: ownerType + schema: + type: string responses: '200': content: @@ -6959,7 +7235,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureGlobalAlertPayload @@ -7006,10 +7282,12 @@ paths: items: $ref: '#/components/schemas/CustomPayloadWithLastUpdated' description: OK + '400': + description: Bad request. '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '422': description: Unable to process request, request data is invalid. security: @@ -7057,7 +7335,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureGlobalAlertPayload @@ -7091,7 +7369,7 @@ paths: ], "version": 1 schema: - $ref: '#/components/schemas/CustomPayloadConfiguration' + $ref: '#/components/schemas/CustomPayloadWithVersion' required: true responses: '200': @@ -7119,7 +7397,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '409': description: Version conflict. '422': @@ -7133,7 +7411,8 @@ paths: x-ibm-ahub-byok: true /api/events/settings/event-specifications/built-in: get: - description: Get all built-in event specifications + description: Get all built-in event specifications. Can be filtered by event + IDs or plugin IDs. operationId: getBuiltInEventSpecifications parameters: - in: query @@ -7143,6 +7422,13 @@ paths: items: type: string uniqueItems: true + - in: query + name: plugins + schema: + type: array + items: + type: string + uniqueItems: true responses: '200': content: @@ -7222,7 +7508,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureCustomAlerts @@ -7245,7 +7531,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureCustomAlerts @@ -7271,7 +7557,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Built-in event specification not found security: @@ -7306,7 +7592,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Built-in event specification not found security: @@ -7341,7 +7627,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Built-in event specification not found security: @@ -7393,7 +7679,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureCustomAlerts @@ -7421,7 +7707,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureCustomAlerts @@ -7449,7 +7735,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureCustomAlerts @@ -7472,7 +7758,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureCustomAlerts @@ -7531,7 +7817,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Custom Event does not exist security: @@ -7572,7 +7858,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Custom event cannot be updated. security: @@ -7610,7 +7896,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Custom Event does not exist security: @@ -7647,7 +7933,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Custom Event does not exist security: @@ -7686,7 +7972,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureCustomAlerts @@ -7717,7 +8003,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureCustomAlerts @@ -7805,9 +8091,7 @@ paths: type: array items: $ref: '#/components/schemas/GlobalApplicationAlertConfigWithMetadata' - description: OK - Returns an empty list if no configurations match the criteria - '403': - description: Insufficient permissions. + description: OK security: - ApiKeyAuth: - Default @@ -7916,13 +8200,13 @@ paths: builtIn: false schema: $ref: '#/components/schemas/GlobalApplicationAlertConfigWithMetadata' - description: Global Smart Alert Configuration created. + description: OK '400': - description: Invalid Configuration. + description: Bad request. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '422': - description: Unprocessable entity. + description: Unprocessable request - missing/invalid data. security: - ApiKeyAuth: - CanConfigureGlobalApplicationSmartAlerts @@ -7930,10 +8214,97 @@ paths: tags: - Global Application Alert Configuration x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/applications/bulk/delete: + put: + description: "Deletes multiple Global Smart Alert Configurations in a single\ + \ request. Only processes non-deleted configs that the user has access to.\ + \ Built-in configs cannot be deleted. \nFor more information on Global Alert\ + \ Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." + operationId: bulkDeleteGlobalApplicationAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts + summary: Bulk Delete Global Smart Alert Configs + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/applications/bulk/disable: + put: + description: "Disables multiple Global Smart Alert Configurations in a single\ + \ request. Only processes configs that are currently enabled and the user\ + \ has access to. \nFor more information on Global Alert Configuration please\ + \ access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." + operationId: bulkDisableGlobalApplicationAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts + summary: Bulk Disable Global Smart Alert Configs + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/applications/bulk/enable: + put: + description: "Enables multiple Global Smart Alert Configurations in a single\ + \ request. Only processes configs that are currently disabled and the user\ + \ has access to. \nFor more information on Global Alert Configuration please\ + \ access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration." + operationId: bulkEnableGlobalApplicationAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts + summary: Bulk Enable Global Smart Alert Configs + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true /api/events/settings/global-alert-configs/applications/{id}: delete: description: |- - Disables a Global Smart Alert Configuration. + Deletes a Global Smart Alert Configuration. For more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration. operationId: deleteGlobalApplicationAlertConfig parameters: @@ -7946,11 +8317,11 @@ paths: type: string responses: '204': - description: Global Smart Alert Configuration deleted. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalApplicationSmartAlerts @@ -8033,9 +8404,9 @@ paths: $ref: '#/components/schemas/GlobalApplicationAlertConfigWithMetadata' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: The requested Configuration does not exist. + description: Resource not found. security: - ApiKeyAuth: - Default @@ -8152,17 +8523,19 @@ paths: builtIn: false schema: $ref: '#/components/schemas/GlobalApplicationAlertConfigWithMetadata' - description: Global Smart Alert Configuration updated. + description: OK '204': description: Global Smart Alert Configuration did not change. '400': - description: Invalid Application ID provided. + description: Bad request. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. + '404': + description: Resource not found. '422': - description: Unprocessable entity. + description: Unprocessable request - missing/invalid data. '500': - description: Internal error. + description: Internal server error. security: - ApiKeyAuth: - CanConfigureGlobalApplicationSmartAlerts @@ -8192,11 +8565,11 @@ paths: nullable: true responses: '204': - description: Global Smart Alert Configuration disabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalApplicationSmartAlerts @@ -8226,11 +8599,11 @@ paths: nullable: true responses: '204': - description: Global Smart Alert Configuration enabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalApplicationSmartAlerts @@ -8269,11 +8642,11 @@ paths: nullable: true responses: '204': - description: Global Smart Alert Configuration restored. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalApplicationSmartAlerts @@ -8316,9 +8689,9 @@ paths: $ref: '#/components/schemas/ConfigVersion' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: The requested Configuration does not exist. + description: Resource not found. security: - ApiKeyAuth: - Default @@ -8372,7 +8745,7 @@ paths: $ref: '#/components/schemas/LogAlertConfigWithMetadata' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts @@ -8381,6 +8754,87 @@ paths: - Log Alert Configuration x-description: createLogAlertConfig x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/logs/bulk/delete: + put: + description: Delete multiple log alert configurations at once. Maximum 1000 + IDs per request. + operationId: bulkDeleteLogAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Invalid request - empty list or exceeds maximum size + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts + summary: Bulk Delete Log Alert Configs + tags: + - Log Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/logs/bulk/disable: + put: + description: Disable multiple log alert configurations at once. Maximum 1000 + IDs per request. + operationId: bulkDisableLogAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Invalid request - empty list or exceeds maximum size + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts + summary: Bulk Disable Log Alert Configs + tags: + - Log Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/logs/bulk/enable: + put: + description: Enable multiple log alert configurations at once. Maximum 1000 + IDs per request. + operationId: bulkEnableLogAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Invalid request - empty list or exceeds maximum size + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts + summary: Bulk Enable Log Alert Configs + tags: + - Log Alert Configuration + x-ibm-ahub-byok: true /api/events/settings/global-alert-configs/logs/{id}: delete: operationId: deleteLogAlertConfig @@ -8392,11 +8846,11 @@ paths: type: string responses: '204': - description: Log Alert Configuration deleted. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts @@ -8427,7 +8881,7 @@ paths: $ref: '#/components/schemas/LogAlertConfigWithMetadata' description: OK '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - Default @@ -8459,7 +8913,7 @@ paths: '204': description: Log Smart Alert did not change '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts @@ -8485,11 +8939,11 @@ paths: nullable: true responses: '204': - description: Log Alert Configuration disabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts @@ -8514,11 +8968,11 @@ paths: nullable: true responses: '204': - description: Log Alert Configuration enabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts @@ -8549,11 +9003,11 @@ paths: nullable: true responses: '204': - description: Log Alert Configuration restored. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts @@ -8582,7 +9036,7 @@ paths: $ref: '#/components/schemas/ConfigVersion' description: OK '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - Default @@ -8595,7 +9049,7 @@ paths: description: Configs are sorted descending by their created date. operationId: findActiveServiceLevelsAlertConfigs parameters: - - description: Service Levels Objective(SLO) Configuration ID + - description: SLO Configuration ID example: SLOEANnWh9tQOa2h88kGxK6wQ in: query name: sloId @@ -8617,7 +9071,7 @@ paths: content: application/json: example: - name: Error Budget Remaining is low + - name: Error Budget Remaining is low description: Error Budget Remaining is less than or equal to 5%. severity: 5 triggering: true @@ -8746,6 +9200,90 @@ paths: - Service Levels Alert Configuration x-description: createServiceLevelsAlertConfig x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/service-levels/bulk/delete: + put: + description: Delete multiple Service Levels Smart Alert configurations in a + single operation. Only configs that are not already deleted will be updated. + operationId: bulkDeleteServiceLevelsAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Service Levels Alert Configurations Deleted Successfully + '403': + description: Forbidden - User does not have permission to configure Service + Levels Smart Alerts + '422': + description: Unprocessable Entity - Invalid request + security: + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts + summary: Bulk Delete Service Levels Smart Alert Configs + tags: + - Service Levels Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/service-levels/bulk/disable: + put: + description: Disable multiple Service Levels Smart Alert configurations in a + single operation. Only configs that are currently enabled will be updated. + operationId: bulkDisableServiceLevelsAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Service Levels Alert Configurations Disabled Successfully + '403': + description: Forbidden - User does not have permission to configure Service + Levels Smart Alerts + '422': + description: Unprocessable Entity - Invalid request + security: + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts + summary: Bulk Disable Service Levels Smart Alert Configs + tags: + - Service Levels Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/service-levels/bulk/enable: + put: + description: Enable multiple Service Levels Smart Alert configurations in a + single operation. Only configs that are currently disabled will be updated. + operationId: bulkEnableServiceLevelsAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Service Levels Alert Configurations Enabled Successfully + '403': + description: Forbidden - User does not have permission to configure Service + Levels Smart Alerts + '422': + description: Unprocessable Entity - Invalid request + security: + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts + summary: Bulk Enable Service Levels Smart Alert Configs + tags: + - Service Levels Alert Configuration + x-ibm-ahub-byok: true /api/events/settings/global-alert-configs/service-levels/{id}: delete: operationId: deleteServiceLevelsAlertConfig @@ -8822,13 +9360,16 @@ paths: - type: staticString key: foo value: bar + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 id: ln3IGogYS-S7CPqcOQYTNA created: 1717668384754 initialCreated: 1717668384754 readOnly: false enabled: true schema: - $ref: '#/components/schemas/ServiceLevelseAlertConfigWithMetadata' + $ref: '#/components/schemas/ServiceLevelsAlertConfigWithRBACTag' description: Fetched Service Level Alert Configuration Successfully '404': content: @@ -9148,7 +9689,10 @@ paths: content: application/json: example: - - name: Tests in EU are failing + - rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 + name: Tests in EU are failing description: Tests in EU failed for 1 consecutive time syntheticTestIds: - ic25Vt1T5dgKzi0K7812 @@ -9197,8 +9741,6 @@ paths: items: $ref: '#/components/schemas/SyntheticAlertConfigWithMetadata' description: Success. Returns empty result if syntheticTestId is invalid. - '403': - description: Insufficient permissions. security: - ApiKeyAuth: - Default @@ -9286,13 +9828,13 @@ paths: enabled: true schema: $ref: '#/components/schemas/SyntheticAlertConfigWithMetadata' - description: Synthetic Smart Alert Configuration created. + description: OK '400': - description: Invalid configuration. + description: Bad request. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '422': - description: Unprocessable entity. + description: Unprocessable request - missing/invalid data. security: - ApiKeyAuth: - CanConfigureGlobalSyntheticSmartAlerts @@ -9300,6 +9842,90 @@ paths: tags: - Synthetic Alert Configuration x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/synthetics/bulk/delete: + put: + description: |- + Deletes multiple Synthetic Smart Alert Configurations. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: bulkDeleteSyntheticAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts + summary: Bulk Delete Synthetic Smart Alert Configs + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/synthetics/bulk/disable: + put: + description: |- + Disables multiple Synthetic Smart Alert Configurations. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: bulkDisableSyntheticAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts + summary: Bulk Disable Synthetic Smart Alert Configs + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/synthetics/bulk/enable: + put: + description: |- + Enables multiple Synthetic Smart Alert Configurations. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: bulkEnableSyntheticAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts + summary: Bulk Enable Synthetic Smart Alert Configs + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true /api/events/settings/global-alert-configs/synthetics/{id}: delete: description: |- @@ -9316,11 +9942,11 @@ paths: type: string responses: '204': - description: Synthetic Smart Alert Configuration deleted. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalSyntheticSmartAlerts @@ -9383,18 +10009,21 @@ paths: violationsCount: 2 customPayloadFields: [ ] + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 id: qgEwvI0vRfe3Al_D7T7LSA created: 1707149760053 initialCreated: 1707145201046 readOnly: false enabled: true schema: - $ref: '#/components/schemas/SyntheticAlertConfigWithMetadata' + $ref: '#/components/schemas/SyntheticAlertConfigWithRBACTag' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: The requested Configuration does not exist. + description: Resource not found. security: - ApiKeyAuth: - Default @@ -9493,14 +10122,14 @@ paths: description: Synthetic Smart Alert Configuration updated '204': description: Synthetic Smart Alert Configuration did not change - '400': - description: Invalid Configuration ID provided. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. + '404': + description: Resource not found. '422': - description: Unprocessable entity. + description: Unprocessable request - missing/invalid data. '500': - description: Internal error. + description: Internal server error. security: - ApiKeyAuth: - CanConfigureGlobalSyntheticSmartAlerts @@ -9530,11 +10159,11 @@ paths: nullable: true responses: '204': - description: Synthetic Smart Alert Configuration disabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalSyntheticSmartAlerts @@ -9564,11 +10193,11 @@ paths: nullable: true responses: '204': - description: Synthetic Smart Alert Configuration enabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalSyntheticSmartAlerts @@ -9607,11 +10236,11 @@ paths: nullable: true responses: '204': - description: Synthetic Smart Alert Configuration restored. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureGlobalSyntheticSmartAlerts @@ -9664,9 +10293,9 @@ paths: $ref: '#/components/schemas/ConfigVersion' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: The requested Configuration does not exist. + description: Resource not found. security: - ApiKeyAuth: - Default @@ -9680,7 +10309,9 @@ paths: operationId: findActiveInfraAlertConfigs parameters: - description: List of IDs of Infra Smart Alert configurations - example: '[4kxgJAXdSDiu6swQaKXrJw, ZLo28grvQaiMqIaikJK1RQ]' + example: + - 4kxgJAXdSDiu6swQaKXrJw + - ZLo28grvQaiMqIaikJK1RQ in: query name: alertIds schema: @@ -9854,7 +10485,9 @@ paths: $ref: '#/components/schemas/InfraAlertConfigWithMetadata' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. + '422': + description: Unprocessable request - missing/invalid data. security: - ApiKeyAuth: - CanConfigureGlobalInfraSmartAlerts @@ -9862,6 +10495,87 @@ paths: tags: - Infrastructure Alert Configuration x-ibm-ahub-byok: true + /api/events/settings/infra-alert-configs/bulk/delete: + put: + description: Delete multiple Infra Smart Alert configurations in a single operation. + Only configs that are not already deleted will be updated. + operationId: bulkDeleteInfraAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '403': + description: Insufficient permissions or limited in access. + '422': + description: Unprocessable request - missing/invalid data. + security: + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts + summary: Bulk Delete Infra Smart Alert Configs + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/infra-alert-configs/bulk/disable: + put: + description: Disable multiple Infra Smart Alert configurations in a single operation. + Only configs that are currently enabled will be updated. + operationId: bulkDisableInfraAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '403': + description: Insufficient permissions or limited in access. + '422': + description: Unprocessable request - missing/invalid data. + security: + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts + summary: Bulk Disable Infra Smart Alert Configs + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/infra-alert-configs/bulk/enable: + put: + description: Enable multiple Infra Smart Alert configurations in a single operation. + Only configs that are currently disabled will be updated. + operationId: bulkEnableInfraAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '403': + description: Insufficient permissions or limited in access. + '422': + description: Unprocessable request - missing/invalid data. + security: + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts + summary: Bulk Enable Infra Smart Alert Configs + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true /api/events/settings/infra-alert-configs/{id}: delete: operationId: deleteInfraAlertConfig @@ -9877,7 +10591,7 @@ paths: '204': description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. security: @@ -10081,7 +10795,11 @@ paths: '204': description: Infra Smart Alert did not change '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. + '404': + description: Resource not found. + '422': + description: Unprocessable request - missing/invalid data. security: - ApiKeyAuth: - CanConfigureGlobalInfraSmartAlerts @@ -10110,7 +10828,7 @@ paths: '204': description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. security: @@ -10141,7 +10859,7 @@ paths: '204': description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. security: @@ -10180,7 +10898,7 @@ paths: '204': description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. security: @@ -10269,7 +10987,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '501': description: The multi close feature is not enabled. security: @@ -10377,9 +11095,12 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: The event id refers to an event that is not open. + '422': + description: Validation failed. The request body contains invalid or missing + required fields (e.g., blank username or reasonForClosing). security: - ApiKeyAuth: - CanManuallyCloseIssue @@ -10400,7 +11121,7 @@ paths: required: true schema: type: string - - description: A list of Smart Alert Configuration IDs. This allows Website + - description: A list of Smart Alert Configuration IDs. This allows Mobile Application Smart Alert Configuration of a specific set of Configurations. This query can be repeated to use multiple IDs. example: smRTFp08juKWtn8I @@ -10448,6 +11169,9 @@ paths: timeWindow: 600000 customPayloadFields: [ ] + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 id: qOW5jlR5TQafXKWDIceRkA created: 1707224011842 initialCreated: 1707224011842 @@ -10478,10 +11202,8 @@ paths: schema: type: array items: - $ref: '#/components/schemas/WithMetadata' - description: Success. Returns empty result if mobileAppId is invalid. - '403': - description: Insufficient permissions. + $ref: '#/components/schemas/MobileAppAlertConfigWithRBACTag' + description: OK security: - ApiKeyAuth: - CanConfigureMobileAppSmartAlerts @@ -10592,14 +11314,14 @@ paths: operator: STARTS_WITH entity: NOT_APPLICABLE schema: - $ref: '#/components/schemas/WithMetadata' - description: Mobile Smart Alert Configuration created. + $ref: '#/components/schemas/WithMetaData' + description: OK '400': - description: Invalid Configuration. + description: Bad request. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '422': - description: Unprocessable entity. + description: Unprocessable request - missing/invalid data. security: - ApiKeyAuth: - CanConfigureMobileAppSmartAlerts @@ -10607,6 +11329,90 @@ paths: tags: - Event Settings x-ibm-ahub-byok: true + /api/events/settings/mobile-app-alert-configs/bulk/delete: + put: + description: Deletes multiple Mobile Smart Alert Configurations in a single + request. + operationId: bulkDeleteMobileAppAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + example: qOW5jlR5TQafXKWDIceRkA + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Bulk delete Mobile Smart Alert Configs + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/mobile-app-alert-configs/bulk/disable: + put: + description: Disables multiple Mobile Smart Alert Configurations in a single + request. + operationId: bulkDisableMobileAppAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + example: qOW5jlR5TQafXKWDIceRkA + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Bulk disable Mobile Smart Alert Configs + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/mobile-app-alert-configs/bulk/enable: + put: + description: Enables multiple Mobile Smart Alert Configurations in a single + request. + operationId: bulkEnableMobileAppAlertConfigs + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + example: qOW5jlR5TQafXKWDIceRkA + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Bulk enable Mobile Smart Alert Configs + tags: + - Event Settings + x-ibm-ahub-byok: true /api/events/settings/mobile-app-alert-configs/{id}: delete: description: Deletes a Mobile Smart Alert Configuration @@ -10621,11 +11427,11 @@ paths: type: string responses: '204': - description: Mobile Smart Alert Configuration deleted. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureMobileAppSmartAlerts @@ -10689,6 +11495,9 @@ paths: timeWindow: 600000 customPayloadFields: [ ] + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 id: qOW5jlR5TQafXKWDIceRkA created: 1707224011842 initialCreated: 1707224011842 @@ -10717,12 +11526,12 @@ paths: operator: STARTS_WITH entity: NOT_APPLICABLE schema: - $ref: '#/components/schemas/WithMetadata' + $ref: '#/components/schemas/MobileAppAlertConfigWithRBACTag' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: The requested Configuration does not exist. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureMobileAppSmartAlerts @@ -10841,18 +11650,20 @@ paths: operator: STARTS_WITH entity: NOT_APPLICABLE schema: - $ref: '#/components/schemas/WithMetadata' - description: Mobile Smart Alert Configuration updated. + $ref: '#/components/schemas/WithMetaData' + description: OK '204': description: Mobile Smart Alert Configuration did not change. '400': - description: Invalid Mobile App ID provided. + description: Bad request. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. + '404': + description: Resource not found. '422': - description: Unprocessable entity. + description: Unprocessable request - missing/invalid data. '500': - description: Internal error. + description: Internal server error. security: - ApiKeyAuth: - CanConfigureMobileAppSmartAlerts @@ -10880,11 +11691,11 @@ paths: nullable: true responses: '204': - description: Mobile Smart Alert Configuration disabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureMobileAppSmartAlerts @@ -10912,11 +11723,11 @@ paths: nullable: true responses: '204': - description: Mobile Smart Alert Configuration enabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureMobileAppSmartAlerts @@ -10953,11 +11764,11 @@ paths: nullable: true responses: '204': - description: Mobile Smart Alert Configuration restored. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureMobileAppSmartAlerts @@ -10979,6 +11790,12 @@ paths: required: true schema: type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true responses: '200': description: Mobile Smart Alert Configuration baseline successfully recalculated @@ -10988,9 +11805,9 @@ paths: '400': description: Invalid configuration type or configuration is read-only. '403': - description: Insufficient permissions to access this configuration. + description: Insufficient permissions or limited in access. '404': - description: Mobile Smart Alert Configuration not found. + description: Resource not found. '428': description: Baseline calculation failed due to insufficient data. security: @@ -11035,9 +11852,9 @@ paths: $ref: '#/components/schemas/ConfigVersion' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: The requested Configuration does not exist. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureMobileAppSmartAlerts @@ -11045,6 +11862,83 @@ paths: tags: - Event Settings x-ibm-ahub-byok: true + /api/events/settings/shortcode/current-prefix: + get: + description: Returns the current shortcode prefix and enabled state used for + events. + operationId: getCurrentPrefix + responses: + '200': + content: + application/json: + example: + prefix: INSTANA- + enabled: true + schema: + $ref: '#/components/schemas/PrefixObject' + description: The current shortcode prefix and enabled state. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: [ + ] + summary: Get current shortcode prefix. + tags: + - Event Settings + x-ibm-ahub-byok: true + put: + description: Updates the shortcode prefix and enabled state used for events. + The prefix will be applied to all new incidents created after this update. + For example, setting the prefix to 'PROD-' with enabled=true will result in + incident codes like 'PROD-1', 'PROD-2', etc. The enabled field allows explicit + control over whether the shortcode feature is active. + operationId: updatePrefix + requestBody: + content: + application/json: + examples: + Disable shortcode feature: + description: Disable the shortcode feature entirely + value: + prefix: '' + enabled: false + Enable with custom prefix: + description: Enable shortcodes with INSTANA- prefix (default) + value: + prefix: INSTANA- + enabled: true + Enable with production prefix: + description: Enable shortcodes with PROD- prefix for production incidents + value: + prefix: PROD- + enabled: true + schema: + $ref: '#/components/schemas/PrefixObject' + description: The new prefix configuration including the enabled state + required: true + responses: + '200': + content: + application/json: + example: + prefix: PROD- + enabled: true + schema: + $ref: '#/components/schemas/PrefixObject' + description: The prefix and enabled state were successfully updated. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: [ + ] + summary: Update shortcode prefix. + tags: + - Event Settings + x-ibm-ahub-byok: true /api/events/settings/website-alert-configs: get: description: Gets all the Website Smart Alert Configuration pertaining to a @@ -11130,13 +12024,14 @@ paths: initialCreated: 1707726529124 readOnly: false enabled: true + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 schema: type: array items: - $ref: '#/components/schemas/WebsiteAlertConfigWithMetadata' - description: Success. Returns empty result if websiteId is invalid. - '403': - description: Insufficient permissions. + $ref: '#/components/schemas/WebsiteAlertConfigWithRBACTag' + description: OK security: - ApiKeyAuth: - CanConfigureWebsiteSmartAlerts @@ -11262,13 +12157,13 @@ paths: enabled: true schema: $ref: '#/components/schemas/WebsiteAlertConfigWithMetadata' - description: Website Smart Alert Configuration created. + description: OK '400': - description: Invalid configuration. + description: Bad request. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '422': - description: Unprocessable entity. + description: Unprocessable request - missing/invalid data. '428': description: Baseline calculation failed due to insufficient data. security: @@ -11278,6 +12173,96 @@ paths: tags: - Event Settings x-ibm-ahub-byok: true + /api/events/settings/website-alert-configs/bulk/delete: + put: + description: Deletes multiple website alert configurations. Creates new revisions + for all specified alerts with deleted=true. All revisions share the same timestamp. + Maximum 1000 IDs per request. + operationId: bulkDeleteWebsiteAlertConfigs + requestBody: + content: + application/json: + example: + - alert-id-1 + - alert-id-2 + - alert-id-3 + schema: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Bulk Delete Website Smart Alert Configs + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/website-alert-configs/bulk/disable: + put: + description: Disables multiple website alert configurations. Creates new revisions + for all specified alerts with enabled=false. All revisions share the same + timestamp. Maximum 1000 IDs per request. + operationId: bulkDisableWebsiteAlertConfigs + requestBody: + content: + application/json: + example: + - alert-id-1 + - alert-id-2 + - alert-id-3 + schema: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Bulk Disable Website Smart Alert Configs + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/website-alert-configs/bulk/enable: + put: + description: Enables multiple website alert configurations. Creates new revisions + for all specified alerts with enabled=true. All revisions share the same timestamp. + Maximum 1000 IDs per request. + operationId: bulkEnableWebsiteAlertConfigs + requestBody: + content: + application/json: + example: + - alert-id-1 + - alert-id-2 + - alert-id-3 + schema: + type: string + required: true + responses: + '204': + description: Successful - no content to return. + '400': + description: Bad request. + '403': + description: Insufficient permissions or limited in access. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Bulk Enable Website Smart Alert Configs + tags: + - Event Settings + x-ibm-ahub-byok: true /api/events/settings/website-alert-configs/{id}: delete: description: Deletes a Website Smart Alert Configuration. @@ -11292,11 +12277,11 @@ paths: type: string responses: '204': - description: Website Smart Alert Configuration deleted. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureWebsiteSmartAlerts @@ -11382,13 +12367,16 @@ paths: initialCreated: 1707726529124 readOnly: false enabled: true + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 schema: - $ref: '#/components/schemas/WebsiteAlertConfigWithMetadata' + $ref: '#/components/schemas/WebsiteAlertConfigWithRBACTag' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: The requested configuration does not exist. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureWebsiteSmartAlerts @@ -11522,21 +12510,21 @@ paths: enabled: true schema: $ref: '#/components/schemas/WebsiteAlertConfigWithMetadata' - description: Website Smart Alert Configuration updated. + description: OK '204': - description: Website Smart Alert Configuration did not change. + description: Successful - no content to return. '400': - description: Invalid Configuration ID provided. + description: Bad request. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: The requested configuration does not exist. + description: Resource not found. '422': - description: Unprocessable entity. + description: Unprocessable request - missing/invalid data. '428': description: Baseline calculation failed due to insufficient data. '500': - description: Internal error. + description: Internal server error. security: - ApiKeyAuth: - CanConfigureWebsiteSmartAlerts @@ -11564,11 +12552,11 @@ paths: nullable: true responses: '204': - description: Website Smart Alert Configuration disabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureWebsiteSmartAlerts @@ -11596,11 +12584,11 @@ paths: nullable: true responses: '204': - description: Website Smart Alert Configuration enabled. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration ID provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureWebsiteSmartAlerts @@ -11637,11 +12625,11 @@ paths: nullable: true responses: '204': - description: Website Smart Alert Configuration restored. + description: Successful - no content to return. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: Invalid Configuration provided. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureWebsiteSmartAlerts @@ -11663,6 +12651,12 @@ paths: required: true schema: type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true responses: '200': description: Website Smart Alert Configuration baseline successfully recalculated @@ -11672,9 +12666,9 @@ paths: '400': description: Invalid configuration type or configuration is read-only. '403': - description: Insufficient permissions to access this configuration. + description: Insufficient permissions or limited in access. '404': - description: Website Smart Alert Configuration not found. + description: Resource not found. '428': description: Baseline calculation failed due to insufficient data. security: @@ -11719,9 +12713,9 @@ paths: $ref: '#/components/schemas/ConfigVersion' description: OK '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': - description: The requested Configuration does not exist. + description: Resource not found. security: - ApiKeyAuth: - CanConfigureWebsiteSmartAlerts @@ -11877,6 +12871,43 @@ paths: - Host Agent x-description: updateConfigurationByQuery x-ibm-ahub-byok: true + /api/host-agent/mode: + post: + operationId: updateModeByQuery + parameters: + - in: query + name: query + required: true + schema: + type: string + minLength: 1 + - in: query + name: size + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AgentModeUpdate' + x-payload: updateModeByQuery + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgentRunMode + summary: Update agent run mode by query + tags: + - Host Agent + x-description: updateModeByQuery + x-ibm-ahub-byok: true /api/host-agent/{hostId}/clr-logs: get: operationId: getAgentClrLogs @@ -11886,6 +12917,7 @@ paths: required: true schema: type: string + minLength: 1 - in: query name: download schema: @@ -11906,6 +12938,30 @@ paths: - Host Agent x-ibm-ahub-byok: true /api/host-agent/{hostId}/configuration: + get: + operationId: getAgentConfigurationByHost + parameters: + - in: path + name: hostId + required: true + schema: + type: string + minLength: 1 + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canDownloadAgentConfiguration + summary: Get effective Agent configuration + tags: + - Host Agent + x-ibm-ahub-byok: true post: operationId: updateConfigurationByHost parameters: @@ -11914,6 +12970,7 @@ paths: required: true schema: type: string + minLength: 1 requestBody: content: application/json: @@ -11945,6 +13002,7 @@ paths: required: true schema: type: string + minLength: 1 - in: query name: download schema: @@ -11972,6 +13030,38 @@ paths: tags: - Host Agent x-ibm-ahub-byok: true + /api/host-agent/{hostId}/mode: + post: + operationId: updateModeByHost + parameters: + - in: path + name: hostId + required: true + schema: + type: string + minLength: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AgentModeUpdate' + x-payload: updateModeByHost + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgentRunMode + summary: Update agent run mode by host + tags: + - Host Agent + x-description: updateModeByHost + x-ibm-ahub-byok: true /api/host-agent/{hostId}/support-info: get: operationId: getAgentSupportInformation @@ -11981,11 +13071,13 @@ paths: required: true schema: type: string + minLength: 1 - in: query name: supportInfoId required: true schema: type: string + minLength: 1 responses: default: content: @@ -12010,6 +13102,7 @@ paths: required: true schema: type: string + minLength: 1 responses: default: content: @@ -12034,6 +13127,7 @@ paths: required: true schema: type: string + minLength: 1 - in: query name: to schema: @@ -12148,38 +13242,56 @@ paths: content: application/json: examples: - ? This example retrieves a JVM entity labeled "custom-metrics.jar" with - metrics for memory used and blocked threads (both using a one hour - granularity and a one minute granularity). - : description: This example retrieves a JVM entity labeled "custom-metrics.jar" - with metrics for memory used and blocked threads (both using a one - hour granularity and a one minute granularity). + This example retrieves first 20 hosts by name with metrics for cpu and memory used.: + description: This example retrieves first 20 hosts by name with metrics + for cpu and memory used. value: - tagFilterExpression: - type: TAG_FILTER - entity: NOT_APPLICABLE - name: label - operator: EQUALS - value: custom-metrics.jar timeFrame: - to: 1673969562715 + to: 1764687385227 windowSize: 3600000 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] pagination: - retrievalSize: 200 - type: jvmRuntimePlatform + retrievalSize: 20 + type: host metrics: + - metric: cpu.used + aggregation: MEAN - metric: memory.used - granularity: 3600000 - aggregation: MAX - - metric: memory.used - granularity: 600000 - aggregation: MAX - - metric: threads.blocked - granularity: 3600000 aggregation: MEAN - - metric: threads.blocked - granularity: 600000 + order: + by: label + direction: ASC + This example retrieves the next 20 hosts by name with metrics for cpu and memory used.: + description: This example retrieves the next 20 hosts by name with + metrics for cpu and memory used. + value: + timeFrame: + to: 1764687385227 + windowSize: 3600000 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + pagination: + retrievalSize: 20 + totalHits: 101 + totalRepresentedItemCount: 101 + ingestionTime: 1764687360000 + offset: 20 + type: host + metrics: + - metric: cpu.used aggregation: MEAN + - metric: memory.used + aggregation: MEAN + order: + by: label + direction: ASC schema: $ref: '#/components/schemas/GetInfrastructureQuery' x-payload: getInfrastructureQuery @@ -12566,6 +13678,13 @@ paths: description: |2- For more information on Infrastructure Metrics please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-metrics. + + **Request Validation Rules:** + - At least one metric name must be defined in the 'metrics' field + - Either 'snapshotIds' or 'query' must be provided (both cannot be empty) + - When using 'query' without 'snapshotIds', the query cannot be empty or a wildcard ('*') unless a 'plugin' is specified + - The rollup value must be valid for the given time window (see API documentation for valid rollups) + - The ratio of windowSize to rollup must not exceed 600 data points (windowSize / rollup <= 600) operationId: getInfrastructureMetrics parameters: - in: query @@ -12585,6 +13704,38 @@ paths: schema: $ref: '#/components/schemas/InfrastructureMetricResult' description: OK + '400': + content: + application/json: + examples: + Invalid query: + description: Invalid query + value: + errors: + - Invalid metric query, query should not be empty or wildcard(*) + Invalid rollup: + description: Invalid rollup + value: + errors: + - The given windowSize (from:1234567890000, to:1234567900000) + is not valid in combination with the rollup (60 sec). Please + see the API documentation for valid rollups. + Missing snapshots or query: + description: Missing snapshots or query + value: + errors: + - At least snapshots or query needs to be not empty! + No metrics specified: + description: No metrics specified + value: + errors: + - At least one metric name needs to be defined + Too many data points: + description: Too many data points + value: + errors: + - The rollup in relation to the windowSize provides too many values + description: 'Bad Request - Invalid request parameters. Possible error messages:' security: - ApiKeyAuth: - Default @@ -13244,6 +14395,65 @@ paths: - Health x-description: getVersion x-ibm-ahub-byok: true + /api/internal/custom-dashboard: + get: + operationId: getInternalCustomDashboards + parameters: + - description: query + example: BeeInstana + in: query + name: query + schema: + type: string + - description: pageSize + example: 2 + in: query + name: pageSize + schema: + type: integer + format: int32 + - description: page + example: 1 + in: query + name: page + schema: + type: integer + format: int32 + - description: withTotalHits + example: false + in: query + name: withTotalHits + schema: + type: boolean + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - Default + x-ibm-ahub-byok: true + /api/internal/custom-dashboard/{dashboardId}: + get: + operationId: getInternalDashboard + parameters: + - in: path + name: dashboardId + required: true + schema: + type: string + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - Default + x-ibm-ahub-byok: true /api/llm/capabilities: get: description: Retrieve all available LLM capabilities. @@ -13283,6 +14493,9 @@ paths: - AI_ASSISTANT - MANUAL_ACTION_GENERATION - SCRIPT_GENERATION + - KUBERNETES_ASSISTANT + - SLO_ASSISTANT + - GENAI_EVALUATION description: OK '401': description: Unauthorized access - requires user authentication. @@ -13295,7 +14508,7 @@ paths: tags: - AI Management x-ibm-ahub-byok: true - /api/llm/egress/handler: + /api/llm/gateways: get: description: Retrieve all LLM gateways. Optionally filter by enabled status or capability. @@ -13346,7 +14559,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -13418,7 +14631,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -13428,7 +14641,51 @@ paths: tags: - AI Management x-ibm-ahub-byok: true - /api/llm/egress/handler/{id}: + /api/llm/gateways/test: + post: + description: Test LLM gateway connection parameters + operationId: testLLMGateway + requestBody: + content: + application/json: + example: + id: WATSONX + connectionParameters: + url: https://watsonx.example.com + apiKey: secret-api-key + project: project-xyz + schema: + $ref: '#/components/schemas/LLMGatewayTestConnectionRequest' + required: true + responses: + '200': + content: + application/json: + example: | + { + "statusCode": 200 + "connected": true, + "message": "Connection successful" + } + schema: + $ref: '#/components/schemas/TestConnectionResponse' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions or limited in access. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureLLM + summary: Test LLM gateway connection parameters + tags: + - AI Management + x-ibm-ahub-byok: true + /api/llm/gateways/{id}: delete: description: Delete a LLM egress gateway by ID. operationId: deleteLLMEgressGateway @@ -13445,7 +14702,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -13500,7 +14757,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -13579,7 +14836,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -13591,7 +14848,7 @@ paths: tags: - AI Management x-ibm-ahub-byok: true - /api/llm/egress/handler/{id}/enable: + /api/llm/gateways/{id}/enable: put: description: Enable a LLM gateway by ID. Any other enabled gateway for the same capability will be automatically disabled. @@ -13609,7 +14866,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -13918,6 +15175,7 @@ paths: required: true schema: type: string + minLength: 1 - in: query name: useCase required: true @@ -14106,7 +15364,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -14134,7 +15392,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -14212,7 +15470,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -14246,7 +15504,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -14284,7 +15542,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -14315,7 +15573,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -14350,7 +15608,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '415': @@ -14386,7 +15644,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -14424,7 +15682,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -14525,7 +15783,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '422': description: Unprocessable request - missing/invalid data. '500': @@ -14563,7 +15821,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -14652,7 +15910,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -14719,7 +15977,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -14806,7 +16064,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -14855,7 +16113,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -15254,7 +16512,7 @@ paths: fullName: Any User timestamp: 1723035109091 schema: - $ref: '#/components/schemas/AccessLogResponse' + $ref: '#/components/schemas/AuditLogUiResponse' description: OK security: - ApiKeyAuth: @@ -15347,6 +16605,392 @@ paths: - Apdex Settings x-description: createApdexConfiguration x-ibm-ahub-byok: true + /api/settings/apdex/v2: + get: + description: API to Get All Apdex Configurations. + operationId: getAllApdexConfigurationsV2 + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + description: Size of the Page + example: 1 + - in: query + name: page + schema: + type: integer + format: int32 + description: Page Number + example: 1 + - in: query + name: orderBy + schema: + type: string + description: Order By Value + enum: + - name + - entityType + - entityName + - apdexScore + - 'null' + example: name + - in: query + name: orderDirection + schema: + type: string + description: Order Direction of the Result, it could be ascending or descending + enum: + - ASC + - DESC + example: ASC + - in: query + name: query + schema: + type: string + description: Keyword or Query which needs to be searched + example: test + - in: query + name: grouped + schema: + type: boolean + description: Boolean operator which specifies if the results are grouped + example: false + - in: query + name: refresh + schema: + type: boolean + description: Boolean operator which specifies if the cache needs to be refreshed + example: false + - in: query + name: from + schema: + type: integer + format: int64 + description: Start timestamp in milliseconds for Apdex score calculation + example: 1705411200000 + - in: query + name: to + schema: + type: integer + format: int64 + description: End timestamp in milliseconds for Apdex score calculation + example: 1705414800000 + - in: query + name: entityType + schema: + type: string + description: Type of the Apdex Configuration, it could be APPLICATION or + WEBSITE + enum: + - APPLICATION + - WEBSITE + example: APPLICATION + - in: query + name: entityId + schema: + type: string + description: Application or Website ID + example: XIZGGVT1TX2O-0OFeT2Yig + responses: + '200': + content: + application/json: + example: + - id: _PvpxqTfSyi27O_LCxMd0A + createdAt: 1653917798682 + apdexName: '{string}' + apdexEntity: + apdexType: website + entityId: '{object}' + threshold: 70 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + beaconType: httpRequest + - id: K6thQVyzQqWc38yspc0QWw + createdAt: 1693828514423 + apdexName: '{string}' + apdexEntity: + apdexType: application + entityId: '{object}' + threshold: 12 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + boundaryScope: ALL + includeInternal: false + includeSynthetic: false + schema: + type: array + items: + $ref: '#/components/schemas/ApdexConfiguration' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get All Apdex Configurations + tags: + - Apdex Settings + x-ibm-ahub-byok: true + post: + operationId: createApdexConfigurationV2 + requestBody: + content: + application/json: + example: + - apdexName: Apdex Configuration One + apdexEntity: + apdexType: website + entityId: XIZGGVT1TX2O-0OFeT2Yig + threshold: 400 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + beaconType: httpRequest + schema: + $ref: '#/components/schemas/ApdexConfigurationInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApdexConfiguration' + description: OK + security: + - ApiKeyAuth: + - canConfigureApdex + summary: Create Apdex Configuration + tags: + - Apdex Settings + x-description: createApdexConfiguration + x-ibm-ahub-byok: true + /api/settings/apdex/v2/apdex-levels: + get: + description: Returns the Apdex satisfaction level definitions with their thresholds + operationId: getAllApdexConfigLevelsV2 + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ApdexLevel' + description: Fetched list of Apdex Levels Successfully + security: + - ApiKeyAuth: + - Default + summary: Get All Apdex Levels + tags: + - Apdex Settings + x-ibm-ahub-byok: true + /api/settings/apdex/v2/tags: + get: + operationId: getAllApdexConfigTagsV2 + parameters: + - in: query + name: query + schema: + type: string + description: Keyword or Query which needs to be searched + example: test Apdex + - in: query + name: tag + schema: + type: array + description: List of tags which needs to be searched + example: Testing + items: + type: string + description: List of tags which needs to be searched + example: Testing + uniqueItems: true + - in: query + name: entityType + schema: + type: string + description: Apdex Entity Type which needs to be filtered + enum: + - APPLICATION + - WEBSITE + example: APPLICATION + responses: + '200': + content: + application/json: + example: + - andre + - test + - testing + - drinks + - got no snacks + - timeBased + - Stan + - no matches + - availability + - Lab + - demo + - thiemo + - TimeWindow Test + - robot-shop + - eventBased + - got snacks + - migration + - robert-creates-a-new-sli + schema: + type: array + items: + type: string + description: Fetched list of Apdex Configuration tags Successfully + security: + - ApiKeyAuth: + - Default + summary: Get All Apdex Config tags + tags: + - Apdex Settings + x-ibm-ahub-byok: true + /api/settings/apdex/v2/{id}: + delete: + operationId: deleteApdexConfigurationV2 + parameters: + - description: Apdex Configuration ID + example: NCAoNKqySWSK1U5GkmyZgQ + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Apdex Configuration Deleted Successfully + security: + - ApiKeyAuth: + - canConfigureApdex + summary: Delete Apdex Configuration + tags: + - Apdex Settings + x-ibm-ahub-byok: true + get: + description: API to Get Apdex Configuration for specified ID. + operationId: getApdexConfigurationV2 + parameters: + - description: Apdex Configuration ID + example: NCAoNKqySWSK1U5GkmyZgQ + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: NCAoNKqySWSK1U5GkmyZgQ + createdAt: 1666112381045 + apdexName: '{string}' + apdexEntity: + apdexType: website + entityId: XIZGGVT1TX2O-0OFeT2Yig + threshold: 100 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + beaconType: httpRequest + schema: + $ref: '#/components/schemas/ApdexConfiguration' + description: OK + '404': + content: + application/json: + example: '{"errors":["Apdex Configuration not found"]}' + schema: + type: string + description: Apdex Configuration not found + security: + - ApiKeyAuth: + - Default + summary: Get Apdex Configuration + tags: + - Apdex Settings + x-ibm-ahub-byok: true + put: + operationId: updateApdexConfigV2 + parameters: + - in: path + name: id + required: true + schema: + type: string + description: Apdex Configuration ID + example: APD0jhg2CWmR_iPYtg-iTOzPw + requestBody: + content: + application/json: + example: + - apdexName: Apdex Configuration One + apdexEntity: + apdexType: website + entityId: XIZGGVT1TX2O-0OFeT2Yig + threshold: 400 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + beaconType: httpRequest + schema: + $ref: '#/components/schemas/ApdexConfiguration' + required: true + responses: + '200': + content: + application/json: + example: + id: NCAoNKqySWSK1U5GkmyZgQ + createdAt: 1666112381045 + apdexName: '{string}' + apdexEntity: + apdexType: website + entityId: XIZGGVT1TX2O-0OFeT2Yig + threshold: 100 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + beaconType: httpRequest + schema: + $ref: '#/components/schemas/SLOConfigWithRBACTag' + description: Updated SLO Configuration Successfully + '400': + content: + application/json: + example: + errors: + - Apdex Configuration not found + schema: + type: string + description: Bad Request + security: + - ApiKeyAuth: + - canConfigureApdex + summary: Update an existing Apdex Config + tags: + - Apdex Settings + x-description: updateApdexConfiguration + x-ibm-ahub-byok: true /api/settings/apdex/{entityType}/{entityId}: get: description: API to Get All Apdex Configurations for specified entity type and @@ -16105,6 +17749,38 @@ paths: tags: - Authentication x-ibm-ahub-byok: true + /api/settings/authentication/idp/status: + patch: + description: Enable or disable the identity provider (IdP) configuration for + the tenant. This allows temporary deactivation of IdP authentication while + preserving the configuration. + operationId: setIdpEnabledStatus + requestBody: + content: + application/json: + examples: + Disable IdP: + description: Disable the IdP configuration + value: + enabled: false + Enable IdP: + description: Enable the IdP configuration + value: + enabled: true + schema: + $ref: '#/components/schemas/IdpStatusUpdate' + responses: + '204': + description: Successful - no content to return. + '404': + description: No IdP configuration found for tenant + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Enable or disable IdP configuration + tags: + - Authentication + x-ibm-ahub-byok: true /api/settings/authentication/ldap: delete: description: Delete the corresponding tenants LDAP configuration. @@ -16574,6 +18250,8 @@ paths: required: true schema: type: string + format: email + minLength: 1 responses: default: content: @@ -16650,6 +18328,618 @@ paths: - User x-description: inviteUsers x-ibm-ahub-byok: true + /api/settings/ip-filtering: + delete: + description: Delete the currently configured ip-filtering for the current tenant + unit. + operationId: deleteIPFiltering + responses: + '204': + description: Successful - no content to return. + '404': + content: + application/json: + example: + errors: + - no ip-filtering setting set + schema: + type: string + description: Resource not found. + '500': + content: + application/json: + example: + errors: + - failed to delete ip-filtering setting + schema: + type: string + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureIPFiltering + summary: Delete current ip-filtering + tags: + - IP Filtering + x-ibm-ahub-byok: true + get: + description: Retrieve currently configured ip-filtering for the current tenant + unit. + operationId: getIPFiltering + responses: + '200': + content: + application/json: + example: + active: true + denyAll: false + enabled: true + supportAccessEnabled: true + rules: + - target: 127.0.0.1 + block: true + - target: 0:0:0:0:0:0:0:1 + block: false + lastChangedAt: 1762356274224 + lastVerifiedAt: null + schema: + $ref: '#/components/schemas/IPFiltering' + description: OK + '404': + content: + application/json: + example: + errors: + - no ip-filtering setting set + schema: + type: string + description: Resource not found. + '500': + content: + application/json: + example: + errors: + - failed to retrieve ip-filtering setting + schema: + type: string + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureIPFiltering + summary: Get current ip-filtering + tags: + - IP Filtering + x-ibm-ahub-byok: true + put: + description: Update or create ip-filtering for the current tenant unit. Enabled + configurations will become temporarily active (5 minutes) and need to be verified + within whilst being temporarily to become permanently active. + operationId: upsertIPFiltering + requestBody: + content: + application/json: + example: + denyAll: false + enabled: true + supportAccessEnabled: true + rules: + - target: 127.0.0.1 + block: true + - target: 0:0:0:0:0:0:0:1 + block: false + schema: + $ref: '#/components/schemas/IPFilteringUpsert' + required: true + responses: + '200': + content: + application/json: + example: + active: true + denyAll: false + enabled: true + supportAccessEnabled: true + rules: + - target: 127.0.0.1 + block: true + - target: 0:0:0:0:0:0:0:1 + block: false + lastChangedAt: 1762356274224 + lastVerifiedAt: null + schema: + $ref: '#/components/schemas/IPFiltering' + description: OK + '400': + content: + application/json: + example: + errors: + - Denying all access is prevented. You need to provide at least one + allow rule. + schema: + type: string + description: Bad request. + '422': + content: + application/json: + example: + errors: + - supportAccessEnabled must not be null + - denyAll must not be null + - rules must not be null + - enabled must not be null + - rules must not be empty + - rules size must be between 1 and 75 + schema: + type: string + description: Unprocessable request - missing/invalid data. + '500': + content: + application/json: + example: + errors: + - failed to upsert ip-filtering setting + schema: + type: string + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureIPFiltering + summary: Upsert ip-filtering + tags: + - IP Filtering + x-ibm-ahub-byok: true + /api/settings/ip-filtering/disable: + patch: + description: Disable and retrieve the currently configured ip-filtering for + the current tenant unit. + operationId: disableIPFiltering + responses: + '200': + content: + application/json: + example: + active: false + denyAll: false + enabled: false + supportAccessEnabled: true + rules: + - target: 127.0.0.1 + block: true + - target: 0:0:0:0:0:0:0:1 + block: false + lastChangedAt: 1762356861555 + lastVerifiedAt: 1762356492161 + schema: + $ref: '#/components/schemas/IPFiltering' + description: OK + '404': + content: + application/json: + example: + errors: + - no ip-filtering setting set + schema: + type: string + description: Resource not found. + '500': + content: + application/json: + example: + errors: + - failed to disable ip-filtering setting + schema: + type: string + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureIPFiltering + summary: Disable the current ip-filtering + tags: + - IP Filtering + x-ibm-ahub-byok: true + /api/settings/ip-filtering/verify: + patch: + description: Verify and retrieve the currently configured ip-filtering for the + current tenant unit. This action is required to promote a configuration from + temporary active to permanently active. This action can only be performed + whilst the configuration is temporary active. + operationId: verifyIPFiltering + responses: + '200': + content: + application/json: + example: + active: true + denyAll: false + enabled: true + supportAccessEnabled: true + rules: + - target: 127.0.0.1 + block: true + - target: 0:0:0:0:0:0:0:1 + block: false + lastChangedAt: 1762356274224 + lastVerifiedAt: 1762356492161 + schema: + $ref: '#/components/schemas/IPFiltering' + description: OK + '404': + content: + application/json: + example: + errors: + - unable to verify either no ip-filtering set or not active + schema: + type: string + description: Resource not found. + '500': + content: + application/json: + example: + errors: + - failed to verify ip-filtering setting + schema: + type: string + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureIPFiltering + summary: Verify current ip-filtering + tags: + - IP Filtering + x-ibm-ahub-byok: true + /api/settings/llm-pricing: + delete: + description: Delete a tenant-specific price configuration for a specific provider+model. + Optionally specify a platform. Only user-defined prices can be deleted. + operationId: deleteLlmModelPriceByQuery + parameters: + - in: query + name: provider + schema: + type: string + description: Provider + example: openai + - in: query + name: modelName + schema: + type: string + description: Model name + example: gpt-4 + - in: query + name: platform + schema: + type: string + description: Platform (optional). If not specified, deletes all-platforms + pricing. + example: aws + responses: + '204': + description: No Content - Successfully deleted + '404': + description: Not Found - Price configuration does not exist + security: + - ApiKeyAuth: + - CanConfigureLlmModelPrice + summary: Delete LLM model price + tags: + - LLM Price Configuration + x-ibm-ahub-byok: true + get: + description: Fetch all LLM price configurations for the current tenant unit. + operationId: getAllLlmModelPrices + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LlmModelPrice' + description: OK + security: + - ApiKeyAuth: + - CanConfigureLlmModelPrice + summary: Get all LLM model prices + tags: + - LLM Price Configuration + x-ibm-ahub-byok: true + put: + description: Create or update price for a specific provider+model. Optionally + specify a platform for platform-specific pricing. + operationId: upsertLlmModelPriceFromBody + requestBody: + content: + application/json: + example: + provider: openai + modelName: gpt-4 + inputCost: 0.5 + outputCost: 1.5 + schema: + $ref: '#/components/schemas/LlmModelPrice' + responses: + '200': + description: OK + security: + - ApiKeyAuth: + - CanConfigureLlmModelPrice + summary: Upsert LLM model price + tags: + - LLM Price Configuration + x-ibm-ahub-byok: true + /api/settings/llm-pricing/currency: + get: + description: Fetch the currency code used for LLM model pricing. + operationId: getLLMModelCurrency + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LlmModelPriceMetadata' + description: OK + '404': + description: Not Found + security: + - ApiKeyAuth: + - CanConfigureLlmModelPrice + summary: Get currency for LLM model prices + tags: + - LLM Price Configuration + x-ibm-ahub-byok: true + put: + description: Set the currency code used for LLM model pricing. + operationId: setLLMModelCurrency + requestBody: + content: + application/json: + example: + currencyCode: USD + schema: + $ref: '#/components/schemas/LlmModelPriceMetadata' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LlmModelPriceMetadata' + description: OK + security: + - ApiKeyAuth: + - CanConfigureLlmModelPrice + summary: Set currency for LLM model prices + tags: + - LLM Price Configuration + x-ibm-ahub-byok: true + /api/settings/llm-pricing/model/{modelName}: + delete: + description: Delete a tenant-specific price configuration for a model without + specifying provider. Optionally specify a platform. Only user-defined prices + can be deleted. + operationId: deleteLlmModelPriceWithoutProvider + parameters: + - in: path + name: modelName + required: true + schema: + type: string + description: Model name + example: gpt-4 + - in: query + name: platform + schema: + type: string + description: Platform (optional). If not specified, deletes all-platforms + pricing. + example: aws + responses: + '204': + description: No Content - Successfully deleted + '404': + description: Not Found - Price configuration does not exist + security: + - ApiKeyAuth: + - CanConfigureLlmModelPrice + summary: Delete LLM model price without provider + tags: + - LLM Price Configuration + x-ibm-ahub-byok: true + get: + description: Fetch the price for a model without specifying provider. Optionally + specify a platform for platform-specific pricing. + operationId: getLlmModelPriceWithoutProvider + parameters: + - in: path + name: modelName + required: true + schema: + type: string + description: Model name + example: gpt-4 + - in: query + name: platform + schema: + type: string + description: Platform (optional). If not specified, returns pricing for + all platforms. + example: aws + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LlmModelPrice' + description: OK + '404': + description: Not Found + security: + - ApiKeyAuth: + - CanConfigureLlmModelPrice + summary: Get LLM model price without provider + tags: + - LLM Price Configuration + x-ibm-ahub-byok: true + put: + description: Create or update price for a model without specifying provider. + Optionally specify a platform for platform-specific pricing. + operationId: upsertLlmModelPriceWithoutProvider + parameters: + - in: path + name: modelName + required: true + schema: + type: string + description: Model name + example: gpt-4 + - in: query + name: platform + schema: + type: string + description: Platform (optional). If not specified, pricing applies to all + platforms. + example: aws + requestBody: + content: + application/json: + example: + inputCost: 0.5 + outputCost: 1.5 + schema: + $ref: '#/components/schemas/LlmModelPrice' + responses: + '200': + description: OK + security: + - ApiKeyAuth: + - CanConfigureLlmModelPrice + summary: Upsert LLM model price without provider + tags: + - LLM Price Configuration + x-ibm-ahub-byok: true + /api/settings/llm-pricing/{provider}/{modelName}: + delete: + description: Delete a tenant-specific price configuration for a specific provider+model. + Optionally specify a platform. Only user-defined prices can be deleted. + operationId: deleteLlmModelPrice + parameters: + - in: path + name: provider + required: true + schema: + type: string + description: Provider + example: openai + - in: path + name: modelName + required: true + schema: + type: string + description: Model name + example: gpt-4 + - in: query + name: platform + schema: + type: string + description: Platform (optional). If not specified, deletes all-platforms + pricing. + example: aws + responses: + '204': + description: No Content - Successfully deleted + '404': + description: Not Found - Price configuration does not exist + security: + - ApiKeyAuth: + - CanConfigureLlmModelPrice + summary: Delete LLM model price + tags: + - LLM Price Configuration + x-ibm-ahub-byok: true + get: + description: Fetch the price for a specific provider+model. Optionally specify + a platform for platform-specific pricing. + operationId: getLlmModelPrice + parameters: + - in: path + name: provider + required: true + schema: + type: string + description: Provider + example: openai + - in: path + name: modelName + required: true + schema: + type: string + description: Model name + example: gpt-4 + - in: query + name: platform + schema: + type: string + description: Platform (optional). If not specified, returns pricing for + all platforms. + example: aws + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LlmModelPrice' + description: OK + '404': + description: Not Found + security: + - ApiKeyAuth: + - CanConfigureLlmModelPrice + summary: Get LLM model price + tags: + - LLM Price Configuration + x-ibm-ahub-byok: true + put: + description: Create or update price for a specific provider+model. Optionally + specify a platform for platform-specific pricing. + operationId: upsertLlmModelPrice + parameters: + - in: path + name: provider + required: true + schema: + type: string + description: Provider + example: openai + - in: path + name: modelName + required: true + schema: + type: string + description: Model name + example: gpt-4 + - in: query + name: platform + schema: + type: string + description: Platform (optional). If not specified, pricing applies to all + platforms. + example: aws + requestBody: + content: + application/json: + example: + inputCost: 0.5 + outputCost: 1.5 + schema: + $ref: '#/components/schemas/LlmModelPrice' + responses: + '200': + description: OK + security: + - ApiKeyAuth: + - CanConfigureLlmModelPrice + summary: Upsert LLM model price + tags: + - LLM Price Configuration + x-ibm-ahub-byok: true /api/settings/maintenance: get: deprecated: true @@ -17716,6 +20006,7 @@ paths: example: - id: role-1 name: Administrator + description: null members: - userId: user-1 email: admin@example.com @@ -17730,6 +20021,7 @@ paths: - CAN_CONFIGURE_TEAMS - id: role-2 name: Developer + description: my optional description (< 500 characters) members: - userId: user-3 email: dev1@example.com @@ -17763,6 +20055,7 @@ paths: application/json: example: name: New Role + description: optional attribute members: - userId: user-5 email: newuser@example.com @@ -17781,6 +20074,7 @@ paths: example: id: role-3 name: New Role + description: optional attribute members: - userId: user-5 email: newuser@example.com @@ -17896,6 +20190,7 @@ paths: example: id: role-2 name: Updated Developer Role + description: optional attribute members: - userId: user-3 email: dev1@example.com @@ -17922,6 +20217,7 @@ paths: example: id: role-2 name: Updated Developer Role + description: optional attribute members: - userId: user-3 email: dev1@example.com @@ -18210,11 +20506,46 @@ paths: requestBody: content: application/json: + example: + id: teamId + tag: teamTag + info: + description: description for the team + scope: + accessPermissions: + - LIMITED_APPLICATIONS_SCOPE + actionFilter: '' + applications: + - applicationId1 + - applicationId2 + restrictedApplicationFilter: + restrictingApplicationId: applicationId3 + label: demo + tagFilterExpression: + type: TAG_FILTER + name: service.name + operator: EQUALS + entity: DESTINATION + value: butler + scope: INCLUDE_NO_DOWNSTREAM + members: + - userId: userId + email: username@example.com + name: userName + roles: + - roleId: '-3' + roleName: Default + viaIdP: false + entities: [ + ] schema: $ref: '#/components/schemas/ApiTeam' + required: true responses: '200': description: Team updated successfully + '400': + description: Bad Request '404': description: Team not found security: @@ -18749,7 +21080,7 @@ paths: - Default summary: Get All SLO Configs tags: - - Service Levels Objective(SLO) Configurations + - SLO Configurations x-ibm-ahub-byok: true post: operationId: createSloConfig @@ -18835,7 +21166,7 @@ paths: - canConfigureServiceLevels summary: Create a new SLO Config tags: - - Service Levels Objective(SLO) Configurations + - SLO Configurations x-description: createSloConfiguration x-ibm-ahub-byok: true /api/settings/slo/tags: @@ -18903,7 +21234,7 @@ paths: - Default summary: Get All SLO Config tags tags: - - Service Levels Objective(SLO) Configurations + - SLO Configurations x-ibm-ahub-byok: true /api/settings/slo/{id}: delete: @@ -18924,7 +21255,7 @@ paths: - canConfigureServiceLevels summary: Delete an existing SLO Config tags: - - Service Levels Objective(SLO) Configurations + - SLO Configurations x-ibm-ahub-byok: true get: operationId: getSloConfigById @@ -18993,7 +21324,7 @@ paths: - Default summary: Get an existing SLO Config tags: - - Service Levels Objective(SLO) Configurations + - SLO Configurations x-ibm-ahub-byok: true put: operationId: updateSloConfig @@ -19089,7 +21420,7 @@ paths: - canConfigureServiceLevels summary: Update an existing SLO Config tags: - - Service Levels Objective(SLO) Configurations + - SLO Configurations x-description: updateSloConfiguration x-ibm-ahub-byok: true /api/settings/synthetic-calls: @@ -19162,7 +21493,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - ConfigureServiceMapping @@ -19185,6 +21516,8 @@ paths: fullName: username lastLoggedIn: 1636434847190 groupCount: 1 + teamNames: [ + ] tfaEnabled: false schema: type: array @@ -19194,7 +21527,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureUsers @@ -19229,7 +21562,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureUsers @@ -19260,7 +21593,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. security: @@ -19289,7 +21622,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureUsers @@ -19344,7 +21677,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. security: - ApiKeyAuth: - CanConfigureUsers @@ -20121,13 +22454,14 @@ paths: application/json: example: errors: - - There is No SLO Correction Windows or Error happened while trying - to fetch SLO Correction Windows. + - No SLO Correction Windows found for the given parameters in this + time range schema: type: array items: type: string - description: There is no SLO Correction Window + description: No SLO Correction Windows found for the given parameters in + this time range security: - ApiKeyAuth: - Default @@ -20135,11 +22469,179 @@ paths: tags: - SLO Correction Windows x-ibm-ahub-byok: true + /api/slo/entities/{sloId}: + get: + operationId: entitiesSlo + parameters: + - description: Service Levels Objective(SLO) Configuration ID + example: SLOEANnWh9tQOa2h88kGxK6wQ + in: path + name: sloId + required: true + schema: + type: string + - description: Size of the time window in which the monitored entities must + be fetched, specified in milliseconds. If not provided or set to 0, the + default value of 3600000 milliseconds (1 hour) is used. + example: 360000 + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: Ending point for the data retrieval, specified as a 13-digit + Unix timestamp in milliseconds. If not provided or set to 0, the current + system time will be used. + example: 1706813100000 + in: query + name: to + schema: + type: integer + format: int64 + - description: Size of the Page + example: 1 + in: query + name: pageSize + schema: + type: integer + format: int32 + - description: Page Number + example: 1 + in: query + name: page + schema: + type: integer + format: int32 + responses: + '200': + content: + application/json: + example: + items: + - 0KmqAFCLeONAGzW4NRbV + - 174tEB4Oe7YsedZA25bh + - 1gV7O4bmdpGZYDG4Ojdd + - 1oYkh2uPmFQAEa3IraUq + - 1tHGNPXKWeaLV2pAN0gT + - 1uZxs5rQvJdf1jwMH6zq + - 3hmyDjiWBJotlh06MKGR + - 4H6WNu3RoluhkEo7iNJC + - 6K627mcw5jxHOkAUXHkm + - 7MKJz441px6U5U0L7Xcb + page: 1 + pageSize: 10 + totalHits: 100 + schema: + type: array + items: + type: string + description: SLO entities retrieved Successfully + '404': + content: + application/json: + example: + code: 404 + message: SLO Configuration not found + schema: + type: array + items: + type: string + description: There is no SLO configuration for the given ID + security: + - ApiKeyAuth: + - Default + summary: Get the entities monitored by a SLO (Service Level Objective) configuration + tags: + - Service Levels Objective(SLO) Report + x-ibm-ahub-byok: true + /api/slo/explain/{sloId}: + get: + operationId: explainSlo + parameters: + - description: Service Levels Objective(SLO) Configuration ID + example: SLOEANnWh9tQOa2h88kGxK6wQ + in: path + name: sloId + required: true + schema: + type: string + - description: Starting point for the data retrieval, specified as 13 digit + Unix Timestamp milliseconds + example: 1706713140000 + in: query + name: from + schema: + type: string + - description: Ending point for the data retrieval, specified as 13 digit Unix + Timestamp milliseconds + example: 1706813100000 + in: query + name: to + schema: + type: string + responses: + '200': + content: + application/json: + example: " **Slo overview**\n - Name: sample-application-availability-eventBased-fixed-1-week\ + \ \n - Target: 99% \n - Time window: fixed 1 week \n\n \ + \ **Entity context**\n - Type: application \n - Application\ + \ id: jo2-TgULSnqzJp2UgN9oLA \n - Label: All Services \n -\ + \ Scope: include immediate downstream database and messaging, inbound\ + \ boundary \n - Tag filter: call.type not empty \n - Access:\ + \ read/write global \n\n **Current performance status**\n -\ + \ Sli: 92.08% (below target) \n - Error budget total: 467 units\ + \ \n - Error budget remaining: -3232 (overrun) \n - Error\ + \ budget spent: 3699 units \n - Error burn rate: 7 (seven times\ + \ the allowed rate) \n - Error accumulation exhausted the error\ + \ budget by the fourth interval \n - Violation distribution: none\ + \ reported (budget exhausted) \n\n **Key insights**\n - Slo\ + \ is significantly breached, indicating major availability issues.\ + \ \n - Error budget was exhausted quickly, suggesting a sustained\ + \ high error rate. \n - Burn rate consistently above 7, far exceeding\ + \ the safe threshold of 1. \n - Most errors occurred early in\ + \ the reporting period (first 4 intervals). \n - No specific violation\ + \ distribution provided, implying widespread impact across the application.\ + \ \n\n **Recommendations**\n - Initiate immediate incident\ + \ response to identify root causes of availability failures. \n \ + \ - Review downstream database and messaging dependencies for latency\ + \ or failures. \n - Increase monitoring granularity on the affected\ + \ services and error events. \n - Implement automated alerts when\ + \ burn rate exceeds 2× the target. \n - Consider short‑term remediation\ + \ (restart services, roll back recent changes) to restore availability.\ + \ \n - Conduct a post‑mortem and update runbooks to prevent recurrence.\ + \ \n - Re‑evaluate the slo target or threshold if the current\ + \ environment cannot realistically meet 99% availability.\n" + schema: + type: array + items: + type: string + description: Explain SLO Successfully + '404': + content: + application/json: + example: + errors: + - There is no SLO configuration for the given ID or the report hasn't + been generated yet. + schema: + type: array + items: + type: string + description: There is no SLO configuration for the given ID or the explain + result hasn't been generated yet. + security: + - ApiKeyAuth: + - Default + summary: Explain Service Levels objective with more details. + tags: + - Service Levels Objective(SLO) Report + x-ibm-ahub-byok: true /api/slo/report/{sloId}: get: operationId: getSlo parameters: - - description: Service Levels Objective(SLO) Configuration ID + - description: SLO Configuration ID example: SLOEANnWh9tQOa2h88kGxK6wQ in: path name: sloId @@ -20891,6 +23393,62 @@ paths: tags: - Service Levels Objective(SLO) Report x-ibm-ahub-byok: true + /api/slo/summarize/{sloId}: + get: + operationId: summarizeSlo + parameters: + - description: Service Levels Objective(SLO) Configuration ID + example: SLOEANnWh9tQOa2h88kGxK6wQ + in: path + name: sloId + required: true + schema: + type: string + - description: Starting point for the data retrieval, specified as 13 digit + Unix Timestamp milliseconds + example: 1706713140000 + in: query + name: from + schema: + type: string + - description: Ending point for the data retrieval, specified as 13 digit Unix + Timestamp milliseconds + example: 1706813100000 + in: query + name: to + schema: + type: string + responses: + '200': + content: + application/json: + example: | + **sample-application-availability-eventBased-fixed-1-week** targets 99 % availability over a fixed one‑week window for the **All Services** application. It monitors event‑based availability across the entire application boundary, excluding internal and synthetic traffic. Current reporting shows the SLO is not meeting its target, with the error budget fully consumed and a sustained high burn rate, indicating a significant performance shortfall that warrants immediate attention. + schema: + type: array + items: + type: string + description: Summarize SLO Successfully + '404': + content: + application/json: + example: + errors: + - There is no SLO configuration for the given ID or the report hasn't + been generated yet. + schema: + type: array + items: + type: string + description: There is no SLO configuration for the given ID or the summarization + result hasn't been generated yet. + security: + - ApiKeyAuth: + - Default + summary: Summarize Service Levels objective results. + tags: + - Service Levels Objective(SLO) Report + x-ibm-ahub-byok: true /api/synthetics/catalog: get: operationId: getSyntheticTagCatalog @@ -21265,7 +23823,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -21398,7 +23956,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -21530,7 +24088,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -21614,7 +24172,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -21789,7 +24347,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -21846,7 +24404,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -21888,8 +24446,10 @@ paths: type: string enum: - HAR + - IMAGES - LOGS - SUBTRANSACTIONS + - VIDEOS - description: Name of the test result detailed file, if more than one file available for the same type. Can be used when parameter type=LOGS example: console.log @@ -21932,7 +24492,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -21994,7 +24554,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -22040,7 +24600,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -22079,7 +24639,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -22119,7 +24679,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -22164,7 +24724,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -22197,7 +24757,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -22242,7 +24802,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -22290,7 +24850,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -22348,7 +24908,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -22397,7 +24957,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -22788,7 +25348,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -22868,7 +25428,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -22918,7 +25478,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -22985,7 +25545,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -23067,7 +25627,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -23123,7 +25683,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -23171,7 +25731,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -23204,7 +25764,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -23294,7 +25854,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -23345,7 +25905,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -23411,7 +25971,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -23661,6 +26221,7 @@ paths: required: true schema: type: string + minLength: 1 - description: useCase example: GROUPING in: query @@ -23866,6 +26427,7 @@ paths: displayName: test schema: type: array + description: Array of team tags items: type: object properties: @@ -23892,7 +26454,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -23920,7 +26482,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -24001,7 +26563,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -24038,7 +26600,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -24076,7 +26638,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -24109,7 +26671,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -24146,7 +26708,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '415': @@ -24185,7 +26747,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -24223,7 +26785,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -24312,7 +26874,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '422': description: Unprocessable request - missing/invalid data. '500': @@ -24347,7 +26909,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. summary: Delete sourcemap upload configuration for website @@ -24418,7 +26980,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -24486,7 +27048,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '404': description: Resource not found. '500': @@ -24535,7 +27097,7 @@ paths: '401': description: Unauthorized access - requires user authentication. '403': - description: Insufficient permissions. + description: Insufficient permissions or limited in access. '500': description: Internal server error. security: @@ -24785,6 +27347,7 @@ components: BIDIRECTIONAL_SLACK: '#/components/schemas/BidirectionalSlackAppIntegration' EMAIL: '#/components/schemas/EmailIntegration' GOOGLE_CHAT: '#/components/schemas/GoogleChatIntegration' + NS1: '#/components/schemas/NS1Integration' OFFICE_365: '#/components/schemas/Office365Integration' OPS_GENIE: '#/components/schemas/OpsgenieIntegration' PAGER_DUTY: '#/components/schemas/PagerdutyIntegration' @@ -24804,12 +27367,16 @@ components: id: type: string description: Unique ID of the returned Alert Channel + minLength: 1 kind: type: string description: The type of the Alerting Channel. name: type: string description: The name of the Alerting Channel. + timezone: + type: string + description: The timezone to be used for DateTime required: - id - kind @@ -24833,54 +27400,6 @@ components: format: int32 required: - ruleType - AccessLogEntry: - type: object - properties: - action: - type: string - enum: - - GRANT_TEMP_ACCESS - - FIRST_LOGIN - - LOGIN - - ACCESS - - FAILED_LOGIN - - LOGOUT - - CREATE_API_TOKEN_BY_POLICY - - IDP_MAPPING - - DISABLE_IP_RESTRICTION - email: - type: string - fullName: - type: string - message: - type: string - meta: - type: object - additionalProperties: - type: object - tenantId: - type: string - tenantUnitId: - type: string - timestamp: - type: integer - format: int64 - minimum: 1118583367265 - required: - - action - - email - - fullName - - tenantId - AccessLogResponse: - type: object - properties: - entries: - type: array - items: - $ref: '#/components/schemas/AccessLogEntry' - total: - type: integer - format: int64 AccessRule: type: object properties: @@ -24963,6 +27482,7 @@ components: items: type: string description: List of tags added to the action. + minLength: 1 type: type: string description: 'Action type can be one of the following values: SCRIPT, HTTP, @@ -25010,6 +27530,7 @@ components: actionId: type: string description: Action identifier of the action to run. + minLength: 1 actionInstanceId: type: string description: Action run identifier. @@ -25017,6 +27538,7 @@ components: actionName: type: string description: Action name of the action to run. + minLength: 1 actionSnapshot: type: string description: Snapshot of the action definition. @@ -25137,6 +27659,7 @@ components: name: type: string description: Metadata name. + minLength: 1 value: type: string description: Metadata value. @@ -25149,9 +27672,11 @@ components: displayName: type: string description: Parameter display name. + minLength: 1 name: type: string description: Parameter name. + minLength: 1 type: type: string description: Parameter type. Valid values are `static`, `dynamic` or `vault` @@ -25230,10 +27755,6 @@ components: score: type: number format: double - required: - - aiEngine - - confidence - - score ActionSearchSpace: type: object properties: @@ -25249,6 +27770,7 @@ components: name: type: string description: The name of an incident or issue. + minLength: 1 required: - name AdaptiveBaseline: @@ -25279,13 +27801,6 @@ components: exclusiveMinimum: false maximum: 16.0 minimum: 0.5 - Addition: - type: object - allOf: - - $ref: '#/components/schemas/ArithmeticOperation' - required: - - left - - right AdjustedTimeframe: type: object description: | @@ -25321,6 +27836,18 @@ components: type: string maxLength: 65536 minLength: 0 + AgentModeUpdate: + type: object + properties: + agent-mode: + type: string + minLength: 1 + pattern: APM|INFRASTRUCTURE|INFRA|OFF + modeAsInteger: + type: integer + format: int32 + required: + - agent-mode AlertingConfiguration: type: object properties: @@ -25332,9 +27859,10 @@ components: customPayloadFields: type: array description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + alert notifications. Supports both static and dynamic fields. Can be left + empty. items: - $ref: '#/components/schemas/StaticStringField' + $ref: '#/components/schemas/CustomPayloadField' maxItems: 20 minItems: 0 eventFilteringConfiguration: @@ -25354,6 +27882,7 @@ components: items: type: string description: List of Alert Channel IDs added in this Alert Configuration. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -25380,9 +27909,10 @@ components: customPayloadFields: type: array description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + alert notifications. Supports both static and dynamic fields. Can be left + empty. items: - $ref: '#/components/schemas/StaticStringField' + $ref: '#/components/schemas/CustomPayloadField' maxItems: 20 minItems: 0 eventFilteringConfiguration: @@ -25402,6 +27932,7 @@ components: items: type: string description: List of Alert Channel IDs added in this Alert Configuration. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -25460,18 +27991,28 @@ components: $ref: '#/components/schemas/ApdexEntity' apdexName: type: string - description: Name of the Apdex Configuration maxLength: 256 minLength: 0 createdAt: type: integer format: int64 - description: Created Date of Apdex Configuration + description: Created date of Apdex Configuration (Unix timestamp in milliseconds) id: type: string description: Apdex Configuration ID maxLength: 64 minLength: 0 + lastUpdated: + type: integer + format: int64 + description: Last updated date of Apdex Configuration (Unix timestamp in + milliseconds) + tags: + type: array + description: List of tags associated with Apdex Configuration + items: + type: string + description: List of tags associated with Apdex Configuration required: - apdexEntity - apdexName @@ -25486,6 +28027,12 @@ components: description: Name of the Apdex Configuration maxLength: 256 minLength: 0 + tags: + type: array + description: List of tags associated with Apdex Configuration + items: + type: string + description: List of tags associated with Apdex Configuration required: - apdexEntity - apdexName @@ -25502,6 +28049,7 @@ components: type: string entityId: type: string + minLength: 1 tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' threshold: @@ -25512,6 +28060,29 @@ components: - apdexType - entityId - tagFilterExpression + ApdexLevel: + type: object + description: Apdex satisfaction level definition with threshold boundaries + properties: + id: + type: integer + format: int32 + description: Unique identifier for the level + example: 0 + lower: + type: number + format: double + description: Lower threshold boundary (inclusive) + example: 0.94 + name: + type: string + description: Name of the satisfaction level + example: Excellent + upper: + type: number + format: double + description: Upper threshold boundary (inclusive) + example: 1.0 ApdexReport: type: object properties: @@ -25543,6 +28114,10 @@ components: ApiCreateGroup: type: object properties: + description: + type: string + maxLength: 500 + minLength: 0 members: type: array items: @@ -25550,6 +28125,7 @@ components: uniqueItems: true name: type: string + minLength: 1 permissionSet: $ref: '#/components/schemas/ApiPermissionSet' required: @@ -25559,6 +28135,10 @@ components: ApiCreateRole: type: object properties: + description: + type: string + maxLength: 500 + minLength: 0 members: type: array items: @@ -25566,10 +28146,12 @@ components: uniqueItems: true name: type: string + minLength: 1 permissions: type: array items: type: string + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -25578,6 +28160,10 @@ components: ApiGroup: type: object properties: + description: + type: string + maxLength: 500 + minLength: 0 id: type: string maxLength: 64 @@ -25589,6 +28175,7 @@ components: uniqueItems: true name: type: string + minLength: 1 permissionSet: $ref: '#/components/schemas/ApiPermissionSet' required: @@ -25653,6 +28240,7 @@ components: type: array items: type: string + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -25703,6 +28291,8 @@ components: properties: label: type: string + maxLength: 128 + minLength: 1 restrictingApplicationId: type: string scope: @@ -25713,9 +28303,16 @@ components: - INCLUDE_ALL_DOWNSTREAM tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' + required: + - label + - scope ApiRole: type: object properties: + description: + type: string + maxLength: 500 + minLength: 0 id: type: string members: @@ -25725,6 +28322,7 @@ components: uniqueItems: true name: type: string + minLength: 1 permissions: type: array items: @@ -25837,6 +28435,7 @@ components: - LIMITED_LINUX_KVM_HYPERVISOR_SCOPE - LIMITED_AI_GATEWAY_SCOPE - LIMITED_SERVICE_LEVEL_SCOPE + - LIMITED_GEN_AI_CAPABILITIES_SCOPE uniqueItems: true actionFilter: type: string @@ -25901,6 +28500,7 @@ components: properties: accessGrantingToken: type: string + minLength: 1 canConfigureAgentRunMode: type: boolean canConfigureAgents: @@ -25941,10 +28541,14 @@ components: type: boolean canConfigureGlobalSyntheticSmartAlerts: type: boolean + canConfigureIPFiltering: + type: boolean canConfigureIntegrations: type: boolean canConfigureLLM: type: boolean + canConfigureLLMModelPrice: + type: boolean canConfigureLogManagement: type: boolean canConfigureLogRetentionPeriod: @@ -25957,6 +28561,8 @@ components: type: boolean canConfigurePersonalApiTokens: type: boolean + canConfigurePersonallyIdentifiableInformationMasking: + type: boolean canConfigureReleases: type: boolean canConfigureServiceLevelCorrectionWindows: @@ -25995,6 +28601,8 @@ components: type: boolean canDeleteLogs: type: boolean + canDownloadAgentConfiguration: + type: boolean canEditAllAccessibleCustomDashboards: type: boolean canInstallNewAgents: @@ -26043,6 +28651,7 @@ components: type: string internalId: type: string + minLength: 1 lastUsedOn: type: integer format: int64 @@ -26056,6 +28665,8 @@ components: type: boolean limitedBizOpsScope: type: boolean + limitedGenAICapabilitiesScope: + type: boolean limitedGenAIScope: type: boolean limitedInfrastructureScope: @@ -26096,6 +28707,7 @@ components: type: boolean name: type: string + minLength: 1 required: - accessGrantingToken - internalId @@ -26133,6 +28745,7 @@ components: metric: type: string description: 'Set a particular metric, eg: `latency`.' + minLength: 1 numeratorTagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' required: @@ -26145,6 +28758,7 @@ components: boundaryScope: type: string description: Here, `ALL` Application Boundary Scope is considered. + minLength: 1 entityType: type: string description: Since, this is an Application Perspective, it will be of type @@ -26156,9 +28770,11 @@ components: id: type: string description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.' + minLength: 1 label: type: string description: 'Name of the Application Perspective. Eg: `app1`.' + minLength: 1 required: - boundaryScope - id @@ -26176,6 +28792,7 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -26222,6 +28839,9 @@ components: by this Smart Alert configuration. maxLength: 65536 minLength: 0 + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. evaluationType: type: string description: Determines whether calls of the aggregated metrics are grouped @@ -26326,6 +28946,7 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -26526,6 +29147,7 @@ components: type: string metricName: type: string + minLength: 1 required: - alertType - metricName @@ -26544,6 +29166,7 @@ components: entityId: type: string description: Application ID + minLength: 1 includeInternal: type: boolean description: A boolean value indicating whether the SLO takes Internal @@ -26731,6 +29354,7 @@ components: id: type: string description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.' + minLength: 1 name: type: string description: 'Name of the Application Perspective. Eg: `app1`.' @@ -26772,6 +29396,7 @@ components: applicationId: type: string description: The ID of the Application + minLength: 1 boundaryScope: type: string description: The Boundary Scope of the Application @@ -26795,6 +29420,8 @@ components: required: - applicationId - boundaryScope + - includeInternal + - includeSynthetic ApplicationTimeThreshold: type: object description: The type of threshold to define the criteria when the event and @@ -26813,71 +29440,13 @@ components: type: string required: - type - ArithmeticConfiguration: - type: object - allOf: - - $ref: '#/components/schemas/InfraMetricConfiguration' - - type: object - properties: - operation: - $ref: '#/components/schemas/ArithmeticOperation' - ArithmeticOperand: - type: object - oneOf: - - $ref: '#/components/schemas/SingleValue' - - $ref: '#/components/schemas/MetricQuery' - - $ref: '#/components/schemas/NestedOperation' - ArithmeticOperation: - type: object - discriminator: - mapping: - ADDITION: '#/components/schemas/Addition' - DIVISION: '#/components/schemas/Division' - MULTIPLICATION: '#/components/schemas/Multiplication' - SUBTRACTION: '#/components/schemas/Subtraction' - propertyName: operator - properties: - left: - $ref: '#/components/schemas/ArithmeticOperand' - operator: - type: string - right: - $ref: '#/components/schemas/ArithmeticOperand' - required: - - left - - operator - - right - AuditLogEntry: - type: object - properties: - action: - type: string - actor: - $ref: '#/components/schemas/LogEntryActor' - id: - type: string - message: - type: string - meta: - type: object - additionalProperties: - type: object - timestamp: - type: integer - format: int64 - required: - - action - - actor - - id - - message - - meta AuditLogUiResponse: type: object properties: entries: type: array items: - $ref: '#/components/schemas/AuditLogEntry' + type: object total: type: integer format: int64 @@ -26995,20 +29564,26 @@ components: properties: apiTokenId: type: string + minLength: 1 channelId: type: string + minLength: 1 channelName: type: string + minLength: 1 instanaUrl: type: string + minLength: 1 serviceUrl: type: string teamId: type: string + minLength: 1 teamName: type: string tenantId: type: string + minLength: 1 tenantName: type: string required: @@ -27164,6 +29739,9 @@ components: description: ID of short plugin of Built-in Event Specification maxLength: 64 minLength: 0 + supportedPollRateSeconds: + type: integer + format: int32 triggering: type: boolean description: Flag to show whether the Built-in Event Specification is triggering @@ -27224,6 +29802,9 @@ components: description: ID of short plugin of Built-in Event Specification maxLength: 64 minLength: 0 + supportedPollRateSeconds: + type: integer + format: int32 triggering: type: boolean description: Flag to show whether the Built-in Event Specification is triggering @@ -27233,6 +29814,18 @@ components: - name - ruleInputs - shortPluginId + BulkAlertConfigRequest: + type: object + properties: + configs: + type: object + additionalProperties: + type: array + items: + type: string + uniqueItems: true + required: + - configs BusinessActivity: type: object properties: @@ -27257,6 +29850,7 @@ components: type: string description: 'Type of the activity ' example: userTask + minLength: 1 callId: type: string writeOnly: true @@ -27335,6 +29929,7 @@ components: name: type: string description: Name of the group. + minLength: 1 timestamp: type: integer format: int64 @@ -27533,6 +30128,7 @@ components: type: string description: This is the list of SLO configurations related to this Correction Window. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -27565,7 +30161,7 @@ components: - hour - day - week - - month + - calendar_month recurrent: type: boolean recurrentRule: @@ -27661,17 +30257,35 @@ components: Minimum value is 1 and maximum value is 200. maximum: 200 minimum: 1 - CursorPaginationInfraExploreCursor: + CursorPaginationWithUiCursorInfraExploreCursor: type: object + description: | + Details for controlling the pagination of the API response. + This object allows you to define the starting point for retrieving records, how many records to skip, and the size of the result set. properties: - cursor: - $ref: '#/components/schemas/InfraExploreCursor' + ingestionTime: + type: integer + format: int64 + description: | + The timestamp indicating the starting point from which data was ingested. + The format of the timestamp is in Unix epoch Time. + For example, `Thursday, 5 September 2024 07:03:13 GMT` can be represented as `1725519793`. + offset: + type: integer + format: int32 + description: | + The number of records to be skipped from the `ingestionTime`. + For example: when `offset` is 20 and `ingestionTime` is 1725519793, the API response should have records starting from the 21st record after the specified `ingestionTime`. + Note that if `offset` value is not empty, `ingestionTime` can't be empty. retrievalSize: type: integer format: int32 - description: number of values to return - required: - - retrievalSize + description: | + The number of records to retrieve in a single request. + For example, when retrievalSize is set to 30, offset is 20, and ingestionTime is 1725519793, the API request will fetch 30 records starting from the 21st record after the specified `ingestionTime`. + Minimum value is 1 and maximum value is 200. + maximum: 200 + minimum: 1 CustomBlueprintIndicator: type: object allOf: @@ -27702,6 +30316,7 @@ components: type: string title: type: string + minLength: 1 widgets: type: array items: @@ -27711,7 +30326,6 @@ components: uniqueItems: true required: - accessRules - - id - title - widgets CustomDashboardPreview: @@ -27733,8 +30347,10 @@ components: minLength: 0 ownerId: type: string + minLength: 1 title: type: string + minLength: 1 required: - annotations - id @@ -27755,6 +30371,7 @@ components: type: string title: type: string + minLength: 1 widgets: type: array items: @@ -27766,7 +30383,6 @@ components: type: boolean required: - accessRules - - id - ownerId - title - widgets @@ -27798,7 +30414,6 @@ components: the dependency. maxItems: 512 minItems: 0 - uniqueItems: true name: type: string maxLength: 256 @@ -27893,13 +30508,21 @@ components: type: string label: type: string + minLength: 1 metrics: type: array items: $ref: '#/components/schemas/CustomMetric' uniqueItems: true + name: + type: string tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' + tags: + type: array + items: + $ref: '#/components/schemas/CustomTag' + uniqueItems: true required: - identifiers - label @@ -27914,6 +30537,7 @@ components: $ref: '#/components/schemas/CustomEntityModel' id: type: string + minLength: 1 version: type: string required: @@ -27927,6 +30551,7 @@ components: properties: customEventName: type: string + minLength: 1 required: - aggregation - customEventName @@ -28014,6 +30639,10 @@ components: type: string maxLength: 64 minLength: 0 + infraAlertConfigId: + type: string + maxLength: 64 + minLength: 0 lastUpdated: type: integer format: int64 @@ -28062,6 +30691,7 @@ components: properties: customEventName: type: string + minLength: 1 required: - aggregation - customEventName @@ -28073,7 +30703,7 @@ components: type: string description: Aggregation to apply on the metric for every member. enum: - - AVG + - MEAN - SUM category: type: string @@ -28153,7 +30783,9 @@ components: - KAFKA_CONNECT - KUBERNETES - MONGO_DB + - MSSQL - OTHERS + - POSTGRESQL - REDIS - SAP - SELF_MONITORING @@ -28170,6 +30802,9 @@ components: type: type: string description: Type of entity for the source metric + required: + - aggregation + - source CustomPayloadConfiguration: type: object properties: @@ -28189,6 +30824,7 @@ components: discriminator: mapping: dynamic: '#/components/schemas/DynamicField' + metricField: '#/components/schemas/MetricField' staticString: '#/components/schemas/StaticStringField' propertyName: type properties: @@ -28196,6 +30832,7 @@ components: type: string description: A user-specified unique identifier or name for a custom payload entry. + minLength: 1 type: type: string required: @@ -28217,6 +30854,7 @@ components: description: Unix timestamp representing the time (in milliseconds) the configuration was last updated. minimum: 1 + readOnly: true required: - fields CustomPayloadWithVersion: @@ -28235,6 +30873,7 @@ components: description: Unix timestamp representing the time (in milliseconds) the configuration was last updated. minimum: 1 + readOnly: true version: type: integer format: int32 @@ -28242,6 +30881,77 @@ components: required: - fields - version + CustomTag: + type: object + properties: + aggregation: + type: string + description: Aggregation to apply on the tag for every member. + enum: + - FIRST + - UNIQUE + - LIST + category: + type: string + description: Category of the tag in the catalog + description: + type: string + description: Description to be used in the catalog + label: + type: string + description: Label to be used in the catalog + name: + type: string + description: Name of the tag. Will use the same value as the source tag + if not specified. + section: + type: string + description: Section of the tag in the catalog + enum: + - ACE + - ALICLOUD + - AWS + - AZURE + - CASSANDRA + - CLOUD_FOUNDRY + - CLR + - COCKROACH + - CONSUL + - CONTAINER + - COUCHBASE + - DFQ + - ELASTICSEARCH + - GCP + - HADOOP_YARN + - HAZELCAST + - IBM_CLOUD + - IBM_DATAPOWER + - IBM_I_SERIES + - IBM_MQ + - IBM_MQMFT + - IBM_OPENSTACK + - KAFKA_CONNECT + - KUBERNETES + - MONGO_DB + - MSSQL + - OTHERS + - POSTGRESQL + - REDIS + - SAP + - SELF_MONITORING + - SOLR + - SPARK + - TIBCOBW + - TUXEDO + - VSHPERE + - WEBSPHERE + - CUSTOM_ENTITY + source: + type: string + description: Name of the source tag + type: + type: string + description: Type of entity for the source tag DNSConfiguration: type: object allOf: @@ -28342,8 +31052,10 @@ components: - CONTAINS - EQUALS - GREATER_THAN + - GREATER_THAN_OR_EQUALS - IS - LESS_THAN + - LESS_THAN_OR_EQUALS - MATCHES - NOT_MATCHES value: @@ -28372,8 +31084,10 @@ components: - CONTAINS - EQUALS - GREATER_THAN + - GREATER_THAN_OR_EQUALS - IS - LESS_THAN + - LESS_THAN_OR_EQUALS - MATCHES - NOT_MATCHES value: @@ -28387,8 +31101,10 @@ components: properties: id: type: string + minLength: 1 name: type: string + minLength: 1 required: - id - name @@ -28410,11 +31126,14 @@ components: - SOURCE name: type: string + minLength: 1 operator: type: string enum: - EQUALS - CONTAINS + - IN + - NOT_IN - LESS_THAN - LESS_OR_EQUAL_THAN - GREATER_THAN @@ -28436,13 +31155,6 @@ components: - name - operator - value - Division: - type: object - allOf: - - $ref: '#/components/schemas/ArithmeticOperation' - required: - - left - - right Duration: type: object properties: @@ -28481,6 +31193,7 @@ components: type: string description: Each dynamic payload entry is associated with tag from Instana's tag catalog + minLength: 1 required: - tagName DynamicParameter: @@ -28499,11 +31212,50 @@ components: tagName: type: string description: 'The name of the tag. Eg: `call.name`' + DynamicTag: + type: object + description: | + Structured dynamic tag prefixes with metadata + properties: + aliases: + type: array + description: List of prefix aliases + items: + type: string + description: List of prefix aliases + canApplyToDestination: + type: boolean + description: Flag to identify if possible to apply for destination + canApplyToSource: + type: boolean + description: Flag to identify if possible to apply for source + categoryLabels: + type: array + description: Category label + items: + type: string + description: Category label + icon: + type: string + description: Icon for the dynamic tag prefix + maxLength: 128 + minLength: 0 + prefix: + type: string + description: The actual prefix string + maxLength: 128 + minLength: 0 + type: + type: string + description: Type of the tag + required: + - prefix EditUser: type: object properties: fullName: type: string + minLength: 1 required: - fullName EmailIntegration: @@ -28518,6 +31270,8 @@ components: type: array items: type: string + minLength: 1 + minItems: 1 required: - emails - id @@ -28543,15 +31297,18 @@ components: id: type: string description: 'Unique ID of the Endpoint. Eg: `NCRq5oYnan5x-PkdTPQwLLUdu5M`.' + minLength: 1 isSynthetic: type: boolean writeOnly: true label: type: string description: 'Name of the Endpoint. Eg: `GET /api/fetch`.' + minLength: 1 serviceId: type: string description: The serviceId this endpoint belongs to. + minLength: 1 synthetic: type: boolean syntheticType: @@ -28641,6 +31398,7 @@ components: An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + minLength: 1 required: - endpointCase - serviceId @@ -28951,6 +31709,11 @@ components: minLength: 0 problem: $ref: '#/components/schemas/Problem' + rbacTags: + type: array + items: + $ref: '#/components/schemas/ApiTag' + uniqueItems: true rca: type: object additionalProperties: @@ -28987,6 +31750,7 @@ components: type: array items: type: string + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -29015,6 +31779,7 @@ components: type: array items: type: string + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -29166,9 +31931,11 @@ components: id: type: string description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.' + minLength: 1 label: type: string description: 'Name of the Service. Eg: `payment`.' + minLength: 1 maxSeverity: type: number format: double @@ -29237,12 +32004,15 @@ components: type: string encoding: type: string + minLength: 1 name: type: string + minLength: 1 secured: type: boolean value: type: string + minLength: 1 required: - encoding - name @@ -29257,6 +32027,7 @@ components: type: string description: | Given `/api/{version}/users` URI, `FIXED` names are `api` and `users` in order. + minLength: 1 required: - name - type @@ -29280,6 +32051,9 @@ components: - $ref: '#/components/schemas/InfraAlertRule' - type: object properties: + entityType: + type: string + minLength: 1 metricGroupBy: type: array items: @@ -29568,7 +32342,8 @@ components: type: string description: Id of the exact metric you want to retrieve, eg. "cpu.user", "clientrequests.read.mean" - maxItems: 5 + minLength: 1 + maxItems: 15 minItems: 1 uniqueItems: true plugin: @@ -29590,7 +32365,8 @@ components: items: type: string description: Unique identifier the metrics are assigned to - maxItems: 30 + minLength: 1 + maxItems: 60 minItems: 1 uniqueItems: true timeFrame: @@ -29604,6 +32380,7 @@ components: eventId: type: string description: Event identifier + minLength: 1 parameters: type: array description: List of dynamic parameters @@ -29726,7 +32503,7 @@ components: metrics: type: array items: - $ref: '#/components/schemas/InfraMetricConfiguration' + $ref: '#/components/schemas/SimpleMetricConfiguration' maxItems: 10 minItems: 0 missingPlaceholder: @@ -29734,7 +32511,7 @@ components: order: $ref: '#/components/schemas/Order' pagination: - $ref: '#/components/schemas/CursorPaginationInfraExploreCursor' + $ref: '#/components/schemas/CursorPaginationWithUiCursorInfraExploreCursor' tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' timeFrame: @@ -29753,7 +32530,7 @@ components: metrics: type: array items: - $ref: '#/components/schemas/InfraMetricConfiguration' + $ref: '#/components/schemas/SimpleMetricConfiguration' maxItems: 10 minItems: 0 missingPlaceholder: @@ -29761,7 +32538,7 @@ components: order: $ref: '#/components/schemas/Order' pagination: - $ref: '#/components/schemas/CursorPaginationInfraExploreCursor' + $ref: '#/components/schemas/CursorPaginationWithUiCursorInfraExploreCursor' tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' tags: @@ -30010,6 +32787,7 @@ components: description: A list of technologies to be used for filtering data. For example, technologies could include AWS ECS, Cassandra, DB2, JVM, Kafka, etc. A full list of available technologies can be found in X. + minLength: 1 maxItems: 20 minItems: 0 uniqueItems: true @@ -30095,7 +32873,6 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - analyticFunction - syntheticMetrics GetTestResultBase: type: object @@ -30408,6 +33185,7 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -30428,6 +33206,7 @@ components: type: string description: IDs of the applications that this Smart Alert is applied to. + minLength: 1 uniqueItems: true applications: type: object @@ -30584,6 +33363,7 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -30720,6 +33500,7 @@ components: properties: webhookUrl: type: string + minLength: 1 required: - id - kind @@ -30805,6 +33586,7 @@ components: type: string tagName: type: string + minLength: 1 required: - tagName GroupMapping: @@ -30812,6 +33594,7 @@ components: properties: groupId: type: string + minLength: 1 id: type: string maxLength: 64 @@ -30918,6 +33701,7 @@ components: type: array items: type: string + minLength: 1 expectJson: $ref: '#/components/schemas/ContainerNode' expectMatch: @@ -30926,6 +33710,7 @@ components: type: array items: type: string + minLength: 1 expectStatus: type: integer format: int32 @@ -31031,6 +33816,7 @@ components: An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + minLength: 1 required: - rules - serviceId @@ -31216,11 +34002,173 @@ components: - description - id - name + ICMPConfiguration: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + packetCount: + type: integer + format: int32 + packetInterval: + type: string + packetSize: + type: integer + format: int32 + packetTimeout: + type: string + targetHost: + type: string + useDNS: + type: boolean + useIPv6: + type: boolean + validationRules: + type: array + items: + $ref: '#/components/schemas/ICMPValidation' + required: + - markSyntheticCall + - syntheticType + - targetHost + ICMPConfigurationUpdate: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - type: object + properties: + packetCount: + type: integer + format: int32 + packetInterval: + type: string + packetSize: + type: integer + format: int32 + packetTimeout: + type: string + targetHost: + type: string + useDNS: + type: boolean + useIPv6: + type: boolean + validationRules: + $ref: '#/components/schemas/SyntheticResourceUpdateListICMPValidationListICMPValidation' + ICMPValidation: + type: object + properties: + key: + type: string + operator: + type: string + enum: + - CONTAINS + - EQUALS + - GREATER_THAN + - GREATER_THAN_OR_EQUALS + - IS + - LESS_THAN + - LESS_THAN_OR_EQUALS + - MATCHES + - NOT_MATCHES + value: + type: integer + format: int64 + required: + - key + - operator + - value + IPFiltering: + type: object + properties: + active: + type: boolean + description: If the configuration is currently enforced, can be permanent + active (if verified), or temporary after creation (enabling the verification). + denyAll: + type: boolean + description: Fallback configuration, if unmatched requests should be denied. + enabled: + type: boolean + description: If the configuration should be enforced. See active status + if it is actually enforced. + lastChangedAt: + type: integer + format: int64 + description: When the configuration was last changed. + lastVerifiedAt: + type: integer + format: int64 + description: When the configuration was last verified. Can be used to assume + if a configuration needs to be verified. + rules: + type: array + description: Actual traffic rules. Enforcing allow / block based on incoming + IP address. Are evaluated in given order. + items: + $ref: '#/components/schemas/IPFilteringRuleDto' + supportAccessEnabled: + type: boolean + description: If Instana support should be able to access your environment. + Instana support is still able to to deactivate the configuration for you + (manual process). + required: + - rules + IPFilteringRuleDto: + type: object + description: Actual traffic rules. Enforcing allow / block based on incoming + IP address. Are evaluated in given order. + properties: + block: + type: boolean + description: If the traffic should be blocked or denied. + target: + type: string + description: Target of this rule, can be either a IP address or a IP address + range. + required: + - block + - target + IPFilteringUpsert: + type: object + properties: + denyAll: + type: boolean + description: Fallback configuration, if unmatched requests should be denied. + enabled: + type: boolean + description: If the configuration should be enforced. See active status + if it is actually enforced. + rules: + type: array + description: Actual traffic rules. Enforcing allow / block based on incoming + IP address. Are evaluated in given order. + items: + $ref: '#/components/schemas/IPFilteringRuleDto' + maxItems: 75 + minItems: 1 + supportAccessEnabled: + type: boolean + description: If Instana support should be able to access your environment. + Instana support is still able to to deactivate the configuration for you + (manual process). + required: + - denyAll + - enabled + - rules + - supportAccessEnabled IdentityProviderPatch: type: object properties: restrictEmptyIdpGroups: type: boolean + IdpStatusUpdate: + type: object + properties: + enabled: + type: boolean ImpactedBeaconInfo: type: object properties: @@ -31247,6 +34195,7 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -31307,6 +34256,7 @@ components: items: type: string description: The grouping tags used to group the metric results. + minLength: 1 maxItems: 5 minItems: 0 name: @@ -31318,6 +34268,12 @@ components: minLength: 0 rule: $ref: '#/components/schemas/InfraAlertRule' + ruleLogicalOperator: + type: string + description: Set AND / OR + enum: + - AND + - OR rules: type: array description: A list of rules where each rule is associated with multiple @@ -31365,6 +34321,7 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -31431,6 +34388,7 @@ components: items: type: string description: The grouping tags used to group the metric results. + minLength: 1 maxItems: 5 minItems: 0 id: @@ -31452,6 +34410,12 @@ components: type: boolean rule: $ref: '#/components/schemas/InfraAlertRule' + ruleLogicalOperator: + type: string + description: Set AND / OR + enum: + - AND + - OR rules: type: array description: A list of rules where each rule is associated with multiple @@ -31544,6 +34508,7 @@ components: type: string metricName: type: string + minLength: 1 metricTagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' regex: @@ -31575,11 +34540,6 @@ components: InfraExploreCursor: type: object description: cursor to use between successive queries - InfraMetricConfiguration: - type: object - oneOf: - - $ref: '#/components/schemas/SimpleMetricConfiguration' - - $ref: '#/components/schemas/ArithmeticConfiguration' InfraSloEntity: type: object allOf: @@ -31730,6 +34690,7 @@ components: id: type: string description: Unique ID of the alert channel + minLength: 1 kind: type: string description: The type of the Alerting Channel. @@ -31757,8 +34718,11 @@ components: properties: email: type: string + format: email + minLength: 1 groupId: type: string + minLength: 1 message: type: string path: @@ -31809,6 +34773,7 @@ components: minimum: -1 file: type: string + minLength: 1 line: type: integer format: int32 @@ -31844,20 +34809,17 @@ components: type: object description: Custom handler definition. properties: - aiModel: - type: string - configurations: - $ref: '#/components/schemas/JsonNode' + capabilities: + type: array + items: + $ref: '#/components/schemas/LLMGatewayCapability' + uniqueItems: true createdAt: type: string description: type: string enabled: type: boolean - endpointApiKey: - type: string - endpointUrl: - type: string id: type: string format: uuid @@ -31865,32 +34827,77 @@ components: $ref: '#/components/schemas/JsonNode' metadata: $ref: '#/components/schemas/JsonNode' + model: + $ref: '#/components/schemas/LLMGatewayModel' modifiedAt: type: string name: type: string + minLength: 1 prompt: type: string - supports: - $ref: '#/components/schemas/JsonNode' + service: + $ref: '#/components/schemas/LLMGatewayService' system: type: boolean tenantUnitId: type: string - watsonxKey: + minLength: 1 + required: + - capabilities + - id + - model + - name + - service + - tenantUnitId + LLMGatewayCapability: + type: object + properties: + enabled: + type: boolean + id: type: string - watsonxProject: + minLength: 1 + name: type: string - watsonxUrl: + required: + - id + LLMGatewayModel: + type: object + properties: + configuration: + type: object + additionalProperties: + type: object + name: + type: string + LLMGatewayService: + type: object + properties: + connectionParameters: + type: object + additionalProperties: + type: string + id: + type: string + minLength: 1 + name: type: string required: - - createdAt - id - - modifiedAt - - name - - prompt - - supports - - tenantUnitId + LLMGatewayTestConnectionRequest: + type: object + properties: + connectionParameters: + type: object + additionalProperties: + type: string + gatewayId: + type: string + serviceId: + type: string + required: + - serviceId LatencyBlueprintIndicator: type: object allOf: @@ -31905,6 +34912,42 @@ components: minimum: 0.0 required: - type + LlmModelPrice: + type: object + properties: + defaultInputCost: + type: number + format: double + defaultOutputCost: + type: number + format: double + hasDefaultPrice: + type: boolean + inputCost: + type: number + format: double + isUserDefined: + type: boolean + modelName: + type: string + outputCost: + type: number + format: double + platform: + type: string + provider: + type: string + required: + - inputCost + - outputCost + LlmModelPriceMetadata: + type: object + properties: + currencyCode: + type: string + minLength: 1 + required: + - currencyCode LocationStatus: type: object properties: @@ -31912,6 +34955,9 @@ components: type: string locationId: type: string + minLength: 1 + locationType: + type: string successRate: type: number format: double @@ -31936,6 +34982,7 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -32037,6 +35084,7 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -32173,6 +35221,7 @@ components: type: string metricName: type: string + minLength: 1 required: - alertType - metricName @@ -32182,25 +35231,6 @@ components: - $ref: '#/components/schemas/LogAlertRule' required: - metricName - LogEntryActor: - type: object - properties: - email: - type: string - id: - type: string - name: - type: string - type: - type: string - enum: - - USER - - API_TOKEN - - POLICY - required: - - id - - name - - type LogEventResult: type: object allOf: @@ -32245,6 +35275,7 @@ components: logVolume: type: integer format: int64 + description: Log volume in bytes numberOfMonth: type: integer format: int32 @@ -32292,6 +35323,8 @@ components: enum: - EQUALS - CONTAINS + - IN + - NOT_IN - LESS_THAN - LESS_OR_EQUAL_THAN - GREATER_THAN @@ -32554,12 +35587,16 @@ components: type: string description: The event IDs to manually close, in case of multi close. uniqueItems: true + forceClose: + type: boolean + description: Flag to indicate whether to forcefully close issues muteAlerts: type: boolean description: Flag to indicate whether to mute alerts. reasonForClosing: type: string description: The reason for manual closing. + minLength: 1 username: type: string description: The user name. @@ -32697,6 +35734,7 @@ components: metric: type: string description: 'Set a particular metric, eg: `latency`.' + minLength: 1 required: - aggregation - metric @@ -32733,6 +35771,7 @@ components: type: string description: Defines the name of the metric to be monitored. Examples include `calls` and `latency` + minLength: 1 threshold: type: number format: double @@ -32820,19 +35859,69 @@ components: * `RATE`: Number of occurrences per second * `BYTE_RATE`: Number of bytes per second * `UNDEFINED`: Metric value unit is not known + minLength: 1 label: type: string description: The name of the metric. For example, `Call count`, `Erroneous calls`, `Service count` etc. + minLength: 1 metricId: type: string description: The unique id of the metric. For example, `calls`, `erroneousCalls`, `latency` etc. + minLength: 1 required: - aggregations - formatter - label - metricId + MetricField: + type: object + allOf: + - $ref: '#/components/schemas/CustomPayloadField' + - type: object + properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MIN + - MAX + entityType: + type: string + metricId: + type: string + timeWindow: + type: object + value: + $ref: '#/components/schemas/MetricFieldValue' + required: + - key + MetricFieldValue: + type: object + description: Configuration for a metric-based custom payload field + properties: + aggregation: + type: string + description: The aggregation type to apply to the metric + enum: + - SUM + - MEAN + - MIN + - MAX + entityType: + type: string + description: The entity type for the metric query + metricId: + type: string + description: The metric ID to retrieve + timeWindow: + type: object + description: The time window in milliseconds for metric aggregation + required: + - aggregation + - metricId MetricInstance: type: object properties: @@ -32840,6 +35929,7 @@ components: type: boolean description: type: string + minLength: 1 formatter: type: string description: | @@ -32879,10 +35969,13 @@ components: - UNDEFINED label: type: string + minLength: 1 metricId: type: string + minLength: 1 pluginId: type: string + minLength: 1 required: - description - formatter @@ -33030,7 +36123,9 @@ components: - KAFKA_CONNECT - KUBERNETES - MONGO_DB + - MSSQL - OTHERS + - POSTGRESQL - REDIS - SAP - SELF_MONITORING @@ -33075,70 +36170,10 @@ components: type: string prefix: type: string + minLength: 1 required: - operator - prefix - MetricQuery: - type: object - allOf: - - $ref: '#/components/schemas/ArithmeticOperand' - - type: object - properties: - aggregation: - type: string - enum: - - SUM - - MEAN - - MAX - - MIN - - P25 - - P50 - - P75 - - P90 - - P95 - - P98 - - P99 - - P99_9 - - P99_99 - - DISTINCT_COUNT - - SUM_POSITIVE - - PER_SECOND - - INCREASE - writeOnly: true - crossSeriesAggregation: - type: string - enum: - - SUM - - MEAN - - MAX - - MIN - - P25 - - P50 - - P75 - - P90 - - P95 - - P98 - - P99 - - P99_9 - - P99_99 - - DISTINCT_COUNT - - SUM_POSITIVE - - PER_SECOND - - INCREASE - writeOnly: true - granularity: - type: integer - format: int64 - writeOnly: true - metric: - type: string - writeOnly: true - regex: - type: boolean - writeOnly: true - required: - type: boolean - writeOnly: true MetricsResult: type: object properties: @@ -33225,6 +36260,7 @@ components: testId: type: string description: The testId for the Synthetic test. + minLength: 1 testName: type: string description: The Synthetic test's name. @@ -33263,6 +36299,7 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -33293,6 +36330,9 @@ components: by this Smart Alert configuration. maxLength: 65536 minLength: 0 + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. gracePeriod: type: integer format: int64 @@ -33312,6 +36352,9 @@ components: - 900000 - 1200000 - 1800000 + id: + type: string + writeOnly: true mobileAppId: type: string description: ID of the mobile app that this Smart Alert configuration is @@ -33363,6 +36406,149 @@ components: - name - tagFilterExpression - timeThreshold + MobileAppAlertConfigWithRBACTag: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + minLength: 1 + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + completeTagFilterExpression: + $ref: '#/components/schemas/TagFilterExpression' + created: + type: integer + format: int64 + description: Unix timestamp representing the creation time of this revision. + minimum: 1 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the mobile app alert configuration. Used as + a template for the description of alert/event notifications triggered + by this Smart Alert configuration. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + id: + type: string + description: 'ID of this Mobile App Alert Config. ' + maxLength: 64 + minLength: 0 + initialCreated: + type: integer + format: int64 + description: Unix timestamp representing the time of the initial revision. + minimum: 1 + mobileAppId: + type: string + description: ID of the mobile app that this Smart Alert configuration is + applied to. + maxLength: 64 + minLength: 0 + name: + type: string + description: Name of the mobile app alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + rbacTags: + type: array + description: RBAC tags associated with the mobile app + items: + $ref: '#/components/schemas/ApiTag' + uniqueItems: true + readOnly: + type: boolean + description: Flag to indicate whether or not the configuration is read-only. + Read-only access restricts modification of the config. + rule: + $ref: '#/components/schemas/MobileAppAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdMobileAppAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/MobileAppTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + required: + - customPayloadFields + - description + - granularity + - id + - mobileAppId + - name + - tagFilterExpression + - timeThreshold MobileAppAlertRule: type: object discriminator: @@ -33398,6 +36584,7 @@ components: type: string metricName: type: string + minLength: 1 required: - alertType - metricName @@ -33423,6 +36610,7 @@ components: type: number name: type: string + minLength: 1 required: - cursor - metrics @@ -33552,6 +36740,12 @@ components: description: ID of the mobile app. MobileAppMetricResult: type: object + additionalProperties: + type: array + items: + type: array + items: + type: number properties: empty: type: boolean @@ -33962,6 +37156,8 @@ components: type: array items: type: string + minLength: 1 + minItems: 1 uniqueItems: true defaultAggregation: type: string @@ -34008,14 +37204,17 @@ components: * `RATE`: Number of occurrences per second * `BYTE_RATE`: Number of bytes per second * `UNDEFINED`: Metric value unit is not known + minLength: 1 label: type: string description: The name of the metric. For example, `Call count`, `Erroneous calls`, `Service count` etc. + minLength: 1 metricId: type: string description: The unique id of the metric. For example, `calls`, `erroneousCalls`, `latency` etc. + minLength: 1 pathToValueInBeacon: type: array items: @@ -34068,6 +37267,7 @@ components: metric: type: string description: 'Set a particular metric, eg: `latency`.' + minLength: 1 numeratorTagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' required: @@ -34098,6 +37298,9 @@ components: hostCount: type: integer format: int32 + otelCollectorCount: + type: integer + format: int32 otelCount: type: integer format: int32 @@ -34116,6 +37319,10 @@ components: description: Count of hosts monitoredEntitiesStats: $ref: '#/components/schemas/MonitoredEntitiesStats' + openTelemetryCollectorCount: + type: integer + format: int32 + description: Count of open telemetry collectors openTelemetryCount: type: integer format: int32 @@ -34124,6 +37331,9 @@ components: type: integer format: int32 description: Count of serverless + required: + - hasEntities + - monitoredEntitiesStats MultipleScriptsConfiguration: type: object properties: @@ -34131,21 +37341,28 @@ components: type: string scriptFile: type: string - Multiplication: + NS1Integration: type: object allOf: - - $ref: '#/components/schemas/ArithmeticOperation' - required: - - left - - right - NestedOperation: - type: object - allOf: - - $ref: '#/components/schemas/ArithmeticOperand' + - $ref: '#/components/schemas/AbstractIntegration' - type: object properties: - operation: - $ref: '#/components/schemas/ArithmeticOperation' + headers: + type: array + items: + type: string + minLength: 1 + webhookUrls: + type: array + items: + type: string + minLength: 1 + minItems: 1 + required: + - id + - kind + - name + - webhookUrls NewApplicationConfig: type: object properties: @@ -34245,8 +37462,10 @@ components: type: string clientId: type: string + minLength: 1 clientSecret: type: string + minLength: 1 grantType: type: string enum: @@ -34257,6 +37476,7 @@ components: writeOnly: true tokenUrl: type: string + minLength: 1 username: type: string writeOnly: true @@ -34313,6 +37533,7 @@ components: properties: webhookUrl: type: string + minLength: 1 required: - id - kind @@ -34336,6 +37557,7 @@ components: type: string apiKey: type: string + minLength: 1 region: type: string enum: @@ -34359,6 +37581,7 @@ components: type: string description: If the granularity is set to `1` you can use the metric name eg. `latency.p95` to order by that value. + minLength: 1 collation: type: string description: Language code used for sorting. Ignored for infrastructure @@ -34381,6 +37604,7 @@ components: properties: serviceIntegrationKey: type: string + minLength: 1 required: - id - kind @@ -34438,9 +37662,11 @@ components: label: type: string description: Parameter label. + minLength: 1 name: type: string description: Parameter name. + minLength: 1 required: type: boolean description: Is parameter required or not. @@ -34451,6 +37677,7 @@ components: type: string description: Parameter type. Valid values are `static`, `dynamic`, or `vault`. Default value is `static` + minLength: 1 value: type: string description: Parameter value. @@ -34465,6 +37692,7 @@ components: name: type: string description: Parameter name. + minLength: 1 value: type: string description: Parameter value. @@ -34481,6 +37709,7 @@ components: type: string description: | Given `/api/{version}/users` URI, `PARAMETER` name is `version`. + minLength: 1 required: - name - type @@ -34541,6 +37770,7 @@ components: items: type: string description: A list of policy tags. + minLength: 1 trigger: $ref: '#/components/schemas/Trigger' typeConfigurations: @@ -34549,6 +37779,7 @@ components: run and the mode (automatic or manual) in which the policy is run. items: $ref: '#/components/schemas/TypeConfiguration' + minItems: 1 required: - id - name @@ -34562,6 +37793,7 @@ components: id: type: string description: Action identifier. + minLength: 1 runConfiguration: $ref: '#/components/schemas/RunConfiguration' type: @@ -34588,8 +37820,6 @@ components: format: date-time description: The time to run the policy action in milliseconds since epoch (UTC) (e.g., `1706713140000`). - required: - - startTime PostSnapshotsResult: type: object properties: @@ -34604,6 +37834,19 @@ components: items: type: string description: Snapshot ids for snapshots that could not be retrieved. + PrefixObject: + type: object + description: Shortcode prefix configuration + properties: + enabled: + type: boolean + description: Whether the shortcode prefix feature is enabled + example: true + prefix: + type: string + description: The prefix to use for event short codes (e.g., 'INSTANA-', + 'PROD-') + example: INSTANA- Problem: type: object properties: @@ -34634,6 +37877,7 @@ components: type: string webhookUrl: type: string + minLength: 1 required: - id - kind @@ -34647,6 +37891,7 @@ components: properties: rrule: type: string + minLength: 1 timezoneId: type: string required: @@ -34788,6 +38033,9 @@ components: type: string maxLength: 256 minLength: 0 + metricRollup: + type: integer + format: int32 required: - inputKind - inputName @@ -34915,6 +38163,7 @@ components: description: List of action configurations. items: $ref: '#/components/schemas/ActionConfiguration' + minItems: 1 required: - actions SLOConfigWithRBACTag: @@ -35026,8 +38275,10 @@ components: - CONTAINS - EQUALS - GREATER_THAN + - GREATER_THAN_OR_EQUALS - IS - LESS_THAN + - LESS_THAN_OR_EQUALS - MATCHES - NOT_MATCHES value: @@ -35046,10 +38297,13 @@ components: type: string clientId: type: string + minLength: 1 clientSecret: type: string + minLength: 1 salesforceUrl: type: string + minLength: 1 required: - clientId - clientSecret @@ -35134,9 +38388,11 @@ components: id: type: string description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.' + minLength: 1 label: type: string description: 'Name of the Service. Eg: `payment`.' + minLength: 1 snapshotIds: type: array description: A unique identifier the metrics are assigned to. @@ -35197,11 +38453,13 @@ components: id: type: string description: 'A unique string for the service configuration. Eg: `G510hmXYSDysLZ5kuj0BaQ`' + minLength: 1 label: type: string description: | It contains the tags defined in `matchSpecification` concatenated with a dash. Eg: if the `matchSpecification` contains keys `kubernetes.namespace.name` and `docker.label`, `label` would be `kubernetes.namespace.name-docker.label`. + minLength: 1 matchSpecification: type: array description: Calls will be matched with the array of key-value tags present @@ -35339,6 +38597,7 @@ components: type: string description: This is the list of channel IDs when alert triggered and sent to. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -35384,6 +38643,7 @@ components: items: type: string description: This is the list of SLO configurations related to this alert. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -35404,6 +38664,116 @@ components: - severity - sloIds - timeThreshold + ServiceLevelsAlertConfigWithRBACTag: + type: object + properties: + alertChannelIds: + type: array + description: This is the list of channel IDs when alert triggered and sent + to. + items: + type: string + description: This is the list of channel IDs when alert triggered and + sent to. + minLength: 1 + maxItems: 1024 + minItems: 0 + uniqueItems: true + burnRateConfig: + type: array + description: This is the burn rate alert configuration which defines alerting + windows and corresponding thresholds. This configuration must to specified + for BURN_RATE_V2 Alerts. + items: + $ref: '#/components/schemas/ServiceLevelsBurnRateConfig' + uniqueItems: true + burnRateTimeWindows: + $ref: '#/components/schemas/ServiceLevelsBurnRateTimeWindows' + created: + type: integer + format: int64 + description: Created Date of the version of Service Levels Smart Alerts + Configuration. + minimum: 1 + customPayloadFields: + type: array + description: This is the custom name and value pairs to be sent along with + the alert to the alert channels. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: The description of the alert. It is also the alert message + content. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + description: Boolean Parameter specifying the enabled state of Service Levels + Smart Alerts Configuration. + id: + type: string + description: Unique ID of the Service Levels Smart Alerts Configuration. + maxLength: 64 + minLength: 0 + initialCreated: + type: integer + format: int64 + description: Created Date of the Initial version of Service Levels Smart + Alerts Configuration. + minimum: 1 + name: + type: string + description: Name of the Service Levels Smart Alerts Configuration. + maxLength: 256 + minLength: 0 + rbacTags: + type: array + description: RBAC tags associated with the service levels + items: + $ref: '#/components/schemas/ApiTag' + uniqueItems: true + readOnly: + type: boolean + description: Boolean Parameter specifying the readonly access to Service + Levels Smart Alerts Configuration. + rule: + $ref: '#/components/schemas/ServiceLevelsAlertRule' + severity: + type: integer + format: int32 + description: 'This is the severity of the alert. The value can be: 5: + warning, 10: critical.' + sloIds: + type: array + description: This is the list of SLO configurations related to this alert. + items: + type: string + description: This is the list of SLO configurations related to this alert. + minLength: 1 + maxItems: 1024 + minItems: 0 + uniqueItems: true + threshold: + $ref: '#/components/schemas/StaticThreshold' + timeThreshold: + $ref: '#/components/schemas/ServiceLevelsTimeThreshold' + triggering: + type: boolean + description: Incident flag. If value is true, this alert will become an + accident. + required: + - alertChannelIds + - customPayloadFields + - description + - id + - name + - rule + - severity + - sloIds + - timeThreshold ServiceLevelsAlertRule: type: object description: This is the service levels alert type. It could be error budget @@ -35515,6 +38885,7 @@ components: type: string description: This is the list of channel IDs when alert triggered and sent to. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -35585,6 +38956,7 @@ components: items: type: string description: This is the list of SLO configurations related to this alert. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -35655,6 +39027,7 @@ components: description: | The service that initiates a request to another service. It contains a unique service id. Eg: `24558242fdeb52571cfb9fa42f1b334aa65d7e61`. + minLength: 1 latency: type: number format: double @@ -35670,6 +39043,7 @@ components: description: | The service that receives the request sent by the source service. It contains a unique service id. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + minLength: 1 required: - from - to @@ -35683,12 +39057,14 @@ components: description: | In Instana UI, this is shown as `Tag`. One can select a variety of pre-defined tags. Eg: `host.fqdn`, `container.label` etc. + minLength: 1 value: type: string description: | In Instana UI, this is known as 'key`. Eg: if one labels Docker containers such as com.acme.service-name:myservice, to map services from this label, the `key` aka `tag` would be `docker.label` and `value` aka `key` would be `com.acme.service-name`. + minLength: 1 required: - key - value @@ -35752,19 +39128,24 @@ components: type: boolean password: type: string + minLength: 1 resolutionOfIncident: type: boolean serviceNowUrl: type: string + minLength: 1 snowStatusOnCloseEvent: type: integer format: int32 tenant: type: string + minLength: 1 unit: type: string + minLength: 1 username: type: string + minLength: 1 required: - id - kind @@ -35784,10 +39165,13 @@ components: type: boolean password: type: string + minLength: 1 serviceNowUrl: type: string + minLength: 1 username: type: string + minLength: 1 required: - id - kind @@ -35836,6 +39220,7 @@ components: id: type: string description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.' + minLength: 1 name: type: string description: 'Name of the Service. Eg: `payment`.' @@ -35895,81 +39280,70 @@ components: minimum: 600000 SimpleMetricConfiguration: type: object - allOf: - - $ref: '#/components/schemas/InfraMetricConfiguration' - - type: object - properties: - aggregation: - type: string - enum: - - SUM - - MEAN - - MAX - - MIN - - P25 - - P50 - - P75 - - P90 - - P95 - - P98 - - P99 - - P99_9 - - P99_99 - - DISTINCT_COUNT - - SUM_POSITIVE - - PER_SECOND - - INCREASE - crossSeriesAggregation: - type: string - enum: - - SUM - - MEAN - - MAX - - MIN - - P25 - - P50 - - P75 - - P90 - - P95 - - P98 - - P99 - - P99_9 - - P99_99 - - DISTINCT_COUNT - - SUM_POSITIVE - - PER_SECOND - - INCREASE - granularity: - type: integer - format: int64 - description: |2 - * If granularity is not specified an aggregated value for the selected timeframe is returned. - * If granularity is specified data points are returned with the specified granularity - * The granularity should not be greater than the `windowSize` (important: `windowSize` is expressed in milliseconds) - * The granularity should not be set too small relative to the `windowSize` to avoid creating an excessively large number of data points (max 600) - title: granularity in milliseconds - metric: - type: string - missingValue: - type: number - format: double - regex: - type: boolean - required: - type: boolean - description: When true, metric must be present with values + properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + crossSeriesAggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + granularity: + type: integer + format: int64 + description: |2 + * If granularity is not specified an aggregated value for the selected timeframe is returned. + * If granularity is specified data points are returned with the specified granularity + * The granularity should not be greater than the `windowSize` (important: `windowSize` is expressed in milliseconds) + * The granularity should not be set too small relative to the `windowSize` to avoid creating an excessively large number of data points (max 600) + title: granularity in milliseconds + metric: + type: string + minLength: 1 + missingValue: + type: number + format: double + regex: + type: boolean + required: + type: boolean + description: When true, metric must be present with values required: - aggregation - metric - SingleValue: - type: object - allOf: - - $ref: '#/components/schemas/ArithmeticOperand' - - type: object - properties: - value: - type: number - format: double SlackIntegration: type: object allOf: @@ -35984,6 +39358,7 @@ components: type: string webhookUrl: type: string + minLength: 1 required: - id - kind @@ -36267,6 +39642,7 @@ components: type: string description: This is a snapshot ID. A unique identifier the metrics are assigned to. + minLength: 1 label: type: string description: Name of the entity. @@ -36315,8 +39691,10 @@ components: type: string name: type: string + minLength: 1 plugin: type: string + minLength: 1 softwareType: type: string enum: @@ -36331,6 +39709,7 @@ components: - API_GATEWAY - OTHER - APPLICATION_FRAMEWORK + minLength: 1 usedBy: type: array items: @@ -36338,8 +39717,10 @@ components: uniqueItems: true vendor: type: string + minLength: 1 version: type: string + minLength: 1 required: - discoveryType - name @@ -36369,6 +39750,7 @@ components: $ref: '#/components/schemas/SourceMapFileBlob' format: type: string + minLength: 1 meta: type: string size: @@ -36386,6 +39768,7 @@ components: - DWARF url: type: string + minLength: 1 required: - format - type @@ -36410,7 +39793,6 @@ components: type: string format: date-time required: - - id - metadata SourceMapUploadConfigs: type: object @@ -36483,6 +39865,7 @@ components: type: string description: The technical type of the span. For example, `node.http.client` or `jdbc`. + minLength: 1 parentId: type: string description: The parent call id, referring to another call in the same trace @@ -36538,6 +39921,8 @@ components: enum: - EQUALS - CONTAINS + - IN + - NOT_IN - LESS_THAN - LESS_OR_EQUAL_THAN - GREATER_THAN @@ -36566,8 +39951,10 @@ components: properties: token: type: string + minLength: 1 url: type: string + minLength: 1 required: - id - kind @@ -36598,6 +39985,7 @@ components: minimum: -1 file: type: string + minLength: 1 line: type: integer format: int32 @@ -36647,6 +40035,7 @@ components: value: type: string description: Custom value for static type custom payload + minLength: 1 required: - key - value @@ -36705,6 +40094,8 @@ components: enum: - EQUALS - CONTAINS + - IN + - NOT_IN - LESS_THAN - LESS_OR_EQUAL_THAN - GREATER_THAN @@ -36722,6 +40113,7 @@ components: - REGEX_MATCH value: type: string + minLength: 1 required: - metricName - operator @@ -36737,6 +40129,8 @@ components: enum: - EQUALS - CONTAINS + - IN + - NOT_IN - LESS_THAN - LESS_OR_EQUAL_THAN - GREATER_THAN @@ -36754,17 +40148,11 @@ components: - REGEX_MATCH value: type: string + minLength: 1 required: - metricName - operator - value - Subtraction: - type: object - allOf: - - $ref: '#/components/schemas/ArithmeticOperation' - required: - - left - - right SyntheticAlertConfig: type: object properties: @@ -36776,6 +40164,7 @@ components: type: string description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -36849,6 +40238,7 @@ components: type: string description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -36934,6 +40324,109 @@ components: - syntheticTestIds - tagFilterExpression - timeThreshold + SyntheticAlertConfigWithRBACTag: + type: object + properties: + alertChannelIds: + type: array + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + description: List of IDs of alert channels defined in Instana. Can be + left empty. + minLength: 1 + maxItems: 1024 + minItems: 0 + uniqueItems: true + created: + type: integer + format: int64 + description: Unix timestamp representing the creation time of this revision. + minimum: 1 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the synthetic alert configuration. Used as a + template for the description of alert/event notifications triggered by + this Smart Alert configuration. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + id: + type: string + description: 'ID of this Synthetic Alert Config. ' + maxLength: 64 + minLength: 0 + initialCreated: + type: integer + format: int64 + description: Unix timestamp representing the time of the initial revision. + minimum: 1 + name: + type: string + description: Name of the synthetic alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + rbacTags: + type: array + description: RBAC tags associated with the synthetic test + items: + $ref: '#/components/schemas/ApiTag' + uniqueItems: true + readOnly: + type: boolean + description: Flag to indicate whether or not the configuration is read-only. + Read-only access restricts modification of the config. + rule: + $ref: '#/components/schemas/SyntheticAlertRule' + severity: + type: integer + format: int32 + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + syntheticTestIds: + type: array + description: IDs of the synthetic tests that this Smart Alert configuration + is applied to. + items: + type: string + description: IDs of the synthetic tests that this Smart Alert configuration + is applied to. + uniqueItems: true + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + timeThreshold: + $ref: '#/components/schemas/SyntheticTimeThreshold' + required: + - alertChannelIds + - customPayloadFields + - description + - id + - name + - rule + - syntheticTestIds + - tagFilterExpression + - timeThreshold SyntheticAlertRule: type: object description: Indicates the type of rule this alert configuration is about. @@ -36966,6 +40459,7 @@ components: type: string metricName: type: string + minLength: 1 required: - alertType - metricName @@ -37307,6 +40801,7 @@ components: metric: type: string description: 'Set a particular metric, eg: `latency`.' + minLength: 1 required: - aggregation - metric @@ -37388,6 +40883,17 @@ components: type: array items: $ref: '#/components/schemas/DNSFilterTargetValue' + SyntheticResourceUpdateListICMPValidationListICMPValidation: + type: object + properties: + add: + type: array + items: + $ref: '#/components/schemas/ICMPValidation' + remove: + type: array + items: + $ref: '#/components/schemas/ICMPValidation' SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation: type: object properties: @@ -37437,8 +40943,6 @@ components: type: string description: 'List of Unique Synthetic Tests IDs ' uniqueItems: true - required: - - syntheticTestIds SyntheticTest: type: object properties: @@ -37688,6 +41192,8 @@ components: $ref: '#/components/schemas/SyntheticResourceUpdateListStringListString' modifiedBy: type: string + rbacTags: + $ref: '#/components/schemas/SyntheticResourceUpdateListStringListString' shallowUpdate: type: boolean syntheticUpdateType: @@ -37737,6 +41243,7 @@ components: DNS: '#/components/schemas/DNSConfiguration' HTTPAction: '#/components/schemas/HttpActionConfiguration' HTTPScript: '#/components/schemas/HttpScriptConfiguration' + ICMP: '#/components/schemas/ICMPConfiguration' NotConfigured: '#/components/schemas/EmptyConfiguration' SSLCertificate: '#/components/schemas/SSLCertificateConfiguration' WebpageAction: '#/components/schemas/WebpageActionConfiguration' @@ -37762,6 +41269,7 @@ components: - DNS - HTTPAction - HTTPScript + - ICMP - SSLCertificate - WebpageAction - WebpageScript @@ -37775,13 +41283,14 @@ components: type: object description: |- Synthetic test configuration that is unique to a synthetic type. Valid types are BrowserScript, - DNS, HTTPAction, HTTPScript, SSLCertificate, WebpageAction, and WebpageScript. + DNS, HTTPAction, HTTPScript, ICMP, SSLCertificate, WebpageAction, and WebpageScript. discriminator: mapping: BrowserScript: '#/components/schemas/BrowserScriptConfigurationUpdate' DNS: '#/components/schemas/DNSConfigurationUpdate' HTTPAction: '#/components/schemas/HttpActionConfigurationUpdate' HTTPScript: '#/components/schemas/HttpScriptConfigurationUpdate' + ICMP: '#/components/schemas/ICMPConfigurationUpdate' SSLCertificate: '#/components/schemas/SSLCertificateConfigurationUpdate' WebpageAction: '#/components/schemas/WebpageActionConfigurationUpdate' WebpageScript: '#/components/schemas/WebpageScriptConfigurationUpdate' @@ -37806,6 +41315,7 @@ components: - DNS - HTTPAction - HTTPScript + - ICMP - SSLCertificate - WebpageAction - WebpageScript @@ -37818,6 +41328,7 @@ components: - DNS - HTTPAction - HTTPScript + - ICMP - SSLCertificate - WebpageAction - WebpageScript @@ -37854,6 +41365,7 @@ components: properties: id: type: string + minLength: 1 name: type: string required: @@ -37929,6 +41441,7 @@ components: name: type: string description: 'The name of the tag. Eg: `call.name`' + minLength: 1 type: type: string description: 'The data type of the tag. Eg: `call.name` accepts `STRING` @@ -37948,6 +41461,12 @@ components: TagCatalog: type: object properties: + dynamicTags: + type: array + description: | + Structured dynamic tag prefixes with metadata + items: + $ref: '#/components/schemas/DynamicTag' tagTree: type: array description: | @@ -37955,6 +41474,7 @@ components: Consider this as the root of the tree where it has tags as attributes or children. items: $ref: '#/components/schemas/TagTreeLevel' + minItems: 1 tags: type: array description: | @@ -37962,6 +41482,7 @@ components: Consider these tags as attributes of a tagTree. Eg: `Call` tagTree has have `Erroneous`, `Call name`, `Latency` etc as attributes. items: $ref: '#/components/schemas/Tag' + minItems: 1 required: - tagTree - tags @@ -37994,6 +41515,8 @@ components: enum: - EQUALS - CONTAINS + - IN + - NOT_IN - LESS_THAN - LESS_OR_EQUAL_THAN - GREATER_THAN @@ -38064,6 +41587,7 @@ components: - SOURCE key: type: string + minLength: 1 operator: type: string enum: @@ -38100,6 +41624,7 @@ components: description: Children tags of tagTree items: $ref: '#/components/schemas/TagTreeNode' + minItems: 1 description: type: string description: The description provided, if any. @@ -38228,8 +41753,10 @@ components: type: string id: type: string + minLength: 1 label: type: string + minLength: 1 locationDisplayLabels: type: array items: @@ -38257,10 +41784,16 @@ components: modifiedAt: type: integer format: int64 + rbacTags: + type: array + items: + $ref: '#/components/schemas/ApiTag' + uniqueItems: true serviceId: type: string type: type: string + minLength: 1 websiteIds: type: array items: @@ -38276,6 +41809,30 @@ components: - id - label - type + TestConnectionResponse: + type: object + description: Response from a test connection request + properties: + connected: + type: boolean + description: Indicates whether the connection to the remote service was + established successfully + example: true + message: + type: string + description: A human-readable message describing the outcome of the connection + test + example: Connection successful + statusCode: + type: integer + format: int32 + description: The HTTP status code returned by the remote service during + the connection test + example: 200 + required: + - connected + - message + - statusCode TestLastError: type: object properties: @@ -38303,6 +41860,7 @@ components: properties: clientId: type: string + minLength: 1 customTags: type: object additionalProperties: @@ -38335,6 +41893,7 @@ components: $ref: '#/components/schemas/TestCommonProperties' testId: type: string + minLength: 1 testLastError: $ref: '#/components/schemas/TestLastError' testName: @@ -38352,10 +41911,8 @@ components: imageFiles: type: object additionalProperties: - type: array - items: - type: string - format: byte + type: string + format: byte logFiles: type: object additionalProperties: @@ -38375,10 +41932,8 @@ components: testResultId: type: string videos: - type: array - items: - type: string - format: byte + type: string + format: byte TestResultItem: type: object properties: @@ -38410,6 +41965,7 @@ components: type: string testId: type: string + minLength: 1 testName: type: string websiteIds: @@ -38468,6 +42024,7 @@ components: format: int64 testId: type: string + minLength: 1 testResultId: type: string required: @@ -38620,7 +42177,7 @@ components: - hour - day - week - - month + - calendar_month timezone: type: string description: Timezone string @@ -38661,9 +42218,11 @@ components: type: string description: The trace ID. All spans of the same trace must have the same trace ID. For example, `e93282c0d5018320`. + minLength: 1 label: type: string description: Name of the trace. + minLength: 1 service: $ref: '#/components/schemas/Service' startTime: @@ -38709,6 +42268,7 @@ components: type: string description: 'The call ID. A unique identifier for an individual call. For example: `1bcad5c82338deaf`.' + minLength: 1 isSynthetic: type: boolean writeOnly: true @@ -38743,6 +42303,13 @@ components: - NOT_FOUND - PERMISSION_DENIED - NO_ERROR + samplingFactor: + type: integer + format: int64 + description: Sampling factor represents the inverse of the sampling rate + and indicates how many actual calls are represented by a single sampled + call. For example, a sampling factor of 10 means that one sampled call + represents 10 actual calls. source: $ref: '#/components/schemas/SpanRelation' spans: @@ -38837,6 +42404,7 @@ components: name: type: string description: Name of the group. + minLength: 1 timestamp: type: integer format: int64 @@ -39061,10 +42629,13 @@ components: properties: email: type: string + minLength: 1 fullName: type: string + minLength: 1 id: type: string + minLength: 1 required: - email - fullName @@ -39122,16 +42693,23 @@ components: properties: email: type: string + minLength: 1 fullName: type: string + minLength: 1 groupCount: type: integer format: int64 id: type: string + minLength: 1 lastLoggedIn: type: integer format: int64 + teamNames: + type: array + items: + type: string tfaEnabled: type: boolean required: @@ -39244,9 +42822,10 @@ components: customPayloadFields: type: array description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + alert notifications. Supports both static and dynamic fields. Can be left + empty. items: - $ref: '#/components/schemas/StaticStringField' + $ref: '#/components/schemas/CustomPayloadField' maxItems: 20 minItems: 0 eventFilteringConfiguration: @@ -39266,6 +42845,7 @@ components: items: type: string description: List of Alert Channel IDs added in this Alert Configuration. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -39419,8 +42999,10 @@ components: properties: apiKey: type: string + minLength: 1 routingKey: type: string + minLength: 1 required: - apiKey - id @@ -39494,8 +43076,10 @@ components: type: array items: type: string + minLength: 1 webhookUrl: type: string + minLength: 1 required: - id - kind @@ -39509,6 +43093,7 @@ components: properties: webhookUrl: type: string + minLength: 1 required: - id - kind @@ -39524,6 +43109,7 @@ components: type: array items: type: string + minLength: 1 oauth: $ref: '#/components/schemas/OAuthIntegration' oauthEnabled: @@ -39534,6 +43120,8 @@ components: type: array items: type: string + minLength: 1 + minItems: 1 required: - id - kind @@ -39622,8 +43210,10 @@ components: type: string id: type: string + minLength: 1 name: type: string + minLength: 1 required: - id - name @@ -39640,6 +43230,7 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -39668,6 +43259,9 @@ components: Alert configuration. maxLength: 65536 minLength: 0 + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. gracePeriod: type: integer format: int64 @@ -39757,6 +43351,148 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + created: + type: integer + format: int64 + description: Unix timestamp representing the creation time of this revision. + minimum: 1 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the website alert configuration. Used as a template + for the description of alert/event notifications triggered by this Smart + Alert configuration. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + id: + type: string + description: 'ID of this Website Alert Config. ' + maxLength: 64 + minLength: 0 + initialCreated: + type: integer + format: int64 + description: Unix timestamp representing the time of the initial revision. + minimum: 1 + name: + type: string + description: Name of the website alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + readOnly: + type: boolean + description: Flag to indicate whether or not the configuration is read-only. + Read-only access restricts modification of the config. + rule: + $ref: '#/components/schemas/WebsiteAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdWebsiteAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/TagFilter' + uniqueItems: true + writeOnly: true + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/WebsiteTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + websiteId: + type: string + description: ID of the website that this Smart Alert configuration is applied + to. + maxLength: 64 + minLength: 0 + required: + - customPayloadFields + - description + - granularity + - id + - name + - tagFilterExpression + - timeThreshold + - websiteId + WebsiteAlertConfigWithRBACTag: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -39829,6 +43565,12 @@ components: configuration. maxLength: 256 minLength: 0 + rbacTags: + type: array + description: RBAC tags associated with the website + items: + $ref: '#/components/schemas/ApiTag' + uniqueItems: true readOnly: type: boolean description: Flag to indicate whether or not the configuration is read-only. @@ -39919,6 +43661,7 @@ components: type: string metricName: type: string + minLength: 1 required: - alertType - metricName @@ -39941,6 +43684,7 @@ components: entityId: type: string description: Website ID + minLength: 1 threshold: type: integer format: int32 @@ -39972,6 +43716,7 @@ components: type: number name: type: string + minLength: 1 required: - cursor - metrics @@ -40128,6 +43873,12 @@ components: description: ID of the website. WebsiteMetricResult: type: object + additionalProperties: + type: array + items: + type: array + items: + type: number properties: empty: type: boolean @@ -40155,9 +43906,9 @@ components: batchSize: type: integer format: int64 - minimum: 1 beaconId: type: string + minLength: 1 browserName: type: string browserVersion: @@ -40239,7 +43990,6 @@ components: duration: type: integer format: int64 - minimum: 0 encodedBodySize: type: integer format: int64 @@ -40247,7 +43997,6 @@ components: errorCount: type: integer format: int64 - minimum: 0 errorId: type: string errorMessage: @@ -40383,7 +44132,6 @@ components: stackTraceReadability: type: integer format: int32 - minimum: 0 subdivision: type: string subdivisionCode: @@ -40402,6 +44150,7 @@ components: minimum: -1 type: type: string + minLength: 1 unloadTime: type: integer format: int64 @@ -40428,8 +44177,10 @@ components: type: string websiteId: type: string + minLength: 1 websiteLabel: type: string + minLength: 1 windowHeight: type: integer format: int32 @@ -40442,9 +44193,6 @@ components: minimum: -1 required: - beaconId - - locationOrigin - - locationUrl - - pageLoadId - type - websiteId - websiteLabel @@ -40486,6 +44234,8 @@ components: type: array items: type: string + minLength: 1 + minItems: 1 uniqueItems: true defaultAggregation: type: string @@ -40532,14 +44282,17 @@ components: * `RATE`: Number of occurrences per second * `BYTE_RATE`: Number of bytes per second * `UNDEFINED`: Metric value unit is not known + minLength: 1 label: type: string description: The name of the metric. For example, `Call count`, `Erroneous calls`, `Service count` etc. + minLength: 1 metricId: type: string description: The unique id of the metric. For example, `calls`, `erroneousCalls`, `latency` etc. + minLength: 1 pathToValueInBeacon: type: array items: @@ -40587,6 +44340,7 @@ components: metric: type: string description: 'Set a particular metric, eg: `latency`.' + minLength: 1 required: - aggregation - metric @@ -40670,6 +44424,7 @@ components: type: string type: type: string + minLength: 1 width: type: integer format: int32 @@ -40688,7 +44443,7 @@ components: - config - id - type - WithMetadata: + WithMetaData: type: object properties: alertChannelIds: @@ -40701,6 +44456,7 @@ components: deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. + minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true @@ -40840,14 +44596,17 @@ components: properties: bearerAuthToken: type: string + minLength: 1 channels: type: array items: type: string + minLength: 1 maxItems: 1 minItems: 0 zchatOpsIncidentsUrl: type: string + minLength: 1 required: - bearerAuthToken - id @@ -40921,7 +44680,7 @@ x-tagGroups: - SLI Report - Apdex Settings - Apdex Report - - Service Levels Objective(SLO) Configurations + - SLO Configurations - Service Levels Objective(SLO) Report - Service Levels Alert Configuration - SLO Correction Configurations @@ -40943,6 +44702,7 @@ x-tagGroups: - Session Settings - Automation Settings - Authentication + - IP Filtering - name: Open Beta Features tags: - Infrastructure Analyze diff --git a/openapi.yaml.bak b/openapi.yaml.bak new file mode 100644 index 0000000..7011485 --- /dev/null +++ b/openapi.yaml.bak @@ -0,0 +1,40957 @@ +openapi: 3.0.1 +info: + contact: + email: support@instana.com + name: © Instana + url: http://instana.com + description: Documentation for INSTANA REST API + termsOfService: https://www.instana.com/terms-of-use/ + title: Instana REST API documentation + version: 1.309.1268 + x-description: info + x-ibm-ahub-try: true + x-logo: + altText: instana logo + backgroundColor: '#FAFBFC' + url: header-logo.svg +servers: +- description: Instana Backend + url: https://{unit}-{tenant}.instana.io + variables: + tenant: + default: tenant + description: Customer tenant unit + unit: + default: unit + description: Customer tenant name +- description: Instana Self-Hosted Backend + url: https://{domain} + variables: + domain: + default: example.com + description: Customer Self-Hosted domain +tags: +- name: Infrastructure Analyze + x-description: tagInfrastructureAnalyze +- name: Infrastructure Metrics + x-description: tagInfrastructureMetrics +- name: Infrastructure Resources + x-description: tagInfrastructureResources +- name: Infrastructure Catalog + x-description: tagInfrastructureCatalog +- name: Infrastructure Topology + x-description: tagInfrastructureTopology +- name: Logging Analyze + x-description: tagLoggingAnalyze +- name: Application Metrics + x-description: tagApplicationMetrics +- name: Application Catalog + x-description: tagApplicationCatalog +- name: Application Resources + x-description: tagApplicationResources +- name: Application Analyze + x-description: tagApplicationAnalyze +- name: Application Settings + x-description: tagApplicationSettings +- name: Application Topology + x-description: tagApplicationTopology +- name: Website Metrics + x-description: tagWebsiteMetrics +- name: Website Catalog + x-description: tagWebsiteCatalog +- name: Website Configuration + x-description: tagWebsiteConfiguration +- name: Website Analyze + x-description: tagWebsiteAnalyze +- name: Mobile App Metrics + x-description: tagMobileAppMetrics +- name: Mobile App Catalog + x-description: tagMobileAppCatalog +- name: Mobile App Configuration + x-description: tagMobileAppConfiguration +- name: Mobile App Analyze + x-description: tagMobileAppAnalyze +- name: Events + x-description: tagEvents +- name: Event Settings + x-description: tagEventSettings +- name: Application Alert Configuration + x-description: tagApplicationAlertConfiguration +- name: Global Application Alert Configuration + x-description: tagGlobalApplicationAlertConfiguration +- name: Infrastructure Alert Configuration + x-description: tagInfrastructureAlertConfiguration +- name: Synthetic Alert Configuration + x-description: tagSyntheticAlertConfiguration +- name: Host Agent + x-description: tagHostAgent +- name: User + x-description: tagUser +- name: Groups + x-description: tagGroups +- name: Teams + x-description: tagTeams +- name: Role + x-description: tagRoles +- name: Audit Log + x-description: tagAuditLog +- name: API Token + x-description: tagAPIToken +- name: Session Settings + x-description: sessionSettings +- name: Maintenance Configuration + x-description: tagMaintenanceConfiguration +- name: Synthetic Calls + x-description: tagSyntheticCalls +- name: Releases + x-description: tagReleases +- name: SLI Settings + x-description: tagSLISettings +- name: SLI Report + x-description: tagSLIReport +- name: Health + x-description: tagHealth +- name: Custom Dashboards + x-description: tagCustomDashboards +- name: Usage + x-description: tagUsage +- name: Synthetic Catalog + x-description: tagSyntheticCatalog +- name: Synthetic Metrics + x-description: tagSyntheticMetrics +- name: Synthetic Settings + x-description: tagSyntheticSettings +- name: Synthetic Test Playback Results + x-description: tagSyntheticResults +- name: Action Catalog + x-description: tagActionCatalog +- name: Action History + x-description: tagActionHistory +- name: Policies + x-description: tagAutomationPolicies +- name: Authentication + x-description: tagAuthentication +- name: Log Alert Configuration + x-description: tagLogAlertConfiguration +- name: End User Monitoring + x-description: endUserMonitoring +- name: AI Management + x-description: tagAiManagement +paths: + /api/apdex/report/{apdexId}: + get: + description: Generate Apdex Report for a specified Apdex ID. + operationId: getApdexReport + parameters: + - description: Apdex Configuration ID + example: nCtEoR6NSPqG61QkIkwwCw + in: path + name: apdexId + required: true + schema: + type: string + - description: Starting point for the data retrieval, specified as 13 digit + Unix Timestamp milliseconds + example: 1706713140000 + in: query + name: from + required: true + schema: + type: integer + format: int64 + - description: Ending point for the data retrieval, specified as 13 digit Unix + Timestamp milliseconds + example: 1706813100000 + in: query + name: to + required: true + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + apdexId: nCtEoR6NSPqG61QkIkwwCw + from: 1706713140000 + to: 1706813100000 + apdexScore: + - - 1706713140000 + - 0.5 + - - 1706779500000 + - 0.5 + schema: + type: array + items: + $ref: '#/components/schemas/ApdexReport' + description: OK + '404': + content: + application/json: + example: + errors: + - There is no Apdex configuration for the given ID. + schema: + type: array + items: + type: string + description: No Apdex configuration for the given ID + security: + - ApiKeyAuth: + - Default + summary: Generate Apdex report + tags: + - Apdex Report + x-ibm-ahub-byok: true + /api/application-monitoring/analyze/backend-correlation: + get: + description: |- + Resolves backend trace IDs using correlation IDs from website and mobile app monitoring beacons. + For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze. + operationId: getCorrelatedTraces + parameters: + - description: | + Here, the `backendTraceId` is typically used which can be obtained from the `Get all beacons` API endpoint for website and mobile app monitoring. + For XHR, fetch, or HTTP beacons, the `beaconId` retrieved from the same API endpoint can also serve as the `correlationId`. + example: 0v7f55879ca12345 + in: query + name: correlationId + required: true + schema: + type: string + maxLength: 128 + minLength: 0 + responses: + '200': + content: + application/json: + example: + - traceId: c606ccf3578135c6 + schema: + type: array + items: + $ref: '#/components/schemas/BackendTraceReference' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Resolve Trace IDs from Monitoring Beacons. + tags: + - Application Analyze + x-ibm-ahub-byok: true + /api/application-monitoring/analyze/call-groups: + post: + description: |2- + + For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze. + operationId: getCallGroup + parameters: + - description: If enabled, fill the missing data points in the metric result + with timestamp and value 0. + in: query + name: fillTimeSeries + schema: + type: boolean + requestBody: + content: + application/json: + example: + group: + groupbyTag: service.name + groupbyTagEntity: DESTINATION + metrics: + - aggregation: SUM + metric: calls + - aggregation: P75 + metric: latency + granularity: 360 + includeInternal: false + includeSynthetic: false + order: + by: calls + direction: DESC + pagination: + retrievalSize: 20 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: call.type + operator: EQUALS + entity: NOT_APPLICABLE + value: DATABASE + - type: TAG_FILTER + name: service.name + operator: EQUALS + entity: DESTINATION + value: ratings + timeFrame: + to: '1688366990000' + windowSize: '600000' + schema: + $ref: '#/components/schemas/GetCallGroups' + x-payload: getCallGroup + responses: + '200': + content: + application/json: + example: + items: + - name: ratings + timestamp: 1688366520000 + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1688980829000 + offset: 1 + metrics: + latency.p75.360: + - - 1688366520000 + - 1.0 + canLoadMore: false + totalHits: 1 + totalRepresentedItemCount: 1 + totalRetainedItemCount: 1 + adjustedTimeframe: + windowSize: 360000 + to: 1688366880000 + schema: + $ref: '#/components/schemas/CallGroupsResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get grouped call metrics + tags: + - Application Analyze + x-description: getCallGroup + x-ibm-ahub-byok: true + /api/application-monitoring/analyze/trace-groups: + post: + description: "In this endpoint, the supported `groupbyTag` are `trace.endpoint.name`\ + \ and `trace.service.name`. \nFor more information on Application Analyze\ + \ please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze." + operationId: getTraceGroups + parameters: + - description: If enabled, fill the missing data points in the metric result + with timestamp and value 0. + in: query + name: fillTimeSeries + schema: + type: boolean + requestBody: + content: + application/json: + example: + group: + groupbyTag: trace.endpoint.name + groupbyTagEntity: NOT_APPLICABLE + metrics: + - aggregation: SUM + metric: latency + order: + by: latency + direction: ASC + pagination: + retrievalSize: 20 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: call.type + operator: EQUALS + entity: NOT_APPLICABLE + value: DATABASE + - type: TAG_FILTER + name: service.name + operator: EQUALS + entity: DESTINATION + value: ratings + schema: + $ref: '#/components/schemas/GetTraceGroups' + x-payload: getTraceGroups + responses: + '200': + content: + application/json: + example: + items: + - name: GET /api/cart-total + timestamp: 1688542673148 + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1688543264000 + offset: 1 + metrics: + latency.sum: + - - 1688543260000 + - 31.0 + canLoadMore: true + totalHits: 2595 + totalRepresentedItemCount: 2595 + totalRetainedItemCount: 2595 + adjustedTimeframe: + windowSize: 600000 + to: 1687939110000 + schema: + $ref: '#/components/schemas/TraceGroupsResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get grouped trace metrics + tags: + - Application Analyze + x-description: getTraceGroups + x-ibm-ahub-byok: true + /api/application-monitoring/analyze/traces: + post: + description: |2- + + For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze. + operationId: getTraces + requestBody: + content: + application/json: + examples: + analyze/traces: + description: analyze/traces + value: + includeInternal: false + includeSynthetic: false + pagination: + retrievalSize: 1 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: endpoint.name + operator: EQUALS + entity: DESTINATION + value: GET / + - type: TAG_FILTER + name: service.name + operator: EQUALS + entity: DESTINATION + value: groundskeeper + order: + by: traceLabel + direction: DESC + schema: + $ref: '#/components/schemas/GetTraces' + x-payload: getTraces + responses: + '200': + content: + application/json: + example: + items: + - trace: + id: 506aef767d8ec147 + label: sdk.reloading-config-cache + startTime: 1725601763937 + duration: 0 + erroneous: false + service: + id: 84b5041665ce4ed6f60b47d1fd96c12d4132c9ed + label: appdata-processor + types: [ + ] + technologies: [ + ] + snapshotIds: [ + ] + entityType: SERVICE + endpoint: null + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1725601787000 + offset: 1 + canLoadMore: true + totalHits: 154 + totalRepresentedItemCount: 154 + totalRetainedItemCount: 154 + adjustedTimeframe: + windowSize: 600000 + to: 1725601780000 + schema: + $ref: '#/components/schemas/TraceResult' + description: OK + x-example: TraceResult + security: + - ApiKeyAuth: + - Default + summary: Get all traces + tags: + - Application Analyze + x-description: getTraces + x-ibm-ahub-byok: true + /api/application-monitoring/applications: + get: + description: |- + Use this API endpoint if one wants to retrieve a list of Application Perspectives. + A use case could be to view the application id of an Application Perspective. + + For more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources. + operationId: getApplications + parameters: + - description: Name of application + in: query + name: nameFilter + schema: + type: string + - description: Size of time window in milliseconds + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: Timestamp since Unix Epoch in milliseconds of the end of the + time window + in: query + name: to + schema: + type: integer + format: int64 + - description: Page number from results + in: query + name: page + schema: + type: integer + format: int32 + - description: Number of items per page + in: query + name: pageSize + schema: + type: integer + format: int32 + - description: 'Filter for application scope, i.e: INBOUND or ALL' + in: query + name: applicationBoundaryScope + schema: + type: string + enum: + - ALL + - INBOUND + responses: + '200': + content: + application/json: + example: + items: + - boundaryScope: INBOUND + entityType: APPLICATION + id: e8krH1wNRV6daAo-NEmG8g + label: Robot Shop + page: 1 + pageSize: 1 + totalHits: 1 + schema: + $ref: '#/components/schemas/ApplicationResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get applications + tags: + - Application Resources + x-ibm-ahub-byok: true + /api/application-monitoring/applications;id=/services: + get: + description: |- + Use this API endpoint if one wants to retrieve a list of services in an Application Perspective. + A use case could be to retrieve all service ids present in an Application Perspective. + + For more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources. + operationId: getApplicationServices + parameters: + - description: Name of service (partial match allowed) + in: query + name: nameFilter + schema: + type: string + - description: Size of time window in milliseconds + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: Timestamp since Unix Epoch in milliseconds of the end of the + time window + in: query + name: to + schema: + type: integer + format: int64 + - description: Page number from results + in: query + name: page + schema: + type: integer + format: int32 + - description: Number of items per page + in: query + name: pageSize + schema: + type: integer + format: int32 + - description: 'Filter for application scope, i.e: INBOUND or ALL' + in: query + name: applicationBoundaryScope + schema: + type: string + enum: + - ALL + - INBOUND + - description: Include snapshot ids in the results + in: query + name: includeSnapshotIds + schema: + type: boolean + responses: + '200': + content: + application/json: + example: + items: + - entityType: SERVICE + id: 79f1430f4a42a707a97621ca00617e40bd51c31d + label: www.paypal.com + snapshotIds: + - CywiRxmGIwtQIKezVs-XMcTX2xg + technologies: + - kafkaCluster + types: + - MESSAGING + page: 1 + pageSize: 1 + totalHits: 1 + schema: + $ref: '#/components/schemas/ServiceResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get applications/services + tags: + - Application Resources + x-ibm-ahub-byok: true + /api/application-monitoring/applications/services/endpoints: + get: + description: |- + Use this API endpoint if one wants to retrieve a list of Endpoints. + A use case could be to view the endpoint id of an Endpoint. + + For more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources. + operationId: getApplicationEndpoints + parameters: + - description: Name of service + in: query + name: nameFilter + schema: + type: string + - description: Type of Endpoint + in: query + name: types + schema: + type: array + items: + type: string + uniqueItems: true + - description: List of technologies + in: query + name: technologies + schema: + type: array + items: + type: string + uniqueItems: true + - description: Size of time window in milliseconds + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: Timestamp since Unix Epoch in milliseconds of the end of the + time window + in: query + name: to + schema: + type: integer + format: int64 + - description: Page number from results + in: query + name: page + schema: + type: integer + format: int32 + - description: Number of items per page + in: query + name: pageSize + schema: + type: integer + format: int32 + - description: 'Filter for application scope, i.e: INBOUND or ALL' + in: query + name: applicationBoundaryScope + schema: + type: string + enum: + - ALL + - INBOUND + responses: + '200': + content: + application/json: + example: + items: + - entityType: ENDPOINT + id: IWeMKSzcvJHijAQoaA-luyHriDQ + label: websites + serviceId: a25c02069636022456e6139ebfe4f4bfec23ae31 + synthetic: false + syntheticType: NON_SYNTHETIC + technologies: + - postgreSqlDatabase + type: DATABASE + page: 1 + pageSize: 1 + totalHits: 1 + schema: + $ref: '#/components/schemas/EndpointResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get endpoints + tags: + - Application Resources + x-ibm-ahub-byok: true + /api/application-monitoring/catalog: + get: + description: |2- + + For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog. + operationId: getApplicationTagCatalog + parameters: + - description: | + The start of the timestamp expreseed in Unix epoch time in milliseconds which will fetch list of queryable tags until current timestamp. + Eg: `1719875833000` (1 July 2024 23:17:13 GMT) will fetch list of queryable tags from that time till current time. + in: query + name: from + schema: + type: integer + format: int64 + - description: The source from where queryable tags should be fetched from. + In Unbounded Analytics, Application Perspectives has 2 sources; `Calls` + and `Traces`. + in: query + name: dataSource + schema: + type: string + enum: + - CALLS + - TRACES + - description: | + The subset of queryable tags that is available for a particular use case. + For eg: If you select `dataSource` as `TRACES` and useCase as `Grouping`. The tags available for querying are `trace.endpoint.name` and `trace.service.name`. + useCase is helpful when one wants to know which tags are supported for querying. + in: query + name: useCase + schema: + type: string + enum: + - GROUPING + - FILTERING + - SERVICE_MAPPING + - SMART_ALERTS + - SMART_ALERTS_LOGS + - SMART_ALERTS_ADAPTIVE_BASELINE + - SMART_ALERTS_CUSTOM_PAYLOAD + - SLI_MANAGEMENT + - APPLICATION_CONFIG + - APPLICATION_CONFIG_BLUEPRINT + - MAINTENANCE_WINDOWS + - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + responses: + '200': + content: + application/json: + example: + tagTree: + - label: Agent + description: null + icon: null + children: + - label: Zone + icon: lib_views_tag + tagName: agent.zone + queryable: true + type: TAG + type: LEVEL + queryable: false + tags: + - name: marathon.label + label: Label + type: KEY_VALUE_PAIR + description: marathon label + canApplyToSource: true + canApplyToDestination: true + idTag: false + schema: + $ref: '#/components/schemas/TagCatalog' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get application tag catalog + tags: + - Application Catalog + x-description: getApplicationTagsCatalog + x-ibm-ahub-byok: true + /api/application-monitoring/catalog/metrics: + get: + description: |2- + + For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog. + operationId: getApplicationCatalogMetrics + responses: + '200': + content: + application/json: + example: + - metricId: calls + label: Call count + formatter: NUMBER + description: Number of received calls + aggregations: + - PER_SECOND + - SUM + defaultAggregation: null + schema: + type: array + items: + $ref: '#/components/schemas/MetricDescription' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get Metric catalog + tags: + - Application Catalog + x-description: getApplicationCatalogMetrics + x-ibm-ahub-byok: true + /api/application-monitoring/catalog/tags: + get: + deprecated: true + description: |2- + + For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog. + operationId: getApplicationTags + parameters: + - description: | + The start of the timestamp expreseed in Unix epoch time in milliseconds which will fetch list of queryable tags until current timestamp. + Eg: `1719875833000` (1 July 2024 23:17:13 GMT) will fetch list of queryable tags from that time till current time. + in: query + name: from + schema: + type: integer + format: int64 + - description: The source from where queryable tags should be fetched from. + In Unbounded Analytics, Application Perspectives has 2 sources; `Calls` + and `Traces`. + in: query + name: dataSource + schema: + type: string + enum: + - CALLS + - TRACES + - description: | + The subset of queryable tags that is available for a particular use case. + For eg: If you select `dataSource` as `TRACES` and useCase as `Grouping`. The tags available for querying are `trace.endpoint.name` and `trace.service.name`. + useCase is helpful when one wants to know which tags are supported for querying. + in: query + name: useCase + schema: + type: string + enum: + - GROUPING + - FILTERING + - SERVICE_MAPPING + - SMART_ALERTS + - SMART_ALERTS_LOGS + - SMART_ALERTS_ADAPTIVE_BASELINE + - SMART_ALERTS_CUSTOM_PAYLOAD + - SLI_MANAGEMENT + - APPLICATION_CONFIG + - APPLICATION_CONFIG_BLUEPRINT + - MAINTENANCE_WINDOWS + - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get application tags + tags: + - Application Catalog + x-description: getApplicationCatalogTags + x-ibm-ahub-byok: true + /api/application-monitoring/metrics/applications: + post: + description: |- + Use this API endpoint if one wants to retrieve one or more supported aggregation of supported metrics for an Application Perspective. + For eg: retrieve `MEAN` aggregation of `latency` metric for an Application Perspective `app`. + For more information on supported metrics, refer `Get Metric catalog`. + + For more information on Application Metrics please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-metrics. + operationId: getApplicationMetrics + parameters: + - description: If enabled, fill the missing data points in the metric result + with timestamp and value 0. + in: query + name: fillTimeSeries + schema: + type: boolean + requestBody: + content: + application/json: + examples: + metrics/applications: + description: | + Attribute in "order by" should + be provided in "metrics" as well + value: + metrics: + - aggregation: MEAN + metric: latency + order: + by: latency.mean + direction: DESC + pagination: + page: 1 + pageSize: 1 + timeFrame: + to: 1646037122400 + windowSize: 3600000 + schema: + $ref: '#/components/schemas/GetApplications' + x-payload: getApplicationMetrics + responses: + '200': + content: + application/json: + example: + items: + - application: + id: Jv83WpUmSKiiCWIpi-reSQ + label: demoApp + boundaryScope: ALL + entityType: APPLICATION + metrics: + latency.mean: + - - 1669190580000 + - 4.0 + page: 1 + pageSize: 1 + totalHits: 1616 + adjustedTimeframe: + windowSize: 3600000 + to: 1646037120000 + schema: + $ref: '#/components/schemas/ApplicationMetricResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get Application Metrics + tags: + - Application Metrics + x-ibm-ahub-byok: true + /api/application-monitoring/metrics/endpoints: + post: + description: |- + Use this API endpoint if one wants to retrieve one or more supported aggregation of supported metrics for an Endpoint. + For eg: retrieve `MEAN` aggregation of `latency` metric for an Endpoint `GET /api/foo`. + For more information on supported metrics, refer `Get Metric catalog`. + + For more information on Application Metrics please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-metrics. + operationId: getEndpointsMetrics + parameters: + - description: If enabled, fill the missing data points in the metric result + with timestamp and value 0. + in: query + name: fillTimeSeries + schema: + type: boolean + requestBody: + content: + application/json: + examples: + metrics/endpoints: + description: | + Order by is supported for following attributes: endpointLabel or valid metrics if provided such as latency.mean + value: + applicationBoundaryScope: ALL + endpointId: murzTwzJlGyqc_CFtEKx8INVCfY + excludeSynthetic: true + metrics: + - aggregation: MEAN + metric: latency + order: + by: latency.mean + direction: ASC + pagination: + page: 1 + pageSize: 1 + timeFrame: + to: 1669190589000 + windowSize: 3600000 + schema: + $ref: '#/components/schemas/GetEndpoints' + x-payload: getEndpoints + responses: + '200': + content: + application/json: + example: + items: + - endpoint: + id: murzTwzJlGyqc_CFtEKx8INVCfY + label: robot-shop + type: MESSAGING + serviceId: 05b145cfb6fbc24d08a8e01155c0aa2bf8460c87 + technologies: + - golangRuntimePlatform + - kubernetesService + syntheticType: NON_SYNTHETIC + synthetic: false + entityType: ENDPOINT + metrics: + latency.mean: + - - 1669190580000 + - 2434.5625 + page: 1 + pageSize: 1 + totalHits: 1 + adjustedTimeframe: + windowSize: 3600000 + to: 1669190580000 + schema: + $ref: '#/components/schemas/EndpointMetricResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get Endpoint metrics + tags: + - Application Metrics + x-ibm-ahub-byok: true + /api/application-monitoring/metrics/services: + post: + description: |- + Use this API endpoint if one wants to retrieve one or more supported aggregation of supported metrics for a Service. + For eg: retrieve `MEAN` aggregation of `latency` metric for a Service `payment`. + For more information on supported metrics, refer `Get Metric catalog`. + + For more information on Application Metrics please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-metrics. + operationId: getServicesMetrics + parameters: + - description: If enabled, fill the missing data points in the metric result + with timestamp and value 0. + in: query + name: fillTimeSeries + schema: + type: boolean + - in: query + name: includeSnapshotIds + schema: + type: boolean + requestBody: + content: + application/json: + examples: + metrics/services: + description: | + Order by is supported for following attributes: types, technologies, serviceLabel and + valid metrics if provided such as latency.mean + value: + applicationBoundaryScope: ALL + contextScope: NONE + metrics: + - aggregation: mean + metric: latency + order: + by: latency.mean + direction: DESC + pagination: + page: 1 + pageSize: 1 + serviceId: c467ca0fa21477fee3cde75a140b2963307388a7 + technologies: + - springbootApplicationContainer + timeFrame: + to: 1669190589000 + windowSize: 3600000 + schema: + $ref: '#/components/schemas/GetServices' + x-payload: getServices + responses: + '200': + content: + application/json: + example: + items: + - service: + id: c467ca0fa21477fee3cde75a140b2963307388a7 + label: discount + types: + - HTTP + technologies: + - springbootApplicationContainer + snapshotIds: [ + ] + entityType: SERVICE + metrics: + endpoints.distinct_count: + - - 1669190580000 + - 4.0 + page: 1 + pageSize: 1 + totalHits: 1 + adjustedTimeframe: + windowSize: 3600000 + to: 1669190580000 + schema: + $ref: '#/components/schemas/ServiceMetricResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get Service metrics + tags: + - Application Metrics + x-ibm-ahub-byok: true + /api/application-monitoring/services: + get: + description: |- + Use this API endpoint if one wants to retrieve a list of Services. + A use case could be to view the service id of a Service. + + For more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources. + operationId: getServices + parameters: + - description: Name of service + in: query + name: nameFilter + schema: + type: string + - description: Size of time window in milliseconds + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: Timestamp since Unix Epoch in milliseconds of the end of the + time window + in: query + name: to + schema: + type: integer + format: int64 + - description: Page number from results + in: query + name: page + schema: + type: integer + format: int32 + - description: Number of items per page + in: query + name: pageSize + schema: + type: integer + format: int32 + - description: Include snapshot ids in the results + in: query + name: includeSnapshotIds + schema: + type: boolean + responses: + '200': + content: + application/json: + example: + items: + - entityType: SERVICE + id: 79f1430f4a42a707a97621ca00617e40bd51c31d + label: Robot Shop + snapshotIds: + - CywiRxmGIwtQIKezVs-XMcTX2xg + technologies: + - kafkaCluster + types: + - MESSAGING + page: 1 + pageSize: 1 + totalHits: 1 + schema: + $ref: '#/components/schemas/ServiceResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get services + tags: + - Application Resources + x-ibm-ahub-byok: true + /api/application-monitoring/settings/application: + get: + description: |- + Use this API endpoint if one wants to retrieve a list of all Application Perspectives with their configuration settings. + This endpoint requires `canConfigureApplications` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureApplications` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Configuration of applications` to `true`. + + ## Deprecated Parameters + **matchSpecification:** A binary tree sturcture of match expression connected with binary operator AND or OR. It is replaced by **tagFilterExpression** which is also used in Application Analyze API endpoints. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: getApplicationConfigs + responses: + '200': + content: + application/json: + example: + - id: CxJ55sRbQwqBIfw5DzpRmQ + label: Discount Canary Build 6987 + matchSpecification: null + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: kubernetes.label + stringValue: stage=canary + numberValue: null + booleanValue: null + key: stage + value: canary + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: build=6987 + numberValue: null + booleanValue: null + key: build + value: '6987' + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: app=discount + numberValue: null + booleanValue: null + key: app + value: discount + operator: EQUALS + entity: DESTINATION + scope: INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING + boundaryScope: INBOUND + accessRules: + - accessType: READ_WRITE + relationType: GLOBAL + relatedId: null + schema: + type: array + items: + $ref: '#/components/schemas/ApplicationConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: All Application configurations + tags: + - Application Settings + x-ibm-ahub-byok: true + post: + description: |2- + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: addApplicationConfig + requestBody: + content: + application/json: + example: + accessRules: + - accessType: READ_WRITE + relationType: GLOBAL + relatedId: null + boundaryScope: INBOUND + label: Discount Build 6987 + scope: INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: kubernetes.label + stringValue: stage=canary + numberValue: null + booleanValue: null + key: stage + value: canary + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: build=6987 + numberValue: null + booleanValue: null + key: build + value: '6987' + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: app=discount + numberValue: null + booleanValue: null + key: app + value: discount + operator: EQUALS + entity: DESTINATION + schema: + $ref: '#/components/schemas/NewApplicationConfig' + required: true + x-payload: addApplicationConfig + responses: + '200': + content: + application/json: + example: + id: oLyuFtIfQ3eKzAqM5vBGkQ + label: Discount Build 6987 + matchSpecification: null + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: kubernetes.label + stringValue: stage=canary + numberValue: null + booleanValue: null + key: stage + value: canary + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: build=6987 + numberValue: null + booleanValue: null + key: build + value: '6987' + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: app=discount + numberValue: null + booleanValue: null + key: app + value: discount + operator: EQUALS + entity: DESTINATION + scope: INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING + boundaryScope: INBOUND + accessRules: + - accessType: READ_WRITE + relationType: GLOBAL + relatedId: null + schema: + $ref: '#/components/schemas/ApplicationConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Add application configuration + tags: + - Application Settings + x-description: addApplicationConfig + x-ibm-ahub-byok: true + /api/application-monitoring/settings/application/{id}: + delete: + description: |- + Use this API endpoint if one wants to delete an Application Perspective. This endpoint requires `canConfigureApplications` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureApplications` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + + ## Deprecated Parameters + **matchSpecification:** A binary tree structure of match expression connected with binary operator AND or OR. It is replaced by **tagFilterExpression** which is also used in Application Analyze API endpoints. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: deleteApplicationConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.' + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Delete application configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + get: + description: |- + Use this API endpoint if one wants to retrieve an Application Perspective with its configuration setting. + This endpoint requires `canConfigureApplications` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureApplications` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Configuration of applications` to `true`. + + ## Deprecated Parameters + **matchSpecification:** A binary tree structure of match expression connected with binary operator AND or OR. It is replaced by **tagFilterExpression** which is also used in Application Analyze API endpoints. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: getApplicationConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.' + responses: + '200': + content: + application/json: + example: + id: CxJ55sRbQwqBIfw5DzpRmQ + label: Discount Canary Build 6987 + matchSpecification: null + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: kubernetes.label + stringValue: stage=canary + numberValue: null + booleanValue: null + key: stage + value: canary + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: build=6987 + numberValue: null + booleanValue: null + key: build + value: '6987' + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: app=discount + numberValue: null + booleanValue: null + key: app + value: discount + operator: EQUALS + entity: DESTINATION + scope: INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING + boundaryScope: INBOUND + accessRules: + - accessType: READ_WRITE + relationType: GLOBAL + relatedId: null + schema: + $ref: '#/components/schemas/ApplicationConfig' + description: OK + '403': + description: Insufficient permission + '404': + description: No config found for provided application id + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Application configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + put: + description: |2- + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: putApplicationConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.' + requestBody: + content: + application/json: + example: + accessRules: + - accessType: READ + relationType: ROLE + boundaryScope: INBOUND + id: CxJ55sRbQwqBIfw5DzpRmQ + label: Discount Build 1 + scope: INCLUDE_NO_DOWNSTREAM + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: kubernetes.label + stringValue: stage=canary + numberValue: null + booleanValue: null + key: stage + value: canary + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: build=6987 + numberValue: null + booleanValue: null + key: build + value: '6987' + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: app=discount + numberValue: null + booleanValue: null + key: app + value: discount + operator: EQUALS + entity: DESTINATION + schema: + $ref: '#/components/schemas/ApplicationConfig' + required: true + x-payload: putApplicationConfig + responses: + '200': + content: + application/json: + example: + id: CxJ55sRbQwqBIfw5DzpRmQ + label: Discount Canary Build 6987 + matchSpecification: null + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: kubernetes.label + stringValue: stage=canary + numberValue: null + booleanValue: null + key: stage + value: canary + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: build=6987 + numberValue: null + booleanValue: null + key: build + value: '6987' + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: kubernetes.label + stringValue: app=discount + numberValue: null + booleanValue: null + key: app + value: discount + operator: EQUALS + entity: DESTINATION + scope: INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING + boundaryScope: INBOUND + accessRules: + - accessType: READ_WRITE + relationType: GLOBAL + relatedId: null + schema: + $ref: '#/components/schemas/ApplicationConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Update application configuration + tags: + - Application Settings + x-description: updateApplicationConfig + x-ibm-ahub-byok: true + /api/application-monitoring/settings/endpoint: + get: + description: |- + Use this API endpoint if one wants to retrieve a list of all endpoint configurations. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: getEndpointConfigs + responses: + '200': + content: + application/json: + example: + - serviceId: d0cedae516f2182ede16f57f67476dd4c7dab9cd + endpointCase: LOWER + endpointNameByFirstPathSegmentRuleEnabled: false + endpointNameByCollectedPathTemplateRuleEnabled: false + rules: null + - serviceId: d0cedae516f2182ede16f57f67476dd4c7dab9cd + endpointCase: UPPER + endpointNameByFirstPathSegmentRuleEnabled: false + endpointNameByCollectedPathTemplateRuleEnabled: false + rules: null + schema: + type: array + items: + $ref: '#/components/schemas/EndpointConfig' + description: OK + security: + - ApiKeyAuth: + - CanConfigureServiceMapping + summary: All Endpoint configurations + tags: + - Application Settings + x-ibm-ahub-byok: true + post: + description: |- + Use this API endpoint if one wants to create an endpoint configuration of a service. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: createEndpointConfig + requestBody: + content: + application/json: + example: + serviceId: d0cedae516f2182ede16f57f67476dd4c7dab9cd + endpointCase: LOWER + endpointNameByFirstPathSegmentRuleEnabled: false + endpointNameByCollectedPathTemplateRuleEnabled: false + rules: null + schema: + $ref: '#/components/schemas/EndpointConfig' + required: true + x-payload: createEndpointConfig + responses: + '200': + content: + application/json: + example: + serviceId: d0cedae516f2182ede16f57f67476dd4c7dab9cd + endpointCase: LOWER + endpointNameByFirstPathSegmentRuleEnabled: false + endpointNameByCollectedPathTemplateRuleEnabled: false + rules: null + schema: + $ref: '#/components/schemas/EndpointConfig' + description: OK + security: + - ApiKeyAuth: + - CanConfigureServiceMapping + summary: Create endpoint configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + /api/application-monitoring/settings/endpoint/{id}: + delete: + description: |- + Use this API endpoint if one wants to delete an endpoint configuration of a service. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: deleteEndpointConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: | + An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureServiceMapping + summary: Delete endpoint configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + get: + description: |- + Use this API endpoint if one wants to retrieve the endpoint configuration of a service. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: getEndpointConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: | + An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + responses: + '200': + content: + application/json: + example: + serviceId: d0cedae516f2182ede16f57f67476dd4c7dab9cd + endpointCase: LOWER + endpointNameByFirstPathSegmentRuleEnabled: false + endpointNameByCollectedPathTemplateRuleEnabled: false + rules: null + schema: + $ref: '#/components/schemas/EndpointConfig' + description: OK + '403': + description: Insufficient permission + '404': + description: No config found for provided service id + security: + - ApiKeyAuth: + - CanConfigureServiceMapping + summary: Endpoint configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + put: + description: |- + Use this API endpoint if one wants to update an existing endpoint configuration of a service. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: updateEndpointConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: | + An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + requestBody: + content: + application/json: + example: + serviceId: 20ba31821b079e7d845a08096124880db3eeeb40 + endpointNameByCollectedPathTemplateRuleEnabled: true + endpointNameByFirstPathSegmentRuleEnabled: true + rules: + - enabled: true + pathSegments: + - name: api + type: FIXED + - name: version + type: PARAMETER + testCases: + - /api/v2/users + endpointCase: UPPER + schema: + $ref: '#/components/schemas/EndpointConfig' + required: true + x-payload: updateEndpointConfig + responses: + '200': + content: + application/json: + example: + serviceId: 20ba31821b079e7d845a08096124880db3eeeb40 + endpointNameByCollectedPathTemplateRuleEnabled: true + endpointNameByFirstPathSegmentRuleEnabled: true + rules: + - enabled: true + pathSegments: + - name: api + type: FIXED + - name: version + type: PARAMETER + testCases: + - /api/v2/users + endpointCase: UPPER + schema: + $ref: '#/components/schemas/EndpointConfig' + description: OK + security: + - ApiKeyAuth: + - CanConfigureServiceMapping + summary: Update endpoint configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + /api/application-monitoring/settings/http-endpoint: + get: + deprecated: true + description: |- + This is a deprecated endpoint. Use `All Endpoint configurations` instead. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: getHttpEndpointConfigs + responses: + '200': + content: + application/json: + example: + serviceId: d0cedae516f2182ede16f57f67476dd4c7dab9cd + endpointNameByFirstPathSegmentRuleEnabled: true + endpointNameByCollectedPathTemplateRuleEnabled: true + rules: + - enabled: true + pathSegments: + - name: api + type: FIXED + - name: version + type: PARAMETER + - type: MATCH_ALL + testCases: + - /api/v2/users + schema: + type: array + items: + $ref: '#/components/schemas/HttpEndpointConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: All HTTP endpoint configurations + tags: + - Application Settings + x-ibm-ahub-byok: true + post: + deprecated: true + description: |- + This is a deprecated endpoint. Use `Create endpoint configuration` instead. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: createHttpEndpointConfig + requestBody: + content: + application/json: + example: + endpointNameByCollectedPathTemplateRuleEnabled: true + endpointNameByFirstPathSegmentRuleEnabled: true + rules: + - enabled: true + pathSegments: + - type: MATCH_ALL + testCases: + - /api/v2/users + serviceId: 20ba31821b079e7d845a08096124880db3eeeb40 + schema: + $ref: '#/components/schemas/HttpEndpointConfig' + required: true + x-payload: createEndpointConfig + responses: + '200': + content: + application/json: + example: + serviceId: 20ba31821b079e7d845a08096124880db3eeeb40 + endpointNameByFirstPathSegmentRuleEnabled: true + endpointNameByCollectedPathTemplateRuleEnabled: true + rules: + - enabled: true + pathSegments: + - type: MATCH_ALL + testCases: + - /api/v2/users + schema: + $ref: '#/components/schemas/HttpEndpointConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Create HTTP endpoint configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + /api/application-monitoring/settings/http-endpoint/{id}: + delete: + deprecated: true + description: |- + This is a deprecated endpoint. Use `Delete endpoint configuration` instead. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: deleteHttpEndpointConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: | + An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Delete HTTP endpoint configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + get: + deprecated: true + description: |- + This is a deprecated endpoint. Use `Endpoint configuration` instead. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: getHttpEndpointConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: | + An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + responses: + '200': + content: + application/json: + example: + endpointNameByCollectedPathTemplateRuleEnabled: true + endpointNameByFirstPathSegmentRuleEnabled: true + rules: + - enabled: true + pathSegments: + - name: api + type: FIXED + - name: version + type: PARAMETER + - type: MATCH_ALL + testCases: + - /api/v2/users + serviceId: 20ba31821b079e7d845a08096124880db3eeeb47 + schema: + $ref: '#/components/schemas/HttpEndpointConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: HTTP Endpoint configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + put: + deprecated: true + description: |- + This is a deprecated endpoint. Use `Update endpoint configuration` instead. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: updateHttpEndpointConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: | + An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + requestBody: + content: + application/json: + example: + endpointNameByCollectedPathTemplateRuleEnabled: true + endpointNameByFirstPathSegmentRuleEnabled: true + rules: + - enabled: true + pathSegments: + - name: api + type: FIXED + - name: version + type: PARAMETER + - type: MATCH_ALL + testCases: + - /api/v2/users + serviceId: 20ba31821b079e7d845a08096124880db3eeeb40 + schema: + $ref: '#/components/schemas/HttpEndpointConfig' + required: true + x-payload: updateEndpointConfig + responses: + '200': + content: + application/json: + example: + endpointNameByCollectedPathTemplateRuleEnabled: true + endpointNameByFirstPathSegmentRuleEnabled: true + rules: + - enabled: true + pathSegments: + - name: api + type: FIXED + - name: version + type: PARAMETER + - type: MATCH_ALL + testCases: + - /api/v2/users + serviceId: 20ba31821b079e7d845a08096124880db3eeeb40 + schema: + $ref: '#/components/schemas/HttpEndpointConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Update HTTP endpoint configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + /api/application-monitoring/settings/manual-service: + get: + description: |2- + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: getAllManualServiceConfigs + responses: + '200': + content: + application/json: + example: + - id: wh49Z209S82aGvRl8ZZ0dQ + tagFilterExpression: + type: TAG_FILTER + name: call.database.connection + stringValue: redis:6379 + numberValue: null + booleanValue: null + key: null + value: redis:6379 + operator: EQUALS + entity: NOT_APPLICABLE + unmonitoredServiceName: null + existingServiceId: 2224a6ad91373ef2504dc6b5795d421bff8e4a4d + description: null + enabled: true + schema: + type: array + items: + $ref: '#/components/schemas/ManualServiceConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: All manual service configurations + tags: + - Application Settings + x-description: getAllManualServiceConfigs + x-ibm-ahub-byok: true + post: + description: |2- + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: addManualServiceConfig + requestBody: + content: + application/json: + example: + description: Map source service example + enabled: true + existingServiceId: c467ca0fa21477fee3cde75a140b2963307388a7 + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: front + numberValue: null + booleanValue: null + key: null + value: front + operator: EQUALS + entity: SOURCE + unmonitoredServiceName: null + schema: + $ref: '#/components/schemas/NewManualServiceConfig' + required: true + responses: + '200': + content: + application/json: + example: + id: FpG0_9tZT5OjzYM7m5VgUQ + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: front + numberValue: null + booleanValue: null + key: null + value: front + operator: EQUALS + entity: SOURCE + unmonitoredServiceName: null + existingServiceId: c467ca0fa21477fee3cde75a140b2963307388a7 + description: Map source service example + enabled: true + schema: + $ref: '#/components/schemas/ManualServiceConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Add manual service configuration + tags: + - Application Settings + x-description: addManualServiceConfigs + x-ibm-ahub-byok: true + put: + description: |2- + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: replaceAllManualServiceConfigs + requestBody: + content: + application/json: + example: + - description: Map source service + enabled: true + existingServiceId: c467ca0fa21477fee3cde75a140b2963307388a7 + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: front + numberValue: null + booleanValue: null + key: null + value: front + operator: EQUALS + entity: SOURCE + unmonitoredServiceName: null + schema: + type: array + items: + $ref: '#/components/schemas/NewManualServiceConfig' + required: true + responses: + '200': + content: + application/json: + example: + - id: undcnbu-S7OWi_4q4BnG4Q + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: front + numberValue: null + booleanValue: null + key: null + value: front + operator: EQUALS + entity: SOURCE + unmonitoredServiceName: null + existingServiceId: c467ca0fa21477fee3cde75a140b2963307388a7 + description: Map source service + enabled: true + schema: + type: array + items: + $ref: '#/components/schemas/ManualServiceConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Replace all manual service configurations + tags: + - Application Settings + x-description: replaceAllManualServiceConfigs + x-ibm-ahub-byok: true + /api/application-monitoring/settings/manual-service/{id}: + delete: + description: |2- + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: deleteManualServiceConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: A unique id of the manual service configuration. + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Delete manual service configuration + tags: + - Application Settings + x-description: deleteManualServiceConfigs + x-ibm-ahub-byok: true + put: + description: |2- + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: updateManualServiceConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: A unique id of the manual service configuration. + requestBody: + content: + application/json: + example: + description: Map source service example + enabled: true + existingServiceId: c467ca0fa21477fee3cde75a140b2963307388a7 + id: BDGeDcG4TRSzRkJ1mGOk-Q + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: front + numberValue: null + booleanValue: null + key: null + value: front + operator: EQUALS + entity: SOURCE + unmonitoredServiceName: null + schema: + $ref: '#/components/schemas/ManualServiceConfig' + required: true + responses: + '200': + content: + application/json: + example: + id: BDGeDcG4TRSzRkJ1mGOk-Q + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: front + numberValue: null + booleanValue: null + key: null + value: front + operator: EQUALS + entity: SOURCE + unmonitoredServiceName: null + existingServiceId: c467ca0fa21477fee3cde75a140b2963307388a7 + description: Map source service example + enabled: true + schema: + $ref: '#/components/schemas/ManualServiceConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Update manual service configuration + tags: + - Application Settings + x-description: updateManualServiceConfigs + x-ibm-ahub-byok: true + /api/application-monitoring/settings/service: + get: + description: |- + Use this API endpoint if one wants to retrive a list of all service configurations. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: getServiceConfigs + responses: + '200': + content: + application/json: + example: + - id: MyhomcyCRz2DF3O2KNXpGg + name: Rule + comment: null + label: '{docker.container.name}' + enabled: false + matchSpecification: + - key: docker.container.name + value: .* + schema: + type: array + items: + $ref: '#/components/schemas/ServiceConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: All service configurations + tags: + - Application Settings + x-ibm-ahub-byok: true + post: + description: |- + Use this API endpoint if one wants to create a custom service rule. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + ## Errata: + + The following field is documented in the request schema: + - The `id` field is not mandatory and one can't have a service configuration id before creating one configuration. + Instana creates it automatically. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: addServiceConfig + requestBody: + content: + application/json: + example: + comment: null + enabled: true + label: '{gce.zone}-{jvm.args.abc}' + matchSpecification: + - key: gce.zone + value: .* + - key: jvm.args.abc + value: .* + name: ABC is good + schema: + $ref: '#/components/schemas/ServiceConfig' + required: true + x-payload: addEndpointConfig + responses: + '200': + content: + application/json: + example: + id: oMsVfR0fSCuTKF2TFdYRmQ + name: ABC is good + comment: null + label: '{gce.zone}-{jvm.args.abc}' + enabled: true + matchSpecification: + - key: gce.zone + value: .* + - key: jvm.args.abc + value: .* + schema: + $ref: '#/components/schemas/ServiceConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Add service configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + put: + description: |- + Use this API endpoint if one wants to modify 1 or more existing service configuration. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: replaceAll + requestBody: + content: + application/json: + example: + - comment: null + enabled: true + id: 8C-jGYx8Rsue854tzkh8KQ + label: '{docker.container.name}' + matchSpecification: + - key: docker.container.name + value: .* + name: Rule + schema: + type: array + items: + $ref: '#/components/schemas/ServiceConfig' + required: true + responses: + '200': + content: + application/json: + example: + - id: 9uma4MhnTTSyBzwu_FKBJA + name: Rule + comment: null + label: '{docker.container.name}' + enabled: true + matchSpecification: + - key: docker.container.name + value: .* + schema: + type: array + items: + $ref: '#/components/schemas/ServiceConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Replace all service configurations + tags: + - Application Settings + x-ibm-ahub-byok: true + /api/application-monitoring/settings/service/order: + put: + description: |- + Use this API endpoint if one wants to change the order of service configurations aka custom service rules. + Note that all service configuration IDs have to be passed in the request to re-order the configurations. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: orderServiceConfig + requestBody: + content: + application/json: + example: + - 9uma4MhnTTSyBzwu_FKBJA + - oMsVfR0fSCuTKF2TFdYRmQ + schema: + type: array + items: + type: string + required: true + responses: + '204': + description: Order of Service rules modified + '400': + description: Provided config is not found + '401': + description: Unauthorized request + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Order of service configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + /api/application-monitoring/settings/service/{id}: + delete: + description: |- + Use this API endpoint if one wants to delete a service configuration. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: deleteServiceConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: 'A unique string for the service configuration. Eg: `G510hmXYSDysLZ5kuj0BaQ`' + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Delete service configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + get: + description: |- + Use this API endpoint if one wants to retrieve a particular custom service rule. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: getServiceConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: 'A unique string for the service configuration. Eg: `G510hmXYSDysLZ5kuj0BaQ`' + responses: + '200': + content: + application/json: + example: + id: P_37IlGQT0qQy9fxLxvFqA + name: Rule + comment: null + label: '{docker.container.name}' + enabled: true + matchSpecification: + - key: docker.container.name + value: .* + schema: + $ref: '#/components/schemas/ServiceConfig' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Service configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + put: + description: |- + Use this API endpoint if one wants to update a particular custom service rule. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + operationId: putServiceConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: 'A unique string for the service configuration. Eg: `G510hmXYSDysLZ5kuj0BaQ`' + requestBody: + content: + application/json: + example: + comment: null + enabled: true + id: 9uma4MhnTTSyBzwu_FKBJA + label: '{gce.zone}-{jvm.args.abc}' + matchSpecification: + - key: gce.zone + value: .* + - key: jvm.args.abc + value: .* + name: DEF is good + schema: + $ref: '#/components/schemas/ServiceConfig' + required: true + responses: + '200': + content: + application/json: + example: + id: 9uma4MhnTTSyBzwu_FKBJA + name: DEF is good + comment: null + label: '{gce.zone}-{jvm.args.abc}' + enabled: true + matchSpecification: + - key: gce.zone + value: .* + - key: jvm.args.abc + value: .* + schema: + $ref: '#/components/schemas/ServiceConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Update service configuration + tags: + - Application Settings + x-ibm-ahub-byok: true + /api/application-monitoring/topology/services: + get: + description: | + Use this API endpoint if one wants to retrieve services and connections (call paths) between them for calls in the scope given by the parameters. + + ## Errata: + + The following fields are unsupported but documented in the schema for the result `services`: + - The `applications` field is always missing and the `snapshotIds` field is always empty, despite being declared as required in the result schema. + - The `maxSeverity` and `numberOfOpenIssues` fields are always missing. + operationId: getServicesMap + parameters: + - description: Size of time window in milliseconds + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: Timestamp since Unix Epoch in milliseconds of the end of the + time window + in: query + name: to + schema: + type: integer + format: int64 + - description: Filter by application ID + in: query + name: applicationId + schema: + type: string + - description: Filter by application scope, i.e., INBOUND or ALL. The default + value is INBOUND. Applies only if application ID filter is specified. + in: query + name: applicationBoundaryScope + schema: + type: string + enum: + - ALL + - INBOUND + responses: + '200': + content: + application/json: + example: + connections: + - from: 8bfb4e1aa590eab8f08f837b97acf5803a5737ed + to: f17e7efb3b9b2d62bfec6b07905759fb81e99797 + calls: 2179 + latency: 1.6103717301514455 + errorRate: 0.0 + services: + - id: f17e7efb3b9b2d62bfec6b07905759fb81e99797 + label: robot-shop + types: + - MESSAGING + technologies: + - kubernetesService + - rabbitMq + snapshotIds: [ + ] + entityType: SERVICE + schema: + $ref: '#/components/schemas/ServiceMap' + description: OK + '400': + description: Bad Request + '401': + description: Unauthorized + '403': + description: Forbidden + security: + - ApiKeyAuth: + - Default + summary: Gets the service topology + tags: + - Application Topology + x-ibm-ahub-byok: true + /api/application-monitoring/v2/analyze/traces/{id}: + get: + description: |- + Use this API endpoint if one wants to retrive comprehensive details of a particular trace. + For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze. + operationId: getTraceDownload + parameters: + - in: path + name: id + required: true + schema: + type: string + description: An Instana generated unique identifier for a trace. + - in: query + name: retrievalSize + schema: + type: integer + format: int32 + description: | + The number of records to retrieve in a single request. + For example, when retrievalSize is set to 30, offset is 20, and ingestionTime is 1725519793, the API request will fetch 30 records starting from the 21st record after the specified `ingestionTime`. + Minimum value is 1 and maximum value is 10000. + maximum: 10000 + minimum: 1 + - in: query + name: offset + schema: + type: integer + format: int32 + description: | + The number of records to be skipped from the `ingestionTime`. + For example: when `offset` is 20 and `ingestionTime` is 1725519793, the API response should have records starting from the 21st record after the specified `ingestionTime`. + Note that if `offset` value is not empty, `ingestionTime` can't be empty. + - in: query + name: ingestionTime + schema: + type: integer + format: int64 + description: | + The timestamp indicating the starting point from which data was ingested. + The format of the timestamp is in Unix epoch Time. + For example, `Thursday, 5 September 2024 07:03:13 GMT` can be represented as `1725519793`. + responses: + '200': + content: + application/json: + example: + items: + - id: daa9141549aea210 + timestamp: 1688544599223 + parentId: null + foreignParentId: null + name: GET /api/shipping/cities/dk + duration: 30 + minSelfTime: 1 + networkTime: null + callCount: 1 + errorCount: 0 + destination: + service: + id: ce4b152bac7b99744d8314838e49b799afd6dd96 + label: nginx-web + endpoint: + id: wAS2omB44e0EK4xqL7f-e-wt4C4 + label: upstream shipping + type: HTTP + technologies: [ + ] + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1688547327000 + offset: 1 + canLoadMore: false + totalHits: 3 + totalRepresentedItemCount: 3 + totalRetainedItemCount: 3 + schema: + $ref: '#/components/schemas/TraceDownloadResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get trace detail + tags: + - Application Analyze + x-ibm-ahub-byok: true + /api/application-monitoring/v2/analyze/traces/{traceId}/calls/{callId}/details: + get: + description: |- + Use this API endpoint to retrieve a vast information about a call present in a trace. + + For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze. + operationId: getCallDetails + parameters: + - in: path + name: traceId + required: true + schema: + type: string + description: An Instana generated unique identifier for a trace. + - in: path + name: callId + required: true + schema: + type: string + description: 'The call ID. A unique identifier for an individual call. For + example: `1bcad5c82338deaf`.' + responses: + '200': + content: + application/json: + example: + id: 14219b3deb6a6bc5 + label: GET /api/shipping/cities/bg + start: 1707295859759 + duration: 3597 + minSelfTime: 2 + networkTime: null + errorCount: 0 + batchSize: 1 + batchSelfTime: 3597 + source: + applications: [ + ] + service: + id: ROOT + label: '' + endpoint: + id: XCjGvnwuiak0m3ISke3naE-NrGA + label: Unspecified + type: UNDEFINED + physicalContext: { + } + destination: + applications: [ + ] + service: + id: ce4b152bac7b99744d8314838e49b799afd6dd96 + label: nginx-web + endpoint: + id: wAS2omB44e0EK4xqL7f-e-wt4C4 + label: upstream shipping + type: HTTP + physicalContext: + process: + id: jXvrnXHuBqfhlZQTux-ck1PYd6Y + time: 1707258023000 + label: Node @30303 + plugin: nginx + data: null + spans: + - id: 14219b3deb6a6bc5 + parentId: '' + name: sdk.http.entry + kind: ENTRY + foreignParentId: '' + start: 1707295859759 + duration: 3597 + errorCount: 0 + stackTrace: [ + ] + data: + service: nginx-web + http: + path: /api/shipping/cities/bg + protocol: http + route_id: upstream shipping + method: GET + host: web:8080 + url: http://web:8080//api/shipping/cities/bg + status: 200 + logs: [ + ] + synthetic: false + schema: + $ref: '#/components/schemas/TraceActivityTreeNodeDetails' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get call detail + tags: + - Application Analyze + x-ibm-ahub-byok: true + /api/application-monitoring/v2/metrics: + post: + description: |- + Use this API endpoint if one wants to retrieve one or more supported aggregation of supported metrics for a combination of entities. + For eg: retrieve `MEAN` aggregation of `latency` metric for an Endpoint `GET /api/foo`, Service `payment` and Application Perspective `app`. + Consider this API endpoint an upgraded version of `Get Application Metrics`, `Get Endpoint metrics` and `Get Service metrics`. + For more information on supported metrics, refer `Get Metric catalog`. + + For more information on Application Metrics please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-metrics. + operationId: getApplicationDataMetricsV2 + requestBody: + content: + application/json: + example: + includeInternal: true + includeSynthetic: true + metrics: + - aggregation: MEAN + metric: latency + tagFilterExpression: + type: TAG_FILTER + name: service.name + operator: EQUALS + entity: DESTINATION + value: warehouse + timeFrame: + to: 1669190589000 + windowSize: 3600000 + schema: + $ref: '#/components/schemas/GetApplicationMetrics' + responses: + '200': + content: + application/json: + example: + metrics: + latency.mean: + - - 1669190580000 + - 106.85055708882756 + adjustedTimeframe: + windowSize: 3600000 + to: 1669190580000 + schema: + $ref: '#/components/schemas/MetricAPIResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get Application Data Metrics + tags: + - Application Metrics + x-ibm-ahub-byok: true + /api/automation/actioninstances: + delete: + description: Deletes the automation action run results from the action run history. + The results to delete is filtered by the filter values given in the query + parameters. The automation action run result will be deleted only if the action + run result was created within the timeframe specified in the `from` and `to` + query parameters. This call requires `Deletion of automation action history` + permission and, `from` and `to` query parameters. + operationId: deleteActionInstances + parameters: + - description: From date filter in milliseconds (13-digit) to look up the action + run results to delete + example: 1706713140000 + in: query + name: from + required: true + schema: + type: integer + format: int64 + - description: To date filter in milliseconds (13-digit) to look up the action + run results to delete + example: 1706713140000 + in: query + name: to + required: true + schema: + type: integer + format: int64 + - description: Target snapshot ID to look up the action run results to delete + example: aCtEoR6NSPqG61QkIkwwCw + in: query + name: targetSnapshotId + schema: + type: string + - description: Event ID filter to look up the action run results to delete + example: bCtEoR6NSPqG61QkIkwwCw + in: query + name: eventId + schema: + type: string + - description: Event specification ID filter to look up the action run results + to delete + example: 1706713140000 + in: query + name: eventSpecificationId + schema: + type: string + - description: Text in action run result name, description and event name to + filter the action run results to delete + example: 1706713140000 + in: query + name: search + schema: + type: string + - description: Action type filter to look up the action run results to delete + example: One or more of the following types HTTP, SCRIPT, ANSIBLE, GITHUB, + GITLAB, JIRA + in: query + name: types + schema: + type: array + items: + type: string + - description: Action status filter to look up the action run results to delete + example: One or more of the following status SUBMITTED, IN_PROGRESS, SUCCESS, + FAILED, TIMEOUT + in: query + name: actionStatuses + schema: + type: array + items: + type: string + - description: List of action IDs to filter the action run results to delete + example: cCtEoR6NSPqG61QkIkwwCw + in: query + name: actionIds + schema: + type: array + items: + type: string + - description: Policy ID filter to look up the action run results to delete + example: bCtEoR6NSPqG61QkIkwwCw + in: query + name: policyId + schema: + type: string + responses: + '200': + content: + application/json: + example: + deletedDocumentsCount: '2' + description: Automation action run results are deleted. + '400': + description: '`from` date or `to` date query parameter is missing.' + '403': + description: Automation feature is not enabled or Insufficient permissions. + '500': + description: The request do not contain a valid user or API Token. + security: + - ApiKeyAuth: + - canDeleteAutomationActionHistory + summary: Delete automation action run results. + tags: + - Action History + x-ibm-ahub-byok: true + get: + description: Get the details of automation action run results from action run + history. The results are filtered by the filters in the query parameters. + The automation action run result will be fetched only if the action run results + were created within the timeframe specified by the `windowSize` and `to` query + parameters. The `windowSize` parameter is used to compute the from date (`from + = to - windowSize`) of the timeframe. The default value for `windowSize` is + 10 minutes and the default value for `to` is current system time. When using + personal access tokens, the user must have at least `Viewer` access for Automation + and the automation action run results returned are also filtered based on + the access set in `Limited access` permission settings. This API returns paginated + result as specified in query parameters `page` and `pageSize`. The response + contains list of automation action run results whose contents corresponds + to the `page` query parameter and whose size corresponds to the `pageSize` + query parameter. + operationId: getActionInstances + parameters: + - description: Window size filter in milliseconds (to compute the from date) + to get the action run result details + example: 10000 + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: To date filter in milliseconds (13-digit) to get the action run + result details + example: 1706713140000 + in: query + name: to + schema: + type: integer + format: int64 + - description: Page to fetch -- used for paging the action run result records + example: 2 + in: query + name: page + schema: + type: integer + format: int32 + - description: Number of records to return in each page -- used for paging the + action run result records + example: 50 + in: query + name: pageSize + schema: + type: integer + format: int32 + - description: Target snapshot ID filter to get the action run result details + example: nCtEoR6NSPqG61QkIkwwCw + in: query + name: targetSnapshotId + schema: + type: string + - description: Event ID filter to get the action run result details + example: nCtEoR6NSPqG61QkIkwwCw + in: query + name: eventId + schema: + type: string + - description: Event specification ID filter to get the action run result details + example: 1706713140000 + in: query + name: eventSpecificationId + schema: + type: string + - description: Text in action run result name, description and event name filter + to get the action run result details + example: 1706713140000 + in: query + name: search + schema: + type: string + - description: Action type filter to get the action run result details + example: One or more of the following types HTTP, SCRIPT, ANSIBLE, GITHUB, + GITLAB, JIRA + in: query + name: types + schema: + type: array + items: + type: string + - description: Action status filter to get the action run result details + example: One or more of the following status SUBMITTED, IN_PROGRESS, SUCCESS, + FAILED, TIMEOUT + in: query + name: actionStatuses + schema: + type: array + items: + type: string + - description: Action IDs filter to get the action run result details for only + these actions + in: query + name: actionIds + schema: + type: array + items: + type: string + - description: Policy ID filter to get the action run result details + example: nCtEoR6NSPqG61QkIkwwCw + in: query + name: policyId + schema: + type: string + - description: Action run result column to order the result set. + example: Name of the action run result column. Default is action run result + start date. + in: query + name: orderBy + schema: + type: string + - description: Sort order direction. + example: asc or desc + in: query + name: orderDirection + schema: + type: string + responses: + '200': + content: + application/json: + example: + items: + - actionInstanceId: fqiH0HOgR1-4Ygoy5EDycw + actionId: d473c1b0-0740-4d08-95fe-31e5d0a9faff + actionName: Hello World + type: SCRIPT + status: SUCCESS + createdDate: 1710162882369 + startDate: 1710162882653 + endDate: 1710162882826 + eventId: M3wuBxuaSDyecZJ7ICioiw + eventSpecificationId: en0FW6XRWu7aRsD4055dbMLAuSU + problemText: Test event + hostSnapshotId: 2nIOVtEW-iPbsEIi89-yDqJHi2g + targetSnapshotId: jfSmhACY-Oa3a8zfjJxvOxJeDSk + metadata: [ + ] + page: 1 + pageSize: 50 + totalHits: 500 + schema: + $ref: '#/components/schemas/PaginatedResult' + description: Automation action run result details are returned. + '403': + description: Automation feature is not enabled or Insufficient permissions. + security: + - ApiKeyAuth: + - Default + summary: Get the details of automation action run results from action run history. + tags: + - Action History + x-ibm-ahub-byok: true + post: + description: Submits the automation action for execution on an agent. The automation + action to execute and the agent on which to execute the action must be specified + as actionId and hostId. For more details on the request payload see the request + sample. This call requires `Execution of automation actions` permission. + operationId: addActionInstance + requestBody: + content: + application/json: + example: + hostId: aHostId + actionId: d473c1b0-0740-4d08-95fe-31e5d0a9faff + policyId: 2nIOVtEW-iPbsEIi89-yDqJabc + inputParameters: + - name: name + type: type + value: value + eventId: M3wuBxuaSDyecZJ7ICioiw + async: 'true' + timeout: '600' + schema: + $ref: '#/components/schemas/ActionInstanceRequest' + required: true + responses: + '200': + content: + application/json: + example: + actionInstanceId: fqiH0HOgR1-4Ygoy5EDycw + actionId: d473c1b0-0740-4d08-95fe-31e5d0a9faff + actionName: Hello World + type: SCRIPT + status: SUBMITTED + createdDate: 1710162882369 + eventId: M3wuBxuaSDyecZJ7ICioiw + eventSpecificationId: en0FW6XRWu7aRsD4055dbMLAuSU + problemText: Test event + hostSnapshotId: 2nIOVtEW-iPbsEIi89-yDqJHi2g + targetSnapshotId: jfSmhACY-Oa3a8zfjJxvOxJeDSk + inputParameters: [ + ] + outputParameters: [ + ] + metadata: [ + ] + externalSourceType: '' + actorId: 5ee5195fbea6150001758c40 + actorName: Stan + actorType: USER + eventEntityType: '' + actionDescription: Simple script action for testing + policyId: 2nIOVtEW-iPbsEIi89-yDqJabc + schema: + $ref: '#/components/schemas/ActionInstance' + description: Automation action submitted for execution on the agent. + '400': + description: The payload in the request body is not valid or the action + ID (actionId) in the payload is invalid or the agent host ID (hostId) + in the payload is invalid. + '403': + description: Automation feature is not enabled or Insufficient permissions. + security: + - ApiKeyAuth: + - canRunAutomationActions + summary: Run an automation action. + tags: + - Action History + x-ibm-ahub-byok: true + /api/automation/actioninstances/{actionInstanceId}: + delete: + description: Deletes the automation action run result specified in the request + path from the action run history. The automation action run result will be + deleted only if the action run result was created within the timeframe specified + in the `from` and `to` query parameters. To get the automation action run + result ID and the created time, you can run `/api/automation/actioninstances` + and `/api/automation/actioninstances/<{actionInstanceId}>` REST calls. This + call requires `Deletion of automation action history` permission. + operationId: deleteActionInstance + parameters: + - description: Automation action run result ID to delete. + example: nCtEoR6NSPqG61QkIkwwCw + in: path + name: actionInstanceId + required: true + schema: + type: string + - description: From date filter in milliseconds (13-digit) to look up the action + run result ID. + example: 1706713140000 + in: query + name: from + required: true + schema: + type: integer + format: int64 + - description: To date filter in milliseconds (13-digit) to look up the action + run result ID. + example: 1706713190000 + in: query + name: to + required: true + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + deletedDocumentsCount: '2' + description: Automation action run result is deleted. + '400': + description: Automation action run result ID is missing in the request path, + or `from` date or `to` date is missing in the query parameters. + '403': + description: Automation feature is not enabled or Insufficient permissions. + '500': + description: The request do not contain a valid user or API Token. + security: + - ApiKeyAuth: + - canDeleteAutomationActionHistory + summary: Deletes an automation action run result from the action run history + by ID. + tags: + - Action History + x-ibm-ahub-byok: true + get: + description: Get the details of automation action run result specified in the + request path from action run history. The automation action run result will + be fetched only if the action run result was created within the timeframe + specified by the `windowSize` and `to` query parameters. The `windowSize` + parameter is used to compute the from date (`from = to - windowSize`) of the + timeframe. The default value for `windowSize` is 10 minutes and the default + value for `to` is current system time. To get the automation action run result + ID and the created time, you can run `/api/automation/actioninstances` REST + calls. When using personal access tokens, the user must have at least `Viewer` + access for Automation. + operationId: getActionInstance + parameters: + - description: action run result ID to get action run result details + example: nCtEoR6NSPqG61QkIkwwCw + in: path + name: actionInstanceId + required: true + schema: + type: string + - description: Window size in milliseconds. This value is used compute the from + date `(from = to - windowSize)` to get the action run result details. The + default `windowSize` is set to 10 minutes if this value is not provided. + example: 10000 + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: To date filter in milliseconds (13-digit) to get the action run + result details. The default `to` date is set to `System.currentTimeMillis()` + if this value is not provided. + example: 1706713140000 + in: query + name: to + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + actionInstanceId: fqiH0HOgR1-4Ygoy5EDycw + actionId: d473c1b0-0740-4d08-95fe-31e5d0a9faff + actionName: Hello World + type: SCRIPT + status: SUCCESS + returnCode: 0 + errorMessage: '' + createdDate: 1710162882369 + startDate: 1710162882653 + endDate: 1710162882826 + eventId: M3wuBxuaSDyecZJ7ICioiw + eventSpecificationId: en0FW6XRWu7aRsD4055dbMLAuSU + problemText: Test event + hostSnapshotId: 2nIOVtEW-iPbsEIi89-yDqJHi2g + inputParameters: [ + ] + outputParameters: [ + ] + metadata: [ + ] + targetSnapshotId: jfSmhACY-Oa3a8zfjJxvOxJeDSk + externalSourceType: '' + actorId: 5ee5195fbea6150001758c40 + actorName: Stan + actorType: USER + eventEntityType: '' + actionDescription: Simple script action for testing + policyId: 2nIOVtEW-iPbsEIi89-yDqJabc + output: Hello world! + schema: + $ref: '#/components/schemas/ActionInstance' + description: The automation action run result detail is returned. + '400': + description: Missing automation action run result ID. + '403': + description: Automation feature is not enabled or Insufficient permissions. + security: + - ApiKeyAuth: + - Default + summary: Get the details of an automation action run result by ID from action + run history. + tags: + - Action History + x-ibm-ahub-byok: true + /api/automation/actions: + get: + description: Get all automation actions. When using personal access tokens, + the user must have at least `Viewer` access for Automation and the actions + returned are also filtered based on the access set in `Limited access` permission + settings. + operationId: getActions + responses: + '200': + content: + application/json: + example: + - id: d473c1b0-0740-4d08-95fe-31e5d0a9faff + name: Hello World + description: Simple script action for testing + type: SCRIPT + fields: + - name: subtype + description: script subtype + encoding: base64 + value: YmFzaA== + secured: false + - name: script_ssh + description: script content + encoding: base64 + value: ZWNobyBoZWxsbyB3b3JsZA== + secured: false + - name: timeout + description: timeout of the action execution in seconds + encoding: ascii + value: '' + secured: false + inputParameters: [ + ] + tags: + - Test + createdAt: 1.694442511129923E9 + modifiedAt: 1.703191040321448E9 + schema: + type: array + items: + $ref: '#/components/schemas/Action' + description: Automation actions are returned. + '403': + description: Automation feature is not enabled or Insufficient permissions. + '500': + description: Failed to retrieve the automation actions. + security: + - ApiKeyAuth: + - Default + summary: Get all automation actions. + tags: + - Action Catalog + x-ibm-ahub-byok: true + /api/automation/actions/{id}: + get: + description: Get an automation action by ID specified in the request path. When + using personal access tokens, the user must have at least `Viewer` access + for Automation and the actions returned are also filtered based on the access + set in `Limited access` permission settings. + operationId: getActionByID + parameters: + - description: Automation action ID + example: d473c1b0-0740-4d08-95fe-31e5d0a9faff + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: d473c1b0-0740-4d08-95fe-31e5d0a9faff + name: Hello World + description: Simple script action for testing + type: SCRIPT + fields: + - name: subtype + description: script subtype + encoding: base64 + value: YmFzaA== + secured: false + - name: script_ssh + description: script content + encoding: base64 + value: ZWNobyBoZWxsbyB3b3JsZA== + secured: false + - name: timeout + description: timeout of the action execution in seconds + encoding: ascii + value: '' + secured: false + inputParameters: [ + ] + tags: + - Test + createdAt: 1.694442511129923E9 + modifiedAt: 1.703191040321448E9 + schema: + $ref: '#/components/schemas/Action' + description: Automation action is returned. + '403': + description: Automation feature is not enabled or Insufficient permissions. + '404': + description: Automation action not found. + security: + - ApiKeyAuth: + - Default + summary: Get an automation action by ID. + tags: + - Action Catalog + x-ibm-ahub-byok: true + /api/automation/ai/action/match: + get: + description: Get automation actions that match based on application ID or snapshot + ID within a specified time window. + operationId: getActionMatchesByIdAndTimeWindow + parameters: + - in: query + name: applicationId + schema: + type: string + - in: query + name: snapshotId + schema: + type: string + - in: query + name: to + schema: + type: integer + format: int64 + - in: query + name: windowSize + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ActionMatch' + description: The automation actions that match are returned. + '400': + description: Either applicationId or snapshotId must be provided, but not + both. + '403': + description: Automation feature is not enabled or Insufficient permissions. + '500': + description: Failed to retrieve the matching automation actions. + security: + - ApiKeyAuth: + - Default + summary: Get action matches by application ID or snapshot ID. + tags: + - Action Catalog + x-ibm-ahub-byok: true + post: + description: Get automation actions that match the incident or issue data in + the request body. + operationId: getActionMatches + parameters: + - in: query + name: targetSnapshotId + schema: + type: string + requestBody: + content: + application/json: + example: + name: CPU spends significant time waiting for input/output + description: Checks whether the system spends significant time waiting + for input/output. + schema: + $ref: '#/components/schemas/ActionSearchSpace' + required: true + responses: + '200': + content: + application/json: + example: + - score: 0.12087341955930318 + action: + id: d473c1b0-0740-4d08-95fe-31e5d0a9faff + name: Hello World + description: Simple script action for testing + type: SCRIPT + fields: + - name: subtype + description: script subtype + encoding: base64 + value: YmFzaA== + secured: false + - name: script_ssh + description: script content + encoding: base64 + value: ZWNobyBoZWxsbyB3b3JsZA== + secured: false + - name: timeout + description: timeout of the action execution in seconds + encoding: ascii + value: '' + secured: false + inputParameters: [ + ] + tags: + - sample + createdAt: 1.694442511129923E9 + modifiedAt: 1.703191040321448E9 + color: low + confidence: low + aiEngine: NLP + schema: + type: array + items: + $ref: '#/components/schemas/ActionMatch' + description: The automation actions that match the incident are returned. + '403': + description: Automation feature is not enabled or Insufficient permissions. + '500': + description: Failed to retrieve the matching automation actions. + security: + - ApiKeyAuth: + - Default + summary: Get automation actions that match the incidents or issues. + tags: + - Action Catalog + x-ibm-ahub-byok: true + /api/automation/parameters/dynamic: + put: + operationId: resolve + requestBody: + content: + application/json: + example: + eventId: 7UPTIakhR3uVaMnSQuG3TA + timestamp: 1710168530000 + parameters: + - name: Application name + tagName: application.name + schema: + $ref: '#/components/schemas/GetDynamicParameterValues' + required: true + responses: + '200': + content: + application/json: + example: + eventId: 7UPTIakhR3uVaMnSQuG3TA + timestamp: 1710168530000 + parameters: + - name: Application name + tagName: application.name + resolvedValue: '["Demo Application"]' + schema: + $ref: '#/components/schemas/GetDynamicParameterValues' + description: OK + '500': + description: Internal server error + security: + - ApiKeyAuth: + - canRunAutomationActions + summary: Resolve dynamic parameter values + tags: + - Action Catalog + x-ibm-ahub-byok: true + /api/automation/parameters/dynamic/catalog: + get: + operationId: getDynamicParametersTagCatalog + responses: + '200': + content: + application/json: + example: + tagTree: + - label: Application + description: null + icon: null + children: + - label: Name + icon: lib_application + tagName: application.name + queryable: true + type: TAG + type: LEVEL + queryable: false + tags: + - name: application.name + label: Name + type: STRING_SET + description: null + canApplyToSource: true + canApplyToDestination: true + idTag: false + schema: + $ref: '#/components/schemas/TagCatalog' + description: OK + '500': + description: Internal server error + security: + - ApiKeyAuth: + - Default + summary: Get tag catalog for dynamic parameters + tags: + - Action Catalog + x-description: getDynamicParametersTagCatalog + x-ibm-ahub-byok: true + /api/automation/policies: + get: + description: Returns all the automation policies filtered by the values in optional + query parameters. When using personal access tokens, the user must have at + least `Viewer` access for Automation and the automation policies returned + are also filtered based on the access set in `Limited access` permission settings. + operationId: getPolicies + parameters: + - description: Filter policies by the event or alert type that can trigger a + policy. This is an optional parameter. Valid values are customEvent, builtinEvent, + applicationSmartAlert, globalApplicationSmartAlert, websiteSmartAlert, infraSmartAlert, + mobileAppSmartAlert, syntheticsSmartAlert, logSmartAlert, sloSmartAlert + in: query + name: triggerType + schema: + type: string + - description: Trigger identifier. This is an optional parameter. + in: query + name: triggerId + schema: + type: string + - description: Filter policies by policy execution type. This is an optional + parameter. Valid values are automatic or manual + in: query + name: executionType + schema: + type: string + - description: Filter policies by action ID. This is an optional parameter. + in: query + name: actionId + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: a14700b0-401b-47eb-a751-deda0035fde3 + name: Policy for test + description: Policy for test + trigger: + type: customEvent + id: C3Ha8PffQHfJ0Hk6 + name: Test Event + typeConfigurations: + - name: manual + runnable: + type: action + id: d473c1b0-0740-4d08-95fe-31e5d0a9faff + runConfiguration: + actions: + - action: + id: d473c1b0-0740-4d08-95fe-31e5d0a9faff + name: Hello World + description: Simple script action for testing + type: SCRIPT + fields: + - name: subtype + description: script subtype + encoding: base64 + value: YmFzaA== + secured: false + - name: script_ssh + description: script content + encoding: base64 + value: ZWNobyBoZWxsbyB3b3JsZA== + secured: false + - name: timeout + description: timeout of the action execution in seconds + encoding: ascii + value: '' + secured: false + inputParameters: [ + ] + tags: + - Test + - idempotent + createdAt: 1.694442511129923E9 + modifiedAt: 1.703191040321448E9 + schema: + type: array + items: + $ref: '#/components/schemas/Policy' + description: Automation policies list filtered by the values in query parameters. + '403': + description: Insufficient permissions. + '500': + description: Failed to retrieve the automation policies. + security: + - ApiKeyAuth: + - Default + summary: Get all automation policies. + tags: + - Policies + x-ibm-ahub-byok: true + post: + description: Creates a new automation policy. Policy creation requires `Configuration + of automation policies` permission. + operationId: addPolicy + requestBody: + content: + application/json: + example: + name: builtin-action-custom-event + trigger: + name: test event + type: customEvent + id: 2X5r-Un18MIE59rE + typeConfigurations: + - name: manual + runnable: + type: action + id: c5ba4453-0bc2-3c3e-bdbe-b3ce68239145 + runConfiguration: + actions: + - action: + id: c5ba4453-0bc2-3c3e-bdbe-b3ce68239145 + schema: + $ref: '#/components/schemas/Policy' + required: true + responses: + '201': + content: + application/json: + example: + id: a14700b0-401b-47eb-a751-deda0035fde3 + name: Policy for test + description: Policy for test + trigger: + type: customEvent + id: C3Ha8PffQHfJ0Hk6 + name: Test Event + typeConfigurations: + - name: manual + runnable: + type: action + id: d473c1b0-0740-4d08-95fe-31e5d0a9faff + runConfiguration: + actions: + - action: + id: d473c1b0-0740-4d08-95fe-31e5d0a9faff + name: Hello World + description: Simple script action for testing + type: SCRIPT + fields: + - name: subtype + description: script subtype + encoding: base64 + value: YmFzaA== + secured: false + - name: script_ssh + description: script content + encoding: base64 + value: ZWNobyBoZWxsbyB3b3JsZA== + secured: false + - name: timeout + description: timeout of the action execution in seconds + encoding: ascii + value: '' + secured: false + inputParameters: [ + ] + tags: + - Test + createdAt: 1.694442511129923E9 + modifiedAt: 1.703191040321448E9 + schema: + $ref: '#/components/schemas/Policy' + description: New policy created. + '400': + description: Bad request. + '403': + description: Insufficient permissions. + '412': + description: Invalid input value. + '500': + description: Internal Server Error. + security: + - ApiKeyAuth: + - canConfigureAutomationPolicies + summary: Create an automation policy. + tags: + - Policies + x-ibm-ahub-byok: true + /api/automation/policies/bulk: + post: + description: Creates a list of automation policies. Policy creation requires + `Configuration of automation policies` permission. + operationId: addPolicies + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Policy' + required: true + responses: + '201': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Policy' + description: Created. + '400': + description: Bad request. + '403': + description: Insufficient permissions. + '412': + description: Invalid input value. + '500': + description: Internal Server Error. + security: + - ApiKeyAuth: + - canConfigureAutomationPolicies + summary: Create automation policies. + tags: + - Policies + x-ibm-ahub-byok: true + /api/automation/policies/{id}: + delete: + description: Deletes an automation policy by identifier. Policy deletion requires + `Configuration of automation policies` permission. When using personal tokens + the automation policies deleted are based on the access set in `Limited access` + permission settings. + operationId: deletePolicy + parameters: + - description: Automation policy ID to delete + example: a14700b0-401b-47eb-a751-deda0035fde3 + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Automation policy successfully deleted + '403': + description: Insufficient permissions. + '412': + description: Automation policy does not exist + security: + - ApiKeyAuth: + - canConfigureAutomationPolicies + summary: Deletes an automation policy by identifier. + tags: + - Policies + x-ibm-ahub-byok: true + get: + description: Returns the automation policy filtered by the ID in request parameter. + When using personal access tokens, the user must have at least `Viewer` access + for Automation and the automation policies returned are also filtered based + on the access set in `Limited access` permission settings. + operationId: getPolicyByID + parameters: + - description: Automation policy ID + example: a14700b0-401b-47eb-a751-deda0035fde3 + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: a14700b0-401b-47eb-a751-deda0035fde3 + name: Policy for test + description: Policy for test + trigger: + type: customEvent + id: C3Ha8PffQHfJ0Hk6 + name: Test Event + typeConfigurations: + - name: manual + runnable: + type: action + id: d473c1b0-0740-4d08-95fe-31e5d0a9faff + runConfiguration: + actions: + - action: + id: d473c1b0-0740-4d08-95fe-31e5d0a9faff + name: Hello World + description: Simple script action for testing + type: SCRIPT + fields: + - name: subtype + description: script subtype + encoding: base64 + value: YmFzaA== + secured: false + - name: script_ssh + description: script content + encoding: base64 + value: ZWNobyBoZWxsbyB3b3JsZA== + secured: false + - name: timeout + description: timeout of the action execution in seconds + encoding: ascii + value: '' + secured: false + inputParameters: [ + ] + tags: + - Test + createdAt: 1.694442511129923E9 + modifiedAt: 1.703191040321448E9 + schema: + $ref: '#/components/schemas/Policy' + description: Automation policy filtered by the ID in request parameter. + '403': + description: Insufficient permissions. + '404': + description: Automation policy not found. + security: + - ApiKeyAuth: + - Default + summary: Get an automation policy by ID. + tags: + - Policies + x-ibm-ahub-byok: true + put: + description: Updates an automation policy by identifier. Policy updates requires + `Configuration of automation policies` permission. When using personal tokens + the automation policies updated are based on the access set in `Limited access` + permission settings. + operationId: updatePolicy + parameters: + - in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: builtin-action-custom-event + trigger: + name: test event + type: customEvent + id: 2X5r-Un18MIE59rE + typeConfigurations: + - name: manual + runnable: + type: action + id: c5ba4453-0bc2-3c3e-bdbe-b3ce68239145 + runConfiguration: + actions: + - action: + id: c5ba4453-0bc2-3c3e-bdbe-b3ce68239145 + schema: + $ref: '#/components/schemas/Policy' + required: true + responses: + '200': + content: + application/json: + example: + id: a14700b0-401b-47eb-a751-deda0035fde3 + name: Policy for test + description: Policy for test + trigger: + type: customEvent + id: C3Ha8PffQHfJ0Hk6 + name: Test Event + typeConfigurations: + - name: manual + runnable: + type: action + id: d473c1b0-0740-4d08-95fe-31e5d0a9faff + runConfiguration: + actions: + - action: + id: d473c1b0-0740-4d08-95fe-31e5d0a9faff + name: Hello World + description: Simple script action for testing + type: SCRIPT + fields: + - name: subtype + description: script subtype + encoding: base64 + value: YmFzaA== + secured: false + - name: script_ssh + description: script content + encoding: base64 + value: ZWNobyBoZWxsbyB3b3JsZA== + secured: false + - name: timeout + description: timeout of the action execution in seconds + encoding: ascii + value: '' + secured: false + inputParameters: [ + ] + tags: + - Test + createdAt: 1.694442511129923E9 + modifiedAt: 1.703191040321448E9 + schema: + $ref: '#/components/schemas/Policy' + description: Automation policy successfully updated. + '403': + description: Insufficient permissions. + '412': + description: Invalid input value. + '500': + description: Server Error. + security: + - ApiKeyAuth: + - canConfigureAutomationPolicies + summary: Updates an automation policy by identifier. + tags: + - Policies + x-ibm-ahub-byok: true + /api/business-monitoring/activities: + post: + operationId: getActivities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetActivities' + x-payload: getActivities + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CursorPaginatedBusinessActivityItem' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get Business Activities + tags: + - Business Monitoring + x-ibm-ahub-byok: true + /api/business-monitoring/activities/csv: + post: + operationId: getActivitiesCsv + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetActivities' + x-payload: getActivitiesCsv + responses: + '200': + content: + text/csv: + schema: + $ref: '#/components/schemas/BusinessActivity' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Download Business Activities + tags: + - Business Monitoring + x-ibm-ahub-byok: true + /api/business-monitoring/business-perspectives: + get: + operationId: getBusinessPerspectives + responses: + '200': + content: + application/json: + example: + - id: gBwNFIbjS6Ozwt0a12regg + label: biz-perspective + name: biz-perspective + description: This is an example business perspective + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: OR + elements: + - type: TAG_FILTER + name: service.id + stringValue: my-service-1 + numberValue: null + booleanValue: null + key: null + value: my-service-1 + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: service.id + stringValue: my-service-2 + numberValue: null + booleanValue: null + key: null + value: my-service-2 + operator: EQUALS + entity: DESTINATION + schema: + $ref: '#/components/schemas/BusinessPerspectiveConfig' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get all business perspectives + tags: + - Business Monitoring + x-ibm-ahub-byok: true + post: + operationId: createBusinessPerspective + requestBody: + content: + application/json: + example: + label: biz-perspective + name: biz-perspective + description: This is an example business perspective + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: OR + elements: + - type: TAG_FILTER + name: service.id + stringValue: my-service-1 + numberValue: null + booleanValue: null + key: null + value: my-service-1 + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: service.id + stringValue: my-service-2 + numberValue: null + booleanValue: null + key: null + value: my-service-2 + operator: EQUALS + entity: DESTINATION + schema: + $ref: '#/components/schemas/NewBusinessPerspectiveConfig' + required: true + x-payload: createBusinessPerspective + responses: + '200': + content: + application/json: + example: + id: gBwNFIbjS6Ozwt0a12regg + label: biz-perspective + name: biz-perspective + description: This is an example business perspective + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: OR + elements: + - type: TAG_FILTER + name: service.id + stringValue: my-service-1 + numberValue: null + booleanValue: null + key: null + value: my-service-1 + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: service.id + stringValue: my-service-2 + numberValue: null + booleanValue: null + key: null + value: my-service-2 + operator: EQUALS + entity: DESTINATION + schema: + $ref: '#/components/schemas/BusinessPerspectiveConfig' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Create business perspective + tags: + - Business Monitoring + x-description: createBusinessPerspective + x-ibm-ahub-byok: true + /api/business-monitoring/business-perspectives/{id}: + delete: + operationId: deleteBusinessPerspective + parameters: + - in: path + name: id + required: true + schema: + type: string + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - Default + summary: Delete business perspective + tags: + - Business Monitoring + x-ibm-ahub-byok: true + get: + operationId: getBusinessPerspective + parameters: + - in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: gBwNFIbjS6Ozwt0a12regg + label: biz-perspective + name: biz-perspective + description: This is an example business perspective + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: OR + elements: + - type: TAG_FILTER + name: service.id + stringValue: my-service-1 + numberValue: null + booleanValue: null + key: null + value: my-service-1 + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: service.id + stringValue: my-service-2 + numberValue: null + booleanValue: null + key: null + value: my-service-2 + operator: EQUALS + entity: DESTINATION + schema: + $ref: '#/components/schemas/BusinessPerspectiveConfig' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get business perspective + tags: + - Business Monitoring + x-ibm-ahub-byok: true + put: + operationId: updateBusinessPerspective + parameters: + - in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + label: biz-perspective + name: biz-perspective + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: OR + elements: + - type: TAG_FILTER + name: service.id + stringValue: my-service-1 + numberValue: null + booleanValue: null + key: null + value: my-service-1 + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: service.id + stringValue: my-service-2 + numberValue: null + booleanValue: null + key: null + value: my-service-2 + operator: EQUALS + entity: DESTINATION + schema: + $ref: '#/components/schemas/UpdatedBusinessPerspectiveConfig' + required: true + x-payload: updateBusinessPerspective + responses: + '200': + content: + application/json: + example: + id: gBwNFIbjS6Ozwt0a12regg + label: biz-perspective + name: biz-perspective + description: This is an example business perspective + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: AND + elements: + - type: EXPRESSION + logicalOperator: OR + elements: + - type: TAG_FILTER + name: service.id + stringValue: my-service-1 + numberValue: null + booleanValue: null + key: null + value: my-service-1 + operator: EQUALS + entity: DESTINATION + - type: TAG_FILTER + name: service.id + stringValue: my-service-2 + numberValue: null + booleanValue: null + key: null + value: my-service-2 + operator: EQUALS + entity: DESTINATION + schema: + $ref: '#/components/schemas/BusinessPerspectiveConfig' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Update business perspective + tags: + - Business Monitoring + x-description: updateBusinessPerspective + x-ibm-ahub-byok: true + /api/business-monitoring/catalog: + get: + operationId: getBusinessTagCatalog + parameters: + - in: query + name: from + schema: + type: integer + format: int64 + - in: query + name: useCase + schema: + type: string + enum: + - GROUPING + - FILTERING + - SERVICE_MAPPING + - SMART_ALERTS + - SMART_ALERTS_LOGS + - SMART_ALERTS_ADAPTIVE_BASELINE + - SMART_ALERTS_CUSTOM_PAYLOAD + - SLI_MANAGEMENT + - APPLICATION_CONFIG + - APPLICATION_CONFIG_BLUEPRINT + - MAINTENANCE_WINDOWS + - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + responses: + '200': + content: + application/json: + example: + tagTree: + - label: Region or Environment + description: null + icon: null + children: + - label: Zone + description: null + icon: null + children: + - label: Agent Zone + tagName: agent.zone + type: TAG + - label: Ec2 Zone + tagName: aws.ec2.zone + type: TAG + - label: Azure Zone + tagName: azure.zone + type: TAG + type: LEVEL + queryable: false + - label: Cloud + description: null + icon: null + children: + - label: Aws Arn + tagName: aws.arn + type: TAG + - label: Ec2 Ipv4 + tagName: aws.ec2.ipv4 + type: TAG + - label: Ec2 PublicName + tagName: aws.ec2.publicName + type: TAG + - label: Ec2 Tag + tagName: aws.ec2.tag + type: TAG + - label: Ec2 Zone + tagName: aws.ec2.zone + type: TAG + - label: Ecs Cluster Name + tagName: aws.ecs.cluster.name + type: TAG + - label: Azure Zone + tagName: azure.zone + type: TAG + - label: Gce Tag + tagName: gce.tag + type: TAG + - label: Gce Zone + tagName: gce.zone + type: TAG + - label: Cloud Provider + tagName: cloud.provider + type: TAG + type: LEVEL + queryable: false + - label: Host + description: null + icon: null + children: + - label: Http Host + tagName: call.http.host + type: TAG + - label: Host Fqdn + tagName: host.fqdn + type: TAG + - label: Host Ip + tagName: host.ip + type: TAG + - label: Host Name + tagName: host.name + type: TAG + - label: Host Zone + tagName: host.zone + type: TAG + - label: Jboss Node Name + tagName: jboss.node.name + type: TAG + - label: Kubernetes Cluster Name + tagName: kubernetes.cluster.name + type: TAG + - label: Kubernetes Node Name + tagName: kubernetes.node.name + type: TAG + type: LEVEL + queryable: false + type: LEVEL + queryable: false + - label: custom + description: null + icon: null + children: + - label: HTTP + description: null + icon: null + children: + - label: Http Header + tagName: call.http.header + type: TAG + - label: Http Params + tagName: call.http.params + type: TAG + - label: Http PathTemplate + tagName: call.http.pathTemplate + type: TAG + type: LEVEL + queryable: false + - label: Miscellaneous + description: null + icon: null + children: + - label: Agent Tag + tagName: agent.tag + type: TAG + - label: Ec2 Tag + tagName: aws.ec2.tag + type: TAG + - label: Call Tag + tagName: call.tag + type: TAG + type: LEVEL + queryable: false + - label: Platform + description: null + icon: null + children: + - label: Docker Label + tagName: docker.label + type: TAG + - label: Kubernetes Label + tagName: kubernetes.label + type: TAG + - label: Kubernetes Deployment Label + tagName: kubernetes.deployment.label + type: TAG + - label: Kubernetes Pod Label + tagName: kubernetes.pod.label + type: TAG + - label: Openshift Deploymentconfig Label + tagName: openshift.deploymentconfig.label + type: TAG + type: LEVEL + queryable: false + type: LEVEL + queryable: false + tags: [ + ] + schema: + $ref: '#/components/schemas/TagCatalog' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get business tag catalog + tags: + - Business Monitoring + x-description: getBusinessTagCatalog + x-ibm-ahub-byok: true + /api/custom-dashboard: + get: + description: |- + Get all accessible custom dashboards details. + For more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards. + operationId: getCustomDashboards + parameters: + - description: query + example: BeeInstana + in: query + name: query + schema: + type: string + - description: pageSize + example: 2 + in: query + name: pageSize + schema: + type: integer + format: int32 + - description: page + example: 1 + in: query + name: page + schema: + type: integer + format: int32 + - description: withTotalHits + example: false + in: query + name: withTotalHits + schema: + type: boolean + responses: + '200': + content: + application/json: + example: + - id: gBtvG96xRpScauwsclG-KA + title: BeeInstana - aggregator + annotations: + - SHARED + - id: UtaUyPjGSTOAmPFICSbwqw + title: BeeInstana - alerting + annotations: + - SHARED + schema: + type: array + items: + $ref: '#/components/schemas/CustomDashboardPreview' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get accessible custom dashboards + tags: + - Custom Dashboards + x-ibm-ahub-byok: true + post: + description: |2- + + For more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards. + operationId: addCustomDashboard + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomDashboard' + x-payload: customDashboard + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomDashboard' + description: OK + '403': + description: When attempting to share dashboards without the canCreatePublicCustomDashboards + permission. + '422': + description: When the custom dashboard payload is invalid. + security: + - ApiKeyAuth: + - Default + summary: Add custom dashboard + tags: + - Custom Dashboards + x-ibm-ahub-byok: true + /api/custom-dashboard/shareable-api-tokens: + get: + description: |- + Get all API tokens that have access to shareable custom dashboards. + For more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards. + operationId: getShareableApiTokens + responses: + '200': + content: + application/json: + example: + - id: foJfJVpyS5eAQAhfxSRctw + name: New API Token + - id: O_OKWG48S2WemaL_e3j_vQ + name: New API Token + - id: ATBzggrzTE-aRpUMBLmG9g + name: New API Token + schema: + type: array + items: + $ref: '#/components/schemas/DashboardApiToken' + description: OK + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - CreatePublicCustomDashboards + summary: Get all API tokens. + tags: + - Custom Dashboards + x-ibm-ahub-byok: true + /api/custom-dashboard/shareable-users: + get: + description: |- + Get all users (without invitations) that have access to shareable custom dashboards. + For more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards. + operationId: getShareableUsers + responses: + '200': + content: + application/json: + example: + - id: 63721be55108940001ead6fa + email: JohnMcClane@instana.com + fullName: John McClane + - id: 6360a5ad034a430001c500d0 + email: HansGruber@instana.com + fullName: Hans Gruber + schema: + type: array + items: + $ref: '#/components/schemas/UserBasicResult' + description: OK + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - CreatePublicCustomDashboards + summary: Get all users (without invitations). + tags: + - Custom Dashboards + x-ibm-ahub-byok: true + /api/custom-dashboard/{customDashboardId}: + delete: + description: |2- + + For more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards. + operationId: deleteCustomDashboard + parameters: + - in: path + name: customDashboardId + required: true + schema: + type: string + responses: + '204': + description: Custom dashboard successfully removed + security: + - ApiKeyAuth: + - Default + summary: Remove custom dashboard + tags: + - Custom Dashboards + x-ibm-ahub-byok: true + get: + description: |- + Get all Custom Dashboard Info for specified customDashboardId. + For more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards. + operationId: getCustomDashboard + parameters: + - description: customDashboardId + example: alHaYV5aSkKku_wcg53teQ + in: path + name: customDashboardId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: | + { + "id": "alHaYV5aSkKku_wcg53teQ", + "title": "{string}", + "accessRules": [ + { + "accessType": "READ_WRITE", + "relationType": "USER", + "relatedId": "5ee8a3e8cd70020001ecb007" + }, + { + "accessType": "READ", + "relationType": "GLOBAL", + "relatedId": null + } + ], + "widgets": [ + { + "id": "dIxxq0LCdqZomve2", + "title": "SUM of bytes received for a particular container", + "width": 2, + "height": 4, + "x": 0, + "y": 0, + "type": "bigNumber", + "config": { + "formatter": "bytes.detailed", + "comparisonDecreaseColor": "greenish", + "metricConfiguration": { + "metric": "network.rx.bytes", + "timeShift": 0, + "tagFilterExpression": { + "name": "docker.containerId", + "type": "TAG_FILTER", + "value": "faaa7f1732d16faa7fc27a0cb49fdf5c07716f3d3be1315e20f24d099657bbe0", + "entity": "NOT_APPLICABLE", + "operator": "EQUALS" + }, + "aggregation": "SUM", + "source": "INFRASTRUCTURE_METRICS", + "crossSeriesAggregation": "SUM", + "type": "docker" + }, + "comparisonIncreaseColor": "redish" + } + } + ], + "writable": true, + "ownerId": {string} + } + schema: + $ref: '#/components/schemas/CustomDashboardWithUserSpecificInformation' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get custom dashboard + tags: + - Custom Dashboards + x-ibm-ahub-byok: true + put: + description: |2- + + For more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#custom-dashboards. + operationId: updateCustomDashboard + parameters: + - in: path + name: customDashboardId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomDashboard' + x-payload: customDashboard + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomDashboard' + description: OK + '403': + description: When attempting to share dashboards without the canCreatePublicCustomDashboards + permission. + '422': + description: When the custom dashboard payload is invalid. + security: + - ApiKeyAuth: + - Default + summary: Update custom dashboard + tags: + - Custom Dashboards + x-ibm-ahub-byok: true + /api/custom-entitytypes: + get: + description: This end point lists custom Entity Type Definition + operationId: listCustomEntities + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEntityWithMetadata' + description: OK + security: + - ApiKeyAuth: + - Default + summary: List custom Entity Type Definition + tags: + - Custom Entities + x-ibm-ahub-byok: true + post: + description: This end point creates a custom entity type + operationId: createCustomEntities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEntityModel' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEntityWithMetadata' + description: OK + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureCustomEntities + summary: Create a Custom Entity type + tags: + - Custom Entities + x-ibm-ahub-byok: true + /api/custom-entitytypes/{id}: + delete: + description: This end point deletes a custom Entity type definition + operationId: deleteCustomEntity + parameters: + - in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEntityModel' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEntityWithMetadata' + description: Entity Deleted + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureCustomEntities + summary: Delete a Custom Entity Type + tags: + - Custom Entities + x-ibm-ahub-byok: true + get: + description: This endpoint gets custom Entity Type by ID + operationId: getCustomEntity + parameters: + - in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEntityWithMetadata' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get custom Entity Types + tags: + - Custom Entities + x-ibm-ahub-byok: true + put: + description: This end points updates the definition of a custom entity type + operationId: updateCustomEntity + parameters: + - in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEntityModel' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEntityWithMetadata' + description: OK + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureCustomEntities + summary: Update a Custom Entity Type + tags: + - Custom Entities + x-ibm-ahub-byok: true + /api/eum/impact/report/{eventId}: + get: + description: Gets a report of users impacted by an event which was created from + a smart alert violation + operationId: getImpactedUsersReport + parameters: + - in: path + name: eventId + required: true + schema: + type: string + responses: + '200': + content: + text/csv: { + } + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get impacted users report + tags: + - End User Monitoring + x-ibm-ahub-byok: true + /api/events: + get: + description: 'Get all Events within a timeframe. The timeframe is defined as + `[from, to]` or `[to - windowSize, to]`. ' + operationId: getEvents + parameters: + - description: A Unix timestamp representing the end of the requested timeframe. + Defaults to the current system time + example: 1704096000000 + in: query + name: to + schema: + type: integer + format: int64 + - description: The size of the requested timeframe, in milliseconds, relative + to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither + 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - + windowSize, to] + example: 600000 + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: A Unix timestamp representing the start of the requested timeframe. + Can be used as an alternative to 'windowSize' to define the timeframe. If + both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting + timeframe range = [from, to] + example: 1672560000000 + in: query + name: from + schema: + type: integer + format: int64 + - description: Flag to filter the results to only show events with state changes + within the timeframe. + example: true + in: query + name: filterEventUpdates + schema: + type: boolean + - description: Flag to filter the results to exclude events that have been triggered + before the timeframe. This also filters out events with state changes within + the timeframe if the events' start times begin before the timeframe. + example: true + in: query + name: excludeTriggeredBefore + schema: + type: boolean + - deprecated: true + description: Flag to filter the results to include Agent Monitoring Issues. + example: true + in: query + name: includeAgentMonitoringIssues + schema: + type: boolean + - deprecated: true + description: Flag to filter the results to include Kubernetes Info Events. + example: true + in: query + name: includeKubernetesInfoEvents + schema: + type: boolean + - description: A string representing an event type - an INCIDENT, ISSUE, or + CHANGE. This query can be repeated to use multiple filters. + example: INCIDENT + in: query + name: eventTypeFilters + schema: + type: array + items: + type: string + enum: + - INCIDENT + - ISSUE + - CHANGE + uniqueItems: true + responses: + '200': + content: + application/json: + example: + - eventId: gM73SycATrOFMcL5qspByQ + start: 1706774419000 + end: 1706783931000 + type: incident + state: open + problem: New Event-test-01 + detail: test + severity: 5 + entityName: .NET App + entityLabel: powershell.exe + metrics: + - metricName: threads.lck_crs + snapshotId: zqEuPom1v7YK61jRU8cEpRhCI1w + entityId: + steadyId: '55428' + pluginId: com.instana.forge.infrastructure.runtime.clr.ClrRuntimePlatform + host: 00:15:5d:ff:fe:98:d1:f6 + entityType: INFRASTRUCTURE + fixSuggestion: test + snapshotId: zqEuPom1v7YK61jRU8cEpRhCI1w + recentEvents: + - eventId: ZzaptuusSOutGLGmqD-wzA + - eventId: oeqTbltKQw6pp1OJi_QH_Q + - eventId: Cnv-8y96SOW2CzZbn7SK7Q + - eventId: vidr6ZX9QmqhtdvBrYFR3Q + - eventId: NWfYJEUjSLSPJbxfCEW6kA + - eventId: iJ2Bm8Y5Qq-Fh-IAwAnRqQ + - eventId: kHiCKKByTdW0sMhhjxvgQg + - eventId: w-hl_-8NQXKEIemcNR5ouw + - eventId: Vn0weJOGROaFKwRtqNDaeg + - eventId: Z9yz38EOR3aR0rYlBN3oRQ + - eventId: h7-N1PT9Sim4dCbyM-sf3g + - eventId: nnWCZ2L2STi8lXFbPNUgUg + - eventId: j1NlsfUYTz69t3dqSMekPQ + probableCause: [ + ] + probableCauseMetadata: { + } + schema: + type: array + items: + $ref: '#/components/schemas/EventResult' + description: OK + '400': + description: Bad request. + security: + - ApiKeyAuth: + - Default + summary: Get all Events + tags: + - Events + x-ibm-ahub-byok: true + post: + description: 'Gets a set of events by their IDs. ' + operationId: getEventsByIds + requestBody: + content: + application/json: + example: + - VOMNl0OgRv2HXlsR0iUYGg + - h66yezD9Sfi5YNh_cmeG7Q + schema: + type: array + items: + type: string + required: true + responses: + '200': + content: + application/json: + example: + - eventId: VOMNl0OgRv2HXlsR0iUYGg + start: 1722027687446 + end: 1722028317446 + type: issue + state: open + problem: Calls are slower than usual + detail: Calls are slower or equal to 50 ms based on latency (90th). + severity: 5 + entityName: Endpoint + entityLabel: POST /integration/slack/event + metrics: + - metricAggregation: P90 + metricName: latency + entityType: ENDPOINT + fixSuggestion: Calls are slower or equal to 50 ms based on latency + (90th). + snapshotId: A-fDmFeA5Mzl3yIs8hXs5Megwz8 + endpointId: A-fDmFeA5Mzl3yIs8hXs5Megwz8 + endpointServiceId: fc3b86a089d24ed3b7d50ac3a7639c682101d6b9 + applicationId: qOlcrsSlS_eWLGnBjooqWA + - eventId: h66yezD9Sfi5YNh_cmeG7Q + start: 1721764921276 + end: 1722028014839 + type: issue + state: open + problem: _RP Static camunda Archive Invoice for k8s-demo + detail: Calls are slower or equal to the expectation based on latency + (90th). + severity: 5 + entityName: Endpoint + entityLabel: Archive Invoice + metrics: + - metricAggregation: P90 + metricName: latency + entityType: ENDPOINT + fixSuggestion: Calls are slower or equal to the expectation based + on latency (90th). + snapshotId: MN1thidNpDc15zM-NP4ilfJs87k + endpointId: MN1thidNpDc15zM-NP4ilfJs87k + endpointServiceId: 1f0ee2b46a33c2dbfedfec9c45ad81ff1c8e7e37 + applicationId: acfRC1IqTVi41OMLAJU4Cw + schema: + type: array + items: + $ref: '#/components/schemas/EventResult' + description: OK + '206': + description: Some of the requested events do not exist. + '422': + description: Unprocessable entity. + security: + - ApiKeyAuth: + - Default + summary: Get Events by IDs + tags: + - Events + x-ibm-ahub-byok: true + /api/events/agent-monitoring-events: + get: + description: 'Gets all Agent Monitoring Events within a timeframe. The timeframe + is defined as `[from, to]` or `[to - windowSize, to]`. ' + operationId: agentMonitoringEvents + parameters: + - description: A Unix timestamp representing the end of the requested timeframe. + Defaults to the current system time + example: 1704096000000 + in: query + name: to + schema: + type: integer + format: int64 + - description: The size of the requested timeframe, in milliseconds, relative + to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither + 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - + windowSize, to] + example: 600000 + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: A Unix timestamp representing the start of the requested timeframe. + Can be used as an alternative to 'windowSize' to define the timeframe. If + both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting + timeframe range = [from, to] + example: 1672560000000 + in: query + name: from + schema: + type: integer + format: int64 + - description: Flag to filter the results to only show events with state changes + within the timeframe. + example: true + in: query + name: filterEventUpdates + schema: + type: boolean + - description: Flag to filter the results to exclude events that have been triggered + before the timeframe. This also filters out events with state changes within + the timeframe if the events' start times begin before the timeframe. + example: true + in: query + name: excludeTriggeredBefore + schema: + type: boolean + responses: + '200': + content: + application/json: + example: + - eventId: n8DamRZKSs6Z2f0wiZ9tVQ + start: 1707472014671 + end: 1707472674671 + type: agent_monitoring_issue + state: open + problem: 'Monitoring issue: jvm_attach_generic' + detail: 'Our Agent observed a problem with monitoring the linked process. + To resolve this issue, please check our docs (https://www.instana.com/docs/) + for error code: jvm_attach_generic' + severity: 5 + entityName: Process + entityLabel: java + entityType: INFRASTRUCTURE + fixSuggestion: 'Our Agent observed a problem with monitoring the linked + process. To resolve this issue, please check our docs (https://www.instana.com/docs/) + for error code: jvm_attach_generic' + snapshotId: 2fDFOytDpF4FYKrTdfwdlklDOPY + schema: + type: array + items: + $ref: '#/components/schemas/EventResult' + description: OK + '404': + description: The events do not exist in the timeframe. + security: + - ApiKeyAuth: + - Default + summary: Get Agent Monitoring Events + tags: + - Events + x-ibm-ahub-byok: true + /api/events/kubernetes-info-events: + get: + description: 'Gets all Kubernetes Info Events within a timeframe. The timeframe + is defined as `[from, to]` or `[to - windowSize, to]`. ' + operationId: kubernetesInfoEvents + parameters: + - description: A Unix timestamp representing the end of the requested timeframe. + Defaults to the current system time + example: 1704096000000 + in: query + name: to + schema: + type: integer + format: int64 + - description: The size of the requested timeframe, in milliseconds, relative + to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither + 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - + windowSize, to] + example: 600000 + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: A Unix timestamp representing the start of the requested timeframe. + Can be used as an alternative to 'windowSize' to define the timeframe. If + both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting + timeframe range = [from, to] + example: 1672560000000 + in: query + name: from + schema: + type: integer + format: int64 + - description: Flag to filter the results to only show events with state changes + within the timeframe. + example: true + in: query + name: filterEventUpdates + schema: + type: boolean + - description: Flag to filter the results to exclude events that have been triggered + before the timeframe. This also filters out events with state changes within + the timeframe if the events' start times begin before the timeframe. + example: true + in: query + name: excludeTriggeredBefore + schema: + type: boolean + responses: + '200': + content: + application/json: + example: + - eventId: nOYcBAncQIyZHdVNnBRmzQ + start: 1707472297000 + end: 1707472297000 + type: change + state: closed + problem: BackOff + detail: Back-off pulling image "gcr.io/kubernetes-helm/tiller:v2.14.1" + severity: -2 + entityName: Kubernetes Pod + entityLabel: kube-system/tiller-deploy-7bf78cdbf7-gnjg5 (pod) + entityType: INFRASTRUCTURE + fixSuggestion: Back-off pulling image "gcr.io/kubernetes-helm/tiller:v2.14.1" + snapshotId: wTRNW3DaFeQhk7G3Cx5bKC5Psgk + schema: + type: array + items: + $ref: '#/components/schemas/EventResult' + description: OK + '404': + description: The events do not exist in the timeframe. + security: + - ApiKeyAuth: + - Default + summary: Get Kubernetes Info Events + tags: + - Events + x-ibm-ahub-byok: true + /api/events/settings/alertingChannels: + get: + description: Gets all the alerting channels. Requires the permission called + CanConfigureIntegrations. + operationId: getAlertingChannels + parameters: + - description: List of IDs of alert channels defined in Instana. Can be left + empty. + example: '[YbcFlaG8k5oIkxD0, OYcbU9gdP6OTBThJ, qbhfsL9vTtlaBOAt]' + in: query + name: ids + schema: + type: array + items: + type: string + uniqueItems: true + responses: + '200': + content: + application/json: + example: + - id: 18iiwkDxHD7_A4mIlouise + name: Email Alert Channel + customEmailSubjectPrefix: null + emails: + - youremail@email.com + kind: EMAIL + - id: 1pFirIMvrZk9NO2R + name: Stan Test Slack Channel + webhookUrl: https://hooks.slack.com/testwebhook + iconUrl: '' + channel: team-stan-test-channel + emojiRendering: false + kind: SLACK + schema: + type: array + items: + $ref: '#/components/schemas/AbstractIntegration' + description: OK + security: + - ApiKeyAuth: + - CanConfigureIntegrations + summary: Get all Alerting Channels + tags: + - Event Settings + x-ibm-ahub-byok: true + post: + description: Creates an alerting channel. Requires the permission called CanConfigureIntegrations. + operationId: postAlertingChannel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AbstractIntegration' + required: true + responses: + '200': + content: + application/json: + example: + id: 18iiwkDxHD7_A4mIlouise + name: Email Alert Channel + customEmailSubjectPrefix: null + emails: + - youremail@email.com + kind: EMAIL + schema: + $ref: '#/components/schemas/AbstractIntegration' + description: created the alert channel setting + '302': + description: 'Redirect to the integration service for continuing the configuration + with the 3rd party system ' + '400': + content: + application/json: + schema: + type: string + description: Failed creating the alert channel setting + security: + - ApiKeyAuth: + - CanConfigureIntegrations + summary: Create Alert Channel + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/alertingChannels/infos: + get: + description: Gets the overview information of all alerting channels. Requires + the permission called CanConfigureIntegrations. + operationId: getAlertingChannelsOverview + parameters: + - description: List of IDs of alert channels defined in Instana. Can be left + empty. + example: '[YbcFlaG8k5oIkxD0, OYcbU9gdP6OTBThJ, qbhfsL9vTtlaBOAt]' + in: query + name: ids + schema: + type: array + items: + type: string + uniqueItems: true + responses: + '200': + content: + application/json: + example: + - id: qbhfsL9vTtlaBOAt + kind: WEB_HOOK + name: alert-response-generic-webhook + properties: { + } + - id: V_gYaoRFPe6S-T-l + kind: OPS_GENIE + name: OpsGenie QA + properties: + Alias: '' + Tags: k8s-test + schema: + type: array + items: + $ref: '#/components/schemas/IntegrationOverview' + description: OK + security: + - ApiKeyAuth: + - CanConfigureIntegrations + summary: Get Overview of Alerting Channels + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/alertingChannels/notify/{id}: + post: + description: Sends alert for a specific event to an alerting channel. Provided + the event Id, an alert could be sent to the alerting channel. This endpoint + requires `canInvokeAlertChannel` permission. + operationId: sendTestAlertingById + parameters: + - description: ID of the alerting channel to be notified on. + example: YbcFlaG8k5oIkxD0 + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ManualAlertingChannelConfiguration' + required: true + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - CanConfigureIntegrations + summary: Notify manually to Alerting Channel. Requires the permission called + CanConfigureIntegrations. + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/alertingChannels/test: + put: + description: Sends a test alert to an alert channel. This is for testing if + an potential alert channel is able to receive alerts from Instana. Requires + the permission called CanConfigureIntegrations. + operationId: sendTestAlerting + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AbstractIntegration' + x-example: alertingChannelTestCall + required: true + responses: + '200': + content: + application/json: + examples: + Failure: + description: Failure + value: + status: failure + message: Alerting channel was unsuccessful. + Success: + description: Success + value: + status: success + message: Alerting Channel was successfully triggered, please check + the channel! + description: Test alerting channel response + security: + - ApiKeyAuth: + - CanConfigureIntegrations + summary: Test Alerting Channel + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/alertingChannels/{id}: + delete: + description: Deletes an alert channel. Requires the permission called CanConfigureIntegrations. + operationId: deleteAlertingChannel + parameters: + - description: ID of the Alerting Channel to delete. + example: YbcFlaG8k5oIkxD0 + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + security: + - ApiKeyAuth: + - CanConfigureIntegrations + summary: Delete Alerting Channel + tags: + - Event Settings + x-ibm-ahub-byok: true + get: + description: Gets an alerting channel. Requires the permission called CanConfigureIntegrations. + operationId: getAlertingChannel + parameters: + - description: ID of the Alerting Channel to get. + example: YbcFlaG8k5oIkxD0 + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: 18iiwkDxHD7_A4mIlouise + name: Email Alert Channel + customEmailSubjectPrefix: null + emails: + - youremail@email.com + kind: EMAIL + schema: + $ref: '#/components/schemas/AbstractIntegration' + description: OK + security: + - ApiKeyAuth: + - CanConfigureIntegrations + summary: Get Alerting Channel + tags: + - Event Settings + x-ibm-ahub-byok: true + put: + description: Updates an alerting channel. Requires the permission called CanConfigureIntegrations. + operationId: putAlertingChannel + parameters: + - description: ID of the Alerting Channel to update. + example: YbcFlaG8k5oIkxD0 + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AbstractIntegration' + required: true + responses: + '200': + content: + application/json: + example: + id: 18iiwkDxHD7_A4mIlouise + name: Email Alert Channel + customEmailSubjectPrefix: null + emails: + - youremail@email.com + kind: EMAIL + schema: + $ref: '#/components/schemas/AbstractIntegration' + description: Updated the alert channel setting + '302': + description: 'Redirect to the integration service for continuing the configuration + with the 3rd party system ' + '400': + content: + application/json: + schema: + type: string + description: Failed updating the alert channel setting + security: + - ApiKeyAuth: + - CanConfigureIntegrations + summary: Update Alert Channel + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/alerts: + get: + description: Gets all Alert Configurations + operationId: getAlerts + responses: + '200': + content: + application/json: + example: + - id: 5GJXiK9aciVaBPnu + alertName: CMH Alert Test + muteUntil: 9007199254740991 + integrationIds: + - GcqLyri-worP8sXX + eventFilteringConfiguration: + query: entity.host.fqdn:robot-shop-pink1.fyre.ibm.com + ruleIds: + - roILHzyaMBRDZE3FxaeZ5T_wx4Q + eventTypes: [ + ] + applicationAlertConfigIds: [ + ] + validVersion: 1 + customPayloadFields: + - type: staticString + key: cmhtest + value: cmhval + lastUpdated: 1702590551696 + invalid: false + alertChannelNames: + - CMH Email test + applicationNames: [ + ] + - id: E8Z88ThbA7RDPgbz + alertName: SQL Server Write txns Alert + muteUntil: 0 + integrationIds: + - Hrigl1epXxAc0Tym + eventFilteringConfiguration: + query: null + ruleIds: + - v1jc5yEjHRNbX8_i + eventTypes: [ + ] + applicationAlertConfigIds: [ + ] + validVersion: 1 + customPayloadFields: [ + ] + lastUpdated: 1702590551748 + invalid: false + alertChannelNames: + - Servicenow Webhook Sunny + applicationNames: [ + ] + - id: Z9eXY8LOfTuAf43e + alertName: IBM i All Alerts + muteUntil: 0 + integrationIds: [ + ] + eventFilteringConfiguration: + query: entity.ibmi.os.hostname:ut31p37.rch.stglabs.ibm.com AND event.text:* + ruleIds: [ + ] + eventTypes: + - warning + applicationAlertConfigIds: [ + ] + validVersion: 1 + customPayloadFields: [ + ] + lastUpdated: 1704894496752 + invalid: false + alertChannelNames: [ + ] + applicationNames: [ + ] + schema: + type: array + items: + $ref: '#/components/schemas/ValidatedAlertingConfiguration' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Get all Alert Configurations + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/alerts/infos: + get: + description: Gets all alert configurations that relate to the given alert channel. + operationId: getAlertingConfigurationInfos + parameters: + - description: ID of a specific alert channel configuration. + example: hu6ynJbwgB4X1rjk + in: query + name: integrationId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: Xt67tttZF4yzemPQ + label: Production Availability Alerts + query: entity.zone:prod + eventTypes: [ + ] + selectedEvents: 2 + enabled: true + type: Alert + entityId: null + invalid: false + - id: wNbFtdyvQgeA4k8JdBSsyA + label: Database Cluster Alerts + query: null + eventTypes: null + selectedEvents: null + enabled: false + type: ApplicationSmartAlert + entityId: mwVo3lG-TD-4ssDa3w0pGA + invalid: false + schema: + type: array + items: + $ref: '#/components/schemas/ValidatedAlertingChannelInputInfo' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: All alerting configuration info + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/alerts/{id}: + delete: + description: Delete a specific Alert Configuration by ID + operationId: deleteAlert + parameters: + - description: ID of a specific Alert Configuration to delete. + example: hu6ynJbwgB4X1rjkkw + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Delete Alert Configuration + tags: + - Event Settings + x-ibm-ahub-byok: true + get: + description: Get a specific Alert Configuration by ID. + operationId: getAlert + parameters: + - description: ID of a specific Alert Configuration to retrieve. + example: iSjG7UWK3Dy6bDUc + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: iSjG7UWK3Dy6bDUc + alertName: test-email-alert + muteUntil: 0 + integrationIds: + - B1PdA6BUdA9JJRZG + eventFilteringConfiguration: + query: event.text:*BRUCE* + ruleIds: [ + ] + eventTypes: + - warning + - incident + - critical + applicationAlertConfigIds: [ + ] + validVersion: 1 + customPayloadFields: [ + ] + lastUpdated: 1718828552918 + schema: + $ref: '#/components/schemas/AlertingConfigurationWithLastUpdated' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Get Alert Configuration + tags: + - Event Settings + x-ibm-ahub-byok: true + put: + description: Create or update a specific Alert configuration by ID + operationId: putAlert + parameters: + - description: ID of a specific Alert Configuration to create or update. + example: hu6ynJbwgB4X1rjk + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + id: hu6ynJbwgB4X1rjk + alertName: Alerts Test + muteUntil: 9007199254740991 + integrationIds: + - ctCR9Q373YAY27H_ + - wyAPFbP_xZCeEUn6 + - M01h5MDfb7YVQPAz + - BH4nVcoPdSpJH_4U + - ldF14o6dCKmQFJxP + - IbQkmZ46_oUGV-L7 + - wpWi9SYL7cJOu_UZ + - ds1Lpvix2WVoWTKg + eventFilteringConfiguration: + query: null + ruleIds: [ + ] + eventTypes: + - incident + - critical + applicationAlertConfigIds: [ + ] + validVersion: 1 + customPayloadFields: + - type: staticString + key: assignment_group + value: ITSM App-Dev + - type: staticString + key: category + value: Software + - type: staticString + key: change_test + value: test kevin + - type: staticString + key: assigned_to + value: Antony Alldis + schema: + $ref: '#/components/schemas/AlertingConfiguration' + required: true + responses: + '200': + content: + application/json: + example: + id: hu6ynJbwgB4X1rjk + alertName: Alerts Test + muteUntil: 0 + integrationIds: + - ctCR9Q373YAY27H_ + - wyAPFbP_xZCeEUn6 + - M01h5MDfb7YVQPAz + - BH4nVcoPdSpJH_4U + - ldF14o6dCKmQFJxP + - IbQkmZ46_oUGV-L7 + - wpWi9SYL7cJOu_UZ + - ds1Lpvix2WVoWTKg + eventFilteringConfiguration: + query: null + ruleIds: [ + ] + eventTypes: + - incident + - critical + applicationAlertConfigIds: [ + ] + validVersion: 1 + customPayloadFields: + - type: staticString + key: assignment_group + value: ITSM App-Dev + - type: staticString + key: category + value: Software + - type: staticString + key: change_test + value: test kevin + - type: staticString + key: assigned_to + value: Antony Alldis + schema: + $ref: '#/components/schemas/AlertingConfigurationWithLastUpdated' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable request - missing/invalid data. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Create or update Alert Configuration + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/application-alert-configs: + get: + description: |- + Gets all the Smart Alert Configurations pertaining to a specific application. Configurations are sorted by creation date in descending order. + For more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration. + operationId: findAllActiveApplicationAlertConfigs + parameters: + - description: The ID of a specific Application. + example: IYS1XOEcTNiT1eOD8pxgXg + in: query + name: applicationId + required: true + schema: + type: string + - description: A list of Smart Alert Configuration IDs. This allows fetching + of a specific set of Configurations. This query can be repeated to use multiple + IDs. + example: IYS1XOEcTNiT1eOD8pxgXg + in: query + name: alertIds + schema: + type: array + items: + type: string + maxItems: 1000 + minItems: 0 + uniqueItems: true + responses: + '200': + content: + application/json: + example: + - name: Erroneous call rate is higher than normal + description: The erroneous call rate is higher or equal to 4%. + boundaryScope: ALL + applicationId: IYS1XOEcTNiT1eOD8pxgXg + applications: + IYS1XOEcTNiT1eOD8pxgXg: + applicationId: IYS1XOEcTNiT1eOD8pxgXg + inclusive: true + services: { + } + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + includeInternal: false + includeSynthetic: false + rule: + alertType: errors + metricName: errors + aggregation: MEAN + threshold: + type: staticThreshold + operator: '>=' + value: 0.04 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + id: A5VvSXR_SVG6z7YbnIHiHQ + created: 1707751873882 + initialCreated: 1707751873882 + readOnly: false + enabled: true + derivedFromGlobalAlert: false + schema: + type: array + items: + $ref: '#/components/schemas/ApplicationAlertConfigWithMetadata' + description: OK - Returns an empty list if no configurations match the criteria + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - Default + summary: Get all Smart Alert Configs + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + post: + description: |- + Creates a new Smart Alert Configuration. + For more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration. + operationId: createApplicationAlertConfig + requestBody: + content: + application/json: + example: + name: Calls are slower than usual + description: Calls are slower or equal to the expectation based on latency + (90th). + boundaryScope: INBOUND + applicationId: ZOi0te_ERE-mRm-9zsbwdg + applications: + ZOi0te_ERE-mRm-9zsbwdg: + applicationId: ZOi0te_ERE-mRm-9zsbwdg + inclusive: true + services: { + } + severity: 5 + triggering: false + tagFilterExpression: + type: TAG_FILTER + name: endpoint.name + stringValue: null + numberValue: null + booleanValue: null + key: null + value: null + operator: NOT_EMPTY + entity: DESTINATION + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 1 + - 3 + - - 600000 + - 1 + - 3 + deviationFactor: 3 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + schema: + $ref: '#/components/schemas/ApplicationAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: Calls are slower than usual + description: Calls are slower or equal to the expectation based on + latency (90th). + boundaryScope: INBOUND + applicationId: ZOi0te_ERE-mRm-9zsbwdg + applications: + ZOi0te_ERE-mRm-9zsbwdg: + applicationId: ZOi0te_ERE-mRm-9zsbwdg + inclusive: true + services: { + } + severity: 5 + triggering: false + tagFilterExpression: + type: TAG_FILTER + name: endpoint.name + stringValue: null + numberValue: null + booleanValue: null + key: null + value: null + operator: NOT_EMPTY + entity: DESTINATION + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 1 + - 3 + - - 600000 + - 1 + - 3 + deviationFactor: 3 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + id: DKp0JArJRAiQIav9CoKSWQ + created: 1706617456952 + initialCreated: 1706617456952 + readOnly: false + enabled: true + derivedFromGlobalAlert: false + schema: + $ref: '#/components/schemas/ApplicationAlertConfigWithMetadata' + description: Smart Alert Configuration created. + '400': + description: Invalid Configuration. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable entity. + '428': + description: Baseline calculation failed due to insufficient data. + security: + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts + summary: Create Smart Alert Config + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/application-alert-configs/{id}: + delete: + description: |- + Deletes an Smart Alert Configuration. + For more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration. + operationId: deleteApplicationAlertConfig + parameters: + - description: ID of a specific Smart Alert Configuration to delete. + example: DKp0JArJRAiQIav9CoKSWQ + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Smart Alert Configuration deleted. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts + summary: Delete Smart Alert Config + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + get: + description: |- + Gets a specific Smart Alert Configuration. This may return a deleted Configuration. + For more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration. + operationId: findApplicationAlertConfig + parameters: + - description: ID of a specific Smart Alert Configuration to retrieve. + example: DKp0JArJRAiQIav9CoKSWQ + in: path + name: id + required: true + schema: + type: string + - description: 'A Unix timestamp representing a specific time the Configuration + was active. If no timestamp is provided, the latest active version will + be retrieved. ' + example: 1706617456952 + in: query + name: validOn + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + name: Calls are slower than usual + description: Calls are slower or equal to the expectation based on + latency (90th). + boundaryScope: INBOUND + applicationId: ZOi0te_ERE-mRm-9zsbwdg + applications: + ZOi0te_ERE-mRm-9zsbwdg: + applicationId: ZOi0te_ERE-mRm-9zsbwdg + inclusive: true + services: { + } + severity: 5 + triggering: false + tagFilterExpression: + type: TAG_FILTER + name: endpoint.name + stringValue: null + numberValue: null + booleanValue: null + key: null + value: null + operator: NOT_EMPTY + entity: DESTINATION + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 1 + - 3 + - - 600000 + - 1 + - 3 + deviationFactor: 3 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + id: DKp0JArJRAiQIav9CoKSWQ + created: 1706617456952 + initialCreated: 1706617456952 + readOnly: false + enabled: true + derivedFromGlobalAlert: false + schema: + $ref: '#/components/schemas/ApplicationAlertConfigWithMetadata' + description: OK + '403': + description: Insufficient permissions. + '404': + description: The requested Configuration does not exist. + security: + - ApiKeyAuth: + - Default + summary: Get Smart Alert Config + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + post: + description: |- + Updates an existing Smart Alert Configuration. + For more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration. + operationId: updateApplicationAlertConfig + parameters: + - description: ID of a specific Smart Alert Configuration to update. + example: DKp0JArJRAiQIav9CoKSWQ + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: Calls are slower than usual + description: Calls are slower or equal to the expectation based on latency + (90th). + boundaryScope: INBOUND + applicationId: ZOi0te_ERE-mRm-9zsbwdg + applications: + ZOi0te_ERE-mRm-9zsbwdg: + applicationId: ZOi0te_ERE-mRm-9zsbwdg + inclusive: true + services: { + } + severity: 5 + triggering: false + tagFilterExpression: + type: TAG_FILTER + name: endpoint.name + stringValue: null + numberValue: null + booleanValue: null + key: null + value: null + operator: NOT_EMPTY + entity: DESTINATION + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 1 + - 3 + - - 600000 + - 1 + - 3 + deviationFactor: 3 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + schema: + $ref: '#/components/schemas/ApplicationAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: Calls are slower than usual + description: Calls are slower or equal to the expectation based on + latency (90th). + boundaryScope: INBOUND + applicationId: ZOi0te_ERE-mRm-9zsbwdg + applications: + ZOi0te_ERE-mRm-9zsbwdg: + applicationId: ZOi0te_ERE-mRm-9zsbwdg + inclusive: true + services: { + } + severity: 5 + triggering: false + tagFilterExpression: + type: TAG_FILTER + name: endpoint.name + stringValue: null + numberValue: null + booleanValue: null + key: null + value: null + operator: NOT_EMPTY + entity: DESTINATION + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 1 + - 3 + - - 600000 + - 1 + - 3 + deviationFactor: 3 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + id: DKp0JArJRAiQIav9CoKSWQ + created: 1706617456952 + initialCreated: 1706617456952 + readOnly: false + enabled: true + derivedFromGlobalAlert: false + schema: + $ref: '#/components/schemas/ApplicationAlertConfigWithMetadata' + description: Smart Alert Configuration updated. + '204': + description: Smart Alert Configuration did not change. + '400': + description: Invalid Application ID provided. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable entity. + '428': + description: Baseline calculation failed due to insufficient data. + '500': + description: Internal error. + security: + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts + summary: Update Smart Alert Config + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/application-alert-configs/{id}/disable: + put: + description: |- + Disables an Smart Alert Configuration. + For more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration. + operationId: disableApplicationAlertConfig + parameters: + - description: ID of a specific Smart Alert Configuration to disable. + example: DKp0JArJRAiQIav9CoKSWQ + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Smart Alert Configuration disabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts + summary: Disable Smart Alert Config + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/application-alert-configs/{id}/enable: + put: + description: |- + Enables an Smart Alert Configuration. + For more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration. + operationId: enableApplicationAlertConfig + parameters: + - description: ID of a specific Smart Alert Configuration to enable. + example: DKp0JArJRAiQIav9CoKSWQ + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Smart Alert Configuration enabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts + summary: Enable Application Alert Config + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/application-alert-configs/{id}/restore/{created}: + put: + description: |- + Restores a deleted Smart Alert Configuration. + For more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration. + operationId: restoreApplicationAlertConfig + parameters: + - description: ID of a specific Smart Alert Configuration to restore. + example: DKp0JArJRAiQIav9CoKSWQ + in: path + name: id + required: true + schema: + type: string + - description: Unix timestamp representing the creation time of a specific Smart + Alert Configuration. + example: 1707726529124 + in: path + name: created + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Smart Alert Configuration restored. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration provided. + security: + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts + summary: Restore Smart Alert Config + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/application-alert-configs/{id}/update-baseline: + post: + description: |- + Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time. + For more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration. + operationId: updateApplicationHistoricBaseline + parameters: + - description: ID of a specific Smart Alert Configuration to recalculate. + example: DKp0JArJRAiQIav9CoKSWQ + in: path + name: id + required: true + schema: + type: string + responses: + '200': + description: Smart Alert Configuration baseline successfully recalculated + and updated. + '204': + description: Baseline recalculation completed with no changes needed. + '400': + description: Invalid configuration type or configuration is read-only. + '403': + description: Insufficient permissions to access this configuration. + '404': + description: Smart Alert Configuration not found. + '428': + description: Baseline calculation failed due to insufficient data. + security: + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts + summary: Recalculate Smart Alert Config Baseline + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/application-alert-configs/{id}/versions: + get: + description: |- + Gets all versions of an Smart Alert Configuration. This may return deleted Configurations. Configurations are sorted by creation date in descending order. + For more information on Application Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-alert-configuration. + operationId: findApplicationAlertConfigVersions + parameters: + - description: ID of a specific Smart Alert Configuration to retrieve. + example: DKp0JArJRAiQIav9CoKSWQ + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: DKp0JArJRAiQIav9CoKSWQ + created: 1706617456952 + enabled: true + deleted: false + changeSummary: + changeType: CREATE + author: + id: 5ee8a3e8cd70020001ecb007 + type: USER + fullName: Stan + schema: + type: array + items: + $ref: '#/components/schemas/ConfigVersion' + description: OK + '403': + description: Insufficient permissions. + '404': + description: The requested Configuration does not exist. + security: + - ApiKeyAuth: + - Default + summary: Get Smart Alert Config Versions + tags: + - Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/custom-payload-configurations: + delete: + description: Deletes a Global Custom Payload Configuration. + operationId: deleteCustomPayloadConfiguration + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureGlobalAlertPayload + summary: Delete Custom Payload Configuration + tags: + - Event Settings + x-ibm-ahub-byok: true + get: + description: Gets All Global Custom Payload Configurations. + operationId: getCustomPayloadConfigurations + parameters: + - in: query + name: context + schema: + type: string + default: ALL + description: The type of Smart Alert that the custom payload is associated + with. + enum: + - ALL + - APPLICATION + - WEBSITE + - SYNTHETIC + - MOBILE_APP + - INFRA + - LOG + responses: + '200': + content: + application/json: + example: + - fields: + - type: dynamic + key: zone + value: + tagName: agent.zone + key: app + - type: staticString + key: global_custom_payload + value: 42+1 + lastUpdated: 1723212859513 + schema: + $ref: '#/components/schemas/CustomPayloadWithVersion' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureGlobalAlertPayload + summary: Get All Global Custom Payload Configurations + tags: + - Event Settings + x-ibm-ahub-byok: true + put: + description: Creates or Updates Global Custom Payload Configuration. + operationId: upsertCustomPayloadConfiguration + requestBody: + content: + application/json: + example: + fields: + - type: staticString + key: string + value: customValue + - type: dynamic + key: string + value: + tagName: agent.zone + key: string + schema: + $ref: '#/components/schemas/CustomPayloadConfiguration' + required: true + responses: + '200': + content: + application/json: + example: + - fields: + - type: staticString + key: string + value: customValue + - type: dynamic + key: string + value: + tagName: agent.zone + key: string + lastUpdated: 1723212859513 + schema: + type: array + items: + $ref: '#/components/schemas/CustomPayloadWithLastUpdated' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '422': + description: Unable to process request, request data is invalid. + security: + - ApiKeyAuth: + - CanConfigureGlobalAlertPayload + summary: Create/Update Global Custom Payload Configuration + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/custom-payload-configurations/catalog: + get: + description: Custom payload tags used to filter, extract and aggregate specific + data like AP calls for alert notifications. The catalog defines available + tags like application.name and their types, and other attributes. + operationId: getCustomPayloadTagCatalog + responses: + '200': + content: + application/json: + example: + - tagTree: + - label: Agent + description: null + icon: null + children: + - label: Tag + icon: lib_views_tag + tagName: agent.tag + queryable: true + type: TAG + scoreBoost: null + type: LEVEL + queryable: false + tags: + - name: azure.appservice.name + label: App Service Name + type: STRING + description: null + canApplyToSource: true + canApplyToDestination: true + idTag: false + schema: + $ref: '#/components/schemas/TagCatalog' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureGlobalAlertPayload + summary: Get Tag Catalog for Custom Payload + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/custom-payload-configurations/v2: + put: + description: Creates or Updates Global Custom Payload Configuration. + operationId: upsertCustomPayloadConfigurationV2 + requestBody: + content: + application/json: + example: |2 + "fields": + [ + { + "type": "staticString", + "key": "string", + "value": "customValue" + }, + { + "type": "dynamic", + "key": "string", + "value": { + "tagName": "agent.zone", + "key": "string" + } + } + ], + "version": 1 + schema: + $ref: '#/components/schemas/CustomPayloadConfiguration' + required: true + responses: + '200': + content: + application/json: + example: + - fields: + - type: staticString + key: string + value: customValue + - type: dynamic + key: string + value: + tagName: agent.zone + key: string + lastUpdated: 1723212859513 + version: 1 + schema: + type: array + items: + $ref: '#/components/schemas/CustomPayloadWithVersion' + description: OK + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '409': + description: Version conflict. + '422': + description: Unable to process request, request data is invalid. + security: + - ApiKeyAuth: + - CanConfigureGlobalAlertPayload + summary: Create/Update Global Custom Payload Configuration + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/event-specifications/built-in: + get: + description: Get all built-in event specifications + operationId: getBuiltInEventSpecifications + parameters: + - in: query + name: ids + schema: + type: array + items: + type: string + uniqueItems: true + responses: + '200': + content: + application/json: + example: + - id: 5J-4V_gLWm-pofGW8BEoFU7C_6s + shortPluginId: otelHost + name: CPU spends significant time waiting for input/output + description: Assesses whether the system is spending a significant + amount of time waiting for input/output operations. + hyperParams: + - id: CsSGNuJ9MCsYvN5tXoWOPIWGiyM + name: Sliding Window + description: Sliding window + defaultValue: 60000 + minValue: 60000 + maxValue: 72000000 + valueFormat: MILLIS + - id: dfLU7K_vx1Qd8FrR4M1XAmiSM0w + name: Maximum wait percentage + description: Specifies the maximum allowable CPU wait percentage. + Metric values that exceed this threshold are deemed violations. + defaultValue: 0.25 + minValue: 0 + maxValue: 1 + valueFormat: PERCENTAGE + - id: eq_Y3yLA37aralhMCV1AYuEVVoA + name: Allowed CPU Wait violations + description: Specifies the number of permitted CPU Wait violations + within the given time window. + defaultValue: 9 + minValue: 0 + maxValue: 9223372036854776000 + valueFormat: NUMBER + ruleInputs: + - inputKind: METRIC + inputName: cpu.wait + severity: 5 + triggering: false + enabled: true + hidden: false + lastUpdated: 1729198411351 + - id: kLC5kTFUUM4HiMWEkqlggo6dF-s + shortPluginId: ibmCloudEventStream + name: Event Stream has more than the recommended number of connected + Kafka clients + description: Checks whether the number of connected Kafka clients + exceeds the recommended maximum + hyperParams: + - id: qkxsXUDoELI6cHEoWSXQ4FR8-8M + name: Kafka Max Connectd Clients Percent Severe + description: Kafka max connected clients percent critical threshold + defaultValue: 0.95 + minValue: 0 + maxValue: 1 + valueFormat: PERCENTAGE + - id: x00McJfR0Y2twIIE8Hf3oxoUEoE + name: Kafka Max Connectd Clients Percent Warning + description: Kafka max connected clients percent warning threshold + defaultValue: 0.9 + minValue: 0 + maxValue: 1 + valueFormat: PERCENTAGE + ruleInputs: + - inputKind: METRIC + inputName: kafka_recommended_max_connected_clients_percent + severity: 5 + triggering: false + enabled: true + hidden: false + lastUpdated: 1729198411681 + schema: + type: array + items: + $ref: '#/components/schemas/BuiltInEventSpecificationWithLastUpdated' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: All built-in event specification + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/event-specifications/built-in/{eventSpecificationId}: + delete: + operationId: deleteBuiltInEventSpecification + parameters: + - in: path + name: eventSpecificationId + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Delete built-in event specification + tags: + - Event Settings + x-ibm-ahub-byok: true + get: + operationId: getBuiltInEventSpecification + parameters: + - in: path + name: eventSpecificationId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BuiltInEventSpecification' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Built-in event specification not found + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Built-in event specifications + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/event-specifications/built-in/{eventSpecificationId}/disable: + post: + operationId: disableBuiltInEventSpecification + parameters: + - in: path + name: eventSpecificationId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BuiltInEventSpecificationWithLastUpdated' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Built-in event specification not found + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Disable built-in event specification + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/event-specifications/built-in/{eventSpecificationId}/enable: + post: + operationId: enableBuiltInEventSpecification + parameters: + - in: path + name: eventSpecificationId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/BuiltInEventSpecificationWithLastUpdated' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Built-in event specification not found + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Enable built-in event specification + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/event-specifications/custom: + get: + description: ' This API helps in getting all the custom event specifications.' + operationId: getCustomEventSpecifications + responses: + '200': + content: + application/json: + example: + - id: Yojfl6Yn9SXaFhJG + name: DP_Domain_MemoryUsage + entityType: ibmDataPowerDomain + query: null + triggering: true + description: Average Memory Usage for the DP Domain >= 0% + expirationTime: 60000 + enabled: true + rules: + - ruleType: threshold + metricName: currentMemUsage + metricPattern: null + rollup: 0 + window: 600000 + aggregation: avg + conditionOperator: '>=' + conditionValue: 0.0 + severity: 5 + ruleLogicalOperator: AND + lastUpdated: 1670404707763 + validVersion: 1 + actions: null + migrated: false + applicationAlertConfigId: null + deleted: false + schema: + type: array + items: + $ref: '#/components/schemas/CustomEventSpecificationWithLastUpdated' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: All custom event specifications + tags: + - Event Settings + x-ibm-ahub-byok: true + post: + operationId: postCustomEventSpecification + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEventSpecification' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEventSpecificationWithLastUpdated' + description: OK + '400': + description: 'Invalid request: unsupported entity type or incorrect query.' + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Create new custom event specification + tags: + - Event Settings + x-description: postCustomEventSpecification + x-ibm-ahub-byok: true + /api/events/settings/event-specifications/custom/systemRules: + get: + description: This API helps to get all the system rules for custom event specifications. + operationId: getSystemRules + responses: + '200': + content: + application/json: + example: + - id: entity.offline + name: Offline event detection (System Rule) + schema: + type: array + items: + $ref: '#/components/schemas/SystemRuleLabel' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: All system rules for custom event specifications + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/event-specifications/custom/{eventSpecificationId}: + delete: + operationId: deleteCustomEventSpecification + parameters: + - in: path + name: eventSpecificationId + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Delete custom event specification + tags: + - Event Settings + x-description: deleteCustomEventSpecification + x-ibm-ahub-byok: true + get: + description: This API helps to get the Custom Event specification for the given + ID. + operationId: getCustomEventSpecification + parameters: + - description: eventSpecificationId + example: Yojfl6Yn9SXaFhJG + in: path + name: eventSpecificationId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: Yojfl6Yn9SXaFhJG + name: DP_Domain_MemoryUsage + entityType: ibmDataPowerDomain + query: null + triggering: true + description: Average Memory Usage for the DP Domain >= 0% + expirationTime: 60000 + enabled: true + rules: + - ruleType: threshold + severity: 5 + metricName: currentMemUsage + rollup: 0 + window: 600000 + metricPattern: null + aggregation: avg + conditionOperator: '>=' + conditionValue: 0.0 + metricLabel: Current Memory Usage + metricFormat: PERCENTAGE + ruleLogicalOperator: AND + lastUpdated: 1670404707763 + validVersion: 1 + actions: null + migrated: false + applicationAlertConfigId: null + deleted: false + schema: + $ref: '#/components/schemas/CustomEventSpecificationWithLastUpdated' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Custom Event does not exist + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Custom event specification + tags: + - Event Settings + x-ibm-ahub-byok: true + put: + operationId: putCustomEventSpecification + parameters: + - in: path + name: eventSpecificationId + required: true + schema: + type: string + - in: query + name: allowRestore + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEventSpecification' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEventSpecificationWithLastUpdated' + description: OK + '400': + description: 'Invalid request: unsupported entity type, incorrect query, + or event is deleted or migrated.' + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Custom event cannot be updated. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Create or update custom event specification + tags: + - Event Settings + x-description: putCustomEventSpecification + x-ibm-ahub-byok: true + /api/events/settings/event-specifications/custom/{eventSpecificationId}/disable: + post: + operationId: disableCustomEventSpecification + parameters: + - in: path + name: eventSpecificationId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEventSpecificationWithLastUpdated' + description: OK + '400': + description: The event configuration was already migrated + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Custom Event does not exist + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Disable custom event specification + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/event-specifications/custom/{eventSpecificationId}/enable: + post: + operationId: enableCustomEventSpecification + parameters: + - in: path + name: eventSpecificationId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomEventSpecificationWithLastUpdated' + description: OK + '400': + description: The event configuration was already migrated + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Custom Event does not exist + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Enable custom event specification + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/event-specifications/infos: + get: + description: This API helps to get the summary of all build-in and custom event + specifications + operationId: getEventSpecificationInfos + responses: + '200': + content: + application/json: + example: + - id: yBGNFSh-pcKzZVBFnxoBu_36Yw4 + name: Frequent TCP errors + description: Checks whether the host has an unusual high number of + TCP errors. + entityType: host + type: BUILT_IN + severity: 5 + triggering: false + invalid: false + enabled: true + migrated: false + schema: + type: array + items: + $ref: '#/components/schemas/EventSpecificationInfo' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: Summary of all built-in and custom event specifications + tags: + - Event Settings + x-ibm-ahub-byok: true + post: + description: Summary of all built-in and custom event specifications by IDs + operationId: getEventSpecificationInfosByIds + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EventSpecificationInfo' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureCustomAlerts + summary: All built-in and custom event specifications + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/applications: + get: + description: |- + Gets all Global Smart Alert Configuration. Configurations are sorted by creation date in descending order. + For more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration. + operationId: findActiveGlobalApplicationAlertConfigs + parameters: + - description: The ID of a specific global application. + example: j02SxMRTSf-NCBXf5IdsjQ + in: query + name: applicationId + required: true + schema: + type: string + - description: A list of Global Smart Alert Configuration IDs. This allows fetching + of a specific set of Configurations. This query can be repeated to use multiple + IDs. + example: IYS1XOEcTNiT1eOD8pxgXg + in: query + name: alertIds + schema: + type: array + items: + type: string + maxItems: 1000 + minItems: 0 + uniqueItems: true + responses: + '200': + content: + application/json: + example: + - name: Slow calls than usual + description: Calls are slower or equal to 2 ms based on latency (90th). + boundaryScope: INBOUND + applications: + j02SxMRTSf-NCBXf5IdsjQ: + applicationId: j02SxMRTSf-NCBXf5IdsjQ + inclusive: true + services: { + } + applicationIds: + - j02SxMRTSf-NCBXf5IdsjQ + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: staticThreshold + operator: '>=' + value: 2.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + id: vlFnxhVTS3KVb-wsN26PeQ + created: 1707305626330 + initialCreated: 1707305626330 + readOnly: false + enabled: true + builtIn: false + schema: + type: array + items: + $ref: '#/components/schemas/GlobalApplicationAlertConfigWithMetadata' + description: OK - Returns an empty list if no configurations match the criteria + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - Default + summary: Get all Global Smart Alert Configs + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true + post: + description: |- + Creates a new Global Smart Alert Configuration. + For more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration. + operationId: createGlobalApplicationAlertConfig + requestBody: + content: + application/json: + example: + name: Slow calls than usual + description: Calls are slower or equal to 2 ms based on latency (90th). + boundaryScope: INBOUND + applications: + j02SxMRTSf-NCBXf5IdsjQ: + applicationId: j02SxMRTSf-NCBXf5IdsjQ + inclusive: true + services: { + } + applicationIds: + - j02SxMRTSf-NCBXf5IdsjQ + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: staticThreshold + operator: '>=' + value: 2.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + schema: + $ref: '#/components/schemas/GlobalApplicationsAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: Slow calls than usual + description: Calls are slower or equal to 2 ms based on latency (90th). + boundaryScope: INBOUND + applications: + j02SxMRTSf-NCBXf5IdsjQ: + applicationId: j02SxMRTSf-NCBXf5IdsjQ + inclusive: true + services: { + } + applicationIds: + - j02SxMRTSf-NCBXf5IdsjQ + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: staticThreshold + operator: '>=' + value: 2.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + id: vlFnxhVTS3KVb-wsN26PeQ + created: 1707305626330 + initialCreated: 1707305626330 + readOnly: false + enabled: true + builtIn: false + schema: + $ref: '#/components/schemas/GlobalApplicationAlertConfigWithMetadata' + description: Global Smart Alert Configuration created. + '400': + description: Invalid Configuration. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable entity. + security: + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts + summary: Create Global Smart Alert Config + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/applications/{id}: + delete: + description: |- + Disables a Global Smart Alert Configuration. + For more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration. + operationId: deleteGlobalApplicationAlertConfig + parameters: + - description: ID of a specific Global Smart Alert Configuration to delete. + example: vlFnxhVTS3KVb-wsN26PeQ + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Global Smart Alert Configuration deleted. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts + summary: Delete Global Smart Alert Config + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true + get: + description: |- + Gets a specific Global Smart Alert Configuration. This may return a deleted Configuration. + For more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration. + operationId: findGlobalApplicationAlertConfig + parameters: + - description: ID of a specific Global Smart Alert Configuration to retrieve. + example: vlFnxhVTS3KVb-wsN26PeQ + in: path + name: id + required: true + schema: + type: string + - description: 'A Unix timestamp representing a specific time the Configuration + was active. If no timestamp is provided, the latest active version will + be retrieved. ' + example: 1707305626330 + in: query + name: validOn + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + name: Slow calls than usual + description: Calls are slower or equal to 2 ms based on latency (90th). + boundaryScope: INBOUND + applications: + j02SxMRTSf-NCBXf5IdsjQ: + applicationId: j02SxMRTSf-NCBXf5IdsjQ + inclusive: true + services: { + } + applicationIds: + - j02SxMRTSf-NCBXf5IdsjQ + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: staticThreshold + operator: '>=' + value: 2.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + id: vlFnxhVTS3KVb-wsN26PeQ + created: 1707305626330 + initialCreated: 1707305626330 + readOnly: false + enabled: true + builtIn: false + schema: + $ref: '#/components/schemas/GlobalApplicationAlertConfigWithMetadata' + description: OK + '403': + description: Insufficient permissions. + '404': + description: The requested Configuration does not exist. + security: + - ApiKeyAuth: + - Default + summary: Get Global Smart Alert Config + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true + post: + description: |- + Updates an existing Global Smart Alert Configuration. + For more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration. + operationId: updateGlobalApplicationAlertConfig + parameters: + - description: ID of a specific Global Smart Alert Configuration to update. + example: vlFnxhVTS3KVb-wsN26PeQ + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: Slow calls than usual + description: Calls are slower or equal to 2 ms based on latency (90th). + boundaryScope: INBOUND + applications: + j02SxMRTSf-NCBXf5IdsjQ: + applicationId: j02SxMRTSf-NCBXf5IdsjQ + inclusive: true + services: { + } + applicationIds: + - j02SxMRTSf-NCBXf5IdsjQ + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: staticThreshold + operator: '>=' + value: 2.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + schema: + $ref: '#/components/schemas/GlobalApplicationsAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: Slow calls than usual + description: Calls are slower or equal to 2 ms based on latency (90th). + boundaryScope: INBOUND + applications: + j02SxMRTSf-NCBXf5IdsjQ: + applicationId: j02SxMRTSf-NCBXf5IdsjQ + inclusive: true + services: { + } + applicationIds: + - j02SxMRTSf-NCBXf5IdsjQ + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + includeInternal: false + includeSynthetic: false + rule: + alertType: slowness + aggregation: P90 + metricName: latency + threshold: + type: staticThreshold + operator: '>=' + value: 2.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + evaluationType: PER_AP + customPayloadFields: [ + ] + id: vlFnxhVTS3KVb-wsN26PeQ + created: 1707305626330 + initialCreated: 1707305626330 + readOnly: false + enabled: true + builtIn: false + schema: + $ref: '#/components/schemas/GlobalApplicationAlertConfigWithMetadata' + description: Global Smart Alert Configuration updated. + '204': + description: Global Smart Alert Configuration did not change. + '400': + description: Invalid Application ID provided. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable entity. + '500': + description: Internal error. + security: + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts + summary: Update Global Smart Alert Config + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/applications/{id}/disable: + put: + description: |- + Disables a Global Smart Alert Configuration. + For more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration. + operationId: disableGlobalApplicationAlertConfig + parameters: + - description: ID of a specific Global Smart Alert Configuration to disable. + example: vlFnxhVTS3KVb-wsN26PeQ + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Global Smart Alert Configuration disabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts + summary: Disable Global Smart Alert Config + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/applications/{id}/enable: + put: + description: |- + Enables a Global Smart Alert Configuration. + For more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration. + operationId: enableGlobalApplicationAlertConfig + parameters: + - description: ID of a specific Global Smart Alert Configuration to enable. + example: vlFnxhVTS3KVb-wsN26PeQ + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Global Smart Alert Configuration enabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts + summary: Enable Global Smart Alert Config + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/applications/{id}/restore/{created}: + put: + description: |- + Restores a deleted Global Smart Alert Configuration. + For more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration. + operationId: restoreGlobalApplicationAlertConfig + parameters: + - description: ID of a specific Global Smart Alert Configuration to restore. + example: vlFnxhVTS3KVb-wsN26PeQ + in: path + name: id + required: true + schema: + type: string + - description: Unix timestamp representing the creation time of a specific Global + Smart Alert Configuration. + example: 1707305626330 + in: path + name: created + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Global Smart Alert Configuration restored. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts + summary: Restore Global Smart Alert Config + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/applications/{id}/versions: + get: + description: |- + Gets all versions of a Global Smart Alert Configuration. This may return deleted Configurations. Configurations are sorted by creation date in descending order. + For more information on Global Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#global-application-alert-configuration. + operationId: findGlobalApplicationAlertConfigVersions + parameters: + - description: ID of a specific Global Smart Alert Configuration to retrieve. + example: vlFnxhVTS3KVb-wsN26PeQ + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: vlFnxhVTS3KVb-wsN26PeQ + created: 1707305626330 + enabled: true + deleted: false + changeSummary: + changeType: CREATE + author: + id: 5ee8a3e8cd70020001ecb007 + type: USER + fullName: Stan + schema: + type: array + items: + $ref: '#/components/schemas/ConfigVersion' + description: OK + '403': + description: Insufficient permissions. + '404': + description: The requested Configuration does not exist. + security: + - ApiKeyAuth: + - Default + summary: Get Global Smart Alert Config Versions + tags: + - Global Application Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/logs: + get: + description: Configs are sorted descending by their created date. + operationId: findActiveLogAlertConfigs + parameters: + - in: query + name: alertIds + schema: + type: array + items: + type: string + maxItems: 1000 + minItems: 0 + uniqueItems: true + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/LogAlertConfigWithMetadata' + description: OK + security: + - ApiKeyAuth: + - Default + summary: All Log Alert Configs + tags: + - Log Alert Configuration + x-ibm-ahub-byok: true + post: + operationId: createLogAlertConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogAlertConfig' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LogAlertConfigWithMetadata' + description: OK + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts + summary: Create Log Alert Config + tags: + - Log Alert Configuration + x-description: createLogAlertConfig + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/logs/{id}: + delete: + operationId: deleteLogAlertConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Log Alert Configuration deleted. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts + summary: Delete Log Alert Config + tags: + - Log Alert Configuration + x-ibm-ahub-byok: true + get: + description: Find a Log Alert Config by ID. This will deliver deleted configs + too. + operationId: findLogAlertConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + - in: query + name: validOn + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LogAlertConfigWithMetadata' + description: OK + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - Default + summary: Get Log Alert Config + tags: + - Log Alert Configuration + x-ibm-ahub-byok: true + post: + operationId: updateLogAlertConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogAlertConfig' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/LogAlertConfigWithMetadata' + description: Log Smart Alert successfully updated + '204': + description: Log Smart Alert did not change + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts + summary: Update Log Alert Config + tags: + - Log Alert Configuration + x-description: updateLogAlertConfig + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/logs/{id}/disable: + put: + operationId: disableLogAlertConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Log Alert Configuration disabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts + summary: Disable Log Alert Config + tags: + - Log Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/logs/{id}/enable: + put: + operationId: enableLogAlertConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Log Alert Configuration enabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts + summary: Enable Log Alert Config + tags: + - Log Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/logs/{id}/restore/{created}: + put: + operationId: restoreLogAlertConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + - in: path + name: created + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Log Alert Configuration restored. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts + summary: Restore Log Alert Config + tags: + - Log Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/logs/{id}/versions: + get: + description: Find all versions of a Log Alert Config by ID. This will deliver + deleted configs too. Configs are sorted descending by their created date. + operationId: findLogAlertConfigVersions + parameters: + - in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ConfigVersion' + description: OK + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - Default + summary: Get versions of Log Alert Config + tags: + - Log Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/service-levels: + get: + description: Configs are sorted descending by their created date. + operationId: findActiveServiceLevelsAlertConfigs + parameters: + - description: Service Levels Objective(SLO) Configuration ID + example: SLOEANnWh9tQOa2h88kGxK6wQ + in: query + name: sloId + schema: + type: string + - description: List of Service Levels Alert Configuration IDs + example: ln3IGogYS-S7CPqcOQYTNA + in: query + name: alertIds + schema: + type: array + items: + type: string + maxItems: 1000 + minItems: 0 + uniqueItems: true + responses: + '200': + content: + application/json: + example: + name: Error Budget Remaining is low + description: Error Budget Remaining is less than or equal to 5%. + severity: 5 + triggering: true + rule: + alertType: ERROR_BUDGET + metric: BURNED_PERCENTAGE + threshold: + type: staticThreshold + operator: '>=' + value: 0.05 + lastUpdated: 1716454787342 + sloIds: + - SLOEANnWh9tQOa2h88kGxK6wQ + alertChannelIds: [ + ] + timeThreshold: + expiry: null + timeWindow: 600000 + customPayloadFields: + - type: staticString + key: foo + value: bar + id: ln3IGogYS-S7CPqcOQYTNA + created: 1717668384754 + initialCreated: 1717668384754 + readOnly: false + enabled: true + schema: + type: array + items: + $ref: '#/components/schemas/ServiceLevelseAlertConfigWithMetadata' + description: Fetched list of the Service Level Alert Configurations Successfully + security: + - ApiKeyAuth: + - Default + summary: All Service levels Alert Configs + tags: + - Service Levels Alert Configuration + x-ibm-ahub-byok: true + post: + operationId: createServiceLevelsAlertConfig + requestBody: + content: + application/json: + example: + alertChannelIds: [ + ] + customPayloadFields: + - key: foo + id: avvh9tbxpfRE65t + type: staticString + value: bar + description: Error Budget Remaining is less than or equal to 5%. + name: Error Budget Remaining is low + rule: + alertType: ERROR_BUDGET + metric: BURNED_PERCENTAGE + severity: 5 + sloIds: + - SLOEANnWh9tQOa2h88kGxK6wQ + threshold: + type: staticThreshold + value: 0.05 + operator: '>=' + lastUpdated: 1716454787342 + timeThreshold: + timeWindow: 600000 + triggering: true + schema: + $ref: '#/components/schemas/ServiceLevelsAlertConfig' + description: Create Request Body + required: true + responses: + '200': + content: + application/json: + example: + name: Error Budget Remaining is low + description: Error Budget Remaining is less than or equal to 5%. + severity: 5 + triggering: true + rule: + alertType: ERROR_BUDGET + metric: BURNED_PERCENTAGE + threshold: + type: staticThreshold + operator: '>=' + value: 0.05 + lastUpdated: 1716454787342 + sloIds: + - SLOEANnWh9tQOa2h88kGxK6wQ + alertChannelIds: [ + ] + timeThreshold: + expiry: null + timeWindow: 600000 + customPayloadFields: + - type: staticString + key: foo + value: bar + id: ln3IGogYS-S7CPqcOQYTNA + created: 1717668384754 + initialCreated: 1717668384754 + readOnly: false + enabled: true + schema: + $ref: '#/components/schemas/ServiceLevelseAlertConfigWithMetadata' + description: Created new Service Levels Alert Configuration Successfully + '400': + content: + application/json: + example: + errors: + - Website SLOs do not support triggering -> true + schema: + type: array + items: + type: string + description: Service levels Alert Config with Website SLOs do not support + triggering + security: + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts + summary: Create Service levels Alert Config + tags: + - Service Levels Alert Configuration + x-description: createServiceLevelsAlertConfig + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/service-levels/{id}: + delete: + operationId: deleteServiceLevelsAlertConfig + parameters: + - description: Service Levels Alert Configuration ID + example: ln3IGogYS-S7CPqcOQYTNA + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Service Levels Alert Configuration Deleted Successfully + '404': + content: + application/json: + example: '{"errors":["Config with id: -DZZjflTQTmZ7yGvBilPlQ is not + found"]}' + schema: + type: string + description: Service levels Alert Config with given ID not found + security: + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts + summary: Delete Service levels Alert Config + tags: + - Service Levels Alert Configuration + x-ibm-ahub-byok: true + get: + description: Find a Service levels Alert Config by ID. This will deliver deleted + configs too. + operationId: findServiceLevelsAlertConfig + parameters: + - description: Service Levels Alert Configuration ID + example: ln3IGogYS-S7CPqcOQYTNA + in: path + name: id + required: true + schema: + type: string + - description: Service Levels Alert Version Creation Date + example: 1706617456952 + in: query + name: validOn + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + name: Error Budget Remaining is low + description: Error Budget Remaining is less than or equal to 5%. + severity: 5 + triggering: true + rule: + alertType: ERROR_BUDGET + metric: BURNED_PERCENTAGE + threshold: + type: staticThreshold + operator: '>=' + value: 0.05 + lastUpdated: 1716454787342 + sloIds: + - SLOEANnWh9tQOa2h88kGxK6wQ + alertChannelIds: [ + ] + timeThreshold: + expiry: null + timeWindow: 600000 + customPayloadFields: + - type: staticString + key: foo + value: bar + id: ln3IGogYS-S7CPqcOQYTNA + created: 1717668384754 + initialCreated: 1717668384754 + readOnly: false + enabled: true + schema: + $ref: '#/components/schemas/ServiceLevelseAlertConfigWithMetadata' + description: Fetched Service Level Alert Configuration Successfully + '404': + content: + application/json: + example: '{"errors":["Config with id: -DZZjflTQTmZ7yGvBilPlQ is not + found"]}' + schema: + type: string + description: Service levels Alert Config with given ID not found + security: + - ApiKeyAuth: + - Default + summary: Get Service levels Alert Config + tags: + - Service Levels Alert Configuration + x-ibm-ahub-byok: true + post: + operationId: updateServiceLevelsAlertConfig + parameters: + - description: Service Levels Alert Configuration ID + example: ln3IGogYS-S7CPqcOQYTNA + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + alertChannelIds: [ + ] + customPayloadFields: + - key: foo + id: avvh9tbxpfRE65t + type: staticString + value: bar + description: Error Budget Remaining is less than or equal to 5%. + name: Error Budget Remaining is low + rule: + alertType: ERROR_BUDGET + metric: BURNED_PERCENTAGE + severity: 5 + sloIds: + - SLOEANnWh9tQOa2h88kGxK6wQ + threshold: + type: staticThreshold + value: 0.05 + operator: '>=' + lastUpdated: 1716454787342 + timeThreshold: + timeWindow: 600000 + triggering: true + schema: + $ref: '#/components/schemas/ServiceLevelsAlertConfig' + description: Update Request Body + required: true + responses: + '200': + content: + application/json: + example: + name: Error Budget Remaining is low + description: Error Budget Remaining is less than or equal to 5%. + severity: 5 + triggering: true + rule: + alertType: ERROR_BUDGET + metric: BURNED_PERCENTAGE + threshold: + type: staticThreshold + operator: '>=' + value: 0.05 + lastUpdated: 1716454787342 + sloIds: + - SLOEANnWh9tQOa2h88kGxK6wQ + alertChannelIds: [ + ] + timeThreshold: + expiry: null + timeWindow: 600000 + customPayloadFields: + - type: staticString + key: foo + value: bar + id: ln3IGogYS-S7CPqcOQYTNA + created: 1717668384754 + initialCreated: 1717668384754 + readOnly: false + enabled: true + schema: + $ref: '#/components/schemas/ServiceLevelseAlertConfigWithMetadata' + description: Updated Service Levels Alert Configuration Successfully + '204': + description: Service Levels Smart Alert Configuration did not change + '400': + content: + application/json: + example: + errors: + - Website SLOs do not support triggering -> true + schema: + type: array + items: + type: string + description: Service levels Alert Config with Website SLOs do not support + triggering + security: + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts + summary: Update Service levels Alert Config + tags: + - Service Levels Alert Configuration + x-description: updateServiceLevelsAlertConfig + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/service-levels/{id}/disable: + put: + operationId: disableServiceLevelsAlertConfig + parameters: + - description: Service Levels Alert Configuration ID + example: ln3IGogYS-S7CPqcOQYTNA + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Service Levels Alert Configuration Disabled Successfully + '404': + content: + application/json: + example: '{"errors":["Config with id: -DZZjflTQTmZ7yGvBilPlQ is not + found"]}' + schema: + type: string + description: Service levels Alert Config with given ID not found + security: + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts + summary: Disable Service levels Alert Config + tags: + - Service Levels Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/service-levels/{id}/enable: + put: + operationId: enableServiceLevelsAlertConfig + parameters: + - description: Service Levels Alert Configuration ID + example: ln3IGogYS-S7CPqcOQYTNA + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Service Levels Alert Configuration Enabled Successfully + '404': + content: + application/json: + example: '{"errors":["Config with id: -DZZjflTQTmZ7yGvBilPlQ is not + found"]}' + schema: + type: string + description: Service levels Alert Config with given ID not found + security: + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts + summary: Enable Service levels Alert Config + tags: + - Service Levels Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/service-levels/{id}/restore/{created}: + put: + operationId: restoreServiceLevelsAlertConfig + parameters: + - description: Service Levels Alert Configuration ID + example: ln3IGogYS-S7CPqcOQYTNA + in: path + name: id + required: true + schema: + type: string + - description: Service Levels Alert Version Creation Date + example: 1706617456952 + in: path + name: created + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Service Levels Alert Configuration Restored Successfully + '404': + content: + application/json: + example: '{"errors":["Config with id: -DZZjflTQTmZ7yGvBilPlQ is not + found"]}' + schema: + type: string + description: Service levels Alert Config with given ID not found + security: + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts + summary: Restore Service levels Alert Config + tags: + - Service Levels Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/service-levels/{id}/versions: + get: + description: Find all versions of a Service levels Alert Config by ID. This + will deliver deleted configs too. Configs are sorted descending by their created + date. + operationId: findServiceLevelsAlertConfigVersions + parameters: + - description: Service Levels Alert Configuration ID + example: ln3IGogYS-S7CPqcOQYTNA + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: ln3IGogYS-S7CPqcOQYTNA + created: 1717507017767 + enabled: false + deleted: false + changeSummary: + changeType: DISABLE + author: + id: SCzqyU_LTtmO9CCnvvVOAg + type: API + fullName: userToken + - id: ln3IGogYS-S7CPqcOQYTNA + created: 1717506979607 + enabled: true + deleted: false + changeSummary: + changeType: CREATE + author: + id: SCzqyU_LTtmO9CCnvvVOAg + type: API + fullName: userToken + schema: + type: array + items: + $ref: '#/components/schemas/ConfigVersion' + description: Fetched list of Service Level Alert Configuration Versions + Successfully + '404': + content: + application/json: + example: '{"errors":["Config with id: -DZZjflTQTmZ7yGvBilPlQ is not + found"]}' + schema: + type: string + description: Service levels Alert Config with given ID not found + security: + - ApiKeyAuth: + - Default + summary: Get versions of Service levels Alert Config + tags: + - Service Levels Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/synthetics: + get: + description: |- + Gets all the Synthetic Smart Alert Configuration pertaining to a specific synthetic test. Configurations are sorted by creation date in descending order. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: findActiveSyntheticAlertConfigs + parameters: + - description: 'The ID of a specific Synthetic Test. ' + example: ic25Vt1T5dgKzi0K7812 + in: query + name: syntheticTestId + schema: + type: string + - description: A list of Smart Alert Configuration IDs. This allows fetching + of a specific set of Configurations. This query can be repeated to use multiple + IDs. + example: smRTFp08juKWtn8I + in: query + name: alertIds + schema: + type: array + items: + type: string + maxItems: 1000 + minItems: 0 + uniqueItems: true + responses: + '200': + content: + application/json: + example: + - name: Tests in EU are failing + description: Tests in EU failed for 1 consecutive time + syntheticTestIds: + - ic25Vt1T5dgKzi0K7812 + - 2gBxQz3oKtXgFXzRoQ6O + severity: 5 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: synthetic.serviceId + stringValue: '12' + numberValue: null + booleanValue: null + key: null + value: '12' + operator: EQUALS + entity: NOT_APPLICABLE + - type: TAG_FILTER + name: synthetic.locationLabel + stringValue: US-west1 + numberValue: null + booleanValue: null + key: null + value: '123' + operator: EQUALS + entity: NOT_APPLICABLE + rule: + alertType: failure + metricName: status + aggregation: SUM + alertChannelIds: [ + ] + timeThreshold: + type: violationsInSequence + violationsCount: 1 + customPayloadFields: [ + ] + id: 2K1YQIeaSQKIcIkHPH7D3g + created: 1707486254161 + initialCreated: 1706531043586 + readOnly: false + enabled: true + schema: + type: array + items: + $ref: '#/components/schemas/SyntheticAlertConfigWithMetadata' + description: Success. Returns empty result if syntheticTestId is invalid. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - Default + summary: Get all Synthetic Smart Alert Configs + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true + post: + description: |- + Creates a new Synthetic Smart Alert Configuration. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: createSyntheticAlertConfig + requestBody: + content: + application/json: + example: + name: 2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel} + description: Alert created without test but with AppId - Synthetic test + failed for 2 consecutive times + syntheticTestIds: + - ic25Vt1T5dgKzi0K7812 + - 2gBxQz3oKtXgFXzRoQ6O + severity: 5 + tagFilterExpression: + type: TAG_FILTER + name: synthetic.applicationId + stringValue: 2BPCBLz_RBG8J6mjyuxm6w + numberValue: null + booleanValue: null + key: null + value: 2BPCBLz_RBG8J6mjyuxm6w + operator: EQUALS + entity: NOT_APPLICABLE + rule: + alertType: failure + metricName: status + aggregation: SUM + alertChannelIds: + - 0o1ISHPfR8-N4iUK + timeThreshold: + type: violationsInSequence + violationsCount: 2 + customPayloadFields: [ + ] + schema: + $ref: '#/components/schemas/SyntheticAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: 2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel} + description: Alert created without test but with AppId - Synthetic + test failed for 2 consecutive times + syntheticTestIds: + - ic25Vt1T5dgKzi0K7812 + - 2gBxQz3oKtXgFXzRoQ6O + severity: 5 + tagFilterExpression: + type: TAG_FILTER + name: synthetic.applicationId + stringValue: 2BPCBLz_RBG8J6mjyuxm6w + numberValue: null + booleanValue: null + key: null + value: 2BPCBLz_RBG8J6mjyuxm6w + operator: EQUALS + entity: NOT_APPLICABLE + rule: + alertType: failure + metricName: status + aggregation: SUM + alertChannelIds: + - 0o1ISHPfR8-N4iUK + timeThreshold: + type: violationsInSequence + violationsCount: 2 + customPayloadFields: [ + ] + id: qgEwvI0vRfe3Al_D7T7LSA + created: 1707149760053 + initialCreated: 1707145201046 + readOnly: false + enabled: true + schema: + $ref: '#/components/schemas/SyntheticAlertConfigWithMetadata' + description: Synthetic Smart Alert Configuration created. + '400': + description: Invalid configuration. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable entity. + security: + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts + summary: Create Synthetic Smart Alert Config + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/synthetics/{id}: + delete: + description: |- + Deletes a Synthetic Smart Alert Configuration. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: deleteSyntheticAlertConfig + parameters: + - description: ID of a specific Synthetic Smart Alert Configuration to delete. + example: 2K1YQIeaSQKIcIkHPH7D3g + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Synthetic Smart Alert Configuration deleted. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts + summary: Delete Synthetic Smart Alert Config + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true + get: + description: |- + Gets a specific Synthetic Smart Alert Configuration. This may return a deleted Configuration. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: findSyntheticAlertConfig + parameters: + - description: ID of a specific Synthetic Smart Alert Configuration to retrieve. + example: qgEwvI0vRfe3Al_D7T7LSA + in: path + name: id + required: true + schema: + type: string + - description: 'A Unix timestamp representing a specific time the Configuration + was active. If no timestamp is provided, the latest active version will + be retrieved. ' + example: 1707149760053 + in: query + name: validOn + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + name: 2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel} + description: Alert created without test but with AppId - Synthetic + test failed for 2 consecutive times + syntheticTestIds: + - ic25Vt1T5dgKzi0K7812 + - 2gBxQz3oKtXgFXzRoQ6O + severity: 5 + tagFilterExpression: + type: TAG_FILTER + name: synthetic.applicationId + stringValue: 2BPCBLz_RBG8J6mjyuxm6w + numberValue: null + booleanValue: null + key: null + value: 2BPCBLz_RBG8J6mjyuxm6w + operator: EQUALS + entity: NOT_APPLICABLE + rule: + alertType: failure + metricName: status + aggregation: SUM + alertChannelIds: + - 0o1ISHPfR8-N4iUK + timeThreshold: + type: violationsInSequence + violationsCount: 2 + customPayloadFields: [ + ] + id: qgEwvI0vRfe3Al_D7T7LSA + created: 1707149760053 + initialCreated: 1707145201046 + readOnly: false + enabled: true + schema: + $ref: '#/components/schemas/SyntheticAlertConfigWithMetadata' + description: OK + '403': + description: Insufficient permissions. + '404': + description: The requested Configuration does not exist. + security: + - ApiKeyAuth: + - Default + summary: Get Synthetic Smart Alert Config + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true + post: + description: |- + Updates an existing Synthetic Smart Alert Configuration. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: updateSyntheticAlertConfig + parameters: + - description: ID of a specific Synthetic Smart Alert Configuration to update. + example: qgEwvI0vRfe3Al_D7T7LSA + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: 2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel} + description: Alert created without test but with AppId - Synthetic test + failed for 2 consecutive times + syntheticTestIds: + - ic25Vt1T5dgKzi0K7812 + - 2gBxQz3oKtXgFXzRoQ6O + severity: 5 + tagFilterExpression: + type: TAG_FILTER + name: synthetic.applicationId + stringValue: 2BPCBLz_RBG8J6mjyuxm6w + numberValue: null + booleanValue: null + key: null + value: 2BPCBLz_RBG8J6mjyuxm6w + operator: EQUALS + entity: NOT_APPLICABLE + rule: + alertType: failure + metricName: status + aggregation: SUM + alertChannelIds: + - 0o1ISHPfR8-N4iUK + timeThreshold: + type: violationsInSequence + violationsCount: 2 + customPayloadFields: [ + ] + schema: + $ref: '#/components/schemas/SyntheticAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: 2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel} + description: Alert created without test but with AppId - Synthetic + test failed for 2 consecutive times + syntheticTestIds: + - ic25Vt1T5dgKzi0K7812 + - 2gBxQz3oKtXgFXzRoQ6O + severity: 5 + tagFilterExpression: + type: TAG_FILTER + name: synthetic.applicationId + stringValue: 2BPCBLz_RBG8J6mjyuxm6w + numberValue: null + booleanValue: null + key: null + value: 2BPCBLz_RBG8J6mjyuxm6w + operator: EQUALS + entity: NOT_APPLICABLE + rule: + alertType: failure + metricName: status + aggregation: SUM + alertChannelIds: + - 0o1ISHPfR8-N4iUK + timeThreshold: + type: violationsInSequence + violationsCount: 2 + customPayloadFields: [ + ] + id: qgEwvI0vRfe3Al_D7T7LSA + created: 1707149760053 + initialCreated: 1707145201046 + readOnly: false + enabled: true + schema: + $ref: '#/components/schemas/SyntheticAlertConfigWithMetadata' + description: Synthetic Smart Alert Configuration updated + '204': + description: Synthetic Smart Alert Configuration did not change + '400': + description: Invalid Configuration ID provided. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable entity. + '500': + description: Internal error. + security: + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts + summary: Update Synthetic Smart Alert Config + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/synthetics/{id}/disable: + put: + description: |- + Disables a Synthetic Smart Alert Configuration. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: disableSyntheticAlertConfig + parameters: + - description: ID of a specific Synthetic Smart Alert Configuration to disable. + example: 2K1YQIeaSQKIcIkHPH7D3g + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Synthetic Smart Alert Configuration disabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts + summary: Disable Synthetic Smart Alert Config + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/synthetics/{id}/enable: + put: + description: |- + Enables a Synthetic Smart Alert Configuration. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: enableSyntheticAlertConfig + parameters: + - description: ID of a specific Synthetic Smart Alert Configuration to enable. + example: 2K1YQIeaSQKIcIkHPH7D3g + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Synthetic Smart Alert Configuration enabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts + summary: Enable Synthetic Smart Alert Config + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/synthetics/{id}/restore/{created}: + put: + description: |- + Restores a deleted Synthetic Smart Alert Configuration. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: restoreSyntheticAlertConfig + parameters: + - description: ID of a specific Synthetic Smart Alert Configuration to restore. + example: 2K1YQIeaSQKIcIkHPH7D3g + in: path + name: id + required: true + schema: + type: string + - description: Unix timestamp representing the creation time of a specific Synthetic + Smart Alert Configuration. + example: 1707726529124 + in: path + name: created + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Synthetic Smart Alert Configuration restored. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration provided. + security: + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts + summary: Restore Synthetic Smart Alert Config + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/global-alert-configs/synthetics/{id}/versions: + get: + description: |- + Gets all versions of a Synthetic Smart Alert Configuration. This may return deleted Configurations. Configurations are sorted by creation date in descending order. + For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration. + operationId: findSyntheticAlertConfigVersions + parameters: + - description: ID of a specific Synthetic Smart Alert Configuration to retrieve. + example: qgEwvI0vRfe3Al_D7T7LSA + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: qgEwvI0vRfe3Al_D7T7LSA + created: 1707149760053 + enabled: true + deleted: false + changeSummary: + changeType: UPDATE + author: + id: 6244073003b38f0001209ec5 + type: USER + fullName: John Doe + - id: qgEwvI0vRfe3Al_D7T7LSA + created: 1707145201046 + enabled: true + deleted: false + changeSummary: + changeType: CREATE + author: + id: 6244073003b38f0001209ec5 + type: USER + fullName: John Doe + schema: + type: array + items: + $ref: '#/components/schemas/ConfigVersion' + description: OK + '403': + description: Insufficient permissions. + '404': + description: The requested Configuration does not exist. + security: + - ApiKeyAuth: + - Default + summary: Get Synthetic Smart Alert Config Versions + tags: + - Synthetic Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/infra-alert-configs: + get: + description: Configs are sorted descending by their created date. + operationId: findActiveInfraAlertConfigs + parameters: + - description: List of IDs of Infra Smart Alert configurations + example: '[4kxgJAXdSDiu6swQaKXrJw, ZLo28grvQaiMqIaikJK1RQ]' + in: query + name: alertIds + schema: + type: array + items: + type: string + maxItems: 1000 + minItems: 0 + uniqueItems: true + responses: + '200': + content: + application/json: + example: + - name: high-mean-memory-usage + description: Something is going wrong in your infrastructure. + severity: 5 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: kubernetes.cluster.name + stringValue: 200_PoP_Cluster + numberValue: null + booleanValue: null + key: null + value: 200_PoP_Cluster + operator: EQUALS + entity: NOT_APPLICABLE + groupBy: + - kubernetes.cluster.name + - kubernetes.namespace.name + - kubernetes.pod.name + rule: + alertType: genericRule + metricName: memory.usage + entityType: crio + aggregation: MEAN + crossSeriesAggregation: MEAN + regex: false + threshold: + type: staticThreshold + operator: '>=' + value: 1 + lastUpdated: 1724720573744 + forecastingConfig: null + alertChannelIds: + - VjS1NvcXpOARmTvA + - CrLI3QeIZKygaNLH + granularity: 60000 + timeThreshold: + type: violationsInSequence + timeWindow: 180000 + id: 4kxgJAXdSDiu6swQaKXrJw + created: 1724720587414 + initialCreated: 1714766649532 + readOnly: false + enabled: false + customPayloadFields: + - type: staticString + key: testKey + value: team-ar + rules: + - thresholdOperator: '>=' + rule: + alertType: genericRule + metricName: memory.usage + entityType: crio + aggregation: MEAN + crossSeriesAggregation: MEAN + regex: false + thresholds: + WARNING: + type: staticThreshold + value: 1 + CRITICAL: + type: staticThreshold + value: 4 + schema: + type: array + items: + $ref: '#/components/schemas/InfraAlertConfigWithMetadata' + description: OK + security: + - ApiKeyAuth: + - Default + summary: All Infra Alert Configs + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true + post: + operationId: createInfraAlertConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InfraAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: high-mean-memory-usage + description: Something is going wrong in your infrastructure. + severity: 5 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: kubernetes.cluster.name + stringValue: 200_PoP_Cluster + numberValue: null + booleanValue: null + key: null + value: 200_PoP_Cluster + operator: EQUALS + entity: NOT_APPLICABLE + groupBy: + - kubernetes.cluster.name + - kubernetes.namespace.name + - kubernetes.pod.name + rule: + alertType: genericRule + metricName: memory.usage + entityType: crio + aggregation: MEAN + crossSeriesAggregation: MEAN + regex: false + threshold: + type: staticThreshold + operator: '>=' + value: 1 + lastUpdated: 1724720573744 + forecastingConfig: null + alertChannelIds: + - VjS1NvcXpOARmTvA + - CrLI3QeIZKygaNLH + granularity: 60000 + timeThreshold: + type: violationsInSequence + timeWindow: 180000 + id: 4kxgJAXdSDiu6swQaKXrJw + created: 1724720587414 + initialCreated: 1714766649532 + readOnly: false + enabled: false + customPayloadFields: + - type: staticString + key: testKey + value: team-ar + rules: + - thresholdOperator: '>=' + rule: + alertType: genericRule + metricName: memory.usage + entityType: crio + aggregation: MEAN + crossSeriesAggregation: MEAN + regex: false + thresholds: + WARNING: + type: staticThreshold + value: 1 + CRITICAL: + type: staticThreshold + value: 4 + schema: + $ref: '#/components/schemas/InfraAlertConfigWithMetadata' + description: OK + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts + summary: Create Infra Alert Config + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/infra-alert-configs/{id}: + delete: + operationId: deleteInfraAlertConfig + parameters: + - description: ID of the Infra Smart Alert configuration to delete + example: 4kxgJAXdSDiu6swQaKXrJw + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + security: + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts + summary: Delete Infra Alert Config + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true + get: + description: Find a Infra Alert Config by ID. This will deliver deleted configs + too. + operationId: findInfraAlertConfig + parameters: + - description: ID of the Infra Smart Alert configuration + example: 4kxgJAXdSDiu6swQaKXrJw + in: path + name: id + required: true + schema: + type: string + - description: 'A Unix timestamp representing a specific time the config was + active. If no timestamp is provided, the latest active version will be retrieved. ' + example: 1722877985000 + in: query + name: validOn + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + name: high-mean-memory-usage + description: Something is going wrong in your infrastructure. + severity: 5 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: kubernetes.cluster.name + stringValue: 200_PoP_Cluster + numberValue: null + booleanValue: null + key: null + value: 200_PoP_Cluster + operator: EQUALS + entity: NOT_APPLICABLE + groupBy: + - kubernetes.cluster.name + - kubernetes.namespace.name + - kubernetes.pod.name + rule: + alertType: genericRule + metricName: memory.usage + entityType: crio + aggregation: MEAN + crossSeriesAggregation: MEAN + regex: false + threshold: + type: staticThreshold + operator: '>=' + value: 1 + lastUpdated: 1724720573744 + forecastingConfig: null + alertChannelIds: + - VjS1NvcXpOARmTvA + - CrLI3QeIZKygaNLH + granularity: 60000 + timeThreshold: + type: violationsInSequence + timeWindow: 180000 + id: 4kxgJAXdSDiu6swQaKXrJw + created: 1724720587414 + initialCreated: 1714766649532 + readOnly: false + enabled: false + customPayloadFields: + - type: staticString + key: testKey + value: team-ar + rules: + - thresholdOperator: '>=' + rule: + alertType: genericRule + metricName: memory.usage + entityType: crio + aggregation: MEAN + crossSeriesAggregation: MEAN + regex: false + thresholds: + WARNING: + type: staticThreshold + value: 1 + CRITICAL: + type: staticThreshold + value: 4 + schema: + $ref: '#/components/schemas/InfraAlertConfigWithMetadata' + description: OK + '404': + description: Resource not found. + security: + - ApiKeyAuth: + - Default + summary: Get Infra Alert Config + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true + post: + operationId: updateInfraAlertConfig + parameters: + - description: ID of the Infra Smart Alert configuration to update + example: 4kxgJAXdSDiu6swQaKXrJw + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InfraAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: high-mean-memory-usage + description: Something is going wrong in your infrastructure. + severity: 5 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: kubernetes.cluster.name + stringValue: 200_PoP_Cluster + numberValue: null + booleanValue: null + key: null + value: 200_PoP_Cluster + operator: EQUALS + entity: NOT_APPLICABLE + groupBy: + - kubernetes.cluster.name + - kubernetes.namespace.name + - kubernetes.pod.name + rule: + alertType: genericRule + metricName: memory.usage + entityType: crio + aggregation: MEAN + crossSeriesAggregation: MEAN + regex: false + threshold: + type: staticThreshold + operator: '>=' + value: 1 + lastUpdated: 1724720573744 + forecastingConfig: null + alertChannelIds: + - VjS1NvcXpOARmTvA + - CrLI3QeIZKygaNLH + granularity: 60000 + timeThreshold: + type: violationsInSequence + timeWindow: 180000 + id: 4kxgJAXdSDiu6swQaKXrJw + created: 1724720587414 + initialCreated: 1714766649532 + readOnly: false + enabled: false + customPayloadFields: + - type: staticString + key: testKey + value: team-ar + rules: + - thresholdOperator: '>=' + rule: + alertType: genericRule + metricName: memory.usage + entityType: crio + aggregation: MEAN + crossSeriesAggregation: MEAN + regex: false + thresholds: + WARNING: + type: staticThreshold + value: 1 + CRITICAL: + type: staticThreshold + value: 4 + schema: + $ref: '#/components/schemas/InfraAlertConfigWithMetadata' + description: OK + '204': + description: Infra Smart Alert did not change + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts + summary: Update Infra Alert Config + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/infra-alert-configs/{id}/disable: + put: + operationId: disableInfraAlertConfig + parameters: + - description: ID of the Infra Smart Alert configuration to disable + example: 4kxgJAXdSDiu6swQaKXrJw + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Successful - no content to return. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + security: + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts + summary: Disable Infra Alert Config + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/infra-alert-configs/{id}/enable: + put: + operationId: enableInfraAlertConfig + parameters: + - description: ID of the Infra Smart Alert configuration to enable + example: 4kxgJAXdSDiu6swQaKXrJw + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Successful - no content to return. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + security: + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts + summary: Enable Infra Alert Config + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/infra-alert-configs/{id}/restore/{created}: + put: + operationId: restoreInfraAlertConfig + parameters: + - description: ID of the Infra Smart Alert configuration to restore + example: 4kxgJAXdSDiu6swQaKXrJw + in: path + name: id + required: true + schema: + type: string + - description: A Unix Timestamp of when the alert was created + example: 1722877985000 + in: path + name: created + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Successful - no content to return. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + security: + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts + summary: Restore Infra Alert Config + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/infra-alert-configs/{id}/versions: + get: + description: Find all versions of a Infra Alert Config by ID. This will deliver + deleted configs too. Configs are sorted descending by their created date. + operationId: findInfraAlertConfigVersions + parameters: + - description: ID of the Infra Smart Alert configuration + example: 4kxgJAXdSDiu6swQaKXrJw + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: 4kxgJAXdSDiu6swQaKXrJw + created: 1724720587414 + enabled: false + deleted: false + changeSummary: + changeType: DISABLE + author: + id: 5ee8a3e8cd70020001ecb007 + type: USER + fullName: Stan + schema: + type: array + items: + $ref: '#/components/schemas/ConfigVersion' + description: OK + '404': + description: Resource not found. + security: + - ApiKeyAuth: + - Default + summary: Get versions of Infra Alert Config + tags: + - Infrastructure Alert Configuration + x-ibm-ahub-byok: true + /api/events/settings/manual-close: + post: + description: Manually close a set of events. A close notification will be sent + out and the event state will be updated accordingly for each event + operationId: multiCloseEvent + requestBody: + content: + application/json: + example: + eventIds: + - DPmhOKanQ3KmQCCElqOBeg + - PRYfcm_7QRid9IRRhW3Y4w + username: user123 + reasonForClosing: Routine maintenance completed + closeTimestamp: 1691505637000 + muteAlerts: true + schema: + $ref: '#/components/schemas/ManualCloseInfo' + required: true + responses: + '200': + content: + application/json: + example: + successfulRequests: + - DPmhOKanQ3KmQCCElqOBeg + - PRYfcm_7QRid9IRRhW3Y4w + failedRequests: [ + ] + schema: + $ref: '#/components/schemas/Json' + description: The multi close operation was successful + '207': + description: At least one of the manual close operations failed + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '501': + description: The multi close feature is not enabled. + security: + - ApiKeyAuth: + - CanManuallyCloseIssue + summary: Manually closing multiple events + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/manual-close/{eventId}: + post: + description: Manually close an event (issue or incident). A close notification + will be sent out and the event state will be updated accordingly. + operationId: manuallyCloseEvent + parameters: + - example: exampleEventId + in: path + name: eventId + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + username: user123 + reasonForClosing: Routine maintenance completed + closeTimestamp: 1691505637000 + muteAlerts: true + schema: + $ref: '#/components/schemas/ManualCloseInfo' + required: true + x-payload: manuallyCloseEvent + responses: + '200': + content: + application/json: + example: | + { + "type": "issue", + "key": "__6oRuc3-oYSbWm2xjiFW7c-7RjLg__com.instana.forge.application.Endpoint__7-eW690TQA-dH4yxMDFpTQ.6oRuc3-oYSbWm2xjiFW7c-7RjLg57517532", + "id": "GdKPDQV0SR6bc184Hg4wig", + "problem": { + "id": "3Lp8tyWNTvKdypvFskzDGA", + "plugin_id": "com.instana.forge.application.Endpoint", + "steady_id": "6oRuc3-oYSbWm2xjiFW7c-7RjLg", + "host_id": "", + "problem_text": "_woot", + "fix_suggestion": "Calls are slower or equal to 3440 ms based on latency (90th).", + "explanation": "", + "severity": 5, + "experimental": false + }, + "state": "MANUALLY_CLOSED", + "metadata": { + "app20EndpointServiceLabel": "otel-shop-shipping", + "entityLabel": "/cities/{code}", + "incidentNeeded": false, + "manualCloseReason": "Routine maintenance completed", + "manualCloseTimestamp": 1730755686351, + "app20EndpointId": "6oRuc3-oYSbWm2xjiFW7c-7RjLg", + "triggeringTime": 1730754600000, + "entityName": "Endpoint", + "metricAccessId": "MjSTRXXEiDXlDRiUUZH_3pKkeNw", + "windowWarmupTime": 1200000, + "app20ApplicationId": "btg-B701Rx6o9QNXUS4TVw", + "disableEvent": false, + "manualCloseUsername": "user123", + "thresholdType": "staticThreshold", + "muteAlerts": true, + "eventConfigurationType": "Application Smart Alert", + "endpointIds": ["6oRuc3-oYSbWm2xjiFW7c-7RjLg"], + "app20ServiceId": "29af274138b88060667309e933725265a7c45208", + "serviceIds": ["29af274138b88060667309e933725265a7c45208"], + "eventSpecificationId": "7-eW690TQA-dH4yxMDFpTQ", + "alertConfigCreated": 1662545340108, + "granularity": 600000, + "metricViolationTimestamps": [1730754600000], + "custom_issue": true, + "applicationId": "btg-B701Rx6o9QNXUS4TVw", + "smartAlertInfo": { + "metricAggregation": "P90", + "metricName": "latency", + "metricValue": 44300.0, + "thresholdValue": 3440.0, + "metricUnit": "MILLIS" + }, + "customPayloads": { + "appName": ["All Services"], + "podName": ["otel-shop-shipping-5b9bd5448d-9r7h9"] + }, + "incidents": [], + "triggering": false, + "start": 1730755339666, + "end": 1730757446576, + "affectedEntities": ["MjSTRXXEiDXlDRiUUZH_3pKkeNw"], + "type": "issue", + "eventMode": "ENDPOINT_20" + } + schema: + $ref: '#/components/schemas/Event' + description: The event associated with that event id was successfully closed. + '400': + description: The manual close information is required. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: The event id refers to an event that is not open. + security: + - ApiKeyAuth: + - CanManuallyCloseIssue + summary: Manually close an event. + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/mobile-app-alert-configs: + get: + description: Gets all the Mobile Smart Alert Configuration pertaining to a specific + mobile app.Configurations are sorted by creation date in descending order. + operationId: findActiveMobileAppAlertConfigs + parameters: + - description: The ID of a specific Mobile Application. + example: tk2OLeusR3aQJD5h-rBh2A + in: query + name: mobileAppId + required: true + schema: + type: string + - description: A list of Smart Alert Configuration IDs. This allows Website + Smart Alert Configuration of a specific set of Configurations. This query + can be repeated to use multiple IDs. + example: smRTFp08juKWtn8I + in: query + name: alertIds + schema: + type: array + items: + type: string + maxItems: 1000 + minItems: 0 + uniqueItems: true + responses: + '200': + content: + application/json: + example: + - name: 'HTTP Status Code(s): 5XX' + description: Occurrences of HTTP Status Code 5XX (Server Error) is + above the expectation. + mobileAppId: tk2OLeusR3aQJD5h-rBh2A + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: statusCode + metricName: httpxxx + operator: STARTS_WITH + value: '5' + aggregation: SUM + threshold: + type: staticThreshold + operator: '>=' + value: 5.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: [ + ] + id: qOW5jlR5TQafXKWDIceRkA + created: 1707224011842 + initialCreated: 1707224011842 + readOnly: false + enabled: true + completeTagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: mobileBeacon.mobileApp.id + stringValue: tk2OLeusR3aQJD5h-rBh2A + numberValue: null + booleanValue: null + key: null + value: tk2OLeusR3aQJD5h-rBh2A + operator: EQUALS + entity: NOT_APPLICABLE + - type: TAG_FILTER + name: mobileBeacon.http.status + stringValue: '5' + numberValue: null + booleanValue: null + key: null + value: '5' + operator: STARTS_WITH + entity: NOT_APPLICABLE + schema: + type: array + items: + $ref: '#/components/schemas/WithMetadata' + description: Success. Returns empty result if mobileAppId is invalid. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Get all Mobile Smart Alert Configs + tags: + - Event Settings + x-ibm-ahub-byok: true + post: + description: 'Creates a new Mobile Smart Alert Configuration. ' + operationId: createMobileAppAlertConfig + requestBody: + content: + application/json: + example: + name: 'HTTP Status Code(s): 5XX' + description: Occurrences of HTTP Status Code 5XX (Server Error) is above + the expectation. + mobileAppId: tk2OLeusR3aQJD5h-rBh2A + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: statusCode + metricName: httpxxx + operator: STARTS_WITH + value: '5' + aggregation: SUM + threshold: + type: staticThreshold + operator: '>=' + value: 5.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: [ + ] + schema: + $ref: '#/components/schemas/MobileAppAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: 'HTTP Status Code(s): 5XX' + description: Occurrences of HTTP Status Code 5XX (Server Error) is + above the expectation. + mobileAppId: tk2OLeusR3aQJD5h-rBh2A + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: statusCode + metricName: httpxxx + operator: STARTS_WITH + value: '5' + aggregation: SUM + threshold: + type: staticThreshold + operator: '>=' + value: 5.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: [ + ] + id: qOW5jlR5TQafXKWDIceRkA + created: 1707224011842 + initialCreated: 1707224011842 + readOnly: false + enabled: true + completeTagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: mobileBeacon.mobileApp.id + stringValue: tk2OLeusR3aQJD5h-rBh2A + numberValue: null + booleanValue: null + key: null + value: tk2OLeusR3aQJD5h-rBh2A + operator: EQUALS + entity: NOT_APPLICABLE + - type: TAG_FILTER + name: mobileBeacon.http.status + stringValue: '5' + numberValue: null + booleanValue: null + key: null + value: '5' + operator: STARTS_WITH + entity: NOT_APPLICABLE + schema: + $ref: '#/components/schemas/WithMetadata' + description: Mobile Smart Alert Configuration created. + '400': + description: Invalid Configuration. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable entity. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Create Mobile Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/mobile-app-alert-configs/{id}: + delete: + description: Deletes a Mobile Smart Alert Configuration + operationId: deleteMobileAppAlertConfig + parameters: + - description: ID of a specific Mobile Smart Alert Configuration to delete. + example: qOW5jlR5TQafXKWDIceRkA + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Mobile Smart Alert Configuration deleted. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Delete Mobile Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + get: + description: Gets a specific Mobile Smart Alert Configuration. This may return + a deleted Configuration. + operationId: findMobileAppAlertConfig + parameters: + - description: ID of a specific Mobile Smart Alert Configuration to retrieve + example: qOW5jlR5TQafXKWDIceRkA + in: path + name: id + required: true + schema: + type: string + - description: 'A Unix timestamp representing a specific time the Configuration + was active. If no timestamp is provided, the latest active version will + be retrieved. ' + example: 1722877985000 + in: query + name: validOn + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + name: 'HTTP Status Code(s): 5XX' + description: Occurrences of HTTP Status Code 5XX (Server Error) is + above the expectation. + mobileAppId: tk2OLeusR3aQJD5h-rBh2A + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: statusCode + metricName: httpxxx + operator: STARTS_WITH + value: '5' + aggregation: SUM + threshold: + type: staticThreshold + operator: '>=' + value: 5.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: [ + ] + id: qOW5jlR5TQafXKWDIceRkA + created: 1707224011842 + initialCreated: 1707224011842 + readOnly: false + enabled: true + completeTagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: mobileBeacon.mobileApp.id + stringValue: tk2OLeusR3aQJD5h-rBh2A + numberValue: null + booleanValue: null + key: null + value: tk2OLeusR3aQJD5h-rBh2A + operator: EQUALS + entity: NOT_APPLICABLE + - type: TAG_FILTER + name: mobileBeacon.http.status + stringValue: '5' + numberValue: null + booleanValue: null + key: null + value: '5' + operator: STARTS_WITH + entity: NOT_APPLICABLE + schema: + $ref: '#/components/schemas/WithMetadata' + description: OK + '403': + description: Insufficient permissions. + '404': + description: The requested Configuration does not exist. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Get Mobile Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + post: + description: 'Updates an existing Mobile Smart Alert Configuration. ' + operationId: updateMobileAppAlertConfig + parameters: + - description: ID of a specific Mobile Smart Alert Configuration to update. + example: qOW5jlR5TQafXKWDIceRkA + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: 'HTTP Status Code(s): 5XX' + description: Occurrences of HTTP Status Code 5XX (Server Error) is above + the expectation. + mobileAppId: tk2OLeusR3aQJD5h-rBh2A + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: statusCode + metricName: httpxxx + operator: STARTS_WITH + value: '5' + aggregation: SUM + threshold: + type: staticThreshold + operator: '>=' + value: 5.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: [ + ] + schema: + $ref: '#/components/schemas/MobileAppAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: 'HTTP Status Code(s): 5XX' + description: Occurrences of HTTP Status Code 5XX (Server Error) is + above the expectation. + mobileAppId: tk2OLeusR3aQJD5h-rBh2A + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: statusCode + metricName: httpxxx + operator: STARTS_WITH + value: '5' + aggregation: SUM + threshold: + type: staticThreshold + operator: '>=' + value: 5.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: [ + ] + id: qOW5jlR5TQafXKWDIceRkA + created: 1707224011842 + initialCreated: 1707224011842 + readOnly: false + enabled: true + completeTagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: mobileBeacon.mobileApp.id + stringValue: tk2OLeusR3aQJD5h-rBh2A + numberValue: null + booleanValue: null + key: null + value: tk2OLeusR3aQJD5h-rBh2A + operator: EQUALS + entity: NOT_APPLICABLE + - type: TAG_FILTER + name: mobileBeacon.http.status + stringValue: '5' + numberValue: null + booleanValue: null + key: null + value: '5' + operator: STARTS_WITH + entity: NOT_APPLICABLE + schema: + $ref: '#/components/schemas/WithMetadata' + description: Mobile Smart Alert Configuration updated. + '204': + description: Mobile Smart Alert Configuration did not change. + '400': + description: Invalid Mobile App ID provided. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable entity. + '500': + description: Internal error. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Update Mobile Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/mobile-app-alert-configs/{id}/disable: + put: + description: Disables a Mobile Smart Alert Configuration. + operationId: disableMobileAppAlertConfig + parameters: + - description: ID of a specific Mobile Smart Alert Configuration to disable. + example: qOW5jlR5TQafXKWDIceRkA + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Mobile Smart Alert Configuration disabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Disable Mobile Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/mobile-app-alert-configs/{id}/enable: + put: + description: Enables a Mobile Smart Alert Configuration. + operationId: enableMobileAppAlertConfig + parameters: + - description: ID of a specific Mobile Smart Alert Configuration to enable. + example: qOW5jlR5TQafXKWDIceRkA + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Mobile Smart Alert Configuration enabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Enable Mobile Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/mobile-app-alert-configs/{id}/restore/{created}: + put: + description: Restores a Mobile Smart Alert Configuration. + operationId: restoreMobileAppAlertConfig + parameters: + - description: ID of a specific Mobile Smart Alert Configuration to restore. + example: qOW5jlR5TQafXKWDIceRkA + in: path + name: id + required: true + schema: + type: string + - description: Unix timestamp representing the creation time of a specific Mobile + Smart Alert Configuration. + example: 1707726529124 + in: path + name: created + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Mobile Smart Alert Configuration restored. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration provided. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Restore Mobile Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/mobile-app-alert-configs/{id}/update-baseline: + post: + description: Recalculates and updates the historic baseline (static seasonal + threshold) of a Configuration. The `LastUpdated` field of the Configuration + is changed to the current time. + operationId: updateMobileAppHistoricBaseline + parameters: + - description: ID of a specific Mobile Smart Alert Configuration to recalculate. + example: qOW5jlR5TQafXKWDIceRkA + in: path + name: id + required: true + schema: + type: string + responses: + '200': + description: Mobile Smart Alert Configuration baseline successfully recalculated + and updated. + '204': + description: Baseline recalculation completed with no changes needed. + '400': + description: Invalid configuration type or configuration is read-only. + '403': + description: Insufficient permissions to access this configuration. + '404': + description: Mobile Smart Alert Configuration not found. + '428': + description: Baseline calculation failed due to insufficient data. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Recalculate Mobile Smart Alert Config Baseline + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/mobile-app-alert-configs/{id}/versions: + get: + description: Gets all versions of a Mobile Smart Alert Configuration. This may + return deleted Configurations. Configurations are sorted by creation date + in descending order. + operationId: findMobileAppAlertConfigVersions + parameters: + - description: ID of a specific Mobile Smart Alert Configuration to retrieve. + example: qOW5jlR5TQafXKWDIceRkA + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: qOW5jlR5TQafXKWDIceRkA + created: 1706686318650 + enabled: true + deleted: false + changeSummary: + changeType: CREATE + author: + id: 5ee8a3e8cd70020001ecb007 + type: USER + fullName: Stan + schema: + type: array + items: + $ref: '#/components/schemas/ConfigVersion' + description: OK + '403': + description: Insufficient permissions. + '404': + description: The requested Configuration does not exist. + security: + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts + summary: Get Mobile Smart Alert Config Versions + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/website-alert-configs: + get: + description: Gets all the Website Smart Alert Configuration pertaining to a + specific website. Configurations are sorted by creation date in descending + order. + operationId: findActiveWebsiteAlertConfigs + parameters: + - description: The ID of a specific Website + example: XIZGGVT1TX2O-0OFeT2Yig + in: query + name: websiteId + required: true + schema: + type: string + - description: A list of Smart Alert Configuration IDs. This allows fetching + of a specific set of Configurations. This query can be repeated to use multiple + IDs. + example: smRTFp08juKWtn8I + in: query + name: alertIds + schema: + type: array + items: + type: string + maxItems: 1000 + minItems: 0 + uniqueItems: true + responses: + '200': + content: + application/json: + example: + - name: onLoad Time (90th) is too high + description: The onLoad Time (90th) is above the expectation. + websiteId: XIZGGVT1TX2O-0OFeT2Yig + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: slowness + metricName: onLoadTime + aggregation: P90 + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 239.164 + - 6.1026 + - - 600000 + - 240.0013 + - 7.4109 + - - 85200000 + - 241.3653 + - 3 + - - 85800000 + - 239.4759 + - 3.9012 + deviationFactor: 3.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: + - type: staticString + key: '1' + value: '2' + - type: dynamic + key: '2' + value: + tagName: beacon.website.name + key: null + id: G-h5p0znTHan2m2U3c-Z1Q + created: 1707726529124 + initialCreated: 1707726529124 + readOnly: false + enabled: true + schema: + type: array + items: + $ref: '#/components/schemas/WebsiteAlertConfigWithMetadata' + description: Success. Returns empty result if websiteId is invalid. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Get all Website Smart Alert Configs + tags: + - Event Settings + x-ibm-ahub-byok: true + post: + description: Creates a new Website Smart Alert Configuration. + operationId: createWebsiteAlertConfig + requestBody: + content: + application/json: + example: + name: onLoad Time (90th) is too high + description: The onLoad Time (90th) is above the expectation. + websiteId: XIZGGVT1TX2O-0OFeT2Yig + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: slowness + metricName: onLoadTime + aggregation: P90 + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 239.164 + - 6.1026 + - - 600000 + - 240.0013 + - 7.4109 + - - 85200000 + - 241.3653 + - 3 + - - 85800000 + - 239.4759 + - 3.9012 + deviationFactor: 3.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: + - type: staticString + key: '1' + value: '2' + - type: dynamic + key: '2' + value: + tagName: beacon.website.name + key: null + schema: + $ref: '#/components/schemas/WebsiteAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: onLoad Time (90th) is too high + description: The onLoad Time (90th) is above the expectation. + websiteId: XIZGGVT1TX2O-0OFeT2Yig + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: slowness + metricName: onLoadTime + aggregation: P90 + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 239.164 + - 6.1026 + - - 600000 + - 240.0013 + - 7.4109 + - - 85200000 + - 241.3653 + - 3 + - - 85800000 + - 239.4759 + - 3.9012 + deviationFactor: 3.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: + - type: staticString + key: '1' + value: '2' + - type: dynamic + key: '2' + value: + tagName: beacon.website.name + key: null + id: G-h5p0znTHan2m2U3c-Z1Q + created: 1707726529124 + initialCreated: 1707726529124 + readOnly: false + enabled: true + schema: + $ref: '#/components/schemas/WebsiteAlertConfigWithMetadata' + description: Website Smart Alert Configuration created. + '400': + description: Invalid configuration. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable entity. + '428': + description: Baseline calculation failed due to insufficient data. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Create Website Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/website-alert-configs/{id}: + delete: + description: Deletes a Website Smart Alert Configuration. + operationId: deleteWebsiteAlertConfig + parameters: + - description: ID of a specific Website Smart Alert Configuration to delete. + example: G-h5p0znTHan2m2U3c-Z1Q + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Website Smart Alert Configuration deleted. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Delete Website Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + get: + description: Gets a specific Website Smart Alert Configuration. This may return + a deleted Configuration. + operationId: findWebsiteAlertConfig + parameters: + - description: ID of a specific Website Smart Alert Configuration to retrieve. + example: G-h5p0znTHan2m2U3c-Z1Q + in: path + name: id + required: true + schema: + type: string + - description: 'A Unix timestamp representing a specific time the config was + active. If no timestamp is provided, the latest active version will be retrieved. ' + example: 1722877985000 + in: query + name: validOn + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + name: onLoad Time (90th) is too high + description: The onLoad Time (90th) is above the expectation. + websiteId: XIZGGVT1TX2O-0OFeT2Yig + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: slowness + metricName: onLoadTime + aggregation: P90 + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 239.164 + - 6.1026 + - - 600000 + - 240.0013 + - 7.4109 + - - 85200000 + - 241.3653 + - 3 + - - 85800000 + - 239.4759 + - 3.9012 + deviationFactor: 3.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: + - type: staticString + key: '1' + value: '2' + - type: dynamic + key: '2' + value: + tagName: beacon.website.name + key: null + id: G-h5p0znTHan2m2U3c-Z1Q + created: 1707726529124 + initialCreated: 1707726529124 + readOnly: false + enabled: true + schema: + $ref: '#/components/schemas/WebsiteAlertConfigWithMetadata' + description: OK + '403': + description: Insufficient permissions. + '404': + description: The requested configuration does not exist. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Get Website Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + post: + description: Updates an existing Website Smart Alert Configuration. + operationId: updateWebsiteAlertConfig + parameters: + - description: ID of a specific Website Smart Alert Configuration to update. + example: G-h5p0znTHan2m2U3c-Z1Q + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: onLoad Time (90th) is too high + description: The onLoad Time (90th) is above the expectation. + websiteId: XIZGGVT1TX2O-0OFeT2Yig + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: slowness + metricName: onLoadTime + aggregation: P90 + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 239.164 + - 6.1026 + - - 600000 + - 240.0013 + - 7.4109 + - - 85200000 + - 241.3653 + - 3 + - - 85800000 + - 239.4759 + - 3.9012 + deviationFactor: 3.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: + - type: staticString + key: '1' + value: '2' + - type: dynamic + key: '2' + value: + tagName: beacon.website.name + key: null + schema: + $ref: '#/components/schemas/WebsiteAlertConfig' + required: true + responses: + '200': + content: + application/json: + example: + name: onLoad Time (90th) is too high + description: The onLoad Time (90th) is above the expectation. + websiteId: XIZGGVT1TX2O-0OFeT2Yig + severity: 5 + triggering: false + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + rule: + alertType: slowness + metricName: onLoadTime + aggregation: P90 + threshold: + type: historicBaseline + operator: '>=' + seasonality: DAILY + baseline: + - - 0 + - 239.164 + - 6.1026 + - - 600000 + - 240.0013 + - 7.4109 + - - 85200000 + - 241.3653 + - 3 + - - 85800000 + - 239.4759 + - 3.9012 + deviationFactor: 3.0 + lastUpdated: 0 + alertChannelIds: [ + ] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: + - type: staticString + key: '1' + value: '2' + - type: dynamic + key: '2' + value: + tagName: beacon.website.name + key: null + id: G-h5p0znTHan2m2U3c-Z1Q + created: 1707726529124 + initialCreated: 1707726529124 + readOnly: false + enabled: true + schema: + $ref: '#/components/schemas/WebsiteAlertConfigWithMetadata' + description: Website Smart Alert Configuration updated. + '204': + description: Website Smart Alert Configuration did not change. + '400': + description: Invalid Configuration ID provided. + '403': + description: Insufficient permissions. + '404': + description: The requested configuration does not exist. + '422': + description: Unprocessable entity. + '428': + description: Baseline calculation failed due to insufficient data. + '500': + description: Internal error. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Update Website Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/website-alert-configs/{id}/disable: + put: + description: Disables a Website Smart Alert Configuration. + operationId: disableWebsiteAlertConfig + parameters: + - description: ID of a specific Website Smart Alert Configuration to disable. + example: G-h5p0znTHan2m2U3c-Z1Q + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Website Smart Alert Configuration disabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Disable Website Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/website-alert-configs/{id}/enable: + put: + description: Enables a website alert configuration. + operationId: enableWebsiteAlertConfig + parameters: + - description: ID of a specific Website Smart Alert Configuration to enable. + example: G-h5p0znTHan2m2U3c-Z1Q + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Website Smart Alert Configuration enabled. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration ID provided. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Enable Website Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/website-alert-configs/{id}/restore/{created}: + put: + description: Restores a deleted Website Smart Alert Configuration. + operationId: restoreWebsiteAlertConfig + parameters: + - description: ID of a specific Website Smart Alert Configuration to restore. + example: G-h5p0znTHan2m2U3c-Z1Q + in: path + name: id + required: true + schema: + type: string + - description: Unix timestamp representing the creation time of a specific Website + Smart Alert Configuration. + example: 1707726529124 + in: path + name: created + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + type: string + nullable: true + responses: + '204': + description: Website Smart Alert Configuration restored. + '403': + description: Insufficient permissions. + '404': + description: Invalid Configuration provided. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Restore Website Smart Alert Config + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/website-alert-configs/{id}/update-baseline: + post: + description: Recalculates and updates the historic baseline (static seasonal + threshold) of a Configuration. The `LastUpdated` field of the Configuration + is changed to the current time. + operationId: updateWebsiteHistoricBaseline + parameters: + - description: ID of a specific Website Smart Alert Configuration to recalculate. + example: G-h5p0znTHan2m2U3c-Z1Q + in: path + name: id + required: true + schema: + type: string + responses: + '200': + description: Website Smart Alert Configuration baseline successfully recalculated + and updated. + '204': + description: Baseline recalculation completed with no changes needed. + '400': + description: Invalid configuration type or configuration is read-only. + '403': + description: Insufficient permissions to access this configuration. + '404': + description: Website Smart Alert Configuration not found. + '428': + description: Baseline calculation failed due to insufficient data. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: Recalculate Website Smart Alert Config Baseline + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/settings/website-alert-configs/{id}/versions: + get: + description: Gets all versions of a Website Smart Alert Configuration. This + may return deleted Configurations. Configurations are sorted by creation date + in descending order. + operationId: findWebsiteAlertConfigVersions + parameters: + - description: ID of a specific Website Smart Alert Configuration to retrieve. + example: G-h5p0znTHan2m2U3c-Z1Q + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: G-h5p0znTHan2m2U3c-Z1Q + created: 1706709825308 + enabled: true + deleted: false + changeSummary: + changeType: CREATE + author: + id: 5ee8a3e8cd70020001ecb007 + type: USER + fullName: Stan + schema: + type: array + items: + $ref: '#/components/schemas/ConfigVersion' + description: OK + '403': + description: Insufficient permissions. + '404': + description: The requested Configuration does not exist. + security: + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts + summary: 'Get Website Smart Alert Config Versions. ' + tags: + - Event Settings + x-ibm-ahub-byok: true + /api/events/{eventId}: + get: + description: Gets a specific event. + operationId: getEvent + parameters: + - description: ID of a specific Event to retrieve. + example: LZOGo1lXR4WeCB2ftgtGGQ + in: path + name: eventId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + eventId: LZOGo1lXR4WeCB2ftgtGGQ + start: 1706783553000 + end: 1706783553000 + type: change + state: closed + problem: Pulled + detail: Successfully pulled image "registry.redhat.io/redhat/redhat-marketplace-index:v4.14" + in 830.603468ms (830.624088ms including waiting) + severity: -2 + entityName: Kubernetes Pod + entityLabel: openshift-marketplace/redhat-marketplace-qbn8f (pod) + entityType: INFRASTRUCTURE + fixSuggestion: Successfully pulled image "registry.redhat.io/redhat/redhat-marketplace-index:v4.14" + in 830.603468ms (830.624088ms including waiting) + snapshotId: xLziJivLyeepxBf0UnNR1ff-9MI + schema: + $ref: '#/components/schemas/EventResult' + description: OK + '404': + description: The requested event does not exist. + security: + - ApiKeyAuth: + - Default + summary: Get Event + tags: + - Events + x-ibm-ahub-byok: true + /api/host-agent: + get: + operationId: searchHostAgents + parameters: + - in: query + name: query + schema: + type: string + - in: query + name: to + schema: + type: integer + format: int64 + - in: query + name: windowSize + schema: + type: integer + format: int64 + - in: query + name: size + schema: + type: integer + format: int32 + - in: query + name: offline + schema: + type: boolean + responses: + '200': + content: + application/json: + example: |2 + { + "items": [ + { + "snapshotId": "iRsnjcH9cls2rlx3wm8ENPapljk", + "plugin": "instanaAgent", + "from": 1706712590000, + "to": null, + "tags": [], + "label": "Instana Agent @ ip-10-255-207-205", + "host": "EC2-i-0a8be85269f7e2b92" + }, + ] + } + schema: + $ref: '#/components/schemas/SnapshotResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Query host agent snapshots + tags: + - Host Agent + x-ibm-ahub-byok: true + /api/host-agent/configuration: + post: + operationId: updateConfigurationByQuery + parameters: + - in: query + name: query + schema: + type: string + - in: query + name: to + schema: + type: integer + format: int64 + - in: query + name: windowSize + schema: + type: integer + format: int64 + - in: query + name: size + schema: + type: integer + format: int32 + - in: query + name: offline + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AgentConfigurationUpdate' + x-payload: updateConfigurationByQuery + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents + summary: Update agent configuration by query + tags: + - Host Agent + x-description: updateConfigurationByQuery + x-ibm-ahub-byok: true + /api/host-agent/{hostId}/clr-logs: + get: + operationId: getAgentClrLogs + parameters: + - in: path + name: hostId + required: true + schema: + type: string + - in: query + name: download + schema: + type: boolean + responses: + default: + content: + application/octet-stream: { + } + description: default response + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents + summary: Agent CLR download logs + tags: + - Host Agent + x-ibm-ahub-byok: true + /api/host-agent/{hostId}/configuration: + post: + operationId: updateConfigurationByHost + parameters: + - in: path + name: hostId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AgentConfigurationUpdate' + x-payload: updateConfigurationByHost + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents + summary: Update agent configuration by host + tags: + - Host Agent + x-description: updateConfigurationByHost + x-ibm-ahub-byok: true + /api/host-agent/{hostId}/logs: + get: + operationId: getAgentLogs + parameters: + - in: path + name: hostId + required: true + schema: + type: string + - in: query + name: download + schema: + type: boolean + - in: query + name: file + required: true + schema: + type: array + items: + type: string + uniqueItems: true + responses: + default: + content: + application/octet-stream: { + } + description: default response + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents + summary: Agent download logs + tags: + - Host Agent + x-ibm-ahub-byok: true + /api/host-agent/{hostId}/support-info: + get: + operationId: getAgentSupportInformation + parameters: + - in: path + name: hostId + required: true + schema: + type: string + - in: query + name: supportInfoId + required: true + schema: + type: string + responses: + default: + content: + application/octet-stream: { + } + description: default response + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents + summary: Agent download support information + tags: + - Host Agent + x-ibm-ahub-byok: true + /api/host-agent/{hostId}/update: + post: + operationId: updateAgent + parameters: + - in: path + name: hostId + required: true + schema: + type: string + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents + summary: Agent update + tags: + - Host Agent + x-ibm-ahub-byok: true + /api/host-agent/{id}: + get: + operationId: getAgentSnapshot + parameters: + - in: path + name: id + required: true + schema: + type: string + - in: query + name: to + schema: + type: integer + format: int64 + - in: query + name: windowSize + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: |2 + { + "snapshotId": "snapshot id", + "plugin": "instanaAgent", + "from": 1706791431000, + "tags": [], + "label": "Instana Agent @ ip-10-255-207-205", + "entityId": { + "host": "EC2-i-0a8be85269f7e2b92", + "pluginId": "plugin id", + "steadyId": "self" + }, + "data": { + "memory.nativeTotal": 134217728, + "capabilities": [ + "gitops", + "logdownload", + "agentprofiler", + "agentSupportInfo", + { + "java-trace-commands": [ + "get-agent-statistics", + "get-loader-statistics", + "get-tracer-statistics", + "get-instrumentation-install-messages", + "get-instrumentation-install-errors", + "get-instrumentation-runtime-errors", + "get-instrumented-classes", + "get-raw-matchers", + "get-weak-concurrent-maps", + "log-reset", + "log-trace-context", + "log-rejected", + "start-debug-tracer", + "stop-debug-tracer" + ] + }, + "log4j-safe-lib" + ], + "origin": "public_docker", + "startedAt": 1705917107361, + "memory.total": 181805056, + "pid": "29001", + "mode": 2, + "hostname": "ip-10-255-207-205", + "java": { + "vmversion": "25.392-b08", + "version": "1.8.0_392", + "vmname": "vm name", + "vmvendor": "vendor name" + }, + "git": { + "present": true, + "initialized": false + }, + "hasCpuLoad": true, + "updateMode": "Auto", + "log.counts.byMessage": { + "?:?": "WARN ? "Can no longer query container metrics for k8s.io: 8ac777f1ca6231299050ee5482ecac6c1747b2545b3b1d890f69d0a849b3adb4 ... requesting sensor shutdown"" + }, + "loglevel": "INFO", + "agentVersion": "Latest", + "metrics": true, + "boot": "1.2.30", + "pids": [ + "14096", + "19502", + "2001", + "29812", + "981", + "28411", + "29522", + "1267", + "2475", + "27182" + ], + "user": "root", + "logAsRate": true + } + } + schema: + $ref: '#/components/schemas/SnapshotItem' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get host agent snapshot details + tags: + - Host Agent + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/analyze/entities: + post: + description: |- + This endpoint retrieves entities for a given entity type along with the requested metrics. + For more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze. + operationId: getEntities + requestBody: + content: + application/json: + examples: + ? This example retrieves a JVM entity labeled "custom-metrics.jar" with + metrics for memory used and blocked threads (both using a one hour + granularity and a one minute granularity). + : description: This example retrieves a JVM entity labeled "custom-metrics.jar" + with metrics for memory used and blocked threads (both using a one + hour granularity and a one minute granularity). + value: + tagFilterExpression: + type: TAG_FILTER + entity: NOT_APPLICABLE + name: label + operator: EQUALS + value: custom-metrics.jar + timeFrame: + to: 1673969562715 + windowSize: 3600000 + pagination: + retrievalSize: 200 + type: jvmRuntimePlatform + metrics: + - metric: memory.used + granularity: 3600000 + aggregation: MAX + - metric: memory.used + granularity: 600000 + aggregation: MAX + - metric: threads.blocked + granularity: 3600000 + aggregation: MEAN + - metric: threads.blocked + granularity: 600000 + aggregation: MEAN + schema: + $ref: '#/components/schemas/GetInfrastructureQuery' + x-payload: getInfrastructureQuery + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InfrastructureEntitiesResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get infrastructure entities + tags: + - Infrastructure Analyze + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/analyze/entity-groups: + post: + description: |- + This endpoint groups entities for a given entity type and aggregates metrics for these groups. + For more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze. + operationId: getEntityGroups + requestBody: + content: + application/json: + examples: + ? This example retrieves JVM entities grouped with the same host name + ordered by label, aggregating memory used and blocked threads (both + using a one hour granularity and a one minute granularity). + : description: This example retrieves JVM entities grouped with the + same host name ordered by label, aggregating memory used and blocked + threads (both using a one hour granularity and a one minute granularity). + value: + timeFrame: + to: 1674075565075 + windowSize: 3600000 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + pagination: + retrievalSize: 20 + groupBy: + - host.name + type: jvmRuntimePlatform + metrics: + - metric: memory.used + granularity: 3600000 + aggregation: MEAN + - metric: memory.used + granularity: 600000 + aggregation: MEAN + - metric: threads.blocked + granularity: 3600000 + aggregation: MEAN + - metric: threads.blocked + granularity: 600000 + aggregation: MEAN + order: + by: label + direction: ASC + schema: + $ref: '#/components/schemas/GetInfrastructureGroupsQuery' + x-payload: GetInfrastructureGroupsQuery + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InfrastructureGroupsResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get grouped infrastructure entities with aggregated metrics + tags: + - Infrastructure Analyze + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/analyze/entity-types: + post: + description: |- + This endpoint retrieves available entity types. + For more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze. + operationId: getAvailablePlugins + requestBody: + content: + application/json: + examples: + This example retrieves all entity types.: + description: This example retrieves all entity types. + value: + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + timeFrame: + to: 1673969562715 + windowSize: 3600000 + schema: + $ref: '#/components/schemas/GetAvailablePluginsQuery' + x-payload: GetAvailablePluginsQuery + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AvailablePlugins' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get available entity types + tags: + - Infrastructure Analyze + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/analyze/metrics: + post: + description: |- + This endpoint retrieves available metrics for an entity type. + For more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze. + operationId: getAvailableMetrics + requestBody: + content: + application/json: + examples: + This example retrieves all available metrics for JVM entities.: + description: This example retrieves all available metrics for JVM + entities. + value: + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + timeFrame: + to: 1673969562715 + windowSize: 3600000 + query: '' + type: jvmRuntimePlatform + schema: + $ref: '#/components/schemas/GetAvailableMetricsQuery' + x-payload: GetAvailableMetricsQuery + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AvailableMetrics' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get available metrics + tags: + - Infrastructure Analyze + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/catalog/metrics/{plugin}: + get: + operationId: getInfrastructureCatalogMetrics + parameters: + - in: path + name: plugin + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: label + schema: + type: string + - in: query + name: limit + schema: + type: integer + format: int32 + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MetricInstance' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get metric catalog + tags: + - Infrastructure Catalog + x-description: getInfrastructureCatalogMetrics + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/catalog/payloads/{pluginId}: + get: + description: 'This endpoint retrieves the list of keys that can be used to retrieve + payloads for a plugin. ' + operationId: getAvailablePayloadKeysByPluginId + parameters: + - description: plugin id + example: db2Database + in: path + name: pluginId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GetPayloadKeysResult' + description: OK + links: + payload for snapshot: + operationId: getPluginPayload + parameters: + payloadKey: $response.body#/[*] + security: + - ApiKeyAuth: + - Default + summary: Get payload keys for plugin + tags: + - Infrastructure Catalog + x-description: getAvailablePayloadKeysByPluginId + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/catalog/plugins: + get: + operationId: getInfrastructureCatalogPlugins + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PluginResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get plugin catalog + tags: + - Infrastructure Catalog + x-description: getInfrastructureCatalogPlugins + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/catalog/plugins-with-custom-metrics: + get: + description: This endpoint retrieves a list of all plugins that have custom + metrics + operationId: getInfrastructureCatalogPluginsWithCustomMetrics + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PluginResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get all plugins with custom metrics catalog + tags: + - Infrastructure Catalog + x-description: getInfrastructureCatalogPluginsWithCustomMetrics + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/catalog/search: + get: + operationId: getInfrastructureCatalogSearchFields + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SearchFieldResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: get search field catalog + tags: + - Infrastructure Catalog + x-description: getInfrastructureCatalogSearchFields + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/catalog/tags: + get: + description: This endpoint retrieves the tag catalog. + operationId: getTagCatalogAll + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TagCatalog' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get available tags + tags: + - Infrastructure Catalog + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/catalog/tags/{plugin}: + get: + description: This endpoint retrieves the tag catalog filtered by plugin. + operationId: getTagCatalog + parameters: + - description: plugin + example: host + in: path + name: plugin + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TagCatalog' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get available tags for a particular plugin + tags: + - Infrastructure Catalog + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/graph/related-hosts/{snapshotId}: + get: + description: Gets the Related Hosts + operationId: getRelatedHosts + parameters: + - description: Snapshot ID running on the host + in: path + name: snapshotId + required: true + schema: + type: string + - description: Size of time window in milliseconds + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: Timestamp since Unix Epoch in milliseconds of the end of the + time window + in: query + name: to + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + - ZoKkksp277FMLSXIghPKdjZcvfE + schema: + type: array + items: + type: string + description: Returns the snapshot ID of the hosts + security: + - ApiKeyAuth: + - Default + summary: Related hosts + tags: + - Infrastructure Topology + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/metrics: + post: + description: |2- + + For more information on Infrastructure Metrics please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-metrics. + operationId: getInfrastructureMetrics + parameters: + - in: query + name: offline + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetCombinedMetrics' + x-payload: getInfrastructureMetrics + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/InfrastructureMetricResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get infrastructure metrics + tags: + - Infrastructure Metrics + x-description: getInfrastructureMetrics + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/monitoring-state: + get: + description: This API endpoint retrieves the current monitoring state of the + system, providing details about the number of monitored hosts and serverless + entities. It responds with a JSON object containing this information. + operationId: getMonitoringState + responses: + '200': + content: + application/json: + example: + hasEntities: true + hostCount: 122 + serverlessCount: 7 + schema: + $ref: '#/components/schemas/MonitoringState' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Monitored host count + tags: + - Infrastructure Resources + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/payloads/{snapshotId}/{payloadKey}: + get: + description: This endpoint retrieves the payload for a snapshot. Please note + that this endpoint is only available for instances of db2. + operationId: getPluginPayload + parameters: + - description: Snapshot id. + in: path + name: snapshotId + required: true + schema: + type: string + - description: Payload key. Use [getAvailablePayloadKeysByPluginId](/openapi/#operation/getAvailablePayloadKeysByPluginId) + to retrieve the list of possible keys. + example: topqueries + in: path + name: payloadKey + required: true + schema: + type: string + - description: End of timeframe expressed as the Unix epoch time in milliseconds. + example: 1689018652000 + in: query + name: to + schema: + type: integer + format: int64 + - description: Window size in milliseconds. + example: 3600000 + in: query + name: windowSize + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + raw_payload: + - DEFERRED_VALUE: '64' + DEFERRED_VALUE_FLAGS: NONE + VALUE: '64' + NAME: app_ctl_heap_sz + VALUE_FLAGS: NONE + timestamp: 1707833086000 + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get a payload for a snapshot + tags: + - Infrastructure Resources + x-description: getPluginPayload + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/snapshots: + get: + operationId: getSnapshots + parameters: + - description: query to use to filter snapshot retrieval + example: entity.zone:myZone* + in: query + name: query + schema: + type: string + - description: end of timeframe expressed as the Unix epoch time in milliseconds + example: 1689018652000 + in: query + name: to + schema: + type: integer + format: int64 + - description: windowSize in milliseconds + example: 3600000 + in: query + name: windowSize + schema: + type: integer + format: int64 + - description: maximum number of snapshots to retrieve + example: 100 + in: query + name: size + schema: + type: integer + format: int32 + - description: entity type + example: host + in: query + name: plugin + schema: + type: string + - description: retrieve snapshots which were online during the timeframe, otherwise, + return only snapshot which were online at the end of the timeframe + example: false + in: query + name: offline + schema: + type: boolean + responses: + '200': + content: + application/json: + example: + items: + - snapshotId: ZoKkksp277FMLSXIghPKdjZcvfE + plugin: host + from: 1706785156000 + to: null + tags: [ + ] + label: ip-10-255-200-30.instana.io + host: EC2-i-03afb0ac5188f57f3 + - snapshotId: ONRQyD-iztZX6QS9QnjKbFFy-oI + plugin: host + from: 1706756437000 + to: null + tags: [ + ] + label: ip-10-255-218-45.instana.io + host: EC2-i-091cba86bac58cc77 + - snapshotId: 0GvRrdko-0Ds9OWPzJVEm0j0vTA + plugin: host + from: 1706785131000 + to: null + tags: [ + ] + label: ip-10-255-203-60.instana.io + host: EC2-i-0d2743935b9596c85 + schema: + $ref: '#/components/schemas/SnapshotResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Search snapshots + tags: + - Infrastructure Resources + x-description: getSnapshots + x-ibm-ahub-byok: true + post: + description: This endpoint retrieves detail information for one or more snapshots. + timeFrame defaults to the last 10 minutes if not specified. + operationId: postSnapshots + requestBody: + content: + application/json: + examples: + This example retrieves the detail information for two snapshots.: + description: This example retrieves the detail information for two + snapshots. + value: + snapshotIds: + - AB3DeFGHIJkLm9OpQrstUVwxY_z + - ZY4XwVUTSRqPo8MlKjihGFedC_a + timeFrame: + to: 1689018652000 + windowSize: 3600000 + schema: + $ref: '#/components/schemas/GetSnapshotsQuery' + x-payload: getSnapshotsQuery + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PostSnapshotsResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get snapshot details for multiple snapshots + tags: + - Infrastructure Resources + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/snapshots/{id}: + get: + description: Get all snapshot information + operationId: getSnapshot + parameters: + - description: snapshot id + in: path + name: id + required: true + schema: + type: string + - description: end of timeframe expressed as the Unix epoch time in milliseconds + example: 1689018652000 + in: query + name: to + schema: + type: integer + format: int64 + - description: windowSize in milliseconds + example: 3600000 + in: query + name: windowSize + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + snapshotId: ZoKkksp277FMLSXIghPKdjZcvfE + plugin: host + from: 1706785156000 + tags: [ + ] + label: ip-10-255-200-30.instana.io + entityId: + host: EC2-i-03afb0ac5188f57f3 + pluginId: com.instana.forge.infrastructure.os.host.Host + steadyId: h + data: + interfaces: + eth0: + addresses: + - subnet: 10.255.200.0 + fqdn: + - 10-255-200-30.instana-agent-headless.instana-agent.svc.cluster.local + - 10-255-200-30.instana-agent.instana-agent.svc.cluster.local + - 10-255-200-30.prometheus-prometheus-node-exporter.prometheus.svc.cluster.local + ip: 10.255.200.30 + mac: 06:00:E9:32:99:C5 + eth1: + addresses: + - subnet: 10.255.200.0 + ip: 10.255.205.14 + mac: 06:93:A2:5B:97:D9 + cpu.model: AMD EPYC 7R13 Processor + fqdn: ip-10-255-200-30.instana.io + bootId: 3b7e2fe9-7cff-42bb-9879-6b856582fa27 + os.arch: amd64 + start: 1694791889000 + memory.total: 65994727424 + openFiles.max: 6441978 + filesystems: + /dev/nvme0n1p1: + options: rw,noatime,attr2,inode64,logbufs=8,logbsize=32k,noquota + mounts: + - /var/lib/kubelet/pods/dc320aef-ef0e-499a-8eb2-56cb454c22d6/volume-subpaths/configuration/instana-agent/11 + - /var/lib/kubelet/pods/dc320aef-ef0e-499a-8eb2-56cb454c22d6/volume-subpaths/configuration/instana-agent/14 + - /var/lib/kubelet/pods/dc320aef-ef0e-499a-8eb2-56cb454c22d6/volume-subpaths/additional-backend-2/instana-agent/12 + - /var/lib/kubelet/pods/dc320aef-ef0e-499a-8eb2-56cb454c22d6/volume-subpaths/additional-backend-3/instana-agent/13 + - / + systype: xfs + icapacity: 28180816 + mount: / + capacity: 83873772 + os.version: 5.10.186-179.751.amzn2.x86_64 + tags: [ + ] + cpu.count: 8 + hostname: ip-10-255-200-30 + machineId: ec2f95ff87a4a46d4672835afb9e2bb5 + systemSerialNumber: ec2f95ff-87a4-a46d-4672-835afb9e2bb5 + os.name: Linux + schema: + $ref: '#/components/schemas/SnapshotItem' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get snapshot details + tags: + - Infrastructure Resources + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/software/versions: + get: + description: |- + Retrieve information about the software that are sensed by the agent remotely, natively, or both. This includes runtime and package manager information. + + The `plugin`, `name`, `version`, `discoveryType`, `softwareType` and `vendor` parameters are optional filters that can be used to reduce the result data set. + The `snapshotId` in `usedBy` is either of host or container, if available + operationId: softwareVersions + parameters: + - description: Timeframe expressed as the Unix epoch time in milliseconds + in: query + name: time + schema: + type: integer + format: int64 + - description: Filter on discoveryType + example: NATIVE_SENSOR + in: query + name: discoveryType + schema: + type: string + enum: + - NATIVE_SENSOR + - REMOTE_SENSOR + - PACKAGE_MANAGER + - OTHER + - description: Filter on softwareType + example: DEPENDENCY + in: query + name: softwareType + schema: + type: string + enum: + - DEPENDENCY + - RUNTIME + - DATABASE + - MESSAGING + - PLATFORM + - PACKAGE + - OS + - CACHE + - API_GATEWAY + - OTHER + - APPLICATION_FRAMEWORK + - description: Filter on this software name + in: query + name: name + schema: + type: string + - description: Filter on this plugin + in: query + name: plugin + schema: + type: string + - description: Filter on this version + in: query + name: version + schema: + type: string + - description: Filter on this vendor + in: query + name: vendor + schema: + type: string + responses: + '200': + content: + application/json: + example: | + [ + { + "name": "errno", + "plugin": "nodeJsRuntimePlatform", + "version": "0.1.8", + "discoveryType": "NATIVE_SENSOR", + "softwareType": "DEPENDENCY", + "vendor": "", + "metadata": {}, + "usedBy": [ + { + "host": "instana-centos1.fyre.ibm.com", + "container": null, + "process": "instana-payload-simulator v1.0.0", + "snapshotId": "nQHb946M0I_rzRNuTFLVVSUorr8" + } + ] + }, + { + "name": "OpenJDK 64-Bit Server VM", + "plugin": "jvmRuntimePlatform" + "version": "17.0.1", + "discoveryType": "NATIVE_SENSOR", + "softwareType": "RUNTIME", + "vendor": "Azul Systems, Inc.", + "metadata": {}, + "usedBy": [ + { + "host": "lima-rancher-desktop", + "container": "elasticsearch/elasticsearch:7.16.2", + "process": "docker-cluster: 0c930ef6c5af", + "snapshotId": "cn06irROoHrvrDEa4fWw9vD6yhc" + } + ] + } + ] + schema: + type: array + items: + $ref: '#/components/schemas/SoftwareVersion' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get installed software + tags: + - Infrastructure Resources + x-ibm-ahub-byok: true + /api/infrastructure-monitoring/topology: + get: + operationId: getTopology + parameters: + - description: Include snapshot data in nodes + in: query + name: includeData + schema: + type: boolean + responses: + '200': + content: + application/json: + example: + nodes: + - id: nYlAch5BEuXdyzQ1Q1V3QvW9jpY + plugin: kubernetesPod + label: openshift-console/downloads-6b8f4d6dfc-zv2tx (pod) + entityId: + host: '' + pluginId: com.instana.forge.infrastructure.paas.kubernetes.derivedentity.pod.KubernetesPod + steadyId: b3e550f4-5754-4388-bd44-025ecd9f057e + edges: + - source: i5wh2JGMSHMiSt_TH2sHo1rNLaQ + destination: k67B5nn-7mpx6i0oCEiIWvP46ko + relation: in + schema: + $ref: '#/components/schemas/Topology' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Gets the infrastructure topology + tags: + - Infrastructure Topology + x-ibm-ahub-byok: true + /api/instana/health: + get: + description: Get basic health of application. + operationId: getHealthState + responses: + '200': + content: + application/json: + example: + health: GREEN + messages: [ + ] + schema: + $ref: '#/components/schemas/HealthState' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Basic health traffic light + tags: + - Health + x-description: getHealthState + x-ibm-ahub-byok: true + /api/instana/usage/api: + get: + operationId: getAllUsage + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UsageResult' + description: OK + security: + - ApiKeyAuth: + - CanViewAccountAndBillingInformation + summary: API usage by customer + tags: + - Usage + x-ibm-ahub-byok: true + /api/instana/usage/api/{day}/{month}/{year}: + get: + operationId: getUsagePerDay + parameters: + - in: path + name: day + required: true + schema: + type: integer + format: int32 + - in: path + name: month + required: true + schema: + type: integer + format: int32 + - in: path + name: year + required: true + schema: + type: integer + format: int32 + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UsageResult' + description: OK + security: + - ApiKeyAuth: + - CanViewAccountAndBillingInformation + summary: API usage day / month / year + tags: + - Usage + x-ibm-ahub-byok: true + /api/instana/usage/api/{month}/{year}: + get: + operationId: getUsagePerMonth + parameters: + - in: path + name: month + required: true + schema: + type: integer + format: int32 + - in: path + name: year + required: true + schema: + type: integer + format: int32 + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UsageResult' + description: OK + security: + - ApiKeyAuth: + - CanViewAccountAndBillingInformation + summary: API usage month / year + tags: + - Usage + x-ibm-ahub-byok: true + /api/instana/usage/hosts/{day}/{month}/{year}: + get: + operationId: getHostsPerDay + parameters: + - in: path + name: day + required: true + schema: + type: integer + format: int32 + - in: path + name: month + required: true + schema: + type: integer + format: int32 + - in: path + name: year + required: true + schema: + type: integer + format: int32 + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UsageResult' + description: OK + security: + - ApiKeyAuth: + - CanViewAccountAndBillingInformation + summary: Host count day / month / year + tags: + - Usage + x-ibm-ahub-byok: true + /api/instana/usage/hosts/{month}/{year}: + get: + operationId: getHostsPerMonth + parameters: + - in: path + name: month + required: true + schema: + type: integer + format: int32 + - in: path + name: year + required: true + schema: + type: integer + format: int32 + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UsageResult' + description: OK + security: + - ApiKeyAuth: + - CanViewAccountAndBillingInformation + summary: Host count month / year + tags: + - Usage + x-ibm-ahub-byok: true + /api/instana/version: + get: + description: Get lastest API version information. + operationId: getVersion + responses: + '200': + content: + application/json: + example: + branch: develop + commit: 862420fa8696bd5106224f340a1f93d3c7d86409 + imageTag: 3.267.99-0 + schema: + $ref: '#/components/schemas/InstanaVersionInfo' + description: OK + security: + - ApiKeyAuth: + - Default + summary: API version information + tags: + - Health + x-description: getVersion + x-ibm-ahub-byok: true + /api/llm/capabilities: + get: + description: Retrieve all available LLM capabilities. + operationId: getLLMCapabilities + responses: + '200': + content: + application/json: + example: + - id: INCIDENT_INVESTIGATION + label: Incident investigation + description: Provides the ability to investigate incidents using AI + assistance. + models: + - id: MISTRAL_MEDIUM_2505 + name: mistralai/mistral-medium-2505 + label: Mistral (medium) + description: Provides high-accuracy results coupled with cost effective + scalability + - id: MISTRAL_LARGE_INSTRUCT_2407 + name: mistralai/Mistral-Large-Instruct-2407 + label: Mistral (large) + description: Provides results with less deviations, but consumes + more tokens + - id: GRANITE_3_3_8B_INSTRUCT + name: ibm/granite-3-3-8b-instruct + label: Granite + description: Provides faster and more accurate results + defaultModel: mistralai/mistral-medium-2505 + schema: + type: array + items: + type: string + enum: + - INCIDENT_INVESTIGATION + - INCIDENT_SUMMARIZATION + - AI_ASSISTANT + - MANUAL_ACTION_GENERATION + - SCRIPT_GENERATION + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: [ + ] + summary: Get all LLM capabilities + tags: + - AI Management + x-ibm-ahub-byok: true + /api/llm/egress/handler: + get: + description: Retrieve all LLM gateways. Optionally filter by enabled status + or capability. + operationId: getLLMEgressGateways + parameters: + - description: Filter by enabled status (true/false) + in: query + name: enabled + schema: + type: boolean + - description: Filter by capability name + in: query + name: capability + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: a14700b0-401b-47eb-a751-deda0035fde3 + name: Example LLM egress Handler + description: This is a sample custom handler used for testing. + aiModel: watsonx-gpt-4 + supports: + capabilities: + - anomaly-detection + - remediation + metadata: + source: user + version: 1.0.0 + endpointUrl: https://example.com/handler + endpointApiKey: secret-api-key + watsonxKey: watsonx-123 + watsonxProject: project-xyz + watsonxUrl: https://watsonx.example.com + instanaAgents: + agents: + - agent-1 + - agent-2 + createdAt: 2024-05-01T10:00:00Z + modifiedAt: 2024-05-02T15:30:00Z + schema: + type: array + items: + $ref: '#/components/schemas/LLMEgressGateway' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: [ + ] + summary: Get all LLM gateways + tags: + - AI Management + x-ibm-ahub-byok: true + post: + description: Create a new LLM gateway + operationId: addLLMEgressGateway + requestBody: + content: + application/json: + example: + name: Example LLM egress Handler + description: This is a sample custom handler used for testing. + aiModel: watsonx-gpt-4 + supports: + capabilities: + - anomaly-detection + - remediation + metadata: + source: user + version: 1.0.0 + endpointUrl: https://example.com/handler + endpointApiKey: secret-api-key + watsonxKey: watsonx-123 + watsonxProject: project-xyz + watsonxUrl: https://watsonx.example.com + instanaAgents: + agents: + - agent-1 + - agent-2 + schema: + $ref: '#/components/schemas/LLMEgressGateway' + required: true + responses: + '200': + content: + application/json: + example: + id: a14700b0-401b-47eb-a751-deda0035fde3 + name: Example LLM egress Handler + description: This is a sample custom handler used for testing. + aiModel: watsonx-gpt-4 + supports: + capabilities: + - anomaly-detection + - remediation + metadata: + source: user + version: 1.0.0 + endpointUrl: https://example.com/handler + endpointApiKey: secret-api-key + watsonxKey: watsonx-123 + watsonxProject: project-xyz + watsonxUrl: https://watsonx.example.com + instanaAgents: + agents: + - agent-1 + - agent-2 + schema: + $ref: '#/components/schemas/LLMEgressGateway' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureLLM + summary: Create a new LLM gateway + tags: + - AI Management + x-ibm-ahub-byok: true + /api/llm/egress/handler/{id}: + delete: + description: Delete a LLM egress gateway by ID. + operationId: deleteLLMEgressGateway + parameters: + - description: LLM gateway ID + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureLLM + summary: Delete a LLM egress gateway + tags: + - AI Management + x-ibm-ahub-byok: true + get: + description: Retrieve a LLM gateway by ID. + operationId: getLLMEgressGatewayById + parameters: + - description: LLM gateway ID + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: a14700b0-401b-47eb-a751-deda0035fde3 + name: Example LLM egress Handler + description: This is a sample custom handler used for testing. + aiModel: watsonx-gpt-4 + supports: + capabilities: + - anomaly-detection + - remediation + metadata: + source: user + version: 1.0.0 + endpointUrl: https://example.com/handler + endpointApiKey: secret-api-key + watsonxKey: watsonx-123 + watsonxProject: project-xyz + watsonxUrl: https://watsonx.example.com + instanaAgents: + agents: + - agent-1 + - agent-2 + createdAt: 2024-05-01T10:00:00Z + modifiedAt: 2024-05-02T15:30:00Z + schema: + $ref: '#/components/schemas/LLMEgressGateway' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get a LLM gateway by ID + tags: + - AI Management + x-ibm-ahub-byok: true + put: + description: Update an existing LLM gateway by ID. + operationId: updateLLMEgressGateway + parameters: + - description: LLM gateway ID + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: Example LLM egress Handler + description: This is a sample custom handler used for testing. + aiModel: watsonx-gpt-4 + supports: + capabilities: + - anomaly-detection + - remediation + metadata: + source: user + version: 1.0.0 + endpointUrl: https://example.com/handler + endpointApiKey: secret-api-key + watsonxKey: watsonx-123 + watsonxProject: project-xyz + watsonxUrl: https://watsonx.example.com + instanaAgents: + agents: + - agent-1 + - agent-2 + schema: + $ref: '#/components/schemas/LLMEgressGateway' + required: true + responses: + '200': + content: + application/json: + example: + id: a14700b0-401b-47eb-a751-deda0035fde3 + name: Example LLM egress Handler + description: This is a sample custom handler used for testing. + aiModel: watsonx-gpt-4 + supports: + capabilities: + - anomaly-detection + - remediation + metadata: + source: user + version: 1.0.0 + endpointUrl: https://example.com/handler + endpointApiKey: secret-api-key + watsonxKey: watsonx-123 + watsonxProject: project-xyz + watsonxUrl: https://watsonx.example.com + instanaAgents: + agents: + - agent-1 + - agent-2 + schema: + $ref: '#/components/schemas/LLMEgressGateway' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureLLM + summary: Update an existing LLM gateway. + tags: + - AI Management + x-ibm-ahub-byok: true + /api/llm/egress/handler/{id}/enable: + put: + description: Enable a LLM gateway by ID. Any other enabled gateway for the same + capability will be automatically disabled. + operationId: enableLLMEgressGateway + parameters: + - description: LLM gateway ID + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureLLM + summary: Set the enabled status of a LLM gateway + tags: + - AI Management + x-ibm-ahub-byok: true + /api/logging/logs/getLogVolumeUsage: + get: + description: | + Returns aggregated log volume usage data for a specified time range and optional grouping tag. + `fromTs` and `toTs` are required and must define a valid time range (i.e., `fromTs` <= `toTs`). + Refer to the query parameter description for valid `groupingTag` values. + operationId: getLogVolumeUsage + parameters: + - description: Start timestamp in seconds. Must be <= `toTs`. + example: 1682899200 + in: query + name: fromTs + required: true + schema: + type: integer + format: int64 + - description: End timestamp in seconds. Must be >= `fromTs`. + example: 1682899201 + in: query + name: toTs + required: true + schema: + type: integer + format: int64 + - description: | + Optional tag to group volume usage by. Valid groupingTag values are: + `kubernetes_cluster_name`, `kubernetes_daemonset_name`, `kubernetes_namespace_name`, + `kubernetes_deployment_name`, `host_name`, `zone`. + example: zone + in: query + name: groupingTag + schema: + type: string + responses: + '200': + content: + application/json: + examples: + Full Data: + description: Full Data + value: + logVolumeUsageItems: + - numberOfMonth: 11 + logVolume: 278141339215 + retentionPeriods: + - retentionDays: 7 + logVolume: 7253402 + logVolumeGroups: + - label: '' + logVolume: 7253402 + - label: demo-us-cluster + logVolume: 0 + - label: demo-us-eks + logVolume: 0 + - retentionDays: 90 + logVolume: 13319384221 + logVolumeGroups: + - label: '' + logVolume: 13004387032 + - label: demo-us-cluster + logVolume: 265176702 + - label: demo-us-eks + logVolume: 22645862 + - label: k8s-demo-cluster + logVolume: 27142175 + - label: rci-robotshop + logVolume: 32450 + Zero Volume: + description: Zero Volume + value: + logVolumeUsageItems: + - numberOfMonth: 1 + logVolume: 0 + retentionPeriods: [ + ] + - numberOfMonth: 2 + logVolume: 0 + retentionPeriods: [ + ] + - numberOfMonth: 3 + logVolume: 0 + retentionPeriods: [ + ] + schema: + $ref: '#/components/schemas/LogVolumeUsageResult' + description: Successfully retrieved log volume usage data + '400': + description: Invalid request (e.g., missing or incorrect time parameters) + '500': + description: Unexpected server error + security: + - ApiKeyAuth: + - Default + summary: Get Log Volume Usage + tags: + - Logging Analyze + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/analyze/beacon-groups: + post: + description: API request to get grouped mobile app beacon metrics. + operationId: getMobileAppBeaconGroups + parameters: + - in: query + name: fillTimeSeries + schema: + type: boolean + requestBody: + content: + application/json: + example: + metrics: + - metric: beaconCount + aggregation: SUM + granularity: 60 + group: + groupbyTag: mobileBeacon.view.name + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: mobileBeacon.mobileApp.name + operator: EQUALS + entity: NOT_APPLICABLE + value: robot-warehouse + - type: TAG_FILTER + name: mobileBeacon.platform + operator: EQUALS + entity: NOT_APPLICABLE + value: iOS + timeFrame: + to: null + windowSize: 3600000 + type: SESSION_START + schema: + $ref: '#/components/schemas/GetMobileAppBeaconGroups' + x-payload: getBeaconGroups + responses: + '200': + content: + application/json: + example: + items: + - name: Products + earliestTimestamp: 1707023340857 + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1707026879283 + offset: 1 + metrics: + beaconCount.sum.60: + - - 1707023340000 + - 47.0 + - - 1707023400000 + - 43.0 + canLoadMore: false + totalHits: 1 + totalRepresentedItemCount: 1 + totalRetainedItemCount: 1 + adjustedTimeframe: + windowSize: 3540000 + to: 1707026880000 + schema: + $ref: '#/components/schemas/MobileAppBeaconGroupsResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get grouped beacon metrics + tags: + - Mobile App Analyze + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/analyze/beacons: + post: + description: API request to get all mobile app beacons with matching type. + operationId: getMobileAppBeacons + requestBody: + content: + application/json: + example: + tagFilterExpression: + entity: NOT_APPLICABLE + name: mobileBeacon.mobileApp.name + operator: EQUALS + value: robot-warehouse + timeFrame: + to: null + windowSize: 60000 + type: SESSION_START + schema: + $ref: '#/components/schemas/GetMobileAppBeacons' + x-payload: getMobileAppBeacons + responses: + '200': + content: + application/json: + example: + items: + - beacon: + agentVersion: 6.0.22 + mobileAppId: K3bP-bmCRkyimNai9vvq8o + mobileAppLabel: robot-warehouse + timestamp: 1707025556799 + clockSkew: 450 + ingestionTime: 1707025557248 + duration: 0 + batchSize: 1 + sessionId: B5CB9B35-C822-4101-B192-DC2488924C7F + beaconId: c43d78282ee5b5cf + parentBeaconId: '' + backendTraceId: '' + type: sessionStart + view: Products + customEventName: '' + meta: + feature.testGroup: beta + userIp: 94.134.0.0 + userId: Example User Id + userSessionId: '' + userName: Example User Name + userEmail: example@example.com + userLanguages: + - de-DE + useFeatures: [ + ] + bundleIdentifier: com.example.shop + appBuild: aba9031kl + appVersion: 1.41.4 + platform: Android + osName: Android + osVersion: '10' + deviceManufacturer: Google + deviceModel: Google Pixel 4XL + deviceHardware: Google Pixel 4XL + viewportWidth: 320 + viewportHeight: 680 + carrier: Deutsche Telekom + connectionType: wifi + effectiveConnectionType: 3g + latitude: 50.9865 + longitude: 6.9304 + accuracyRadius: 20 + city: Cologne + subdivision: North Rhine-Westphalia + subdivisionCode: NW + country: Germany + countryCode: DE + continent: Europe + continentCode: EU + httpCallUrl: '' + httpCallOrigin: '' + httpCallPath: '' + httpCallMethod: '' + httpCallHeaders: { + } + errorCount: 0 + errorMessage: '' + errorId: '' + errorType: '' + stackTrace: '' + stackTraceLine: [ + ] + parsedStackTrace: '' + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1707025557248 + offset: 1 + canLoadMore: false + totalHits: 70 + totalRepresentedItemCount: 70 + totalRetainedItemCount: 70 + adjustedTimeframe: + windowSize: 60000 + to: 1707025560000 + schema: + $ref: '#/components/schemas/MobileAppBeaconResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get all beacons + tags: + - Mobile App Analyze + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/catalog: + get: + operationId: getMobileAppTagCatalog + parameters: + - in: query + name: beaconType + required: true + schema: + type: string + - in: query + name: useCase + required: true + schema: + type: string + enum: + - GROUPING + - FILTERING + - SERVICE_MAPPING + - SMART_ALERTS + - SMART_ALERTS_LOGS + - SMART_ALERTS_ADAPTIVE_BASELINE + - SMART_ALERTS_CUSTOM_PAYLOAD + - SLI_MANAGEMENT + - APPLICATION_CONFIG + - APPLICATION_CONFIG_BLUEPRINT + - MAINTENANCE_WINDOWS + - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + responses: + '200': + content: + application/json: + example: + - name: mobileBeacon.carrier + type: STRING + category: MOBILE + canApplyToSource: false + canApplyToDestination: false + sourceValueAvailableFrom: 0 + schema: + $ref: '#/components/schemas/TagCatalog' + description: OK + '400': + description: When the combination of beaconType and useCase is unsupported/unknown. + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get mobile app tag catalog + tags: + - Mobile App Catalog + x-description: getMobileAppTagCatalog + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/catalog/metrics: + get: + description: API request to get mobile app metric catalog. + operationId: getMobileAppMetricCatalog + responses: + '200': + content: + application/json: + example: + - metricId: beaconCount + label: Beacon count + formatter: NUMBER + description: How many beacons matching a filter were recorded. + aggregations: + - SUM + defaultAggregation: null + beaconTypes: + - sessionStart + - viewChange + - custom + - httpRequest + - crash + pathToValueInBeacon: null + tagName: null + secondaryBeaconTypes: + - sessionStart + - viewChange + - custom + schema: + type: array + items: + $ref: '#/components/schemas/MobileAppMonitoringMetricDescription' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Metric catalog + tags: + - Mobile App Catalog + x-description: getMobileAppMetricCatalog + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/catalog/tags: + get: + description: API request to get all mobile app tags. + operationId: getAllMobileAppCatalogTags + responses: + '200': + content: + application/json: + example: + - name: mobileBeacon.view.name + type: STRING + category: MOBILE + canApplyToSource: false + canApplyToDestination: false + sourceValueAvailableFrom: 0 + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get all existing mobile app tags + tags: + - Mobile App Catalog + x-description: getAllMobileAppCatalogTags + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/config: + get: + description: API request to get configured mobile apps. + operationId: getMobileAppConfig + responses: + '200': + content: + application/json: + example: + - id: K3bP-bmCRkyimNai9vvq8o + name: example_mobile_app + rbacTags: + - id: test + displayName: test + schema: + type: array + items: + $ref: '#/components/schemas/MobileApp' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get configured mobile apps + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + post: + description: API request to add new mobile app. + operationId: postMobileAppConfig + parameters: + - description: Name of the mobile app + in: query + name: name + schema: + type: string + requestBody: + content: + application/json: + example: + - id: test + displayName: test + schema: + type: array + items: + $ref: '#/components/schemas/ApiTag' + responses: + '200': + content: + application/json: + example: + - id: K3bP-bmCRkyimNai9vvq8o + name: example_mobile_app + schema: + $ref: '#/components/schemas/MobileApp' + description: Mobile App successfully configured + '400': + description: Missing name query parameter or name already used for a configured + mobile app. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Configure new mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/config/{mobileAppId}: + delete: + description: API request to remove mobile app. + operationId: deleteMobileAppConfig + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + responses: + '204': + description: Mobile app successfully removed + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Remove mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + get: + description: API request to get a specific mobile app configuration by ID. + operationId: getSingleMobileAppConfig + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: K3bP-bmCRkyimNai9vvq8o + name: example_mobile_app + rbacTags: + - id: test + displayName: test + schema: + $ref: '#/components/schemas/MobileApp' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get mobile app configuration by ID + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + put: + description: API request to rename mobile app. + operationId: renameMobileAppConfig + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + - description: New name of the mobile app + in: query + name: name + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: K3bP-bmCRkyimNai9vvq8o + name: example_mobile_app + schema: + $ref: '#/components/schemas/MobileApp' + description: Mobile app successfully renamed + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Rename mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/config/{mobileAppId}/geo-location: + get: + description: API request to get geo location configuration for mobile app. + operationId: getMobileAppGeoLocationConfiguration + parameters: + - in: path + name: mobileAppId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + geoDetailRemoval: NO_REMOVAL + geoMappingRules: [ + ] + schema: + $ref: '#/components/schemas/GeoLocationConfiguration' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Get geo location configuration for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + put: + description: API request to update geo location configuration for mobile app. + operationId: updateMobileAppGeoLocationConfiguration + parameters: + - description: Mobile App ID + example: iiLxP1zaTuCS7fyk9m4W0W + in: path + name: mobileAppId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GeoLocationConfiguration' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GeoLocationConfiguration' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Update geo location configuration for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/config/{mobileAppId}/geo-mapping-rules: + get: + description: API request to get custom geo mapping rules for mobile app. + operationId: getMobileAppGeoMappingRules + parameters: + - in: path + name: mobileAppId + required: true + schema: + type: string + responses: + '200': + content: + text/csv: { + } + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Get custom geo mapping rules for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + put: + description: API request to set custom geo mapping rules for mobile app. + operationId: setMobileAppGeoMappingRules + parameters: + - in: path + name: mobileAppId + required: true + schema: + type: string + requestBody: + content: + text/csv: + schema: + type: string + responses: + '200': + content: + text/csv: { + } + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '415': + description: Unsupported Media Type. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Set custom geo mapping rules for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/config/{mobileAppId}/ip-masking: + get: + description: API request to get IP masking configuration for mobile app. + operationId: getMobileAppIpMaskingConfiguration + parameters: + - in: path + name: mobileAppId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + ipMasking: DEFAULT + schema: + $ref: '#/components/schemas/IpMaskingConfiguration' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Get IP masking configuration for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + put: + description: API request to update IP masking configuration for mobile app. + operationId: updateMobileAppIpMaskingConfiguration + parameters: + - description: Mobile App ID + example: iiLxP1zaTuCS7fyk9m4W0W + in: path + name: mobileAppId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IpMaskingConfiguration' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IpMaskingConfiguration' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Update IP masking configuration for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload: + get: + description: API request to get all sourcemap configurations for mobile app. + operationId: getMobileAppSourceMapFiles + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + configs: + - id: 26ae11a865ec8c24 + description: InstanaAgentExample_v1 + createdAt: 1.7398641509596016E9 + modifiedAt: 1.7398643141402564E9 + metadata: + - type: DWARF + format: TGZ + url: com.instana.ios.InstanaAgentExample/dwarf + size: 2332564 + sizeOnDisk: 2324096 + blobs: + - blobIndex: 1 + size: 2332564 + sizeOnDisk: 2324096 + meta: null + schema: + $ref: '#/components/schemas/SourceMapUploadConfigs' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get all sourcemap configurations for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + post: + description: API request to add sourcemap configuration for mobile app. + operationId: postMobileAppSourceMapConfig + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + description: InstanaAgentExample_v2 + schema: + type: object + description: Source map upload configuration + properties: + description: + type: string + description: Name of configuration + responses: + '200': + content: + application/json: + example: + id: 1f4acfd2da7c53f1 + description: InstanaAgentExample_v2 + createdAt: 1.7478923068642304E9 + modifiedAt: 1.7478923068642304E9 + metadata: [ + ] + schema: + $ref: '#/components/schemas/SourceMapUploadConfig' + description: Mobile App sourcemap configuration added successfully + '400': + description: Missing description or description already used for a configuration. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable request - missing/invalid data. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Add new sourcemap configuration for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload/{sourceMapConfigId}: + delete: + description: API request to delete sourcemap configuration for mobile app. + operationId: deleteMobileAppSourceMapUploadConfiguration + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + - description: Source Map Config ID + example: 97e0ad312110d3ad + in: path + name: sourceMapConfigId + required: true + schema: + type: string + responses: + '204': + description: Sourcemap configuration successfully deleted or sourcemap not + found + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Delete sourcemap configuration for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + get: + description: API request to get sourcemap configuration for mobile app. + operationId: getMobileAppSourceMapFile + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + - description: Source Map Config ID + example: 97e0ad312110d3ad + in: path + name: sourceMapConfigId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: 53467e4fb60c1ba2 + description: InstanaAgentExample_v1 + createdAt: 1.7216977227669933E9 + modifiedAt: 1.7216983084051073E9 + metadata: + - type: DWARF + format: TGZ + url: com.instana.ios.InstanaAgentExample/dwarf + size: 3301023 + sizeOnDisk: 3287984 + blobs: + - blobIndex: 1 + size: 3301023 + sizeOnDisk: 3287984 + meta: null + schema: + $ref: '#/components/schemas/SourceMapUploadConfig' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get sourcemap configuration for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload/{sourceMapConfigId}/clear: + put: + description: API request to clear sourcemap files of a configuration for mobile + app. + operationId: clearMobileAppSourceMapUploadConfiguration + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + - description: Source Map Config ID + example: 97e0ad312110d3ad + in: path + name: sourceMapConfigId + required: true + schema: + type: string + responses: + '204': + description: Sourcemap files in the sourcemap configuration successfully + cleared + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Clear sourcemap files for sourcemap upload configuration + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload/{sourceMapConfigId}/commit: + put: + description: API request to commit sourcemap file upload for mobile app. + operationId: commitMobileAppSourceMapFile + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + - description: Source Map Config ID + example: 97e0ad312110d3ad + in: path + name: sourceMapConfigId + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + fileId: + type: string + fileType: + type: string + responses: + '200': + content: + application/json: + example: + id: fb3e868cd69f0647 + description: InstanaAgentExample_v2 + createdAt: 1.7479543183628924E9 + modifiedAt: 1.7479550970266616E9 + metadata: + - type: DWARF + format: TGZ + url: com.instana.ios.InstanaAgentExample/dwarf + size: 3454658 + sizeOnDisk: 3442288 + blobs: + - blobIndex: 1 + size: 3454658 + sizeOnDisk: 3442288 + meta: null + schema: + $ref: '#/components/schemas/SourceMapUploadConfig' + description: Successfully committed sourcemap file upload. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Commit sourcemap file upload for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload/{sourceMapConfigId}/form: + put: + description: API request to upload sourcemap file for mobile app. + operationId: uploadMobileAppSourceMapFile + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + - description: Source Map Config ID + example: 97e0ad312110d3ad + in: path + name: sourceMapConfigId + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + blobIndex: + type: integer + format: int32 + description: Blob index which starts from 1 + fileFormat: + type: string + description: File format. Example tgz + fileId: + type: string + description: Identifier of your app. For example, com.instana.ios.InstanaExampleApp + fileType: + type: string + description: dSYM stands for iOS symbol file, R8PG_MAP stands for + Android java mapping file + sourceMap: + type: string + format: binary + description: Path to your local symbol file + required: + - blobIndex + - fileFormat + - fileId + - fileType + - sourceMap + responses: + '200': + content: + application/json: + example: + id: 77e4c6c8c9855973 + description: InstanaAgentExample_v2 + createdAt: 1.7479473508836377E9 + modifiedAt: 1.7479484622585921E9 + metadata: + - type: DWARF + format: TGZ + url: com.instana.ios.InstanaAgentExample/dwarf + size: 3455633 + sizeOnDisk: 3443584 + blobs: + - blobIndex: 1 + size: 3455633 + sizeOnDisk: 3443584 + meta: null + schema: + $ref: '#/components/schemas/SourceMapUploadConfig' + description: OK + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Upload sourcemap file for mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/config/{mobileAppId}/teams: + put: + description: API request to update teams of a mobile app. + operationId: updateMobileAppTeams + parameters: + - in: path + name: mobileAppId + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + - id: test + displayName: test + schema: + type: array + items: + $ref: '#/components/schemas/ApiTag' + responses: + '200': + content: + application/json: + example: + - id: test + displayName: test + schema: + type: array + items: + $ref: '#/components/schemas/ApiTag' + description: Mobile App successfully configured + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Update teams assigned to the mobile app + tags: + - Mobile App Configuration + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/metrics: + post: + deprecated: true + description: API request to get mobile app monitoring beacon metrics. + operationId: getMobileAppBeaconMetrics + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetMobileAppMetrics' + x-payload: getMobileAppMetricsQuery + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MobileAppMetricResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get mobile app beacon metrics + tags: + - Mobile App Metrics + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/session{id}{timestamp}: + get: + description: API request to get a mobile app monitoring session. + operationId: getSession + parameters: + - description: Identifier of the session to be retrieved + example: 9CA9E31D-B0F7-40EC-8D32-FE163A6557AE + in: path + name: id + required: true + schema: + type: string + style: matrix + - description: Timestamp of the session to be retrieved + example: 1730595029980 + in: path + name: timestamp + required: true + schema: + type: integer + format: int64 + style: matrix + responses: + '200': + content: + application/json: + example: + - agentVersion: 1.8.5 + mobileAppId: K3bP-bmCRkyimNai9vvq8o + mobileAppLabel: robot-warehouse + timestamp: 1707025019211 + clockSkew: 460 + ingestionTime: 1707025019670 + duration: 0 + batchSize: 1 + sessionId: 9CA9E31D-B0F7-40EC-8D32-FE163A6557AE + beaconId: 659302486df75422 + parentBeaconId: '' + backendTraceId: '' + type: sessionStart + view: Products + customEventName: '' + meta: + feature.testGroup: sigma + userIp: 149.200.0.0 + userId: Example user id + userSessionId: '' + userName: Example user name + userEmail: example@example.com + userLanguages: + - ar-JO + useFeatures: [ + ] + bundleIdentifier: com.example.shop + appBuild: aba9031kl + appVersion: 1.42.3 + platform: iOS + osName: iOS + osVersion: 16.7.1 + deviceManufacturer: Apple + deviceModel: iPhone 13 + deviceHardware: iPhone14,5 + viewportWidth: 320 + viewportHeight: 680 + carrier: Orange + connectionType: wifi + effectiveConnectionType: 3g + latitude: 31.9555 + longitude: 35.9435 + accuracyRadius: 20 + city: Amman + subdivision: Amman Governorate + subdivisionCode: AM + country: Jordan + countryCode: JO + continent: Asia + continentCode: AS + httpCallUrl: '' + httpCallOrigin: '' + httpCallPath: '' + httpCallMethod: '' + httpCallHeaders: { + } + errorCount: 0 + errorMessage: '' + errorId: '' + errorType: '' + stackTrace: '' + stackTraceLine: [ + ] + parsedStackTrace: '' + schema: + type: array + items: + $ref: '#/components/schemas/MobileAppMonitoringBeacon' + description: OK + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get mobile app session + tags: + - Mobile App Metrics + x-ibm-ahub-byok: true + /api/mobile-app-monitoring/v2/metrics: + post: + description: API request to get mobile app monitoring beacon metrics. + operationId: getMobileAppBeaconMetricsV2 + requestBody: + content: + application/json: + example: + metrics: + - metric: beaconCount + aggregation: SUM + granularity: 60 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: mobileBeacon.mobileApp.name + operator: EQUALS + entity: NOT_APPLICABLE + value: robot-warehouse + - type: TAG_FILTER + name: mobileBeacon.view.name + operator: EQUALS + entity: NOT_APPLICABLE + value: Products + timeFrame: + to: null + windowSize: 3600000 + type: SESSION_START + schema: + $ref: '#/components/schemas/GetMobileAppMetricsV2' + x-payload: getMobileAppMetricsQuery + responses: + '200': + content: + application/json: + example: + metrics: + beaconCount.sum.60: + - - 1707026940000 + - 75.0 + - - 1707027000000 + - 75.0 + adjustedTimeframe: + windowSize: 3540000 + to: 1707030480000 + schema: + $ref: '#/components/schemas/MetricAPIResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get beacon metrics + tags: + - Mobile App Metrics + x-ibm-ahub-byok: true + /api/releases: + get: + operationId: getAllReleases + parameters: + - in: query + name: from + schema: + type: integer + format: int64 + description: The timestamp from where one wants to fetch the release markers. + - in: query + name: to + schema: + type: integer + format: int64 + description: The timestamp till where one wants to fetch the release markers. + - in: query + name: maxResults + schema: + type: integer + format: int32 + description: The maximum number of release markers to be fetched + responses: + '200': + content: + application/json: + example: + - id: Tiu16hLCTniHDtHb_uDV1w + name: demo-app/main-** + start: 1709091782000 + lastUpdated: 1709091782533 + schema: + type: array + items: + $ref: '#/components/schemas/ReleaseWithMetadata' + description: OK + security: + - ApiKeyAuth: + - CanConfigureReleases + summary: Get all releases + tags: + - Releases + x-description: getAllReleases + x-ibm-ahub-byok: true + post: + operationId: postRelease + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Release' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ReleaseWithMetadata' + description: OK + security: + - ApiKeyAuth: + - CanConfigureReleases + summary: Create release + tags: + - Releases + x-description: postRelease + x-ibm-ahub-byok: true + /api/releases/{releaseId}: + delete: + operationId: deleteRelease + parameters: + - in: path + name: releaseId + required: true + schema: + type: string + description: The unique release id which one wants to delete. + example: XK1e1TE3T9SHKugndn_soQ + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - CanConfigureReleases + summary: Delete release + tags: + - Releases + x-description: deleteRelease + x-ibm-ahub-byok: true + get: + operationId: getRelease + parameters: + - description: The unique release id which one wants to retrieve. + example: XK1e1TF3T9SHKugndn_soQ + in: path + name: releaseId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: XK1e1TF3T9SHKugndn_soQ + name: demo-app/main-** + start: 1706674621000 + lastUpdated: 1706674621604 + schema: + $ref: '#/components/schemas/ReleaseWithMetadata' + description: OK + security: + - ApiKeyAuth: + - CanConfigureReleases + summary: Get release + tags: + - Releases + x-description: getRelease + x-ibm-ahub-byok: true + put: + operationId: putRelease + parameters: + - in: path + name: releaseId + required: true + schema: + type: string + description: The unique release id which one wants to update. + example: XK1e1TQ3T9SHKugndn_soQ + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Release' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ReleaseWithMetadata' + description: OK + security: + - ApiKeyAuth: + - CanConfigureReleases + summary: Update release + tags: + - Releases + x-description: putRelease + x-ibm-ahub-byok: true + /api/settings/accesslog: + get: + description: Retrieve all access logs using defined query. + operationId: getAccessLogs + parameters: + - description: The offset within the result set + example: 0 + in: query + name: offset + schema: + type: integer + format: int32 + - description: The query to filter the results + example: username@example + in: query + name: query + schema: + type: string + - description: The size of returned page + example: 10 + in: query + name: pageSize + schema: + type: integer + format: int32 + responses: + '200': + content: + application/json: + example: + total: 1977 + entries: + - tenantId: tenantId + tenantUnitId: unitId + action: LOGIN + email: username@example.com + fullName: Any User + timestamp: 1723035109091 + schema: + $ref: '#/components/schemas/AccessLogResponse' + description: OK + security: + - ApiKeyAuth: + - CanViewAuditLog + summary: Access log + tags: + - Audit Log + x-ibm-ahub-byok: true + /api/settings/apdex: + get: + description: API to Get All Apdex Configurations. + operationId: getAllApdexConfigurations + responses: + '200': + content: + application/json: + example: + - id: _PvpxqTfSyi27O_LCxMd0A + createdAt: 1653917798682 + apdexName: '{string}' + apdexEntity: + apdexType: website + entityId: '{object}' + threshold: 70 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + beaconType: httpRequest + - id: K6thQVyzQqWc38yspc0QWw + createdAt: 1693828514423 + apdexName: '{string}' + apdexEntity: + apdexType: application + entityId: '{object}' + threshold: 12 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + boundaryScope: ALL + includeInternal: false + includeSynthetic: false + schema: + type: array + items: + $ref: '#/components/schemas/ApdexConfiguration' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get All Apdex Configurations + tags: + - Apdex Settings + x-ibm-ahub-byok: true + post: + operationId: createApdexConfiguration + requestBody: + content: + application/json: + example: + - apdexName: Apdex Configuration One + apdexEntity: + apdexType: website + entityId: XIZGGVT1TX2O-0OFeT2Yig + threshold: 400 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + beaconType: httpRequest + schema: + $ref: '#/components/schemas/ApdexConfigurationInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ApdexConfiguration' + description: OK + security: + - ApiKeyAuth: + - canConfigureApdex + summary: Create Apdex Configuration + tags: + - Apdex Settings + x-description: createApdexConfiguration + x-ibm-ahub-byok: true + /api/settings/apdex/{entityType}/{entityId}: + get: + description: API to Get All Apdex Configurations for specified entity type and + entity id. + operationId: getApdexConfigurationsForEntityTypeAndId + parameters: + - description: Type of the Apdex Configuration, it could be APPLICATION or WEBSITE + example: APPLICATION + in: path + name: entityType + required: true + schema: + type: string + enum: + - APPLICATION + - WEBSITE + - description: Application or Website ID + example: XIZGGVT1TX2O-0OFeT2Yig + in: path + name: entityId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: u2MBXtasQoy3reni5-QZgg + createdAt: 1657743333352 + apdexName: Apdex Configuration One + apdexEntity: + apdexType: website + entityId: XIZGGVT1TX2O-0OFeT2Yig + threshold: 400 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + beaconType: httpRequest + - id: ShIqRJgpTT69HZHbfQKRGg + createdAt: 1693482558276 + apdexName: Apdex Configuration Two + apdexEntity: + apdexType: website + entityId: XIZGGVT1TX2O-0OFeT2Yig + threshold: 90 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + beaconType: httpRequest + schema: + type: array + items: + $ref: '#/components/schemas/ApdexConfiguration' + description: OK + '400': + content: + application/json: + example: '{"code":400,"message":"path param entityType must be one of + [APPLICATION, WEBSITE]"}' + schema: + type: string + description: Bad Request + security: + - ApiKeyAuth: + - Default + summary: Get all Apdex configurations for entity type and entity id + tags: + - Apdex Settings + x-ibm-ahub-byok: true + /api/settings/apdex/{id}: + delete: + operationId: deleteApdexConfiguration + parameters: + - description: Apdex Configuration ID + example: NCAoNKqySWSK1U5GkmyZgQ + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Apdex Configuration Deleted Successfully + security: + - ApiKeyAuth: + - canConfigureApdex + summary: Delete Apdex Configuration + tags: + - Apdex Settings + x-ibm-ahub-byok: true + get: + description: API to Get Apdex Configuration for specified ID. + operationId: getApdexConfiguration + parameters: + - description: Apdex Configuration ID + example: NCAoNKqySWSK1U5GkmyZgQ + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: NCAoNKqySWSK1U5GkmyZgQ + createdAt: 1666112381045 + apdexName: '{string}' + apdexEntity: + apdexType: website + entityId: XIZGGVT1TX2O-0OFeT2Yig + threshold: 100 + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: [ + ] + beaconType: httpRequest + schema: + $ref: '#/components/schemas/ApdexConfiguration' + description: OK + '404': + content: + application/json: + example: '{"errors":["Apdex Configuration not found"]}' + schema: + type: string + description: Apdex Configuration not found + security: + - ApiKeyAuth: + - Default + summary: Get Apdex Configuration + tags: + - Apdex Settings + x-ibm-ahub-byok: true + /api/settings/api-tokens: + get: + description: |- + Get the list of API Tokens for this Tenant-Unit + For more information on APIToken please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#apitoken. + operationId: getApiTokens + responses: + '200': + content: + application/json: + example: |- + [ + { + "id": "tokenId-1(masked)", + "accessGrantingToken": "accessGrantingToken-1(masked)", + "internalId": "internalId-1", + "name": "tokenName-1", + "createdBy": "user1@example.com", + "createdOn": timestamp, + "lastUsedOn": timestamp, + "expiresOn": null, + "limitedApplicationsScope": false, + "limitedBizOpsScope": false, + "limitedWebsitesScope": false, + "limitedKubernetesScope": false, + "limitedMobileAppsScope": false, + "limitedInfrastructureScope": false, + "limitedSyntheticsScope": false, + "limitedVsphereScope": false, + "limitedPhmcScope": false, + "limitedPvcScope": false, + "limitedZhmcScope": false, + "limitedPcfScope": false, + "limitedOpenstackScope": false, + "limitedAutomationScope": false, + "limitedLogsScope": false, + "canConfigureServiceMapping": true, + "canConfigureEumApplications": true, + "canConfigureMobileAppMonitoring": true, + "canConfigureUsers": true, + "canInstallNewAgents": true, + "canConfigureIntegrations": true, + "canConfigureApiTokens": true, + "canConfigurePersonalApiTokens": false, + "canConfigureAgentRunMode": true, + "canViewAuditLog": true, + "canConfigureAgents": true, + "canConfigureAuthenticationMethods": true, + "canConfigureApplications": true, + "canConfigureTeams": true, + "canConfigureReleases": true, + "canConfigureLogManagement": true, + "canConfigureDatabaseManagement": false, + "canCreatePublicCustomDashboards": true, + "canViewLogs": true, + "canViewTraceDetails": true, + "canConfigureSessionSettings": true, + "canConfigureGlobalAlertPayload": true, + "canViewAccountAndBillingInformation": true, + "canEditAllAccessibleCustomDashboards": true, + "canConfigureAutomationActions": true, + "canConfigureAutomationPolicies": true, + "canRunAutomationActions": true, + "canDeleteAutomationActionHistory": true, + "canConfigureSyntheticTests": true, + "canConfigureSyntheticLocations": true, + "canConfigureSyntheticCredentials": true, + "canViewSyntheticTests": true, + "canViewSyntheticLocations": true, + "canViewSyntheticTestResults": true, + "canUseSyntheticCredentials": true, + "canViewBusinessProcesses": false, + "canViewBusinessProcessDetails": false, + "canViewBusinessActivities": false, + "canViewBizAlerts": false, + "canDeleteLogs": true, + "canCreateHeapDump": false, + "canCreateThreadDump": false, + "canConfigureEventsAndAlerts": true, + "canConfigureMaintenanceWindows": true, + "canConfigureApplicationSmartAlerts": true, + "canConfigureWebsiteSmartAlerts": true, + "canConfigureMobileAppSmartAlerts": true, + "canConfigureGlobalApplicationSmartAlerts": true, + "canConfigureGlobalSyntheticSmartAlerts": true, + "canConfigureGlobalInfraSmartAlerts": true, + "canConfigureGlobalLogSmartAlerts": true, + "canManuallyCloseIssue": true, + "canViewLogVolume": true, + "canConfigureLogRetentionPeriod": true + }, + { + "id": "tokenId-2(masked)", + "accessGrantingToken": "accessGrantingToken-2(masked)", + "internalId": "internalId-2", + "name": "tokenName-2", + "createdBy": "user2@example.com", + "createdOn": timestamp, + "lastUsedOn": timestamp, + "limitedApplicationsScope": false, + "limitedBizOpsScope": false, + "limitedWebsitesScope": false, + "limitedKubernetesScope": false, + "limitedMobileAppsScope": false, + "limitedInfrastructureScope": false, + "limitedSyntheticsScope": false, + "limitedVsphereScope": false, + "limitedPhmcScope": false, + "limitedPvcScope": false, + "limitedZhmcScope": false, + "limitedPcfScope": false, + "limitedOpenstackScope": false, + "limitedAutomationScope": false, + "limitedLogsScope": false, + "canConfigureServiceMapping": true, + "canConfigureEumApplications": true, + "canConfigureMobileAppMonitoring": true, + "canConfigureUsers": true, + "canInstallNewAgents": true, + "canConfigureIntegrations": true, + "canConfigureApiTokens": true, + "canConfigurePersonalApiTokens": false, + "canConfigureAgentRunMode": true, + "canViewAuditLog": true, + "canConfigureAgents": true, + "canConfigureAuthenticationMethods": true, + "canConfigureApplications": true, + "canConfigureTeams": true, + "canConfigureReleases": true, + "canConfigureLogManagement": true, + "canConfigureDatabaseManagement": false, + "canCreatePublicCustomDashboards": true, + "canViewLogs": true, + "canViewTraceDetails": true, + "canConfigureSessionSettings": true, + "canConfigureGlobalAlertPayload": true, + "canViewAccountAndBillingInformation": true, + "canEditAllAccessibleCustomDashboards": true, + "canConfigureAutomationActions": false, + "canConfigureAutomationPolicies": false, + "canRunAutomationActions": false, + "canDeleteAutomationActionHistory": false, + "canConfigureSyntheticTests": true, + "canConfigureSyntheticLocations": true, + "canConfigureSyntheticCredentials": true, + "canViewSyntheticTests": true, + "canViewSyntheticLocations": true, + "canViewSyntheticTestResults": true, + "canUseSyntheticCredentials": true, + "canViewBusinessProcesses": false, + "canViewBusinessProcessDetails": false, + "canViewBusinessActivities": false, + "canViewBizAlerts": false, + "canDeleteLogs": false, + "canCreateHeapDump": false, + "canCreateThreadDump": false, + "canConfigureEventsAndAlerts": true, + "canConfigureMaintenanceWindows": true, + "canConfigureApplicationSmartAlerts": true, + "canConfigureWebsiteSmartAlerts": true, + "canConfigureMobileAppSmartAlerts": true, + "canConfigureGlobalApplicationSmartAlerts": true, + "canConfigureGlobalSyntheticSmartAlerts": true, + "canConfigureGlobalInfraSmartAlerts": true, + "canConfigureGlobalLogSmartAlerts": false, + "canManuallyCloseIssue": false, + "canViewLogVolume": false, + "canConfigureLogRetentionPeriod": false + } + ] + schema: + type: array + items: + $ref: '#/components/schemas/ApiToken' + description: OK + '404': + description: No API Tokens found + security: + - ApiKeyAuth: + - CanConfigureApiTokens + summary: Get all API Tokens + tags: + - API Token + x-ibm-ahub-byok: true + post: + description: |- + Create an API Token on the Tenant-Unit. Each API Token entry also contains a set of permissions + For more information on APIToken please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#apitoken. + operationId: postApiToken + requestBody: + content: + application/json: + example: | + { + "accessGrantingToken": "accessGrantingToken", + "name": "tokenName", + "internalId": "internalId", + "canViewAuditLog": true, + "canConfigureSessionSettings": true, + "canConfigureApplications": true, + "canConfigureAgents": true, + "canConfigureUsers": true, + "canConfigureEventsAndAlerts": true, + } + schema: + $ref: '#/components/schemas/ApiToken' + required: true + responses: + '200': + content: + application/json: + example: + id: tokenId + accessGrantingToken: accessGrantingToken + internalId: internalId + name: tokenName + createdBy: createdBy + createdOn: createdOn + lastUsedOn: lastUsedOn + expiresOn: expiresOn + limitedApplicationsScope: false + limitedBizOpsScope: false + limitedWebsitesScope: false + limitedKubernetesScope: false + limitedMobileAppsScope: false + limitedInfrastructureScope: false + limitedSyntheticsScope: false + limitedVsphereScope: false + limitedPhmcScope: false + limitedPvcScope: false + limitedZhmcScope: false + limitedPcfScope: false + limitedOpenstackScope: false + limitedAutomationScope: false + limitedLogsScope: false + canConfigureServiceMapping: false + canConfigureEumApplications: false + canConfigureMobileAppMonitoring: false + canConfigureUsers: true + canInstallNewAgents: false + canConfigureIntegrations: false + canConfigureApiTokens: false + canConfigurePersonalApiTokens: false + canConfigureAgentRunMode: false + canViewAuditLog: true + canConfigureAgents: true + canConfigureAuthenticationMethods: false + canConfigureApplications: true + canConfigureTeams: false + canConfigureReleases: false + canConfigureLogManagement: false + canConfigureDatabaseManagement: false + canCreatePublicCustomDashboards: false + canViewLogs: false + canViewTraceDetails: false + canConfigureSessionSettings: true + canConfigureGlobalAlertPayload: false + canViewAccountAndBillingInformation: false + canEditAllAccessibleCustomDashboards: false + canConfigureAutomationActions: false + canConfigureAutomationPolicies: false + canRunAutomationActions: false + canDeleteAutomationActionHistory: false + canConfigureSyntheticTests: false + canConfigureSyntheticLocations: false + canConfigureSyntheticCredentials: false + canViewSyntheticTests: false + canViewSyntheticLocations: false + canViewSyntheticTestResults: false + canUseSyntheticCredentials: false + canViewBusinessProcesses: false + canViewBusinessProcessDetails: false + canViewBusinessActivities: false + canViewBizAlerts: false + canDeleteLogs: false + canCreateHeapDump: false + canCreateThreadDump: false + canConfigureEventsAndAlerts: true + canConfigureMaintenanceWindows: false + canConfigureApplicationSmartAlerts: false + canConfigureWebsiteSmartAlerts: false + canConfigureMobileAppSmartAlerts: false + canConfigureGlobalApplicationSmartAlerts: false + canConfigureGlobalSyntheticSmartAlerts: false + canConfigureGlobalInfraSmartAlerts: false + canConfigureGlobalLogSmartAlerts: false + canManuallyCloseIssue: false + canViewLogVolume: false + canConfigureLogRetentionPeriod: false + schema: + $ref: '#/components/schemas/ApiToken' + description: OK + security: + - ApiKeyAuth: + - CanConfigureApiTokens + summary: Create an API token + tags: + - API Token + x-ibm-ahub-byok: true + /api/settings/api-tokens/{internalId}: + delete: + description: |- + Delete the Api Token + For more information on APIToken please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#apitoken. + operationId: deleteApiToken + parameters: + - in: path + name: internalId + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + security: + - ApiKeyAuth: + - CanConfigureApiTokens + summary: Delete API token + tags: + - API Token + x-ibm-ahub-byok: true + get: + description: |- + Returns API Token details, including the set of permissions + For more information on APIToken please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#apitoken. + operationId: getApiToken + parameters: + - in: path + name: internalId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: | + { + "id": "tokenId(masked)", + "accessGrantingToken": "accessGrantingToken(masked)", + "internalId": "internalId", + "name": "tokenName", + "createdBy": "user@example.com", + "createdOn": timestamp, + "lastUsedOn": timestamp, + "expiresOn": null, + "limitedApplicationsScope": false, + "limitedBizOpsScope": false, + "limitedWebsitesScope": false, + "limitedKubernetesScope": false, + "limitedMobileAppsScope": false, + "limitedInfrastructureScope": false, + "limitedSyntheticsScope": false, + "limitedVsphereScope": false, + "limitedPhmcScope": false, + "limitedPvcScope": false, + "limitedZhmcScope": false, + "limitedPcfScope": false, + "limitedOpenstackScope": false, + "limitedAutomationScope": false, + "limitedLogsScope": false, + "canConfigureServiceMapping": true, + "canConfigureEumApplications": true, + "canConfigureMobileAppMonitoring": true, + "canConfigureUsers": true, + "canInstallNewAgents": true, + "canConfigureIntegrations": true, + "canConfigureApiTokens": true, + "canConfigurePersonalApiTokens": false, + "canConfigureAgentRunMode": true, + "canViewAuditLog": true, + "canConfigureAgents": true, + "canConfigureAuthenticationMethods": true, + "canConfigureApplications": true, + "canConfigureTeams": true, + "canConfigureReleases": true, + "canConfigureLogManagement": true, + "canConfigureDatabaseManagement": false, + "canCreatePublicCustomDashboards": true, + "canViewLogs": true, + "canViewTraceDetails": true, + "canConfigureSessionSettings": true, + "canConfigureGlobalAlertPayload": true, + "canViewAccountAndBillingInformation": true, + "canEditAllAccessibleCustomDashboards": true, + "canConfigureAutomationActions": true, + "canConfigureAutomationPolicies": true, + "canRunAutomationActions": true, + "canDeleteAutomationActionHistory": true, + "canConfigureSyntheticTests": true, + "canConfigureSyntheticLocations": true, + "canConfigureSyntheticCredentials": true, + "canViewSyntheticTests": true, + "canViewSyntheticLocations": true, + "canViewSyntheticTestResults": true, + "canUseSyntheticCredentials": true, + "canViewBusinessProcesses": false, + "canViewBusinessProcessDetails": false, + "canViewBusinessActivities": false, + "canViewBizAlerts": false, + "canDeleteLogs": true, + "canCreateHeapDump": false, + "canCreateThreadDump": false, + "canConfigureEventsAndAlerts": true, + "canConfigureMaintenanceWindows": true, + "canConfigureApplicationSmartAlerts": true, + "canConfigureWebsiteSmartAlerts": true, + "canConfigureMobileAppSmartAlerts": true, + "canConfigureGlobalApplicationSmartAlerts": true, + "canConfigureGlobalSyntheticSmartAlerts": true, + "canConfigureGlobalInfraSmartAlerts": true, + "canConfigureGlobalLogSmartAlerts": true, + "canManuallyCloseIssue": true, + "canViewLogVolume": true, + "canConfigureLogRetentionPeriod": true + } + schema: + $ref: '#/components/schemas/ApiToken' + description: OK + '404': + description: No ApiToken found with internalId + security: + - ApiKeyAuth: + - CanConfigureApiTokens + summary: Get API token + tags: + - API Token + x-ibm-ahub-byok: true + put: + description: |- + Update API Token- Change Token name and associated permissions + For more information on APIToken please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#apitoken. + operationId: putApiToken + parameters: + - in: path + name: internalId + required: true + schema: + type: string + requestBody: + content: + application/json: + example: | + { + "accessGrantingToken": "accessGrantingToken", + "name": "tokenName", + "internalId": "internalId", + "canViewAuditLog": true, + "canConfigureSessionSettings": true, + "canConfigureApplications": true, + "canConfigureAgents": true, + "canConfigureUsers": true, + "canConfigureEventsAndAlerts": true, + } + schema: + $ref: '#/components/schemas/ApiToken' + required: true + responses: + '200': + content: + application/json: + example: + id: tokenId + accessGrantingToken: accessGrantingToken + internalId: internalId + name: tokenName + createdBy: createdBy + createdOn: createdOn + lastUsedOn: lastUsedOn + expiresOn: expiresOn + limitedApplicationsScope: false + limitedBizOpsScope: false + limitedWebsitesScope: false + limitedKubernetesScope: false + limitedMobileAppsScope: false + limitedInfrastructureScope: false + limitedSyntheticsScope: false + limitedVsphereScope: false + limitedPhmcScope: false + limitedPvcScope: false + limitedZhmcScope: false + limitedPcfScope: false + limitedOpenstackScope: false + limitedAutomationScope: false + limitedLogsScope: false + canConfigureServiceMapping: false + canConfigureEumApplications: false + canConfigureMobileAppMonitoring: false + canConfigureUsers: true + canInstallNewAgents: false + canConfigureIntegrations: false + canConfigureApiTokens: false + canConfigurePersonalApiTokens: false + canConfigureAgentRunMode: false + canViewAuditLog: true + canConfigureAgents: true + canConfigureAuthenticationMethods: false + canConfigureApplications: true + canConfigureTeams: false + canConfigureReleases: false + canConfigureLogManagement: false + canConfigureDatabaseManagement: false + canCreatePublicCustomDashboards: false + canViewLogs: false + canViewTraceDetails: false + canConfigureSessionSettings: true + canConfigureGlobalAlertPayload: false + canViewAccountAndBillingInformation: false + canEditAllAccessibleCustomDashboards: false + canConfigureAutomationActions: false + canConfigureAutomationPolicies: false + canRunAutomationActions: false + canDeleteAutomationActionHistory: false + canConfigureSyntheticTests: false + canConfigureSyntheticLocations: false + canConfigureSyntheticCredentials: false + canViewSyntheticTests: false + canViewSyntheticLocations: false + canViewSyntheticTestResults: false + canUseSyntheticCredentials: false + canViewBusinessProcesses: false + canViewBusinessProcessDetails: false + canViewBusinessActivities: false + canViewBizAlerts: false + canDeleteLogs: false + canCreateHeapDump: false + canCreateThreadDump: false + canConfigureEventsAndAlerts: true + canConfigureMaintenanceWindows: false + canConfigureApplicationSmartAlerts: false + canConfigureWebsiteSmartAlerts: false + canConfigureMobileAppSmartAlerts: false + canConfigureGlobalApplicationSmartAlerts: false + canConfigureGlobalSyntheticSmartAlerts: false + canConfigureGlobalInfraSmartAlerts: false + canConfigureGlobalLogSmartAlerts: false + canManuallyCloseIssue: false + canViewLogVolume: false + canConfigureLogRetentionPeriod: false + schema: + $ref: '#/components/schemas/ApiToken' + description: OK + security: + - ApiKeyAuth: + - CanConfigureApiTokens + summary: Create or update an API token + tags: + - API Token + x-ibm-ahub-byok: true + /api/settings/auditlog: + get: + description: Retrieve all audit logs using defined query. + operationId: getAuditLogs + parameters: + - description: The offset within the result set + example: 0 + in: query + name: offset + schema: + type: integer + format: int32 + - description: The query to filter the results + example: username@example.com + in: query + name: query + schema: + type: string + - description: The size of returned page + example: 10 + in: query + name: pageSize + schema: + type: integer + format: int32 + responses: + '200': + content: + application/json: + example: + total: 1977 + entries: + - id: WawO9-p0SJ2ifST460tXYZ + action: GET /api/settings + message: Aborting request due to Insufficient permissions/access + rights for resource method + actor: + type: USER + id: userId + name: Any User + email: username@example.com + timestamp: 1723035109091 + meta: + origin_ip: 10.69.123.42 + schema: + $ref: '#/components/schemas/AuditLogUiResponse' + description: OK + security: + - ApiKeyAuth: + - CanViewAuditLog + summary: Audit log + tags: + - Audit Log + x-ibm-ahub-byok: true + /api/settings/authentication/googleSSO: + delete: + description: Delete the corresponding tenants Google SSO configuration. + operationId: deleteGoogleSSOConfig + responses: + '204': + description: Successful - no content to return. + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Delete Google SSO configuration + tags: + - Authentication + x-ibm-ahub-byok: true + /api/settings/authentication/ldap: + delete: + description: Delete the corresponding tenants LDAP configuration. + operationId: deleteLdapConfig + responses: + '204': + description: Successful - no content to return. + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Delete LDAP configuration + tags: + - Authentication + x-ibm-ahub-byok: true + /api/settings/authentication/oidc: + delete: + description: Delete the corresponding tenants OIDC configuration. + operationId: deleteOidcConfig + responses: + '204': + description: Successful - no content to return. + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Delete OIDC configuration + tags: + - Authentication + x-ibm-ahub-byok: true + /api/settings/authentication/saml: + delete: + description: Delete the corresponding tenants SAML configuration. + operationId: deleteSamlConfig + responses: + '204': + description: Successful - no content to return. + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Delete SAML configuration + tags: + - Authentication + x-ibm-ahub-byok: true + /api/settings/correction: + get: + operationId: getAllSloCorrectionWindowConfigs + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + description: Size of the Page + example: 1 + - in: query + name: page + schema: + type: integer + format: int32 + description: Page Number + example: 1 + - in: query + name: orderBy + schema: + type: string + description: Order By Value + enum: + - name + - start + - nextStart + - duration + - 'null' + example: name + - in: query + name: orderDirection + schema: + type: string + description: Order Direction of the Result, it could be ascending or descending + enum: + - ASC + - DESC + example: ASC + - in: query + name: query + schema: + type: string + description: Keyword or Query which needs to be searched + example: test Correction + - in: query + name: tag + schema: + type: array + description: List of tags which needs to be searched + example: Testing + items: + type: string + description: List of tags which needs to be searched + example: Testing + uniqueItems: true + - in: query + name: id + schema: + type: array + description: List of Correction Configuration IDs for which details need + to be fetched + example: SSPTkTWoT1W0OpE_iQbfaA + items: + type: string + description: List of Correction Configuration IDs for which details need + to be fetched + example: SSPTkTWoT1W0OpE_iQbfaA + - in: query + name: sloId + schema: + type: array + description: List of SLO IDs for which details need to be fetched + example: SLOdCTspkHlS_OzNOATQWgsuw + items: + type: string + description: List of SLO IDs for which details need to be fetched + example: SLOdCTspkHlS_OzNOATQWgsuw + - in: query + name: refresh + schema: + type: boolean + description: Boolean operator which specifies if the cache needs to be refreshed + example: false + responses: + '200': + content: + application/json: + example: + items: + - id: N9RdTL-WQkSTa3DYZidxzw + name: Correction test 2 + description: Correction test 2 + active: false + createdDate: 1749638253403 + lastUpdated: 1749595053386 + scheduling: + startTime: 1749664800000 + duration: 2 + durationUnit: hour + recurrentRule: FREQ=DAILY;INTERVAL=1 + recurrent: true + sloIds: + - SLOBL-EmhZZQRy-19JVEivEdg + tags: [ + ] + - id: p9kWax0uS7K2Who1WegsSg + name: New test for DST corrections - Test-1 + description: This is to minimize impacts from DST + active: true + createdDate: 1749514781416 + lastUpdated: 1749514780649 + scheduling: + startTime: 1748775600000 + duration: 10 + durationUnit: hour + recurrentRule: FREQ=DAILY;INTERVAL=1 + recurrent: true + sloIds: + - SLOffwtrVkfRmCjOZbdv3Ls9g + tags: + - seasonal + - once + - id: b1T4ShnZS-qaORzBTAFRTA + name: test rrule - one time + description: test + active: true + createdDate: 1750161592895 + lastUpdated: 1750161592139 + scheduling: + startTime: 1750287600000 + duration: 24 + durationUnit: hour + recurrentRule: '' + recurrent: false + sloIds: + - SLOffwtrVkfRmCjOZbdv3Ls9g + tags: [ + ] + page: 1 + pageSize: 10000 + totalHits: 3 + schema: + $ref: '#/components/schemas/PaginatedResult' + description: Fetched list of the SLO Correction Window Configurations Successfully + security: + - ApiKeyAuth: + - Default + summary: Get All SLO Correction Window Configs + tags: + - SLO Correction Configurations + x-ibm-ahub-byok: true + post: + operationId: createSloCorrectionWindowConfig + requestBody: + content: + application/json: + example: + name: New test for DST corrections Test-9 + description: This is to check report API + active: true + scheduling: + startTime: 1749607200000 + duration: 3 + durationUnit: HOUR + recurrentRule: FREQ=DAILY;INTERVAL=1 + sloIds: + - SLO4s-fs-GuT56c3v4KzQKBuQ + tags: + - test + - rrule + schema: + $ref: '#/components/schemas/CorrectionConfiguration' + required: true + responses: + '200': + content: + application/json: + example: + id: S8rHrE93Rz2TXScTjBw1eg + name: New test for DST corrections Test-9 + description: This is to check report API + active: true + createdDate: 1750179360429 + lastUpdated: 1750179359948 + scheduling: + startTime: 1749607200000 + duration: 3 + durationUnit: hour + recurrentRule: FREQ=DAILY;INTERVAL=1 + recurrent: true + sloIds: + - SLO4s-fs-GuT56c3v4KzQKBuQ + tags: + - rrule + - test + schema: + $ref: '#/components/schemas/CorrectionConfiguration' + description: New SLO Correction Window Configuration Created Successfully + '400': + content: + application/json: + example: '{"errors":["SloConfiguration with id: SLOeDPoToCSTyOtd2ZQ + was not found"]}' + schema: + type: string + description: Bad Request + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureServiceLevelCorrectionWindows + summary: Create a new SLO Correction Window Config + tags: + - SLO Correction Configurations + x-description: createSloCorrectionConfiguration + x-ibm-ahub-byok: true + /api/settings/correction/{id}: + delete: + operationId: deleteSloCorrectionWindowConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: SLO Correction Window Configuration ID + example: cvLxfzNJQriV86MQTqOu1g + responses: + '204': + description: SLO Correction Window Configuration Deleted Successfully + security: + - ApiKeyAuth: + - canConfigureServiceLevelCorrectionWindows + summary: Delete an existing SLO Correction Window Configuration + tags: + - SLO Correction Configurations + x-ibm-ahub-byok: true + get: + operationId: getSloCorrectionWindowConfigById + parameters: + - in: path + name: id + required: true + schema: + type: string + description: SLO Correction Window Configuration ID + example: dCTspkffgHlS_OzNOATQWgsuw + - in: query + name: refresh + schema: + type: boolean + description: Boolean operator which specifies if the cache needs to be refreshed + example: false + responses: + '200': + content: + application/json: + example: + id: S8rHrE93Rz2TXScTjBw1eg + name: New test for DST corrections Test-9 + description: This is to check report API + active: true + createdDate: 1750179360429 + lastUpdated: 1750179359948 + scheduling: + startTime: 1749607200000 + duration: 3 + durationUnit: hour + recurrentRule: FREQ=DAILY;INTERVAL=1 + recurrent: true + sloIds: + - SLO4s-fs-GuT56c3v4KzQKBuQ + tags: + - rrule + - test + schema: + $ref: '#/components/schemas/CorrectionConfiguration' + description: Fetched SLO Correction Window Configuration Successfully + '404': + content: + application/json: + example: + errors: + - The SLO Correction Window Configuration you are looking for does + not exist. + schema: + type: string + description: SLO Correction Window Configuration Not Found + security: + - ApiKeyAuth: + - Default + summary: Get an existing SLO Correction Window Config + tags: + - SLO Correction Configurations + x-ibm-ahub-byok: true + put: + operationId: updateSloCorrectionWindowConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: SLO Correction Window Configuration ID + example: cvLxfzNJQriV86MQTqOu1g + requestBody: + content: + application/json: + example: + name: New test for DST corrections Test-9 + description: This is to check report API + active: true + scheduling: + startTime: 1749607200000 + duration: 3 + durationUnit: HOUR + recurrentRule: FREQ=DAILY;INTERVAL=1 + sloIds: + - SLO4s-fs-GuT56c3v4KzQKBuQ + tags: + - test + - rrule + schema: + $ref: '#/components/schemas/CorrectionConfiguration' + required: true + responses: + '200': + content: + application/json: + example: + id: S8rHrE93Rz2TXScTjBw1eg + name: New test for DST corrections Test-9 + description: This is to check report API + active: true + createdDate: 1750179360429 + lastUpdated: 1750179359948 + scheduling: + startTime: 1749607200000 + duration: 3 + durationUnit: hour + recurrentRule: FREQ=DAILY;INTERVAL=1 + recurrent: true + sloIds: + - SLO4s-fs-GuT56c3v4KzQKBuQ + tags: + - rrule + - test + schema: + $ref: '#/components/schemas/CorrectionConfiguration' + description: Updated SLO Correction Window Configuration Successfully + '400': + content: + application/json: + example: + errors: + - 'SloConfiguration with id: SLOeDPoToCSTyOtd2ZQ was not found' + schema: + type: string + description: Bad Request + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureServiceLevelCorrectionWindows + summary: Update an existing SLO Correction Window Config + tags: + - SLO Correction Configurations + x-description: updateSloCorrectionConfiguration + x-ibm-ahub-byok: true + /api/settings/invitation/share: + post: + operationId: shareAndInviteUsers + requestBody: + content: + application/json: + example: + - email: username@example.com + groupId: '-1' + message: hello message + path: /testpath + schema: + type: array + items: + $ref: '#/components/schemas/Invitation' + required: true + responses: + '200': + content: + application/json: + example: + invitationResults: + - userEmail: username@example.com + invitationStatus: SUCCESS + schema: + type: array + items: + $ref: '#/components/schemas/InvitationResponse' + description: OK + '400': + content: + application/json: + example: + errors: + - Please set at least one email + schema: + type: string + description: Bad Request Error + security: + - ApiKeyAuth: + - CanConfigureUsers + summary: Send user invitations + tags: + - User + x-description: inviteUsers + x-ibm-ahub-byok: true + /api/settings/invitations: + delete: + operationId: revokePendingInvitation + parameters: + - description: Email of the invite for removal + example: username@example.com + in: query + name: email + required: true + schema: + type: string + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - CanConfigureUsers + summary: Revoke pending invitation + tags: + - User + x-description: revokePendingInvitation + x-ibm-ahub-byok: true + get: + operationId: getInvitations + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/InvitationResult' + description: OK + security: + - ApiKeyAuth: + - CanConfigureUsers + summary: All pending invitations + tags: + - User + x-description: getInvitations + x-ibm-ahub-byok: true + post: + operationId: inviteUsers + requestBody: + content: + application/json: + example: + - email: username@example.com + groupId: '-1' + schema: + type: array + items: + $ref: '#/components/schemas/Invitation' + required: true + responses: + '200': + content: + application/json: + example: + invitationResults: + - userEmail: username@example.com + invitationStatus: SUCCESS + schema: + type: array + items: + $ref: '#/components/schemas/InvitationResponse' + description: OK + '400': + content: + application/json: + example: + errors: + - Please set at least one email + schema: + type: string + description: Bad Request Error + security: + - ApiKeyAuth: + - CanConfigureUsers + summary: Send user invitations + tags: + - User + x-description: inviteUsers + x-ibm-ahub-byok: true + /api/settings/maintenance: + get: + deprecated: true + description: |2- + + For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + operationId: getMaintenanceConfigs + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ValidatedMaintenanceConfigWithStatus' + description: OK + security: + - ApiKeyAuth: + - CanConfigureMaintenanceWindows + summary: All maintenance configurations + tags: + - Maintenance Configuration + x-ibm-ahub-byok: true + /api/settings/maintenance/{id}: + delete: + deprecated: true + description: |2- + + For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + operationId: deleteMaintenanceConfig + parameters: + - description: ID of the Maintenance Window Configuration to delete. + example: MPhKWoXRp0PBelqk + in: path + name: id + required: true + schema: + type: string + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - CanConfigureMaintenanceWindows + summary: Delete maintenance configuration + tags: + - Maintenance Configuration + x-ibm-ahub-byok: true + get: + deprecated: true + description: |2- + + For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + operationId: getMaintenanceConfig + parameters: + - description: ID of the Maintenance Window Configuration to get. + example: MPhKWoXRp0PBelqk + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/MaintenanceConfigWithLastUpdated' + description: OK + security: + - ApiKeyAuth: + - CanConfigureMaintenanceWindows + summary: Maintenance configuration + tags: + - Maintenance Configuration + x-ibm-ahub-byok: true + put: + deprecated: true + description: |2- + + For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + operationId: putMaintenanceConfig + parameters: + - description: ID of the Maintenance Window Configuration to update. + example: MPhKWoXRp0PBelqk + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MaintenanceConfig' + required: true + responses: + '200': + description: Maintenance config has been created or updated, and successfully + scheduled immediately if needed + '202': + description: Maintenance config has been created or updated, but could not + to be scheduled immediately. It will therefore be scheduled during the + next auto-refresh with a delay of up to 4 minutes. + '400': + description: Invalid JSON or mismatching IDs have been provided + security: + - ApiKeyAuth: + - CanConfigureMaintenanceWindows + summary: Create or update maintenance configuration + tags: + - Maintenance Configuration + x-ibm-ahub-byok: true + /api/settings/rbac/groups: + get: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: getGroups + responses: + '200': + content: + application/json: + example: + - id: groupId1 + name: group1 + members: + - userId: userId1 + email: username1@example.com + - userId: userId2 + email: username2@example.com + - id: groupId2 + name: group2 + members: + - userId: userId1 + email: username1@example.com + - userId: userId3 + email: username3@example.com + schema: + type: array + items: + $ref: '#/components/schemas/ApiGroup' + description: OK + '404': + description: No groups found + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Get groups + tags: + - Groups + x-description: getGroups + x-ibm-ahub-byok: true + post: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: createGroup + requestBody: + content: + application/json: + example: + name: group name + members: + - userId: userId + email: username@example.com + permissionSet: + permissions: + - CAN_VIEW_LOGS + applicationIds: + - scopeId: scopeId1 + scopeRoleId: '-102' + kubernetesClusterUUIDs: [ + ] + kubernetesNamespaceUIDs: [ + ] + websiteIds: [ + ] + mobileAppIds: [ + ] + syntheticTestIds: + - scopeId: scopeId10 + scopeRoleId: '-1' + restrictedApplicationFilter: + label: group name + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: acceptor + numberValue: null + booleanValue: null + key: null + value: acceptor + operator: EQUALS + entity: DESTINATION + scope: INCLUDE_NO_DOWNSTREAM + infraDfqFilter: + scopeId: '' + scopeRoleId: '-1' + actionFilter: + scopeId: '' + scopeRoleId: '-1' + schema: + $ref: '#/components/schemas/ApiCreateGroup' + required: true + responses: + '200': + content: + application/json: + example: + name: group name + members: + - userId: userId + email: username@example.com + permissionSet: + permissions: + - CAN_VIEW_LOGS + applicationIds: + - scopeId: scopeId1 + scopeRoleId: '-102' + kubernetesClusterUUIDs: [ + ] + kubernetesNamespaceUIDs: [ + ] + websiteIds: [ + ] + mobileAppIds: [ + ] + syntheticTestIds: + - scopeId: scopeId10 + scopeRoleId: '-1' + restrictedApplicationFilter: + label: group name + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: acceptor + numberValue: null + booleanValue: null + key: null + value: acceptor + operator: EQUALS + entity: DESTINATION + scope: INCLUDE_NO_DOWNSTREAM + infraDfqFilter: + scopeId: '' + scopeRoleId: '-1' + actionFilter: + scopeId: '' + scopeRoleId: '-1' + schema: + $ref: '#/components/schemas/ApiGroup' + description: OK + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Create group + tags: + - Groups + x-description: createGroup + x-ibm-ahub-byok: true + /api/settings/rbac/groups/delete: + put: + description: |- + Delete multiple groups + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: deleteGroups + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + uniqueItems: true + required: true + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Delete groups + tags: + - Groups + x-ibm-ahub-byok: true + /api/settings/rbac/groups/user/{email}: + get: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: getGroupsByUser + parameters: + - description: Email of the user for retrieval + example: username@example.com + in: path + name: email + required: true + schema: + type: string + style: simple + responses: + '200': + content: + application/json: + example: + - id: groupId + name: group name + members: + - userId: userId + email: username@example.com + permissionSet: + permissions: + - CAN_VIEW_LOGS + - LIMITED_APPLICATIONS_SCOPE + - ACCESS_APPLICATIONS + - CAN_VIEW_TRACE_DETAILS + applicationIds: + - scopeId: scopeId1 + scopeRoleId: '-102' + kubernetesClusterUUIDs: [ + ] + kubernetesNamespaceUIDs: [ + ] + websiteIds: [ + ] + mobileAppIds: [ + ] + syntheticTestIds: [ + ] + restrictedApplicationFilter: + label: filter name + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: acceptor + numberValue: null + booleanValue: null + key: null + value: acceptor + operator: EQUALS + entity: DESTINATION + scope: INCLUDE_NO_DOWNSTREAM + infraDfqFilter: + scopeId: '' + scopeRoleId: '-1' + actionFilter: + scopeId: '' + scopeRoleId: '-1' + schema: + type: array + items: + $ref: '#/components/schemas/ApiGroup' + description: OK + '404': + description: No groups found + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Get groups of a single user + tags: + - Groups + x-description: getGroupsByUser + x-ibm-ahub-byok: true + /api/settings/rbac/groups/{groupId}/permissions: + put: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: addPermissionsOnGroup + parameters: + - description: Id of the group to add permissions + example: groupId + in: path + name: groupId + required: true + schema: + type: string + style: simple + requestBody: + content: + application/json: + example: + - CAN_VIEW_SYNTHETIC_TESTS + - CAN_VIEW_SYNTHETIC_LOCATIONS + - CAN_CONFIGURE_AUTOMATION_ACTIONS + schema: + type: array + items: + type: string + required: true + responses: + '200': + content: + application/json: + example: + id: groupId + name: group name + members: + - userId: userId1 + email: username1@example.com + permissionSet: + permissions: + - CAN_VIEW_LOGS + - CAN_VIEW_SYNTHETIC_TESTS + - CAN_VIEW_SYNTHETIC_LOCATIONS + - CAN_CONFIGURE_AUTOMATION_ACTIONS + applicationIds: [ + ] + kubernetesClusterUUIDs: [ + ] + kubernetesNamespaceUIDs: [ + ] + websiteIds: [ + ] + mobileAppIds: [ + ] + syntheticTestIds: [ + ] + infraDfqFilter: + scopeId: '' + scopeRoleId: '-1' + actionFilter: + scopeId: '' + scopeRoleId: '-1' + schema: + $ref: '#/components/schemas/ApiGroup' + description: OK + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Add permissions to group + tags: + - Groups + x-description: updateGroup + x-ibm-ahub-byok: true + /api/settings/rbac/groups/{groupId}/users: + put: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: addUsersToGroup + parameters: + - description: Id of the group to add users + example: groupId + in: path + name: groupId + required: true + schema: + type: string + style: simple + requestBody: + content: + application/json: + example: + - userId1 + - userId3 + schema: + type: array + items: + type: string + required: true + responses: + '200': + content: + application/json: + example: + id: groupId + name: group name + members: + - userId: userId1 + email: username1@example.com + - userId: userId2 + email: username2@example.com + - userId: userId3 + email: username3@example.com + permissionSet: + permissions: + - CAN_VIEW_LOGS + applicationIds: [ + ] + kubernetesClusterUUIDs: [ + ] + kubernetesNamespaceUIDs: [ + ] + websiteIds: [ + ] + mobileAppIds: [ + ] + syntheticTestIds: [ + ] + infraDfqFilter: + scopeId: '' + scopeRoleId: '-1' + actionFilter: + scopeId: '' + scopeRoleId: '-1' + schema: + $ref: '#/components/schemas/ApiGroup' + description: OK + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Add users to group + tags: + - Groups + x-description: addUsersToGroup + x-ibm-ahub-byok: true + /api/settings/rbac/groups/{id}: + delete: + description: |- + Delete the group data. + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: deleteGroup + parameters: + - description: Id of the group to delete + example: groupId + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: No Content - Group successfully deleted + '412': + content: + application/json: + example: Deletion of this group is not allowed + schema: + type: string + example: Deletion of this group is not allowed + description: Pre-Condition Failed - Returned when attempting to delete protected + system groups. + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Delete group + tags: + - Groups + x-ibm-ahub-byok: true + get: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: getGroup + parameters: + - description: Id of the group for retrieval + example: groupId + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: groupId + name: group name + members: + - userId: userId + email: username@example.com + permissionSet: + permissions: + - ACCESS_INFRASTRUCTURE + - LIMITED_WEBSITES_SCOPE + - CAN_VIEW_SYNTHETIC_TESTS + - CAN_VIEW_SYNTHETIC_LOCATIONS + - CAN_VIEW_TRACE_DETAILS + - CAN_CONFIGURE_AGENT_RUN_MODE + - CAN_CONFIGURE_AUTOMATION_ACTIONS + - CAN_CONFIGURE_USERS + - ACCESS_SYNTHETICS + - CAN_VIEW_LOGS + - LIMITED_KUBERNETES_SCOPE + - CAN_CONFIGURE_TEAMS + - CAN_VIEW_SYNTHETIC_TEST_RESULTS + - LIMITED_SYNTHETICS_SCOPE + - LIMITED_INFRASTRUCTURE_SCOPE + applicationIds: + - scopeId: scopeId1 + scopeRoleId: '-102' + - scopeId: scopeId2 + scopeRoleId: '-102' + - scopeId: scopeId3 + scopeRoleId: '-102' + - scopeId: scopeId4 + scopeRoleId: '-102' + - scopeId: scopeId5 + scopeRoleId: '-102' + - scopeId: scopeId6 + scopeRoleId: '-102' + kubernetesClusterUUIDs: [ + ] + kubernetesNamespaceUIDs: [ + ] + websiteIds: [ + ] + mobileAppIds: [ + ] + syntheticTestIds: + - scopeId: scopeId10 + scopeRoleId: '-1' + restrictedApplicationFilter: + label: filter name + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: acceptor + numberValue: null + booleanValue: null + key: null + value: acceptor + operator: EQUALS + entity: DESTINATION + scope: INCLUDE_NO_DOWNSTREAM + infraDfqFilter: + scopeId: '' + scopeRoleId: '-1' + actionFilter: + scopeId: '' + scopeRoleId: '-1' + schema: + $ref: '#/components/schemas/ApiGroup' + description: OK + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Get group + tags: + - Groups + x-description: getGroup + x-ibm-ahub-byok: true + put: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: updateGroup + parameters: + - description: Id of the group to update + example: groupId + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: group name + members: + - userId: userId + email: username@example.com + permissionSet: + permissions: + - CAN_VIEW_LOGS + applicationIds: + - scopeId: scopeId1 + scopeRoleId: '-102' + kubernetesClusterUUIDs: [ + ] + kubernetesNamespaceUIDs: [ + ] + websiteIds: [ + ] + mobileAppIds: [ + ] + syntheticTestIds: + - scopeId: scopeId10 + scopeRoleId: '-1' + restrictedApplicationFilter: + label: group name + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: acceptor + numberValue: null + booleanValue: null + key: null + value: acceptor + operator: EQUALS + entity: DESTINATION + scope: INCLUDE_NO_DOWNSTREAM + infraDfqFilter: + scopeId: '' + scopeRoleId: '-1' + actionFilter: + scopeId: '' + scopeRoleId: '-1' + schema: + $ref: '#/components/schemas/ApiGroup' + required: true + responses: + '200': + content: + application/json: + example: + name: group name + members: + - userId: userId + email: username@example.com + permissionSet: + permissions: + - CAN_VIEW_LOGS + applicationIds: + - scopeId: scopeId1 + scopeRoleId: '-102' + kubernetesClusterUUIDs: [ + ] + kubernetesNamespaceUIDs: [ + ] + websiteIds: [ + ] + mobileAppIds: [ + ] + syntheticTestIds: + - scopeId: scopeId10 + scopeRoleId: '-1' + restrictedApplicationFilter: + label: group name + tagFilterExpression: + type: TAG_FILTER + name: service.name + stringValue: acceptor + numberValue: null + booleanValue: null + key: null + value: acceptor + operator: EQUALS + entity: DESTINATION + scope: INCLUDE_NO_DOWNSTREAM + infraDfqFilter: + scopeId: '' + scopeRoleId: '-1' + actionFilter: + scopeId: '' + scopeRoleId: '-1' + schema: + $ref: '#/components/schemas/ApiGroup' + description: OK + '404': + description: Not Found - Group with the specified ID does not exist + '412': + content: + application/json: + example: Modification of this group is not allowed + schema: + type: string + example: Modification of this group is not allowed + description: Pre-Condition Failed - Returned when attempting to modify protected + groups in a forbidden way. + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Update group + tags: + - Groups + x-description: updateGroup + x-ibm-ahub-byok: true + /api/settings/rbac/groups/{id}/user/{userId}: + delete: + description: |- + Remove the user from a group. + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: removeUserFromGroup + parameters: + - description: Id of the group to remove user from + example: groupId + in: path + name: id + required: true + schema: + type: string + - description: Id of the user to remove + example: userId + in: path + name: userId + required: true + schema: + type: string + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Remove user from group + tags: + - Groups + x-ibm-ahub-byok: true + /api/settings/rbac/mappings: + get: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: getGroupMappings + responses: + '200': + content: + application/json: + example: + - id: mappingId + key: roles + value: analyst + groupId: '-3' + schema: + type: array + items: + $ref: '#/components/schemas/GroupMapping' + description: OK + '404': + description: No group mapping found + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Get all group mappings + tags: + - Groups + x-description: getGroupMappings + x-ibm-ahub-byok: true + post: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: createGroupMapping + requestBody: + content: + application/json: + example: + key: roles + value: analyst + groupId: '-3' + schema: + $ref: '#/components/schemas/GroupMapping' + required: true + responses: + '200': + content: + application/json: + example: + id: mappingId + key: roles + value: analyst + groupId: '-3' + schema: + $ref: '#/components/schemas/GroupMapping' + description: OK + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Create group mapping + tags: + - Groups + x-description: createGroupMapping + x-ibm-ahub-byok: true + /api/settings/rbac/mappings/identityProvider/restrictEmptyIdpGroups: + get: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: getIdentityProviderPatch + responses: + '200': + content: + application/json: + example: + restrictEmptyIdpGroups: false + schema: + $ref: '#/components/schemas/IdentityProviderPatch' + description: OK + '404': + description: No group mapping restriction found + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Check user restrictions for empty Idp group mapping + tags: + - Groups + x-description: getIdentityProviderPatch + x-ibm-ahub-byok: true + put: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: updateIdentityProvider + requestBody: + content: + application/json: + example: + restrictEmptyIdpGroups: true + schema: + $ref: '#/components/schemas/IdentityProviderPatch' + required: true + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Allow/Restrict users with empty Idp group mapping + tags: + - Groups + x-description: updateIdentityProvider + x-ibm-ahub-byok: true + /api/settings/rbac/mappings/overview: + get: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: getGroupMappingsOverview + responses: + '200': + content: + application/json: + example: + - id: mappingId + key: roles + value: analyst + role: default + team: testing + schema: + type: array + items: + $ref: '#/components/schemas/GroupMappingOverview' + description: OK + '404': + description: No group mapping overviews found + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Get all group mappings overview + tags: + - Groups + x-description: getGroupMappingsOverview + x-ibm-ahub-byok: true + /api/settings/rbac/mappings/{id}: + delete: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: deleteGroupMapping + parameters: + - description: Id of the group mapping to delete + example: mappingId + in: path + name: id + required: true + schema: + type: string + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Delete group mapping + tags: + - Groups + x-description: deleteGroupMapping + x-ibm-ahub-byok: true + get: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: getGroupMapping + parameters: + - in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: mappingId + key: roles + value: analyst + groupId: '-3' + schema: + $ref: '#/components/schemas/GroupMapping' + description: OK + '404': + description: No group mapping found + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Get group mapping + tags: + - Groups + x-description: getGroupMapping + x-ibm-ahub-byok: true + put: + description: |2- + + For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + operationId: updateGroupMapping + parameters: + - description: Id of the group mapping to update + example: mappingId + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + id: mappingId + key: roles + value: analyst + groupId: '-3' + schema: + $ref: '#/components/schemas/GroupMapping' + required: true + responses: + '200': + content: + application/json: + example: + id: mappingId + key: roles + value: analyst + groupId: '-3' + schema: + $ref: '#/components/schemas/GroupMapping' + description: OK + security: + - ApiKeyAuth: + - CanConfigureAuthenticationMethods + summary: Update group mapping + tags: + - Groups + x-description: updateGroupMapping + x-ibm-ahub-byok: true + /api/settings/rbac/roles: + get: + description: Retrieve all roles for the current tenant unit. + operationId: getRoles + responses: + '200': + content: + application/json: + example: + - id: role-1 + name: Administrator + members: + - userId: user-1 + email: admin@example.com + name: Admin User + - userId: user-2 + email: manager@example.com + name: Manager User + permissions: + - CAN_CONFIGURE_APPLICATIONS + - CAN_CONFIGURE_EVENTS + - CAN_CONFIGURE_INFRASTRUCTURE + - CAN_CONFIGURE_TEAMS + - id: role-2 + name: Developer + members: + - userId: user-3 + email: dev1@example.com + name: Developer One + - userId: user-4 + email: dev2@example.com + name: Developer Two + permissions: + - CAN_VIEW_APPLICATIONS + - CAN_VIEW_EVENTS + - CAN_VIEW_INFRASTRUCTURE + schema: + type: array + items: + $ref: '#/components/schemas/ApiRole' + description: OK + '404': + description: No roles found + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Get all roles + tags: + - Roles + x-ibm-ahub-byok: true + post: + description: Create a new role. + operationId: createRole + requestBody: + content: + application/json: + example: + name: New Role + members: + - userId: user-5 + email: newuser@example.com + name: New User + permissions: + - CAN_VIEW_APPLICATIONS + - CAN_VIEW_EVENTS + schema: + $ref: '#/components/schemas/ApiCreateRole' + description: Role to create + required: true + responses: + '200': + content: + application/json: + example: + id: role-3 + name: New Role + members: + - userId: user-5 + email: newuser@example.com + name: New User + permissions: + - CAN_VIEW_APPLICATIONS + - CAN_VIEW_EVENTS + schema: + $ref: '#/components/schemas/ApiRole' + description: OK + '422': + description: Unprocessable entity. + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Create role + tags: + - Roles + x-ibm-ahub-byok: true + /api/settings/rbac/roles/{id}: + delete: + description: Delete a role by ID. + operationId: deleteRole + parameters: + - description: Id of the role to delete + example: roleId + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Role successfully deleted + '404': + description: Role not found + '412': + content: + application/json: + example: Deletion of this group is not allowed + schema: + type: string + example: Deletion of this group is not allowed + description: Pre-Condition Failed - Returned when attempting to delete protected + system roles. + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Delete role + tags: + - Roles + x-ibm-ahub-byok: true + get: + description: Retrieve a specific role by its ID. + operationId: getRole + parameters: + - description: Id of the role for retrieval + example: roleId + in: path + name: id + required: true + schema: + type: string + - in: query + name: includeTeamUsage + schema: + type: boolean + responses: + '200': + content: + application/json: + example: + id: role-1 + name: Administrator + members: + - userId: user-1 + email: admin@example.com + name: Admin User + - userId: user-2 + email: manager@example.com + name: Manager User + permissions: + - CAN_CONFIGURE_APPLICATIONS + - CAN_CONFIGURE_EVENTS + - CAN_CONFIGURE_INFRASTRUCTURE + - CAN_CONFIGURE_TEAMS + schema: + $ref: '#/components/schemas/ApiRole' + description: OK + '404': + description: Role not found + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Get role by ID + tags: + - Roles + x-ibm-ahub-byok: true + put: + description: Update an existing role by ID. + operationId: updateRole + parameters: + - description: Id of the role to update + example: roleId + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + id: role-2 + name: Updated Developer Role + members: + - userId: user-3 + email: dev1@example.com + name: Developer One + - userId: user-4 + email: dev2@example.com + name: Developer Two + - userId: user-6 + email: dev3@example.com + name: Developer Three + permissions: + - CAN_VIEW_APPLICATIONS + - CAN_VIEW_EVENTS + - CAN_VIEW_INFRASTRUCTURE + - CAN_CONFIGURE_APPLICATIONS + schema: + $ref: '#/components/schemas/ApiRole' + description: Updated role data + required: true + responses: + '200': + content: + application/json: + example: + id: role-2 + name: Updated Developer Role + members: + - userId: user-3 + email: dev1@example.com + name: Developer One + - userId: user-4 + email: dev2@example.com + name: Developer Two + - userId: user-6 + email: dev3@example.com + name: Developer Three + permissions: + - CAN_VIEW_APPLICATIONS + - CAN_VIEW_EVENTS + - CAN_VIEW_INFRASTRUCTURE + - CAN_CONFIGURE_APPLICATIONS + schema: + $ref: '#/components/schemas/ApiRole' + description: OK + '404': + description: Role not found + '412': + content: + application/json: + example: Modification of this group is not allowed + schema: + type: string + example: Modification of this group is not allowed + description: Pre-Condition Failed - Returned when attempting to modify protected + roles in a forbidden way. + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Update role + tags: + - Roles + x-ibm-ahub-byok: true + /api/settings/rbac/teams: + get: + description: Retrieve all user teams for the current tenant unit. + operationId: getTeams + responses: + '200': + content: + application/json: + example: + - id: teamId1 + tag: team1 + info: + description: Team 1 description + scope: + accessPermissions: + - CAN_CONFIGURE_APPLICATIONS + - CAN_CONFIGURE_EVENTS + restrictedApplicationFilter: null + applications: + - app-123 + - app-456 + websites: [ + ] + mobileApps: [ + ] + kubernetesClusters: + - cluster-1 + kubernetesNamespaces: [ + ] + syntheticTests: [ + ] + syntheticCredentials: [ + ] + businessPerspectives: [ + ] + tagIds: + - tag-1 + actionFilter: '' + logFilter: '' + infraDfqFilter: '' + members: + - userId: userId1 + email: username1@example.com + name: User One + roles: + - roleId: role-1 + roleName: Admin + viaIdP: false + - userId: userId2 + email: username2@example.com + name: User Two + roles: + - roleId: role-2 + roleName: Developer + viaIdP: false + - id: teamId2 + tag: team2 + info: + description: Team 2 description + scope: + accessPermissions: + - CAN_CONFIGURE_INFRASTRUCTURE + restrictedApplicationFilter: null + applications: [ + ] + websites: [ + ] + mobileApps: [ + ] + kubernetesClusters: [ + ] + kubernetesNamespaces: + - namespace-1 + syntheticTests: [ + ] + syntheticCredentials: [ + ] + businessPerspectives: [ + ] + tagIds: [ + ] + actionFilter: '' + logFilter: '' + infraDfqFilter: '' + members: + - userId: userId1 + email: username1@example.com + name: User One + roles: + - roleId: role-1 + roleName: Admin + viaIdP: false + - userId: userId3 + email: username3@example.com + name: User Three + roles: + - roleId: role-3 + roleName: Operator + viaIdP: true + schema: + type: array + items: + $ref: '#/components/schemas/ApiTeam' + description: OK + '404': + description: No teams found + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Get all teams + tags: + - Teams + x-ibm-ahub-byok: true + post: + description: Create a new team. + operationId: createTeam + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApiTeam' + description: Team to create + required: true + responses: + '200': + description: Team created successfully + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Create team + tags: + - Teams + x-ibm-ahub-byok: true + /api/settings/rbac/teams/{id}: + delete: + description: Delete the team data. + operationId: deleteTeam + parameters: + - description: Id of the team to delete + example: teamId + in: path + name: id + required: true + schema: + type: string + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Delete team + tags: + - Teams + x-ibm-ahub-byok: true + get: + description: Retrieve a specific team by its ID. + operationId: getTeam + parameters: + - description: Id of the team for retrieval + example: teamId + in: path + name: id + required: true + schema: + type: string + - in: query + name: includeTeamUsage + schema: + type: boolean + responses: + '200': + content: + application/json: + example: + id: team-1 + tag: Development Team + info: + description: Team responsible for application development + scope: + accessPermissions: + - CAN_CONFIGURE_APPLICATIONS + - CAN_CONFIGURE_EVENTS + restrictedApplicationFilter: + restrictingApplicationId: app-123 + applications: + - app-123 + - app-456 + websites: + - website-1 + mobileApps: + - mobile-1 + kubernetesClusters: + - cluster-1 + kubernetesNamespaces: + - namespace-1 + syntheticTests: + - test-1 + syntheticCredentials: [ + ] + businessPerspectives: + - bp-1 + tagIds: + - tag-1 + - tag-2 + actionFilter: '' + logFilter: '' + infraDfqFilter: '' + members: + - userId: user-1 + email: user1@example.com + name: John Doe + roles: + - roleId: role-1 + roleName: Admin + viaIdP: false + - userId: user-2 + email: user2@example.com + name: Jane Smith + roles: + - roleId: role-2 + roleName: Developer + viaIdP: false + schema: + $ref: '#/components/schemas/ApiTeam' + description: Successfully retrieved the team + '404': + description: Team not found + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Get team by ID + tags: + - Teams + x-ibm-ahub-byok: true + put: + description: Update an existing team by ID. + operationId: updateTeam + parameters: + - description: Id of the team to update + example: teamId + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApiTeam' + responses: + '200': + description: Team updated successfully + '404': + description: Team not found + security: + - ApiKeyAuth: + - CanConfigureTeams + summary: Update team + tags: + - Teams + x-ibm-ahub-byok: true + /api/settings/session: + delete: + description: Delete tenant unit session settings. + operationId: deleteSessionSettings + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - CanConfigureSessionSettings + summary: Delete session settings + tags: + - Session Settings + x-ibm-ahub-byok: true + get: + description: Get the tenant unit session settings + operationId: getSessionSettings + responses: + '200': + content: + application/json: + example: | + { + tokenLifeTimeInMillis: 28800000, + idleTimeInMillis: 3600000 + } + schema: + $ref: '#/components/schemas/SessionSettings' + description: OK + security: + - ApiKeyAuth: + - CanConfigureSessionSettings + summary: Get session settings + tags: + - Session Settings + x-ibm-ahub-byok: true + put: + description: Update individual tenant unit session settings. + operationId: setSessionSettings + requestBody: + content: + application/json: + example: | + { + tokenLifeTimeInMillis: 28800000, + idleTimeInMillis: 3600000 + } + schema: + $ref: '#/components/schemas/SessionSettings' + responses: + '200': + content: + application/json: + example: | + { + tokenLifeTimeInMillis: 28800000, + idleTimeInMillis: 3600000 + } + schema: + $ref: '#/components/schemas/SessionSettings' + description: OK + security: + - ApiKeyAuth: + - CanConfigureSessionSettings + summary: Configure session settings + tags: + - Session Settings + x-ibm-ahub-byok: true + /api/settings/sli: + get: + deprecated: true + operationId: getAllSliConfigs + responses: + '200': + content: + application/json: + example: + id: 3J0RDgfyQz-P_hVzbNNb4A + sliName: test-application-sli + initialEvaluationTimestamp: 1732017600000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 555 + sliEntity: + sliType: application + applicationId: btg-B709IU6o9QNXUS4TVw + serviceId: null + endpointId: null + boundaryScope: INBOUND + lastUpdated: 1732017541059 + schema: + type: array + items: + $ref: '#/components/schemas/SliConfigurationWithLastUpdated' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get All SLI Configs + tags: + - SLI Settings + x-ibm-ahub-byok: true + post: + deprecated: true + operationId: createSliConfig + requestBody: + content: + application/json: + example: + sliName: test-application-sli + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 555 + sliEntity: + sliType: application + applicationId: btg-B709IU6o9QNXUS4TVw + serviceId: null + endpointId: null + boundaryScope: INBOUND + schema: + $ref: '#/components/schemas/SliConfiguration' + required: true + responses: + '200': + content: + application/json: + example: + id: 3J0RDgfyQz-P_hVzbNNb4A + sliName: test-application-sli + initialEvaluationTimestamp: 1732017600000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 555 + sliEntity: + sliType: application + applicationId: btg-B709IU6o9QNXUS4TVw + serviceId: null + endpointId: null + boundaryScope: INBOUND + lastUpdated: 1732017541059 + schema: + $ref: '#/components/schemas/SliConfigurationWithLastUpdated' + description: OK + security: + - ApiKeyAuth: + - canConfigureServiceLevels + summary: Create SLI Config + tags: + - SLI Settings + x-description: createSliConfiguration + x-ibm-ahub-byok: true + /api/settings/sli/{id}: + delete: + deprecated: true + operationId: deleteSliConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: Service Levels Indicator ID + example: 7iydEfqJQP6AKzd3yR3byw + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - canConfigureServiceLevels + summary: Delete SLI Config + tags: + - SLI Settings + x-ibm-ahub-byok: true + get: + deprecated: true + operationId: getSliConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: Service Levels Indicator ID + example: 3J0RDgfyQz-P_hVzbNNb4A + responses: + '200': + content: + application/json: + example: + id: 3J0RDgfyQz-P_hVzbNNb4A + sliName: test-application-sli + initialEvaluationTimestamp: 1732017600000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 555 + sliEntity: + sliType: application + applicationId: btg-B709IU6o9QNXUS4TVw + serviceId: null + endpointId: null + boundaryScope: INBOUND + lastUpdated: 1732017541059 + schema: + $ref: '#/components/schemas/SliConfigurationWithLastUpdated' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get SLI Config + tags: + - SLI Settings + x-ibm-ahub-byok: true + put: + deprecated: true + operationId: updateSliConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: Service Levels Indicator ID + example: 3J0RDgfyQz-P_hVzbNNb4A + requestBody: + content: + application/json: + example: + id: 3J0RDgfyQz-P_hVzbNNb4A + sliName: test-application-sli + initialEvaluationTimestamp: 1732017600000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 555 + sliEntity: + sliType: application + applicationId: btg-B709IU6o9QNXUS4TVw + serviceId: null + endpointId: null + boundaryScope: INBOUND + lastUpdated: 1732017541059 + schema: + $ref: '#/components/schemas/SliConfiguration' + required: true + responses: + '200': + content: + application/json: + example: + id: 3J0RDgfyQz-P_hVzbNNb4A + sliName: test-application-sli + initialEvaluationTimestamp: 1732017600000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 555 + sliEntity: + sliType: application + applicationId: btg-B709IU6o9QNXUS4TVw + serviceId: null + endpointId: null + boundaryScope: INBOUND + lastUpdated: 1732017541059 + schema: + $ref: '#/components/schemas/SliConfigurationWithLastUpdated' + description: OK + security: + - ApiKeyAuth: + - canConfigureServiceLevels + summary: Update SLI Config + tags: + - SLI Settings + x-ibm-ahub-byok: true + /api/settings/slo: + get: + operationId: getAllSloConfigs + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + description: Size of the Page + example: 1 + - in: query + name: page + schema: + type: integer + format: int32 + description: Page Number + example: 1 + - in: query + name: orderBy + schema: + type: string + description: Order By Value + enum: + - name + - entityType + - entityName + - blueprint + - sloStatus + - sloWindowRemain + - timeWindow + - 'null' + example: name + - in: query + name: orderDirection + schema: + type: string + description: Order Direction of the Result, it could be ascending or descending + enum: + - ASC + - DESC + example: ASC + - in: query + name: query + schema: + type: string + description: Keyword or Query which needs to be searched + example: test SLO + - in: query + name: tag + schema: + type: array + description: List of tags which needs to be searched + example: Testing + items: + type: string + description: List of tags which needs to be searched + example: Testing + uniqueItems: true + - in: query + name: entityType + schema: + type: array + description: SLO Entity Type which needs to be filtered. (This filter could + occurs multiple times.) + example: application + items: + type: string + description: SLO Entity Type which needs to be filtered. (This filter + could occurs multiple times.) + enum: + - application + - website + - synthetic + - infrastructure + example: application + uniqueItems: true + - in: query + name: infraEntityTypes + schema: + type: array + description: Infrastructure Entity Type which needs to be filtered for Infrastructure + SLOs. + example: KubernetesCluster + items: + type: string + description: Infrastructure Entity Type which needs to be filtered for + Infrastructure SLOs. + example: KubernetesCluster + uniqueItems: true + - in: query + name: kubernetesClusterUuid + schema: + type: string + description: Kubernetes Cluster UUID which needs to be filtered for Infrastructure + SLOs with KubernetesCluster as infraType. + example: 823b8c2e-5bc3-11ee-a0f4-42010a8000ff + - in: query + name: blueprint + schema: + type: array + description: SLO blueprint Type which needs to be filtered. (This filter + could occurs multiple times.) + example: latency + items: + type: string + description: SLO blueprint Type which needs to be filtered. (This filter + could occurs multiple times.) + enum: + - latency + - availability + - traffic + - saturation + - custom + example: latency + uniqueItems: true + - in: query + name: sloIds + schema: + type: array + description: List of SLO IDs for which details need to be fetched + example: SLOdCTspkHlS_OzNOATQWgsuw + items: + type: string + description: List of SLO IDs for which details need to be fetched + example: SLOdCTspkHlS_OzNOATQWgsuw + - in: query + name: sloStatus + schema: + type: string + description: Filter by the SLO status + example: green + - in: query + name: entityIds + schema: + type: array + description: List of entity IDs for which details need to be fetched + example: adsewby312sdfd1 + items: + type: string + description: List of entity IDs for which details need to be fetched + example: adsewby312sdfd1 + - in: query + name: grouped + schema: + type: boolean + description: Boolean operator which specifies if the results are grouped + example: false + - in: query + name: refresh + schema: + type: boolean + description: Boolean operator which specifies if the cache needs to be refreshed + example: false + - in: query + name: rbacTags + schema: + type: array + description: List of rbac teams tags which needs to be searched + example: Testing + items: + type: string + description: List of rbac teams tags which needs to be searched + example: Testing + uniqueItems: true + responses: + '200': + content: + application/json: + example: + items: + - id: SLOY2KDCFExTvmsLyf4W067JQ + name: Stans test SLO 2 + target: 0.99 + lastUpdated: 1680182215442 + entity: + type: application + applicationId: VTNvC_sATZqMj4vSZfsjKA + serviceId: null + endpointId: null + boundaryScope: INBOUND + includeInternal: false + includeSynthetic: false + tagFilterExpression: null + rbacTags: + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 + indicator: + type: timeBased + blueprint: latency + threshold: 100 + aggregation: P90 + timeWindow: + type: rolling + duration: 1 + durationUnit: week + tags: + - Stan + - testing + - id: SLOsmbQLI8ORcuhF_L-QquFWQ + name: '[Should match no nothing test] website entity tag filter' + target: 0.9999 + lastUpdated: 1683792839372 + rbacTags: + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 + entity: + type: website + websiteId: XIZGGVT1TX2O-0OFeT2Yig + beaconType: httpRequest + tagFilterExpression: + type: TAG_FILTER + name: beacon.geo.country + stringValue: Moon + numberValue: null + booleanValue: null + key: null + value: Moon + operator: EQUALS + entity: NOT_APPLICABLE + indicator: + type: eventBased + blueprint: latency + threshold: 60000 + timeWindow: + type: rolling + duration: 1 + durationUnit: week + tags: + - test + - no matches + page: 1 + pageSize: 10000 + totalHits: 2 + schema: + $ref: '#/components/schemas/PaginatedResult' + description: Fetched list of the SLO Configurations Successfully + security: + - ApiKeyAuth: + - Default + summary: Get All SLO Configs + tags: + - Service Levels Objective(SLO) Configurations + x-ibm-ahub-byok: true + post: + operationId: createSloConfig + requestBody: + content: + application/json: + example: + name: Stans test SLO 4 + target: 0.99 + rbacTags: + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 + entity: + type: application + applicationId: VTNvC_sATZqMj4vSZfsjKA + serviceId: null + endpointId: null + boundaryScope: INBOUND + includeInternal: false + includeSynthetic: false + tagFilterExpression: null + indicator: + type: timeBased + blueprint: latency + threshold: 100 + aggregation: P90 + timeWindow: + type: rolling + duration: 1 + durationUnit: week + tags: + - Stan + - testing + schema: + $ref: '#/components/schemas/SLOConfigWithRBACTag' + required: true + responses: + '200': + content: + application/json: + example: + id: SLOdCTspkHlS_OzNOATQWgsuw + rbacTags: + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 + createdDate: 1680182236227 + name: Stans test SLO 4 + target: 0.99 + lastUpdated: 1713873207738 + entity: + type: application + applicationId: VTNvC_sATZqMj4vSZfsjKA + serviceId: null + endpointId: null + boundaryScope: INBOUND + includeInternal: false + includeSynthetic: false + tagFilterExpression: null + indicator: + type: timeBased + blueprint: latency + threshold: 100 + aggregation: P90 + timeWindow: + type: rolling + duration: 1 + durationUnit: week + tags: + - Stan + - testing + schema: + $ref: '#/components/schemas/SLOConfigWithRBACTag' + description: New SLO Configuration Created Successfully + '400': + content: + application/json: + example: '{"errors":["Unknown tag filter: call.error"]}' + schema: + type: string + description: Invalid Tag Filter + security: + - ApiKeyAuth: + - canConfigureServiceLevels + summary: Create a new SLO Config + tags: + - Service Levels Objective(SLO) Configurations + x-description: createSloConfiguration + x-ibm-ahub-byok: true + /api/settings/slo/tags: + get: + operationId: getAllSloConfigTags + parameters: + - in: query + name: query + schema: + type: string + description: Keyword or Query which needs to be searched + example: test SLO + - in: query + name: tag + schema: + type: array + description: List of tags which needs to be searched + example: Testing + items: + type: string + description: List of tags which needs to be searched + example: Testing + uniqueItems: true + - in: query + name: entityType + schema: + type: string + description: SLO Entity Type which needs to be filtered + enum: + - application + - website + - synthetic + - infrastructure + example: application + responses: + '200': + content: + application/json: + example: + - andre + - test + - testing + - drinks + - got no snacks + - timeBased + - Stan + - no matches + - availability + - Lab + - demo + - thiemo + - TimeWindow Test + - robot-shop + - eventBased + - got snacks + - migration + - robert-creates-a-new-sli + schema: + type: array + items: + type: string + description: Fetched list of SLO Configuration tags Successfully + security: + - ApiKeyAuth: + - Default + summary: Get All SLO Config tags + tags: + - Service Levels Objective(SLO) Configurations + x-ibm-ahub-byok: true + /api/settings/slo/{id}: + delete: + operationId: deleteSloConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: Service Levels Objective Configuration ID + example: SLOdCTspkHlS_OzNOATQWgsuw + responses: + '204': + description: SLO Configuration Deleted Successfully + security: + - ApiKeyAuth: + - canConfigureServiceLevels + summary: Delete an existing SLO Config + tags: + - Service Levels Objective(SLO) Configurations + x-ibm-ahub-byok: true + get: + operationId: getSloConfigById + parameters: + - in: path + name: id + required: true + schema: + type: string + description: Service Levels Objective Configuration ID + example: SLOdCTspkHlS_OzNOATQWgsuw + - in: query + name: refresh + schema: + type: boolean + description: Boolean operator which specifies if the cache needs to be refreshed + example: false + responses: + '200': + content: + application/json: + example: + id: SLOdCTspkHlS_OzNOATQWgsuw + rbacTags: + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 + createdDate: 1680182236227 + name: Stans test SLO 4 + target: 0.99 + lastUpdated: 1713873207738 + entity: + type: application + applicationId: VTNvC_sATZqMj4vSZfsjKA + serviceId: null + endpointId: null + boundaryScope: INBOUND + includeInternal: false + includeSynthetic: false + tagFilterExpression: null + indicator: + type: timeBased + blueprint: latency + threshold: 100 + aggregation: P90 + timeWindow: + type: rolling + duration: 1 + durationUnit: week + tags: + - Stan + - testing + schema: + $ref: '#/components/schemas/SLOConfigWithRBACTag' + description: Fetched SLO Configuration Successfully + '404': + content: + application/json: + example: + errors: + - The sloConfiguration you are looking for does not exist. + schema: + type: string + description: SLO Configuration Not Found + security: + - ApiKeyAuth: + - Default + summary: Get an existing SLO Config + tags: + - Service Levels Objective(SLO) Configurations + x-ibm-ahub-byok: true + put: + operationId: updateSloConfig + parameters: + - in: path + name: id + required: true + schema: + type: string + description: Service Levels Objective Configuration ID + example: SLOdCTspkHlS_OzNOATQWgsuw + requestBody: + content: + application/json: + example: + name: Stans test SLO 4 + target: 0.99 + rbacTags: + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 + entity: + type: application + applicationId: VTNvC_sATZqMj4vSZfsjKA + serviceId: null + endpointId: null + boundaryScope: INBOUND + includeInternal: false + includeSynthetic: false + tagFilterExpression: null + indicator: + type: timeBased + blueprint: latency + threshold: 100 + aggregation: P90 + timeWindow: + type: rolling + duration: 1 + durationUnit: week + tags: + - Stan + - testing + schema: + $ref: '#/components/schemas/SLOConfigWithRBACTag' + required: true + responses: + '200': + content: + application/json: + example: + id: SLOdCTspkHlS_OzNOATQWgsuw + rbacTags: + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 + createdDate: 1680182236227 + name: Stans test SLO 4 + target: 0.99 + lastUpdated: 1713873207738 + entity: + type: application + applicationId: VTNvC_sATZqMj4vSZfsjKA + serviceId: null + endpointId: null + boundaryScope: INBOUND + includeInternal: false + includeSynthetic: false + tagFilterExpression: null + indicator: + type: timeBased + blueprint: latency + threshold: 100 + aggregation: P90 + timeWindow: + type: rolling + duration: 1 + durationUnit: week + tags: + - Stan + - testing + schema: + $ref: '#/components/schemas/SLOConfigWithRBACTag' + description: Updated SLO Configuration Successfully + '400': + content: + application/json: + example: + errors: + - 'SloConfiguration with id: GC8r6gbZT4WIhtsMx_YgLg was not found' + schema: + type: string + description: Bad Request + security: + - ApiKeyAuth: + - canConfigureServiceLevels + summary: Update an existing SLO Config + tags: + - Service Levels Objective(SLO) Configurations + x-description: updateSloConfiguration + x-ibm-ahub-byok: true + /api/settings/synthetic-calls: + delete: + description: |- + Use this API endpoint if one wants to delete all custom synthetic call configurations. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Synthetic Calls please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#synthetic-calls. + operationId: deleteSyntheticCall + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Delete synthetic call configurations + tags: + - Synthetic Calls + x-ibm-ahub-byok: true + get: + description: |- + Use this API endpoint if one wants to get all custom synthetic call configurations. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Synthetic Calls please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#synthetic-calls. + operationId: getSyntheticCalls + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SyntheticCallWithDefaultsConfig' + description: OK + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Synthetic call configurations + tags: + - Synthetic Calls + x-ibm-ahub-byok: true + put: + description: |- + Use this API endpoint if one wants to get all custom synthetic call configurations. + This endpoint requires `CanConfigureServiceMapping` permission. + One can use `Create or update an API token` endpoint to update the permission by setting `canConfigureServiceMapping` to `true`. + If one wants to enable the permission from Instana UI, go to Settings -> Security & Access -> Access Control -> API Token. + There one can update the existing token or create a new token and set `Customize service rules and endpoint mapping` to `true`. + + For more information on Synthetic Calls please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#synthetic-calls. + operationId: updateSyntheticCall + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyntheticCallConfig' + required: true + responses: + '200': + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - ConfigureServiceMapping + summary: Update synthetic call configurations + tags: + - Synthetic Calls + x-ibm-ahub-byok: true + /api/settings/users: + get: + description: Retrieves all users with access to the tenant. The result will + not contain pending invitations. + operationId: getUsers + responses: + '200': + content: + application/json: + example: + - id: userId + email: username@example.com + fullName: username + lastLoggedIn: 1636434847190 + groupCount: 1 + tfaEnabled: false + schema: + type: array + items: + $ref: '#/components/schemas/UserResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureUsers + summary: All users (without invitations) + tags: + - User + x-ibm-ahub-byok: true + /api/settings/users/overview: + get: + description: Retrieves all users with access to the tenant. The result will + also contain pending invitations. + operationId: getUsersIncludingInvitations + responses: + '200': + content: + application/json: + example: + users: + - id: userId1 + email: username@example.com + fullName: fullName + lastLoggedIn: 1699313025975 + groupCount: null + tfaEnabled: null + invitations: + - id: userId2 + email: username2@example.com + groupId: '-3' + schema: + $ref: '#/components/schemas/UsersResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureUsers + summary: All users (incl. invitations) + tags: + - User + x-ibm-ahub-byok: true + /api/settings/users/{email}: + put: + description: Updates the full name of the user. + operationId: updateUser + parameters: + - in: path + name: email + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + fullName: Updated Name + schema: + $ref: '#/components/schemas/EditUser' + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + security: + - ApiKeyAuth: + - CanConfigureUsers + summary: Change user name of single user + tags: + - User + x-ibm-ahub-byok: true + /api/settings/users/{userId}: + delete: + description: Remove the users access to the tenant. Removing a user from a tenant + does not delete their user account. + operationId: removeUserFromTenant + parameters: + - description: Id of the user for removal + example: userId + in: path + name: userId + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureUsers + summary: Remove user from tenant + tags: + - User + x-ibm-ahub-byok: true + get: + description: Retrieves the user with access to the tenant. + operationId: getUserById + parameters: + - description: Id of the user for retrieval + example: userId + in: path + name: userId + required: true + schema: + type: string + style: simple + responses: + '200': + content: + application/json: + example: + id: userId + preferredName: preferredName + fullName: fullName + email: username@example.com + encryptedPassword: '' + lastLoggedIn: 1699442707385 + timestampAcceptedTos: 1696404223545 + timestampAcceptedPrivacyAgreement: 1696404223545 + acceptedTosVersion: 6 + acceptedPrivacyAgreementVersion: 9 + tenantsWhereMainContact: [ + ] + tenants: [ + ] + createDate: 1696404196256 + emailConfirmed: true + tenantIds: + - 55557f97186b9c0007857730 + passwordResetAttempt: 0 + groupCount: null + tfaEnabled: null + role: null + schema: + type: array + items: + $ref: '#/components/schemas/UserResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + security: + - ApiKeyAuth: + - CanConfigureUsers + summary: Get single user + tags: + - User + x-ibm-ahub-byok: true + /api/settings/v2/maintenance: + get: + description: |2- + + For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + operationId: getMaintenanceConfigsV2 + responses: + '200': + content: + application/json: + example: + - id: maintenanceConfigId + name: maintenanceConfig + query: entity.application.id:"anApplicationId" + scheduling: + start: 1680703219486 + duration: + amount: 2 + unit: HOURS + rrule: FREQ=DAILY;INTERVAL=1;COUNT=1 + timezoneId: UTC + type: RECURRENT + paused: false + lastUpdated: 1680703219678 + state: EXPIRED + validVersion: 1 + occurrence: + start: 1680703219000 + end: 1680710419000 + invalid: false + applicationNames: + - anApplicationName + - id: anotherMaintenanceConfigId + name: anotherMaintenanceConfig + query: entity.type:ibmz.db2 + scheduling: + start: 1680703219486 + duration: + amount: 2 + unit: HOURS + rrule: FREQ=DAILY;INTERVAL=1;COUNT=1 + timezoneId: UTC + type: RECURRENT + paused: false + lastUpdated: 1680703219678 + state: EXPIRED + validVersion: 1 + occurrence: + start: 1680703219000 + end: 1680710419000 + invalid: false + applicationNames: [ + ] + - id: '1698949644924' + name: sampleMaintenanceConfig + query: '' + scheduling: + start: 1698949644924 + duration: + amount: 2 + unit: HOURS + rrule: FREQ=WEEKLY;INTERVAL=2;BYDAY=SA;COUNT=10 + timezoneId: America/New_York + type: RECURRENT + paused: false + validVersion: 1 + tagFilterExpression: + type: EXPRESSION + logicalOperator: OR + elements: + - type: TAG_FILTER + name: synthetic.locationLabelAggregated + stringValue: us-east + numberValue: null + booleanValue: null + key: null + value: us-east + operator: EQUALS + entity: NOT_APPLICABLE + - type: TAG_FILTER + name: synthetic.syntheticType + stringValue: HTTPScript + numberValue: null + booleanValue: null + key: null + value: HTTPScript + operator: EQUALS + entity: NOT_APPLICABLE + tagFilterExpressionEnabled: true + retriggerOpenAlertsEnabled: true + lastUpdated: 1698949645163 + state: SCHEDULED + occurrence: + start: 1699122444000 + end: 1699129644000 + schema: + type: array + items: + $ref: '#/components/schemas/ValidatedMaintenanceConfigV2WithStateAndOccurrence' + description: OK + security: + - ApiKeyAuth: + - CanConfigureMaintenanceWindows + summary: All maintenance configurations + tags: + - Maintenance Configuration + x-description: getMaintenanceConfigs + x-ibm-ahub-byok: true + /api/settings/v2/maintenance/{id}: + delete: + description: |2- + + For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + operationId: deleteMaintenanceConfigV2 + parameters: + - description: Id of the Maintenance Window configuration to delete. + example: 8924aa6b + in: path + name: id + required: true + schema: + type: string + responses: + default: + content: + application/json: { + } + description: default response + security: + - ApiKeyAuth: + - CanConfigureMaintenanceWindows + summary: Delete maintenance configuration + tags: + - Maintenance Configuration + x-description: deleteMaintenanceConfig + x-ibm-ahub-byok: true + get: + description: |2- + + For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + operationId: getMaintenanceConfigV2 + parameters: + - description: Id of the Maintenance Window Configuration to get. + example: 8924aa6b + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: maintenanceConfigId + name: maintenanceConfig + query: '' + scheduling: + start: 1683864000000 + duration: + amount: 24 + unit: HOURS + type: ONE_TIME + paused: false + validVersion: 1 + lastUpdated: 1683901553115 + state: EXPIRED + occurrence: + start: 1683864000000 + end: 1683950400000 + schema: + $ref: '#/components/schemas/MaintenanceConfigV2WithStateAndOccurrence' + description: OK + security: + - ApiKeyAuth: + - CanConfigureMaintenanceWindows + summary: Get maintenance configuration + tags: + - Maintenance Configuration + x-description: getMaintenanceConfig + x-ibm-ahub-byok: true + put: + description: |2- + + For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + operationId: putMaintenanceConfigV2 + parameters: + - description: Id of the Maintenance Window configuration to update. + example: 8924aa6b + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MaintenanceConfigV2' + required: true + x-payload: putMaintenanceConfig + responses: + '200': + content: + application/json: + example: + id: maintenanceConfigId + name: maintenanceConfig + query: '' + scheduling: + start: 1698938631036 + duration: + amount: 2 + unit: HOURS + type: ONE_TIME + paused: false + validVersion: 1 + tagFilterExpression: + type: EXPRESSION + logicalOperator: OR + elements: + - type: TAG_FILTER + name: synthetic.locationLabelAggregated + stringValue: us-east + numberValue: null + booleanValue: null + key: null + value: us-east + operator: EQUALS + entity: NOT_APPLICABLE + - type: TAG_FILTER + name: synthetic.syntheticType + stringValue: HTTPScript + numberValue: null + booleanValue: null + key: null + value: HTTPScript + operator: EQUALS + entity: NOT_APPLICABLE + tagFilterExpressionEnabled: true + retriggerOpenAlertsEnabled: true + lastUpdated: 1698938631408 + state: ACTIVE + occurrence: + start: 1698938631036 + end: 1698945831036 + description: Maintenance config has been created or updated, and successfully + scheduled immediately if needed + '202': + description: Maintenance config has been created or updated, but could not + to be scheduled immediately. It will therefore be scheduled during the + next auto-refresh with a delay of up to 4 minutes. + '400': + description: The provided maintenance configuration is invalid. + '422': + description: The provided maintenance configuration is incomplete or cannot + be processed. + security: + - ApiKeyAuth: + - CanConfigureMaintenanceWindows + summary: Create or update maintenance configuration + tags: + - Maintenance Configuration + x-description: putMaintenanceConfig + x-ibm-ahub-byok: true + /api/settings/v2/maintenance/{id}/pause: + put: + description: |2- + + For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + operationId: pauseRecurrentMaintenanceConfiguration + parameters: + - description: Id of the Maintenance Window configuration to pause. + example: 8924aa6b + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: maintenanceConfigId + name: maintenanceConfig + query: entity.application.id:"anApplicationId" + scheduling: + start: 1684251745262 + duration: + amount: 2 + unit: HOURS + type: ONE_TIME + paused: true + validVersion: 1 + lastUpdated: 1684251750475 + state: PAUSED + occurrence: + start: 1684251745262 + end: 1684258945262 + schema: + $ref: '#/components/schemas/MaintenanceConfigV2WithStateAndOccurrence' + description: OK + security: + - ApiKeyAuth: + - CanConfigureMaintenanceWindows + summary: Pause maintenance configuration + tags: + - Maintenance Configuration + x-description: pauseMaintenanceConfig + x-ibm-ahub-byok: true + /api/settings/v2/maintenance/{id}/resume: + put: + description: |2- + + For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + operationId: resumeRecurrentMaintenanceConfiguration + parameters: + - description: Id of the Maintenance Window configuration to resume. + example: 8924aa6b + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: maintenanceConfigId + name: maintenanceConfig + query: entity.application.id:"anApplicationId" + scheduling: + start: 1684251745262 + duration: + amount: 2 + unit: HOURS + type: ONE_TIME + paused: false + validVersion: 1 + lastUpdated: 1684251933433 + state: ACTIVE + occurrence: + start: 1684251745262 + end: 1684258945262 + schema: + $ref: '#/components/schemas/MaintenanceConfigV2WithStateAndOccurrence' + description: OK + security: + - ApiKeyAuth: + - CanConfigureMaintenanceWindows + summary: Resume maintenance configuration + tags: + - Maintenance Configuration + x-description: resumeMaintenanceConfig + x-ibm-ahub-byok: true + /api/settings/v2/sli: + get: + operationId: getAllSliConfigsV2 + responses: + '200': + content: + application/json: + example: + - id: T0yCMBR4G + sliName: Siva SLI test + initialEvaluationTimestamp: 1637758860000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 100.0 + sliEntity: + sliType: application + applicationId: 1qvXgVfLTNqi8gGTcCaNUw + serviceId: 6097d596c3d9024034b3d03b2b5c43acea65e5a4 + endpointId: oETFj2WyPusvXgRW_181J3fH_t8 + boundaryScope: INBOUND + lastUpdated: 1637758839104 + schema: + type: array + items: + $ref: '#/components/schemas/SliConfigurationWithLastUpdated' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get All SLI Configs + tags: + - SLI Settings + x-ibm-ahub-byok: true + post: + operationId: createSliConfigV2 + requestBody: + content: + application/json: + example: + sliName: test-application-sli + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 555 + sliEntity: + sliType: application + applicationId: btg-B709IU6o9QNXUS4TVw + serviceId: null + endpointId: null + boundaryScope: INBOUND + schema: + $ref: '#/components/schemas/SliConfiguration' + required: true + responses: + '200': + content: + application/json: + example: + id: 3J0RDgfyQz-P_hVzbNNb4A + sliName: test-application-sli + initialEvaluationTimestamp: 1732017600000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 555 + sliEntity: + sliType: application + applicationId: btg-B709IU6o9QNXUS4TVw + serviceId: null + endpointId: null + boundaryScope: INBOUND + lastUpdated: 1732017541059 + schema: + $ref: '#/components/schemas/SliConfigurationWithLastUpdated' + description: New SLI Configuration Created Successfully + '400': + content: + application/json: + example: '{"errors":["Unknown tag filter: call.eron"]}' + schema: + type: string + description: Bad Request + '422': + content: + application/json: + example: '{"errors":["sliEntity.entityId must not be blank"]}' + schema: + type: string + description: Unprocessable Entity + security: + - ApiKeyAuth: + - canConfigureServiceLevels + summary: Create SLI Config + tags: + - SLI Settings + x-description: createSliConfiguration + x-ibm-ahub-byok: true + /api/settings/v2/sli/{entityType}/{entityId}: + get: + operationId: getSliConfigsForEntityTypeAndIdV2 + parameters: + - description: Type of the Entity, whether it is an application or website + in: path + name: entityType + required: true + schema: + type: string + enum: + - APPLICATION + - WEBSITE + - description: Unique ID of the Entity + example: DkPX-x9VQuKBKopuilrkYw + in: path + name: entityId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: HXcNRWhDSWiZs3HiUAKr7g + sliName: turbo time 1 + initialEvaluationTimestamp: 1648133520000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 300.0 + sliEntity: + sliType: application + applicationId: 1qvXgVfLTNqi8gGTcCaNUw + serviceId: null + endpointId: null + boundaryScope: INBOUND + lastUpdated: 1648133508938 + schema: + type: array + items: + $ref: '#/components/schemas/SliConfigurationWithLastUpdated' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get all SLI configs for entity type and entity id + tags: + - SLI Settings + x-ibm-ahub-byok: true + /api/settings/v2/sli/{id}: + delete: + operationId: deleteSliConfigV2 + parameters: + - description: ID of the Service Level Indicator (SLI) + example: HXcNRWhDSWiZs3HiUAKr7g + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: SLI Configuration Deleted Successfully + security: + - ApiKeyAuth: + - canConfigureServiceLevels + summary: Delete SLI Config + tags: + - SLI Settings + x-ibm-ahub-byok: true + get: + operationId: getSliConfigV2 + parameters: + - description: ID of the Service Level Indicator (SLI) + example: HXcNRWhDSWiZs3HiUAKr7g + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + - id: HXcNRWhDSWiZs3HiUAKr7g + sliName: turbo time 1 + initialEvaluationTimestamp: 1648133520000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 300.0 + sliEntity: + sliType: application + applicationId: 1qvXgVfLTNqi8gGTcCaNUw + serviceId: null + endpointId: null + boundaryScope: INBOUND + lastUpdated: 1648133508938 + schema: + $ref: '#/components/schemas/SliConfigurationWithLastUpdated' + description: OK + '404': + content: + application/json: + example: + errors: + - The SLI Configuration you are looking for does not exist. + schema: + type: string + description: SLI Configuration Not Found + security: + - ApiKeyAuth: + - Default + summary: Get SLI Config + tags: + - SLI Settings + x-ibm-ahub-byok: true + /api/sli/report/{sliId}: + get: + operationId: getSli + parameters: + - description: ID of the Service Level Indicator (SLI) + example: nCtEoR6NSPqG61QkIkwwCw + in: path + name: sliId + required: true + schema: + type: string + - description: Target SLO + example: 0.99 + in: query + name: slo + required: true + schema: + type: number + format: double + - description: From Timestamp in milliseconds (13-digit) + example: 1706713140000 + in: query + name: from + required: true + schema: + type: integer + format: int64 + - description: To Timestamp in milliseconds (13-digit) + example: 1706713140000 + in: query + name: to + required: true + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + sli: 0.008228916434859497 + slo: 0.1 + totalErrorBudget: 10236633 + errorBudgetRemaining: -1043808 + fromTimestamp: 1707771600000 + toTimestamp: 1707858000000 + violationDistribution: null + schema: + type: array + items: + $ref: '#/components/schemas/SliReport' + description: OK + '404': + content: + application/json: + example: + errors: + - There is no SLI configuration for the given ID or the report hasn't + been generated yet. + schema: + type: array + items: + type: string + description: There is no SLI configuration for the given ID or the report + hasn't been generated yet. + security: + - ApiKeyAuth: + - Default + summary: 'Generate SLI report (Limitation: the Classic Edition API report can + be available one hour after the SLI configuration created; other editions + are around one minute.)' + tags: + - SLI Report + x-ibm-ahub-byok: true + /api/slo/correction: + get: + operationId: getSloCorrection + parameters: + - in: query + name: sloId + schema: + type: array + description: List of SLO IDs for which Correction Windows needs to be fetched + example: SLOdCTspkHlS_OzNOATQWgsuw + items: + type: string + description: List of SLO IDs for which Correction Windows needs to be + fetched + example: SLOdCTspkHlS_OzNOATQWgsuw + uniqueItems: true + - description: IDs of Correction Configurations to be Excluded from the result + example: N1Xj6q8QTZu_cfJOGqy4mg + in: query + name: excludeCorrectionId + schema: + type: array + items: + type: string + uniqueItems: true + - description: IDs of Correction Configurations to be Included in the result + example: uvP7Z03pSUuybDT8-WHLDA + in: query + name: includeCorrectionId + schema: + type: array + items: + type: string + uniqueItems: true + - in: query + name: tags + schema: + type: array + items: + type: string + uniqueItems: true + - description: Correction starting timestamp in milliseconds (13-digit) + example: 1706713140000 + in: query + name: from + required: true + schema: + type: integer + format: int64 + - description: Correction ending timestamp in milliseconds (13-digit) + example: 1706713140000 + in: query + name: to + required: true + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + from: 1750125600000 + to: 1750176418243 + correctionWindows: + - from: 1750165200000 + to: 1750176418243 + correctionConfigs: + - CpCe85NeQC2xOKXQluC30g + sloConfigs: + - SLOwfOpxuCJQjauS2IeHDUpAw + - from: 1750158000000 + to: 1750176418243 + correctionConfigs: + - p9kWax0uS7K2Who1WegsSg + sloConfigs: + - SLOffwtrVkfRmCjOZbdv3Ls9g + - from: 1750150800000 + to: 1750165200000 + correctionConfigs: + - uvP7Z03pSUuybDT8-WHLDA + sloConfigs: + - SLOukNGcoooQlev1z7aqONkIg + - from: 1750125600000 + to: 1750136400000 + correctionConfigs: + - S8rHrE93Rz2TXScTjBw1eg + sloConfigs: + - SLO4s-fs-GuT56c3v4KzQKBuQ + - from: 1750172400000 + to: 1750176418243 + correctionConfigs: + - 9Uf9TtvVRgOIMR0DkLB2Ng + sloConfigs: [ + ] + - from: 1750125600000 + to: 1750136400000 + correctionConfigs: + - 96MtLg5zRP-lmT4WOUE3Yg + sloConfigs: + - SLO4s-fs-GuT56c3v4KzQKBuQ + activeCorrectionConfigIds: + - S8rHrE93Rz2TXScTjBw1eg + - uvP7Z03pSUuybDT8-WHLDA + - CpCe85NeQC2xOKXQluC30g + - 9Uf9TtvVRgOIMR0DkLB2Ng + - 96MtLg5zRP-lmT4WOUE3Yg + - p9kWax0uS7K2Who1WegsSg + inActiveCorrectionConfigIds: + - nNMSbRwFQEKoQ1Wj0BCWcg + schema: + type: array + items: + $ref: '#/components/schemas/Correction' + description: Fetched SLO Correction Windows Successfully + '404': + content: + application/json: + example: + errors: + - There is No SLO Correction Windows or Error happened while trying + to fetch SLO Correction Windows. + schema: + type: array + items: + type: string + description: There is no SLO Correction Window + security: + - ApiKeyAuth: + - Default + summary: Generate SLO Correction Windows + tags: + - SLO Correction Windows + x-ibm-ahub-byok: true + /api/slo/report/{sloId}: + get: + operationId: getSlo + parameters: + - description: Service Levels Objective(SLO) Configuration ID + example: SLOEANnWh9tQOa2h88kGxK6wQ + in: path + name: sloId + required: true + schema: + type: string + - description: Starting point for the data retrieval, specified as 13 digit + Unix Timestamp milliseconds + example: 1706713140000 + in: query + name: from + schema: + type: string + - description: Ending point for the data retrieval, specified as 13 digit Unix + Timestamp milliseconds + example: 1706813100000 + in: query + name: to + schema: + type: string + - description: IDs of Correction Configurations to be Excluded from the result + example: N1Xj6q8QTZu_cfJOGqy4mg + in: query + name: excludeCorrectionId + schema: + type: array + items: + type: string + uniqueItems: true + - description: IDs of Correction Configurations to be Included in the result + example: uvP7Z03pSUuybDT8-WHLDA + in: query + name: includeCorrectionId + schema: + type: array + items: + type: string + uniqueItems: true + responses: + '200': + content: + application/json: + example: + sli: 1 + slo: 0.9999 + totalErrorBudget: 12 + errorBudgetRemaining: 12 + errorBudgetSpent: 0 + fromTimestamp: 1705081552605 + toTimestamp: 1705686352605 + violationDistribution: + '0': 0 + '1': 0 + '2': 0 + '3': 0 + '4': 0 + '5': 0 + '6': 0 + '7': 0 + '8': 0 + '9': 0 + '10': 0 + '11': 0 + '12': 0 + '13': 0 + '14': 0 + '15': 0 + '16': 0 + '17': 0 + '18': 0 + '19': 0 + '20': 0 + '21': 0 + '22': 0 + '23': 0 + '24': 0 + '25': 0 + '26': 0 + '27': 0 + '28': 0 + '29': 0 + '30': 0 + '31': 0 + '32': 0 + '33': 0 + '34': 0 + '35': 0 + '36': 0 + '37': 0 + '38': 0 + '39': 0 + '40': 0 + '41': 0 + '42': 0 + '43': 0 + '44': 0 + '45': 0 + '46': 0 + '47': 0 + '48': 0 + '49': 0 + '50': 0 + '51': 0 + '52': 0 + '53': 0 + '54': 0 + '55': 0 + '56': 0 + '57': 0 + '58': 0 + '59': 0 + '60': 0 + '61': 0 + '62': 0 + '63': 0 + '64': 0 + '65': 0 + '66': 0 + '67': 0 + '68': 0 + '69': 0 + '70': 0 + '71': 0 + '72': 0 + '73': 0 + '74': 0 + '75': 0 + '76': 0 + '77': 0 + '78': 0 + '79': 0 + '80': 0 + '81': 0 + '82': 0 + '83': 0 + '84': 0 + '85': 0 + '86': 0 + '87': 0 + '88': 0 + '89': 0 + '90': 0 + '91': 0 + '92': 0 + '93': 0 + '94': 0 + '95': 0 + '96': 0 + '97': 0 + '98': 0 + '99': 0 + '100': 0 + '101': 0 + '102': 0 + '103': 0 + '104': 0 + '105': 0 + '106': 0 + '107': 0 + '108': 0 + '109': 0 + '110': 0 + '111': 0 + '112': 0 + '113': 0 + '114': 0 + '115': 0 + '116': 0 + '117': 0 + '118': 0 + '119': 0 + '120': 0 + '121': 0 + '122': 0 + '123': 0 + '124': 0 + '125': 0 + '126': 0 + '127': 0 + '128': 0 + '129': 0 + '130': 0 + '131': 0 + '132': 0 + '133': 0 + '134': 0 + '135': 0 + '136': 0 + '137': 0 + '138': 0 + '139': 0 + '140': 0 + '141': 0 + '142': 0 + '143': 0 + '144': 0 + '145': 0 + '146': 0 + '147': 0 + '148': 0 + '149': 0 + '150': 0 + '151': 0 + '152': 0 + '153': 0 + '154': 0 + '155': 0 + '156': 0 + '157': 0 + '158': 0 + '159': 0 + '160': 0 + '161': 0 + '162': 0 + '163': 0 + '164': 0 + '165': 0 + '166': 0 + '167': 0 + errorChart: + '0': 0 + '1': 0 + '2': 0 + '3': 0 + '4': 0 + '5': 0 + '6': 0 + '7': 0 + '8': 0 + '9': 0 + '10': 0 + '11': 0 + '12': 0 + '13': 0 + '14': 0 + '15': 0 + '16': 0 + '17': 0 + '18': 0 + '19': 0 + '20': 0 + '21': 0 + '22': 0 + '23': 0 + '24': 0 + '25': 0 + '26': 0 + '27': 0 + '28': 0 + '29': 0 + '30': 0 + '31': 0 + '32': 0 + '33': 0 + '34': 0 + '35': 0 + '36': 0 + '37': 0 + '38': 0 + '39': 0 + '40': 0 + '41': 0 + '42': 0 + '43': 0 + '44': 0 + '45': 0 + '46': 0 + '47': 0 + '48': 0 + '49': 0 + '50': 0 + '51': 0 + '52': 0 + '53': 0 + '54': 0 + '55': 0 + '56': 0 + '57': 0 + '58': 0 + '59': 0 + '60': 0 + '61': 0 + '62': 0 + '63': 0 + '64': 0 + '65': 0 + '66': 0 + '67': 0 + '68': 0 + '69': 0 + '70': 0 + '71': 0 + '72': 0 + '73': 0 + '74': 0 + '75': 0 + '76': 0 + '77': 0 + '78': 0 + '79': 0 + '80': 0 + '81': 0 + '82': 0 + '83': 0 + '84': 0 + '85': 0 + '86': 0 + '87': 0 + '88': 0 + '89': 0 + '90': 0 + '91': 0 + '92': 0 + '93': 0 + '94': 0 + '95': 0 + '96': 0 + '97': 0 + '98': 0 + '99': 0 + '100': 0 + '101': 0 + '102': 0 + '103': 0 + '104': 0 + '105': 0 + '106': 0 + '107': 0 + '108': 0 + '109': 0 + '110': 0 + '111': 0 + '112': 0 + '113': 0 + '114': 0 + '115': 0 + '116': 0 + '117': 0 + '118': 0 + '119': 0 + '120': 0 + '121': 0 + '122': 0 + '123': 0 + '124': 0 + '125': 0 + '126': 0 + '127': 0 + '128': 0 + '129': 0 + '130': 0 + '131': 0 + '132': 0 + '133': 0 + '134': 0 + '135': 0 + '136': 0 + '137': 0 + '138': 0 + '139': 0 + '140': 0 + '141': 0 + '142': 0 + '143': 0 + '144': 0 + '145': 0 + '146': 0 + '147': 0 + '148': 0 + '149': 0 + '150': 0 + '151': 0 + '152': 0 + '153': 0 + '154': 0 + '155': 0 + '156': 0 + '157': 0 + '158': 0 + '159': 0 + '160': 0 + '161': 0 + '162': 0 + '163': 0 + '164': 0 + '165': 0 + '166': 0 + '167': 0 + errorAccumulationChart: + '0': 0 + '1': 0 + '2': 0 + '3': 0 + '4': 0 + '5': 0 + '6': 0 + '7': 0 + '8': 0 + '9': 0 + '10': 0 + '11': 0 + '12': 0 + '13': 0 + '14': 0 + '15': 0 + '16': 0 + '17': 0 + '18': 0 + '19': 0 + '20': 0 + '21': 0 + '22': 0 + '23': 0 + '24': 0 + '25': 0 + '26': 0 + '27': 0 + '28': 0 + '29': 0 + '30': 0 + '31': 0 + '32': 0 + '33': 0 + '34': 0 + '35': 0 + '36': 0 + '37': 0 + '38': 0 + '39': 0 + '40': 0 + '41': 0 + '42': 0 + '43': 0 + '44': 0 + '45': 0 + '46': 0 + '47': 0 + '48': 0 + '49': 0 + '50': 0 + '51': 0 + '52': 0 + '53': 0 + '54': 0 + '55': 0 + '56': 0 + '57': 0 + '58': 0 + '59': 0 + '60': 0 + '61': 0 + '62': 0 + '63': 0 + '64': 0 + '65': 0 + '66': 0 + '67': 0 + '68': 0 + '69': 0 + '70': 0 + '71': 0 + '72': 0 + '73': 0 + '74': 0 + '75': 0 + '76': 0 + '77': 0 + '78': 0 + '79': 0 + '80': 0 + '81': 0 + '82': 0 + '83': 0 + '84': 0 + '85': 0 + '86': 0 + '87': 0 + '88': 0 + '89': 0 + '90': 0 + '91': 0 + '92': 0 + '93': 0 + '94': 0 + '95': 0 + '96': 0 + '97': 0 + '98': 0 + '99': 0 + '100': 0 + '101': 0 + '102': 0 + '103': 0 + '104': 0 + '105': 0 + '106': 0 + '107': 0 + '108': 0 + '109': 0 + '110': 0 + '111': 0 + '112': 0 + '113': 0 + '114': 0 + '115': 0 + '116': 0 + '117': 0 + '118': 0 + '119': 0 + '120': 0 + '121': 0 + '122': 0 + '123': 0 + '124': 0 + '125': 0 + '126': 0 + '127': 0 + '128': 0 + '129': 0 + '130': 0 + '131': 0 + '132': 0 + '133': 0 + '134': 0 + '135': 0 + '136': 0 + '137': 0 + '138': 0 + '139': 0 + '140': 0 + '141': 0 + '142': 0 + '143': 0 + '144': 0 + '145': 0 + '146': 0 + '147': 0 + '148': 0 + '149': 0 + '150': 0 + '151': 0 + '152': 0 + '153': 0 + '154': 0 + '155': 0 + '156': 0 + '157': 0 + '158': 0 + '159': 0 + '160': 0 + '161': 0 + '162': 0 + '163': 0 + '164': 0 + '165': 0 + '166': 0 + '167': 0 + errorBudgetRemainChart: + '0': 0 + '1': 0 + '2': 0 + '3': 0 + '4': 0 + '5': 0 + '6': 0 + '7': 0 + '8': 0 + '9': 0 + '10': 1 + '11': 1 + '12': 1 + '13': 1 + '14': 1 + '15': 1 + '16': 1 + '17': 1 + '18': 1 + '19': 1 + '20': 1 + '21': 2 + '22': 2 + '23': 2 + '24': 2 + '25': 2 + '26': 2 + '27': 2 + '28': 2 + '29': 2 + '30': 2 + '31': 2 + '32': 2 + '33': 3 + '34': 3 + '35': 3 + '36': 3 + '37': 3 + '38': 3 + '39': 3 + '40': 3 + '41': 3 + '42': 3 + '43': 3 + '44': 4 + '45': 4 + '46': 4 + '47': 4 + '48': 4 + '49': 4 + '50': 4 + '51': 4 + '52': 4 + '53': 4 + '54': 4 + '55': 4 + '56': 5 + '57': 5 + '58': 5 + '59': 5 + '60': 5 + '61': 5 + '62': 5 + '63': 5 + '64': 5 + '65': 5 + '66': 5 + '67': 6 + '68': 6 + '69': 6 + '70': 6 + '71': 6 + '72': 6 + '73': 6 + '74': 6 + '75': 6 + '76': 6 + '77': 6 + '78': 6 + '79': 7 + '80': 7 + '81': 7 + '82': 7 + '83': 7 + '84': 7 + '85': 7 + '86': 7 + '87': 7 + '88': 7 + '89': 7 + '90': 7 + '91': 7 + '92': 7 + '93': 7 + '94': 7 + '95': 7 + '96': 7 + '97': 7 + '98': 7 + '99': 7 + '100': 7 + '101': 7 + '102': 7 + '103': 7 + '104': 7 + '105': 7 + '106': 7 + '107': 7 + '108': 7 + '109': 7 + '110': 7 + '111': 7 + '112': 7 + '113': 7 + '114': 7 + '115': 8 + '116': 8 + '117': 8 + '118': 8 + '119': 8 + '120': 8 + '121': 8 + '122': 8 + '123': 8 + '124': 8 + '125': 8 + '126': 8 + '127': 9 + '128': 9 + '129': 9 + '130': 9 + '131': 9 + '132': 9 + '133': 9 + '134': 9 + '135': 9 + '136': 9 + '137': 9 + '138': 10 + '139': 10 + '140': 10 + '141': 10 + '142': 10 + '143': 10 + '144': 10 + '145': 10 + '146': 10 + '147': 10 + '148': 10 + '149': 10 + '150': 11 + '151': 11 + '152': 11 + '153': 11 + '154': 11 + '155': 11 + '156': 11 + '157': 11 + '158': 11 + '159': 11 + '160': 11 + '161': 12 + '162': 12 + '163': 12 + '164': 12 + '165': 12 + '166': 12 + '167': 12 + schema: + type: array + items: + $ref: '#/components/schemas/SloReport' + description: Fetched SLO Configuration Report Successfully + '404': + content: + application/json: + example: + errors: + - There is no SLO configuration for the given ID or the report hasn't + been generated yet. + schema: + type: array + items: + type: string + description: There is no SLO configuration for the given ID or the report + hasn't been generated yet. + security: + - ApiKeyAuth: + - Default + summary: Generate Service Levels report + tags: + - Service Levels Objective(SLO) Report + x-ibm-ahub-byok: true + /api/synthetics/catalog: + get: + operationId: getSyntheticTagCatalog + parameters: + - in: query + name: useCase + required: true + schema: + type: string + enum: + - GROUPING + - FILTERING + - SERVICE_MAPPING + - SMART_ALERTS + - SMART_ALERTS_LOGS + - SMART_ALERTS_ADAPTIVE_BASELINE + - SMART_ALERTS_CUSTOM_PAYLOAD + - SLI_MANAGEMENT + - APPLICATION_CONFIG + - APPLICATION_CONFIG_BLUEPRINT + - MAINTENANCE_WINDOWS + - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + responses: + '200': + content: + application/json: + example: + tagTree: + - label: Commonly Used + description: null + icon: null + children: + - label: Location Label + tagName: synthetic.locationLabel + type: TAG + - label: Synthetic Type Label + tagName: synthetic.typeLabel + type: TAG + - label: Tags + tagName: synthetic.tags + type: TAG + type: LEVEL + queryable: false + - label: Application + description: null + icon: null + children: + - label: Application Id + tagName: synthetic.applicationId + type: TAG + type: LEVEL + queryable: false + - label: Synthetic Test + description: null + icon: null + children: + - label: Errors + tagName: synthetic.errors + type: TAG + - label: Synthetic Type + tagName: synthetic.syntheticType + type: TAG + - label: Synthetic Type Label + tagName: synthetic.typeLabel + type: TAG + - label: Tags + tagName: synthetic.tags + type: TAG + - label: Test Active + tagName: synthetic.testActive + type: TAG + - label: Test Id + tagName: synthetic.testId + type: TAG + - label: Test Name + tagName: synthetic.testName + type: TAG + type: LEVEL + queryable: false + - label: Location + description: null + icon: null + children: + - label: Location Id + tagName: synthetic.locationId + type: TAG + - label: Location Label + tagName: synthetic.locationLabel + type: TAG + - label: Location Type + tagName: synthetic.locationType + type: TAG + type: LEVEL + queryable: false + tags: + - name: synthetic.locationId + label: Location Id + type: STRING + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + - name: synthetic.locationLabel + label: Location Label + type: STRING + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + - name: synthetic.syntheticType + label: Synthetic Type + type: STRING + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + - name: synthetic.typeLabel + label: Synthetic Type Label + type: STRING + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + - name: synthetic.applicationId + label: Application Id + type: STRING + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + - name: synthetic.tags + label: Tags + type: KEY_VALUE_PAIR + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + - name: synthetic.testId + label: Test Id + type: STRING + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + - name: synthetic.testName + label: Test Name + type: STRING + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + - name: synthetic.errors + label: Errors + type: STRING_LIST + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + - name: synthetic.testActive + label: Test Active + type: BOOLEAN + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + - name: synthetic.locationType + label: Location Type + type: STRING + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + schema: + $ref: '#/components/schemas/TagCatalog' + description: OK + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get synthetic tag catalog + tags: + - Synthetic Catalog + x-description: getSyntheticTagCatalog + x-ibm-ahub-byok: true + /api/synthetics/catalog/metrics: + get: + description: API to get catalog of synthetic metrics. + operationId: getSyntheticCatalogMetrics + responses: + '200': + content: + application/json: + example: + - metricId: synthetic.metricResponseTime + label: Response Time + formatter: MILLIS + description: Script response time in milliseconds + aggregations: + - MEAN + - 25th + - 50th + - 75th + - 90th + - 95th + - 98th + - 99th + - SUM + defaultAggregation: null + schema: + type: array + items: + $ref: '#/components/schemas/MetricDescription' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get Metric catalog + tags: + - Synthetic Catalog + x-description: getSyntheticCatalogMetrics + x-ibm-ahub-byok: true + /api/synthetics/metrics: + post: + description: |- + API request to retrieve Synthetic Metrics. + For more information on Synthetic Metrics please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-metrics. + operationId: getMetricsResult + requestBody: + content: + application/json: + example: + pagination: + page: 1 + pageSize: 3 + metrics: + - metric: synthetic.metricsResponseTime + aggregation: SUM + timeFrame: + to: 0 + windowSize: 3600000 + groups: + - groupbyTag: synthetic.applicationId + - groupbyTag: synthetic.tags + groupbyTagSecondLevelTag: region + schema: + $ref: '#/components/schemas/GetMetricsResult' + x-payload: getMetricsResult + responses: + '200': + content: + application/json: + example: + metricsResult: + - tests: + - testId: 6GwdCuiMjGdMrtz8THjo + testName: rumattach-BasicNavTest + locationId: + - f7cEoG61DJfVyWcDnWsc + applicationId: application1 + serviceId: serviceId1 + metrics: + - synthetic.metricsResponseTime: 1276 + customMetrics: + - region: region1 + - tests: + - testId: OCnmrLSlNgzntI68094j + testName: test-javascript-bundled + locationId: + - wHICfVoIpiHbwawo5xQ6 + applicationId: application2 + serviceId: serviceId2 + metrics: + - synthetic.metricsResponseTime: 14 + customMetrics: + - location: location1 + region: region2 + - tests: + - testId: 9i6gpys6whaYtN5k9VeD + testName: My_Test_ReadFile + locationId: + - DemoPoP1_saas_instana_test + applicationId: application3 + serviceId: serviceid3 + metrics: + - synthetic.metricsResponseTime: 7 + customMetrics: + - location: location3 + region: region3 + page: 1 + pageSize: 3 + totalHits: 2212 + schema: + $ref: '#/components/schemas/MetricsResult' + description: OK + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get Synthetic Metrics + tags: + - Synthetic Metrics + x-ibm-ahub-byok: true + /api/synthetics/results: + post: + description: |- + Get a list of aggregated playback results metrics for Synthetic tests matching the specified parameters + For more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results. + operationId: getSyntheticResult + requestBody: + content: + application/json: + example: + pagination: + page: 1 + pageSize: 3 + metrics: + - metric: synthetic.metricsResponseTime + aggregation: SUM + order: + by: synthetic.startTime + direction: DESC + timeFrame: + to: 0 + windowSize: 144000000 + schema: + $ref: '#/components/schemas/GetTestResult' + x-payload: getSyntheticResults + responses: + '200': + content: + application/json: + example: + testResult: + - testId: 6GwdCuiMjGdMrtz8THjo + testName: rumattach-BasicNavTest + locationId: + - f7cEoG61DJfVyWcDnWsc + metrics: + - synthetic.metricsResponseTime: 1276 + - testId: OCnmrLSlNgzntI68094j + testName: test-javascript-bundled + locationId: + - wHICfVoIpiHbwawo5xQ6 + metrics: + - synthetic.metricsResponseTime: 14 + - testId: 9i6gpys6whaYtN5k9VeD + testName: My_Test_ReadFile + locationId: + - DemoPoP1_saas_instana_test + metrics: + - synthetic.metricsResponseTime: 7 + page: 1 + pageSize: 3 + totalHits: 2212 + schema: + $ref: '#/components/schemas/TestResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get Synthetic test playback results + tags: + - Synthetic Test Playback Results + x-ibm-ahub-byok: true + /api/synthetics/results/analytic: + post: + description: |- + Get a list of playback results metrics for Synthetic tests matching the specified parameters for the specified analytic + For more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results. + operationId: getSyntheticResultAnalytic + requestBody: + content: + application/json: + example: + pagination: + page: 1 + pageSize: 3 + syntheticMetrics: + - synthetic.metricsResponseTime + - status + - synthetic.errors + order: + by: start_time + direction: DESC + timeFrame: + to: 0 + windowSize: 144000000 + TagFilterExpression: + type: EXPRESSION + elements: + - type: EXPRESSION + elements: + - name: synthetic.errors + stringValue: Exception + operator: CONTAINS + logicalOperator: OR + logicalOperator: OR + analyticFunction: LAST_VALUE + schema: + $ref: '#/components/schemas/GetTestResultAnalytic' + x-payload: getSyntheticResultAnalytic + responses: + '200': + content: + application/json: + example: + items: + - testResultCommonProperties: + testId: 9i6gpys6whaYtN5k9VeD + testName: My_Test_ReadFile + locationId: DemoPoP1_saas_instana_test + clientId: saas_instana_test + id: 8f3bedbb-e278-4584-81b8-6efe07286a55 + errors: + - |- + {timeStamp=1706131087368, errorType=Exception, errorMessage=access to path /etc/pop/redispass/redis-password is denied, stackTrace=Error: access to path /etc/pop/redispass/redis-password is denied + at /opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1750914 + at Array.forEach () + at s (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1750876) + at Object.openSync (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1751693) + at VM Wrapper.apply (vm/bridge.js:468:15) + at /tmp/9i6gpys6whaYtN5k9VeD/script.js:7:13 + at /tmp/9i6gpys6whaYtN5k9VeD/script.js:21:3 + at VM Wrapper.apply (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1806330) + at k.run (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1771939) + at Object.e.exports.execute (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1739863) + at process. (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:2197562) + at Object.onceWrapper (node:events:628:26) + at process.emit (node:events:513:28) + at emit (node:internal/child_process:946:14) + at processTicksAndRejections (node:internal/process/task_queues:84:21)} + locationDisplayLabel: DemoPoP1(vm) + metrics: + response_time: + - - 1706131087358 + - 9 + status: + - - 1706131087358 + - 0 + - testResultCommonProperties: + testId: QRN50tqvJPnwKIjn2qKx + testName: Demo_IBM_simple_ping + locationId: DemoPoP1_saas_instana_test + clientId: saas_instana_test + id: 7f503812-c428-4ea8-995d-dbdf97c145b7 + errors: + - '{timeStamp=1706131070262, errorType=Exception, errorMessage=Ping: + http://httpbin.org/status/200%2C400 -> Expected a success status + (status < 400) but got 400, stackTrace=}' + locationDisplayLabel: DemoPoP1(vm) + metrics: + response_time: + - - 1706131070111 + - 149 + status: + - - 1706131070111 + - 0 + - testResultCommonProperties: + testId: mfwdxHpvwXM1PGUBAFeP + testName: test-disable-api-simple-jul17 + locationId: f7cEoG61DJfVyWcDnWsc + clientId: saas_instana_test + id: a1a4ed1c-7c87-45d5-bf45-3f3c462445d7 + errors: + - |- + {timeStamp=1706131069537, errorType=Exception, errorMessage=Unable to parse response body as JSON: Unexpected token < in JSON at position 0, stackTrace=Error: Unable to parse response body as JSON: Unexpected token < in JSON at position 0 + at /opt/ibm/microservice/javascript-playback/bin/index.js:2:1057667 + at k. (/opt/ibm/microservice/javascript-playback/bin/index.js:2:1058257) + at runMicrotasks () + at processTicksAndRejections (node:internal/process/task_queues:96:5)} + locationDisplayLabel: Test-Pop-101 + metrics: + response_time: + - - 1706131069036 + - 490 + status: + - - 1706131069036 + - 0 + page: 1 + pageSize: 3 + totalHits: 14305 + schema: + $ref: '#/components/schemas/TestResultListResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get a list of Synthetic tests based on the specified analytic function + tags: + - Synthetic Test Playback Results + x-ibm-ahub-byok: true + /api/synthetics/results/list: + post: + description: |- + Get a list of playback results metrics for Synthetic tests matching the specified parameters + For more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results. + operationId: getSyntheticResultList + requestBody: + content: + application/json: + example: + pagination: + page: 1 + pageSize: 3 + syntheticMetrics: + - synthetic.metricsResponseTime + - status + - synthetic.errors + order: + by: start_time + direction: DESC + timeFrame: + to: 0 + windowSize: 144000000 + TagFilterExpression: + type: EXPRESSION + elements: + - type: EXPRESSION + elements: + - name: synthetic.errors + stringValue: Exception + operator: CONTAINS + logicalOperator: OR + logicalOperator: OR + schema: + $ref: '#/components/schemas/GetTestResultList' + x-payload: getSyntheticResultList + responses: + '200': + content: + application/json: + example: + items: + - testResultCommonProperties: + testId: 9i6gpys6whaYtN5k9VeD + testName: My_Test_ReadFile + locationId: DemoPoP1_saas_instana_test + clientId: saas_instana_test + id: 8f3bedbb-e278-4584-81b8-6efe07286a55 + errors: + - |- + {timeStamp=1706131087368, errorType=Exception, errorMessage=access to path /etc/pop/redispass/redis-password is denied, stackTrace=Error: access to path /etc/pop/redispass/redis-password is denied + at /opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1750914 + at Array.forEach () + at s (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1750876) + at Object.openSync (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1751693) + at VM Wrapper.apply (vm/bridge.js:468:15) + at /tmp/9i6gpys6whaYtN5k9VeD/script.js:7:13 + at /tmp/9i6gpys6whaYtN5k9VeD/script.js:21:3 + at VM Wrapper.apply (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1806330) + at k.run (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1771939) + at Object.e.exports.execute (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:1739863) + at process. (/opt/ibm/microservice/javascript-playback/bin/vm/runner.bundle.js:2:2197562) + at Object.onceWrapper (node:events:628:26) + at process.emit (node:events:513:28) + at emit (node:internal/child_process:946:14) + at processTicksAndRejections (node:internal/process/task_queues:84:21)} + locationDisplayLabel: DemoPoP1(vm) + metrics: + response_time: + - - 1706131087358 + - 9 + status: + - - 1706131087358 + - 0 + - testResultCommonProperties: + testId: QRN50tqvJPnwKIjn2qKx + testName: Demo_IBM_simple_ping + locationId: DemoPoP1_saas_instana_test + clientId: saas_instana_test + id: 7f503812-c428-4ea8-995d-dbdf97c145b7 + errors: + - '{timeStamp=1706131070262, errorType=Exception, errorMessage=Ping: + http://httpbin.org/status/200%2C400 -> Expected a success status + (status < 400) but got 400, stackTrace=}' + locationDisplayLabel: DemoPoP1(vm) + metrics: + response_time: + - - 1706131070111 + - 149 + status: + - - 1706131070111 + - 0 + - testResultCommonProperties: + testId: mfwdxHpvwXM1PGUBAFeP + testName: test-disable-api-simple-jul17 + locationId: f7cEoG61DJfVyWcDnWsc + clientId: saas_instana_test + id: a1a4ed1c-7c87-45d5-bf45-3f3c462445d7 + errors: + - |- + {timeStamp=1706131069537, errorType=Exception, errorMessage=Unable to parse response body as JSON: Unexpected token < in JSON at position 0, stackTrace=Error: Unable to parse response body as JSON: Unexpected token < in JSON at position 0 + at /opt/ibm/microservice/javascript-playback/bin/index.js:2:1057667 + at k. (/opt/ibm/microservice/javascript-playback/bin/index.js:2:1058257) + at runMicrotasks () + at processTicksAndRejections (node:internal/process/task_queues:96:5)} + locationDisplayLabel: Test-Pop-101 + metrics: + response_time: + - - 1706131069036 + - 490 + status: + - - 1706131069036 + - 0 + page: 1 + pageSize: 3 + totalHits: 14305 + schema: + $ref: '#/components/schemas/TestResultListResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get a list of Synthetic test playback results + tags: + - Synthetic Test Playback Results + x-ibm-ahub-byok: true + /api/synthetics/results/locationsummarylist: + post: + description: |- + Get summary information for Synthetic locations matching the specified parameters + For more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results. + operationId: getLocationSummaryList + requestBody: + content: + application/json: + example: + timeFrame: + to: null + windowSize: 300000 + pagination: + page: 1 + pageSize: 3 + schema: + $ref: '#/components/schemas/GetTestResultBase' + x-payload: getLocationSummaryList + responses: + '200': + content: + application/json: + example: + items: + - id: wFulJMRXA3bZgAlhCuZV + label: test101-pop + displayLabel: west-12(Idaho) + type: Private + status: Online + linkedTests: 0 + lastRunOn: 0 + namespace: my-kedatest + clusterName: test101-pop + description: PoP in region test101 for my-kedatest + popSnapshotId: null + popVersion: 1.1.2 + - id: 0po5d5MxSZx91moqCbri + label: apminstana-pop + displayLabel: apminstana-pop + type: Private + status: Online + linkedTests: 12 + lastRunOn: 0 + namespace: redwood + clusterName: apminstana-pop + description: This is a Synthetic Point of Presence + popSnapshotId: ZFOBIU_Stg9FWs4DMRVY7VTSmBs + entityHealthInfo: + maxSeverity: 0 + openIssues: [ + ] + popVersion: 1.1.1 + - id: c7sXV7jZcuiD2ewGAjYI + label: Aggie + displayLabel: Aggie popLoc + type: Private + status: Offline + linkedTests: 9 + lastRunOn: 0 + namespace: poploc + clusterName: instana-pop-deployment + description: My City Kubecost + popSnapshotId: null + popVersion: 1.0.15 + page: 1 + pageSize: 3 + totalHits: 47 + schema: + $ref: '#/components/schemas/TestResultListResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get a list of Synthetic locations with last run test on each location + data + tags: + - Synthetic Test Playback Results + x-ibm-ahub-byok: true + /api/synthetics/results/testsummarylist: + post: + description: |- + Get a summary of the playback results metrics and success rate for Synthetic tests matching the specified parameters + For more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results. + operationId: getTestSummaryList + requestBody: + content: + application/json: + example: + metrics: + - aggregation: MEAN + metric: success_rate + granularity: 600 + TagFilterExpression: + type: EXPRESSION + elements: + - name: synthetic.testActive + booleanValue: true + operator: EQUALS + logicalOperator: AND + timeFrame: + to: 0 + windowSize: 1800000 + pagination: + page: 1 + pageSize: 3 + schema: + $ref: '#/components/schemas/GetTestSummaryResult' + x-payload: getTestSummaryList + responses: + '200': + content: + application/json: + example: + items: + - testResultCommonProperties: + testId: 0FzZz41QwOxPjOUE0VhU + testName: 260-browserwebpage + clientId: saas_instana_test + testCommonProperties: + id: 0FzZz41QwOxPjOUE0VhU + label: 260-browserwebpage + type: Webpage Simple + frequency: 3 + active: true + locationIds: + - KHphVmZqqRf9Kp2xSoud + - cs1RvxTXJcavxnbQ6fBE + locationLabels: + - microk8s_PoP + - mini_PoP2_BrowserTest + locationDisplayLabels: + - MicroK8s PoP + - mini_PoP2_BrowserTest + locationStatusList: + - locationId: KHphVmZqqRf9Kp2xSoud + totalTestRuns: 10 + successRuns: 10 + locationDisplayLabel: MicroK8s PoP + successRate: 1 + - locationId: cs1RvxTXJcavxnbQ6fBE + totalTestRuns: 0 + successRuns: 0 + locationDisplayLabel: mini_PoP2_BrowserTest + successRate: 0 + createdAt: 1697175933150 + modifiedAt: 1700456221719 + metrics: + total_test_runs: + - - 1706132249095 + - 10 + successful_test_runs: + - - 1706132249095 + - 10 + response_time: + - - 1706132249095 + - 372.9 + success_rate: + - - 1706132249095 + - 1 + - testResultCommonProperties: + testId: 0OKldV7M44UfDxmNt1Ef + testName: Syne2eHttpActionTest + clientId: saas_instana_test + testCommonProperties: + id: 0OKldV7M44UfDxmNt1Ef + label: Syne2eHttpActionTest + type: API Simple + frequency: 5 + active: true + locationIds: + - 18WyhtDb5jpVOsjlNdeV + locationLabels: + - Syne2e + locationDisplayLabels: + - E2ETest PoP + locationStatusList: + - locationId: 18WyhtDb5jpVOsjlNdeV + totalTestRuns: 6 + successRuns: 6 + locationDisplayLabel: E2ETest PoP + successRate: 1 + createdAt: 1703867554340 + modifiedAt: 1703867554340 + metrics: + total_test_runs: + - - 1706132249095 + - 6 + successful_test_runs: + - - 1706132249095 + - 6 + response_time: + - - 1706132249095 + - 157.5 + success_rate: + - - 1706132249095 + - 1 + - testResultCommonProperties: + testId: 0qB3qb9659JBJ86bflnf + testName: Syne2eHttpActionTest + clientId: saas_instana_test + testCommonProperties: + id: 0qB3qb9659JBJ86bflnf + label: Syne2eHttpActionTest + type: API Simple + frequency: 5 + active: true + locationIds: + - 18WyhtDb5jpVOsjlNdeV + locationLabels: + - Syne2e + locationDisplayLabels: + - E2ETest PoP + locationStatusList: + - locationId: 18WyhtDb5jpVOsjlNdeV + totalTestRuns: 6 + successRuns: 6 + locationDisplayLabel: E2ETest PoP + successRate: 1 + createdAt: 1702269153825 + modifiedAt: 1702269153825 + metrics: + total_test_runs: + - - 1706132249095 + - 6 + successful_test_runs: + - - 1706132249095 + - 6 + response_time: + - - 1706132249095 + - 178.66666666666666 + success_rate: + - - 1706132249095 + - 1 + page: 1 + pageSize: 3 + totalHits: 567 + schema: + $ref: '#/components/schemas/TestResultListResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get a list of Synthetic tests with success rate and average response + time data + tags: + - Synthetic Test Playback Results + x-ibm-ahub-byok: true + /api/synthetics/results/{testid}/{testresultid}: + get: + description: |- + Gets the list of detailed data file names associated to a Synthetic playback result + For more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results. + operationId: getSyntheticResultMetadata + parameters: + - description: Test id of the test result detailed description to be retrieved + example: AMl0Y7tsvpp8XXrXt1XO + in: path + name: testid + required: true + schema: + type: string + - description: Test result id of the test result detailed description to be + retrieved + example: 5623c161-31d6-49b8-b314-91d4fb598f55 + in: path + name: testresultid + required: true + schema: + type: string + - description: Start time of the test result detailed description + example: 1730295066008 + in: query + name: startTime + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + testId: AMl0Y7tsvpp8XXrXt1XO + testResultId: 5623c161-31d6-49b8-b314-91d4fb598f55 + startTime: 1730295066008 + metadata: + logs.tgz: + - console.log + schema: + $ref: '#/components/schemas/TestResultMetadata' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get Synthetic test playback detail result description(metadata) + tags: + - Synthetic Test Playback Results + x-ibm-ahub-byok: true + /api/synthetics/results/{testid}/{testresultid}/detail: + get: + description: |- + Download the contents of the Synthetic the playback result detail data file matching the specified file type + For more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results. + operationId: getSyntheticResultDetailData + parameters: + - description: Test id of the test result detailed file contents to be retrieved + example: AMl0Y7tsvpp8XXrXt1XO + in: path + name: testid + required: true + schema: + type: string + - description: Test result id of the test result detailed file to be retrieved + example: 5623c161-31d6-49b8-b314-91d4fb598f55 + in: path + name: testresultid + required: true + schema: + type: string + - description: Type of the test result detailed file contents + example: LOGS + in: query + name: type + required: true + schema: + type: string + enum: + - HAR + - LOGS + - SUBTRANSACTIONS + - description: Name of the test result detailed file, if more than one file + available for the same type. Can be used when parameter type=LOGS + example: console.log + in: query + name: name + schema: + type: string + - description: Start time of the test result detailed file contents + example: 1730295066008 + in: query + name: startTime + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + testId: AMl0Y7tsvpp8XXrXt1XO + testResultId: 5623c161-31d6-49b8-b314-91d4fb598f55 + logs: | + 2024-01-18T19:55:02.162Z [SyntheticPoP] synthetic playback starts + 2024-01-18T19:55:02.169Z [SyntheticPoP] http request undefined https://www.ibm.com/ + 2024-01-18T19:55:02.319Z [SyntheticPoP] http response 303 for https://www.ibm.com/ + 2024-01-18T19:55:02.430Z [SyntheticPoP] http response 200 for https://www.ibm.com/us-en + 2024-01-18T19:55:02.478Z http request 1/2: 200 + 2024-01-18T19:56:01.103Z [SyntheticPoP] synthetic playback ends + logFiles: + console.log: | + 2024-01-18T19:55:02.162Z [SyntheticPoP] synthetic playback starts + 2024-01-18T19:55:02.169Z [SyntheticPoP] http request undefined https://www.ibm.com/ + 2024-01-18T19:55:02.319Z [SyntheticPoP] http response 303 for https://www.ibm.com/ + 2024-01-18T19:55:02.430Z [SyntheticPoP] http response 200 for https://www.ibm.com/us-en + 2024-01-18T19:55:02.478Z http request 1/2: 200 + 2024-01-18T19:56:01.103Z [SyntheticPoP] synthetic playback ends + schema: + $ref: '#/components/schemas/TestResultDetailData' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get Synthetic test playback result detail data + tags: + - Synthetic Test Playback Results + x-ibm-ahub-byok: true + /api/synthetics/results/{testid}/{testresultid}/file: + get: + description: |- + Download a Synthetic the playback result detail data file matching the specified file type + For more information on Synthetic Test Playback Results please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-test-playback-results. + operationId: getSyntheticResultDetailDataFile + parameters: + - description: Test id of the test result detailed file to be retrieved + example: AMl0Y7tsvpp8XXrXt1XO + in: path + name: testid + required: true + schema: + type: string + - description: Test result id of the test result detailed file to be retrieved + example: 5623c161-31d6-49b8-b314-91d4fb598f55 + in: path + name: testresultid + required: true + schema: + type: string + - description: Type of the test result detailed file + example: LOGS + in: query + name: type + required: true + schema: + type: string + enum: + - HAR + - IMAGES + - LOGS + - SUBTRANSACTIONS + - VIDEOS + - description: Start time of the test result detailed file + example: 1730295066008 + in: query + name: startTime + schema: + type: integer + format: int64 + responses: + '200': + content: + application/octet-stream: { + } + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Download the synthetic test playback result detail data file + tags: + - Synthetic Test Playback Results + x-description: getSyntheticResultDetailDataFile + x-ibm-ahub-byok: true + /api/synthetics/settings/credentials: + get: + description: |- + API request to retrieve the names of all Synthetic Credentials. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: getSyntheticCredentialNames + responses: + '200': + content: + application/json: + example: + - kittyhawk_test2 + - user1_password + - user1_name + - MyBearer + - MY_CREDS333 + - Test_Creds + - credName5 + - credName4 + - credName3 + - credName2 + - credName1 + - MY_CREDS1 + - MY_PASS + - USER_NAME_TEST + schema: + type: array + items: + type: string + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canUseSyntheticCredentials + - canConfigureSyntheticTests + summary: All Synthetic credential names + tags: + - Synthetic Settings + x-ibm-ahub-byok: true + post: + description: |- + API request to create a Synthetic Credential. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: createSyntheticCredential + requestBody: + content: + application/json: + example: + credentialName: userPassword + credentialValue: '123456' + rbacTags: + - id: test + displayName: test + schema: + $ref: '#/components/schemas/SyntheticCredential' + required: true + responses: + '200': + content: + application/json: { + } + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticCredentials + summary: Create a Synthetic credential + tags: + - Synthetic Settings + x-payload: createSyntheticCredential + x-ibm-ahub-byok: true + /api/synthetics/settings/credentials/associations: + get: + description: |- + API request to retrieve all Synthetic Credentials. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: getSyntheticCredentialAssociations + responses: + '200': + content: + application/json: + example: + - credentialName: password1 + createdAt: 1717617206785 + modifiedAt: 1717617206785 + - credentialName: password2 + applications: + - f4KX5zd8RW2pERKKFUCZgQ + applicationLabels: + - All Services + createdAt: 1717620972843 + modifiedAt: 1717620972843 + schema: + type: array + items: + $ref: '#/components/schemas/SyntheticCredential' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canUseSyntheticCredentials + - canConfigureSyntheticTests + summary: All Synthetic credentials + tags: + - Synthetic Settings + x-ibm-ahub-byok: true + /api/synthetics/settings/credentials/associations/{name}: + get: + description: |- + API request to retrieve a Synthetic Credential with matching name. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: getOneSyntheticCredentialAssociations + parameters: + - description: Name of the credential to be retrieved + example: password4test + in: path + name: name + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + credentialName: password4test + applications: + - f4KX5zd8RW2pERKKFUCZgQ + applicationLabels: + - All Services + createdAt: 1717620972843 + modifiedAt: 1717620972843 + schema: + $ref: '#/components/schemas/SyntheticCredential' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canUseSyntheticCredentials + - canConfigureSyntheticTests + summary: A Synthetic credential + tags: + - Synthetic Settings + x-ibm-ahub-byok: true + /api/synthetics/settings/credentials/{name}: + delete: + description: |- + API request to delete a Synthetic Credential. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: deleteSyntheticCredential + parameters: + - description: Name of the credential to be deleted + example: password4test + in: path + name: name + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticCredentials + summary: Delete a Synthetic credential + tags: + - Synthetic Settings + x-ibm-ahub-byok: true + patch: + description: |- + API request to patch attributes of a Synthetic Credential. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: patchSyntheticCredential + parameters: + - description: Name of the credential to be patched + example: password4test + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + credentialValue: password4test + applications: + - f4KX5zd8RW2pERKKFUCZgQ + rbacTags: + - id: test + displayName: test + schema: + $ref: '#/components/schemas/SyntheticCredential' + required: true + responses: + '200': + content: + application/json: { + } + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canUseSyntheticCredentials + - canConfigureSyntheticTests + summary: Patch a Synthetic credential + tags: + - Synthetic Settings + x-description: patchSyntheticCredential + x-ibm-ahub-byok: true + put: + description: |- + API request to update a Synthetic Credential. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: updateSyntheticCredential + parameters: + - description: Name of the credential to be updated + example: password4db2 + in: path + name: name + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + credentialName: password4db2 + credentialValue: '123456' + applications: + - f4KX5zd8RW2pERKKFUCZgQ + rbacTags: + - id: test + displayName: test + schema: + $ref: '#/components/schemas/SyntheticCredential' + required: true + responses: + '201': + content: + application/json: { + } + description: Successful - resource created + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticCredentials + summary: Update a Synthetic credential + tags: + - Synthetic Settings + x-payload: updateSyntheticCredential + x-ibm-ahub-byok: true + /api/synthetics/settings/datacenters: + get: + description: |- + API request to retrieve all Synthetic Datacenters. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: getSyntheticDatacenters + responses: + '200': + content: + application/json: + example: + - code: us-east-1 + label: us-east-1(NVirginia) + provider: aws + countryName: USA + cityName: NVirginia + latitude: 37.22 + longitude: -81.44 + status: Active + modifiedAt: 1728096600396 + configuration: + ipAddresses: + - 34.226.13.189 + locationLabel: instana-test-aws-us-east-1-NVirginia + datacenterId: aws-us-east-1-NVirginia + - code: eu-central-1 + label: eu-central-1(Frankfurt) + provider: aws + countryName: DEU + cityName: Frankfurt + latitude: 50.11 + longitude: 8.68 + status: Active + modifiedAt: 1710241599981 + configuration: + ipAddresses: + - 3.122.151.177 + locationLabel: instana-test-aws-eu-central-1-Frankfurt + datacenterId: aws-eu-central-1-Frankfurt + schema: + type: array + items: + $ref: '#/components/schemas/SyntheticDatacenter' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticLocations + summary: All Synthetic datacenters + tags: + - Synthetic Settings + x-ibm-ahub-byok: true + /api/synthetics/settings/datacenters/{datacenterId}: + get: + description: |- + API request to retrieve a Synthetic Datacenter with matching id. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: getSyntheticDatacenter + parameters: + - description: Id of the datacenter to be retrieved + example: aws-us-east-1-NVirginia + in: path + name: datacenterId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + code: us-east-1 + label: us-east-1(NVirginia) + provider: aws + countryName: USA + cityName: NVirginia + latitude: 37.22 + longitude: -81.44 + status: Active + modifiedAt: 1728096600396 + configuration: + ipAddresses: + - 34.226.13.189 + locationLabel: instana-test-aws-us-east-1-NVirginia + datacenterId: aws-us-east-1-NVirginia + schema: + $ref: '#/components/schemas/SyntheticDatacenter' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticLocations + summary: A Synthetic datacenter + tags: + - Synthetic Settings + x-ibm-ahub-byok: true + /api/synthetics/settings/locations: + get: + description: |- + API request to retrieve Synthetic Locations. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: getSyntheticLocations + parameters: + - description: Defines the attribute by which the returned synthetic locations + will be ordered by. Order using '+' means ASC and '-' means DESC + example: +label + in: query + name: sort + schema: + type: string + pattern: ' <+|->' + - description: Used in conjunction with limit. Defines how many pages will be + skipped before returning the synthetic locations + example: 1 + in: query + name: offset + schema: + type: integer + format: int64 + - description: Defines the size of a page - the number of synthetic locations + that will be returned by the query + example: 10 + in: query + name: limit + schema: + type: integer + format: int64 + - description: Defines the attributes by which the returned synthetic locations + will be filtered by. Multiple filter parameters are allowed. See 'Supported + filter attributes and operators' for complete list of supported attributes + and operators. + example: '{locationType=Managed}' + in: query + name: filter + schema: + type: string + pattern: ' {}' + responses: + '200': + content: + application/json: + example: + - id: 55bzhnXQ9uqwld4Ha3bD + label: Austin + displayLabel: AUTO + popVersion: 1.1.2 + description: My Location 101 + locationType: Private + playbackCapabilities: + syntheticType: + - HTTPAction + - HTTPScript + - BrowserScript + - WebpageScript + browserType: + - firefox + - chrome + geoPoint: + cityName: austin + countryName: india + latitude: 0 + longitude: 0 + totalTests: 1 + configuration: + namespace: syn-pop-tls + customProperties: { + } + createdAt: 1698742890784 + modifiedAt: 1702372728619 + observedAt: 1704266105229 + status: Offline + - id: OjJPXWHmsE9deLzanNAW + label: Dallas + displayLabel: AUTOscaling + popVersion: 1.1.1 + description: My Location 101 + locationType: Private + playbackCapabilities: + syntheticType: + - HTTPAction + - HTTPScript + - BrowserScript + - WebpageScript + browserType: + - firefox + - chrome + geoPoint: + cityName: dallas + countryName: india + latitude: 0 + longitude: 0 + totalTests: 0 + configuration: + namespace: andy + customProperties: { + } + createdAt: 1698988890723 + modifiedAt: 1700116951600 + observedAt: 1705556766316 + status: Offline + schema: + type: array + items: + $ref: '#/components/schemas/SyntheticLocation' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canViewSyntheticLocations + summary: All Synthetic locations + tags: + - Synthetic Settings + x-description: getSyntheticLocations + x-ibm-ahub-byok: true + /api/synthetics/settings/locations/{id}: + delete: + description: |- + API request to delete a Synthetic Location with matching id. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: deleteSyntheticLocation + parameters: + - description: Identifier of the location to be deleted + example: 55bzhnXQ9uqwld4Ha3bD + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticLocations + summary: Delete a Synthetic location + tags: + - Synthetic Settings + x-description: deleteSyntheticLocation + x-ibm-ahub-byok: true + get: + description: |- + API request to retrieve a Synthetic Location with matching id. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: getSyntheticLocation + parameters: + - description: Identifier of the location to be retrieved + example: OjJPXWHmsE9deLzanNAW + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: OjJPXWHmsE9deLzanNAW + label: Austin + displayLabel: AUTOscaling + popVersion: 1.1.1 + description: Test Location 101 + locationType: Private + playbackCapabilities: + syntheticType: + - HTTPAction + - HTTPScript + - BrowserScript + - WebpageScript + browserType: + - firefox + - chrome + geoPoint: + cityName: austin + countryName: india + latitude: 0 + longitude: 0 + totalTests: 0 + configuration: + namespace: andy + customProperties: { + } + createdAt: 1698988890723 + modifiedAt: 1700116951600 + observedAt: 1705556766316 + status: Offline + schema: + $ref: '#/components/schemas/SyntheticLocation' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canViewSyntheticLocations + summary: A Synthetic location + tags: + - Synthetic Settings + x-ibm-ahub-byok: true + /api/synthetics/settings/tests: + get: + description: |- + API request to retrieve Synthetic Tests. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: getSyntheticTests + parameters: + - description: 'Defines the application id by which the returned synthetic tests + will be filtered by. ' + example: pWoK4onRRN-POTz1RU62UQ + in: query + name: applicationId + schema: + type: string + - description: 'Defines the location id by which the returned synthetic tests + will be filtered by. ' + example: 18WyhtDb5jpVOsjlNdeV + in: query + name: locationId + schema: + type: string + - description: 'Defines the credential name by which the returned synthetic + tests will be filtered by. ' + example: adminPassword + in: query + name: credentialName + schema: + type: string + - description: Defines the attribute by which the returned synthetic tests will + be ordered by. Order using '+' means ASC and '-' means DESC + example: +label + in: query + name: sort + schema: + type: string + pattern: ' <+|->' + - description: Used in conjunction with limit. Defines how many pages will be + skipped before returning the synthetic tests + example: 1 + in: query + name: offset + schema: + type: integer + format: int64 + - description: Defines the size of a page - the number of synthetic tests that + will be returned by the query + example: 10 + in: query + name: limit + schema: + type: integer + format: int64 + - description: Defines the attributes by which the returned synthetic tests + will be filtered by. Multiple filter parameters are allowed. See 'Supported + filter attributes and operators' for complete list of supported attributes + and operators. + example: '{label=MyTest}' + in: query + name: filter + schema: + type: string + pattern: ' {}' + responses: + '200': + content: + application/json: + example: + - id: ic25Vt1T5dgKzi0K7812 + tenantId: saas_instana_test + label: 260-api-feature + active: true + testFrequency: 10 + playbackMode: Simultaneous + applicationId: UOGJ3jBOSMOgN2EBCoOghw + applicationLabel: test_cb + locations: + - KHphVmZqqRf9Kp2xSoud + - cs1RvxTXJcavxnbQ6fBE + locationLabels: + - microk8s_PoP + - mini_PoP2_BrowserTest + locationDisplayLabels: + - MicroK8s PoP + - mini_PoP2_BrowserTest + configuration: + syntheticType: HTTPScript + markSyntheticCall: true + retries: 1 + retryInterval: 1 + timeout: '' + script: "const assert = require('assert');\n\n$got('https://www.ibm.com').then(response=>{\n\ + \ console.log('request 1/2:', response.statusCode);\n assert.equal(response.statusCode,\ + \ 200, 'it should be 200')\n \n setTimeout(()=>{\n \ + \ $got('https://www.bing.com').then(response=>{\n \ + \ console.log('request 2/2:', response.statusCode);\n \ + \ assert.equal(response.statusCode, 200, 'it should be 200')\n\ + \ })\n\n }, 70000);\n});" + scriptType: Basic + customProperties: { + } + createdAt: 1697175907759 + modifiedAt: 1705915155144 + - id: EFNRoPd39SgZBkULeQIf + tenantId: saas_instana_test + label: APITest_getApplication + active: true + testFrequency: 15 + playbackMode: Simultaneous + applicationId: UOGJ3jBOSMOgN2EBCoOghw + applicationLabel: test_cb + locations: + - 18WyhtDb5jpVOsjlNdeV + locationLabels: + - Syne2e + locationDisplayLabels: + - E2ETest PoP + configuration: + syntheticType: HTTPScript + markSyntheticCall: true + retries: 2 + retryInterval: 1 + timeout: 10m + script: |- + const got = require('got'); + const assert = require('assert'); + + // Define the API request configuration + const apiConfig = { + method: 'GET', + url: 'https://test-instana.pink.instana.rocks/api/application-monitoring/settings/application/btg-B701Rx6o9QNXUS4TVw', + headers: { + 'Authorization': $secure.apiToken + } + }; + + // Function to perform the API test + const performAPITest = async () => { + const response = await got(apiConfig); + console.info("Get one application API - GET, response code: " + response.statusCode); + assert.ok(response.statusCode == 200, "GET status is " + response.statusCode + ", it should be 200"); + + const jsonBody = JSON.parse(response.body); + assert.ok(jsonBody.id != "", "Application ID is not in the payload"); + assert.ok(jsonBody.label != "", "Application label is not in the payload"); + assert.ok(jsonBody.tagFilterExpression != null, "tagFilterExpression is not in the payload"); + }; + + // Initial test + performAPITest(); + scriptType: Basic + customProperties: + test: '123' + createdAt: 1696625954210 + modifiedAt: 1701216106812 + modifiedBy: Internal + rbacTags: + - id: test + displayName: test + schema: + type: array + items: + $ref: '#/components/schemas/SyntheticTest' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canViewSyntheticTests + summary: All Synthetic tests + tags: + - Synthetic Settings + x-description: getSyntheticTests + x-ibm-ahub-byok: true + post: + description: |- + API request to create a Synthetic Test. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: createSyntheticTest + requestBody: + content: + application/json: + example: + label: Test_SimplePing + description: this is to test a simple ping API + applicationId: applicationId001 + active: true + testFrequency: 1 + playbackMode: Simultaneous + locations: + - saas_instana_test + configuration: + syntheticType: HTTPAction + url: https://httpbin.org/post + operation: POST + headers: + Content-Type: text/plain + body: Hello World! + validationString: Hello World! + customProperties: + Team: DevTeam + Purpose: Demo + rbacTags: + - id: test + displayName: test + schema: + $ref: '#/components/schemas/SyntheticTest' + required: true + x-payload: createSyntheticTest + responses: + '201': + content: + application/json: + example: + id: ic25Vt1T5dgKzi0K7812 + label: Test_SimplePing + description: this is to test a simple ping API + applicationId: applicationId001 + active: true + testFrequency: 1 + playbackMode: Simultaneous + locations: + - saas_instana_test + configuration: + syntheticType: HTTPAction + url: https://httpbin.org/post + operation: POST + headers: + Content-Type: text/plain + body: Hello World! + validationString: Hello World! + customProperties: + Team: DevTeam + Purpose: Demo + rbacTags: + - id: test + displayName: test + schema: + $ref: '#/components/schemas/SyntheticTest' + description: Successful - resource created + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticTests + summary: Create a Synthetic test + tags: + - Synthetic Settings + x-description: createSyntheticTest + x-ibm-ahub-byok: true + /api/synthetics/settings/tests/bulk-delete: + post: + description: API request to delete a list of Synthetic Tests. + operationId: bulkDeleteSyntheticTests + requestBody: + content: + application/json: + example: + - ic25Vt1T5dgKzi0K7812 + - EFNRoPd39SgZBkULeQIf + - kaj02pbxbW0XmQP9qu4b + - FrhxAJzKdsXU6V4WxWrY + schema: + type: array + items: + type: string + required: true + x-payload: bulkDeleteSyntheticTests + responses: + '200': + content: + application/json: + example: + - id: ic25Vt1T5dgKzi0K7812 + status: 200 - Success + - id: EFNRoPd39SgZBkULeQIf + status: 404 - Not Found + - id: kaj02pbxbW0XmQP9qu4b + status: 401 - Forbidden + - id: FrhxAJzKdsXU6V4WxWrY + status: 500 - Internal Server Error + schema: + type: array + items: + $ref: '#/components/schemas/SyntheticBulkResponse' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticTests + summary: Delete Synthetic tests + tags: + - Synthetic Settings + x-ibm-ahub-byok: true + /api/synthetics/settings/tests/bulk-update: + post: + description: API request to update a list of Synthetic Tests. + operationId: bulkUpdateSyntheticTests + requestBody: + content: + application/json: + example: | + { + "ids" : [ + "ic25Vt1T5dgKzi0K7812", + "EFNRoPd39SgZBkULeQIf", + "kaj02pbxbW0XmQP9qu4b", + "FrhxAJzKdsXU6V4WxWrY" + ], + "locations": { + "add": [ "hGyJAQCTnMbpmWrYfbq6", "RMtD8XkRHmxG5N0IT418" ], + "remove": ["AOsPYuhGjpFHpNgWub90"], + }, + "applications": { + "add": [ "XRVRqG3zLNDKlJUho90j" ] + }, + "configuration": { + "timeout": "1s" + }, + "customProperties": { + "add": { + "property1": "Test" + }, + "remove": ["property2", "property3"], + } + { + schema: + $ref: '#/components/schemas/SyntheticTestUpdate' + required: true + x-payload: bulkUpdateSyntheticTests + responses: + '200': + content: + application/json: + example: + - id: ic25Vt1T5dgKzi0K7812 + status: 200 - Success + - id: EFNRoPd39SgZBkULeQIf + status: 404 - Not Found + - id: kaj02pbxbW0XmQP9qu4b + status: 401 - Forbidden + - id: FrhxAJzKdsXU6V4WxWrY + status: 500 - Internal Server Error + schema: + type: array + items: + $ref: '#/components/schemas/SyntheticBulkResponse' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticTests + summary: Update Synthetic tests + tags: + - Synthetic Settings + x-ibm-ahub-byok: true + /api/synthetics/settings/tests/ci-cd: + get: + description: |- + API request to retrieve the Synthetic Test CI/CDs + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: getSyntheticTestCICDs + parameters: + - description: Defines the attributes by which the returned synthetic test CI/CDs + will be filtered by. Multiple filter parameters are allowed. See 'Supported + filter attributes and operators' for complete list of supported attributes + and operators. + example: '{runType=OnDemand}' + in: query + name: filter + schema: + type: string + pattern: ' {}' + - description: Used in conjunction with limit. Defines how many pages will be + skipped before returning the synthetic test CI/CDs + example: 1 + in: query + name: offset + schema: + type: integer + format: int64 + - description: Defines the size of a page - the number of synthetic test CI/CDs + that will be returned by the query + example: 10 + in: query + name: limit + schema: + type: integer + format: int64 + responses: + '200': + content: + application/json: + example: + - testResultId: e22aba08-e630-422d-8d7a-19b8a1c75d32 + locationId: r4zo4DjbORqEAES2c8xj + locationLabel: SynTest + testId: 5ufGW4jOnZNhViGmIbnx + testLabel: test + testType: HTTPAction + runType: OnDemand + completed: false + customization: + configuration: + retries: 1 + timeout: 15s + customProperties: + tag: test + - testResultId: 0cf1324b-3022-4116-ae03-6c868daa43d4 + locationId: r4zo4DjbORqEAES2c8xj + locationLabel: SynTest + testId: 5ufGW4jOnZNhViGmIbnx + testLabel: test + testType: HTTPAction + runType: OnDemand + completed: false + customization: + configuration: + retries: 2 + timeout: 5s + schema: + type: array + items: + $ref: '#/components/schemas/SyntheticTestCICDItem' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticTests + summary: All Synthetic test CI/CDs + tags: + - Synthetic Settings + x-description: getSyntheticTestCICDs + x-ibm-ahub-byok: true + post: + description: |- + API request to create a Synthetic Test CI/CD. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: createSyntheticTestCICD + requestBody: + content: + application/json: + example: + - testId: K331gkuCbelN1HI5y1wl + customization: + locations: + - 8mCxCPOI7oEmMSee4ec0 + - lalQTzq7MwO6hZ6c6xDd + configuration: + timeout: 100ms + retries: 2 + customProperties: + Team: DevTeam + Purpose: Demo + schema: + type: array + items: + $ref: '#/components/schemas/SyntheticTestCICD' + required: true + x-payload: createSyntheticTestCICD + responses: + '200': + content: + application/json: + example: + - testResultId: f078443e-468c-4e35-b614-979ad9200fe4 + testId: K331gkuCbelN1HI5y1wl + locationId: 8mCxCPOI7oEmMSee4ec0 + - testResultId: 2cba4974-c73a-45ea-ad63-77c44c19bd36 + testId: K331gkuCbelN1HI5y1wl + locationId: lalQTzq7MwO6hZ6c6xDd + schema: + type: array + items: + $ref: '#/components/schemas/SyntheticTestCICDResponse' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticTests + summary: Create a Synthetic test CI/CD + tags: + - Synthetic Settings + x-description: createSyntheticTestCICD + x-ibm-ahub-byok: true + /api/synthetics/settings/tests/ci-cd/{testResultId}: + get: + description: |- + API request to retrieve the Synthetic Test CI/CD identified by the given test result id. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: getSyntheticTestCICD + parameters: + - description: The synthetic test result id of the CI/CD to be retrieved + example: 0cf1324b-3022-4116-ae03-6c868daa43d4 + in: path + name: testResultId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + testResultId: 0cf1324b-3022-4116-ae03-6c868daa43d4 + locationId: r4zo4DjbORqEAES2c8xj + locationLabel: SynTest + testId: 5ufGW4jOnZNhViGmIbnx + testLabel: test + testType: HTTPAction + runType: OnDemand + completed: false + customization: + configuration: + retries: 2 + timeout: 5s + schema: + $ref: '#/components/schemas/SyntheticTestCICDItem' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticTests + summary: A Synthetic test CI/CD. + tags: + - Synthetic Settings + x-description: getSyntheticTestCICD + x-ibm-ahub-byok: true + /api/synthetics/settings/tests/{id}: + delete: + description: |- + API request to delete a Synthetic Test. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: deleteSyntheticTest + parameters: + - description: Id of the synthetic test to be deleted + example: ic25Vt1T5dgKzi0K7812 + in: path + name: id + required: true + schema: + type: string + responses: + '204': + description: Successful - no content to return. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticTests + summary: Delete a Synthetic test + tags: + - Synthetic Settings + x-ibm-ahub-byok: true + get: + description: |- + API request to retrieve a Synthetic Test with matching id. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: getSyntheticTest + parameters: + - description: Id of the synthetic test to be retrieved + example: EFNRoPd39SgZBkULeQIf + in: path + name: id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: EFNRoPd39SgZBkULeQIf + tenantId: saas_instana_test + label: APITest_getApplication + active: true + testFrequency: 15 + playbackMode: Simultaneous + applicationId: UOGJ3jBOSMOgN2EBCoOghw + applicationLabel: test_cb + locations: + - 18WyhtDb5jpVOsjlNdeV + locationLabels: + - Syne2e + locationDisplayLabels: + - E2ETest PoP + configuration: + syntheticType: HTTPScript + markSyntheticCall: true + retries: 2 + retryInterval: 1 + timeout: 10m + script: |- + const got = require('got'); + const assert = require('assert'); + + // Define the API request configuration + const apiConfig = { + method: 'GET', + url: 'https://test-instana.pink.instana.rocks/api/application-monitoring/settings/application/btg-B701Rx6o9QNXUS4TVw', + headers: { + 'Authorization': $secure.apiToken + } + }; + + // Function to perform the API test + const performAPITest = async () => { + const response = await got(apiConfig); + console.info("Get one application API - GET, response code: " + response.statusCode); + assert.ok(response.statusCode == 200, "GET status is " + response.statusCode + ", it should be 200"); + + const jsonBody = JSON.parse(response.body); + assert.ok(jsonBody.id != "", "Application ID is not in the payload"); + assert.ok(jsonBody.label != "", "Application label is not in the payload"); + assert.ok(jsonBody.tagFilterExpression != null, "tagFilterExpression is not in the payload"); + }; + + // Initial test + performAPITest(); + scriptType: Basic + customProperties: + test: '123' + createdAt: 1696625954210 + modifiedAt: 1701216106812 + modifiedBy: Internal + rbacTags: + - id: test + displayName: test + schema: + $ref: '#/components/schemas/SyntheticTest' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canViewSyntheticTests + summary: A Synthetic test + tags: + - Synthetic Settings + x-ibm-ahub-byok: true + patch: + description: |- + API request to update a Synthetic Test. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: patchSyntheticTest + parameters: + - description: Id of the synthetic test to be patched + example: ic25Vt1T5dgKzi0K7812 + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + active: true + configuration: + scripts: null + script: //script goes here + rbacTags: + - id: test + displayName: test + schema: + $ref: '#/components/schemas/SyntheticTest' + required: true + x-payload: patchSyntheticTest + responses: + '200': + content: + application/json: { + } + description: OK + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticTests + summary: Patch a Synthetic test + tags: + - Synthetic Settings + x-description: patchSyntheticTest + x-ibm-ahub-byok: true + put: + description: |- + API request to update a Synthetic Test. + For more information on Synthetic Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-settings. + operationId: updateSyntheticTest + parameters: + - description: Id of the synthetic test to be updated + example: ic25Vt1T5dgKzi0K7812 + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + id: ic25Vt1T5dgKzi0K7812 + label: Test_SimplePing + description: this is to test a simple ping API + applicationId: applicationId001 + active: true + testFrequency: 1 + playbackMode: Simultaneous + locations: + - saas_instana_test + configuration: + syntheticType: HTTPAction + url: https://httpbin.org/post + operation: POST + headers: + Content-Type: text/plain + body: Hello World! + validationString: Hello World! + customProperties: + Team: DevTeam + Purpose: Demo + rbacTags: + - id: JxrVZtRtTUGug71K1oYMcw + displayName: tests + schema: + $ref: '#/components/schemas/SyntheticTest' + required: true + x-payload: updateSyntheticTest + responses: + '200': + content: + application/json: { + } + description: OK + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - canConfigureSyntheticTests + summary: Update a Synthetic test + tags: + - Synthetic Settings + x-description: updateSyntheticTest + x-ibm-ahub-byok: true + /api/website-monitoring/analyze/beacon-groups: + post: + description: |- + API request to get grouped website monitoring beacon metrics. + For more information on Website Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Websites+&+Mobile+Apps. + operationId: getBeaconGroups + parameters: + - in: query + name: fillTimeSeries + schema: + type: boolean + requestBody: + content: + application/json: + example: + metrics: + - metric: beaconCount + aggregation: SUM + granularity: 60 + group: + groupByTag: beacon.page.name + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: beacon.website.name + operator: EQUALS + entity: NOT_APPLICABLE + value: robot-shop + - type: TAG_FILTER + name: beacon.location.path + operator: EQUALS + entity: NOT_APPLICABLE + value: /checkout + timeFrame: + to: null + windowSize: 3600000 + type: PAGELOAD + schema: + $ref: '#/components/schemas/GetWebsiteBeaconGroups' + x-payload: getBeaconGroups + responses: + '200': + content: + application/json: + example: + items: + - name: Check Out + earliestTimestamp: 1707019058453 + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1707022593250 + offset: 1 + metrics: + beaconCount.sum.60: + - - 1707019020000 + - 1.0 + - - 1707019080000 + - 3.0 + canLoadMore: false + totalHits: 1 + totalRepresentedItemCount: 1 + totalRetainedItemCount: 1 + adjustedTimeframe: + windowSize: 3600000 + to: 1707022620000 + schema: + $ref: '#/components/schemas/WebsiteBeaconGroupsResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get grouped beacon metrics + tags: + - Website Analyze + x-ibm-ahub-byok: true + /api/website-monitoring/analyze/beacons: + post: + description: |- + API request to get all website monitoring beacons with matching type. + For more information on Website Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Websites+&+Mobile+Apps. + operationId: getBeacons + requestBody: + content: + application/json: + example: + tagFilterExpression: + type: TAG_FILTER + name: beacon.website.name + operator: EQUALS + entity: NOT_APPLICABLE + value: robot-shop + timeFrame: + to: null + windowSize: 3600000 + type: PAGELOAD + schema: + $ref: '#/components/schemas/GetWebsiteBeacons' + x-payload: getWebsiteBeacons + responses: + '200': + content: + application/json: + example: + items: + - beacon: + websiteId: Example website ID + websiteLabel: robot-shop + page: Products + phase: pageLoad + timestamp: 1707023459363 + clockSkew: 356 + duration: 240 + batchSize: 1 + accurateTimingsAvailable: true + deprecations: [ + ] + pageLoadId: 0cea1830450a460 + sessionId: 899e5d28e5c6402 + beaconId: 00cea1830450a460 + backendTraceId: ef968a97dd967268 + type: pageLoad + customEventName: '' + meta: + stage: production + status: silver + locationUrl: http://robotshop.instana.com/products + locationOrigin: http://robotshop.instana.com + locationPath: /products + errorCount: 0 + errorMessage: '' + errorId: '' + errorType: '' + parsedStackTrace: [ + ] + componentStack: '' + userIp: 195.140.0.0 + userId: Example User Id + userName: Example User Name + userEmail: example@example.com + userLanguages: + - en-GB + deviceType: '' + connectionType: 4g + browserName: Chrome + browserVersion: '73' + osName: Windows + osVersion: '10' + windowHidden: false + windowWidth: 1149 + windowHeight: 1008 + latitude: 51.5088 + longitude: -0.093 + accuracyRadius: 20 + city: London + subdivision: England + subdivisionCode: ENG + country: United Kingdom + countryCode: GB + continent: Europe + continentCode: EU + httpCallUrl: '' + httpCallOrigin: '' + httpCallPath: '' + httpCallMethod: '' + httpCallStatus: -1 + httpCallCorrelationAttempted: false + httpCallAsynchronous: false + initiator: html + resourceType: document + cacheInteraction: '' + encodedBodySize: -1 + decodedBodySize: -1 + transferSize: -1 + unloadTime: 0 + redirectTime: 0 + appCacheTime: 0 + dnsTime: 0 + tcpTime: 0 + sslTime: 0 + requestTime: 42 + responseTime: 1 + processingTime: -1 + onLoadTime: 1 + backendTime: 51 + frontendTime: -1 + domTime: -1 + childrenTime: 5 + firstPaintTime: 331 + firstContentfulPaintTime: 331 + largestContentfulPaintTime: 331 + firstInputDelayTime: -1 + cumulativeLayoutShift: -1.0 + cspBlockedUri: '' + cspEffectiveDirective: '' + cspOriginalPolicy: '' + cspDisposition: '' + cspSample: '' + cspSourceFile: '' + cspLineNumber: -1 + cspColumnNumber: -1 + snippetVersion: '2' + httpCallHeaders: { + } + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1707023459959 + offset: 1 + schema: + $ref: '#/components/schemas/WebsiteBeaconResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get all beacons + tags: + - Website Analyze + x-ibm-ahub-byok: true + /api/website-monitoring/catalog: + get: + description: API to get website tag catalog for specified beaconType and useCase. + operationId: getWebsiteTagCatalog + parameters: + - description: beaconType + example: pageLoad + in: query + name: beaconType + required: true + schema: + type: string + - description: useCase + example: GROUPING + in: query + name: useCase + required: true + schema: + type: string + enum: + - GROUPING + - FILTERING + - SERVICE_MAPPING + - SMART_ALERTS + - SMART_ALERTS_LOGS + - SMART_ALERTS_ADAPTIVE_BASELINE + - SMART_ALERTS_CUSTOM_PAYLOAD + - SLI_MANAGEMENT + - APPLICATION_CONFIG + - APPLICATION_CONFIG_BLUEPRINT + - MAINTENANCE_WINDOWS + - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + responses: + '200': + content: + application/json: + example: + tagTree: + - label: Commonly Used + description: null + icon: null + children: + - label: Website Label + description: Name of the website as configured within the Instana + user interface. + tagName: beacon.website.name + type: TAG + tags: + - name: beacon.type + label: Beacon Type + type: STRING + description: null + canApplyToSource: false + canApplyToDestination: false + idTag: false + schema: + $ref: '#/components/schemas/TagCatalog' + description: OK + '400': + description: When the combination of beaconType and useCase is unsupported/unknown. + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get website tag catalog + tags: + - Website Catalog + x-description: getWebsiteTagCatalog + x-ibm-ahub-byok: true + /api/website-monitoring/catalog/metrics: + get: + description: API to get catalog of website metrics. + operationId: getWebsiteCatalogMetrics + responses: + '200': + content: + application/json: + example: + - metricId: beaconDuration + label: Beacon duration + formatter: LATENCY + description: The recorded duration for a beacon. + aggregations: + - P25 + - MEAN + - MAX + - P95 + - P90 + - SUM + - P98 + - P99 + - MIN + - P75 + - P50 + defaultAggregation: null + beaconTypes: + - pageLoad + - resourceLoad + - custom + - httpRequest + pathToValueInBeacon: + - duration + tagName: beacon.duration + - metricId: pageLoads + label: Page loads + formatter: NUMBER + description: How often a full page load occurred. This typically requires + retrieval of an HTML document from a server (unless cached) and + then the full onLoad cycle. + aggregations: + - SUM + defaultAggregation: null + beaconTypes: + - pageLoad + pathToValueInBeacon: null + tagName: null + schema: + type: array + items: + $ref: '#/components/schemas/WebsiteMonitoringMetricDescription' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Metric catalog + tags: + - Website Catalog + x-description: getWebsiteCatalogMetrics + x-ibm-ahub-byok: true + /api/website-monitoring/catalog/tags: + get: + description: API to get all existing website tags. + operationId: getWebsiteCatalogTags + responses: + '200': + content: + application/json: + example: + - name: beacon.sessionId + type: STRING + category: WEBSITE + canApplyToSource: false + canApplyToDestination: false + sourceValueAvailableFrom: 0 + schema: + type: array + items: + $ref: '#/components/schemas/Tag' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get all existing website tags + tags: + - Website Catalog + x-description: getWebsiteCatalogTags + x-ibm-ahub-byok: true + /api/website-monitoring/config: + get: + description: API request to get all configured websites details. + operationId: getWebsites + responses: + '200': + content: + application/json: + example: + - id: K3bP-bmCRkyimNai9vvq8o + name: example_website + appName: example_website + rbacTags: + - id: test + displayName: test + schema: + type: array + items: + $ref: '#/components/schemas/Website' + description: OK + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get configured websites + tags: + - Website Configuration + x-ibm-ahub-byok: true + post: + description: API request to add new website. + operationId: createWebsite + parameters: + - in: query + name: name + schema: + type: string + requestBody: + content: + application/json: + example: + - id: test + displayName: test + schema: + type: array + items: + type: object + properties: + displayName: + type: string + description: Name of team tag + id: + type: string + description: ID of team tag + responses: + '200': + content: + application/json: + example: + id: K3bP-bmCRkyimNai9vvq8o + name: example_website + appName: example_website + schema: + $ref: '#/components/schemas/Website' + description: Website successfully configured + '400': + description: Missing name query parameter or name already used for a configured + website + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Configure new website + tags: + - Website Configuration + x-ibm-ahub-byok: true + /api/website-monitoring/config/{websiteId}: + delete: + description: API request to delete website. + operationId: deleteWebsite + parameters: + - description: Website ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: websiteId + required: true + schema: + type: string + responses: + '204': + description: Website successfully removed + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Remove website + tags: + - Website Configuration + x-ibm-ahub-byok: true + get: + description: API request to get configured website details for specified websiteId + operationId: getWebsite + parameters: + - description: Website ID + example: 1ELrNt-eQ9SlK4D_EgLMiA + in: path + name: websiteId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: |2 + { + "id": "1ELrNt-eQ9SlK4D_EgLMiA", + "name": "example_website", + "appName": "example_website" + "rbacTags: [{ + "id": "test", + "displayName": "test" + }] + } + schema: + $ref: '#/components/schemas/Website' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get configured website + tags: + - Website Configuration + x-ibm-ahub-byok: true + put: + description: API request to rename website. + operationId: renameWebsite + parameters: + - description: Website ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: websiteId + required: true + schema: + type: string + - in: query + name: name + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: K3bP-bmCRkyimNai9vvq8o + name: example_website + appName: example_website + schema: + $ref: '#/components/schemas/Website' + description: Website successfully renamed + '400': + description: Missing name query parameter or name already used for a configured + website + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Rename website + tags: + - Website Configuration + x-ibm-ahub-byok: true + /api/website-monitoring/config/{websiteId}/geo-location: + get: + description: API request to get geo-location configuration of a website specified + by its websiteId + operationId: getWebsiteGeoLocationConfiguration + parameters: + - description: Website ID + example: 1ELrNt-eQ9SlK4D_EgLMiA + in: path + name: websiteId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + geoDetailRemoval: NO_REMOVAL + geoMappingRules: [ + ] + schema: + $ref: '#/components/schemas/GeoLocationConfiguration' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Get geo location configuration for website + tags: + - Website Configuration + x-ibm-ahub-byok: true + put: + description: API request to update geo location configuration for website. + operationId: updateWebsiteGeoLocationConfiguration + parameters: + - description: Website ID + example: iiLxP1zaTuCS7fyk9m4W0W + in: path + name: websiteId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GeoLocationConfiguration' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GeoLocationConfiguration' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Update geo location configuration for website + tags: + - Website Configuration + x-ibm-ahub-byok: true + /api/website-monitoring/config/{websiteId}/geo-mapping-rules: + get: + description: API request to get custom geo mapping rules for website. + operationId: getWebsiteGeoMappingRules + parameters: + - description: Website ID + example: iiLxP1zaTuCS7fyk9m4W0W + in: path + name: websiteId + required: true + schema: + type: string + responses: + '200': + content: + text/csv: { + } + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Get custom geo mapping rules for website + tags: + - Website Configuration + x-ibm-ahub-byok: true + put: + description: API request to set custom geo mapping rules for website. + operationId: setWebsiteGeoMappingRules + parameters: + - description: Website ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: websiteId + required: true + schema: + type: string + requestBody: + content: + text/csv: + schema: + type: string + responses: + '200': + content: + text/csv: { + } + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '415': + description: Unsupported Media Type. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Set custom geo mapping rules for website + tags: + - Website Configuration + x-ibm-ahub-byok: true + /api/website-monitoring/config/{websiteId}/ip-masking: + get: + description: API request to get IP masking configuration of a website specified + by its websiteId + operationId: getWebsiteIpMaskingConfiguration + parameters: + - description: Website ID + example: 1ELrNt-eQ9SlK4D_EgLMiA + in: path + name: websiteId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + ipMasking: DEFAULT + schema: + $ref: '#/components/schemas/IpMaskingConfiguration' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Get IP masking configuration for website + tags: + - Website Configuration + x-ibm-ahub-byok: true + put: + description: API request to update IP masking configuration for website. + operationId: updateWebsiteIpMaskingConfiguration + parameters: + - description: Website ID + example: iiLxP1zaTuCS7fyk9m4W0W + in: path + name: websiteId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IpMaskingConfiguration' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IpMaskingConfiguration' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Update IP masking configuration for website + tags: + - Website Configuration + x-ibm-ahub-byok: true + /api/website-monitoring/config/{websiteId}/sourcemap-upload: + get: + description: API request to get all sourcemap upload configurations for website. + operationId: getWebsiteSourceMapUploadConfigurations + parameters: + - description: Website ID + example: 1ELrNt-eQ9SlK4D_EgLMiA + in: path + name: websiteId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + configs: + - id: 67f84a0b117c99e + description: websiteSourcemapUploadConfig1 + createdAt: 1.7479781712347815E9 + modifiedAt: 1.7479781712347815E9 + metadata: [ + ] + schema: + $ref: '#/components/schemas/SourceMapUploadConfigs' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + summary: Get all sourcemap upload configurations for website + tags: + - Website Configuration + x-ibm-ahub-byok: true + post: + description: API request to add sourcemap upload configuration for website. + operationId: postWebsiteSourceMapUploadConfig + parameters: + - description: Website ID + example: 1ELrNt-eQ9SlK4D_EgLMiA + in: path + name: websiteId + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + description: websiteSourcemapConfig2 + schema: + type: object + description: Source map upload configuration + properties: + description: + type: string + description: Name of configuration + responses: + '200': + content: + application/json: + example: + id: 5894971d635094e7 + description: websiteSourcemapConfig2 + createdAt: 1.7479800626018546E9 + modifiedAt: 1.7479800626018546E9 + metadata: [ + ] + schema: + $ref: '#/components/schemas/SourceMapUploadConfig' + description: Website sourcemap upload configuration added successfully + '400': + description: Missing description or description already used for a configuration. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '422': + description: Unprocessable request - missing/invalid data. + '500': + description: Internal server error. + summary: Add new sourcemap upload configuration for website + tags: + - Website Configuration + x-ibm-ahub-byok: true + /api/website-monitoring/config/{websiteId}/sourcemap-upload/{sourceMapConfigId}: + delete: + description: API request to delete sourcemap upload configuration for website. + operationId: deleteWebsiteSourceMapUploadConfiguration + parameters: + - description: Website ID + example: 1ELrNt-eQ9SlK4D_EgLMiA + in: path + name: websiteId + required: true + schema: + type: string + - description: Source Map Config ID + example: 97e0ad312110d3ad + in: path + name: sourceMapConfigId + required: true + schema: + type: string + responses: + '204': + description: Sourcemap configuration successfully deleted or sourcemap not + found + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + summary: Delete sourcemap upload configuration for website + tags: + - Website Configuration + x-ibm-ahub-byok: true + get: + description: API request to get sourcemap upload configuration for website. + operationId: getWebsiteSourceMapUploadConfiguration + parameters: + - in: path + name: websiteId + required: true + schema: + type: string + - description: Source Map Config ID + example: 97e0ad312110d3ad + in: path + name: sourceMapConfigId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + example: + id: 67f84a0b117c99e + description: websiteSourcemapUploadConfig1 + createdAt: 1.7479781712347815E9 + modifiedAt: 1.7479781712347815E9 + metadata: [ + ] + schema: + $ref: '#/components/schemas/SourceMapUploadConfig' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '500': + description: Internal server error. + summary: Get sourcemap upload configurations for website + tags: + - Website Configuration + x-ibm-ahub-byok: true + /api/website-monitoring/config/{websiteId}/sourcemap-upload/{sourceMapConfigId}/clear: + put: + description: API request to clear source map files for sourcemap upload configuration. + operationId: clearSourceMapUploadConfiguration + parameters: + - description: Website ID + example: UhzF-fWORlyVLHDlvutYYQ + in: path + name: websiteId + required: true + schema: + type: string + - description: Source Map Config ID + example: 97e0ad312110d3ad + in: path + name: sourceMapConfigId + required: true + schema: + type: string + responses: + '204': + description: Source map files in the source map upload configuration successfully + cleared + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Clear source map files for sourcemap upload configuration + tags: + - Website Configuration + x-ibm-ahub-byok: true + /api/website-monitoring/config/{websiteId}/sourcemap-upload/{sourceMapConfigId}/form: + put: + description: API request to upload sourcemap file for website. + operationId: uploadSourceMapFile + parameters: + - description: Website ID + example: UhzF-fWORlyVLHDlvutYYQ + in: path + name: websiteId + required: true + schema: + type: string + - description: Source Map Config ID + example: 97e0ad312110d3ad + in: path + name: sourceMapConfigId + required: true + schema: + type: string + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + fileFormat: + type: string + sourceMap: + type: string + format: binary + description: Local Source Map file path + url: + type: string + description: URL of the website + required: + - sourceMap + - url + responses: + '200': + content: + application/json: + example: + id: 67f84a0b117c99e + description: websiteSourcemapUploadConfig1 + createdAt: 1.7479781712347815E9 + modifiedAt: 1.7479781712347815E9 + metadata: [ + ] + schema: + $ref: '#/components/schemas/SourceMapUploadConfig' + description: OK + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '404': + description: Resource not found. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Upload sourcemap file for website + tags: + - Website Configuration + x-ibm-ahub-byok: true + /api/website-monitoring/config/{websiteId}/teams: + put: + description: API request to update teams of a website. + operationId: updateWebsiteTeams + parameters: + - in: path + name: websiteId + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + - id: test + displayName: test + schema: + type: array + items: + $ref: '#/components/schemas/ApiTag' + responses: + '200': + content: + application/json: + example: + - id: test + displayName: test + schema: + type: array + items: + $ref: '#/components/schemas/ApiTag' + description: Website successfully configured + '400': + description: Bad request. + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - CanConfigureEumApplications + summary: Update teams assigned to the website + tags: + - Website Configuration + x-ibm-ahub-byok: true + /api/website-monitoring/metrics: + post: + deprecated: true + description: API request to get website monitoring beacon metrics. + operationId: getBeaconMetrics + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetWebsiteMetrics' + x-payload: getWebsiteMetricsQuery + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WebsiteMetricResult' + description: OK + security: + - ApiKeyAuth: + - Default + summary: Get beacon metrics + tags: + - Website Metrics + x-ibm-ahub-byok: true + /api/website-monitoring/page-load{id}{timestamp}: + get: + description: API request to get website monitoring beacons for a page load. + operationId: getPageLoad + parameters: + - description: Identifier of the page load to be retrieved + example: 63f5b070e8d9a597 + in: path + name: id + required: true + schema: + type: string + style: matrix + - description: Timestamp of the page load to be retrieved + example: 1707012285674 + in: path + name: timestamp + required: true + schema: + type: integer + format: int64 + style: matrix + responses: + '200': + content: + application/json: + example: + - websiteId: example website id + websiteLabel: robot-shop + page: Home + phase: pageLoad + timestamp: 1707012285674 + clockSkew: 447 + duration: 120 + batchSize: 1 + accurateTimingsAvailable: true + deprecations: [ + ] + pageLoadId: 974bca2eb13047c + sessionId: e995a184bb4b4e0 + beaconId: 0974bca2eb13047c + backendTraceId: c92e3ec967ef173f + type: pageLoad + customEventName: '' + meta: + stage: production + status: bronze + locationUrl: http://robotshop.instana.com/ + locationOrigin: http://robotshop.instana.com + locationPath: / + errorCount: 0 + errorMessage: '' + errorId: '' + errorType: '' + parsedStackTrace: [ + ] + componentStack: '' + userIp: 87.191.0.0 + userId: example user id + userName: example user name + userEmail: example@example.com + userLanguages: + - de-DE + deviceType: '' + connectionType: 4g + browserName: Firefox + browserVersion: '63' + osName: Ubuntu + osVersion: '18' + windowHidden: false + windowWidth: 1149 + windowHeight: 1008 + latitude: 50.8021 + longitude: 8.7857 + accuracyRadius: 200 + city: Weidenhausen + subdivision: Hesse + subdivisionCode: HE + country: Germany + countryCode: DE + continent: Europe + continentCode: EU + httpCallUrl: '' + httpCallOrigin: '' + httpCallPath: '' + httpCallMethod: '' + httpCallStatus: 400 + httpCallCorrelationAttempted: false + httpCallAsynchronous: false + initiator: html + resourceType: document + cacheInteraction: '' + encodedBodySize: -1 + decodedBodySize: -1 + transferSize: -1 + unloadTime: 0 + redirectTime: 0 + appCacheTime: 0 + dnsTime: 0 + tcpTime: 0 + sslTime: 0 + requestTime: 42 + responseTime: 1 + processingTime: -1 + onLoadTime: 1 + backendTime: 51 + frontendTime: -1 + domTime: -1 + childrenTime: 5 + firstPaintTime: 331 + firstContentfulPaintTime: 331 + largestContentfulPaintTime: 331 + firstInputDelayTime: -1 + cumulativeLayoutShift: -1.0 + cspBlockedUri: '' + cspEffectiveDirective: '' + cspOriginalPolicy: '' + cspDisposition: '' + cspSample: '' + cspSourceFile: '' + cspLineNumber: -1 + cspColumnNumber: -1 + snippetVersion: '2' + httpCallHeaders: { + } + parentBeaconId: '' + interactionNextPaint: -1 + schema: + type: array + items: + $ref: '#/components/schemas/WebsiteMonitoringBeacon' + description: OK + '400': + description: Bad request. + '404': + description: Resource not found. + security: + - ApiKeyAuth: + - Default + summary: Get page load + tags: + - Website Metrics + x-ibm-ahub-byok: true + /api/website-monitoring/v2/metrics: + post: + description: API request to get website monitoring beacon metrics. + operationId: getBeaconMetricsV2 + requestBody: + content: + application/json: + example: + metrics: + - metric: beaconCount + aggregation: SUM + tagFilterExpression: + type: EXPRESSION + logicalOperator: AND + elements: + - type: TAG_FILTER + name: beacon.website.name + operator: EQUALS + entity: NOT_APPLICABLE + value: robot-shop + - type: TAG_FILTER + name: beacon.location.path + operator: EQUALS + entity: NOT_APPLICABLE + value: / + timeFrame: + to: null + windowSize: 3600000 + type: PAGELOAD + schema: + $ref: '#/components/schemas/GetWebsiteMetricsV2' + x-payload: getWebsiteMetricsQuery + responses: + '200': + content: + application/json: + example: + metrics: + beaconCount.sum: + - - 1706856180000 + - 100.0 + adjustedTimeFrame: + windowSize: 3540000 + to: 1706856180000 + schema: + $ref: '#/components/schemas/MetricAPIResult' + description: OK + '401': + description: Unauthorized access - requires user authentication. + '404': + description: Resource not found. + '422': + description: Unprocessable request - missing/invalid data. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - Default + summary: Get beacon metrics + tags: + - Website Metrics + x-ibm-ahub-byok: true +components: + schemas: + AbstractIntegration: + type: object + discriminator: + mapping: + BIDIRECTIONAL_MS_TEAMS: '#/components/schemas/BidirectionalMsTeamsAppIntegration' + BIDIRECTIONAL_SLACK: '#/components/schemas/BidirectionalSlackAppIntegration' + EMAIL: '#/components/schemas/EmailIntegration' + GOOGLE_CHAT: '#/components/schemas/GoogleChatIntegration' + OFFICE_365: '#/components/schemas/Office365Integration' + OPS_GENIE: '#/components/schemas/OpsgenieIntegration' + PAGER_DUTY: '#/components/schemas/PagerdutyIntegration' + PROMETHEUS_WEBHOOK: '#/components/schemas/PrometheusWebhookIntegration' + SALESFORCE: '#/components/schemas/SalesforceIntegration' + SERVICE_NOW_APPLICATION: '#/components/schemas/ServiceNowEnhancedIntegration' + SERVICE_NOW_WEBHOOK: '#/components/schemas/ServiceNowIntegration' + SLACK: '#/components/schemas/SlackIntegration' + SPLUNK: '#/components/schemas/SplunkIntegration' + VICTOR_OPS: '#/components/schemas/VictorOpsIntegration' + WATSON_AIOPS_WEBHOOK: '#/components/schemas/WatsonAIOpsWebhookIntegration' + WEBEX_TEAMS_WEBHOOK: '#/components/schemas/WebexTeamsWebhookIntegration' + WEB_HOOK: '#/components/schemas/WebhookIntegration' + Z_CHATOPS: '#/components/schemas/ZChatOpsIntegration' + propertyName: kind + properties: + id: + type: string + description: Unique ID of the returned Alert Channel + kind: + type: string + description: The type of the Alerting Channel. + name: + type: string + description: The name of the Alerting Channel. + required: + - id + - kind + - name + AbstractRule: + type: object + discriminator: + mapping: + entity_count: '#/components/schemas/EntityCountRule' + entity_count_verification: '#/components/schemas/EntityCountVerificationRule' + entity_verification: '#/components/schemas/EntityVerificationRule' + host_availability: '#/components/schemas/HostAvailabilityRule' + system: '#/components/schemas/SystemRule' + threshold: '#/components/schemas/ThresholdRule' + propertyName: ruleType + properties: + ruleType: + type: string + severity: + type: integer + format: int32 + required: + - ruleType + AccessLogEntry: + type: object + properties: + action: + type: string + enum: + - GRANT_TEMP_ACCESS + - FIRST_LOGIN + - LOGIN + - ACCESS + - FAILED_LOGIN + - LOGOUT + - CREATE_API_TOKEN_BY_POLICY + - IDP_MAPPING + - DISABLE_IP_RESTRICTION + email: + type: string + fullName: + type: string + message: + type: string + meta: + type: object + additionalProperties: + type: object + tenantId: + type: string + tenantUnitId: + type: string + timestamp: + type: integer + format: int64 + minimum: 1118583367265 + required: + - action + - email + - fullName + - tenantId + AccessLogResponse: + type: object + properties: + entries: + type: array + items: + $ref: '#/components/schemas/AccessLogEntry' + total: + type: integer + format: int64 + AccessRule: + type: object + properties: + accessType: + type: string + description: "Specifies the type of access permitted. \n\n`READ`: Only viewing\ + \ Application Perspective is allowed. \n\n`READ_WRITE`: Both viewing and\ + \ modifying Application Perspective are permitted. \n\n" + enum: + - READ + - READ_WRITE + relatedId: + type: string + description: "An identifier that connects the access rule to a specific\ + \ entity.\nFor example, if the `relationType` is `USER`, the corresponding\ + \ `relatedId` would be a user id. \n\n**Note**: when `relationType` is\ + \ `GLOBAL`, `relatedId` is `null`.\n" + maxLength: 64 + minLength: 0 + relationType: + type: string + description: "Defines the type of relationship or subject to which the access\ + \ rule applies. \n\n`USER`: Access is granted to an individual user. \n\ + \n`API_TOKEN`: Access is granted to a specific API token. \n\n`ROLE`:\ + \ Access is granted based on a user role, applying to any user with that\ + \ role. \n\n`TEAM`: Access is granted to a team, likely applying to all\ + \ team members. \n\n`GLOBAL`: Access is granted to every user or service.\n" + enum: + - USER + - API_TOKEN + - ROLE + - TEAM + - GLOBAL + required: + - accessType + - relationType + Action: + type: object + description: Automation action definition. When this is used in policy creation + request, only `id` should be specified. + properties: + createdAt: + type: string + format: date-time + description: Action created time. + description: + type: string + description: Action description. + maxLength: 512 + minLength: 0 + fields: + type: array + description: List of fields that describe an action. + items: + $ref: '#/components/schemas/Field' + id: + type: string + description: Action identifier. + maxLength: 128 + minLength: 1 + inputParameters: + type: array + description: List of inputs to the action. + items: + $ref: '#/components/schemas/Parameter' + metadata: + $ref: '#/components/schemas/MetaData' + modifiedAt: + type: string + format: date-time + description: Action modified time. + name: + type: string + description: Action name. + maxLength: 128 + minLength: 1 + tags: + type: array + description: List of tags added to the action. + items: + type: string + description: List of tags added to the action. + type: + type: string + description: 'Action type can be one of the following values: SCRIPT, HTTP, + ANSIBLE, EXTERNAL, GITHUB, GITLAB, JIRA, MANUAL, DOC_LINK' + enum: + - SCRIPT + - HTTP + - ANSIBLE + - EXTERNAL + - GITHUB + - GITLAB + - JIRA + - MANUAL + - DOC_LINK + maxLength: 128 + minLength: 0 + required: + - createdAt + - id + - modifiedAt + - name + - type + ActionConfiguration: + type: object + description: List of action configurations. + properties: + action: + $ref: '#/components/schemas/Action' + agentId: + type: string + description: Identifier of the agent host on which to run the action. + inputParameterValues: + type: array + description: List of action input parameters. + items: + $ref: '#/components/schemas/ParameterValue' + required: + - action + ActionInstance: + type: object + properties: + actionDescription: + type: string + description: Action description of the action to run. + actionId: + type: string + description: Action identifier of the action to run. + actionInstanceId: + type: string + description: Action run identifier. + readOnly: true + actionName: + type: string + description: Action name of the action to run. + actionSnapshot: + type: string + description: Snapshot of the action definition. + readOnly: true + actorId: + type: string + description: User identifier, API token or the policy identifier that started + the action run. + actorName: + type: string + description: Name of the user, API token or the policy that started the + action run. + actorType: + type: string + description: Type of Actor. Valid values are listed in the enum definition. + enum: + - ACTOR_UNKNOWN + - USER + - APITOKEN + - POLICY + createdDate: + type: integer + format: int64 + description: Action run created timestamp. The timestamp at which the action + run got submitted. + endDate: + type: integer + format: int64 + description: Action run end timestamp. The timestamp at which the action + run ended on the agent host. + errorMessage: + type: string + description: Error message, if any, of action run on the agent host. + eventEntityType: + type: string + description: Event entity type set in the event that triggered this action + run. + eventId: + type: string + description: Event identifier of the event that triggered this action run. + eventSpecificationId: + type: string + description: Event specification identifier of the event that triggered + this action run. + externalSourceType: + type: string + description: If the action type is external this field contains the name + of the external source. + hostSnapshotId: + type: string + description: Host snapshot identifier of the agent on which the action ran. + inputParameters: + type: array + description: List of input parameters to this action run. + items: + $ref: '#/components/schemas/ActionInstanceParameter' + metadata: + type: array + description: List of metadata parameters set to this action run by sensors. + items: + $ref: '#/components/schemas/ActionInstanceMetadataEntry' + output: + type: string + description: Action run output. + policyId: + type: string + description: Identifier of the policy that triggered this action run. + problemText: + type: string + description: Event problem text of the event that triggered this action + run. + returnCode: + type: integer + format: int32 + description: Return code of action run on the agent host. + startDate: + type: integer + format: int64 + description: Action run start timestamp. The timestamp at which the action + run started on the agent host. + status: + type: string + description: Action run status. Valid values are listed in the enum definition. + enum: + - STATUS_UNKNOWN + - SUBMITTED + - IN_PROGRESS + - SUCCESS + - FAILED + - READY + - TIMEOUT + targetSnapshotId: + type: string + description: Action target entity identifier set in the event that triggered + this action run. This is the identifier of the entity on which an incident + or issue was raised. + type: + type: string + description: Action type. Valid values are listed in the enum definition. + enum: + - SCRIPT + - HTTP + - ANSIBLE + - EXTERNAL + - GITHUB + - GITLAB + - JIRA + - MANUAL + - DOC_LINK + required: + - actionId + - actionName + - type + ActionInstanceMetadataEntry: + type: object + description: List of metadata parameters set to this action run by sensors. + properties: + name: + type: string + description: Metadata name. + value: + type: string + description: Metadata value. + required: + - name + ActionInstanceParameter: + type: object + description: List of input parameters to this action run. + properties: + displayName: + type: string + description: Parameter display name. + name: + type: string + description: Parameter name. + type: + type: string + description: Parameter type. Valid values are `static`, `dynamic` or `vault` + value: + type: string + description: Parameter value. + required: + - displayName + - name + ActionInstanceRequest: + type: object + properties: + actionId: + type: string + description: Action identifier of the action to run. + async: + type: string + description: '`"true"` if the action should be run in asynchronous mode + `"false"` otherwise. Default is `"true"`.' + eventId: + type: string + description: Event identifier (incident or issue) associated with the policy. + hostId: + type: string + description: Agent host identifier on which to run the action. + inputParameters: + type: array + description: Action run input parameters. + items: + $ref: '#/components/schemas/ActionInstanceRequestParameters' + policyId: + type: string + description: Policy identifier that associates the action trigger (incident + or issue) to the action to run. + timeout: + type: string + description: Action run time out. Default is `30 seconds`. + required: + - actionId + - hostId + ActionInstanceRequestParameters: + type: object + description: Action run input parameters. + properties: + name: + type: string + description: Name of the input parameter. + type: + type: string + description: Type of the input parameter. Valid values are `static`, `dynamic` + or `vault`. Default is `static`. + value: + type: string + description: Value of the input parameter + required: + - name + - value + ActionMatch: + type: object + properties: + action: + $ref: '#/components/schemas/Action' + aiEngine: + type: string + enum: + - POLICY + - EVENT_SIMILARITY + - NLP + - SUCCESS_RATE + - TURBONOMIC + - WATSONX + confidence: + type: string + policy: + $ref: '#/components/schemas/Policy' + score: + type: number + format: double + required: + - aiEngine + - confidence + - score + ActionSearchSpace: + type: object + properties: + description: + type: string + description: The description of an incident or issue. + entityType: + type: string + description: The entity type associated with the incident or issue. + eventId: + type: string + description: The event identifier associated with the incident or issue. + name: + type: string + description: The name of an incident or issue. + required: + - name + AdaptiveBaseline: + type: object + allOf: + - $ref: '#/components/schemas/Threshold' + - type: object + properties: + deviationFactor: + type: number + format: double + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 16.0 + minimum: 0.5 + required: + - operator + AdaptiveThresholdRule: + type: object + allOf: + - $ref: '#/components/schemas/ThresholdConfigRule' + - type: object + properties: + deviationFactor: + type: number + format: double + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 16.0 + minimum: 0.5 + Addition: + type: object + allOf: + - $ref: '#/components/schemas/ArithmeticOperation' + required: + - left + - right + AdjustedTimeframe: + type: object + description: | + Time frame provided in API request is slightly adjusted in response for faster API response. + For example, In request payload, if timeframe is 08:03 - 14:03, which is a 6 hour window size. It is adjusted to 08:05 - 14:00 + Another example, In request payload, if timeframe is 08:20 - 08:20 (next day) which is a 24h window size. It is adjusted to 08:30 - 08:00 (next day) + properties: + to: + type: integer + format: int64 + description: 'end of timeframe expressed as the Unix epoch time in milliseconds. + Eg: `ISO 8601` standard time `2024-06-27T05:05:55.615Z` can be represented + as `1719464755615` in Unix epoch time in milliseconds.' + windowSize: + type: integer + format: int64 + description: windowSize in milliseconds + minimum: 0 + required: + - to + AgentConfigurationUpdate: + type: object + properties: + remoteBranch: + type: string + maxLength: 256 + minLength: 0 + remoteName: + type: string + maxLength: 256 + minLength: 0 + remoteUri: + type: string + maxLength: 65536 + minLength: 0 + AlertingConfiguration: + type: object + properties: + alertName: + type: string + description: Name of the Alert Configuration. + maxLength: 256 + minLength: 0 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/StaticStringField' + maxItems: 20 + minItems: 0 + eventFilteringConfiguration: + $ref: '#/components/schemas/EventFilteringConfiguration' + id: + type: string + description: ID of the Alert Configuration. + maxLength: 64 + minLength: 0 + includeEntityNameInLegacyAlerts: + type: boolean + description: To include the entity name in a legacy alert based on built-in/custom + events. + integrationIds: + type: array + description: List of Alert Channel IDs added in this Alert Configuration. + items: + type: string + description: List of Alert Channel IDs added in this Alert Configuration. + maxItems: 1024 + minItems: 0 + uniqueItems: true + muteUntil: + type: integer + format: int64 + description: Timer dictating how long the Alert Configuration will stay + muted. A value of `0` means the Alert Configuration is currently enabled. + Otherwise, the Alert Configuration is currently disabled (muted). + required: + - alertName + - customPayloadFields + - eventFilteringConfiguration + - id + - integrationIds + AlertingConfigurationWithLastUpdated: + type: object + properties: + alertName: + type: string + description: Name of the Alert Configuration. + maxLength: 256 + minLength: 0 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/StaticStringField' + maxItems: 20 + minItems: 0 + eventFilteringConfiguration: + $ref: '#/components/schemas/EventFilteringConfiguration' + id: + type: string + description: ID of the Alert Configuration. + maxLength: 64 + minLength: 0 + includeEntityNameInLegacyAlerts: + type: boolean + description: To include the entity name in a legacy alert based on built-in/custom + events. + integrationIds: + type: array + description: List of Alert Channel IDs added in this Alert Configuration. + items: + type: string + description: List of Alert Channel IDs added in this Alert Configuration. + maxItems: 1024 + minItems: 0 + uniqueItems: true + lastUpdated: + type: integer + format: int64 + description: Unix timestamp representing the time the configuration was + last updated. + minimum: 1 + muteUntil: + type: integer + format: int64 + description: Timer dictating how long the Alert Configuration will stay + muted. A value of `0` means the Alert Configuration is currently enabled. + Otherwise, the Alert Configuration is currently disabled (muted). + required: + - alertName + - customPayloadFields + - eventFilteringConfiguration + - id + - integrationIds + AlertingTimeWindow: + type: object + properties: + duration: + type: integer + format: int32 + durationType: + type: string + enum: + - millisecond + - second + - minute + - hour + - day + - week + - month + durationUnit: + type: string + enum: + - millisecond + - second + - minute + - hour + - day + - week + - month + writeOnly: true + required: + - duration + - durationType + ApdexConfiguration: + type: object + properties: + apdexEntity: + $ref: '#/components/schemas/ApdexEntity' + apdexName: + type: string + description: Name of the Apdex Configuration + maxLength: 256 + minLength: 0 + createdAt: + type: integer + format: int64 + description: Created Date of Apdex Configuration + id: + type: string + description: Apdex Configuration ID + maxLength: 64 + minLength: 0 + required: + - apdexEntity + - apdexName + - id + ApdexConfigurationInput: + type: object + properties: + apdexEntity: + $ref: '#/components/schemas/ApdexEntity' + apdexName: + type: string + description: Name of the Apdex Configuration + maxLength: 256 + minLength: 0 + required: + - apdexEntity + - apdexName + ApdexEntity: + type: object + description: Entity which holds the information of Apdex Configuration + discriminator: + mapping: + application: '#/components/schemas/ApplicationApdexEntity' + website: '#/components/schemas/WebsiteApdexEntity' + propertyName: apdexType + properties: + apdexType: + type: string + entityId: + type: string + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + type: integer + format: int32 + minimum: 1 + required: + - apdexType + - entityId + - tagFilterExpression + ApdexReport: + type: object + properties: + apdexId: + type: string + description: Apdex Configuration ID + apdexScore: + type: array + description: Apdex Score in different timestamps from starting to the ending + point + items: + type: array + description: Apdex Score in different timestamps from starting to the + ending point + items: + type: number + description: Apdex Score in different timestamps from starting to the + ending point + from: + type: integer + format: int64 + description: Starting point for the data retrieval, specified as 13 digit + Unix Timestamp milliseconds + to: + type: integer + format: int64 + description: Ending point for the data retrieval, specified as 13 digit + Unix Timestamp milliseconds + ApiCreateGroup: + type: object + properties: + members: + type: array + items: + $ref: '#/components/schemas/ApiMember' + uniqueItems: true + name: + type: string + permissionSet: + $ref: '#/components/schemas/ApiPermissionSet' + required: + - members + - name + - permissionSet + ApiCreateRole: + type: object + properties: + members: + type: array + items: + $ref: '#/components/schemas/ApiMember' + uniqueItems: true + name: + type: string + permissions: + type: array + items: + type: string + maxItems: 1024 + minItems: 0 + uniqueItems: true + required: + - name + ApiGroup: + type: object + properties: + id: + type: string + maxLength: 64 + minLength: 0 + members: + type: array + items: + $ref: '#/components/schemas/ApiMember' + uniqueItems: true + name: + type: string + permissionSet: + $ref: '#/components/schemas/ApiPermissionSet' + required: + - id + - members + - name + - permissionSet + ApiMember: + type: object + properties: + email: + type: string + name: + type: string + userId: + type: string + required: + - userId + ApiPermissionSet: + type: object + properties: + actionFilter: + $ref: '#/components/schemas/ScopeBinding' + applicationIds: + type: array + items: + $ref: '#/components/schemas/ScopeBinding' + maxItems: 1024 + minItems: 0 + uniqueItems: true + businessPerspectiveIds: + type: array + items: + $ref: '#/components/schemas/ScopeBinding' + maxItems: 1024 + minItems: 0 + uniqueItems: true + infraDfqFilter: + $ref: '#/components/schemas/ScopeBinding' + kubernetesClusterUUIDs: + type: array + items: + $ref: '#/components/schemas/ScopeBinding' + maxItems: 1024 + minItems: 0 + uniqueItems: true + kubernetesNamespaceUIDs: + type: array + items: + $ref: '#/components/schemas/ScopeBinding' + maxItems: 1024 + minItems: 0 + uniqueItems: true + mobileAppIds: + type: array + items: + $ref: '#/components/schemas/ScopeBinding' + maxItems: 1024 + minItems: 0 + uniqueItems: true + permissions: + type: array + items: + type: string + maxItems: 1024 + minItems: 0 + uniqueItems: true + restrictedApplicationFilter: + $ref: '#/components/schemas/ApiRestrictedApplicationFilter' + sloIds: + type: array + items: + $ref: '#/components/schemas/ScopeBinding' + maxItems: 1024 + minItems: 0 + uniqueItems: true + syntheticCredentialKeys: + type: array + items: + $ref: '#/components/schemas/ScopeBinding' + maxItems: 1024 + minItems: 0 + uniqueItems: true + syntheticTestIds: + type: array + items: + $ref: '#/components/schemas/ScopeBinding' + maxItems: 1024 + minItems: 0 + uniqueItems: true + websiteIds: + type: array + items: + $ref: '#/components/schemas/ScopeBinding' + maxItems: 1024 + minItems: 0 + uniqueItems: true + required: + - applicationIds + - businessPerspectiveIds + - infraDfqFilter + - kubernetesClusterUUIDs + - kubernetesNamespaceUIDs + - mobileAppIds + - permissions + - sloIds + - syntheticCredentialKeys + - syntheticTestIds + - websiteIds + ApiRestrictedApplicationFilter: + type: object + properties: + label: + type: string + restrictingApplicationId: + type: string + scope: + type: string + enum: + - INCLUDE_NO_DOWNSTREAM + - INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING + - INCLUDE_ALL_DOWNSTREAM + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + ApiRole: + type: object + properties: + id: + type: string + members: + type: array + items: + $ref: '#/components/schemas/ApiMember' + uniqueItems: true + name: + type: string + permissions: + type: array + items: + type: string + uniqueItems: true + required: + - id + - members + - name + - permissions + ApiTag: + type: object + properties: + displayName: + type: string + maxLength: 256 + minLength: 0 + id: + type: string + maxLength: 64 + minLength: 0 + required: + - displayName + - id + ApiTeam: + type: object + properties: + id: + type: string + maxLength: 64 + minLength: 0 + info: + $ref: '#/components/schemas/ApiTeamInfo' + members: + type: array + items: + $ref: '#/components/schemas/ApiTeamMember' + uniqueItems: true + scope: + $ref: '#/components/schemas/ApiTeamScope' + tag: + type: string + maxLength: 256 + minLength: 0 + required: + - tag + ApiTeamInfo: + type: object + properties: + description: + type: string + maxLength: 2048 + minLength: 0 + ApiTeamMember: + type: object + properties: + email: + type: string + name: + type: string + roles: + type: array + items: + $ref: '#/components/schemas/ApiTeamRole' + uniqueItems: true + userId: + type: string + required: + - userId + ApiTeamRole: + type: object + properties: + roleId: + type: string + roleName: + type: string + viaIdP: + type: boolean + required: + - roleId + ApiTeamScope: + type: object + properties: + accessPermissions: + type: array + items: + type: string + enum: + - LIMITED_APPLICATIONS_SCOPE + - LIMITED_WEBSITES_SCOPE + - LIMITED_KUBERNETES_SCOPE + - LIMITED_MOBILE_APPS_SCOPE + - LIMITED_INFRASTRUCTURE_SCOPE + - LIMITED_SYNTHETICS_SCOPE + - LIMITED_BIZOPS_SCOPE + - LIMITED_GEN_AI_SCOPE + - LIMITED_AUTOMATION_SCOPE + - LIMITED_LOGS_SCOPE + - LIMITED_ALERT_CHANNELS_SCOPE + - LIMITED_VSPHERE_SCOPE + - LIMITED_PHMC_SCOPE + - LIMITED_POWERVC_SCOPE + - LIMITED_ZHMC_SCOPE + - LIMITED_PCF_SCOPE + - LIMITED_OPENSTACK_SCOPE + - LIMITED_SAP_SCOPE + - LIMITED_NUTANIX_SCOPE + - LIMITED_XENSERVER_SCOPE + - LIMITED_WINDOWS_HYPERVISOR_SCOPE + - LIMITED_LINUX_KVM_HYPERVISOR_SCOPE + - LIMITED_AI_GATEWAY_SCOPE + - LIMITED_SERVICE_LEVEL_SCOPE + uniqueItems: true + actionFilter: + type: string + applications: + type: array + items: + type: string + uniqueItems: true + businessPerspectives: + type: array + items: + type: string + uniqueItems: true + infraDfqFilter: + type: string + kubernetesClusters: + type: array + items: + type: string + uniqueItems: true + kubernetesNamespaces: + type: array + items: + type: string + uniqueItems: true + logFilter: + type: string + mobileApps: + type: array + items: + type: string + uniqueItems: true + restrictedApplicationFilter: + $ref: '#/components/schemas/ApiRestrictedApplicationFilter' + sloIds: + type: array + items: + type: string + uniqueItems: true + syntheticCredentials: + type: array + items: + type: string + uniqueItems: true + syntheticTests: + type: array + items: + type: string + uniqueItems: true + tagIds: + type: array + items: + type: string + uniqueItems: true + websites: + type: array + items: + type: string + uniqueItems: true + ApiToken: + type: object + properties: + accessGrantingToken: + type: string + canConfigureAgentRunMode: + type: boolean + canConfigureAgents: + type: boolean + canConfigureAiAgents: + type: boolean + canConfigureApdex: + type: boolean + canConfigureApiTokens: + type: boolean + canConfigureApplicationSmartAlerts: + type: boolean + canConfigureApplications: + type: boolean + canConfigureAuthenticationMethods: + type: boolean + canConfigureAutomationActions: + type: boolean + canConfigureAutomationPolicies: + type: boolean + canConfigureBizops: + type: boolean + canConfigureCustomEntities: + type: boolean + canConfigureDatabaseManagement: + type: boolean + canConfigureEumApplications: + type: boolean + canConfigureEventsAndAlerts: + type: boolean + canConfigureGlobalAlertPayload: + type: boolean + canConfigureGlobalApplicationSmartAlerts: + type: boolean + canConfigureGlobalInfraSmartAlerts: + type: boolean + canConfigureGlobalLogSmartAlerts: + type: boolean + canConfigureGlobalSyntheticSmartAlerts: + type: boolean + canConfigureIntegrations: + type: boolean + canConfigureLLM: + type: boolean + canConfigureLogManagement: + type: boolean + canConfigureLogRetentionPeriod: + type: boolean + canConfigureMaintenanceWindows: + type: boolean + canConfigureMobileAppMonitoring: + type: boolean + canConfigureMobileAppSmartAlerts: + type: boolean + canConfigurePersonalApiTokens: + type: boolean + canConfigureReleases: + type: boolean + canConfigureServiceLevelCorrectionWindows: + type: boolean + canConfigureServiceLevelSmartAlerts: + type: boolean + canConfigureServiceLevels: + type: boolean + canConfigureServiceMapping: + type: boolean + canConfigureSessionSettings: + type: boolean + canConfigureSubtraces: + type: boolean + canConfigureSyntheticCredentials: + type: boolean + canConfigureSyntheticLocations: + type: boolean + canConfigureSyntheticTests: + type: boolean + canConfigureTeams: + type: boolean + canConfigureUsers: + type: boolean + canConfigureWebsiteConversions: + type: boolean + canConfigureWebsiteSmartAlerts: + type: boolean + canCreateHeapDump: + type: boolean + canCreatePublicCustomDashboards: + type: boolean + canCreateThreadDump: + type: boolean + canDeleteAutomationActionHistory: + type: boolean + canDeleteLogs: + type: boolean + canEditAllAccessibleCustomDashboards: + type: boolean + canInstallNewAgents: + type: boolean + canInvokeAlertChannel: + type: boolean + canManuallyCloseIssue: + type: boolean + canRunAutomationActions: + type: boolean + canUseSyntheticCredentials: + type: boolean + canViewAccountAndBillingInformation: + type: boolean + canViewAuditLog: + type: boolean + canViewBizAlerts: + type: boolean + canViewBusinessActivities: + type: boolean + canViewBusinessProcessDetails: + type: boolean + canViewBusinessProcesses: + type: boolean + canViewLogVolume: + type: boolean + canViewLogs: + type: boolean + canViewSyntheticLocations: + type: boolean + canViewSyntheticTestResults: + type: boolean + canViewSyntheticTests: + type: boolean + canViewTraceDetails: + type: boolean + createdBy: + type: string + createdOn: + type: integer + format: int64 + expiresOn: + type: integer + format: int64 + id: + type: string + internalId: + type: string + lastUsedOn: + type: integer + format: int64 + limitedAiGatewayScope: + type: boolean + limitedAlertChannelsScope: + type: boolean + limitedApplicationsScope: + type: boolean + limitedAutomationScope: + type: boolean + limitedBizOpsScope: + type: boolean + limitedGenAIScope: + type: boolean + limitedInfrastructureScope: + type: boolean + limitedKubernetesScope: + type: boolean + limitedLinuxKVMHypervisorScope: + type: boolean + limitedLogsScope: + type: boolean + limitedMobileAppsScope: + type: boolean + limitedNutanixScope: + type: boolean + limitedOpenstackScope: + type: boolean + limitedPcfScope: + type: boolean + limitedPhmcScope: + type: boolean + limitedPvcScope: + type: boolean + limitedSAPScope: + type: boolean + limitedServiceLevelScope: + type: boolean + limitedSyntheticsScope: + type: boolean + limitedVsphereScope: + type: boolean + limitedWebsitesScope: + type: boolean + limitedWindowsHypervisorScope: + type: boolean + limitedXenServerScope: + type: boolean + limitedZhmcScope: + type: boolean + name: + type: string + required: + - accessGrantingToken + - internalId + - name + AppDataMetricConfiguration: + type: object + properties: + aggregation: + type: string + description: 'Set aggregation that can be applied to a series of values. + Eg: `MEAN`.' + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + granularity: + type: integer + format: int32 + description: 'If the granularity is set you will get data points with the + specified granularity in seconds. Default: `1000` milliseconds' + metric: + type: string + description: 'Set a particular metric, eg: `latency`.' + numeratorTagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + required: + - aggregation + - metric + Application: + type: object + description: Returns a list of Application Perspectives. + properties: + boundaryScope: + type: string + description: Here, `ALL` Application Boundary Scope is considered. + entityType: + type: string + description: Since, this is an Application Perspective, it will be of type + `APPLICATION`. + enum: + - APPLICATION + - SERVICE + - ENDPOINT + id: + type: string + description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.' + label: + type: string + description: 'Name of the Application Perspective. Eg: `app1`.' + required: + - boundaryScope + - id + - label + ApplicationAlertConfig: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + applicationId: + type: string + writeOnly: true + applications: + type: object + additionalProperties: + $ref: '#/components/schemas/ApplicationNode' + description: Selection of applications, services, and endpoints that this + Smart Alert configuration is associated with. This selection is connected + to the defined `tagFilterExpression` by the logical `AND` operator. + boundaryScope: + type: string + description: Determines the source of the application alert configuration. + An `INBOUND` scope refers to consumer-made calls. An `ALL` scope refers + to both consumer and internally made calls. + enum: + - ALL + - INBOUND + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the application alert configuration. Used as + a template for the description of alert/event notifications triggered + by this Smart Alert configuration. + maxLength: 65536 + minLength: 0 + evaluationType: + type: string + description: Determines whether calls of the aggregated metrics are grouped + by the application, the service, or the endpoint. This also determines + whether the resulting events are categorized as an issue on the respective + entity of that group. + enum: + - PER_AP + - PER_AP_SERVICE + - PER_AP_ENDPOINT + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + includeInternal: + type: boolean + description: Flag to include Internal Calls. These calls are work done inside + a service and correspond to intermediate spans in custom tracing. + includeSynthetic: + type: boolean + description: 'Flag to include Synthetic Calls. These calls have a synthetic + endpoint as their destination, such as calls to health-check endpoints. ' + name: + type: string + description: Name of the application alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + rule: + $ref: '#/components/schemas/ApplicationAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdApplicationAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/TagFilter' + uniqueItems: true + writeOnly: true + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/ApplicationTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + required: + - alertChannelIds + - applications + - boundaryScope + - customPayloadFields + - description + - evaluationType + - granularity + - name + - tagFilterExpression + - timeThreshold + ApplicationAlertConfigWithMetadata: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + applicationId: + type: string + deprecated: true + description: ID of the application that this Smart Alert configuration is + applied to. + maxLength: 64 + minLength: 0 + applications: + type: object + additionalProperties: + $ref: '#/components/schemas/ApplicationNode' + description: Selection of applications, services, and endpoints that this + Smart Alert configuration is associated with. This selection is connected + to the defined `tagFilterExpression` by the logical `AND` operator. + boundaryScope: + type: string + description: Determines the source of the application alert configuration. + An `INBOUND` scope refers to consumer-made calls. An `ALL` scope refers + to both consumer and internally made calls. + enum: + - ALL + - INBOUND + created: + type: integer + format: int64 + description: Unix timestamp representing the creation time of this revision. + minimum: 1 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the application alert configuration. Used as + a template for the description of alert/event notifications triggered + by this Smart Alert configuration. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. + evaluationType: + type: string + description: Determines whether calls of the aggregated metrics are grouped + by the application, the service, or the endpoint. This also determines + whether the resulting events are categorized as an issue on the respective + entity of that group. + enum: + - PER_AP + - PER_AP_SERVICE + - PER_AP_ENDPOINT + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + id: + type: string + description: 'ID of this Application App Alert Config. ' + maxLength: 64 + minLength: 0 + includeInternal: + type: boolean + description: Flag to include Internal Calls. These calls are work done inside + a service and correspond to intermediate spans in custom tracing. + includeSynthetic: + type: boolean + description: 'Flag to include Synthetic Calls. These calls have a synthetic + endpoint as their destination, such as calls to health-check endpoints. ' + initialCreated: + type: integer + format: int64 + description: Unix timestamp representing the time of the initial revision. + minimum: 1 + name: + type: string + description: Name of the application alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + readOnly: + type: boolean + description: Flag to indicate whether or not the configuration is read-only. + Read-only access restricts modification of the config. + rule: + $ref: '#/components/schemas/ApplicationAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdApplicationAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/TagFilter' + uniqueItems: true + writeOnly: true + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/ApplicationTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + required: + - alertChannelIds + - applications + - boundaryScope + - customPayloadFields + - description + - evaluationType + - granularity + - id + - name + - tagFilterExpression + - timeThreshold + ApplicationAlertRule: + type: object + discriminator: + mapping: + errorRate: '#/components/schemas/ErrorsApplicationAlertRule' + errors: '#/components/schemas/ErrorsApplicationAlertRule' + logs: '#/components/schemas/LogsApplicationAlertRule' + slowness: '#/components/schemas/SlownessApplicationAlertRule' + statusCode: '#/components/schemas/StatusCodeApplicationAlertRule' + throughput: '#/components/schemas/ThroughputApplicationAlertRule' + propertyName: alertType + properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + alertType: + type: string + metricName: + type: string + required: + - alertType + - metricName + ApplicationApdexEntity: + type: object + allOf: + - $ref: '#/components/schemas/ApdexEntity' + - type: object + properties: + boundaryScope: + type: string + description: Application Boundary Scope, it could be ALL or INBOUND + enum: + - ALL + - INBOUND + entityId: + type: string + description: Application ID + includeInternal: + type: boolean + description: A boolean value indicating whether the SLO takes Internal + calls into account + includeSynthetic: + type: boolean + description: A boolean value indicating whether the SLO takes Synthetic + calls into account + threshold: + type: integer + format: int32 + description: Value of the Apdex Threshold + minimum: 1 + required: + - boundaryScope + - entityId + - tagFilterExpression + ApplicationConfig: + type: object + properties: + accessRules: + type: array + description: | + Defines permissions and access relationships. + items: + $ref: '#/components/schemas/AccessRule' + maxItems: 64 + minItems: 1 + boundaryScope: + type: string + description: | + **INBOUND**: Inbound calls are calls initiated from outside the application and where the destination service is part of the selected application perspective. + + **ALL**: Results and metrics for not only calls at the application perspective boundary, but also those occurring within the application perspective. + + **DEFAULT**: Default value, for Application Perspectives created before the introduction of `ALL` and `INBOUND`. + At present, whenever new Application Perspectives are created, there are only 2 options to select: `ALL` or `INBOUND`. + It is recommended to use either `ALL` or `INBOUND` as `DEFAULT` is deprecated. `DEFAULT` is treated as `INBOUND`. + enum: + - ALL + - INBOUND + - DEFAULT + id: + type: string + description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.' + maxLength: 128 + minLength: 1 + label: + type: string + description: 'Name of the Application Perspective. Eg: `app1`.' + maxLength: 128 + minLength: 1 + matchSpecification: + $ref: '#/components/schemas/MatchExpressionDTO' + scope: + type: string + description: | + **INCLUDE_NO_DOWNSTREAM** : Only the selected services from the filters are included (call this the core set). + This is useful when you treat the services as opaque. + An example would be the services that represent 3rd party APIs. + + **INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING** : Include the core set of services from the filters and then expand this core set to include the database and messaging services that the core set directly interacts with. + This is useful if you are want to monitor a set of services and their direct dependencies. + For example, a development team responsible for several micro-services. + + **INCLUDE_ALL_DOWNSTREAM** : It effortlessly and automatically includes all the services that form the entire end-to-end dependency chain of the core set of services. + This is useful if the AP will be used for troubleshooting. + enum: + - INCLUDE_NO_DOWNSTREAM + - INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING + - INCLUDE_ALL_DOWNSTREAM + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + required: + - accessRules + - boundaryScope + - id + - label + - scope + ApplicationEventResult: + type: object + allOf: + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + applicationId: + type: string + description: ID of the application. + ApplicationItem: + type: object + properties: + application: + $ref: '#/components/schemas/Application' + metrics: + type: object + additionalProperties: + type: array + items: + type: array + items: + type: number + required: + - application + - metrics + ApplicationMetricResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + items: + type: array + items: + $ref: '#/components/schemas/ApplicationItem' + page: + type: integer + format: int32 + description: Page Number + minimum: 1 + pageSize: + type: integer + format: int32 + minimum: 1 + totalHits: + type: integer + format: int64 + minimum: 0 + required: + - items + ApplicationNode: + type: object + description: Selection of applications, services, and endpoints that this Smart + Alert configuration is associated with. This selection is connected to the + defined `tagFilterExpression` by the logical `AND` operator. + properties: + applicationId: + type: string + maxLength: 64 + minLength: 0 + inclusive: + type: boolean + services: + type: object + additionalProperties: + $ref: '#/components/schemas/ServiceNode' + required: + - applicationId + - services + ApplicationResult: + type: object + properties: + items: + type: array + description: Returns a list of Application Perspectives. + items: + $ref: '#/components/schemas/Application' + page: + type: integer + format: int32 + description: Page number you want to retrieve in a request / retrieved in + a response. + pageSize: + type: integer + format: int32 + description: number of elements retrieved in a single query. + totalHits: + type: integer + format: int32 + description: 'The number of results returned. For eg: If `items` has 5 elements, + `totalhits` will be 5' + ApplicationScope: + type: object + description: The list of application perspectives where the release can be viewed. + properties: + name: + type: string + description: 'Name of the Application Perspective. Eg: `app1`.' + maxLength: 256 + minLength: 0 + required: + - name + ApplicationScopeWithMetadata: + type: object + description: The list of application perspectives where the release can be viewed. + properties: + id: + type: string + description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.' + name: + type: string + description: 'Name of the Application Perspective. Eg: `app1`.' + required: + - id + ApplicationSliEntity: + type: object + allOf: + - $ref: '#/components/schemas/SliEntity' + - type: object + properties: + applicationId: + type: string + description: Specifies the ID of the Application that is to be monitored + by the SLO + boundaryScope: + type: string + description: Defines the boundary of calls to be monitored, specifying + whether to track all calls or only inbound calls + enum: + - ALL + - INBOUND + endpointId: + type: string + description: Specifies the ID of the Endpoint to be monitored by the application + SLO + serviceId: + type: string + description: Identifies the service to be monitored by the application + SLO + required: + - boundaryScope + ApplicationSloEntity: + type: object + allOf: + - $ref: '#/components/schemas/SloEntity' + - type: object + properties: + applicationId: + type: string + description: The ID of the Application + boundaryScope: + type: string + description: The Boundary Scope of the Application + enum: + - ALL + - INBOUND + endpointId: + type: string + description: The Endpoint ID of the Application + includeInternal: + type: boolean + description: A boolean value indicating whether the SLO takes Internal + calls into account + includeSynthetic: + type: boolean + description: A boolean value indicating whether the SLO takes Synthetic + calls into account + serviceId: + type: string + description: The Service ID of the Application + required: + - applicationId + - boundaryScope + ApplicationTimeThreshold: + type: object + description: The type of threshold to define the criteria when the event and + alert triggers and resolves. + discriminator: + mapping: + requestImpact: '#/components/schemas/TraceImpactApplicationTimeThreshold' + violationsInPeriod: '#/components/schemas/ViolationsInPeriodApplicationTimeThreshold' + violationsInSequence: '#/components/schemas/ViolationsInSequenceApplicationTimeThreshold' + propertyName: type + properties: + timeWindow: + type: integer + format: int64 + type: + type: string + required: + - type + ArithmeticConfiguration: + type: object + allOf: + - $ref: '#/components/schemas/InfraMetricConfiguration' + - type: object + properties: + operation: + $ref: '#/components/schemas/ArithmeticOperation' + ArithmeticOperand: + type: object + oneOf: + - $ref: '#/components/schemas/SingleValue' + - $ref: '#/components/schemas/MetricQuery' + - $ref: '#/components/schemas/NestedOperation' + ArithmeticOperation: + type: object + discriminator: + mapping: + ADDITION: '#/components/schemas/Addition' + DIVISION: '#/components/schemas/Division' + MULTIPLICATION: '#/components/schemas/Multiplication' + SUBTRACTION: '#/components/schemas/Subtraction' + propertyName: operator + properties: + left: + $ref: '#/components/schemas/ArithmeticOperand' + operator: + type: string + right: + $ref: '#/components/schemas/ArithmeticOperand' + required: + - left + - operator + - right + AuditLogEntry: + type: object + properties: + action: + type: string + actor: + $ref: '#/components/schemas/LogEntryActor' + id: + type: string + message: + type: string + meta: + type: object + additionalProperties: + type: object + timestamp: + type: integer + format: int64 + required: + - action + - actor + - id + - message + - meta + AuditLogUiResponse: + type: object + properties: + entries: + type: array + items: + $ref: '#/components/schemas/AuditLogEntry' + total: + type: integer + format: int64 + Author: + type: object + properties: + id: + type: string + type: + type: string + enum: + - API + - USER + - INSTANA + - UNKNOWN + AvailabilityBlueprintIndicator: + type: object + allOf: + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + properties: + threshold: + type: number + format: double + description: Threshold Value for the Blueprint + exclusiveMinimum: false + minimum: 0.0 + required: + - type + AvailabilitySliEntity: + type: object + allOf: + - $ref: '#/components/schemas/SliEntity' + - type: object + properties: + applicationId: + type: string + description: Specifies the ID of the Application that is to be monitored + by the SLO + badEventFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + badEventFilters: + type: array + description: Defines the logical expression to filter data and classify + events as Bad Events + items: + $ref: '#/components/schemas/TagFilter' + maxItems: 32 + minItems: 1 + boundaryScope: + type: string + description: Defines the boundary of calls to be monitored, specifying + whether to track all calls or only inbound calls + enum: + - ALL + - INBOUND + endpointId: + type: string + description: Specifies the ID of the Endpoint to be monitored by the availability-based + application SLO + goodEventFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + goodEventFilters: + type: array + description: Defines the logical expression to filter data and classify + events as Good Events + items: + $ref: '#/components/schemas/TagFilter' + maxItems: 32 + minItems: 1 + includeInternal: + type: boolean + description: Boolean value indicating whether internal calls should be + included in the monitoring process + includeSynthetic: + type: boolean + description: Boolean value indicating whether synthetic calls should be + included in the monitoring process + serviceId: + type: string + description: Identifies the service to be monitored by the availability-based + application SLO + required: + - boundaryScope + AvailableMetrics: + type: object + properties: + metrics: + type: array + items: + $ref: '#/components/schemas/MetricMetadata' + uniqueItems: true + AvailablePlugins: + type: object + properties: + plugins: + type: array + items: + type: string + uniqueItems: true + BackendTraceReference: + type: object + properties: + traceId: + type: string + description: 'The corresponding trace ID. For eg: `07eaf10c1d051234` or + `000000000000000007eaf10c1d051234`' + required: + - traceId + BidirectionalMsTeamsAppIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + apiTokenId: + type: string + channelId: + type: string + channelName: + type: string + instanaUrl: + type: string + serviceUrl: + type: string + teamId: + type: string + teamName: + type: string + tenantId: + type: string + tenantName: + type: string + required: + - apiTokenId + - channelId + - channelName + - id + - instanaUrl + - kind + - name + - teamId + - tenantId + BidirectionalSlackAppIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + appId: + type: string + channelId: + type: string + channelName: + type: string + emojiRendering: + type: boolean + status: + type: string + teamId: + type: string + teamName: + type: string + required: + - id + - kind + - name + BinaryOperatorDTO: + type: object + allOf: + - $ref: '#/components/schemas/MatchExpressionDTO' + - type: object + properties: + conjunction: + type: string + enum: + - AND + - OR + left: + $ref: '#/components/schemas/MatchExpressionDTO' + right: + $ref: '#/components/schemas/MatchExpressionDTO' + required: + - conjunction + - left + - right + BrowserScriptConfiguration: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + browser: + type: string + enum: + - chrome + - firefox + fileName: + type: string + recordVideo: + type: boolean + script: + type: string + maxLength: 1048576 + minLength: 0 + scriptType: + type: string + enum: + - Basic + - Jest + scripts: + $ref: '#/components/schemas/MultipleScriptsConfiguration' + required: + - markSyntheticCall + - syntheticType + BrowserScriptConfigurationUpdate: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - type: object + properties: + browser: + type: string + enum: + - chrome + - firefox + fileName: + type: string + recordVideo: + type: boolean + script: + type: string + scriptType: + type: string + enum: + - Basic + - Jest + scripts: + $ref: '#/components/schemas/MultipleScriptsConfiguration' + BuiltInEventSpecification: + type: object + properties: + description: + type: string + description: Description of Built-in Event Specification + maxLength: 2048 + minLength: 0 + enabled: + type: boolean + description: Flag to show whether the Built-in Event Specification is enabled + hidden: + type: boolean + description: Flag to show whether the Built-in Event Specification is hidden + hyperParams: + type: array + description: List of hyper parameters of the Built-in Event Specification + items: + $ref: '#/components/schemas/HyperParam' + maxItems: 32 + minItems: 0 + id: + type: string + description: ID of Built-in Event Specification + maxLength: 2048 + minLength: 0 + name: + type: string + description: Name of Built-in Event Specification + maxLength: 256 + minLength: 0 + ruleInputs: + type: array + description: List of input rules of the Built-in Event Specification + items: + $ref: '#/components/schemas/RuleInput' + maxItems: 32 + minItems: 0 + severity: + type: integer + format: int32 + description: Severity level of Built-in Event Specification + shortPluginId: + type: string + description: ID of short plugin of Built-in Event Specification + maxLength: 64 + minLength: 0 + triggering: + type: boolean + description: Flag to show whether the Built-in Event Specification is triggering + required: + - hyperParams + - id + - name + - ruleInputs + - shortPluginId + BuiltInEventSpecificationWithLastUpdated: + type: object + properties: + description: + type: string + description: Description of Built-in Event Specification + maxLength: 2048 + minLength: 0 + enabled: + type: boolean + description: Flag to show whether the Built-in Event Specification is enabled + hidden: + type: boolean + description: Flag to show whether the Built-in Event Specification is hidden + hyperParams: + type: array + description: List of hyper parameters of the Built-in Event Specification + items: + $ref: '#/components/schemas/HyperParam' + maxItems: 32 + minItems: 0 + id: + type: string + description: ID of Built-in Event Specification + maxLength: 2048 + minLength: 0 + lastUpdated: + type: integer + format: int64 + minimum: 1 + name: + type: string + description: Name of Built-in Event Specification + maxLength: 256 + minLength: 0 + ruleInputs: + type: array + description: List of input rules of the Built-in Event Specification + items: + $ref: '#/components/schemas/RuleInput' + maxItems: 32 + minItems: 0 + severity: + type: integer + format: int32 + description: Severity level of Built-in Event Specification + shortPluginId: + type: string + description: ID of short plugin of Built-in Event Specification + maxLength: 64 + minLength: 0 + triggering: + type: boolean + description: Flag to show whether the Built-in Event Specification is triggering + required: + - hyperParams + - id + - name + - ruleInputs + - shortPluginId + BusinessActivity: + type: object + properties: + activityId: + type: string + description: Unique identifier for the activity generated by the source + BPM tool + example: ApproveInvoiceTask + nullable: true + activityName: + type: string + description: 'Name of the activity ' + example: Approve Invoice + nullable: true + activityStart: + type: integer + format: int64 + description: Unix timestamp representing the activity's start time + example: 1680559706000 + nullable: true + activityType: + type: string + description: 'Type of the activity ' + example: userTask + callId: + type: string + writeOnly: true + endpointIds: + type: array + items: + type: string + processDefinitionId: + type: string + description: The identifier of the process the activity is an instance of. + example: invoice:2:aa2bbbcc-bb04-11ee-9d4e-0242ac110002 + nullable: true + processDefinitionName: + type: string + description: The name of the process that the activity is an instance of + example: Invoice Approval + nullable: true + rootProcessInstanceId: + type: string + description: The id of the root process for the activity + example: 486cbb3b-e633-11ee-8707-0242ac110002 + nullable: true + required: + - activityType + BusinessPerspectiveConfig: + type: object + properties: + description: + type: string + maxLength: 300 + minLength: 0 + id: + type: string + maxLength: 128 + minLength: 1 + name: + type: string + maxLength: 100 + minLength: 0 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + required: + - id + CallGroupsItem: + type: object + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + properties: + cursor: + $ref: '#/components/schemas/IngestionOffsetCursor' + metrics: + type: object + additionalProperties: + type: array + description: | + Grouped metric details like `errors.mean`, `calls.sum`. + It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`. + Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`. + items: + type: array + description: | + Grouped metric details like `errors.mean`, `calls.sum`. + It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`. + Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`. + items: + type: number + description: | + Grouped metric details like `errors.mean`, `calls.sum`. + It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`. + Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`. + description: | + Grouped metric details like `errors.mean`, `calls.sum`. + It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`. + Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`. + name: + type: string + description: Name of the group. + timestamp: + type: integer + format: int64 + description: Earliest timestamp of the call from the group + minimum: 0 + required: + - cursor + - metrics + - name + CallGroupsResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + canLoadMore: + type: boolean + description: Determine if additional data is available when a new query + is made using the cursor from the last item in the `items` list. + items: + type: array + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + items: + $ref: '#/components/schemas/CallGroupsItem' + totalHits: + type: integer + format: int64 + description: The total number of items that match a given filter + minimum: 0 + totalRepresentedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, one row can represent multiple real + items (batched call, sample multiplicity) + minimum: 0 + totalRetainedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, only a subset is retained for historic + data. Each retained row can represent multiple real items due to batching. + minimum: 0 + required: + - items + CallRelation: + type: object + description: It shows from where the call is destined to. It includes destination + service, its endpoint and list of technologies of the service. + properties: + endpoint: + $ref: '#/components/schemas/EndpointSimple' + service: + $ref: '#/components/schemas/ServiceSimple' + technologies: + type: array + description: 'List of technologies: `Eg:["springbootApplicationContainer"]`' + items: + type: string + description: 'List of technologies: `Eg:["springbootApplicationContainer"]`' + ChangeSummary: + type: object + description: Brief summary of changes made in this config version. + properties: + author: + $ref: '#/components/schemas/Author' + changeType: + type: string + enum: + - CREATE + - UPDATE + - DELETE + - ENABLE + - DISABLE + - RESTORE + - UNKNOWN + required: + - author + - changeType + CloudfoundryPhysicalContext: + type: object + description: | + Contains physical context of Cloudfoundry. It contains the following information: + 1. `application`: Application running within Cloud Foundry environment. + 2. `cfInstanceIndex`: A unique ID of the container created and managed by Garden in the Cloud Foundry environment. + 3. `organization`: Organization in the Cloud Foundry environment. + 4. `space`: Space within an organization in Cloud Foundry environment. + properties: + application: + $ref: '#/components/schemas/SnapshotPreview' + cfInstanceIndex: + type: string + description: A unique ID of the container created and managed by Garden + in the Cloud Foundry environment. + organization: + $ref: '#/components/schemas/SnapshotPreview' + space: + $ref: '#/components/schemas/SnapshotPreview' + Condition: + type: object + description: This applies to only `automatic` policy type. A Dynamic Focus Query + that selects a list of entities on which the policy is run. + properties: + query: + type: string + description: Dynamic Focus Query string that selects a list of entities + on which the policy is run. + ConfigVersion: + type: object + properties: + changeSummary: + $ref: '#/components/schemas/ChangeSummary' + created: + type: integer + format: int64 + description: Unix timestamp representing the creation time of this revision. + minimum: 1 + deleted: + type: boolean + deprecated: true + description: Flag to indicate whether or not the configuration was deleted. + enabled: + type: boolean + deprecated: true + description: Flag to indicate whether or not the configuration is enabled. + id: + type: string + description: ID of this configuration version. + maxLength: 64 + minLength: 0 + required: + - id + ContainerNode: + type: object + Correction: + type: object + properties: + activeCorrectionConfigIds: + type: array + description: IDs of correction configs that are active + items: + type: string + description: IDs of correction configs that are active + uniqueItems: true + correctionWindows: + type: array + description: List of Correction Windows + items: + $ref: '#/components/schemas/CorrectionWindow' + from: + type: string + format: date-time + description: Correction starting timestamp in milliseconds (13-digit) + inActiveCorrectionConfigIds: + type: array + description: IDs of correction configs that are inactive + items: + type: string + description: IDs of correction configs that are inactive + uniqueItems: true + to: + type: string + format: date-time + description: Correction ending timestamp in milliseconds (13-digit) + CorrectionConfiguration: + type: object + properties: + active: + type: boolean + description: If value is true, then the correction window is active + createdDate: + type: string + format: date-time + description: Created date of SLO Correction Window Configuration + description: + type: string + description: Description of the SLO Correction Window Configuration + id: + type: string + description: SLO Correction Window Configuration ID + maxLength: 64 + minLength: 0 + lastUpdated: + type: string + format: date-time + description: Last updated date of SLO Correction Window Configuration + name: + type: string + description: Name of the SLO Correction Window Configuration + scheduling: + $ref: '#/components/schemas/CorrectionScheduling' + sloIds: + type: array + description: This is the list of SLO configurations related to this Correction + Window. + items: + type: string + description: This is the list of SLO configurations related to this Correction + Window. + maxItems: 1024 + minItems: 0 + uniqueItems: true + tags: + type: array + description: List of tags associated with SLO Correction Window Configuration + items: + type: string + description: List of tags associated with SLO Correction Window Configuration + uniqueItems: true + required: + - name + - scheduling + CorrectionScheduling: + type: object + description: Time scheduling of the SLO Correction Window configurations. + properties: + duration: + type: integer + format: int32 + description: Duration of the correction window, defined by the count of + time units. + durationUnit: + type: string + description: 'Unit for duration. Supported values: `MINUTE`, `HOUR`, `DAY`.' + enum: + - millisecond + - second + - minute + - hour + - day + - week + - month + recurrent: + type: boolean + recurrentRule: + type: string + description: 'Recurrence Rule defines how the event recurs, using iCalendar + RRULE format (e.g., `FREQ=DAILY;INTERVAL=1`).It supports fields like FREQ, + INTERVAL, BYDAY, etc. Refer to RFC 5545: https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10' + maxLength: 2048 + minLength: 0 + startTime: + type: string + format: date-time + description: Start time of the correction window in milliseconds since epoch + (UTC) (e.g., `1706713140000`). + required: + - duration + - durationUnit + CorrectionWindow: + type: object + description: List of Correction Windows + properties: + correctionConfigs: + type: array + description: IDs of the Correction configurations in the Correction Window + items: + type: string + description: IDs of the Correction configurations in the Correction Window + uniqueItems: true + from: + type: string + format: date-time + description: Correction Window starting timestamp in milliseconds (13-digit) + sloConfigs: + type: array + description: IDs of the SLO configurations in the Correction Window + items: + type: string + description: IDs of the SLO configurations in the Correction Window + uniqueItems: true + to: + type: string + format: date-time + description: Correction Window ending timestamp in milliseconds (13-digit) + CrashMobileAppAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/MobileAppAlertRule' + required: + - metricName + CursorPaginatedBusinessActivityItem: + type: object + properties: + businessActivity: + $ref: '#/components/schemas/BusinessActivity' + cursor: + $ref: '#/components/schemas/IngestionOffsetCursor' + metrics: + type: object + additionalProperties: + type: array + items: + type: array + items: + type: number + required: + - cursor + CursorPagination: + type: object + description: | + Details for controlling the pagination of the API response. + This object allows you to define the starting point for retrieving records, how many records to skip, and the size of the result set. + properties: + ingestionTime: + type: integer + format: int64 + description: | + The timestamp indicating the starting point from which data was ingested. + The format of the timestamp is in Unix epoch Time. + For example, `Thursday, 5 September 2024 07:03:13 GMT` can be represented as `1725519793`. + offset: + type: integer + format: int32 + description: | + The number of records to be skipped from the `ingestionTime`. + For example: when `offset` is 20 and `ingestionTime` is 1725519793, the API response should have records starting from the 21st record after the specified `ingestionTime`. + Note that if `offset` value is not empty, `ingestionTime` can't be empty. + retrievalSize: + type: integer + format: int32 + description: | + The number of records to retrieve in a single request. + For example, when retrievalSize is set to 30, offset is 20, and ingestionTime is 1725519793, the API request will fetch 30 records starting from the 21st record after the specified `ingestionTime`. + Minimum value is 1 and maximum value is 200. + maximum: 200 + minimum: 1 + CursorPaginationInfraExploreCursor: + type: object + properties: + cursor: + $ref: '#/components/schemas/InfraExploreCursor' + retrievalSize: + type: integer + format: int32 + description: number of values to return + required: + - retrievalSize + CustomBlueprintIndicator: + type: object + allOf: + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + properties: + badEventInfraMetric: + type: string + badEventsFilter: + $ref: '#/components/schemas/TagFilterExpressionElement' + goodEventInfraMetric: + type: string + goodEventsFilter: + $ref: '#/components/schemas/TagFilterExpressionElement' + required: + - goodEventsFilter + - type + CustomDashboard: + type: object + properties: + accessRules: + type: array + items: + $ref: '#/components/schemas/AccessRule' + maxItems: 64 + minItems: 1 + id: + type: string + title: + type: string + widgets: + type: array + items: + $ref: '#/components/schemas/Widget' + maxItems: 128 + minItems: 0 + uniqueItems: true + required: + - accessRules + - id + - title + - widgets + CustomDashboardPreview: + type: object + properties: + annotations: + type: array + items: + type: string + enum: + - SHARED + - WRITABLE + maxItems: 8 + minItems: 0 + uniqueItems: true + id: + type: string + maxLength: 64 + minLength: 0 + ownerId: + type: string + title: + type: string + required: + - annotations + - id + - ownerId + - title + CustomDashboardWithUserSpecificInformation: + type: object + properties: + accessRules: + type: array + items: + $ref: '#/components/schemas/AccessRule' + maxItems: 64 + minItems: 1 + id: + type: string + ownerId: + type: string + title: + type: string + widgets: + type: array + items: + $ref: '#/components/schemas/Widget' + maxItems: 128 + minItems: 0 + uniqueItems: true + writable: + type: boolean + required: + - accessRules + - id + - ownerId + - title + - widgets + - writable + CustomDependency: + type: object + properties: + direction: + type: string + enum: + - outgoing + - incoming + maxLength: 64 + minLength: 1 + entityType: + type: string + description: If entityType is set, the dependency will be added to the plugin + for that entity type. Otherwise, the dependency will be applied to the + custom entity itself. + maxLength: 64 + minLength: 0 + identifiers: + type: array + description: Will take the identifiers values for building the key of the + dependency. + items: + type: string + description: Will take the identifiers values for building the key of + the dependency. + maxItems: 512 + minItems: 0 + uniqueItems: true + name: + type: string + maxLength: 256 + minLength: 1 + separator: + type: string + description: Separator between identifiers for building the key of the dependency. + type: + type: string + enum: + - in + - is + - to + - of + - connected + - describes + - of20 + - to20 + - dummy + - parent + maxLength: 8 + minLength: 1 + CustomEmailSubjectPrefix: + type: object + properties: + agentMonitoringIssue: + type: object + additionalProperties: + type: string + description: A map containing the open and close email subject value of + a given agent monitoring issue + example: '{"openValue":"Open email subject prefix value","closeValue":"Close + email subject prefix value"}' + description: A map containing the open and close email subject value of + a given agent monitoring issue + example: + closeValue: Close email subject prefix value + openValue: Open email subject prefix value + change: + type: object + additionalProperties: + type: string + description: A map containing the open and close email subject value of + a given change event + example: '{"changeValue":"Email subject prefix value"}' + description: A map containing the open and close email subject value of + a given change event + example: + changeValue: Email subject prefix value + incident: + type: object + additionalProperties: + type: string + description: A map containing the open and close email subject value of + a given incident + example: '{"openValue":"Open email subject prefix value","closeValue":"Close + email subject prefix value"}' + description: A map containing the open and close email subject value of + a given incident + example: + closeValue: Close email subject prefix value + openValue: Open email subject prefix value + issue: + type: object + additionalProperties: + type: string + description: A map containing the open and close email subject value of + a given issue + example: '{"openValue":"Open email subject prefix value","closeValue":"Close + email subject prefix value"}' + description: A map containing the open and close email subject value of + a given issue + example: + closeValue: Close email subject prefix value + openValue: Open email subject prefix value + CustomEntityModel: + type: object + properties: + dashboards: + type: array + items: + $ref: '#/components/schemas/CustomDashboard' + uniqueItems: true + dependencies: + type: array + items: + $ref: '#/components/schemas/CustomDependency' + uniqueItems: true + identifiers: + type: array + items: + type: string + label: + type: string + metrics: + type: array + items: + $ref: '#/components/schemas/CustomMetric' + uniqueItems: true + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + required: + - identifiers + - label + - tagFilterExpression + CustomEntityWithMetadata: + type: object + properties: + created: + type: integer + format: int64 + data: + $ref: '#/components/schemas/CustomEntityModel' + id: + type: string + version: + type: string + required: + - data + - id + CustomEventMobileAppAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/MobileAppAlertRule' + - type: object + properties: + customEventName: + type: string + required: + - aggregation + - customEventName + - metricName + CustomEventSpecification: + type: object + properties: + actions: + type: array + items: + $ref: '#/components/schemas/Action' + description: + type: string + maxLength: 32765 + minLength: 0 + enabled: + type: boolean + entityType: + type: string + maxLength: 64 + minLength: 0 + expirationTime: + type: integer + format: int64 + name: + type: string + maxLength: 256 + minLength: 0 + query: + type: string + maxLength: 2048 + minLength: 0 + ruleLogicalOperator: + type: string + description: Set AND / OR + enum: + - AND + - OR + rules: + type: array + items: + $ref: '#/components/schemas/AbstractRule' + maxItems: 5 + minItems: 1 + transientEventAlertMuted: + type: boolean + transientEventEnabled: + type: boolean + transientEventThreshold: + type: integer + format: int64 + triggering: + type: boolean + required: + - entityType + - name + - rules + CustomEventSpecificationWithLastUpdated: + type: object + properties: + actions: + type: array + items: + $ref: '#/components/schemas/Action' + applicationAlertConfigId: + type: string + maxLength: 64 + minLength: 0 + deleted: + type: boolean + description: + type: string + maxLength: 32765 + minLength: 0 + enabled: + type: boolean + entityType: + type: string + maxLength: 64 + minLength: 0 + expirationTime: + type: integer + format: int64 + id: + type: string + maxLength: 64 + minLength: 0 + lastUpdated: + type: integer + format: int64 + minimum: 1 + migrated: + type: boolean + name: + type: string + maxLength: 256 + minLength: 0 + query: + type: string + maxLength: 2048 + minLength: 0 + ruleLogicalOperator: + type: string + description: Set AND / OR + enum: + - AND + - OR + rules: + type: array + items: + $ref: '#/components/schemas/AbstractRule' + maxItems: 5 + minItems: 1 + transientEventAlertMuted: + type: boolean + transientEventEnabled: + type: boolean + transientEventThreshold: + type: integer + format: int64 + triggering: + type: boolean + required: + - entityType + - id + - name + - rules + CustomEventWebsiteAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/WebsiteAlertRule' + - type: object + properties: + customEventName: + type: string + required: + - aggregation + - customEventName + - metricName + CustomMetric: + type: object + properties: + aggregation: + type: string + description: Aggregation to apply on the metric for every member. + enum: + - AVG + - SUM + category: + type: string + description: Category of the metric in the catalog + description: + type: string + description: Description to be used in the catalog + formatter: + type: string + description: | + | + * NUMBER: Generic number + * BYTES: Number of bytes + * KILO_BYTES: Number of kilobytes + * MEGA_BYTES: Number of megabytes + * PERCENTAGE: Percentage in scale [0,1] + * PERCENTAGE_100: Percentage in scale [0,100] + * PERCENTAGE_NO_CAPPING: Percentage in scale [0,1] but value could exceed 1 for example when metric is aggregated + * PERCENTAGE_100_NO_CAPPING: Percentage in scale [0,100] but value could exceed 100 for example when metric is aggregated + * LATENCY: Time in milliseconds, with value of 0 should not be considered a a strict 0, but considered as < 1ms + * NANOS: Time in nanoseconds + * MILLIS: Time in milliseconds + * MICROS: Time in microseconds + * SECONDS: Time in seconds + * RATE: Number of occurrences per second + * BYTE_RATE: Number of bytes per second + * UNDEFINED: Metric value unit is not known + enum: + - NUMBER + - BYTES + - KILO_BYTES + - MEGA_BYTES + - PERCENTAGE + - PERCENTAGE_100 + - PERCENTAGE_NO_CAPPING + - PERCENTAGE_100_NO_CAPPING + - LATENCY + - NANOS + - MILLIS + - MICROS + - SECONDS + - RATE + - BYTE_RATE + - UNDEFINED + label: + type: string + description: Label to be used in the catalog + name: + type: string + description: Name of the metric + section: + type: string + description: Section of the metric in the catalog + enum: + - ACE + - ALICLOUD + - AWS + - AZURE + - CASSANDRA + - CLOUD_FOUNDRY + - CLR + - COCKROACH + - CONSUL + - CONTAINER + - COUCHBASE + - DFQ + - ELASTICSEARCH + - GCP + - HADOOP_YARN + - HAZELCAST + - IBM_CLOUD + - IBM_DATAPOWER + - IBM_I_SERIES + - IBM_MQ + - IBM_MQMFT + - IBM_OPENSTACK + - KAFKA_CONNECT + - KUBERNETES + - MONGO_DB + - OTHERS + - REDIS + - SAP + - SELF_MONITORING + - SOLR + - SPARK + - TIBCOBW + - TUXEDO + - VSHPERE + - WEBSPHERE + - CUSTOM_ENTITY + source: + type: string + description: Name of the source metric + type: + type: string + description: Type of entity for the source metric + CustomPayloadConfiguration: + type: object + properties: + fields: + type: array + description: Required parameters for custom payload configuration. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + required: + - fields + CustomPayloadField: + type: object + description: Custom payload fields to send additional information in the alert + notifications. Can be left empty. + discriminator: + mapping: + dynamic: '#/components/schemas/DynamicField' + staticString: '#/components/schemas/StaticStringField' + propertyName: type + properties: + key: + type: string + description: A user-specified unique identifier or name for a custom payload + entry. + type: + type: string + required: + - key + - type + CustomPayloadWithLastUpdated: + type: object + properties: + fields: + type: array + description: Required parameters for custom payload configuration. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + lastUpdated: + type: integer + format: int64 + description: Unix timestamp representing the time (in milliseconds) the + configuration was last updated. + minimum: 1 + required: + - fields + CustomPayloadWithVersion: + type: object + properties: + fields: + type: array + description: Required parameters for custom payload configuration. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + lastUpdated: + type: integer + format: int64 + description: Unix timestamp representing the time (in milliseconds) the + configuration was last updated. + minimum: 1 + version: + type: integer + format: int32 + description: Global custom payloads version. + required: + - fields + - version + DNSConfiguration: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + acceptCNAME: + type: boolean + lookup: + type: string + lookupServerName: + type: boolean + port: + type: integer + format: int32 + queryTime: + $ref: '#/components/schemas/DNSFilterQueryTime' + queryType: + type: string + enum: + - ALL + - ALL_CONDITIONS + - ANY + - A + - AAAA + - CNAME + - NS + recursiveLookups: + type: boolean + server: + type: string + serverRetries: + type: integer + format: int32 + targetValues: + type: array + items: + $ref: '#/components/schemas/DNSFilterTargetValue' + transport: + type: string + enum: + - TCP + - UDP + required: + - lookup + - markSyntheticCall + - server + - syntheticType + DNSConfigurationUpdate: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - type: object + properties: + acceptCNAME: + type: boolean + lookup: + type: string + lookupServerName: + type: boolean + port: + type: integer + format: int32 + queryTime: + $ref: '#/components/schemas/DNSFilterQueryTime' + queryType: + type: string + enum: + - ALL + - ALL_CONDITIONS + - ANY + - A + - AAAA + - CNAME + - NS + recursiveLookups: + type: boolean + server: + type: string + serverRetries: + type: integer + format: int32 + targetValues: + $ref: '#/components/schemas/SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue' + transport: + type: string + enum: + - TCP + - UDP + DNSFilterQueryTime: + type: object + properties: + key: + type: string + operator: + type: string + enum: + - CONTAINS + - EQUALS + - GREATER_THAN + - IS + - LESS_THAN + - MATCHES + - NOT_MATCHES + value: + type: integer + format: int64 + required: + - key + - operator + - value + DNSFilterTargetValue: + type: object + properties: + key: + type: string + enum: + - ALL + - ALL_CONDITIONS + - ANY + - A + - AAAA + - CNAME + - NS + operator: + type: string + enum: + - CONTAINS + - EQUALS + - GREATER_THAN + - IS + - LESS_THAN + - MATCHES + - NOT_MATCHES + value: + type: string + required: + - key + - operator + - value + DashboardApiToken: + type: object + properties: + id: + type: string + name: + type: string + required: + - id + - name + DatabaseIntegration: + type: object + properties: + type: + type: string + url: + type: string + DeprecatedTagFilter: + type: object + properties: + entity: + type: string + enum: + - NOT_APPLICABLE + - DESTINATION + - SOURCE + name: + type: string + operator: + type: string + enum: + - EQUALS + - CONTAINS + - LESS_THAN + - LESS_OR_EQUAL_THAN + - GREATER_THAN + - GREATER_OR_EQUAL_THAN + - NOT_EMPTY + - NOT_EQUAL + - NOT_CONTAIN + - IS_EMPTY + - NOT_BLANK + - IS_BLANK + - STARTS_WITH + - ENDS_WITH + - NOT_STARTS_WITH + - NOT_ENDS_WITH + - REGEX_MATCH + value: + type: string + required: + - name + - operator + - value + Division: + type: object + allOf: + - $ref: '#/components/schemas/ArithmeticOperation' + required: + - left + - right + Duration: + type: object + properties: + amount: + type: integer + format: int64 + minimum: 1 + unit: + type: string + enum: + - MINUTES + - HOURS + - DAYS + required: + - amount + - unit + DynamicField: + type: object + allOf: + - $ref: '#/components/schemas/CustomPayloadField' + - type: object + properties: + value: + $ref: '#/components/schemas/DynamicFieldValue' + required: + - key + - value + DynamicFieldValue: + type: object + properties: + key: + type: string + description: 'Key for selected dynamic tag: specifies which dictionary style + value user is interested in.' + tagName: + type: string + description: Each dynamic payload entry is associated with tag from Instana's + tag catalog + required: + - tagName + DynamicParameter: + type: object + description: List of dynamic parameters + properties: + key: + type: string + description: Parameter key + name: + type: string + description: Parameter name + resolvedValue: + type: string + description: Parameter value after resolution + tagName: + type: string + description: 'The name of the tag. Eg: `call.name`' + EditUser: + type: object + properties: + fullName: + type: string + required: + - fullName + EmailIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + customEmailSubjectPrefix: + $ref: '#/components/schemas/CustomEmailSubjectPrefix' + emails: + type: array + items: + type: string + required: + - emails + - id + - kind + - name + EmptyConfiguration: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + required: + - markSyntheticCall + - syntheticType + Endpoint: + type: object + properties: + entityType: + type: string + description: Since, this is a Endpoint, it will be of type `ENDPOINT`. + enum: + - APPLICATION + - SERVICE + - ENDPOINT + id: + type: string + description: 'Unique ID of the Endpoint. Eg: `NCRq5oYnan5x-PkdTPQwLLUdu5M`.' + isSynthetic: + type: boolean + writeOnly: true + label: + type: string + description: 'Name of the Endpoint. Eg: `GET /api/fetch`.' + serviceId: + type: string + description: The serviceId this endpoint belongs to. + synthetic: + type: boolean + syntheticType: + type: string + enum: + - NON_SYNTHETIC + - SYNTHETIC + - MIXED + technologies: + type: array + description: 'List of technologies: `Eg:["springbootApplicationContainer"]`' + items: + type: string + description: 'List of technologies: `Eg:["springbootApplicationContainer"]`' + uniqueItems: true + type: + type: string + description: The type of the Endpoint. + enum: + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - DATABASE + - MESSAGING + - PAGE + - PAGE_RESOURCE + required: + - id + - label + - serviceId + - technologies + - type + EndpointConfig: + type: object + properties: + endpointCase: + type: string + description: "This represents case sensitivity of endpoints of a service.\n\ + Let's say in a service there are three endpoints, `user`, `Order` and\ + \ `PAYMENT`: \n\nFor example, if `endpointCase` is `UPPER`, then endpoint\ + \ names are converted to `USER`, `ORDER` and `PAYMENT`. \n\nIf `endpointCase`\ + \ is `LOWER`, then endpoint names are converted to `user`, `order` and\ + \ `payment`. \n\nIf `endpointCase` is `ORIGINAL`, then endpoint names\ + \ are converted to `user`, `Order` and `PAYMENT`.\n" + enum: + - ORIGINAL + - LOWER + - UPPER + endpointNameByCollectedPathTemplateRuleEnabled: + type: boolean + description: | + The highest default precedence of endpoint rule is creating endpoint is based on path template. For example, + ``` + /hospital/1948/patient/291148 + /hospital/728/patient/924892 + /hospital/47/patient/25978 + /hospital/108429/patient/1847 + ``` + can be considered as `/hospital/{hid}/patient/{pid}` if this rule is enabled. For most of the use cases, this rule should be enabled. + endpointNameByFirstPathSegmentRuleEnabled: + type: boolean + description: | + There are endpoint extraction rules in Instana which take the first path segment from the HTTP request and turn this into an endpoint name. + For example, given the following URLs `/users/123/profile` and `/users/123/settings`, the extraction rule will only take the first segment. As a result endpoint name will be `users`. + Although this is useful in cases where broad overview of monitoring is required, lot of use cases are more specified. + Considering the above example, if this rule is enabled, Instana can't distinguish between `profile` or `settings` as endpoints. + For use cases where endpoints has to be monitored at fine granular level, this flag should be set to `false`. + rules: + type: array + description: Specify custom rule configuration apart from Instana predefined + rules. This rule has the highest precedence. This is only available for + HTTP endpoints. + items: + $ref: '#/components/schemas/HttpEndpointRule' + maxItems: 500 + minItems: 1 + serviceId: + type: string + description: | + An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + required: + - endpointCase + - serviceId + EndpointEventResult: + type: object + allOf: + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + applicationId: + type: string + description: ID of the application this endpoint is in scope of. + endpointId: + type: string + description: ID of the endpoint. + endpointServiceId: + type: string + description: ID service related to this endpoint. + EndpointItem: + type: object + properties: + endpoint: + $ref: '#/components/schemas/Endpoint' + metrics: + type: object + additionalProperties: + type: array + items: + type: array + items: + type: number + required: + - endpoint + - metrics + EndpointMetricResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + items: + type: array + items: + $ref: '#/components/schemas/EndpointItem' + page: + type: integer + format: int32 + description: Page Number + minimum: 1 + pageSize: + type: integer + format: int32 + minimum: 1 + totalHits: + type: integer + format: int64 + minimum: 0 + required: + - items + EndpointNode: + type: object + properties: + endpointId: + type: string + maxLength: 64 + minLength: 0 + inclusive: + type: boolean + required: + - endpointId + EndpointResult: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Endpoint' + page: + type: integer + format: int32 + description: Page number you want to retrieve in a request / retrieved in + a response. + pageSize: + type: integer + format: int32 + description: number of elements retrieved in a single query. + totalHits: + type: integer + format: int32 + description: 'The number of results returned. For eg: If `items` has 5 elements, + `totalhits` will be 5' + EndpointSimple: + type: object + description: The destination service's endpoint where the call enters. + properties: + id: + type: string + description: 'Unique ID of the Endpoint. Eg: `NCRq5oYnan5x-PkdTPQwLLUdu5M`.' + label: + type: string + description: 'Name of the Endpoint. Eg: `GET /api/fetch`.' + type: + type: string + description: The type of the Endpoint. + enum: + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - DATABASE + - MESSAGING + - PAGE + - PAGE_RESOURCE + EntityCountRule: + type: object + allOf: + - $ref: '#/components/schemas/AbstractRule' + - type: object + properties: + conditionOperator: + type: string + enum: + - '>' + - '>=' + - < + - <= + - = + - '!=' + conditionValue: + type: number + format: double + required: + - conditionOperator + EntityCountVerificationRule: + type: object + allOf: + - $ref: '#/components/schemas/AbstractRule' + - type: object + properties: + conditionOperator: + type: string + enum: + - '>' + - '>=' + - < + - <= + - = + - '!=' + conditionValue: + type: number + format: double + matchingEntityLabel: + type: string + maxLength: 2048 + minLength: 0 + matchingEntityType: + type: string + maxLength: 64 + minLength: 0 + matchingOperator: + type: string + enum: + - is + - contains + - startsWith + - endsWith + required: + - conditionOperator + - matchingEntityLabel + - matchingEntityType + - matchingOperator + EntityHealthInfo: + type: object + properties: + maxSeverity: + type: number + format: double + maximum: 10 + minimum: 0 + openIssues: + type: array + items: + $ref: '#/components/schemas/Event' + uniqueItems: true + required: + - openIssues + EntityId: + type: object + properties: + host: + type: string + pluginId: + type: string + description: Plugin name + steadyId: + type: string + description: Steady identifier for the entity. + required: + - host + - pluginId + - steadyId + EntityVerificationRule: + type: object + allOf: + - $ref: '#/components/schemas/AbstractRule' + - type: object + properties: + matchingEntityLabel: + type: string + maxLength: 2048 + minLength: 0 + matchingEntityType: + type: string + maxLength: 64 + minLength: 0 + matchingOperator: + type: string + enum: + - is + - contains + - startsWith + - endsWith + offlineDuration: + type: integer + format: int64 + required: + - matchingEntityLabel + - matchingEntityType + - matchingOperator + ErrorBudgetAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/ServiceLevelsAlertRule' + - type: object + properties: + metric: + type: string + description: This is the service levels metric type. Error budget alert + uses BURNED_PERCENTAGE, BURN_RATE (Deprecated) + or BURN_RATE_V2 metric. + enum: + - BURN_RATE + - BURNED_PERCENTAGE + - BURN_RATE_V2 + required: + - metric + ErrorsApplicationAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/ApplicationAlertRule' + required: + - metricName + Event: + type: object + properties: + affectedEntities: + type: array + items: + type: string + uniqueItems: true + end: + type: integer + format: int64 + minimum: 1 + endpointServiceId: + type: string + maxLength: 64 + minLength: 0 + entityId: + type: string + maxLength: 64 + minLength: 0 + entityType: + type: string + enum: + - Entity10 + - App20 + - Service20 + - Endpoint20 + - Website + - Synthetic + - MobileApp + - Log + eventConfigurationType: + type: string + id: + type: string + maxLength: 64 + minLength: 0 + longFormPluginId: + type: string + metadata: + type: object + additionalProperties: + type: object + metricAccessId: + type: string + maxLength: 64 + minLength: 0 + plugin: + type: string + maxLength: 256 + minLength: 0 + problem: + $ref: '#/components/schemas/Problem' + rca: + type: object + additionalProperties: + type: object + shortCode: + type: string + maxLength: 64 + minLength: 0 + start: + type: integer + format: int64 + minimum: 1 + state: + type: string + maxLength: 8 + minLength: 0 + type: + type: string + maxLength: 64 + minLength: 0 + required: + - entityId + - id + - plugin + - state + - type + EventFilteringConfiguration: + type: object + description: Event Filter Configuration for supporting the scope of the Alert + Configuration. Applies a filter based on the application perspective or selected + entities. + properties: + applicationAlertConfigIds: + type: array + items: + type: string + maxItems: 1024 + minItems: 0 + uniqueItems: true + eventTypes: + type: array + items: + type: string + enum: + - incident + - critical + - warning + - change + - online + - offline + - agent_monitoring_issue + - cve_issue + - none + maxItems: 1024 + minItems: 0 + uniqueItems: true + query: + type: string + maxLength: 2048 + minLength: 0 + ruleIds: + type: array + items: + type: string + maxItems: 1024 + minItems: 0 + uniqueItems: true + EventResult: + type: object + discriminator: + mapping: + APPLICATION: '#/components/schemas/ApplicationEventResult' + ENDPOINT: '#/components/schemas/EndpointEventResult' + INFRASTRUCTURE: '#/components/schemas/InfraEventResult' + LOG: '#/components/schemas/LogEventResult' + MOBILE_APP: '#/components/schemas/MobileAppEventResult' + SERVICE: '#/components/schemas/ServiceEventResult' + SYNTHETICS: '#/components/schemas/SyntheticsEventResult' + WEBSITE: '#/components/schemas/WebsiteEventResult' + propertyName: entityType + properties: + detail: + type: string + description: Details of the event. + end: + type: integer + format: int64 + description: A Unix timestamp representing the end time of the Event. + entityLabel: + type: string + description: The label of the affected entity of the event. + entityName: + type: string + description: The name or type of the affected entity of the event. + entityType: + type: string + description: The category of the affected entity. + eventId: + type: string + description: ID of this Event. + eventSpecificationId: + type: string + description: ID of the configuration that created this event. + fixSuggestion: + type: string + deprecated: true + description: Details of the event. + metrics: + type: array + description: List of metrics associated with the Event. + items: + type: object + additionalProperties: + type: object + description: List of metrics associated with the Event. + description: List of metrics associated with the Event. + probableCause: + type: object + additionalProperties: + type: object + description: Metadata of the probable root cause for this event. Only + present in case of specific "Incident" type events. + description: Metadata of the probable root cause for this event. Only present + in case of specific "Incident" type events. + problem: + type: string + description: Main problem title of the Event. + recentEvents: + type: array + description: List of related recent events. Only present in case of "Incident" + type events. + items: + type: object + additionalProperties: + type: object + description: List of related recent events. Only present in case of + "Incident" type events. + description: List of related recent events. Only present in case of "Incident" + type events. + severity: + type: integer + format: int32 + description: The severity of the Event when triggered. + shortCode: + type: string + description: A short code for the event + snapshotId: + type: string + deprecated: true + description: The snapshot ID of the affected entity of this event. + start: + type: integer + format: int64 + description: A Unix timestamp representing the start time of the Event. + state: + type: string + description: 'The state of the Event, "open" or "close". ' + type: + type: string + description: The type of Event. + EventSpecificationInfo: + type: object + properties: + description: + type: string + enabled: + type: boolean + entityType: + type: string + id: + type: string + maxLength: 64 + minLength: 0 + invalid: + type: boolean + migrated: + type: boolean + name: + type: string + maxLength: 256 + minLength: 0 + severity: + type: integer + format: int32 + triggering: + type: boolean + type: + type: string + enum: + - BUILT_IN + - CUSTOM + required: + - entityType + - id + - name + - type + ExtendedService: + type: object + description: List of services in the topology. + properties: + applications: + type: array + items: + type: string + uniqueItems: true + entityType: + type: string + description: Since, this is a Service, it will be of type `SERVICE`. + enum: + - APPLICATION + - SERVICE + - ENDPOINT + id: + type: string + description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.' + label: + type: string + description: 'Name of the Service. Eg: `payment`.' + maxSeverity: + type: number + format: double + maximum: 10 + minimum: 0 + numberOfOpenIssues: + type: integer + format: int32 + minimum: 0 + snapshotIds: + type: array + description: A unique identifier the metrics are assigned to. + items: + type: string + description: A unique identifier the metrics are assigned to. + uniqueItems: true + technologies: + type: array + description: 'List of technologies: `Eg:["springbootApplicationContainer"]`' + items: + type: string + description: 'List of technologies: `Eg:["springbootApplicationContainer"]`' + uniqueItems: true + types: + type: array + description: 'Shows types of Endpoints a Service can consist of. It may + be one or more. Eg: `HTTP` `OPENTELEMETRY` can be in 1 Service.' + items: + type: string + description: 'Shows types of Endpoints a Service can consist of. It may + be one or more. Eg: `HTTP` `OPENTELEMETRY` can be in 1 Service.' + enum: + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - DATABASE + - MESSAGING + - PAGE + - PAGE_RESOURCE + uniqueItems: true + required: + - applications + - id + - label + - snapshotIds + - technologies + - types + FailureSyntheticAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticAlertRule' + required: + - metricName + Field: + type: object + description: List of fields that describe an action. + properties: + description: + type: string + encoding: + type: string + name: + type: string + secured: + type: boolean + value: + type: string + required: + - encoding + - name + - value + FixedHttpPathSegmentMatchingRule: + type: object + allOf: + - $ref: '#/components/schemas/HttpPathSegmentMatchingRule' + - type: object + properties: + name: + type: string + description: | + Given `/api/{version}/users` URI, `FIXED` names are `api` and `users` in order. + required: + - name + - type + FixedTimeWindow: + type: object + allOf: + - $ref: '#/components/schemas/TimeWindow' + - type: object + properties: + startTimestamp: + type: string + format: date-time + description: The timestamp at which the fixed time window of the SLO starts + required: + - duration + - durationUnit + - startTimestamp + GenericInfraAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/InfraAlertRule' + - type: object + properties: + metricGroupBy: + type: array + items: + type: string + maxItems: 1 + minItems: 0 + required: + - aggregation + - crossSeriesAggregation + - entityType + - metricGroupBy + - metricName + - metricTagFilterExpression + GeoLocationConfiguration: + type: object + properties: + geoDetailRemoval: + type: string + enum: + - NO_REMOVAL + - REMOVE_COORDINATES + - REMOVE_CITY + - REMOVE_ALL + geoMappingRules: + type: array + items: + $ref: '#/components/schemas/GeoMappingRule' + maxItems: 512 + minItems: 0 + required: + - geoDetailRemoval + GeoMappingRule: + type: object + properties: + accuracyRadius: + type: integer + format: int64 + minimum: -1 + cidr: + type: string + maxLength: 128 + minLength: 0 + city: + type: string + continent: + type: string + continentCode: + type: string + country: + type: string + countryCode: + type: string + latitude: + type: number + format: double + leastSpecificSubdivision: + $ref: '#/components/schemas/GeoSubdivision' + longitude: + type: number + format: double + subdivisions: + type: array + items: + $ref: '#/components/schemas/GeoSubdivision' + maxItems: 8 + minItems: 0 + required: + - cidr + - subdivisions + GeoSubdivision: + type: object + properties: + code: + type: string + maxLength: 32 + minLength: 0 + name: + type: string + maxLength: 256 + minLength: 0 + required: + - name + GetActivities: + type: object + properties: + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/Pagination' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + timeframe: + $ref: '#/components/schemas/TimeFrame' + required: + - order + - pagination + - timeFrame + GetApplicationMetrics: + type: object + properties: + includeInternal: + type: boolean + writeOnly: true + includeSynthetic: + type: boolean + writeOnly: true + metrics: + type: array + items: + $ref: '#/components/schemas/AppDataMetricConfiguration' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - metrics + - timeFrame + GetApplications: + type: object + properties: + applicationBoundaryScope: + type: string + description: "Use when querying calls of an application:\n `INBOUND`: only\ + \ inbound calls \n `ALL`: all the calls to that application (inbound +\ + \ internal)" + enum: + - ALL + - INBOUND + applicationId: + type: string + description: | + An Instana generated unique identifier for an Application. If specified, the list of results will be filtered for the specified Application ID. Eg: `Av62RoIKQv-A3n6DbMQh9g`. + One can see the application id from Instana UI by going to an Application Perspective page. In the URL, there will be `appId=Av62RoIKQv-A3n6DbMQh9g`. + Alternatively, one can use `Get applications` API endpoint to get the application id in `id` parameter. + maxLength: 64 + minLength: 0 + endpointId: + type: string + description: | + An Instana generated unique identifier for an Endpoint. If specified, the list of results will be filtered for the specified Endpoint ID. Eg `NCRq5oYnan5x-PkdTPQwLLUdu5M`. + One can see the endpoint id from Instana UI by going to an Endpoint page. In the URL, there will be `endpointId=NCRq5oYnan5x-PkdTPQwLLUdu5M`. + Alternatively, one can use `Get endpoints` API endpoint to get the endpoint id in `id` parameter. + maxLength: 64 + minLength: 0 + endpointTypes: + type: array + items: + type: string + enum: + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - DATABASE + - MESSAGING + - PAGE + - PAGE_RESOURCE + uniqueItems: true + writeOnly: true + metrics: + type: array + description: 'A list of objects each of which defines a metric and the (statistical) + aggregation -- MEAN, SUM, MAX, etc -- that should be used to summarize + it for the defined time frame. Eg: `[{ ''metric'': ''latency'', ''aggregation'': + ''MEAN''}]`. To know more about supported metrics and its aggregation, + See `Get Metric catalog`.' + items: + $ref: '#/components/schemas/AppDataMetricConfiguration' + maxItems: 5 + minItems: 1 + nameFilter: + type: string + description: 'filter by name with `contains` semantic. Eg: Let''s say there + are 2 names `app1` and `app2`, you can set `app`` here to include the + two names' + maxLength: 256 + minLength: 0 + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/Pagination' + serviceId: + type: string + description: | + An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + maxLength: 64 + minLength: 0 + technologies: + type: array + items: + type: string + uniqueItems: true + writeOnly: true + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - metrics + GetAvailableMetricsQuery: + type: object + properties: + query: + type: string + description: Search term used to filter results using fields such as label, + description, tag name or keywords + maxLength: 200 + minLength: 0 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + type: + type: string + description: Entity type. Identifier for the monitored technology. + required: + - tagFilterExpression + - timeFrame + GetAvailablePluginsQuery: + type: object + properties: + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - tagFilterExpression + - timeFrame + GetCallGroups: + type: object + properties: + group: + $ref: '#/components/schemas/Group' + includeInternal: + type: boolean + description: Flag to include Internal Calls. These calls are work done inside + a service and correspond to intermediate spans in custom tracing. + includeSynthetic: + type: boolean + description: Flag to include Synthetic Calls. These calls have a synthetic + endpoint as their destination, such as calls to health-check endpoints. + metrics: + type: array + description: 'A list of objects each of which defines a metric and the (statistical) + aggregation -- MEAN, SUM, MAX, etc -- that should be used to summarize + it for the defined time frame. Eg: `[{ ''metric'': ''latency'', ''aggregation'': + ''MEAN''}]`. To know more about supported metrics and its aggregation, + See `Get Metric catalog`.' + items: + $ref: '#/components/schemas/MetricConfig' + maxItems: 5 + minItems: 1 + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/CursorPagination' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/DeprecatedTagFilter' + maxItems: 10 + minItems: 0 + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - group + - metrics + GetCombinedMetrics: + type: object + properties: + metrics: + type: array + description: Id of the exact metric you want to retrieve, eg. "cpu.user", + "clientrequests.read.mean" + items: + type: string + description: Id of the exact metric you want to retrieve, eg. "cpu.user", + "clientrequests.read.mean" + maxItems: 5 + minItems: 1 + uniqueItems: true + plugin: + type: string + description: Plugin name + example: host + query: + type: string + description: Dynamic Focus Query + example: entity.selfType:java + rollup: + type: integer + format: int32 + description: Rollup value in seconds + example: 5 + snapshotIds: + type: array + description: Unique identifier the metrics are assigned to + items: + type: string + description: Unique identifier the metrics are assigned to + maxItems: 30 + minItems: 1 + uniqueItems: true + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - metrics + - plugin + GetDynamicParameterValues: + type: object + properties: + eventId: + type: string + description: Event identifier + parameters: + type: array + description: List of dynamic parameters + items: + $ref: '#/components/schemas/DynamicParameter' + timestamp: + type: integer + format: int64 + description: The start of the timestamp expressed in Unix epoch time in + milliseconds. + required: + - eventId + - parameters + - timestamp + GetEndpoints: + type: object + properties: + applicationBoundaryScope: + type: string + description: "Use when querying calls of an application:\n `INBOUND`: only\ + \ inbound calls \n `ALL`: all the calls to that application (inbound +\ + \ internal)" + enum: + - ALL + - INBOUND + applicationId: + type: string + description: | + An Instana generated unique identifier for an Application. If specified, the list of results will be filtered for the specified Application ID. Eg: `Av62RoIKQv-A3n6DbMQh9g`. + One can see the application id from Instana UI by going to an Application Perspective page. In the URL, there will be `appId=Av62RoIKQv-A3n6DbMQh9g`. + Alternatively, one can use `Get applications` API endpoint to get the application id in `id` parameter. + maxLength: 64 + minLength: 0 + endpointId: + type: string + description: | + An Instana generated unique identifier for an Endpoint. If specified, the list of results will be filtered for the specified Endpoint ID. Eg `NCRq5oYnan5x-PkdTPQwLLUdu5M`. + One can see the endpoint id from Instana UI by going to an Endpoint page. In the URL, there will be `endpointId=NCRq5oYnan5x-PkdTPQwLLUdu5M`. + Alternatively, one can use `Get endpoints` API endpoint to get the endpoint id in `id` parameter. + maxLength: 64 + minLength: 0 + endpointTypes: + type: array + description: A list of endpoint types, each of which is a string. An endpoint + can specified for a database, an SDK, etc. + items: + type: string + description: A list of endpoint types, each of which is a string. An endpoint + can specified for a database, an SDK, etc. + enum: + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - DATABASE + - MESSAGING + - PAGE + - PAGE_RESOURCE + maxItems: 8 + minItems: 0 + uniqueItems: true + excludeSynthetic: + type: boolean + description: A variable used to specify whether synthetic endpoints should + be excluded. If set to 'true', synthetic endpoints will be excluded from + the result. + metrics: + type: array + description: 'A list of objects each of which defines a metric and the (statistical) + aggregation -- MEAN, SUM, MAX, etc -- that should be used to summarize + it for the defined time frame. Eg: `[{ ''metric'': ''latency'', ''aggregation'': + ''MEAN''}]`. To know more about supported metrics and its aggregation, + See `Get Metric catalog`.' + items: + $ref: '#/components/schemas/AppDataMetricConfiguration' + maxItems: 5 + minItems: 1 + nameFilter: + type: string + description: 'filter by endpoint name with `contains` semantic. Eg: Let''s + say there are 2 Endpoint names `GET /api/fetch` and `GET /api/update`, + you can set `GET /api/` here to include the two Endpoints.' + maxLength: 256 + minLength: 0 + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/Pagination' + serviceId: + type: string + description: | + An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + maxLength: 64 + minLength: 0 + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - metrics + GetInfrastructureGroupsQuery: + type: object + properties: + groupBy: + type: array + description: Entity grouping tag. Use the Instana Analyze Infrastructure + dashboard to determine the entity grouping tag name. + items: + type: string + description: Entity grouping tag. Use the Instana Analyze Infrastructure + dashboard to determine the entity grouping tag name. + maxItems: 5 + minItems: 0 + metrics: + type: array + items: + $ref: '#/components/schemas/InfraMetricConfiguration' + maxItems: 10 + minItems: 0 + missingPlaceholder: + type: string + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/CursorPaginationInfraExploreCursor' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + type: + type: string + description: Type of entities + required: + - groupBy + - pagination + - tagFilterExpression + - timeFrame + GetInfrastructureQuery: + type: object + properties: + metrics: + type: array + items: + $ref: '#/components/schemas/InfraMetricConfiguration' + maxItems: 10 + minItems: 0 + missingPlaceholder: + type: string + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/CursorPaginationInfraExploreCursor' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tags: + type: array + items: + type: string + maxItems: 5 + minItems: 0 + timeFrame: + $ref: '#/components/schemas/TimeFrame' + type: + type: string + description: Type of entities + required: + - pagination + - tagFilterExpression + - timeFrame + GetMetricsResult: + type: object + properties: + disableDefaultGroups: + type: boolean + writeOnly: true + groups: + type: array + description: ' Grouping of data under `groupbyTag`, where `groupbyTagEntity` + and `groupbyTagSecondLevelKey` are aspects of `groupbyTag`.' + items: + $ref: '#/components/schemas/SyntheticMetricTagGroup' + includeAggregatedTestIds: + type: boolean + writeOnly: true + metrics: + type: array + description: 'A list of objects each of which defines a metric and the (statistical) + aggregation -- MEAN, SUM, MAX, etc -- that should be used to summarize + it for the defined time frame. Eg: `[{ ''metric'': ''latency'', ''aggregation'': + ''MEAN''}]`. To know more about supported metrics and its aggregation, + See `Get Metric catalog`.' + items: + $ref: '#/components/schemas/SyntheticMetricConfiguration' + pagination: + $ref: '#/components/schemas/Pagination' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - metrics + GetMobileAppBeaconGroups: + type: object + properties: + group: + $ref: '#/components/schemas/MobileAppBeaconTagGroup' + metrics: + type: array + items: + $ref: '#/components/schemas/MobileAppMonitoringMetricsConfiguration' + maxItems: 5 + minItems: 1 + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/CursorPagination' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/DeprecatedTagFilter' + maxItems: 32 + minItems: 0 + timeFrame: + $ref: '#/components/schemas/TimeFrame' + type: + type: string + enum: + - SESSION_START + - HTTP_REQUEST + - CRASH + - CUSTOM + - VIEW_CHANGE + - DROP_BEACON + - PERF + required: + - group + - metrics + - type + GetMobileAppBeacons: + type: object + properties: + pagination: + $ref: '#/components/schemas/CursorPagination' + tagFilters: + type: array + items: + $ref: '#/components/schemas/DeprecatedTagFilter' + maxItems: 32 + minItems: 0 + timeFrame: + $ref: '#/components/schemas/TimeFrame' + type: + type: string + enum: + - SESSION_START + - HTTP_REQUEST + - CRASH + - CUSTOM + - VIEW_CHANGE + - DROP_BEACON + - PERF + required: + - type + GetMobileAppMetrics: + type: object + properties: + metrics: + type: array + items: + $ref: '#/components/schemas/MobileAppMonitoringMetricsConfiguration' + maxItems: 5 + minItems: 1 + tagFilters: + type: array + items: + $ref: '#/components/schemas/DeprecatedTagFilter' + maxItems: 32 + minItems: 0 + timeFrame: + $ref: '#/components/schemas/TimeFrame' + type: + type: string + enum: + - SESSION_START + - HTTP_REQUEST + - CRASH + - CUSTOM + - VIEW_CHANGE + - DROP_BEACON + - PERF + required: + - metrics + - type + GetMobileAppMetricsV2: + type: object + properties: + metrics: + type: array + items: + $ref: '#/components/schemas/MobileAppMonitoringMetricsConfiguration' + maxItems: 5 + minItems: 1 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + type: + type: string + enum: + - SESSION_START + - HTTP_REQUEST + - CRASH + - CUSTOM + - VIEW_CHANGE + - DROP_BEACON + - PERF + required: + - metrics + - type + GetPayloadKeysResult: + type: object + properties: + payloadKeys: + type: array + description: Keys that can be used to retrieve plugin payloads. + items: + type: string + description: Keys that can be used to retrieve plugin payloads. + GetServices: + type: object + properties: + applicationBoundaryScope: + type: string + description: "Use when querying calls of an application:\n `INBOUND`: only\ + \ inbound calls \n `ALL`: all the calls to that application (inbound +\ + \ internal)" + enum: + - ALL + - INBOUND + applicationId: + type: string + description: | + An Instana generated unique identifier for an Application. If specified, the list of results will be filtered for the specified Application ID. Eg: `Av62RoIKQv-A3n6DbMQh9g`. + One can see the application id from Instana UI by going to an Application Perspective page. In the URL, there will be `appId=Av62RoIKQv-A3n6DbMQh9g`. + Alternatively, one can use `Get applications` API endpoint to get the application id in `id` parameter. + maxLength: 64 + minLength: 0 + contextScope: + type: string + description: |- + separate filtering and group by service id field + - upstream is filtered on destination service and groups on source service + - downstream is filtered on source service and groups on destination service + - none is filtered on destination service and no grouping + enum: + - NONE + - UPSTREAM + - DOWNSTREAM + metrics: + type: array + description: 'A list of objects each of which defines a metric and the (statistical) + aggregation -- MEAN, SUM, MAX, etc -- that should be used to summarize + it for the defined time frame. Eg: `[{ ''metric'': ''latency'', ''aggregation'': + ''MEAN''}]`. To know more about supported metrics and its aggregation, + See `Get Metric catalog`.' + items: + $ref: '#/components/schemas/AppDataMetricConfiguration' + maxItems: 5 + minItems: 1 + nameFilter: + type: string + description: 'filter by name with `contains` semantic. Eg: Let''s say there + are 2 service names `ecomm-order` and `ecomm-deliver`, you can set `ecomm-` + here to include the two Services.' + maxLength: 256 + minLength: 0 + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/Pagination' + serviceId: + type: string + description: | + An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + maxLength: 64 + minLength: 0 + technologies: + type: array + description: A list of technologies to be used for filtering data. For example, + technologies could include AWS ECS, Cassandra, DB2, JVM, Kafka, etc. A + full list of available technologies can be found in X. + items: + type: string + description: A list of technologies to be used for filtering data. For + example, technologies could include AWS ECS, Cassandra, DB2, JVM, Kafka, + etc. A full list of available technologies can be found in X. + maxItems: 20 + minItems: 0 + uniqueItems: true + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - metrics + GetSnapshotsQuery: + type: object + properties: + snapshotIds: + type: array + description: List of one or more snapshot ids. + items: + type: string + description: List of one or more snapshot ids. + maxItems: 1000 + minItems: 0 + uniqueItems: true + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - snapshotIds + GetTestResult: + type: object + properties: + applicationId: + type: string + maxLength: 64 + minLength: 0 + locationId: + type: array + items: + type: string + metrics: + type: array + items: + $ref: '#/components/schemas/SyntheticMetricConfiguration' + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/Pagination' + serviceId: + type: string + maxLength: 64 + minLength: 0 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/TagFilter' + testId: + type: array + items: + type: string + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - metrics + GetTestResultAnalytic: + type: object + properties: + analyticFunction: + type: string + includeLocationIdGrouping: + type: boolean + writeOnly: true + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/Pagination' + syntheticMetrics: + type: array + items: + type: string + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/TagFilter' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - analyticFunction + - syntheticMetrics + GetTestResultBase: + type: object + properties: + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/Pagination' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/TagFilter' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + GetTestResultList: + type: object + properties: + applicationId: + type: string + maxLength: 64 + minLength: 0 + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/Pagination' + syntheticMetrics: + type: array + items: + type: string + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/TagFilter' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - syntheticMetrics + GetTestSummaryResult: + type: object + properties: + metrics: + type: array + items: + $ref: '#/components/schemas/SyntheticMetricConfiguration' + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/Pagination' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/TagFilter' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - metrics + GetTraceDownloadResultItem: + type: object + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + properties: + callCount: + type: integer + format: int64 + description: Number of calls in a trace. + cursor: + $ref: '#/components/schemas/IngestionOffsetCursor' + destination: + $ref: '#/components/schemas/CallRelation' + duration: + type: integer + format: int64 + description: The total time taken for the entire operation of a call, from + the moment the request was initiated to when the response was received. + The time measured is in milliseconds. This is also known as latency of + a call. + errorCount: + type: integer + format: int64 + description: Represents whether the call is erroneous or not. 0 is not erroneous + and 1 is erroneous. + foreignParentId: + type: string + id: + type: string + description: 'The call ID. A unique identifier for an individual call. For + example: `1bcad5c82338deaf`.' + minSelfTime: + type: integer + format: int64 + description: The smallest self time in the batch. May be null to indicate + that `minSelfTime` is unknown when this node has only an exit span and + no children. The time measured is in milliseconds. + name: + type: string + description: 'Name of the call. For example: `GET /articles/:id`.' + networkTime: + type: integer + format: int64 + description: exit span duration - entry span duration + parentId: + type: string + description: The parent call id, referring to another call in the same trace + which triggered the processing associated with this call. + timestamp: + type: integer + format: int64 + description: The timestamp when the call or request was initiated. For example, + Unix epoch time in milliseconds `1735532879870` is `Monday, 30 December + 2024 04:27:59.870 GMT` + GetTraceGroups: + type: object + properties: + group: + $ref: '#/components/schemas/Group' + includeInternal: + type: boolean + description: Flag to include Internal Calls. These calls are work done inside + a service and correspond to intermediate spans in custom tracing. + includeSynthetic: + type: boolean + description: Flag to include Synthetic Calls. These calls have a synthetic + endpoint as their destination, such as calls to health-check endpoints. + metrics: + type: array + description: 'A list of objects each of which defines a metric and the (statistical) + aggregation -- MEAN, SUM, MAX, etc -- that should be used to summarize + it for the defined time frame. Eg: `[{ ''metric'': ''latency'', ''aggregation'': + ''MEAN''}]`. To know more about supported metrics and its aggregation, + See `Get Metric catalog`.' + items: + $ref: '#/components/schemas/MetricConfig' + maxItems: 5 + minItems: 1 + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/CursorPagination' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/DeprecatedTagFilter' + maxItems: 32 + minItems: 0 + timeFrame: + $ref: '#/components/schemas/TimeFrame' + required: + - group + - metrics + GetTraces: + type: object + properties: + includeInternal: + type: boolean + description: Flag to include Internal Calls. These calls are work done inside + a service and correspond to intermediate spans in custom tracing. + includeSynthetic: + type: boolean + description: Flag to include Synthetic Calls. These calls have a synthetic + endpoint as their destination, such as calls to health-check endpoints. + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/CursorPagination' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/DeprecatedTagFilter' + maxItems: 32 + minItems: 0 + timeFrame: + $ref: '#/components/schemas/TimeFrame' + GetWebsiteBeaconGroups: + type: object + properties: + group: + $ref: '#/components/schemas/WebsiteBeaconTagGroup' + metrics: + type: array + items: + $ref: '#/components/schemas/WebsiteMonitoringMetricsConfiguration' + maxItems: 5 + minItems: 1 + order: + $ref: '#/components/schemas/Order' + pagination: + $ref: '#/components/schemas/CursorPagination' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/DeprecatedTagFilter' + maxItems: 32 + minItems: 0 + timeFrame: + $ref: '#/components/schemas/TimeFrame' + type: + type: string + enum: + - PAGELOAD + - RESOURCELOAD + - HTTPREQUEST + - ERROR + - CUSTOM + - PAGE_CHANGE + required: + - group + - metrics + - type + GetWebsiteBeacons: + type: object + properties: + pagination: + $ref: '#/components/schemas/CursorPagination' + tagFilters: + type: array + items: + $ref: '#/components/schemas/DeprecatedTagFilter' + maxItems: 32 + minItems: 0 + timeFrame: + $ref: '#/components/schemas/TimeFrame' + type: + type: string + enum: + - PAGELOAD + - RESOURCELOAD + - HTTPREQUEST + - ERROR + - CUSTOM + - PAGE_CHANGE + required: + - type + GetWebsiteMetrics: + type: object + properties: + metrics: + type: array + items: + $ref: '#/components/schemas/WebsiteMonitoringMetricsConfiguration' + maxItems: 5 + minItems: 1 + tagFilters: + type: array + items: + $ref: '#/components/schemas/DeprecatedTagFilter' + maxItems: 32 + minItems: 0 + timeFrame: + $ref: '#/components/schemas/TimeFrame' + type: + type: string + enum: + - PAGELOAD + - RESOURCELOAD + - HTTPREQUEST + - ERROR + - CUSTOM + - PAGE_CHANGE + required: + - metrics + - type + GetWebsiteMetricsV2: + type: object + properties: + metrics: + type: array + items: + $ref: '#/components/schemas/WebsiteMonitoringMetricsConfiguration' + maxItems: 5 + minItems: 1 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + timeFrame: + $ref: '#/components/schemas/TimeFrame' + type: + type: string + enum: + - PAGELOAD + - RESOURCELOAD + - HTTPREQUEST + - ERROR + - CUSTOM + - PAGE_CHANGE + required: + - metrics + - type + GlobalApplicationAlertConfigWithMetadata: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + applicationIds: + type: array + description: IDs of the applications that this Smart Alert is applied to. + items: + type: string + description: IDs of the applications that this Smart Alert is applied + to. + uniqueItems: true + applications: + type: object + additionalProperties: + $ref: '#/components/schemas/ApplicationNode' + description: Selection of applications, services, and endpoints that this + Smart Alert configuration is associated with. This selection is connected + to the defined `tagFilterExpression` by the logical `AND` operator. + boundaryScope: + type: string + description: Determines the source of the application alert configuration. + An `INBOUND` scope refers to consumer-made calls. An `ALL` scope refers + to both consumer and internally made calls. + enum: + - ALL + - INBOUND + builtIn: + type: boolean + description: 'Flag that indicates whether this configuration is a built-in + Smart Alert. ' + created: + type: integer + format: int64 + description: Unix timestamp representing the creation time of this revision. + minimum: 1 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the application alert configuration. Used as + a template for the description of alert/event notifications triggered + by this Smart Alert configuration. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. + evaluationType: + type: string + description: Determines whether calls of the aggregated metrics are grouped + by the application, the service, or the endpoint. This also determines + whether the resulting events are categorized as an issue on the respective + entity of that group. + enum: + - PER_AP + - PER_AP_SERVICE + - PER_AP_ENDPOINT + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + id: + type: string + description: ID of this Global Application Alert Configuration. + maxLength: 64 + minLength: 0 + includeInternal: + type: boolean + description: Flag to include Internal Calls. These calls are work done inside + a service and correspond to intermediate spans in custom tracing. + includeSynthetic: + type: boolean + description: 'Flag to include Synthetic Calls. These calls have a synthetic + endpoint as their destination, such as calls to health-check endpoints. ' + initialCreated: + type: integer + format: int64 + description: Unix timestamp representing the time of the initial revision. + minimum: 1 + name: + type: string + description: Name of the application alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + readOnly: + type: boolean + description: Flag to indicate whether or not the configuration is read-only. + Read-only access restricts modification of the config. + rule: + $ref: '#/components/schemas/ApplicationAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdApplicationAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/ApplicationTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + required: + - alertChannelIds + - applications + - boundaryScope + - customPayloadFields + - description + - evaluationType + - granularity + - id + - name + - tagFilterExpression + - timeThreshold + GlobalApplicationsAlertConfig: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + applications: + type: object + additionalProperties: + $ref: '#/components/schemas/ApplicationNode' + description: Selection of applications, services, and endpoints that this + Smart Alert configuration is associated with. This selection is connected + to the defined `tagFilterExpression` by the logical `AND` operator. + boundaryScope: + type: string + description: Determines the source of the application alert configuration. + An `INBOUND` scope refers to consumer-made calls. An `ALL` scope refers + to both consumer and internally made calls. + enum: + - ALL + - INBOUND + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the application alert configuration. Used as + a template for the description of alert/event notifications triggered + by this Smart Alert configuration. + maxLength: 65536 + minLength: 0 + evaluationType: + type: string + description: Determines whether calls of the aggregated metrics are grouped + by the application, the service, or the endpoint. This also determines + whether the resulting events are categorized as an issue on the respective + entity of that group. + enum: + - PER_AP + - PER_AP_SERVICE + - PER_AP_ENDPOINT + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + includeInternal: + type: boolean + description: Flag to include Internal Calls. These calls are work done inside + a service and correspond to intermediate spans in custom tracing. + includeSynthetic: + type: boolean + description: 'Flag to include Synthetic Calls. These calls have a synthetic + endpoint as their destination, such as calls to health-check endpoints. ' + name: + type: string + description: Name of the application alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + rule: + $ref: '#/components/schemas/ApplicationAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdApplicationAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/ApplicationTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + required: + - alertChannelIds + - applications + - boundaryScope + - customPayloadFields + - description + - evaluationType + - granularity + - name + - tagFilterExpression + - timeThreshold + GoogleChatIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + webhookUrl: + type: string + required: + - id + - kind + - name + - webhookUrl + GraphEdge: + type: object + properties: + destination: + type: string + description: ID of the outgoing GraphEdge. + relation: + type: string + description: Type of dependency between the source and the destination. + enum: + - in + - is + - to + - of + - connected + - describes + - of20 + - to20 + - dummy + - parent + source: + type: string + description: ID of the incoming GraphEdge. + GraphNode: + type: object + properties: + data: + type: object + additionalProperties: + type: object + entityId: + $ref: '#/components/schemas/EntityId' + id: + type: string + description: GraphNode ID. + label: + type: string + description: Label of the entity + plugin: + type: string + description: Name of the plugin + Group: + type: object + description: ' Grouping of data under `groupbyTag`, where `groupbyTagEntity` + and `groupbyTagSecondLevelKey` are aspects of `groupbyTag`.' + properties: + groupbyTag: + type: string + description: The name of the group tag (e.g. `agent.tag` or `docker.label`). + maxLength: 256 + minLength: 0 + groupbyTagEntity: + type: string + description: | + The entity by which the data should be grouped. + This field supports three possible values: `NOT_APPLICABLE`, `DESTINATION`, and `SOURCE`. + `SOURCE`: the tag filter should apply to the source entity. + `DESTINATION`: the tag filter should apply to the destination entity. + `NOT_APPLICABLE`: some tags are independent of source or destination, such as tags on the call itself, log tags or trace tags (only destination makes sense because the source is unknown for the root call). + enum: + - NOT_APPLICABLE + - DESTINATION + - SOURCE + groupbyTagSecondLevelKey: + type: string + description: If present, it's the 2nd level key part (e.g. `customKey` on + `docker.label.customKey`) + maxLength: 256 + minLength: 0 + required: + - groupbyTag + - groupbyTagEntity + GroupByTag: + type: object + description: The grouping tags used to group the metric results. + properties: + key: + type: string + tagName: + type: string + required: + - tagName + GroupMapping: + type: object + properties: + groupId: + type: string + id: + type: string + maxLength: 64 + minLength: 0 + key: + type: string + maxLength: 65536 + minLength: 0 + teamId: + type: string + maxLength: 64 + minLength: 5 + value: + type: string + maxLength: 65536 + minLength: 0 + required: + - groupId + - key + - value + GroupMappingOverview: + type: object + properties: + id: + type: string + key: + type: string + role: + type: string + team: + type: string + value: + type: string + HealthState: + type: object + properties: + health: + type: string + enum: + - RED + - YELLOW + - GREEN + messages: + type: array + items: + type: string + HistoricBaseline: + type: object + allOf: + - $ref: '#/components/schemas/Threshold' + - type: object + properties: + baseline: + type: array + items: + type: array + items: + type: number + deviationFactor: + type: number + format: double + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 16.0 + minimum: 0.5 + lastUpdated: + type: integer + format: int64 + minimum: 0 + seasonality: + type: string + enum: + - WEEKLY + - DAILY + required: + - operator + - seasonality + HostAvailabilityRule: + type: object + allOf: + - $ref: '#/components/schemas/AbstractRule' + - type: object + properties: + closeAfter: + type: integer + format: int64 + maximum: 86400000 + offlineDuration: + type: integer + format: int64 + tagFilter: + $ref: '#/components/schemas/TagFilter' + HttpActionConfiguration: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + allowInsecure: + type: boolean + body: + type: string + expectExists: + type: array + items: + type: string + expectJson: + $ref: '#/components/schemas/ContainerNode' + expectMatch: + type: string + expectNotEmpty: + type: array + items: + type: string + expectStatus: + type: integer + format: int32 + followRedirect: + type: boolean + headers: + type: object + additionalProperties: + type: string + operation: + type: string + enum: + - DELETE + - GET + - HEAD + - OPTIONS + - PATCH + - POST + - PUT + url: + type: string + maxLength: 2047 + minLength: 0 + validationString: + type: string + required: + - markSyntheticCall + - syntheticType + - url + HttpActionConfigurationUpdate: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - type: object + properties: + allowInsecure: + type: boolean + body: + type: string + expectExists: + $ref: '#/components/schemas/SyntheticResourceUpdateListStringListString' + expectJson: + $ref: '#/components/schemas/ContainerNode' + expectMatch: + type: string + expectNotEmpty: + $ref: '#/components/schemas/SyntheticResourceUpdateListStringListString' + expectStatus: + type: integer + format: int32 + followRedirect: + type: boolean + headers: + $ref: '#/components/schemas/SyntheticResourceUpdateMapStringStringListString' + operation: + type: string + enum: + - DELETE + - GET + - HEAD + - OPTIONS + - PATCH + - POST + - PUT + url: + type: string + validationString: + type: string + HttpEndpointConfig: + type: object + properties: + endpointNameByCollectedPathTemplateRuleEnabled: + type: boolean + description: | + The highest default precedence of endpoint rule is creating endpoint is based on path template. For example, + ``` + /hospital/1948/patient/291148 + /hospital/728/patient/924892 + /hospital/47/patient/25978 + /hospital/108429/patient/1847 + ``` + can be considered as `/hospital/{hid}/patient/{pid}` if this rule is enabled. For most of the use cases, this rule should be enabled. + endpointNameByFirstPathSegmentRuleEnabled: + type: boolean + description: | + There are endpoint extraction rules in Instana which take the first path segment from the HTTP request and turn this into an endpoint name. + For example, given the following URLs `/users/123/profile` and `/users/123/settings`, the extraction rule will only take the first segment. As a result endpoint name will be `users`. + Although this is useful in cases where broad overview of monitoring is required, lot of use cases are more specified. + Considering the above example, if this rule is enabled, Instana can't distinguish between `profile` or `settings` as endpoints. + For use cases where endpoints has to be monitored at fine granular level, this flag should be set to `false`. + rules: + type: array + description: Specify custom rule configuration apart from Instana predefined + rules. This rule has the highest precedence. This is only available for + HTTP endpoints. + items: + $ref: '#/components/schemas/HttpEndpointRule' + maxItems: 500 + minItems: 0 + serviceId: + type: string + description: | + An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. + required: + - rules + - serviceId + HttpEndpointRule: + type: object + description: Specify custom rule configuration apart from Instana predefined + rules. This rule has the highest precedence. This is only available for HTTP + endpoints. + properties: + enabled: + type: boolean + description: Set this flag to `true` if custom rule configurations has to + be considered. + pathSegments: + type: array + description: "A list of path segment matching rules, each defining how a\ + \ segment of the HTTP path should be matched.\nEach object in this array\ + \ represents a segment rule, allowing for fixed segments, dynamic parameters,\ + \ wildcards, or unsupported segments. \n\n**UNSUPPORTED**: A path segment\ + \ that is not recognized by the system. \n\n**FIXED**: This type represents\ + \ a static, unchanging part of the URL path.\nFor example, `/api/{version}/users`,\ + \ `api` and `users` would be `FIXED` segment. \n\n**PARAMETER**: This\ + \ type represents a variable part of the URL path, often used to capture\ + \ specific parameters or IDs that change with each request.\nFor example,\ + \ `/api/{version}/users`, `version` would be `PARAMETER` segment. `version`\ + \ can be `v1`, `v2`, `v3` etc. \n\n**MATCH_ALL**: This type represents\ + \ a wildcard, capturing all remaining segments from this point onward\ + \ in the URL path.\nFor example, `/api/{version}/users/*` — Matches all\ + \ paths like `/api/v1/users/123`. `/api/v3/users/456` etc. \n\n" + items: + $ref: '#/components/schemas/HttpPathSegmentMatchingRule' + maxItems: 16 + minItems: 1 + testCases: + type: array + description: | + To validate whether the the defined custom endpoint rule configuration is working as expected. + For example, given a query `/api/*/{version}`, the following test case `/api/anyName/123` will match, while `/otherApi/anyName/123` will not. + items: + type: string + description: | + To validate whether the the defined custom endpoint rule configuration is working as expected. + For example, given a query `/api/*/{version}`, the following test case `/api/anyName/123` will match, while `/otherApi/anyName/123` will not. + maxItems: 32 + minItems: 0 + required: + - pathSegments + HttpPathSegmentMatchingRule: + type: object + description: "A list of path segment matching rules, each defining how a segment\ + \ of the HTTP path should be matched.\nEach object in this array represents\ + \ a segment rule, allowing for fixed segments, dynamic parameters, wildcards,\ + \ or unsupported segments. \n\n**UNSUPPORTED**: A path segment that is not\ + \ recognized by the system. \n\n**FIXED**: This type represents a static,\ + \ unchanging part of the URL path.\nFor example, `/api/{version}/users`, `api`\ + \ and `users` would be `FIXED` segment. \n\n**PARAMETER**: This type represents\ + \ a variable part of the URL path, often used to capture specific parameters\ + \ or IDs that change with each request.\nFor example, `/api/{version}/users`,\ + \ `version` would be `PARAMETER` segment. `version` can be `v1`, `v2`, `v3`\ + \ etc. \n\n**MATCH_ALL**: This type represents a wildcard, capturing all remaining\ + \ segments from this point onward in the URL path.\nFor example, `/api/{version}/users/*`\ + \ — Matches all paths like `/api/v1/users/123`. `/api/v3/users/456` etc. \n\ + \n" + discriminator: + mapping: + FIXED: '#/components/schemas/FixedHttpPathSegmentMatchingRule' + MATCH_ALL: '#/components/schemas/MatchAllHttpPathSegmentMatchingRule' + PARAMETER: '#/components/schemas/PathParameterHttpPathSegmentMatchingRule' + UNSUPPORTED: '#/components/schemas/UnsupportedHttpPathSegmentMatchingRule' + propertyName: type + properties: + type: + type: string + enum: + - UNSUPPORTED + - FIXED + - PARAMETER + - MATCH_ALL + required: + - type + HttpScriptConfiguration: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + fileName: + type: string + script: + type: string + maxLength: 1048576 + minLength: 0 + scriptType: + type: string + enum: + - Basic + - Jest + scripts: + $ref: '#/components/schemas/MultipleScriptsConfiguration' + required: + - markSyntheticCall + - syntheticType + HttpScriptConfigurationUpdate: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - type: object + properties: + fileName: + type: string + script: + type: string + scriptType: + type: string + enum: + - Basic + - Jest + scripts: + $ref: '#/components/schemas/MultipleScriptsConfiguration' + HyperParam: + type: object + description: List of hyper parameters of the Built-in Event Specification + properties: + defaultValue: + type: number + format: double + description: + type: string + maxLength: 2048 + minLength: 0 + id: + type: string + maxLength: 64 + minLength: 0 + maxValue: + type: number + format: double + minValue: + type: number + format: double + name: + type: string + maxLength: 256 + minLength: 0 + valueFormat: + type: string + description: | + | + * NUMBER: Generic number + * BYTES: Number of bytes + * KILO_BYTES: Number of kilobytes + * MEGA_BYTES: Number of megabytes + * PERCENTAGE: Percentage in scale [0,1] + * PERCENTAGE_100: Percentage in scale [0,100] + * PERCENTAGE_NO_CAPPING: Percentage in scale [0,1] but value could exceed 1 for example when metric is aggregated + * PERCENTAGE_100_NO_CAPPING: Percentage in scale [0,100] but value could exceed 100 for example when metric is aggregated + * LATENCY: Time in milliseconds, with value of 0 should not be considered a a strict 0, but considered as < 1ms + * NANOS: Time in nanoseconds + * MILLIS: Time in milliseconds + * MICROS: Time in microseconds + * SECONDS: Time in seconds + * RATE: Number of occurrences per second + * BYTE_RATE: Number of bytes per second + * UNDEFINED: Metric value unit is not known + enum: + - NUMBER + - BYTES + - KILO_BYTES + - MEGA_BYTES + - PERCENTAGE + - PERCENTAGE_100 + - PERCENTAGE_NO_CAPPING + - PERCENTAGE_100_NO_CAPPING + - LATENCY + - NANOS + - MILLIS + - MICROS + - SECONDS + - RATE + - BYTE_RATE + - UNDEFINED + required: + - description + - id + - name + IdentityProviderPatch: + type: object + properties: + restrictEmptyIdpGroups: + type: boolean + ImpactedBeaconInfo: + type: object + properties: + country: + type: string + label: + type: string + subdivision: + type: string + userEmail: + type: string + userName: + type: string + InfraAlertConfig: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the Infrastructure Smart Alert. Used as a template + for the description of alert/event notifications triggered by this Smart + Alert configuration. + maxLength: 65536 + minLength: 0 + evaluationType: + type: string + description: Determines whether we evaluate each infra entity independently + or group of entities will be evaluated together. + enum: + - PER_ENTITY + - CUSTOM + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + groupBy: + type: array + description: The grouping tags used to group the metric results. + items: + type: string + description: The grouping tags used to group the metric results. + maxItems: 5 + minItems: 0 + name: + type: string + description: Name of the Infrastructure Smart Alert. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + rule: + $ref: '#/components/schemas/InfraAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdInfraAlertRule' + maxItems: 5 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/InfraTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + required: + - customPayloadFields + - description + - granularity + - groupBy + - name + - tagFilterExpression + - timeThreshold + InfraAlertConfigWithMetadata: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + created: + type: integer + format: int64 + minimum: 1 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the Infrastructure Smart Alert. Used as a template + for the description of alert/event notifications triggered by this Smart + Alert configuration. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + evaluationType: + type: string + description: Determines whether we evaluate each infra entity independently + or group of entities will be evaluated together. + enum: + - PER_ENTITY + - CUSTOM + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + groupBy: + type: array + description: The grouping tags used to group the metric results. + items: + type: string + description: The grouping tags used to group the metric results. + maxItems: 5 + minItems: 0 + id: + type: string + maxLength: 64 + minLength: 0 + initialCreated: + type: integer + format: int64 + minimum: 1 + name: + type: string + description: Name of the Infrastructure Smart Alert. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + readOnly: + type: boolean + rule: + $ref: '#/components/schemas/InfraAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdInfraAlertRule' + maxItems: 5 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/InfraTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + required: + - customPayloadFields + - description + - granularity + - groupBy + - id + - name + - tagFilterExpression + - timeThreshold + InfraAlertRule: + type: object + discriminator: + mapping: + genericRule: '#/components/schemas/GenericInfraAlertRule' + propertyName: alertType + properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + alertType: + type: string + crossSeriesAggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + entityType: + type: string + metricGroupBy: + type: array + items: + type: string + metricName: + type: string + metricTagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + regex: + type: boolean + required: + - alertType + - metricName + InfraEventResult: + type: object + allOf: + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + ibmMqFileTransfer: + type: array + description: IBM MQ file transfer information, if relevant for this entity + and event. + items: + type: object + additionalProperties: + type: object + description: IBM MQ file transfer information, if relevant for this + entity and event. + description: IBM MQ file transfer information, if relevant for this + entity and event. + snapshotId: + type: string + description: ID of the snapshot. + InfraExploreCursor: + type: object + description: cursor to use between successive queries + InfraMetricConfiguration: + type: object + oneOf: + - $ref: '#/components/schemas/SimpleMetricConfiguration' + - $ref: '#/components/schemas/ArithmeticConfiguration' + InfraSloEntity: + type: object + allOf: + - $ref: '#/components/schemas/SloEntity' + - type: object + properties: + infraType: + type: string + description: Infrastructure Type + required: + - infraType + InfraTimeThreshold: + type: object + description: The type of threshold to define the criteria when the event and + alert triggers and resolves. + discriminator: + mapping: + violationsInSequence: '#/components/schemas/ViolationsInSequenceInfraTimeThreshold' + propertyName: type + properties: + timeWindow: + type: integer + format: int64 + type: + type: string + required: + - type + InfrastructureEntitiesResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + canLoadMore: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/InfrastructureItem' + next: + $ref: '#/components/schemas/InfraExploreCursor' + totalHits: + type: integer + format: int64 + description: represents the total number of results + minimum: 0 + required: + - items + InfrastructureGroup: + type: object + description: group of infrastructure entities + properties: + count: + type: integer + format: int64 + description: number of entities in this group + metrics: + type: object + additionalProperties: + type: array + description: map of metric keys to array of timestamp,value pairs + items: + type: array + description: map of metric keys to array of timestamp,value pairs + items: + type: number + description: map of metric keys to array of timestamp,value pairs + description: map of metric keys to array of timestamp,value pairs + pollRate: + type: integer + format: int64 + description: max poll rate across this group + tags: + type: object + additionalProperties: + type: object + description: tag keys and values for this group + description: tag keys and values for this group + InfrastructureGroupsResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + canLoadMore: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/InfrastructureGroup' + next: + $ref: '#/components/schemas/InfraExploreCursor' + totalHits: + type: integer + format: int64 + description: represents the total number of results + minimum: 0 + required: + - items + InfrastructureItem: + type: object + properties: + entityHealthInfo: + $ref: '#/components/schemas/EntityHealthInfo' + label: + type: string + metrics: + type: object + additionalProperties: + type: array + items: + type: array + items: + type: number + plugin: + type: string + snapshotId: + type: string + tags: + type: object + additionalProperties: + type: string + time: + type: integer + format: int64 + description: Epoch time in milliseconds if the snapshot is offline. Set + to 9223372036854775807 if the snapshot is online. + InfrastructureMetricResult: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/MetricItem' + IngestionOffsetCursor: + type: object + description: Cursor to use between successive queries + InstanaVersionInfo: + type: object + properties: + branch: + type: string + commit: + type: string + imageTag: + type: string + IntegrationOverview: + type: object + properties: + id: + type: string + description: Unique ID of the alert channel + kind: + type: string + description: The type of the Alerting Channel. + name: + type: string + description: The name of the Alerting Channel. + properties: + type: object + additionalProperties: + type: string + description: Properties of the alert channel in pairs of key/value + description: Properties of the alert channel in pairs of key/value + rbacTags: + type: array + description: Team Tags that's assigned to the Alerting Channel + items: + $ref: '#/components/schemas/ApiTag' + uniqueItems: true + required: + - id + - kind + - name + Invitation: + type: object + properties: + email: + type: string + groupId: + type: string + message: + type: string + path: + type: string + teamId: + type: string + required: + - email + - groupId + InvitationResponse: + type: object + properties: + invitationResults: + type: array + items: + $ref: '#/components/schemas/InvitationResult' + InvitationResult: + type: object + properties: + invitationStatus: + type: string + enum: + - SUCCESS + - INTERNAL_ERROR + - FAILURE_USER_ALREADY_EXISTS + - FAILURE_USER_ALREADY_INVITED + - FAILURE_ONLY_DEFAULT_GROUP_INVITATION_ALLOWED + - FAILURE_TENANT_IDP_CONFIGURED + userEmail: + type: string + IpMaskingConfiguration: + type: object + properties: + ipMasking: + type: string + enum: + - DEFAULT + - STRICT + - REMOVE_ALL_DETAILS + required: + - ipMasking + JsStackTraceLine: + type: object + properties: + column: + type: integer + format: int32 + minimum: -1 + file: + type: string + line: + type: integer + format: int32 + minimum: -1 + name: + type: string + translationExplanation: + type: string + translationStatus: + type: integer + format: int32 + minimum: -1 + required: + - file + Json: + type: object + JsonNode: + type: object + KubernetesPhysicalContext: + type: object + description: Contains physical context of Kubernetes which contains information + about the cluster, namespace, node and pod. + properties: + cluster: + $ref: '#/components/schemas/SnapshotPreview' + namespace: + $ref: '#/components/schemas/SnapshotPreview' + node: + $ref: '#/components/schemas/SnapshotPreview' + pod: + $ref: '#/components/schemas/SnapshotPreview' + LLMEgressGateway: + type: object + description: Custom handler definition. + properties: + aiModel: + type: string + configurations: + $ref: '#/components/schemas/JsonNode' + createdAt: + type: string + description: + type: string + enabled: + type: boolean + endpointApiKey: + type: string + endpointUrl: + type: string + id: + type: string + format: uuid + instanaAgents: + $ref: '#/components/schemas/JsonNode' + metadata: + $ref: '#/components/schemas/JsonNode' + modifiedAt: + type: string + name: + type: string + prompt: + type: string + supports: + $ref: '#/components/schemas/JsonNode' + system: + type: boolean + tenantUnitId: + type: string + watsonxKey: + type: string + watsonxProject: + type: string + watsonxUrl: + type: string + required: + - createdAt + - id + - modifiedAt + - name + - prompt + - supports + - tenantUnitId + LatencyBlueprintIndicator: + type: object + allOf: + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + properties: + threshold: + type: number + format: double + description: Threshold Value for the Blueprint + exclusiveMinimum: false + minimum: 0.0 + required: + - type + LocationStatus: + type: object + properties: + locationDisplayLabel: + type: string + locationId: + type: string + successRate: + type: number + format: double + successRuns: + type: integer + format: int64 + totalTestRuns: + type: integer + format: int64 + required: + - locationId + LogAlertConfig: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the Log Smart Alert. Used as a template for + the description of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 65536 + minLength: 0 + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + groupBy: + type: array + description: The grouping tags used to group the metric results. + items: + $ref: '#/components/schemas/GroupByTag' + maxItems: 1 + minItems: 0 + name: + type: string + description: Name of the Log Smart Alert. Used as a template for the title + of alert/event notifications triggered by this Smart Alert configuration. + maxLength: 256 + minLength: 0 + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdLogAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/LogTimeThreshold' + required: + - description + - granularity + - name + - tagFilterExpression + - timeThreshold + LogAlertConfigWithMetadata: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + created: + type: integer + format: int64 + minimum: 1 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the Log Smart Alert. Used as a template for + the description of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + groupBy: + type: array + description: The grouping tags used to group the metric results. + items: + $ref: '#/components/schemas/GroupByTag' + maxItems: 1 + minItems: 0 + id: + type: string + maxLength: 64 + minLength: 0 + initialCreated: + type: integer + format: int64 + minimum: 1 + name: + type: string + description: Name of the Log Smart Alert. Used as a template for the title + of alert/event notifications triggered by this Smart Alert configuration. + maxLength: 256 + minLength: 0 + readOnly: + type: boolean + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdLogAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/LogTimeThreshold' + required: + - description + - granularity + - id + - name + - tagFilterExpression + - timeThreshold + LogAlertRule: + type: object + discriminator: + mapping: + logCount: '#/components/schemas/LogCountAlertRule' + propertyName: alertType + properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + alertType: + type: string + metricName: + type: string + required: + - alertType + - metricName + LogCountAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/LogAlertRule' + required: + - metricName + LogEntryActor: + type: object + properties: + email: + type: string + id: + type: string + name: + type: string + type: + type: string + enum: + - USER + - API_TOKEN + - POLICY + required: + - id + - name + - type + LogEventResult: + type: object + allOf: + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + snapshotId: + type: string + description: ID of the snapshot. + LogTimeThreshold: + type: object + description: The type of threshold to define the criteria when the event and + alert triggers and resolves. + discriminator: + mapping: + violationsInSequence: '#/components/schemas/ViolationsInSequenceLogTimeThreshold' + propertyName: type + properties: + timeWindow: + type: integer + format: int64 + type: + type: string + required: + - type + LogVolumeGroup: + type: object + properties: + label: + type: string + maxLength: 256 + minLength: 0 + logVolume: + type: integer + format: int64 + required: + - label + - logVolume + LogVolumeUsageItem: + type: object + properties: + logVolume: + type: integer + format: int64 + numberOfMonth: + type: integer + format: int32 + maximum: 12 + minimum: 1 + retentionPeriods: + type: array + items: + $ref: '#/components/schemas/RetentionPeriod' + required: + - logVolume + - retentionPeriods + LogVolumeUsageResult: + type: object + properties: + logVolumeUsageItems: + type: array + items: + $ref: '#/components/schemas/LogVolumeUsageItem' + required: + - logVolumeUsageItems + LogsApplicationAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/ApplicationAlertRule' + - type: object + properties: + level: + type: string + enum: + - WARN + - ERROR + - ANY + loglevel: + type: string + enum: + - WARN + - ERROR + - ANY + writeOnly: true + message: + type: string + operator: + type: string + enum: + - EQUALS + - CONTAINS + - LESS_THAN + - LESS_OR_EQUAL_THAN + - GREATER_THAN + - GREATER_OR_EQUAL_THAN + - NOT_EMPTY + - NOT_EQUAL + - NOT_CONTAIN + - IS_EMPTY + - NOT_BLANK + - IS_BLANK + - STARTS_WITH + - ENDS_WITH + - NOT_STARTS_WITH + - NOT_ENDS_WITH + - REGEX_MATCH + required: + - level + - metricName + - operator + MaintenanceConfig: + type: object + properties: + id: + type: string + description: ID of the Maintenance Window Configuration. + maxLength: 64 + minLength: 0 + name: + type: string + description: Name of the Maintenance Window Configuration. + maxLength: 256 + minLength: 0 + query: + type: string + description: Dynamic Focus Query that determines the scope of the Maintenance + Window configuration. + maxLength: 2048 + minLength: 0 + windows: + type: array + description: A set of time periods when the Maintenance Window Configuration + is active. + items: + $ref: '#/components/schemas/MaintenanceWindow' + maxItems: 1 + minItems: 0 + uniqueItems: true + required: + - id + - name + - query + MaintenanceConfigScheduling: + type: object + description: Time scheduling of the Maintenance Window configurations. + discriminator: + mapping: + ONE_TIME: '#/components/schemas/OneTimeMaintenanceWindow' + RECURRENT: '#/components/schemas/RecurrentMaintenanceWindow' + propertyName: type + properties: + duration: + $ref: '#/components/schemas/Duration' + start: + type: integer + format: int64 + minimum: 1 + type: + type: string + maxLength: 2048 + minLength: 0 + required: + - duration + - start + - type + MaintenanceConfigV2: + type: object + properties: + id: + type: string + description: ID of the Maintenance Window configuration. + maxLength: 64 + minLength: 0 + name: + type: string + description: Name of the Maintenance Window configuration. + maxLength: 256 + minLength: 0 + paused: + type: boolean + description: Boolean flag to determine if the Maintenance Window configuration + is paused or still live. + query: + type: string + description: Dynamic Focus Query that determines the scope of the Maintenance + Window configuration. + maxLength: 2048 + minLength: 0 + retriggerOpenAlertsEnabled: + type: boolean + description: Boolean flag to determine if we should retrigger open alerts + to be sent out for any events that opened during this maintenance window, + and continues to remain open after the window expires + scheduling: + $ref: '#/components/schemas/MaintenanceConfigScheduling' + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilterExpressionEnabled: + type: boolean + description: Boolean flag to determine if the tagFilterExpression is enabled. + required: + - id + - name + - query + - scheduling + MaintenanceConfigV2WithStateAndOccurrence: + type: object + properties: + id: + type: string + description: ID of the Maintenance Window configuration. + maxLength: 64 + minLength: 0 + lastUpdated: + type: integer + format: int64 + minimum: 1 + name: + type: string + description: Name of the Maintenance Window configuration. + maxLength: 256 + minLength: 0 + occurrence: + $ref: '#/components/schemas/Occurrence' + paused: + type: boolean + description: Boolean flag to determine if the Maintenance Window configuration + is paused or still live. + query: + type: string + description: Dynamic Focus Query that determines the scope of the Maintenance + Window configuration. + maxLength: 2048 + minLength: 0 + retriggerOpenAlertsEnabled: + type: boolean + description: Boolean flag to determine if we should retrigger open alerts + to be sent out for any events that opened during this maintenance window, + and continues to remain open after the window expires + scheduling: + $ref: '#/components/schemas/MaintenanceConfigScheduling' + state: + type: string + description: 'State of the Maintenance Window, it can be: UNSCHEDULED, SCHEDULED, + ACTIVE, PAUSED, EXPIRED.' + enum: + - UNSCHEDULED + - SCHEDULED + - ACTIVE + - PAUSED + - EXPIRED + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilterExpressionEnabled: + type: boolean + description: Boolean flag to determine if the tagFilterExpression is enabled. + required: + - id + - name + - occurrence + - query + - scheduling + MaintenanceConfigWithLastUpdated: + type: object + properties: + id: + type: string + description: ID of the Maintenance Window Configuration. + maxLength: 64 + minLength: 0 + lastUpdated: + type: integer + format: int64 + minimum: 1 + name: + type: string + description: Name of the Maintenance Window Configuration. + maxLength: 256 + minLength: 0 + query: + type: string + description: Dynamic Focus Query that determines the scope of the Maintenance + Window configuration. + maxLength: 2048 + minLength: 0 + windows: + type: array + description: A set of time periods when the Maintenance Window Configuration + is active. + items: + $ref: '#/components/schemas/MaintenanceWindow' + maxItems: 1 + minItems: 0 + uniqueItems: true + required: + - id + - name + - query + MaintenanceWindow: + type: object + description: A set of time periods when the Maintenance Window Configuration + is active. + properties: + end: + type: integer + format: int64 + minimum: 1 + id: + type: string + maxLength: 64 + minLength: 0 + start: + type: integer + format: int64 + minimum: 0 + required: + - id + ManualAlertingChannelConfiguration: + type: object + properties: + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/StaticStringField' + maxItems: 20 + minItems: 0 + eventId: + type: string + description: Id of the event to be notified about. + maxLength: 256 + minLength: 0 + required: + - customPayloadFields + - eventId + ManualCloseInfo: + type: object + properties: + closeTimestamp: + type: integer + format: int64 + description: The closing timestamp. + disableEvent: + type: boolean + description: Flag to indicate whether to disable the event. + eventIds: + type: array + description: The event IDs to manually close, in case of multi close. + items: + type: string + description: The event IDs to manually close, in case of multi close. + uniqueItems: true + muteAlerts: + type: boolean + description: Flag to indicate whether to mute alerts. + reasonForClosing: + type: string + description: The reason for manual closing. + username: + type: string + description: The user name. + maxLength: 256 + minLength: 0 + required: + - reasonForClosing + - username + ManualServiceConfig: + type: object + properties: + description: + type: string + description: A description of the manual service configuration. + enabled: + type: boolean + description: Enable or disable the manual service configuration. By default + it is enabled. + existingServiceId: + type: string + description: The service ID of the existing monitored service to which the + calls should be linked. + id: + type: string + description: A unique id of the manual service configuration. + maxLength: 128 + minLength: 1 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + unmonitoredServiceName: + type: string + description: A service name if you want to map calls to an unmonitored service. + required: + - id + - tagFilterExpression + MatchAllHttpPathSegmentMatchingRule: + type: object + allOf: + - $ref: '#/components/schemas/HttpPathSegmentMatchingRule' + required: + - type + MatchExpressionDTO: + type: object + description: ' Specify the expression to match, For example, `endpoint.name + contains health`.' + discriminator: + mapping: + BINARY_OP: '#/components/schemas/BinaryOperatorDTO' + LEAF: '#/components/schemas/TagMatcherDTO' + propertyName: type + properties: + type: + type: string + required: + - type + MetaData: + type: object + description: Action metadata. + properties: + ai: + type: array + description: List of metadata for AI originated actions. + items: + type: object + additionalProperties: + type: object + description: List of metadata for AI originated actions. + description: List of metadata for AI originated actions. + aiOriginated: + type: boolean + description: AI originated action flag. Value is `true` if action is AI + generated `false` otherwise. + builtIn: + type: boolean + description: Built-in out of the box action flag. Value is `true` if built-in + action `false` otherwise. + readOnly: + type: boolean + description: Read only action flag. Value is `true` if read only `false` + otherwise. + sensorImported: + type: boolean + description: Sensor imported action flag. Value is `true` if action is imported + from sensor `false` otherwise. + MetricAPIResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + metrics: + type: object + additionalProperties: + type: array + items: + type: array + items: + type: number + required: + - metrics + MetricConfig: + type: object + description: 'A list of objects each of which defines a metric and the (statistical) + aggregation -- MEAN, SUM, MAX, etc -- that should be used to summarize it + for the defined time frame. Eg: `[{ ''metric'': ''latency'', ''aggregation'': + ''MEAN''}]`. To know more about supported metrics and its aggregation, See + `Get Metric catalog`.' + properties: + aggregation: + type: string + description: 'Set aggregation that can be applied to a series of values. + Eg: `MEAN`.' + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + granularity: + type: integer + format: int32 + description: 'If the granularity is set you will get data points with the + specified granularity in seconds. Default: `1000` milliseconds' + metric: + type: string + description: 'Set a particular metric, eg: `latency`.' + required: + - aggregation + - metric + MetricConfiguration: + type: object + description: Details regarding the metric to be configured, including the metric + name, threshold, and aggregation method + properties: + metricAggregation: + type: string + description: | + Specifies the types of aggregations that can be applied to a series of values. + For example, `P25` refers to the 25th percentile. Note that not all aggregation methods are available for every metric. + For instance, the `Call count` metric supports only the `SUM` aggregation, whereas the `Error rate` metric only supports the `MEAN` aggregation. + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + metricName: + type: string + description: Defines the name of the metric to be monitored. Examples include + `calls` and `latency` + threshold: + type: number + format: double + description: Specifies the threshold value for the metric being monitored + exclusiveMinimum: true + minimum: 0.0 + required: + - metricName + MetricDescription: + type: object + properties: + aggregations: + type: array + description: | + The types of aggregations that can be applied to a series of values. + For example, `P25` is 25th percentile. Note that not all aggregations are available for metrics. + For example, `Trace count` has only `SUM` as an aggregation whereas `Call Count` has two aggregations, `SUM` and `PER_SECOND`. + items: + type: string + description: | + The types of aggregations that can be applied to a series of values. + For example, `P25` is 25th percentile. Note that not all aggregations are available for metrics. + For example, `Trace count` has only `SUM` as an aggregation whereas `Call Count` has two aggregations, `SUM` and `PER_SECOND`. + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + uniqueItems: true + defaultAggregation: + type: string + description: The preselected aggregation for a metric. For example, for + `Call latency` the default aggregation is `MEAN`. + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + description: + type: string + description: A description of the metric. For example, for `Call count` + metric, the description would be something like `Number of received calls` + formatter: + type: string + description: | + * `NUMBER`: Generic number + * `BYTES`: Number of bytes + * `KILO_BYTES`: Number of kilobytes + * `MEGA_BYTES`: Number of megabytes + * `PERCENTAGE`: Percentage in scale [0,1] + * `PERCENTAGE_100`: Percentage in scale [0,100] + * `PERCENTAGE_NO_CAPPING`: Percentage in scale [0,1] but value could exceed 1 for example when metric is aggregated + * `PERCENTAGE_100_NO_CAPPING`: Percentage in scale [0,100] but value could exceed 100 for example when metric is aggregated + * `LATENCY`: Time in milliseconds, with value of 0 should not be considered a a strict 0, but considered as < 1ms + * `NANOS`: Time in nanoseconds + * `MILLIS`: Time in milliseconds + * `MICROS`: Time in microseconds + * `SECONDS`: Time in seconds + * `RATE`: Number of occurrences per second + * `BYTE_RATE`: Number of bytes per second + * `UNDEFINED`: Metric value unit is not known + label: + type: string + description: The name of the metric. For example, `Call count`, `Erroneous + calls`, `Service count` etc. + metricId: + type: string + description: The unique id of the metric. For example, `calls`, `erroneousCalls`, + `latency` etc. + required: + - aggregations + - formatter + - label + - metricId + MetricInstance: + type: object + properties: + custom: + type: boolean + description: + type: string + formatter: + type: string + description: | + | + * NUMBER: Generic number + * BYTES: Number of bytes + * KILO_BYTES: Number of kilobytes + * MEGA_BYTES: Number of megabytes + * PERCENTAGE: Percentage in scale [0,1] + * PERCENTAGE_100: Percentage in scale [0,100] + * PERCENTAGE_NO_CAPPING: Percentage in scale [0,1] but value could exceed 1 for example when metric is aggregated + * PERCENTAGE_100_NO_CAPPING: Percentage in scale [0,100] but value could exceed 100 for example when metric is aggregated + * LATENCY: Time in milliseconds, with value of 0 should not be considered a a strict 0, but considered as < 1ms + * NANOS: Time in nanoseconds + * MILLIS: Time in milliseconds + * MICROS: Time in microseconds + * SECONDS: Time in seconds + * RATE: Number of occurrences per second + * BYTE_RATE: Number of bytes per second + * UNDEFINED: Metric value unit is not known + enum: + - NUMBER + - BYTES + - KILO_BYTES + - MEGA_BYTES + - PERCENTAGE + - PERCENTAGE_100 + - PERCENTAGE_NO_CAPPING + - PERCENTAGE_100_NO_CAPPING + - LATENCY + - NANOS + - MILLIS + - MICROS + - SECONDS + - RATE + - BYTE_RATE + - UNDEFINED + label: + type: string + metricId: + type: string + pluginId: + type: string + required: + - description + - formatter + - label + - metricId + - pluginId + MetricItem: + type: object + properties: + from: + type: integer + format: int64 + description: Start of timeframe expressed as the Unix epoch time in milliseconds + host: + type: string + description: Host name + label: + type: string + description: Entitiy label + metrics: + type: object + additionalProperties: + type: array + items: + type: array + items: + type: number + plugin: + type: string + description: Plugin name + snapshotId: + type: string + description: Id of the exact metric you want to retrieve, eg. "cpu.user", + "clientrequests.read.mean" + tags: + type: array + description: Entitiy tags + items: + type: string + description: Entitiy tags + to: + type: integer + format: int64 + description: End of timeframe expressed as the Unix epoch time in milliseconds + MetricMetadata: + type: object + properties: + category: + type: string + description: Category of the metric + crossSeriesAggregations: + type: array + description: Possible cross series aggregation the metric supports + items: + type: string + description: Possible cross series aggregation the metric supports + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + uniqueItems: true + description: + type: string + description: Description of the metric + format: + type: string + description: | + | + * NUMBER: Generic number + * BYTES: Number of bytes + * KILO_BYTES: Number of kilobytes + * MEGA_BYTES: Number of megabytes + * PERCENTAGE: Percentage in scale [0,1] + * PERCENTAGE_100: Percentage in scale [0,100] + * PERCENTAGE_NO_CAPPING: Percentage in scale [0,1] but value could exceed 1 for example when metric is aggregated + * PERCENTAGE_100_NO_CAPPING: Percentage in scale [0,100] but value could exceed 100 for example when metric is aggregated + * LATENCY: Time in milliseconds, with value of 0 should not be considered a a strict 0, but considered as < 1ms + * NANOS: Time in nanoseconds + * MILLIS: Time in milliseconds + * MICROS: Time in microseconds + * SECONDS: Time in seconds + * RATE: Number of occurrences per second + * BYTE_RATE: Number of bytes per second + * UNDEFINED: Metric value unit is not known + enum: + - NUMBER + - BYTES + - KILO_BYTES + - MEGA_BYTES + - PERCENTAGE + - PERCENTAGE_100 + - PERCENTAGE_NO_CAPPING + - PERCENTAGE_100_NO_CAPPING + - LATENCY + - NANOS + - MILLIS + - MICROS + - SECONDS + - RATE + - BYTE_RATE + - UNDEFINED + id: + type: string + description: Identifier for the metric + infraTagCategory: + type: string + description: Category of the entity + enum: + - ACE + - ALICLOUD + - AWS + - AZURE + - CASSANDRA + - CLOUD_FOUNDRY + - CLR + - COCKROACH + - CONSUL + - CONTAINER + - COUCHBASE + - DFQ + - ELASTICSEARCH + - GCP + - HADOOP_YARN + - HAZELCAST + - IBM_CLOUD + - IBM_DATAPOWER + - IBM_I_SERIES + - IBM_MQ + - IBM_MQMFT + - IBM_OPENSTACK + - KAFKA_CONNECT + - KUBERNETES + - MONGO_DB + - OTHERS + - REDIS + - SAP + - SELF_MONITORING + - SOLR + - SPARK + - TIBCOBW + - TUXEDO + - VSHPERE + - WEBSPHERE + - CUSTOM_ENTITY + label: + type: string + description: Label for the metric + ownerType: + type: string + description: Type of the entity associated with the metric + tags: + type: array + description: Metric tags + items: + type: string + description: Metric tags + required: + - id + - infraTagCategory + - label + - ownerType + MetricPattern: + type: object + properties: + operator: + type: string + enum: + - is + - contains + - startsWith + - endsWith + - any + placeholder: + type: string + postfix: + type: string + prefix: + type: string + required: + - operator + - prefix + MetricQuery: + type: object + allOf: + - $ref: '#/components/schemas/ArithmeticOperand' + - type: object + properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + writeOnly: true + crossSeriesAggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + writeOnly: true + granularity: + type: integer + format: int64 + writeOnly: true + metric: + type: string + writeOnly: true + regex: + type: boolean + writeOnly: true + required: + type: boolean + writeOnly: true + MetricsResult: + type: object + properties: + metricsResult: + type: array + items: + $ref: '#/components/schemas/MetricsResultItem' + required: + - metricsResult + MetricsResultItem: + type: object + properties: + customTags: + type: object + additionalProperties: + type: string + description: A map of custom properties composed of the custom property + name and its value. This information will be included if the custom + properties were requested or if the query was grouped and the grouping + included one or more custom properties. + description: A map of custom properties composed of the custom property + name and its value. This information will be included if the custom properties + were requested or if the query was grouped and the grouping included one + or more custom properties. + metrics: + type: array + description: A map of the requested metrics, composed of the metric name + and its value. + items: + type: object + additionalProperties: + type: object + description: A map of the requested metrics, composed of the metric + name and its value. + description: A map of the requested metrics, composed of the metric name + and its value. + runType: + type: string + description: Indicates whether the test was scheduled to run or run now + tests: + type: array + description: A description of the Synthetic test associated with the result + item. This information will be included if the request was grouped by + synthetic.testId or if includeAggregatedTestId was true on the request. + items: + $ref: '#/components/schemas/MetricsTestResultItem' + required: + - metrics + MetricsTestResultItem: + type: object + description: A description of the Synthetic test associated with the result + item. This information will be included if the request was grouped by synthetic.testId + or if includeAggregatedTestId was true on the request. + properties: + applicationId: + type: string + description: An identifier of an application associated with the Synthetic + test. This field is deprecated and will be replace by the applicationIds + field. + applicationIds: + type: array + description: A list of the applications associated with the Synthetic test. + items: + type: string + description: A list of the applications associated with the Synthetic + test. + locationId: + type: array + description: A list of the locations associated with the Synthetic test. + items: + type: string + description: A list of the locations associated with the Synthetic test. + mobileApplicationIds: + type: array + description: A list of the mobile applications associated with the Synthetic + test. + items: + type: string + description: A list of the mobile applications associated with the Synthetic + test. + serviceId: + type: string + description: A service associated with the Synthetic test. + testId: + type: string + description: The testId for the Synthetic test. + testName: + type: string + description: The Synthetic test's name. + websiteIds: + type: array + description: A list of the websites associated with the Synthetic test. + items: + type: string + description: A list of the websites associated with the Synthetic test. + required: + - testId + MobileApp: + type: object + properties: + id: + type: string + maxLength: 128 + minLength: 0 + name: + type: string + maxLength: 128 + minLength: 0 + required: + - id + - name + MobileAppAlertConfig: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + completeTagFilterExpression: + $ref: '#/components/schemas/TagFilterExpression' + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the mobile app alert configuration. Used as + a template for the description of alert/event notifications triggered + by this Smart Alert configuration. + maxLength: 65536 + minLength: 0 + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + mobileAppId: + type: string + description: ID of the mobile app that this Smart Alert configuration is + applied to. + maxLength: 64 + minLength: 0 + name: + type: string + description: Name of the mobile app alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + rule: + $ref: '#/components/schemas/MobileAppAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdMobileAppAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/MobileAppTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + required: + - customPayloadFields + - description + - granularity + - mobileAppId + - name + - tagFilterExpression + - timeThreshold + MobileAppAlertRule: + type: object + discriminator: + mapping: + crash: '#/components/schemas/CrashMobileAppAlertRule' + customEvent: '#/components/schemas/CustomEventMobileAppAlertRule' + slowness: '#/components/schemas/SlownessMobileAppAlertRule' + statusCode: '#/components/schemas/StatusCodeMobileAppAlertRule' + throughput: '#/components/schemas/ThroughputMobileAppAlertRule' + propertyName: alertType + properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + alertType: + type: string + metricName: + type: string + required: + - alertType + - metricName + MobileAppBeaconGroupsItem: + type: object + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + properties: + cursor: + $ref: '#/components/schemas/IngestionOffsetCursor' + earliestTimestamp: + type: integer + format: int64 + minimum: 0 + metrics: + type: object + additionalProperties: + type: array + items: + type: array + items: + type: number + name: + type: string + required: + - cursor + - metrics + - name + MobileAppBeaconGroupsResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + canLoadMore: + type: boolean + description: Determine if additional data is available when a new query + is made using the cursor from the last item in the `items` list. + items: + type: array + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + items: + $ref: '#/components/schemas/MobileAppBeaconGroupsItem' + totalHits: + type: integer + format: int64 + description: The total number of items that match a given filter + minimum: 0 + totalRepresentedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, one row can represent multiple real + items (batched call, sample multiplicity) + minimum: 0 + totalRetainedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, only a subset is retained for historic + data. Each retained row can represent multiple real items due to batching. + minimum: 0 + required: + - items + MobileAppBeaconResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + canLoadMore: + type: boolean + description: Determine if additional data is available when a new query + is made using the cursor from the last item in the `items` list. + items: + type: array + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + items: + $ref: '#/components/schemas/MobileAppBeaconsItem' + totalHits: + type: integer + format: int64 + description: The total number of items that match a given filter + minimum: 0 + totalRepresentedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, one row can represent multiple real + items (batched call, sample multiplicity) + minimum: 0 + totalRetainedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, only a subset is retained for historic + data. Each retained row can represent multiple real items due to batching. + minimum: 0 + required: + - items + MobileAppBeaconTagGroup: + type: object + properties: + groupbyTag: + type: string + description: The name of the group tag (e.g. `agent.tag` or `docker.label`). + maxLength: 256 + minLength: 0 + groupbyTagEntity: + type: string + description: | + The entity by which the data should be grouped. + This field supports three possible values: `NOT_APPLICABLE`, `DESTINATION`, and `SOURCE`. + `SOURCE`: the tag filter should apply to the source entity. + `DESTINATION`: the tag filter should apply to the destination entity. + `NOT_APPLICABLE`: some tags are independent of source or destination, such as tags on the call itself, log tags or trace tags (only destination makes sense because the source is unknown for the root call). + enum: + - NOT_APPLICABLE + - DESTINATION + - SOURCE + groupbyTagSecondLevelKey: + type: string + description: If present, it's the 2nd level key part (e.g. `customKey` on + `docker.label.customKey`) + maxLength: 256 + minLength: 0 + required: + - groupbyTag + - groupbyTagEntity + MobileAppBeaconsItem: + type: object + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + properties: + beacon: + $ref: '#/components/schemas/MobileAppMonitoringBeacon' + cursor: + $ref: '#/components/schemas/IngestionOffsetCursor' + impactedBeaconInfo: + $ref: '#/components/schemas/ImpactedBeaconInfo' + required: + - beacon + - cursor + MobileAppEventResult: + type: object + allOf: + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + mobileAppId: + type: string + description: ID of the mobile app. + MobileAppMetricResult: + type: object + properties: + empty: + type: boolean + MobileAppMonitoringBeacon: + type: object + properties: + accuracyRadius: + type: integer + format: int64 + minimum: -1 + agentVersion: + type: string + maxLength: 128 + minLength: 0 + appBuild: + type: string + maxLength: 128 + minLength: 0 + appVersion: + type: string + maxLength: 128 + minLength: 0 + appVersionNumber: + type: integer + format: int64 + minimum: -1 + availableMb: + type: integer + format: int64 + minimum: -1 + backendTraceId: + type: string + maxLength: 128 + minLength: 0 + batchSize: + type: integer + format: int64 + minimum: 1 + beaconId: + type: string + maxLength: 128 + minLength: 0 + bundleIdentifier: + type: string + maxLength: 128 + minLength: 0 + bytesIngested: + type: integer + format: int64 + carrier: + type: string + maxLength: 256 + minLength: 0 + city: + type: string + maxLength: 256 + minLength: 0 + clockSkew: + type: integer + format: int64 + minimum: 0 + coldStartTimeMs: + type: integer + format: int64 + minimum: -1 + connectionType: + type: string + maxLength: 16 + minLength: 0 + continent: + type: string + maxLength: 256 + minLength: 0 + continentCode: + type: string + maxLength: 64 + minLength: 0 + country: + type: string + maxLength: 256 + minLength: 0 + countryCode: + type: string + maxLength: 64 + minLength: 0 + currentAppState: + type: string + maxLength: 24 + minLength: 0 + customEventName: + type: string + maxLength: 256 + minLength: 0 + customMetric: + type: number + format: double + decodedBodySize: + type: integer + format: int64 + minimum: -1 + deviceHardware: + type: string + maxLength: 128 + minLength: 0 + deviceManufacturer: + type: string + maxLength: 128 + minLength: 0 + deviceModel: + type: string + maxLength: 128 + minLength: 0 + dropView: + type: string + maxLength: 256 + minLength: 0 + duration: + type: integer + format: int64 + minimum: 0 + effectiveConnectionType: + type: string + maxLength: 16 + minLength: 0 + encodedBodySize: + type: integer + format: int64 + minimum: -1 + environment: + type: string + maxLength: 256 + minLength: 0 + errorCount: + type: integer + format: int64 + minimum: 0 + errorId: + type: string + maxLength: 128 + minLength: 0 + errorMessage: + type: string + maxLength: 16384 + minLength: 0 + errorType: + type: string + maxLength: 1024 + minLength: 0 + googlePlayServicesMissing: + type: boolean + hotStartTimeMs: + type: integer + format: int64 + minimum: -1 + httpCallHeaders: + type: object + additionalProperties: + type: string + httpCallMethod: + type: string + maxLength: 16 + minLength: 0 + httpCallOrigin: + type: string + maxLength: 1024 + minLength: 0 + httpCallPath: + type: string + maxLength: 4096 + minLength: 0 + httpCallStatus: + type: integer + format: int32 + maximum: 599 + minimum: -1 + httpCallUrl: + type: string + maxLength: 4096 + minLength: 0 + ingestionTime: + type: integer + format: int64 + minimum: 1 + internalMeta: + type: object + additionalProperties: + type: string + label: + type: string + latitude: + type: number + format: double + longitude: + type: number + format: double + maxMb: + type: integer + format: int64 + minimum: -1 + meta: + type: object + additionalProperties: + type: string + mobileAppId: + type: string + maxLength: 64 + minLength: 0 + mobileAppLabel: + type: string + maxLength: 128 + minLength: 0 + osName: + type: string + maxLength: 128 + minLength: 0 + osVersion: + type: string + maxLength: 128 + minLength: 0 + parentBeaconId: + type: string + parsedStackTrace: + type: string + maxLength: 16384 + minLength: 0 + performanceSubtype: + type: string + maxLength: 24 + minLength: 0 + platform: + type: string + maxLength: 32 + minLength: 0 + rateLimitBeaconType: + type: string + maxLength: 128 + minLength: 0 + rateLimitCount: + type: integer + format: int64 + minimum: 0 + rateLimitCustomMetricVal: + type: array + items: + type: number + format: float + rateLimitTimeMax: + type: integer + format: int64 + minimum: 0 + rateLimitTimeMin: + type: integer + format: int64 + minimum: 0 + region: + type: string + maxLength: 256 + minLength: 0 + rooted: + type: boolean + sessionId: + type: string + maxLength: 128 + minLength: 0 + stackTrace: + type: string + maxLength: 16384 + minLength: 0 + stackTraceKeyChecksum: + type: string + maxLength: 128 + minLength: 0 + stackTraceKeyInformation: + type: string + maxLength: 1024 + minLength: 0 + stackTraceLine: + type: array + items: + $ref: '#/components/schemas/StackTraceLine' + maxItems: 128 + minItems: 0 + stackTraceParsingStatus: + type: integer + format: int32 + minimum: -1 + subdivision: + type: string + maxLength: 256 + minLength: 0 + subdivisionCode: + type: string + maxLength: 64 + minLength: 0 + tenant: + type: string + maxLength: 256 + minLength: 0 + timestamp: + type: integer + format: int64 + minimum: 1 + transferSize: + type: integer + format: int64 + minimum: -1 + type: + type: string + maxLength: 24 + minLength: 0 + unit: + type: string + maxLength: 256 + minLength: 0 + useFeatures: + type: array + items: + type: string + maxItems: 15 + minItems: 0 + usedMb: + type: integer + format: int64 + minimum: -1 + userEmail: + type: string + maxLength: 128 + minLength: 0 + userId: + type: string + maxLength: 128 + minLength: 0 + userIp: + type: string + maxLength: 45 + minLength: 0 + userLanguages: + type: array + items: + type: string + maxItems: 5 + minItems: 0 + userName: + type: string + maxLength: 128 + minLength: 0 + userSessionId: + type: string + maxLength: 128 + minLength: 0 + view: + type: string + maxLength: 256 + minLength: 0 + viewportHeight: + type: integer + format: int32 + minimum: -1 + viewportWidth: + type: integer + format: int32 + minimum: -1 + warmStartTimeMs: + type: integer + format: int64 + minimum: -1 + required: + - beaconId + - mobileAppId + - performanceSubtype + - rateLimitBeaconType + - type + MobileAppMonitoringMetricDescription: + type: object + properties: + aggregations: + type: array + description: | + The types of aggregations that can be applied to a series of values. + For example, `P25` is 25th percentile. Note that not all aggregations are available for metrics. + For example, `Trace count` has only `SUM` as an aggregation whereas `Call Count` has two aggregations, `SUM` and `PER_SECOND`. + items: + type: string + description: | + The types of aggregations that can be applied to a series of values. + For example, `P25` is 25th percentile. Note that not all aggregations are available for metrics. + For example, `Trace count` has only `SUM` as an aggregation whereas `Call Count` has two aggregations, `SUM` and `PER_SECOND`. + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + uniqueItems: true + beaconTypes: + type: array + items: + type: string + uniqueItems: true + defaultAggregation: + type: string + description: The preselected aggregation for a metric. For example, for + `Call latency` the default aggregation is `MEAN`. + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + description: + type: string + description: A description of the metric. For example, for `Call count` + metric, the description would be something like `Number of received calls` + formatter: + type: string + description: | + * `NUMBER`: Generic number + * `BYTES`: Number of bytes + * `KILO_BYTES`: Number of kilobytes + * `MEGA_BYTES`: Number of megabytes + * `PERCENTAGE`: Percentage in scale [0,1] + * `PERCENTAGE_100`: Percentage in scale [0,100] + * `PERCENTAGE_NO_CAPPING`: Percentage in scale [0,1] but value could exceed 1 for example when metric is aggregated + * `PERCENTAGE_100_NO_CAPPING`: Percentage in scale [0,100] but value could exceed 100 for example when metric is aggregated + * `LATENCY`: Time in milliseconds, with value of 0 should not be considered a a strict 0, but considered as < 1ms + * `NANOS`: Time in nanoseconds + * `MILLIS`: Time in milliseconds + * `MICROS`: Time in microseconds + * `SECONDS`: Time in seconds + * `RATE`: Number of occurrences per second + * `BYTE_RATE`: Number of bytes per second + * `UNDEFINED`: Metric value unit is not known + label: + type: string + description: The name of the metric. For example, `Call count`, `Erroneous + calls`, `Service count` etc. + metricId: + type: string + description: The unique id of the metric. For example, `calls`, `erroneousCalls`, + `latency` etc. + pathToValueInBeacon: + type: array + items: + type: string + maxItems: 2147483647 + minItems: 1 + secondaryBeaconTypes: + type: array + items: + type: string + uniqueItems: true + tagName: + type: string + required: + - aggregations + - beaconTypes + - formatter + - label + - metricId + MobileAppMonitoringMetricsConfiguration: + type: object + properties: + aggregation: + type: string + description: 'Set aggregation that can be applied to a series of values. + Eg: `MEAN`.' + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + granularity: + type: integer + format: int32 + description: 'If the granularity is set you will get data points with the + specified granularity in seconds. Default: `1000` milliseconds' + metric: + type: string + description: 'Set a particular metric, eg: `latency`.' + numeratorTagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + required: + - aggregation + - metric + MobileAppTimeThreshold: + type: object + description: The type of threshold to define the criteria when the event and + alert triggers and resolves. + discriminator: + mapping: + userImpactOfViolationsInSequence: '#/components/schemas/UserImpactMobileAppTimeThreshold' + violationsInPeriod: '#/components/schemas/ViolationsInPeriodMobileAppTimeThreshold' + violationsInSequence: '#/components/schemas/ViolationsInSequenceMobileAppTimeThreshold' + propertyName: type + properties: + timeWindow: + type: integer + format: int64 + type: + type: string + required: + - type + MonitoredEntitiesStats: + type: object + description: Statistics of monitored entities. + properties: + hostCount: + type: integer + format: int32 + otelCount: + type: integer + format: int32 + serverlessCount: + type: integer + format: int32 + MonitoringState: + type: object + properties: + hasEntities: + type: boolean + description: Has entities + hostCount: + type: integer + format: int32 + description: Count of hosts + monitoredEntitiesStats: + $ref: '#/components/schemas/MonitoredEntitiesStats' + openTelemetryCount: + type: integer + format: int32 + description: Count of open telemetry + serverlessCount: + type: integer + format: int32 + description: Count of serverless + MultipleScriptsConfiguration: + type: object + properties: + bundle: + type: string + scriptFile: + type: string + Multiplication: + type: object + allOf: + - $ref: '#/components/schemas/ArithmeticOperation' + required: + - left + - right + NestedOperation: + type: object + allOf: + - $ref: '#/components/schemas/ArithmeticOperand' + - type: object + properties: + operation: + $ref: '#/components/schemas/ArithmeticOperation' + NewApplicationConfig: + type: object + properties: + accessRules: + type: array + description: | + Defines permissions and access relationships. + items: + $ref: '#/components/schemas/AccessRule' + maxItems: 64 + minItems: 1 + boundaryScope: + type: string + description: | + **INBOUND**: Inbound calls are calls initiated from outside the application and where the destination service is part of the selected application perspective. + + **ALL**: Results and metrics for not only calls at the application perspective boundary, but also those occurring within the application perspective. + + **DEFAULT**: Default value, for Application Perspectives created before the introduction of `ALL` and `INBOUND`. + At present, whenever new Application Perspectives are created, there are only 2 options to select: `ALL` or `INBOUND`. + It is recommended to use either `ALL` or `INBOUND` as `DEFAULT` is deprecated. `DEFAULT` is treated as `INBOUND`. + enum: + - ALL + - INBOUND + - DEFAULT + label: + type: string + description: 'Name of the Application Perspective. Eg: `app1`.' + maxLength: 128 + minLength: 1 + matchSpecification: + $ref: '#/components/schemas/MatchExpressionDTO' + scope: + type: string + description: | + **INCLUDE_NO_DOWNSTREAM** : Only the selected services from the filters are included (call this the core set). + This is useful when you treat the services as opaque. + An example would be the services that represent 3rd party APIs. + + **INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING** : Include the core set of services from the filters and then expand this core set to include the database and messaging services that the core set directly interacts with. + This is useful if you are want to monitor a set of services and their direct dependencies. + For example, a development team responsible for several micro-services. + + **INCLUDE_ALL_DOWNSTREAM** : It effortlessly and automatically includes all the services that form the entire end-to-end dependency chain of the core set of services. + This is useful if the AP will be used for troubleshooting. + enum: + - INCLUDE_NO_DOWNSTREAM + - INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING + - INCLUDE_ALL_DOWNSTREAM + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + required: + - accessRules + - boundaryScope + - label + - scope + NewBusinessPerspectiveConfig: + type: object + properties: + description: + type: string + maxLength: 300 + minLength: 0 + name: + type: string + maxLength: 100 + minLength: 0 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + NewManualServiceConfig: + type: object + properties: + description: + type: string + description: A description of the manual service configuration. + enabled: + type: boolean + description: Enable or disable the manual service configuration. By default + it is enabled. + existingServiceId: + type: string + description: The service ID of the existing monitored service to which the + calls should be linked. + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + unmonitoredServiceName: + type: string + description: A service name if you want to map calls to an unmonitored service. + required: + - tagFilterExpression + OAuthConfig: + type: object + properties: + additionalParameters: + type: object + additionalProperties: + type: string + clientId: + type: string + clientSecret: + type: string + grantType: + type: string + enum: + - CLIENT_CREDENTIALS + - PASSWORD + password: + type: string + writeOnly: true + tokenUrl: + type: string + username: + type: string + writeOnly: true + required: + - clientId + - clientSecret + - tokenUrl + OAuthIntegration: + type: object + properties: + config: + $ref: '#/components/schemas/OAuthConfig' + token: + $ref: '#/components/schemas/OAuthToken' + OAuthToken: + type: object + properties: + accessToken: + type: string + createdAt: + type: string + format: date-time + expiresAt: + type: string + format: date-time + refreshToken: + type: string + status: + type: string + enum: + - VALID + - INVALID + tokenType: + type: string + valid: + type: boolean + Occurrence: + type: object + description: Time window of the Maintence Window configuration occurrences. + properties: + end: + type: integer + format: int64 + minimum: 1 + start: + type: integer + format: int64 + minimum: 0 + Office365Integration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + webhookUrl: + type: string + required: + - id + - kind + - name + - webhookUrl + OneTimeMaintenanceWindow: + type: object + allOf: + - $ref: '#/components/schemas/MaintenanceConfigScheduling' + required: + - duration + - start + - type + OpsgenieIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + alias: + type: string + apiKey: + type: string + region: + type: string + enum: + - US + - EU + tags: + type: string + required: + - apiKey + - id + - kind + - name + - region + Order: + type: object + description: | + Specifies the ordering of the results. + It contains fields that define the sorting criteria, the collation for sorting, and the direction in which the results should be ordered. + properties: + by: + type: string + description: If the granularity is set to `1` you can use the metric name + eg. `latency.p95` to order by that value. + collation: + type: string + description: Language code used for sorting. Ignored for infrastructure + queries. + direction: + type: string + description: The order in which results will be sorted, either `ASC` for + ascending or `DESC` for descending. + enum: + - ASC + - DESC + required: + - by + - direction + PagerdutyIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + serviceIntegrationKey: + type: string + required: + - id + - kind + - name + - serviceIntegrationKey + PaginatedResult: + type: object + properties: + items: + type: array + items: + type: object + page: + type: integer + format: int32 + description: Page Number + minimum: 1 + pageSize: + type: integer + format: int32 + minimum: 1 + totalHits: + type: integer + format: int64 + minimum: 0 + required: + - items + Pagination: + type: object + properties: + page: + type: integer + format: int32 + description: Page number for a specific page in the results. For example, + if you'd like to retrieve the 5th page out of 10 pages, the value would + be 5. + minimum: 1 + pageSize: + type: integer + format: int32 + description: 'Set the number of items you want to return with one query. + Eg: if you want to retrieve 10 items, the value would be 10.' + maximum: 200 + minimum: 1 + Parameter: + type: object + description: List of inputs to the action. + properties: + description: + type: string + description: Parameter description. + hidden: + type: boolean + description: Is parameter hidden or not. + label: + type: string + description: Parameter label. + name: + type: string + description: Parameter name. + required: + type: boolean + description: Is parameter required or not. + secured: + type: boolean + description: Is parameter secured or not. + type: + type: string + description: Parameter type. Valid values are `static`, `dynamic`, or `vault`. + Default value is `static` + value: + type: string + description: Parameter value. + required: + - label + - name + - type + ParameterValue: + type: object + description: List of action input parameters. + properties: + name: + type: string + description: Parameter name. + value: + type: string + description: Parameter value. + required: + - name + - value + PathParameterHttpPathSegmentMatchingRule: + type: object + allOf: + - $ref: '#/components/schemas/HttpPathSegmentMatchingRule' + - type: object + properties: + name: + type: string + description: | + Given `/api/{version}/users` URI, `PARAMETER` name is `version`. + required: + - name + - type + PhysicalContext: + type: object + description: | + The physical context of an entity. This is typically used to describe where a host, container or process fits into the infrastructure. + 1. `cloudfoundry`: Contains physical context of Cloudfoundry. + 2. `cluster`: Contains physical context of cluster like Hazelcast, Elasticsearch. + 3. `container`: Contains physical context of container. + 4. `host`: Contains physical context of host. + 5. `kubernetes`: Contains physical context of Kubernetes. + 6. `process`: Contains physical context of a process. + properties: + cloudfoundry: + $ref: '#/components/schemas/CloudfoundryPhysicalContext' + cluster: + $ref: '#/components/schemas/SnapshotPreview' + container: + $ref: '#/components/schemas/SnapshotPreview' + host: + $ref: '#/components/schemas/SnapshotPreview' + kubernetes: + $ref: '#/components/schemas/KubernetesPhysicalContext' + process: + $ref: '#/components/schemas/SnapshotPreview' + PluginResult: + type: object + properties: + label: + type: string + description: Plugin name + plugin: + type: string + description: Plugin ID + Policy: + type: object + properties: + description: + type: string + description: Policy description. + maxLength: 512 + minLength: 0 + id: + type: string + description: Policy identifier. + maxLength: 128 + minLength: 1 + readOnly: true + name: + type: string + description: Policy name. + maxLength: 128 + minLength: 1 + tags: + type: array + description: A list of policy tags. + items: + type: string + description: A list of policy tags. + trigger: + $ref: '#/components/schemas/Trigger' + typeConfigurations: + type: array + description: List of configurations that contains the list of actions to + run and the mode (automatic or manual) in which the policy is run. + items: + $ref: '#/components/schemas/TypeConfiguration' + required: + - id + - name + - trigger + - typeConfigurations + PolicyRunnable: + type: object + description: Runnable associated with the policy. It can be a `workflow` or + `action`. Currently only supports `action`. + properties: + id: + type: string + description: Action identifier. + runConfiguration: + $ref: '#/components/schemas/RunConfiguration' + type: + type: string + description: Type of runnable. Supported value is `action`. + enum: + - action + - workflow + required: + - id + - runConfiguration + - type + PolicyScheduling: + type: object + description: Scheduling information for a scheduled policy. + properties: + recurrentRule: + type: string + description: 'Recurrent Rule defines how the policy recurs, using iCalendar + RRULE format (e.g., `FREQ=DAILY;INTERVAL=1`).It supports fields like FREQ, + INTERVAL, BYDAY. Refer to RFC 5545: https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10' + startTime: + type: string + format: date-time + description: The time to run the policy action in milliseconds since epoch + (UTC) (e.g., `1706713140000`). + required: + - startTime + PostSnapshotsResult: + type: object + properties: + items: + type: array + description: Detail information for requested snapshots. + items: + $ref: '#/components/schemas/SnapshotItem' + notFoundSnapshotsIds: + type: array + description: Snapshot ids for snapshots that could not be retrieved. + items: + type: string + description: Snapshot ids for snapshots that could not be retrieved. + Problem: + type: object + properties: + fixSuggestion: + type: string + maxLength: 65536 + minLength: 0 + id: + type: string + maxLength: 64 + minLength: 0 + problemText: + type: string + maxLength: 2048 + minLength: 0 + severity: + type: integer + format: int32 + required: + - id + PrometheusWebhookIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + receiver: + type: string + webhookUrl: + type: string + required: + - id + - kind + - name + - webhookUrl + RecurrentMaintenanceWindow: + type: object + allOf: + - $ref: '#/components/schemas/MaintenanceConfigScheduling' + - type: object + properties: + rrule: + type: string + timezoneId: + type: string + required: + - duration + - rrule + - start + - type + Release: + type: object + properties: + applications: + type: array + description: The list of application perspectives where the release can + be viewed. + items: + $ref: '#/components/schemas/ApplicationScope' + maxItems: 10 + minItems: 0 + name: + type: string + description: 'The name of the release. For example: `frontend/release-2000`.' + maxLength: 256 + minLength: 0 + services: + type: array + description: The list of services where the release can be viewed. + items: + $ref: '#/components/schemas/ServiceScope' + maxItems: 10 + minItems: 0 + start: + type: integer + format: int64 + description: 'The timestamp for when the release is created. The time measured + is in milliseconds. For example: `1742349976000` is `Wednesday, 19 March + 2025 02:06:16 GMT`.' + minimum: 1 + required: + - name + - start + ReleaseScope: + type: object + properties: + applicationId: + type: string + applicationName: + type: string + serviceId: + type: string + serviceName: + type: string + ReleaseWithMetadata: + type: object + properties: + applications: + type: array + description: The list of application perspectives where the release can + be viewed. + items: + $ref: '#/components/schemas/ApplicationScopeWithMetadata' + maxItems: 10 + minItems: 0 + id: + type: string + description: 'A unique id for a release. For example: `l1wgr3DsQkGLf8u18JiGsg`.' + maxLength: 64 + minLength: 0 + lastUpdated: + type: integer + format: int64 + description: 'The timestamp for when the same release is updated. The time + measured is in milliseconds. For example: `1742369990000` is `Wednesday, + 19 March 2025 07:39:50 GMT`.' + minimum: 1 + name: + type: string + description: 'The name of the release. For example: `frontend/release-2000`.' + maxLength: 256 + minLength: 0 + scopes: + type: array + items: + $ref: '#/components/schemas/ReleaseScope' + writeOnly: true + services: + type: array + description: The list of services where the release can be viewed. + items: + $ref: '#/components/schemas/ServiceScopeWithMetadata' + maxItems: 10 + minItems: 0 + start: + type: integer + format: int64 + description: 'The timestamp for when the release is created. The time measured + is in milliseconds. For example: `1742349976000` is `Wednesday, 19 March + 2025 02:06:16 GMT`.' + minimum: 1 + required: + - id + - name + RetentionPeriod: + type: object + properties: + logVolume: + type: integer + format: int64 + logVolumeGroups: + type: array + items: + $ref: '#/components/schemas/LogVolumeGroup' + retentionDays: + type: integer + format: int32 + maximum: 90 + minimum: 7 + required: + - logVolume + RollingTimeWindow: + type: object + allOf: + - $ref: '#/components/schemas/TimeWindow' + required: + - duration + - durationUnit + RuleInput: + type: object + description: List of input rules of the Built-in Event Specification + properties: + inputKind: + type: string + enum: + - METRIC + - SNAPSHOT_FIELD + - EVENT + - DERIVED_METRIC + - METRIC_PATTERN + inputName: + type: string + maxLength: 256 + minLength: 0 + required: + - inputKind + - inputName + RuleWithThresholdApplicationAlertRule: + type: object + description: A list of rules where each rule is associated with multiple thresholds + and their corresponding severity levels. This enables more complex alert configurations + with validations to ensure consistent and logical threshold-severity combinations. + properties: + rule: + $ref: '#/components/schemas/ApplicationAlertRule' + thresholdOperator: + type: string + enum: + - '>' + - '>=' + - < + - <= + thresholds: + type: object + additionalProperties: + $ref: '#/components/schemas/ThresholdConfigRule' + required: + - rule + - thresholdOperator + - thresholds + RuleWithThresholdInfraAlertRule: + type: object + description: A list of rules where each rule is associated with multiple thresholds + and their corresponding severity levels. This enables more complex alert configurations + with validations to ensure consistent and logical threshold-severity combinations. + properties: + rule: + $ref: '#/components/schemas/InfraAlertRule' + thresholdOperator: + type: string + enum: + - '>' + - '>=' + - < + - <= + thresholds: + type: object + additionalProperties: + $ref: '#/components/schemas/ThresholdConfigRule' + required: + - rule + - thresholdOperator + - thresholds + RuleWithThresholdLogAlertRule: + type: object + description: A list of rules where each rule is associated with multiple thresholds + and their corresponding severity levels. This enables more complex alert configurations + with validations to ensure consistent and logical threshold-severity combinations. + properties: + rule: + $ref: '#/components/schemas/LogAlertRule' + thresholdOperator: + type: string + enum: + - '>' + - '>=' + - < + - <= + thresholds: + type: object + additionalProperties: + $ref: '#/components/schemas/ThresholdConfigRule' + required: + - rule + - thresholdOperator + - thresholds + RuleWithThresholdMobileAppAlertRule: + type: object + description: A list of rules where each rule is associated with multiple thresholds + and their corresponding severity levels. This enables more complex alert configurations + with validations to ensure consistent and logical threshold-severity combinations. + properties: + rule: + $ref: '#/components/schemas/MobileAppAlertRule' + thresholdOperator: + type: string + enum: + - '>' + - '>=' + - < + - <= + thresholds: + type: object + additionalProperties: + $ref: '#/components/schemas/ThresholdConfigRule' + required: + - rule + - thresholdOperator + - thresholds + RuleWithThresholdWebsiteAlertRule: + type: object + description: A list of rules where each rule is associated with multiple thresholds + and their corresponding severity levels. This enables more complex alert configurations + with validations to ensure consistent and logical threshold-severity combinations. + properties: + rule: + $ref: '#/components/schemas/WebsiteAlertRule' + thresholdOperator: + type: string + enum: + - '>' + - '>=' + - < + - <= + thresholds: + type: object + additionalProperties: + $ref: '#/components/schemas/ThresholdConfigRule' + required: + - rule + - thresholdOperator + - thresholds + RunConfiguration: + type: object + description: Action run configuration. + properties: + actions: + type: array + description: List of action configurations. + items: + $ref: '#/components/schemas/ActionConfiguration' + required: + - actions + SLOConfigWithRBACTag: + type: object + properties: + createdDate: + type: string + format: date-time + description: Created date of Service Levels Objective Configuration + entity: + $ref: '#/components/schemas/SloEntity' + id: + type: string + description: Service Levels Objective Configuration ID + maxLength: 64 + minLength: 0 + indicator: + $ref: '#/components/schemas/ServiceLevelIndicator' + lastUpdated: + type: string + format: date-time + description: Last updated date of Service Levels Objective Configuration + name: + type: string + description: Name of the Service Levels Objective Configuration + rbacTags: + type: array + items: + $ref: '#/components/schemas/ApiTag' + uniqueItems: true + tags: + type: array + description: List of tags associated with Service Levels Objective Configuration + items: + type: string + description: List of tags associated with Service Levels Objective Configuration + target: + type: number + format: double + description: Service Levels Objective Configuration Target + exclusiveMaximum: false + exclusiveMinimum: true + maximum: 0.9999 + minimum: 0.0 + timeWindow: + $ref: '#/components/schemas/TimeWindow' + required: + - entity + - indicator + - name + - tags + - target + - timeWindow + SSLCertificateConfiguration: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + acceptSelfSignedCertificate: + type: boolean + daysRemainingCheck: + type: integer + format: int32 + maximum: 365 + minimum: 1 + hostname: + type: string + maxLength: 2047 + minLength: 0 + port: + type: integer + format: int32 + validationRules: + type: array + items: + $ref: '#/components/schemas/SSLCertificateValidation' + required: + - daysRemainingCheck + - hostname + - markSyntheticCall + - syntheticType + SSLCertificateConfigurationUpdate: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - type: object + properties: + acceptSelfSignedCertificate: + type: boolean + daysRemainingCheck: + type: integer + format: int32 + hostname: + type: string + port: + type: integer + format: int32 + validationRules: + $ref: '#/components/schemas/SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation' + SSLCertificateValidation: + type: object + properties: + key: + type: string + operator: + type: string + enum: + - CONTAINS + - EQUALS + - GREATER_THAN + - IS + - LESS_THAN + - MATCHES + - NOT_MATCHES + value: + type: object + required: + - key + - operator + - value + SalesforceIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + bearerToken: + type: string + clientId: + type: string + clientSecret: + type: string + salesforceUrl: + type: string + required: + - clientId + - clientSecret + - id + - kind + - name + - salesforceUrl + SaturationBlueprintIndicator: + type: object + allOf: + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + properties: + metricName: + type: string + threshold: + type: number + format: double + description: Threshold Value for the Blueprint + exclusiveMinimum: false + minimum: 0.0 + required: + - type + ScopeBinding: + type: object + properties: + scopeId: + type: string + maxLength: 64 + minLength: 0 + scopeRoleId: + type: string + maxLength: 64 + minLength: 0 + SearchFieldResult: + type: object + properties: + context: + type: string + description: Field context + enum: + - entities + - events + - applications + - services + - endpoints + - appdata_shared + - default_field + example: Entity data, trace data, even data + description: + type: string + description: Description of the keyword + fixedValues: + type: array + description: Fixed value associated to the keyword + items: + type: string + description: Fixed value associated to the keyword + keyword: + type: string + description: Retrieved keyword + termType: + type: string + description: Term type + enum: + - string + - long + - double + - bool + - key_value + - id + Service: + type: object + properties: + entityType: + type: string + description: Since, this is a Service, it will be of type `SERVICE`. + enum: + - APPLICATION + - SERVICE + - ENDPOINT + id: + type: string + description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.' + label: + type: string + description: 'Name of the Service. Eg: `payment`.' + snapshotIds: + type: array + description: A unique identifier the metrics are assigned to. + items: + type: string + description: A unique identifier the metrics are assigned to. + uniqueItems: true + technologies: + type: array + description: 'List of technologies: `Eg:["springbootApplicationContainer"]`' + items: + type: string + description: 'List of technologies: `Eg:["springbootApplicationContainer"]`' + uniqueItems: true + types: + type: array + description: 'Shows types of Endpoints a Service can consist of. It may + be one or more. Eg: `HTTP` `OPENTELEMETRY` can be in 1 Service.' + items: + type: string + description: 'Shows types of Endpoints a Service can consist of. It may + be one or more. Eg: `HTTP` `OPENTELEMETRY` can be in 1 Service.' + enum: + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - DATABASE + - MESSAGING + - PAGE + - PAGE_RESOURCE + uniqueItems: true + required: + - id + - label + - snapshotIds + - technologies + - types + ServiceConfig: + type: object + properties: + comment: + type: string + description: | + A small description of the service configuration would be present in this field if it was provided during creation of the custom service rule. + If it was not provided, this field will remain empty. It is considered as best practice to add a comment to document the reasoning behind creating the rule. + maxLength: 2048 + minLength: 0 + enabled: + type: boolean + description: If enabled, calls will be mapped to the rule. + id: + type: string + description: 'A unique string for the service configuration. Eg: `G510hmXYSDysLZ5kuj0BaQ`' + label: + type: string + description: | + It contains the tags defined in `matchSpecification` concatenated with a dash. + Eg: if the `matchSpecification` contains keys `kubernetes.namespace.name` and `docker.label`, `label` would be `kubernetes.namespace.name-docker.label`. + matchSpecification: + type: array + description: Calls will be matched with the array of key-value tags present + in this field. + items: + $ref: '#/components/schemas/ServiceMatchingRule' + maxItems: 20 + minItems: 0 + name: + type: string + description: 'The name of the service configuration. Eg: `Rule ABC`' + maxLength: 128 + minLength: 1 + required: + - enabled + - id + - label + - matchSpecification + - name + ServiceEventResult: + type: object + allOf: + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + applicationId: + type: string + description: ID of the application this service is in scope of. + serviceId: + type: string + description: ID of the service. + ServiceItem: + type: object + properties: + metrics: + type: object + additionalProperties: + type: array + items: + type: array + items: + type: number + service: + $ref: '#/components/schemas/Service' + required: + - metrics + - service + ServiceLevelIndicator: + type: object + description: Indicator of the Service Levels Objective Configuration, it indicates + the type of metric by which the SLO should be evaluated + discriminator: + mapping: + availability: '#/components/schemas/AvailabilityBlueprintIndicator' + custom: '#/components/schemas/CustomBlueprintIndicator' + latency: '#/components/schemas/LatencyBlueprintIndicator' + saturation: '#/components/schemas/SaturationBlueprintIndicator' + traffic: '#/components/schemas/TrafficBlueprintIndicator' + propertyName: blueprint + properties: + aggregation: + type: string + description: Aggregation Type for the Threshold Value + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + blueprint: + type: string + enum: + - latency + - availability + - traffic + - saturation + - custom + operator: + type: string + description: Operator for the Threshold Value + enum: + - '>' + - '>=' + - < + - <= + serviceLevelsMeasurement: + type: string + description: Defines Measurement Type of SLO + enum: + - eventBased + - timeBased + - erroneous + - all + threshold: + type: number + format: double + description: Threshold Value for the Blueprint + type: + type: string + enum: + - eventBased + - timeBased + ServiceLevelObjectiveAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/ServiceLevelsAlertRule' + - type: object + properties: + metric: + type: string + description: This is the service levels metric type. Service levels objective + alerts using status metric. + enum: + - STATUS + ServiceLevelsAlertConfig: + type: object + properties: + alertChannelIds: + type: array + description: This is the list of channel IDs when alert triggered and sent + to. + items: + type: string + description: This is the list of channel IDs when alert triggered and + sent to. + maxItems: 1024 + minItems: 0 + uniqueItems: true + burnRateConfig: + type: array + description: This is the burn rate alert configuration which defines alerting + windows and corresponding thresholds. This configuration must to specified + for BURN_RATE_V2 Alerts. + items: + $ref: '#/components/schemas/ServiceLevelsBurnRateConfig' + uniqueItems: true + burnRateTimeWindows: + $ref: '#/components/schemas/ServiceLevelsBurnRateTimeWindows' + customPayloadFields: + type: array + description: This is the custom name and value pairs to be sent along with + the alert to the alert channels. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: The description of the alert. It is also the alert message + content. + maxLength: 65536 + minLength: 0 + name: + type: string + description: Name of the Service Levels Smart Alerts Configuration. + maxLength: 256 + minLength: 0 + rule: + $ref: '#/components/schemas/ServiceLevelsAlertRule' + severity: + type: integer + format: int32 + description: 'This is the severity of the alert. The value can be: 5: + warning, 10: critical.' + sloIds: + type: array + description: This is the list of SLO configurations related to this alert. + items: + type: string + description: This is the list of SLO configurations related to this alert. + maxItems: 1024 + minItems: 0 + uniqueItems: true + threshold: + $ref: '#/components/schemas/StaticThreshold' + timeThreshold: + $ref: '#/components/schemas/ServiceLevelsTimeThreshold' + triggering: + type: boolean + description: Incident flag. If value is true, this alert will become an + accident. + required: + - alertChannelIds + - customPayloadFields + - description + - name + - rule + - severity + - sloIds + - timeThreshold + ServiceLevelsAlertRule: + type: object + description: This is the service levels alert type. It could be error budget + alert or service levels object alert. + discriminator: + mapping: + ERROR_BUDGET: '#/components/schemas/ErrorBudgetAlertRule' + SERVICE_LEVELS_OBJECTIVE: '#/components/schemas/ServiceLevelObjectiveAlertRule' + propertyName: alertType + properties: + alertType: + type: string + required: + - alertType + ServiceLevelsBurnRateConfig: + type: object + description: This is the burn rate alert configuration which defines alerting + windows and corresponding thresholds. This configuration must to specified + for BURN_RATE_V2 Alerts. + properties: + alertWindowType: + type: string + description: 'Specifies the Burn Rate Alerting Window type: SINGLE for single + window/threshold alerts, or LONG and SHORT for multi-window/threshold + alerts.' + enum: + - SINGLE + - LONG + - SHORT + duration: + type: integer + format: int32 + description: Duration of the Burn Rate Alerting Window. + durationUnitType: + type: string + description: Duration Unit Type of the Burn Rate Alerting Window. + enum: + - millisecond + - second + - minute + - hour + - day + - week + - month + threshold: + $ref: '#/components/schemas/ServiceLevelsStaticThresholdConfig' + required: + - duration + - durationUnitType + - threshold + ServiceLevelsBurnRateTimeWindows: + type: object + deprecated: true + description: This is the short and long time window setting for the burn rate + alerts. + properties: + longTimeWindow: + $ref: '#/components/schemas/AlertingTimeWindow' + shortTimeWindow: + $ref: '#/components/schemas/AlertingTimeWindow' + ServiceLevelsStaticThresholdConfig: + type: object + description: This threshold defines a static value to be evaluated with a specific + operator for burn rate v2 alerts. + properties: + lastUpdated: + type: integer + format: int64 + minimum: 0 + operator: + type: string + enum: + - '>' + - '>=' + - < + - <= + value: + type: number + format: double + minimum: 0 + required: + - operator + ServiceLevelsTimeThreshold: + type: object + description: This is the warm-up and cool-down setting to emit or stop alert + event after threshold reached. + properties: + expiry: + type: integer + format: int64 + description: This is the cooldown period when the active alert misses threshold + and stop emitting notification. + timeWindow: + type: integer + format: int64 + description: This is the grace period when the threshold is reached and + the alert becomes active to emit notification. + required: + - expiry + - timeWindow + ServiceLevelseAlertConfigWithMetadata: + type: object + properties: + alertChannelIds: + type: array + description: This is the list of channel IDs when alert triggered and sent + to. + items: + type: string + description: This is the list of channel IDs when alert triggered and + sent to. + maxItems: 1024 + minItems: 0 + uniqueItems: true + burnRateConfig: + type: array + description: This is the burn rate alert configuration which defines alerting + windows and corresponding thresholds. This configuration must to specified + for BURN_RATE_V2 Alerts. + items: + $ref: '#/components/schemas/ServiceLevelsBurnRateConfig' + uniqueItems: true + burnRateTimeWindows: + $ref: '#/components/schemas/ServiceLevelsBurnRateTimeWindows' + created: + type: integer + format: int64 + description: Created Date of the version of Service Levels Smart Alerts + Configuration. + minimum: 1 + customPayloadFields: + type: array + description: This is the custom name and value pairs to be sent along with + the alert to the alert channels. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: The description of the alert. It is also the alert message + content. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + description: Boolean Parameter specifying the enabled state of Service Levels + Smart Alerts Configuration. + id: + type: string + description: Unique ID of the Service Levels Smart Alerts Configuration. + maxLength: 64 + minLength: 0 + initialCreated: + type: integer + format: int64 + description: Created Date of the Initial version of Service Levels Smart + Alerts Configuration. + minimum: 1 + name: + type: string + description: Name of the Service Levels Smart Alerts Configuration. + maxLength: 256 + minLength: 0 + readOnly: + type: boolean + description: Boolean Parameter specifying the readonly access to Service + Levels Smart Alerts Configuration. + rule: + $ref: '#/components/schemas/ServiceLevelsAlertRule' + severity: + type: integer + format: int32 + description: 'This is the severity of the alert. The value can be: 5: + warning, 10: critical.' + sloIds: + type: array + description: This is the list of SLO configurations related to this alert. + items: + type: string + description: This is the list of SLO configurations related to this alert. + maxItems: 1024 + minItems: 0 + uniqueItems: true + threshold: + $ref: '#/components/schemas/StaticThreshold' + timeThreshold: + $ref: '#/components/schemas/ServiceLevelsTimeThreshold' + triggering: + type: boolean + description: Incident flag. If value is true, this alert will become an + accident. + required: + - alertChannelIds + - customPayloadFields + - description + - id + - name + - rule + - severity + - sloIds + - timeThreshold + ServiceMap: + type: object + properties: + connections: + type: array + description: A list which indicates which services are consumers and which + are providers in the communication chain. + items: + $ref: '#/components/schemas/ServiceMapConnection' + uniqueItems: true + services: + type: array + description: List of services in the topology. + items: + $ref: '#/components/schemas/ExtendedService' + uniqueItems: true + required: + - connections + - services + ServiceMapConnection: + type: object + description: A list which indicates which services are consumers and which are + providers in the communication chain. + properties: + calls: + type: integer + format: int64 + description: "The number of calls between the 2 services.\nEg: The number\ + \ of calls from `24558242fdeb52571cfb9fa42f1b334aa65d7e61` service to\ + \ `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa` service over the mentioned\ + \ timeframe is `200`. \n\nIf no timeframe (`to` and `windowSize` in query\ + \ paramter) is mentioned, the timeframe is taken as last hour.\n" + minimum: 0 + errorRate: + type: number + format: double + description: "The error rate of the calls between the 2 services.\nEg: The\ + \ error rate of calls from `24558242fdeb52571cfb9fa42f1b334aa65d7e61`\ + \ service to `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa` service over the\ + \ mentioned timeframe is `0.1`. \n\nThe value is between 0 and 1. \n\n\ + If no timeframe (`to` and `windowSize` in query paramter) is mentioned,\ + \ the timeframe is taken as last hour.\n" + maximum: 1 + minimum: 0 + from: + type: string + description: | + The service that initiates a request to another service. + It contains a unique service id. Eg: `24558242fdeb52571cfb9fa42f1b334aa65d7e61`. + latency: + type: number + format: double + description: "The mean latency of the calls between the 2 services.\nEg:\ + \ The mean latency of calls from `24558242fdeb52571cfb9fa42f1b334aa65d7e61`\ + \ service to `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa` service over the\ + \ mentioned timeframe is `4.46`. \n\nThe value is in milliseconds. \n\n\ + If no timeframe (`to` and `windowSize` in query paramter) is mentioned,\ + \ the timeframe is taken as last hour.\n" + minimum: 0 + to: + type: string + description: | + The service that receives the request sent by the source service. + It contains a unique service id. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + required: + - from + - to + ServiceMatchingRule: + type: object + description: Calls will be matched with the array of key-value tags present + in this field. + properties: + key: + type: string + description: | + In Instana UI, this is shown as `Tag`. + One can select a variety of pre-defined tags. Eg: `host.fqdn`, `container.label` etc. + value: + type: string + description: | + In Instana UI, this is known as 'key`. + Eg: if one labels Docker containers such as com.acme.service-name:myservice, to map services from this label, + the `key` aka `tag` would be `docker.label` and `value` aka `key` would be `com.acme.service-name`. + required: + - key + - value + ServiceMetricResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + items: + type: array + items: + $ref: '#/components/schemas/ServiceItem' + page: + type: integer + format: int32 + description: Page Number + minimum: 1 + pageSize: + type: integer + format: int32 + minimum: 1 + totalHits: + type: integer + format: int64 + minimum: 0 + required: + - items + ServiceNode: + type: object + properties: + endpoints: + type: object + additionalProperties: + $ref: '#/components/schemas/EndpointNode' + inclusive: + type: boolean + serviceId: + type: string + maxLength: 64 + minLength: 0 + required: + - endpoints + - serviceId + ServiceNowEnhancedIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + autoCloseIncidents: + type: boolean + enableSendInstanaNotes: + type: boolean + enableSendServiceNowActivities: + type: boolean + enableSendServiceNowWorkNotes: + type: boolean + instanaUrl: + type: string + manuallyClosedIncidents: + type: boolean + password: + type: string + resolutionOfIncident: + type: boolean + serviceNowUrl: + type: string + snowStatusOnCloseEvent: + type: integer + format: int32 + tenant: + type: string + unit: + type: string + username: + type: string + required: + - id + - kind + - name + - password + - serviceNowUrl + - tenant + - unit + - username + ServiceNowIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + autoCloseIncidents: + type: boolean + password: + type: string + serviceNowUrl: + type: string + username: + type: string + required: + - id + - kind + - name + - password + - serviceNowUrl + - username + ServiceResult: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Service' + page: + type: integer + format: int32 + description: Page number you want to retrieve in a request / retrieved in + a response. + pageSize: + type: integer + format: int32 + description: number of elements retrieved in a single query. + totalHits: + type: integer + format: int32 + description: 'The number of results returned. For eg: If `items` has 5 elements, + `totalhits` will be 5' + ServiceScope: + type: object + description: The list of services where the release can be viewed. + properties: + name: + type: string + description: 'Name of the Service. Eg: `payment`.' + maxLength: 256 + minLength: 0 + scopedTo: + $ref: '#/components/schemas/ServiceScopedTo' + required: + - name + ServiceScopeWithMetadata: + type: object + description: The list of services where the release can be viewed. + properties: + id: + type: string + description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.' + name: + type: string + description: 'Name of the Service. Eg: `payment`.' + scopedTo: + $ref: '#/components/schemas/ServiceScopedToWithMetadata' + required: + - id + ServiceScopedTo: + type: object + description: 'The list of application perspectives where the service is present. ' + properties: + applications: + type: array + items: + $ref: '#/components/schemas/ApplicationScope' + maxItems: 10 + minItems: 1 + required: + - applications + ServiceScopedToWithMetadata: + type: object + description: The release marker would be present in the service but not for + other services within the Application perspective. + properties: + applications: + type: array + description: 'The list of application perspectives where the service is + present. ' + items: + $ref: '#/components/schemas/ApplicationScopeWithMetadata' + maxItems: 10 + minItems: 1 + required: + - applications + ServiceSimple: + type: object + description: The destination service. + properties: + id: + type: string + description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.' + label: + type: string + description: 'Name of the Service. Eg: `payment`.' + SessionSettings: + type: object + properties: + idleTimeInMillis: + type: integer + format: int64 + maximum: 28800000 + minimum: 600000 + tokenLifeTimeInMillis: + type: integer + format: int64 + maximum: 604800000 + minimum: 600000 + SimpleMetricConfiguration: + type: object + allOf: + - $ref: '#/components/schemas/InfraMetricConfiguration' + - type: object + properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + crossSeriesAggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + granularity: + type: integer + format: int64 + description: |2 + * If granularity is not specified an aggregated value for the selected timeframe is returned. + * If granularity is specified data points are returned with the specified granularity + * The granularity should not be greater than the `windowSize` (important: `windowSize` is expressed in milliseconds) + * The granularity should not be set too small relative to the `windowSize` to avoid creating an excessively large number of data points (max 600) + title: granularity in milliseconds + metric: + type: string + missingValue: + type: number + format: double + regex: + type: boolean + required: + type: boolean + description: When true, metric must be present with values + required: + - aggregation + - metric + SingleValue: + type: object + allOf: + - $ref: '#/components/schemas/ArithmeticOperand' + - type: object + properties: + value: + type: number + format: double + SlackIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + channel: + type: string + emojiRendering: + type: boolean + iconUrl: + type: string + webhookUrl: + type: string + required: + - id + - kind + - name + - webhookUrl + SliConfiguration: + type: object + properties: + id: + type: string + description: Unique ID for each SLI + maxLength: 64 + minLength: 0 + initialEvaluationTimestamp: + type: integer + format: int64 + description: Initial evaluation timestamp in milliseconds (13-digit) + metricConfiguration: + $ref: '#/components/schemas/MetricConfiguration' + sliEntity: + $ref: '#/components/schemas/SliEntity' + sliName: + type: string + description: The name of the Service Level Indicator (SLI) specified during + its creation + maxLength: 256 + minLength: 0 + required: + - id + - sliEntity + - sliName + SliConfigurationWithLastUpdated: + type: object + properties: + id: + type: string + description: Unique ID for each SLI + maxLength: 64 + minLength: 0 + initialEvaluationTimestamp: + type: integer + format: int64 + description: Initial evaluation timestamp in milliseconds (13-digit) + lastUpdated: + type: integer + format: int64 + description: Last Updated timestamp in milliseconds (13-digit) + minimum: 1 + metricConfiguration: + $ref: '#/components/schemas/MetricConfiguration' + sliEntity: + $ref: '#/components/schemas/SliEntity' + sliName: + type: string + description: The name of the Service Level Indicator (SLI) specified during + its creation + maxLength: 256 + minLength: 0 + required: + - id + - sliEntity + - sliName + SliEntity: + type: object + description: Entity Type of the SLI Configuration + discriminator: + mapping: + application: '#/components/schemas/ApplicationSliEntity' + availability: '#/components/schemas/AvailabilitySliEntity' + websiteEventBased: '#/components/schemas/WebsiteEventBasedSliEntity' + websiteTimeBased: '#/components/schemas/WebsiteTimeBasedSliEntity' + propertyName: sliType + properties: + sliType: + type: string + required: + - sliType + SliReport: + type: object + properties: + errorBudgetRemaining: + type: integer + format: int64 + description: This is the error budget remaining compared to the total error + budget + fromTimestamp: + type: integer + format: int64 + description: from timestamp in milliseconds (13-digit) + sli: + type: number + format: double + description: 'Service Level Indicator: This indicates the actual performance + measure of the service' + slo: + type: number + format: double + description: 'Service Level Objective: This is the target value that should + be met by the SLI' + toTimestamp: + type: integer + format: int64 + description: to timestamp in milliseconds (13-digit) + totalErrorBudget: + type: integer + format: int64 + description: This is the total error budget available + violationDistribution: + type: object + additionalProperties: + type: integer + format: int32 + SloEntity: + type: object + description: Entity of the Service Levels Objective Configuration, it could + be either Application nor Website + discriminator: + mapping: + application: '#/components/schemas/ApplicationSloEntity' + infrastructure: '#/components/schemas/InfraSloEntity' + synthetic: '#/components/schemas/SyntheticSloEntity' + website: '#/components/schemas/WebsiteSloEntity' + propertyName: type + properties: + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + type: + type: string + required: + - type + SloReport: + type: object + properties: + errorAccumulationChart: + type: object + additionalProperties: + type: integer + format: int32 + description: Value of accumulated bad minutes/events of SLO configuration + in different timestamps from starting to ending point + description: Value of accumulated bad minutes/events of SLO configuration + in different timestamps from starting to ending point + errorBudgetRemainChart: + type: object + additionalProperties: + type: integer + format: int32 + description: Error Budget Remain value of SLO configuration in different + timestamps from starting to ending point + description: Error Budget Remain value of SLO configuration in different + timestamps from starting to ending point + errorBudgetRemaining: + type: integer + format: int32 + description: Latest Remaining Error Budget value of SLO Configuration + errorBudgetSpent: + type: integer + format: int32 + description: Spent Error Budget of SLO Configuration + errorBurnRate: + type: integer + format: int32 + description: Latest Burn Rate value of SLO Configuration + errorBurnRateChart: + type: object + additionalProperties: + type: integer + format: int32 + description: Budget Rate value of SLO configuration in different timestamps + from starting to ending point + description: Budget Rate value of SLO configuration in different timestamps + from starting to ending point + errorChart: + type: object + additionalProperties: + type: integer + format: int32 + description: Value indicating presence of bad minutes/events of SLO configuration + in different timestamps from starting to ending point + description: Value indicating presence of bad minutes/events of SLO configuration + in different timestamps from starting to ending point + fromTimestamp: + type: integer + format: int64 + description: Starting point of the data retrieval, specified as 13 digit + Unix Timestamp milliseconds + sli: + type: number + format: double + description: Latest Status value of SLO Configuration + slo: + type: number + format: double + description: Target status of SLO Configuration + toTimestamp: + type: integer + format: int64 + description: Ending point of the data retrieval, specified as 13 digit Unix + Timestamp milliseconds + totalErrorBudget: + type: integer + format: int32 + description: Latest Available Error Budget value of SLO Configuration + violationDistribution: + type: object + additionalProperties: + type: integer + format: int32 + description: Value indicating violation of SLO configuration in different + timestamps from starting to ending point + description: Value indicating violation of SLO configuration in different + timestamps from starting to ending point + SlownessApplicationAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/ApplicationAlertRule' + required: + - aggregation + - metricName + SlownessMobileAppAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/MobileAppAlertRule' + required: + - aggregation + - metricName + SlownessWebsiteAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/WebsiteAlertRule' + required: + - aggregation + - metricName + SnapshotItem: + type: object + description: Detail information for requested snapshots. + properties: + data: + type: object + additionalProperties: + type: object + from: + type: integer + format: int64 + description: Start of timeframe expressed as the Unix epoch time in milliseconds + host: + type: string + description: Host name + label: + type: string + description: Friendly label for the entity + plugin: + type: string + description: Plugin name + example: host + snapshotId: + type: string + description: Snapshot ID + tags: + type: array + description: Tags which can be used to search for this entity + items: + type: string + description: Tags which can be used to search for this entity + to: + type: integer + format: int64 + description: End of timeframe expressed as the Unix epoch time in milliseconds + SnapshotPreview: + type: object + properties: + data: + type: object + additionalProperties: + type: object + description: Subset of the data section of the plugin. In most cases this + field will be null. + description: Subset of the data section of the plugin. In most cases this + field will be null. + id: + type: string + description: This is a snapshot ID. A unique identifier the metrics are + assigned to. + label: + type: string + description: Name of the entity. + plugin: + type: string + description: A short plugin ID. For example, `containerd`, `nginx` etc. + time: + type: integer + format: int64 + description: Specifies the exact point at which the id, label and plugin + are valid. + minimum: 1 + required: + - id + SnapshotResult: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SnapshotItem' + SoftwareUser: + type: object + properties: + container: + type: string + host: + type: string + process: + type: string + snapshotId: + type: string + SoftwareVersion: + type: object + properties: + discoveryType: + type: string + enum: + - NATIVE_SENSOR + - REMOTE_SENSOR + - PACKAGE_MANAGER + - OTHER + metadata: + type: object + additionalProperties: + type: string + name: + type: string + plugin: + type: string + softwareType: + type: string + enum: + - DEPENDENCY + - RUNTIME + - DATABASE + - MESSAGING + - PLATFORM + - PACKAGE + - OS + - CACHE + - API_GATEWAY + - OTHER + - APPLICATION_FRAMEWORK + usedBy: + type: array + items: + $ref: '#/components/schemas/SoftwareUser' + uniqueItems: true + vendor: + type: string + version: + type: string + required: + - discoveryType + - name + - plugin + - softwareType + - usedBy + - vendor + - version + SourceMapFileBlob: + type: object + properties: + blobIndex: + type: integer + format: int32 + size: + type: integer + format: int64 + sizeOnDisk: + type: integer + format: int64 + SourceMapFileMeta: + type: object + properties: + blobs: + type: array + items: + $ref: '#/components/schemas/SourceMapFileBlob' + format: + type: string + meta: + type: string + size: + type: integer + format: int64 + sizeOnDisk: + type: integer + format: int64 + type: + type: string + enum: + - JS_MAP + - JS + - R8PG_MAP + - DWARF + url: + type: string + required: + - format + - type + - url + SourceMapUploadConfig: + type: object + properties: + createdAt: + type: string + format: date-time + description: + type: string + id: + type: string + metadata: + type: array + items: + $ref: '#/components/schemas/SourceMapFileMeta' + maxItems: 500 + minItems: 0 + modifiedAt: + type: string + format: date-time + required: + - id + - metadata + SourceMapUploadConfigs: + type: object + properties: + config: + type: array + items: + $ref: '#/components/schemas/SourceMapUploadConfig' + writeOnly: true + configs: + type: array + items: + $ref: '#/components/schemas/SourceMapUploadConfig' + maxItems: 1024 + minItems: 0 + required: + - configs + SpanExcerpt: + type: object + description: Information about the logs attached to the call, if available. + properties: + data: + type: object + additionalProperties: + type: object + description: Some information about the span, like service name, if it + is an http call, then some information about it like, path, method, + host, errors etc. + description: Some information about the span, like service name, if it is + an http call, then some information about it like, path, method, host, + errors etc. + databaseIntegrations: + type: array + items: + $ref: '#/components/schemas/DatabaseIntegration' + duration: + type: integer + format: int64 + description: The total time taken for the entire operation of a call, from + the moment the request was initiated to when the response was received. + The time measured is in milliseconds. This is also known as latency of + a call. + minimum: 0 + errorCount: + type: integer + format: int32 + description: Represents whether the span is erroneous or not. 0 is not erroneous + and 1 is erroneous. + minimum: 0 + foreignParentId: + type: string + id: + type: string + description: 'The call ID. A unique identifier for an individual call. For + example: `1bcad5c82338deaf`.' + kind: + type: string + description: | + There are 4 types of span kind: + 1. `ENTRY`: An entry span represents an incoming request into a traced service. + 2. `EXIT`: An exit span represents an outgoing request that a service makes to some other service. + 3. `INTERMEDIATE`: An intermediate span represents anything that happens inside a traced service where the flow of control neither enters nor leaves that service, but stays inside it. + 4. `UNKNOWN`: Instana can't determine the span kind. + enum: + - UNKNOWN + - ENTRY + - EXIT + - INTERMEDIATE + name: + type: string + description: The technical type of the span. For example, `node.http.client` + or `jdbc`. + parentId: + type: string + description: The parent call id, referring to another call in the same trace + which triggered the processing associated with this call. + stackTrace: + type: array + description: For an erroneous call, if stack trace is available it will + show a list of items containing file, method and line number of the code. + items: + $ref: '#/components/schemas/StackTraceItem' + start: + type: integer + format: int64 + description: The timestamp when the call or request was initiated. For example, + Unix epoch time in milliseconds `1735532879870` is `Monday, 30 December + 2024 04:27:59.870 GMT` + minimum: 1 + required: + - data + - id + - kind + - name + - stackTrace + SpanRelation: + type: object + description: | + It shows from where the call is destined to. It includes the following information: + 1. List of Application Perspectives from which the call is destined to. + 2. Destination service and destination endpoint. + 3. Physical context from the infrastructure point of view. + properties: + applications: + type: array + items: + $ref: '#/components/schemas/Application' + uniqueItems: true + endpoint: + $ref: '#/components/schemas/Endpoint' + physicalContext: + $ref: '#/components/schemas/PhysicalContext' + service: + $ref: '#/components/schemas/Service' + required: + - applications + SpecificJsErrorsWebsiteAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/WebsiteAlertRule' + - type: object + properties: + operator: + type: string + enum: + - EQUALS + - CONTAINS + - LESS_THAN + - LESS_OR_EQUAL_THAN + - GREATER_THAN + - GREATER_OR_EQUAL_THAN + - NOT_EMPTY + - NOT_EQUAL + - NOT_CONTAIN + - IS_EMPTY + - NOT_BLANK + - IS_BLANK + - STARTS_WITH + - ENDS_WITH + - NOT_STARTS_WITH + - NOT_ENDS_WITH + - REGEX_MATCH + value: + type: string + required: + - metricName + - operator + SplunkIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + token: + type: string + url: + type: string + required: + - id + - kind + - name + - token + - url + StackTraceItem: + type: object + description: For an erroneous call, if stack trace is available it will show + a list of items containing file, method and line number of the code. + properties: + file: + type: string + description: The name of the file where the executed code resides. + line: + type: string + description: The line number within the file where the error was thrown. + method: + type: string + description: The name of the method or function being executed at the time + the stack trace item was generated. + StackTraceLine: + type: object + properties: + column: + type: integer + format: int32 + minimum: -1 + file: + type: string + line: + type: integer + format: int32 + minimum: -1 + name: + type: string + translationExplanation: + type: string + translationStatus: + type: integer + format: int32 + minimum: -1 + required: + - file + StaticBaselineThresholdRule: + type: object + allOf: + - $ref: '#/components/schemas/ThresholdConfigRule' + - type: object + properties: + baseline: + type: array + items: + type: array + items: + type: number + deviationFactor: + type: number + format: double + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 16.0 + minimum: 0.5 + seasonality: + type: string + enum: + - WEEKLY + - DAILY + required: + - seasonality + StaticStringField: + type: object + allOf: + - $ref: '#/components/schemas/CustomPayloadField' + - type: object + properties: + value: + type: string + description: Custom value for static type custom payload + required: + - key + - value + StaticThreshold: + type: object + allOf: + - $ref: '#/components/schemas/Threshold' + - type: object + properties: + lastUpdated: + type: integer + format: int64 + minimum: 0 + value: + type: number + format: double + minimum: 0 + description: This threshold defines a static value to be evaluated with a specific + operator. + required: + - operator + StaticThresholdRule: + type: object + allOf: + - $ref: '#/components/schemas/ThresholdConfigRule' + - type: object + properties: + value: + type: number + format: double + minimum: 0 + StatusCodeApplicationAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/ApplicationAlertRule' + - type: object + properties: + statusCodeEnd: + type: integer + format: int32 + minimum: 1 + statusCodeStart: + type: integer + format: int32 + minimum: 1 + required: + - metricName + StatusCodeMobileAppAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/MobileAppAlertRule' + - type: object + properties: + operator: + type: string + enum: + - EQUALS + - CONTAINS + - LESS_THAN + - LESS_OR_EQUAL_THAN + - GREATER_THAN + - GREATER_OR_EQUAL_THAN + - NOT_EMPTY + - NOT_EQUAL + - NOT_CONTAIN + - IS_EMPTY + - NOT_BLANK + - IS_BLANK + - STARTS_WITH + - ENDS_WITH + - NOT_STARTS_WITH + - NOT_ENDS_WITH + - REGEX_MATCH + value: + type: string + required: + - metricName + - operator + - value + StatusCodeWebsiteAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/WebsiteAlertRule' + - type: object + properties: + operator: + type: string + enum: + - EQUALS + - CONTAINS + - LESS_THAN + - LESS_OR_EQUAL_THAN + - GREATER_THAN + - GREATER_OR_EQUAL_THAN + - NOT_EMPTY + - NOT_EQUAL + - NOT_CONTAIN + - IS_EMPTY + - NOT_BLANK + - IS_BLANK + - STARTS_WITH + - ENDS_WITH + - NOT_STARTS_WITH + - NOT_ENDS_WITH + - REGEX_MATCH + value: + type: string + required: + - metricName + - operator + - value + Subtraction: + type: object + allOf: + - $ref: '#/components/schemas/ArithmeticOperation' + required: + - left + - right + SyntheticAlertConfig: + type: object + properties: + alertChannelIds: + type: array + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the synthetic alert configuration. Used as a + template for the description of alert/event notifications triggered by + this Smart Alert configuration. + maxLength: 65536 + minLength: 0 + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + name: + type: string + description: Name of the synthetic alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + rule: + $ref: '#/components/schemas/SyntheticAlertRule' + severity: + type: integer + format: int32 + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + syntheticTestIds: + type: array + description: IDs of the synthetic tests that this Smart Alert configuration + is applied to. + items: + type: string + description: IDs of the synthetic tests that this Smart Alert configuration + is applied to. + uniqueItems: true + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + timeThreshold: + $ref: '#/components/schemas/SyntheticTimeThreshold' + required: + - alertChannelIds + - customPayloadFields + - description + - name + - rule + - syntheticTestIds + - tagFilterExpression + - timeThreshold + SyntheticAlertConfigWithMetadata: + type: object + properties: + alertChannelIds: + type: array + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + created: + type: integer + format: int64 + description: Unix timestamp representing the creation time of this revision. + minimum: 1 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the synthetic alert configuration. Used as a + template for the description of alert/event notifications triggered by + this Smart Alert configuration. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + id: + type: string + description: 'ID of this Synthetic Alert Config. ' + maxLength: 64 + minLength: 0 + initialCreated: + type: integer + format: int64 + description: Unix timestamp representing the time of the initial revision. + minimum: 1 + name: + type: string + description: Name of the synthetic alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + readOnly: + type: boolean + description: Flag to indicate whether or not the configuration is read-only. + Read-only access restricts modification of the config. + rule: + $ref: '#/components/schemas/SyntheticAlertRule' + severity: + type: integer + format: int32 + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + syntheticTestIds: + type: array + description: IDs of the synthetic tests that this Smart Alert configuration + is applied to. + items: + type: string + description: IDs of the synthetic tests that this Smart Alert configuration + is applied to. + uniqueItems: true + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + timeThreshold: + $ref: '#/components/schemas/SyntheticTimeThreshold' + required: + - alertChannelIds + - customPayloadFields + - description + - id + - name + - rule + - syntheticTestIds + - tagFilterExpression + - timeThreshold + SyntheticAlertRule: + type: object + description: Indicates the type of rule this alert configuration is about. + discriminator: + mapping: + failure: '#/components/schemas/FailureSyntheticAlertRule' + propertyName: alertType + properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + alertType: + type: string + metricName: + type: string + required: + - alertType + - metricName + SyntheticBulkResponse: + type: object + properties: + errorMessage: + type: string + id: + type: string + status: + type: string + SyntheticCallConfig: + type: object + properties: + customRules: + type: array + description: The list of custom rules for synthetic endpoints defined by + the user. + items: + $ref: '#/components/schemas/SyntheticCallRule' + maxItems: 500 + minItems: 0 + defaultRulesEnabled: + type: boolean + description: A flag to enable/disable the default synthetic endpoint configurations + defined by Instana. + required: + - customRules + SyntheticCallRule: + type: object + description: The list of custom rules for synthetic endpoints defined by the + user. + properties: + description: + type: string + description: A description of the custom rule. For example, one can mention + the reason behind having the custom rule. + maxLength: 2048 + minLength: 0 + enabled: + type: boolean + description: A flag to enable/disable the custom synthetic endpoint configurations + defined by the user. + matchSpecification: + $ref: '#/components/schemas/MatchExpressionDTO' + name: + type: string + description: The name of the custom rule for Synthetic endpoints. + maxLength: 128 + minLength: 1 + required: + - matchSpecification + - name + SyntheticCallWithDefaultsConfig: + type: object + properties: + customRules: + type: array + description: The list of custom rules for synthetic endpoints defined by + the user. + items: + $ref: '#/components/schemas/SyntheticCallRule' + maxItems: 500 + minItems: 0 + defaultRules: + type: array + items: + $ref: '#/components/schemas/SyntheticCallRule' + defaultRulesEnabled: + type: boolean + description: A flag to enable/disable the default synthetic endpoint configurations + defined by Instana. + required: + - customRules + - defaultRules + SyntheticConfiguration: + type: object + properties: + retries: + type: integer + format: int32 + maximum: 2 + minimum: 0 + retryInterval: + type: integer + format: int32 + maximum: 10 + minimum: 1 + timeout: + type: string + SyntheticConfigurationUpdate: + type: object + properties: + markSyntheticCall: + type: boolean + retries: + type: integer + format: int32 + maximum: 2 + minimum: 0 + retryInterval: + type: integer + format: int32 + maximum: 10 + minimum: 1 + timeout: + type: string + SyntheticCredential: + type: object + properties: + applicationLabels: + type: array + items: + type: string + readOnly: true + readOnly: true + applications: + type: array + items: + type: string + createdAt: + type: integer + format: int64 + readOnly: true + createdBy: + type: string + maxLength: 128 + minLength: 0 + credentialName: + type: string + maxLength: 128 + minLength: 1 + credentialValue: + type: string + writeOnly: true + mobileAppLabels: + type: array + items: + type: string + readOnly: true + readOnly: true + mobileApps: + type: array + items: + type: string + modifiedAt: + type: integer + format: int64 + readOnly: true + modifiedBy: + type: string + maxLength: 128 + minLength: 0 + rbacTags: + type: array + items: + $ref: '#/components/schemas/ApiTag' + uniqueItems: true + websiteLabels: + type: array + items: + type: string + readOnly: true + readOnly: true + websites: + type: array + items: + type: string + required: + - credentialName + - credentialValue + SyntheticDatacenter: + type: object + properties: + cityName: + type: string + code: + type: string + maxLength: 128 + minLength: 1 + configuration: + $ref: '#/components/schemas/SyntheticDatacenterConfiguration' + countryName: + type: string + datacenterId: + type: string + expectedActiveAt: + type: integer + format: int64 + label: + type: string + maxLength: 128 + minLength: 1 + latitude: + type: number + format: double + locationLabel: + type: string + longitude: + type: number + format: double + modifiedAt: + type: integer + format: int64 + provider: + type: string + maxLength: 128 + minLength: 1 + status: + type: string + required: + - cityName + - code + - countryName + - label + - provider + SyntheticDatacenterConfiguration: + type: object + properties: + ipAddresses: + type: array + items: + type: string + SyntheticGeoPoint: + type: object + properties: + cityName: + type: string + countryName: + type: string + latitude: + type: number + format: double + longitude: + type: number + format: double + required: + - cityName + - countryName + - latitude + - longitude + SyntheticLocation: + type: object + properties: + configuration: + $ref: '#/components/schemas/SyntheticLocationConfiguration' + createdAt: + type: integer + format: int64 + customProperties: + type: object + additionalProperties: + type: string + description: + type: string + maxLength: 512 + minLength: 0 + displayLabel: + type: string + maxLength: 128 + minLength: 1 + geoPoint: + $ref: '#/components/schemas/SyntheticGeoPoint' + id: + type: string + maxLength: 128 + minLength: 0 + label: + type: string + maxLength: 128 + minLength: 1 + locationType: + type: string + modifiedAt: + type: integer + format: int64 + observedAt: + type: integer + format: int64 + playbackCapabilities: + $ref: '#/components/schemas/SyntheticPlaybackCapabilities' + popVersion: + type: string + maxLength: 64 + minLength: 1 + status: + type: string + totalTests: + type: integer + format: int32 + required: + - geoPoint + - label + - locationType + - playbackCapabilities + SyntheticLocationConfiguration: + type: object + properties: + clusterName: + type: string + namespace: + type: string + tenantType: + type: string + enum: + - Multi + - Single + SyntheticMetricConfiguration: + type: object + properties: + aggregation: + type: string + description: 'Set aggregation that can be applied to a series of values. + Eg: `MEAN`.' + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + granularity: + type: integer + format: int32 + description: 'If the granularity is set you will get data points with the + specified granularity in seconds. Default: `1000` milliseconds' + metric: + type: string + description: 'Set a particular metric, eg: `latency`.' + required: + - aggregation + - metric + SyntheticMetricTagGroup: + type: object + description: ' Grouping of data under `groupbyTag`, where `groupbyTagEntity` + and `groupbyTagSecondLevelKey` are aspects of `groupbyTag`.' + properties: + direction: + type: string + enum: + - ASC + - DESC + groupbyTag: + type: string + description: The name of the group tag (e.g. `agent.tag` or `docker.label`). + maxLength: 256 + minLength: 0 + groupbyTagEntity: + type: string + description: | + The entity by which the data should be grouped. + This field supports three possible values: `NOT_APPLICABLE`, `DESTINATION`, and `SOURCE`. + `SOURCE`: the tag filter should apply to the source entity. + `DESTINATION`: the tag filter should apply to the destination entity. + `NOT_APPLICABLE`: some tags are independent of source or destination, such as tags on the call itself, log tags or trace tags (only destination makes sense because the source is unknown for the root call). + enum: + - NOT_APPLICABLE + - DESTINATION + - SOURCE + groupbyTagSecondLevelKey: + type: string + description: If present, it's the 2nd level key part (e.g. `customKey` on + `docker.label.customKey`) + maxLength: 256 + minLength: 0 + includeOthers: + type: boolean + maxResults: + type: integer + format: int32 + maximum: 50 + minimum: 1 + required: + - direction + - groupbyTag + - groupbyTagEntity + SyntheticPlaybackCapabilities: + type: object + properties: + browserType: + type: array + items: + type: string + enum: + - chrome + - firefox + executionType: + type: array + items: + type: string + enum: + - CI/CD + syntheticType: + type: array + items: + type: string + required: + - browserType + - syntheticType + SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue: + type: object + properties: + add: + type: array + items: + $ref: '#/components/schemas/DNSFilterTargetValue' + remove: + type: array + items: + $ref: '#/components/schemas/DNSFilterTargetValue' + SyntheticResourceUpdateListSSLCertificateValidationListSSLCertificateValidation: + type: object + properties: + add: + type: array + items: + $ref: '#/components/schemas/SSLCertificateValidation' + remove: + type: array + items: + $ref: '#/components/schemas/SSLCertificateValidation' + SyntheticResourceUpdateListStringListString: + type: object + properties: + add: + type: array + items: + type: string + remove: + type: array + items: + type: string + SyntheticResourceUpdateMapStringStringListString: + type: object + properties: + add: + type: object + additionalProperties: + type: string + remove: + type: array + items: + type: string + SyntheticSloEntity: + type: object + allOf: + - $ref: '#/components/schemas/SloEntity' + - type: object + properties: + includeUnscheduledTestResults: + type: boolean + description: 'Only includes the scheduled test results. ' + syntheticTestIds: + type: array + description: 'List of Unique Synthetic Tests IDs ' + items: + type: string + description: 'List of Unique Synthetic Tests IDs ' + uniqueItems: true + required: + - syntheticTestIds + SyntheticTest: + type: object + properties: + active: + type: boolean + applicationId: + type: string + maxLength: 512 + minLength: 0 + applicationLabel: + type: string + maxLength: 512 + minLength: 0 + readOnly: true + applicationLabels: + type: array + items: + type: string + readOnly: true + readOnly: true + applications: + type: array + items: + type: string + configuration: + $ref: '#/components/schemas/SyntheticTypeConfiguration' + createdAt: + type: integer + format: int64 + readOnly: true + createdBy: + type: string + maxLength: 128 + minLength: 0 + customProperties: + type: object + additionalProperties: + type: string + description: + type: string + maxLength: 512 + minLength: 0 + id: + type: string + maxLength: 128 + minLength: 1 + label: + type: string + maxLength: 128 + minLength: 1 + locationDisplayLabels: + type: array + items: + type: string + readOnly: true + readOnly: true + locationLabels: + type: array + items: + type: string + readOnly: true + readOnly: true + locations: + type: array + items: + type: string + mobileAppLabels: + type: array + items: + type: string + readOnly: true + readOnly: true + mobileApps: + type: array + items: + type: string + modifiedAt: + type: integer + format: int64 + modifiedBy: + type: string + maxLength: 128 + minLength: 0 + playbackMode: + type: string + enum: + - Simultaneous + - Staggered + rbacTags: + type: array + items: + $ref: '#/components/schemas/ApiTag' + uniqueItems: true + tenantId: + type: string + testFrequency: + type: integer + format: int32 + maximum: 1440 + minimum: 1 + websiteLabels: + type: array + items: + type: string + readOnly: true + readOnly: true + websites: + type: array + items: + type: string + required: + - active + - configuration + - label + - locations + - testFrequency + SyntheticTestCICD: + type: object + properties: + customization: + $ref: '#/components/schemas/SyntheticTestCICDCustomization' + runType: + type: string + testId: + type: string + required: + - customization + - testId + SyntheticTestCICDCustomization: + type: object + properties: + configuration: + $ref: '#/components/schemas/SyntheticConfiguration' + customProperties: + type: object + additionalProperties: + type: string + locations: + type: array + items: + type: string + required: + - configuration + SyntheticTestCICDItem: + type: object + properties: + applications: + type: array + items: + type: string + completed: + type: boolean + customization: + $ref: '#/components/schemas/SyntheticTestCICDCustomization' + locationId: + type: string + locationLabel: + type: string + mobileApps: + type: array + items: + type: string + runType: + type: string + testId: + type: string + testLabel: + type: string + testResultId: + type: string + testType: + type: string + websites: + type: array + items: + type: string + required: + - completed + - customization + - locationId + - locationLabel + - testId + - testLabel + - testResultId + - testType + SyntheticTestCICDResponse: + type: object + properties: + locationId: + type: string + testId: + type: string + testResultId: + type: string + required: + - locationId + - testId + - testResultId + SyntheticTestDeepUpdate: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTestUpdate' + - type: object + properties: + configuration: + $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + required: + - syntheticUpdateType + SyntheticTestShallowUpdate: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTestUpdate' + - type: object + properties: + configuration: + $ref: '#/components/schemas/SyntheticConfigurationUpdate' + required: + - syntheticUpdateType + SyntheticTestUpdate: + type: object + description: Identifies the type of the synthetic tests updated on this request. + Valid types are Deep and Shallow. + discriminator: + mapping: + Deep: '#/components/schemas/SyntheticTestDeepUpdate' + Shallow: '#/components/schemas/SyntheticTestShallowUpdate' + propertyName: syntheticUpdateType + properties: + active: + type: boolean + applications: + $ref: '#/components/schemas/SyntheticResourceUpdateListStringListString' + customProperties: + $ref: '#/components/schemas/SyntheticResourceUpdateMapStringStringListString' + ids: + type: array + items: + type: string + lastModifiedAt: + type: array + items: + type: integer + format: int64 + locations: + $ref: '#/components/schemas/SyntheticResourceUpdateListStringListString' + mobileApps: + $ref: '#/components/schemas/SyntheticResourceUpdateListStringListString' + modifiedBy: + type: string + shallowUpdate: + type: boolean + syntheticUpdateType: + type: string + description: | + Indicates the type of update to apply to a set of tests of same syntheticType (Deep) + or a mix of syntheticType values (Shallow). When Shallow is used, only the configuration properties + retries, retryInterval and timeout can be updated + enum: + - Deep + - Shallow + testFrequency: + type: integer + format: int32 + maximum: 1440 + minimum: 1 + websites: + $ref: '#/components/schemas/SyntheticResourceUpdateListStringListString' + required: + - syntheticUpdateType + SyntheticTimeThreshold: + type: object + description: The type of threshold to define the criteria when the event and + alert triggers and resolves. + discriminator: + mapping: + violationsInSequence: '#/components/schemas/ViolationsInSequenceSyntheticTimeThreshold' + propertyName: type + properties: + type: + type: string + violationsCount: + type: integer + format: int32 + maximum: 12 + minimum: 1 + required: + - type + SyntheticTypeConfiguration: + type: object + description: |- + Synthetic test configuration that is unique to a synthetic type. Valid types are BrowserScript, + DNS, HTTPAction, HTTPScript, SSLCertificate, WebpageAction, and WebpageScript. + discriminator: + mapping: + BrowserScript: '#/components/schemas/BrowserScriptConfiguration' + DNS: '#/components/schemas/DNSConfiguration' + HTTPAction: '#/components/schemas/HttpActionConfiguration' + HTTPScript: '#/components/schemas/HttpScriptConfiguration' + NotConfigured: '#/components/schemas/EmptyConfiguration' + SSLCertificate: '#/components/schemas/SSLCertificateConfiguration' + WebpageAction: '#/components/schemas/WebpageActionConfiguration' + WebpageScript: '#/components/schemas/WebpageScriptConfiguration' + propertyName: syntheticType + properties: + markSyntheticCall: + type: boolean + retries: + type: integer + format: int32 + maximum: 2 + minimum: 0 + retryInterval: + type: integer + format: int32 + maximum: 10 + minimum: 1 + syntheticType: + type: string + enum: + - BrowserScript + - DNS + - HTTPAction + - HTTPScript + - SSLCertificate + - WebpageAction + - WebpageScript + - NotConfigured + timeout: + type: string + required: + - markSyntheticCall + - syntheticType + SyntheticTypeConfigurationUpdate: + type: object + description: |- + Synthetic test configuration that is unique to a synthetic type. Valid types are BrowserScript, + DNS, HTTPAction, HTTPScript, SSLCertificate, WebpageAction, and WebpageScript. + discriminator: + mapping: + BrowserScript: '#/components/schemas/BrowserScriptConfigurationUpdate' + DNS: '#/components/schemas/DNSConfigurationUpdate' + HTTPAction: '#/components/schemas/HttpActionConfigurationUpdate' + HTTPScript: '#/components/schemas/HttpScriptConfigurationUpdate' + SSLCertificate: '#/components/schemas/SSLCertificateConfigurationUpdate' + WebpageAction: '#/components/schemas/WebpageActionConfigurationUpdate' + WebpageScript: '#/components/schemas/WebpageScriptConfigurationUpdate' + propertyName: syntheticType + properties: + markSyntheticCall: + type: boolean + retries: + type: integer + format: int32 + maximum: 2 + minimum: 0 + retryInterval: + type: integer + format: int32 + maximum: 10 + minimum: 1 + syntheticTest: + type: string + enum: + - BrowserScript + - DNS + - HTTPAction + - HTTPScript + - SSLCertificate + - WebpageAction + - WebpageScript + - NotConfigured + writeOnly: true + syntheticType: + type: string + enum: + - BrowserScript + - DNS + - HTTPAction + - HTTPScript + - SSLCertificate + - WebpageAction + - WebpageScript + - NotConfigured + timeout: + type: string + SyntheticsEventResult: + type: object + allOf: + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + locationIds: + type: array + description: IDs of the locations. + items: + type: string + description: IDs of the locations. + syntheticTestId: + type: string + description: ID of the synthetic test. + SystemRule: + type: object + allOf: + - $ref: '#/components/schemas/AbstractRule' + - type: object + properties: + systemRuleId: + type: string + required: + - systemRuleId + SystemRuleLabel: + type: object + properties: + id: + type: string + name: + type: string + required: + - id + - name + Tag: + type: object + description: | + List of queryable tags available in a tagTree. Eg: `call.erroneous`. + Consider these tags as attributes of a tagTree. Eg: `Call` tagTree has have `Erroneous`, `Call name`, `Latency` etc as attributes. + properties: + aliases: + type: array + description: | + List of other names that can refer to this tag + items: + type: string + description: | + List of other names that can refer to this tag + uniqueItems: true + availability: + type: array + description: | + List of product areas this tag is available in + items: + type: string + description: | + List of product areas this tag is available in + enum: + - INFRASTRUCTURE_METRICS + - APPLICATION + - WEBSITE + - MOBILE_APP + - EUM + - EUM_IMPACTED_BEACON + - EVENT + - SLI + - SLO + - SLO_PREVIEW + - USAGE + - LOG + - SYNTHETICS + - SYNTHETICS_DETAIL + - APDEX + - BIZOPS + - BUSINESS_METRICS + - SUBTRACE + - UNKNOWN + uniqueItems: true + canApplyToDestination: + type: boolean + description: | + Whether the tag is available for destination or not. + If source and destination is false, it means the tag is independent of source and destination. Eg: of such tag is `call.http.path`. + canApplyToSource: + type: boolean + description: | + Whether the tag is available for source or not. + If source and destination is false, it means the tag is independent of source and destination. Eg: of such tag is `call.http.path`. + description: + type: string + description: The description of the tag if it is provided. + idTag: + type: boolean + description: | + Whether the Tag is a unique ID or not. + Eg: `idTag` for `endpoint.id` is true but for `call.rpc.method` it is false. + label: + type: string + description: 'The name of the tag which is seen in the UI. Eg: `Call name`' + maxLength: 256 + minLength: 0 + name: + type: string + description: 'The name of the tag. Eg: `call.name`' + type: + type: string + description: 'The data type of the tag. Eg: `call.name` accepts `STRING` + value.' + enum: + - BOOLEAN + - STRING + - NUMBER + - STRING_SET + - STRING_LIST + - KEY_VALUE_PAIR + - FLOAT_LIST + - KEY_NUMBER_PAIR + required: + - name + - type + TagCatalog: + type: object + properties: + tagTree: + type: array + description: | + The name of the tag dataset (tagTree) which can contain one or more tags as its attributes or children. Eg: `Call`. + Consider this as the root of the tree where it has tags as attributes or children. + items: + $ref: '#/components/schemas/TagTreeLevel' + tags: + type: array + description: | + List of queryable tags available in a tagTree. Eg: `call.erroneous`. + Consider these tags as attributes of a tagTree. Eg: `Call` tagTree has have `Erroneous`, `Call name`, `Latency` etc as attributes. + items: + $ref: '#/components/schemas/Tag' + required: + - tagTree + - tags + TagFilter: + type: object + allOf: + - $ref: '#/components/schemas/TagFilterExpressionElement' + - type: object + properties: + entity: + type: string + description: SOURCE or DESTINATION tag in case of a call tag. For Infrastructure, + always set to NOT_APPLICABLE. + enum: + - NOT_APPLICABLE + - DESTINATION + - SOURCE + key: + type: string + description: Tag key in case of a key/value tag. + maxLength: 512 + minLength: 0 + name: + type: string + description: Name of the tag. + maxLength: 128 + minLength: 0 + operator: + type: string + enum: + - EQUALS + - CONTAINS + - LESS_THAN + - LESS_OR_EQUAL_THAN + - GREATER_THAN + - GREATER_OR_EQUAL_THAN + - NOT_EMPTY + - NOT_EQUAL + - NOT_CONTAIN + - IS_EMPTY + - NOT_BLANK + - IS_BLANK + - STARTS_WITH + - ENDS_WITH + - NOT_STARTS_WITH + - NOT_ENDS_WITH + - REGEX_MATCH + value: + type: object + description: Tag value to filter on. Can be a string, number, or boolean + value. + required: + - entity + - name + - operator + TagFilterExpression: + type: object + allOf: + - $ref: '#/components/schemas/TagFilterExpressionElement' + - type: object + properties: + elements: + type: array + items: + $ref: '#/components/schemas/TagFilterExpressionElement' + logicalOperator: + type: string + description: Set AND / OR + enum: + - AND + - OR + required: + - elements + - logicalOperator + TagFilterExpressionElement: + type: object + description: Boolean expression of tag filters to define the scope of relevant + calls. + discriminator: + mapping: + EXPRESSION: '#/components/schemas/TagFilterExpression' + TAG_FILTER: '#/components/schemas/TagFilter' + propertyName: type + properties: + type: + type: string + required: + - type + TagMatcherDTO: + type: object + allOf: + - $ref: '#/components/schemas/MatchExpressionDTO' + - type: object + properties: + entity: + type: string + enum: + - NOT_APPLICABLE + - DESTINATION + - SOURCE + key: + type: string + operator: + type: string + enum: + - EQUALS + - NOT_EQUAL + - CONTAINS + - NOT_CONTAIN + - IS_EMPTY + - NOT_EMPTY + - IS_BLANK + - NOT_BLANK + - STARTS_WITH + - ENDS_WITH + - NOT_STARTS_WITH + - NOT_ENDS_WITH + - GREATER_OR_EQUAL_THAN + - LESS_OR_EQUAL_THAN + - LESS_THAN + - GREATER_THAN + value: + type: string + required: + - entity + - key + - operator + TagTreeLevel: + type: object + description: | + The name of the tag dataset (tagTree) which can contain one or more tags as its attributes or children. Eg: `Call`. + Consider this as the root of the tree where it has tags as attributes or children. + properties: + children: + type: array + description: Children tags of tagTree + items: + $ref: '#/components/schemas/TagTreeNode' + description: + type: string + description: The description provided, if any. + maxLength: 512 + minLength: 0 + icon: + type: string + description: | + Each tag has an Icon which can be seen on the drop down list in Unbounded Analytics. + If there is an icon, there will be a string associated with it. + Eg: For for all `TAG` under `Call` tagTreeNode, the `icon` value is `lib_application_call`. + maxLength: 128 + minLength: 0 + label: + type: string + description: 'The name of the tagTreeNode. Eg: `Commonly Used`, `Application`.' + maxLength: 128 + minLength: 0 + queryable: + type: boolean + scoreBoost: + type: integer + format: int32 + description: | + By default it is `null` if it is not set explictily by IBM Instana. + The purpose of this parameter is to rank the tagTree. For eg: some set of tags are frequently used. + Tags under `Commonly used` is frequently used, so it will come up on top of the drop down list of `Query Builder` in `Unbounded Analytics`. + Higher the scoreBoost, higher the ranking. + type: + type: string + description: Type would be either `LEVEL` or `TAG` depending on whether + the tag has any child tags or not respectively. + required: + - children + - label + TagTreeNode: + type: object + description: Children tags of tagTree + discriminator: + mapping: + LEVEL: '#/components/schemas/TagTreeLevel' + TAG: '#/components/schemas/TagTreeTag' + propertyName: type + properties: + icon: + type: string + label: + type: string + type: + type: string + description: Type would be either `LEVEL` or `TAG` depending on whether + the tag has any child tags or not respectively. + TagTreeTag: + type: object + allOf: + - $ref: '#/components/schemas/TagTreeNode' + - type: object + properties: + description: + type: string + maxLength: 512 + minLength: 0 + hidden: + type: boolean + description: If true, the tag will not be available for query in Unbounded + Analytics. + icon: + type: string + maxLength: 128 + minLength: 0 + label: + type: string + description: 'The name of the tagTreeNode. Eg: `Call Error Message`, `Endpoint + Name`.' + maxLength: 128 + minLength: 0 + queryable: + type: boolean + description: | + queryable property can have 3 states which will be reflected in the drop down list in `Query Builder` of `Unbounded Analytics` of Instana UI: + - true: the tag has been seen by IBM Instana and must be shown. + - false: the tag could have been processed, but has not been seen by IBM Instana and could be hidden. + - null: the tag has not been processed and should be shown. + The purpose is to make it easier for customers to find the right tags in drop down list + scoreBoost: + type: integer + format: int32 + description: | + By default it is `null` if it is not set explictily by IBM Instana. + The purpose of this parameter is to rank the Tag. For eg: tags are frequently used within the tagTree + For eg, assume there are 8 tags under `Commonly Used`. IBM Instana can set the ranking for each of these tags within `Commonly Used`. + Higher the scoreBoost, higher the ranking. + tagName: + type: string + maxLength: 128 + minLength: 0 + required: + - label + - tagName + TestCommonProperties: + type: object + properties: + active: + type: boolean + applicationId: + type: string + applicationIds: + type: array + items: + type: string + applicationLabel: + type: string + applicationLabels: + type: array + items: + type: string + createdAt: + type: integer + format: int64 + frequency: + type: integer + format: int32 + getWebsiteLabels: + type: array + items: + type: string + id: + type: string + label: + type: string + locationDisplayLabels: + type: array + items: + type: string + locationIds: + type: array + items: + type: string + locationLabels: + type: array + items: + type: string + locationStatusList: + type: array + items: + $ref: '#/components/schemas/LocationStatus' + mobileApplicationIds: + type: array + items: + type: string + mobileApplicationLabels: + type: array + items: + type: string + modifiedAt: + type: integer + format: int64 + serviceId: + type: string + type: + type: string + websiteIds: + type: array + items: + type: string + websiteLabels: + type: array + items: + type: string + writeOnly: true + required: + - active + - frequency + - id + - label + - type + TestLastError: + type: object + properties: + errors: + type: array + items: + type: string + startTime: + type: integer + format: int64 + TestResult: + type: object + properties: + testResult: + type: array + items: + $ref: '#/components/schemas/TestResultItem' + testResultItems: + type: array + items: + $ref: '#/components/schemas/TestResultItem' + writeOnly: true + TestResultCommonProperties: + type: object + properties: + clientId: + type: string + customTags: + type: object + additionalProperties: + type: string + dnsQueryType: + type: string + dnsServerName: + type: string + errors: + type: array + items: + type: string + id: + type: string + ismDetails: + type: object + additionalProperties: + type: string + lastErrors: + $ref: '#/components/schemas/TestLastError' + locationDisplayLabel: + type: string + locationId: + type: string + runType: + type: string + sslDaysRemaining: + type: string + testCommonProperties: + $ref: '#/components/schemas/TestCommonProperties' + testId: + type: string + testLastError: + $ref: '#/components/schemas/TestLastError' + testName: + type: string + required: + - clientId + - testId + TestResultDetailData: + type: object + properties: + har: + type: object + additionalProperties: + type: object + imageFiles: + type: object + additionalProperties: + type: array + items: + type: string + format: byte + logFiles: + type: object + additionalProperties: + type: string + logs: + type: string + subtransactionAvgMetrics: + type: object + additionalProperties: + type: object + subtransactions: + type: array + items: + $ref: '#/components/schemas/TestResultSubtransaction' + testId: + type: string + testResultId: + type: string + videos: + type: array + items: + type: string + format: byte + TestResultItem: + type: object + properties: + applicationId: + type: string + applicationIds: + type: array + items: + type: string + customTags: + type: object + additionalProperties: + type: string + locationId: + type: array + items: + type: string + metrics: + type: array + items: + type: object + additionalProperties: + type: object + mobileApplicationIds: + type: array + items: + type: string + serviceId: + type: string + testId: + type: string + testName: + type: string + websiteIds: + type: array + items: + type: string + required: + - testId + TestResultListItem: + type: object + properties: + metrics: + type: object + additionalProperties: + type: array + items: + type: array + items: + type: number + testResultCommonProperties: + $ref: '#/components/schemas/TestResultCommonProperties' + required: + - metrics + - testResultCommonProperties + TestResultListResult: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/TestResultListItem' + page: + type: integer + format: int32 + description: Page Number + minimum: 1 + pageSize: + type: integer + format: int32 + minimum: 1 + totalHits: + type: integer + format: int64 + minimum: 0 + required: + - items + TestResultMetadata: + type: object + properties: + metadata: + type: object + additionalProperties: + type: object + startTime: + type: integer + format: int64 + testId: + type: string + testResultId: + type: string + required: + - testId + TestResultSubtransaction: + type: object + properties: + metrics: + type: object + additionalProperties: + type: object + properties: + type: object + additionalProperties: + type: object + required: + - metrics + - properties + Threshold: + type: object + deprecated: true + description: Indicates the type of threshold this alert rule is evaluated on. + discriminator: + mapping: + adaptiveBaseline: '#/components/schemas/AdaptiveBaseline' + historicBaseline: '#/components/schemas/HistoricBaseline' + staticThreshold: '#/components/schemas/StaticThreshold' + propertyName: type + properties: + operator: + type: string + enum: + - '>' + - '>=' + - < + - <= + type: + type: string + required: + - operator + - type + ThresholdConfigRule: + type: object + discriminator: + mapping: + adaptiveBaseline: '#/components/schemas/AdaptiveThresholdRule' + historicBaseline: '#/components/schemas/StaticBaselineThresholdRule' + staticThreshold: '#/components/schemas/StaticThresholdRule' + propertyName: type + properties: + type: + type: string + required: + - type + ThresholdRule: + type: object + allOf: + - $ref: '#/components/schemas/AbstractRule' + - type: object + properties: + aggregation: + type: string + enum: + - sum + - avg + - min + - max + - absolute_diff + - relative_diff + conditionOperator: + type: string + enum: + - '>' + - '>=' + - < + - <= + - = + - '!=' + conditionValue: + type: number + format: double + metricName: + type: string + maxLength: 512 + minLength: 0 + metricPattern: + $ref: '#/components/schemas/MetricPattern' + rollup: + type: integer + format: int64 + window: + type: integer + format: int64 + required: + - conditionOperator + ThroughputApplicationAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/ApplicationAlertRule' + required: + - metricName + ThroughputMobileAppAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/MobileAppAlertRule' + required: + - metricName + ThroughputWebsiteAlertRule: + type: object + allOf: + - $ref: '#/components/schemas/WebsiteAlertRule' + required: + - metricName + TimeFrame: + type: object + description: Time range for which the data should be retrieved. + properties: + to: + type: integer + format: int64 + description: 'end of timeframe expressed as the Unix epoch time in milliseconds. + Eg: `ISO 8601` standard time `2024-06-27T05:05:55.615Z` can be represented + as `1719464755615` in Unix epoch time in milliseconds.' + windowSize: + type: integer + format: int64 + description: windowSize in milliseconds + maximum: 2678400000 + minimum: 0 + TimeWindow: + type: object + description: Time Window type of the SLO, it could be Fixed or Rolling + discriminator: + mapping: + fixed: '#/components/schemas/FixedTimeWindow' + rolling: '#/components/schemas/RollingTimeWindow' + propertyName: type + properties: + duration: + type: integer + format: int32 + description: Duration of the Time Window + durationUnit: + type: string + description: Unit of the Time Window Duration + enum: + - millisecond + - second + - minute + - hour + - day + - week + - month + timezone: + type: string + description: Timezone string + type: + type: string + required: + - duration + - durationUnit + - type + Topology: + type: object + properties: + edges: + type: array + items: + $ref: '#/components/schemas/GraphEdge' + nodes: + type: array + items: + $ref: '#/components/schemas/GraphNode' + Trace: + type: object + description: | + 1. `service`: The service from where trace started. + 2. `endpoint`: Endpoint of the service. + properties: + duration: + type: integer + format: int64 + description: Total time taken for a trace to finish. + minimum: 0 + endpoint: + $ref: '#/components/schemas/Endpoint' + erroneous: + type: boolean + description: Flag which tells whether the trace is erroneous or not + id: + type: string + description: The trace ID. All spans of the same trace must have the same + trace ID. For example, `e93282c0d5018320`. + label: + type: string + description: Name of the trace. + service: + $ref: '#/components/schemas/Service' + startTime: + type: integer + format: int64 + description: The start time of the trace. + minimum: 1 + required: + - id + - label + TraceActivityTreeNodeDetails: + type: object + properties: + batchSelfTime: + type: integer + format: int64 + description: | + Sum of all self times in a batch of calls. + For example, if 5 calls are in a batch and its self times are : `[1,2,3,4,5]` in milliseconds, then the batch self time would be sum of the self times, + in this case, it will be 15 milliseconds. + batchSize: + type: integer + format: int32 + description: Number of calls in a batch. + minimum: 0 + destination: + $ref: '#/components/schemas/SpanRelation' + duration: + type: integer + format: int64 + description: The total time taken for the entire operation of a call, from + the moment the request was initiated to when the response was received. + The time measured is in milliseconds. This is also known as latency of + a call. + minimum: 0 + errorCount: + type: integer + format: int32 + description: Represents whether the call is erroneous or not. 0 is not erroneous + and 1 is erroneous. + minimum: 0 + id: + type: string + description: 'The call ID. A unique identifier for an individual call. For + example: `1bcad5c82338deaf`.' + isSynthetic: + type: boolean + writeOnly: true + label: + type: string + description: 'Name of the call. For example: `GET /articles/:id`.' + maxLength: 128 + minLength: 0 + logs: + type: array + description: Information about the logs attached to the call, if available. + items: + $ref: '#/components/schemas/SpanExcerpt' + uniqueItems: true + minSelfTime: + type: integer + format: int64 + description: The smallest self time in the batch. May be null to indicate + that `minSelfTime` is unknown when this node has only an exit span and + no children. The time measured is in milliseconds. + networkTime: + type: integer + format: int64 + description: The time difference between the Exit Span Time of the caller + and the Entry Span Time of the call. This value is measured in milliseconds + and may be null if network time is not applicable. + rawSpanLoadError: + type: string + description: Whether an error occurred loading raw spans from external storage. + enum: + - UNKNOWN_ERROR + - NOT_FOUND + - PERMISSION_DENIED + - NO_ERROR + source: + $ref: '#/components/schemas/SpanRelation' + spans: + type: array + description: Information about the spans from which the call is composed. + items: + $ref: '#/components/schemas/SpanExcerpt' + maxItems: 2 + minItems: 1 + uniqueItems: true + start: + type: integer + format: int64 + description: The timestamp when the call or request was initiated. For example, + Unix epoch time in milliseconds `1735532879870` is `Monday, 30 December + 2024 04:27:59.870 GMT` + minimum: 1 + synthetic: + type: boolean + required: + - id + - label + - logs + - spans + TraceDownloadResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + canLoadMore: + type: boolean + description: Determine if additional data is available when a new query + is made using the cursor from the last item in the `items` list. + items: + type: array + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + items: + $ref: '#/components/schemas/GetTraceDownloadResultItem' + totalHits: + type: integer + format: int64 + description: The total number of items that match a given filter + minimum: 0 + totalRepresentedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, one row can represent multiple real + items (batched call, sample multiplicity) + minimum: 0 + totalRetainedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, only a subset is retained for historic + data. Each retained row can represent multiple real items due to batching. + minimum: 0 + required: + - items + TraceGroupsItem: + type: object + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + properties: + cursor: + $ref: '#/components/schemas/IngestionOffsetCursor' + metrics: + type: object + additionalProperties: + type: array + description: | + Grouped metric details like `errors.mean`, `calls.sum`. + It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`. + Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`. + items: + type: array + description: | + Grouped metric details like `errors.mean`, `calls.sum`. + It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`. + Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`. + items: + type: number + description: | + Grouped metric details like `errors.mean`, `calls.sum`. + It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`. + Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`. + description: | + Grouped metric details like `errors.mean`, `calls.sum`. + It is usually a array of key-value pair. Format of key is `metric.aggregation.granularity`, for example: `latency.p75.360`. + Format of value is `[earliest timestamp, value of key]`, for example: `[1725602720000, 0.013141001434936938]`. + name: + type: string + description: Name of the group. + timestamp: + type: integer + format: int64 + description: Earliest timestamp of the trace from the group + minimum: 0 + required: + - cursor + - metrics + - name + TraceGroupsResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + canLoadMore: + type: boolean + description: Determine if additional data is available when a new query + is made using the cursor from the last item in the `items` list. + items: + type: array + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + items: + $ref: '#/components/schemas/TraceGroupsItem' + totalHits: + type: integer + format: int64 + description: The total number of items that match a given filter + minimum: 0 + totalRepresentedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, one row can represent multiple real + items (batched call, sample multiplicity) + minimum: 0 + totalRetainedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, only a subset is retained for historic + data. Each retained row can represent multiple real items due to batching. + minimum: 0 + required: + - items + TraceImpactApplicationTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/ApplicationTimeThreshold' + - type: object + properties: + requests: + type: integer + format: int32 + minimum: 1 + TraceItem: + type: object + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + properties: + cursor: + $ref: '#/components/schemas/IngestionOffsetCursor' + trace: + $ref: '#/components/schemas/Trace' + required: + - cursor + - trace + TraceResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + canLoadMore: + type: boolean + description: Determine if additional data is available when a new query + is made using the cursor from the last item in the `items` list. + items: + type: array + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + items: + $ref: '#/components/schemas/TraceItem' + totalHits: + type: integer + format: int64 + description: The total number of items that match a given filter + minimum: 0 + totalRepresentedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, one row can represent multiple real + items (batched call, sample multiplicity) + minimum: 0 + totalRetainedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, only a subset is retained for historic + data. Each retained row can represent multiple real items due to batching. + minimum: 0 + required: + - items + TrafficBlueprintIndicator: + type: object + allOf: + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + properties: + threshold: + type: number + format: double + description: Threshold Value for the Blueprint + exclusiveMinimum: false + minimum: 0.0 + trafficType: + type: string + enum: + - erroneous + - all + required: + - trafficType + - type + Trigger: + type: object + description: The trigger is the Instana event or Smart Alert that defines the + initial conditions that must be met for the policy to apply on the actions + in `typeConfiguration`. + properties: + description: + type: string + description: A description for the trigger. + id: + type: string + description: Trigger (Instana event or Smart Alert) identifier. + name: + type: string + description: A name of the trigger (name of Instana event or Smart Alert). + scheduling: + $ref: '#/components/schemas/PolicyScheduling' + type: + type: string + description: Instana event type, Smart Alert type, or 'schedule'. The type + must be one of the enum values. + enum: + - customEvent + - builtinEvent + - applicationSmartAlert + - globalApplicationSmartAlert + - websiteSmartAlert + - infraSmartAlert + - mobileAppSmartAlert + - syntheticsSmartAlert + - logSmartAlert + - sloSmartAlert + - schedule + required: + - type + TypeConfiguration: + type: object + description: List of configurations that contains the list of actions to run + and the mode (automatic or manual) in which the policy is run. + properties: + condition: + $ref: '#/components/schemas/Condition' + name: + type: string + description: The policy type determines how a policy is run. Value must + be one of the enum values. Value `manual` means the policy is run manually + when an event is raised. Value `automatic` means policy is run automatically + when an event is raised. + enum: + - automatic + - manual + runnable: + $ref: '#/components/schemas/PolicyRunnable' + required: + - name + - runnable + UnsupportedHttpPathSegmentMatchingRule: + type: object + allOf: + - $ref: '#/components/schemas/HttpPathSegmentMatchingRule' + - type: object + properties: + unsupportedType: + type: string + required: + - type + UpdatedBusinessPerspectiveConfig: + type: object + properties: + description: + type: string + maxLength: 300 + minLength: 0 + name: + type: string + maxLength: 100 + minLength: 0 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + UsageResult: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/UsageResultItems' + time: + type: integer + format: int64 + UsageResultItems: + type: object + properties: + name: + type: string + sims: + type: integer + format: int64 + UserBasicResult: + type: object + properties: + email: + type: string + fullName: + type: string + id: + type: string + required: + - email + - fullName + - id + UserImpactMobileAppTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/MobileAppTimeThreshold' + - type: object + properties: + impactMeasurementMethod: + type: string + enum: + - AGGREGATED + - PER_WINDOW + userPercentage: + type: number + format: double + exclusiveMaximum: false + exclusiveMinimum: true + maximum: 1.0 + minimum: 0.0 + users: + type: integer + format: int32 + minimum: 1 + required: + - impactMeasurementMethod + UserImpactWebsiteTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/WebsiteTimeThreshold' + - type: object + properties: + impactMeasurementMethod: + type: string + enum: + - AGGREGATED + - PER_WINDOW + userPercentage: + type: number + format: double + exclusiveMaximum: false + exclusiveMinimum: true + maximum: 1.0 + minimum: 0.0 + users: + type: integer + format: int32 + minimum: 1 + required: + - impactMeasurementMethod + UserResult: + type: object + properties: + email: + type: string + fullName: + type: string + groupCount: + type: integer + format: int64 + id: + type: string + lastLoggedIn: + type: integer + format: int64 + tfaEnabled: + type: boolean + required: + - email + - fullName + - id + UsersResult: + type: object + properties: + invitations: + type: array + items: + $ref: '#/components/schemas/InvitationResult' + uniqueItems: true + users: + type: array + items: + $ref: '#/components/schemas/UserResult' + uniqueItems: true + ValidatedAlertingChannelInputInfo: + type: object + properties: + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. + entityId: + type: string + description: The entity ID in case of Smart Alerts, such as for the application, + website or mobile app. + eventTypes: + type: array + description: The selected event types, if applicable. + items: + type: string + description: The selected event types, if applicable. + enum: + - incident + - critical + - warning + - change + - online + - offline + - agent_monitoring_issue + - cve_issue + - none + maxItems: 6 + minItems: 0 + uniqueItems: true + id: + type: string + description: ID of the alert configuration. + maxLength: 64 + minLength: 0 + invalid: + type: boolean + description: Flag to indicate whether the specified query is invalid. + label: + type: string + description: The name of the alert configuration. + maxLength: 256 + minLength: 0 + query: + type: string + description: The DFQ used in the alert configuration, if applicable. + maxLength: 2048 + minLength: 0 + selectedEvents: + type: integer + format: int32 + description: The number of selected events, if applicable. + type: + type: string + description: The alert type. + enum: + - Alert + - WebsiteSmartAlert + - MobileSmartAlert + - ApplicationSmartAlert + - GlobalApplicationSmartAlert + - SyntheticSmartAlert + - InfraSmartAlert + - ServiceLevelSmartAlert + - LogSmartAlert + required: + - id + - label + - type + ValidatedAlertingConfiguration: + type: object + properties: + alertChannelNames: + type: array + description: Set of Alert Channel names added in the Alert Configuration. + items: + type: string + description: Set of Alert Channel names added in the Alert Configuration. + uniqueItems: true + alertName: + type: string + description: Name of the Alert Configuration. + maxLength: 256 + minLength: 0 + applicationNames: + type: array + description: Set of Application Perspective names added in the Alert Configuration. + items: + type: string + description: Set of Application Perspective names added in the Alert Configuration. + uniqueItems: true + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/StaticStringField' + maxItems: 20 + minItems: 0 + eventFilteringConfiguration: + $ref: '#/components/schemas/EventFilteringConfiguration' + id: + type: string + description: ID of the Alert Configuration. + maxLength: 64 + minLength: 0 + includeEntityNameInLegacyAlerts: + type: boolean + description: To include the entity name in a legacy alert based on built-in/custom + events. + integrationIds: + type: array + description: List of Alert Channel IDs added in this Alert Configuration. + items: + type: string + description: List of Alert Channel IDs added in this Alert Configuration. + maxItems: 1024 + minItems: 0 + uniqueItems: true + invalid: + type: boolean + description: Flag to show whether the Alert Configuration is valid. + lastUpdated: + type: integer + format: int64 + description: Unix timestamp representing the time the configuration was + last updated. + minimum: 1 + muteUntil: + type: integer + format: int64 + description: Timer dictating how long the Alert Configuration will stay + muted. A value of `0` means the Alert Configuration is currently enabled. + Otherwise, the Alert Configuration is currently disabled (muted). + required: + - alertName + - customPayloadFields + - eventFilteringConfiguration + - id + - integrationIds + ValidatedMaintenanceConfigV2WithStateAndOccurrence: + type: object + properties: + applicationNames: + type: array + description: Name set of the Application Perspectives within the scope of + the Maintenance Window + items: + type: string + description: Name set of the Application Perspectives within the scope + of the Maintenance Window + uniqueItems: true + id: + type: string + description: ID of the Maintenance Window configuration. + maxLength: 64 + minLength: 0 + invalid: + type: boolean + description: Boolean flag that tells if the Dynamic Focus Query(DFQ) is + invalid. + lastUpdated: + type: integer + format: int64 + minimum: 1 + name: + type: string + description: Name of the Maintenance Window configuration. + maxLength: 256 + minLength: 0 + occurrence: + $ref: '#/components/schemas/Occurrence' + paused: + type: boolean + description: Boolean flag to determine if the Maintenance Window configuration + is paused or still live. + query: + type: string + description: Dynamic Focus Query that determines the scope of the Maintenance + Window configuration. + maxLength: 2048 + minLength: 0 + retriggerOpenAlertsEnabled: + type: boolean + description: Boolean flag to determine if we should retrigger open alerts + to be sent out for any events that opened during this maintenance window, + and continues to remain open after the window expires + scheduling: + $ref: '#/components/schemas/MaintenanceConfigScheduling' + state: + type: string + description: 'State of the Maintenance Window, it can be: UNSCHEDULED, SCHEDULED, + ACTIVE, PAUSED, EXPIRED.' + enum: + - UNSCHEDULED + - SCHEDULED + - ACTIVE + - PAUSED + - EXPIRED + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilterExpressionEnabled: + type: boolean + description: Boolean flag to determine if the tagFilterExpression is enabled. + required: + - id + - name + - occurrence + - query + - scheduling + ValidatedMaintenanceConfigWithStatus: + type: object + properties: + id: + type: string + description: ID of the Maintenance Window Configuration. + maxLength: 64 + minLength: 0 + invalid: + type: boolean + description: Boolean flag that tells if the Dynamic Focus Query(DFQ) is + invalid. + lastUpdated: + type: integer + format: int64 + minimum: 1 + name: + type: string + description: Name of the Maintenance Window Configuration. + maxLength: 256 + minLength: 0 + query: + type: string + description: Dynamic Focus Query that determines the scope of the Maintenance + Window configuration. + maxLength: 2048 + minLength: 0 + status: + type: string + description: 'Status of the Maintenance Window Configuration. It can be + one of: UNSCHEDULED, SCHEDULED, ACTIVE, FINISHED, PAUSED.' + enum: + - UNSCHEDULED + - SCHEDULED + - ACTIVE + - FINISHED + - PAUSED + windows: + type: array + description: A set of time periods when the Maintenance Window Configuration + is active. + items: + $ref: '#/components/schemas/MaintenanceWindow' + maxItems: 1 + minItems: 0 + uniqueItems: true + required: + - id + - name + - query + - status + VictorOpsIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + apiKey: + type: string + routingKey: + type: string + required: + - apiKey + - id + - kind + - name + - routingKey + ViolationsInPeriodApplicationTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/ApplicationTimeThreshold' + - type: object + properties: + violations: + type: integer + format: int32 + maximum: 12 + minimum: 1 + ViolationsInPeriodMobileAppTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/MobileAppTimeThreshold' + - type: object + properties: + violations: + type: integer + format: int32 + maximum: 12 + minimum: 1 + ViolationsInPeriodWebsiteTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/WebsiteTimeThreshold' + - type: object + properties: + violations: + type: integer + format: int32 + maximum: 12 + minimum: 1 + ViolationsInSequenceApplicationTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/ApplicationTimeThreshold' + ViolationsInSequenceInfraTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/InfraTimeThreshold' + ViolationsInSequenceLogTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/LogTimeThreshold' + ViolationsInSequenceMobileAppTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/MobileAppTimeThreshold' + ViolationsInSequenceSyntheticTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTimeThreshold' + ViolationsInSequenceWebsiteTimeThreshold: + type: object + allOf: + - $ref: '#/components/schemas/WebsiteTimeThreshold' + WatsonAIOpsWebhookIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + headers: + type: array + items: + type: string + webhookUrl: + type: string + required: + - id + - kind + - name + - webhookUrl + WebexTeamsWebhookIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + webhookUrl: + type: string + required: + - id + - kind + - name + - webhookUrl + WebhookIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + headers: + type: array + items: + type: string + oauth: + $ref: '#/components/schemas/OAuthIntegration' + oauthEnabled: + type: boolean + transformationExpression: + type: string + webhookUrls: + type: array + items: + type: string + required: + - id + - kind + - name + - webhookUrls + WebpageActionConfiguration: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + browser: + type: string + enum: + - chrome + - firefox + recordVideo: + type: boolean + url: + type: string + maxLength: 2047 + minLength: 0 + required: + - markSyntheticCall + - syntheticType + - url + WebpageActionConfigurationUpdate: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - type: object + properties: + browser: + type: string + enum: + - chrome + - firefox + recordVideo: + type: boolean + url: + type: string + WebpageScriptConfiguration: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + browser: + type: string + enum: + - chrome + - firefox + fileName: + type: string + recordVideo: + type: boolean + script: + type: string + maxLength: 1048576 + minLength: 0 + required: + - markSyntheticCall + - script + - syntheticType + WebpageScriptConfigurationUpdate: + type: object + allOf: + - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - type: object + properties: + browser: + type: string + enum: + - chrome + - firefox + fileName: + type: string + recordVideo: + type: boolean + script: + type: string + Website: + type: object + properties: + appName: + type: string + id: + type: string + name: + type: string + required: + - id + - name + WebsiteAlertConfig: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the website alert configuration. Used as a template + for the description of alert/event notifications triggered by this Smart + Alert configuration. + maxLength: 65536 + minLength: 0 + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + name: + type: string + description: Name of the website alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + rule: + $ref: '#/components/schemas/WebsiteAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdWebsiteAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/TagFilter' + uniqueItems: true + writeOnly: true + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/WebsiteTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + websiteId: + type: string + description: ID of the website that this Smart Alert configuration is applied + to. + maxLength: 64 + minLength: 0 + required: + - customPayloadFields + - description + - granularity + - name + - tagFilterExpression + - timeThreshold + - websiteId + WebsiteAlertConfigWithMetadata: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + created: + type: integer + format: int64 + description: Unix timestamp representing the creation time of this revision. + minimum: 1 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the website alert configuration. Used as a template + for the description of alert/event notifications triggered by this Smart + Alert configuration. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + id: + type: string + description: 'ID of this Website Alert Config. ' + maxLength: 64 + minLength: 0 + initialCreated: + type: integer + format: int64 + description: Unix timestamp representing the time of the initial revision. + minimum: 1 + name: + type: string + description: Name of the website alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + readOnly: + type: boolean + description: Flag to indicate whether or not the configuration is read-only. + Read-only access restricts modification of the config. + rule: + $ref: '#/components/schemas/WebsiteAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdWebsiteAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + tagFilters: + type: array + items: + $ref: '#/components/schemas/TagFilter' + uniqueItems: true + writeOnly: true + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/WebsiteTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + websiteId: + type: string + description: ID of the website that this Smart Alert configuration is applied + to. + maxLength: 64 + minLength: 0 + required: + - customPayloadFields + - description + - granularity + - id + - name + - tagFilterExpression + - timeThreshold + - websiteId + WebsiteAlertRule: + type: object + discriminator: + mapping: + customEvent: '#/components/schemas/CustomEventWebsiteAlertRule' + slowness: '#/components/schemas/SlownessWebsiteAlertRule' + specificJsError: '#/components/schemas/SpecificJsErrorsWebsiteAlertRule' + statusCode: '#/components/schemas/StatusCodeWebsiteAlertRule' + throughput: '#/components/schemas/ThroughputWebsiteAlertRule' + propertyName: alertType + properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + alertType: + type: string + metricName: + type: string + required: + - alertType + - metricName + WebsiteApdexEntity: + type: object + allOf: + - $ref: '#/components/schemas/ApdexEntity' + - type: object + properties: + beaconType: + type: string + description: Website Beacon Type + enum: + - pageLoad + - resourceLoad + - httpRequest + - error + - custom + - pageChange + entityId: + type: string + description: Website ID + threshold: + type: integer + format: int32 + description: Value of the Apdex Threshold + minimum: 1 + required: + - beaconType + - entityId + - tagFilterExpression + WebsiteBeaconGroupsItem: + type: object + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + properties: + cursor: + $ref: '#/components/schemas/IngestionOffsetCursor' + earliestTimestamp: + type: integer + format: int64 + minimum: 0 + metrics: + type: object + additionalProperties: + type: array + items: + type: array + items: + type: number + name: + type: string + required: + - cursor + - metrics + - name + WebsiteBeaconGroupsResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + canLoadMore: + type: boolean + description: Determine if additional data is available when a new query + is made using the cursor from the last item in the `items` list. + items: + type: array + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + items: + $ref: '#/components/schemas/WebsiteBeaconGroupsItem' + totalHits: + type: integer + format: int64 + description: The total number of items that match a given filter + minimum: 0 + totalRepresentedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, one row can represent multiple real + items (batched call, sample multiplicity) + minimum: 0 + totalRetainedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, only a subset is retained for historic + data. Each retained row can represent multiple real items due to batching. + minimum: 0 + required: + - items + WebsiteBeaconResult: + type: object + properties: + adjustedTimeframe: + $ref: '#/components/schemas/AdjustedTimeframe' + canLoadMore: + type: boolean + description: Determine if additional data is available when a new query + is made using the cursor from the last item in the `items` list. + items: + type: array + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + items: + $ref: '#/components/schemas/WebsiteBeaconsItem' + totalHits: + type: integer + format: int64 + description: The total number of items that match a given filter + minimum: 0 + totalRepresentedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, one row can represent multiple real + items (batched call, sample multiplicity) + minimum: 0 + totalRetainedItemCount: + type: integer + format: int64 + description: For calls and EUM beacons, only a subset is retained for historic + data. Each retained row can represent multiple real items due to batching. + minimum: 0 + required: + - items + WebsiteBeaconTagGroup: + type: object + properties: + groupbyTag: + type: string + description: The name of the group tag (e.g. `agent.tag` or `docker.label`). + maxLength: 256 + minLength: 0 + groupbyTagEntity: + type: string + description: | + The entity by which the data should be grouped. + This field supports three possible values: `NOT_APPLICABLE`, `DESTINATION`, and `SOURCE`. + `SOURCE`: the tag filter should apply to the source entity. + `DESTINATION`: the tag filter should apply to the destination entity. + `NOT_APPLICABLE`: some tags are independent of source or destination, such as tags on the call itself, log tags or trace tags (only destination makes sense because the source is unknown for the root call). + enum: + - NOT_APPLICABLE + - DESTINATION + - SOURCE + groupbyTagSecondLevelKey: + type: string + description: If present, it's the 2nd level key part (e.g. `customKey` on + `docker.label.customKey`) + maxLength: 256 + minLength: 0 + required: + - groupbyTag + - groupbyTagEntity + WebsiteBeaconsItem: + type: object + description: | + Represents an array of call group item containing several attributes that describe its properties. + The item includes fields such as cursor, metrics, name, and timestamp, which provide detailed information about the item. + properties: + beacon: + $ref: '#/components/schemas/WebsiteMonitoringBeacon' + cursor: + $ref: '#/components/schemas/IngestionOffsetCursor' + impactedBeaconInfo: + $ref: '#/components/schemas/ImpactedBeaconInfo' + required: + - beacon + - cursor + WebsiteEventBasedSliEntity: + type: object + allOf: + - $ref: '#/components/schemas/SliEntity' + - type: object + properties: + badEventFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + beaconType: + type: string + description: Enum value to specify the type of beacons to be monitored + enum: + - pageLoad + - resourceLoad + - httpRequest + - error + - custom + - pageChange + goodEventFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + websiteId: + type: string + description: Specifies the ID of the Website + required: + - badEventFilterExpression + - beaconType + - goodEventFilterExpression + WebsiteEventResult: + type: object + allOf: + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + websiteId: + type: string + description: ID of the website. + WebsiteMetricResult: + type: object + properties: + empty: + type: boolean + WebsiteMonitoringBeacon: + type: object + properties: + accuracyRadius: + type: integer + format: int64 + minimum: -1 + accurateTimingsAvailable: + type: boolean + agentVersion: + type: string + appCacheTime: + type: integer + format: int64 + minimum: -1 + backendTime: + type: integer + format: int64 + minimum: -1 + backendTraceId: + type: string + batchSize: + type: integer + format: int64 + minimum: 1 + beaconId: + type: string + browserName: + type: string + browserVersion: + type: string + bytesIngested: + type: integer + format: int64 + cacheInteraction: + type: string + childrenTime: + type: integer + format: int64 + minimum: -1 + city: + type: string + clockSkew: + type: integer + format: int64 + minimum: -1 + componentStack: + type: string + connectionType: + type: string + continent: + type: string + continentCode: + type: string + country: + type: string + countryCode: + type: string + cspBlockedUri: + type: string + cspColumnNumber: + type: integer + format: int64 + cspDisposition: + type: string + cspEffectiveDirective: + type: string + cspLineNumber: + type: integer + format: int64 + cspOriginalPolicy: + type: string + cspSample: + type: string + cspSourceFile: + type: string + cumulativeLayoutShift: + type: number + format: double + customEventName: + type: string + customMetric: + type: number + format: double + decodedBodySize: + type: integer + format: int64 + minimum: -1 + deprecations: + type: array + items: + type: string + maxItems: 16 + minItems: 0 + uniqueItems: true + deviceType: + type: string + dnsTime: + type: integer + format: int64 + minimum: -1 + domTime: + type: integer + format: int64 + minimum: -1 + duration: + type: integer + format: int64 + minimum: 0 + encodedBodySize: + type: integer + format: int64 + minimum: -1 + errorCount: + type: integer + format: int64 + minimum: 0 + errorId: + type: string + errorMessage: + type: string + errorType: + type: string + firstContentfulPaintTime: + type: integer + format: int64 + minimum: -1 + firstInputDelayTime: + type: integer + format: int64 + minimum: -1 + firstPaintTime: + type: integer + format: int64 + minimum: -1 + frontendTime: + type: integer + format: int64 + minimum: -1 + graphqlOperationName: + type: string + graphqlOperationType: + type: string + httpCallAsynchronous: + type: boolean + httpCallCorrelationAttempted: + type: boolean + httpCallHeaders: + type: object + additionalProperties: + type: string + httpCallMethod: + type: string + httpCallOrigin: + type: string + httpCallPath: + type: string + httpCallStatus: + type: integer + format: int32 + maximum: 599 + minimum: -1 + httpCallUrl: + type: string + initiator: + type: string + interactionNextPaint: + type: integer + format: int64 + internalMeta: + type: object + additionalProperties: + type: string + label: + type: string + largestContentfulPaintTime: + type: integer + format: int64 + minimum: -1 + latitude: + type: number + format: double + locationOrigin: + type: string + locationPath: + type: string + locationUrl: + type: string + longitude: + type: number + format: double + meta: + type: object + additionalProperties: + type: string + onLoadTime: + type: integer + format: int64 + minimum: -1 + osName: + type: string + osVersion: + type: string + page: + type: string + pageLoadId: + type: string + parentBeaconId: + type: string + parsedStackTrace: + type: array + items: + $ref: '#/components/schemas/JsStackTraceLine' + maxItems: 64 + minItems: 0 + phase: + type: string + processingTime: + type: integer + format: int64 + minimum: -1 + redirectTime: + type: integer + format: int64 + minimum: -1 + requestTime: + type: integer + format: int64 + minimum: -1 + resourceType: + type: string + responseTime: + type: integer + format: int64 + minimum: -1 + sessionId: + type: string + snippetVersion: + type: string + sslTime: + type: integer + format: int64 + minimum: -1 + stackTrace: + type: string + stackTraceParsingStatus: + type: integer + format: int32 + minimum: -1 + stackTraceReadability: + type: integer + format: int32 + minimum: 0 + subdivision: + type: string + subdivisionCode: + type: string + tcpTime: + type: integer + format: int64 + minimum: -1 + timestamp: + type: integer + format: int64 + minimum: 1 + transferSize: + type: integer + format: int64 + minimum: -1 + type: + type: string + unloadTime: + type: integer + format: int64 + minimum: -1 + useFeatures: + type: array + items: + type: string + maxItems: 15 + minItems: 0 + userEmail: + type: string + userId: + type: string + userIp: + type: string + userLanguages: + type: array + items: + type: string + maxItems: 5 + minItems: 0 + userName: + type: string + websiteId: + type: string + websiteLabel: + type: string + windowHeight: + type: integer + format: int32 + minimum: -1 + windowHidden: + type: boolean + windowWidth: + type: integer + format: int32 + minimum: -1 + required: + - beaconId + - locationOrigin + - locationUrl + - pageLoadId + - type + - websiteId + - websiteLabel + WebsiteMonitoringMetricDescription: + type: object + properties: + aggregations: + type: array + description: | + The types of aggregations that can be applied to a series of values. + For example, `P25` is 25th percentile. Note that not all aggregations are available for metrics. + For example, `Trace count` has only `SUM` as an aggregation whereas `Call Count` has two aggregations, `SUM` and `PER_SECOND`. + items: + type: string + description: | + The types of aggregations that can be applied to a series of values. + For example, `P25` is 25th percentile. Note that not all aggregations are available for metrics. + For example, `Trace count` has only `SUM` as an aggregation whereas `Call Count` has two aggregations, `SUM` and `PER_SECOND`. + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + uniqueItems: true + beaconTypes: + type: array + items: + type: string + uniqueItems: true + defaultAggregation: + type: string + description: The preselected aggregation for a metric. For example, for + `Call latency` the default aggregation is `MEAN`. + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + description: + type: string + description: A description of the metric. For example, for `Call count` + metric, the description would be something like `Number of received calls` + formatter: + type: string + description: | + * `NUMBER`: Generic number + * `BYTES`: Number of bytes + * `KILO_BYTES`: Number of kilobytes + * `MEGA_BYTES`: Number of megabytes + * `PERCENTAGE`: Percentage in scale [0,1] + * `PERCENTAGE_100`: Percentage in scale [0,100] + * `PERCENTAGE_NO_CAPPING`: Percentage in scale [0,1] but value could exceed 1 for example when metric is aggregated + * `PERCENTAGE_100_NO_CAPPING`: Percentage in scale [0,100] but value could exceed 100 for example when metric is aggregated + * `LATENCY`: Time in milliseconds, with value of 0 should not be considered a a strict 0, but considered as < 1ms + * `NANOS`: Time in nanoseconds + * `MILLIS`: Time in milliseconds + * `MICROS`: Time in microseconds + * `SECONDS`: Time in seconds + * `RATE`: Number of occurrences per second + * `BYTE_RATE`: Number of bytes per second + * `UNDEFINED`: Metric value unit is not known + label: + type: string + description: The name of the metric. For example, `Call count`, `Erroneous + calls`, `Service count` etc. + metricId: + type: string + description: The unique id of the metric. For example, `calls`, `erroneousCalls`, + `latency` etc. + pathToValueInBeacon: + type: array + items: + type: string + maxItems: 2147483647 + minItems: 1 + tagName: + type: string + required: + - aggregations + - beaconTypes + - formatter + - label + - metricId + WebsiteMonitoringMetricsConfiguration: + type: object + properties: + aggregation: + type: string + description: 'Set aggregation that can be applied to a series of values. + Eg: `MEAN`.' + enum: + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE + granularity: + type: integer + format: int32 + description: 'If the granularity is set you will get data points with the + specified granularity in seconds. Default: `1000` milliseconds' + metric: + type: string + description: 'Set a particular metric, eg: `latency`.' + required: + - aggregation + - metric + WebsiteSloEntity: + type: object + allOf: + - $ref: '#/components/schemas/SloEntity' + - type: object + properties: + beaconType: + type: string + description: Type of Website Beacon to be considered for the SLO + enum: + - pageLoad + - resourceLoad + - httpRequest + - error + - custom + - pageChange + websiteId: + type: string + description: The ID of the Website + required: + - beaconType + - websiteId + WebsiteTimeBasedSliEntity: + type: object + allOf: + - $ref: '#/components/schemas/SliEntity' + - type: object + properties: + beaconType: + type: string + description: Enum value to specify the type of beacons to be monitored + enum: + - pageLoad + - resourceLoad + - httpRequest + - error + - custom + - pageChange + filterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + websiteId: + type: string + description: Specifies the ID of the Website + required: + - beaconType + WebsiteTimeThreshold: + type: object + description: The type of threshold to define the criteria when the event and + alert triggers and resolves. + discriminator: + mapping: + userImpactOfViolationsInSequence: '#/components/schemas/UserImpactWebsiteTimeThreshold' + violationsInPeriod: '#/components/schemas/ViolationsInPeriodWebsiteTimeThreshold' + violationsInSequence: '#/components/schemas/ViolationsInSequenceWebsiteTimeThreshold' + propertyName: type + properties: + timeWindow: + type: integer + format: int64 + type: + type: string + required: + - type + Widget: + type: object + properties: + config: + type: object + height: + type: integer + format: int32 + minimum: 1 + id: + type: string + maxLength: 64 + minLength: 0 + title: + type: string + type: + type: string + width: + type: integer + format: int32 + maximum: 12 + minimum: 1 + x: + type: integer + format: int32 + maximum: 11 + minimum: 0 + y: + type: integer + format: int32 + minimum: 0 + required: + - config + - id + - type + WithMetadata: + type: object + properties: + alertChannelIds: + type: array + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be left + empty. + items: + type: string + deprecated: true + description: List of IDs of alert channels defined in Instana. Can be + left empty. + maxItems: 1024 + minItems: 0 + uniqueItems: true + alertChannels: + type: object + additionalProperties: + type: array + description: Set of alert channel IDs associated with the severity. + items: + type: string + description: Set of alert channel IDs associated with the severity. + uniqueItems: true + description: Set of alert channel IDs associated with the severity. + completeTagFilterExpression: + $ref: '#/components/schemas/TagFilterExpression' + created: + type: integer + format: int64 + description: Unix timestamp representing the creation time of this revision. + minimum: 1 + customPayloadFields: + type: array + description: Custom payload fields to send additional information in the + alert notifications. Can be left empty. + items: + $ref: '#/components/schemas/CustomPayloadField' + maxItems: 20 + minItems: 0 + description: + type: string + description: Description of the mobile app alert configuration. Used as + a template for the description of alert/event notifications triggered + by this Smart Alert configuration. + maxLength: 65536 + minLength: 0 + enabled: + type: boolean + description: Flag to indicate whether or not the configuration is enabled. + gracePeriod: + type: integer + format: int64 + description: The duration for which an alert remains open after conditions + are no longer violated, with the alert auto-closing once the grace period + expires. + granularity: + type: integer + format: int32 + default: 600000 + description: The evaluation granularity used for detection of violations + of the defined threshold. Defines the size of the tumbling window used. + enum: + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 + id: + type: string + description: 'ID of this Mobile App Alert Config. ' + maxLength: 64 + minLength: 0 + initialCreated: + type: integer + format: int64 + description: Unix timestamp representing the time of the initial revision. + minimum: 1 + mobileAppId: + type: string + description: ID of the mobile app that this Smart Alert configuration is + applied to. + maxLength: 64 + minLength: 0 + name: + type: string + description: Name of the mobile app alert configuration. Used as a template + for the title of alert/event notifications triggered by this Smart Alert + configuration. + maxLength: 256 + minLength: 0 + readOnly: + type: boolean + description: Flag to indicate whether or not the configuration is read-only. + Read-only access restricts modification of the config. + rule: + $ref: '#/components/schemas/MobileAppAlertRule' + rules: + type: array + description: A list of rules where each rule is associated with multiple + thresholds and their corresponding severity levels. This enables more + complex alert configurations with validations to ensure consistent and + logical threshold-severity combinations. + items: + $ref: '#/components/schemas/RuleWithThresholdMobileAppAlertRule' + maxItems: 1 + minItems: 1 + severity: + type: integer + format: int32 + deprecated: true + description: The severity of the alert when triggered, which is either 5 + (Warning), or 10 (Critical). + maximum: 10 + minimum: 5 + tagFilterExpression: + $ref: '#/components/schemas/TagFilterExpressionElement' + threshold: + $ref: '#/components/schemas/Threshold' + timeThreshold: + $ref: '#/components/schemas/MobileAppTimeThreshold' + triggering: + type: boolean + description: Optional flag to indicate whether an Incident is also triggered + or not. + required: + - customPayloadFields + - description + - granularity + - id + - mobileAppId + - name + - tagFilterExpression + - timeThreshold + WithResolvedName: + type: object + allOf: + - $ref: '#/components/schemas/Author' + - type: object + properties: + fullName: + type: string + ZChatOpsIntegration: + type: object + allOf: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + bearerAuthToken: + type: string + channels: + type: array + items: + type: string + maxItems: 1 + minItems: 0 + zchatOpsIncidentsUrl: + type: string + required: + - bearerAuthToken + - id + - kind + - name + - zchatOpsIncidentsUrl + securitySchemes: + ApiKeyAuth: + description: In order to use the REST API, you need to create an API token and + assign permissions to it. API tokens are managed only by the account owner + role, who can create multiple API tokens with varying permissions. API token + management can found in Settings → Access Control → API Tokens. + in: header + name: authorization + type: apiKey + x-description: authorization +x-tagGroups: +- name: Websites & Mobile Apps + tags: + - Website Metrics + - Website Catalog + - Website Analyze + - Website Configuration + - Mobile App Metrics + - Mobile App Catalog + - Mobile App Analyze + - Mobile App Configuration + - End User Monitoring +- name: Applications + tags: + - Application Metrics + - Application Resources + - Application Catalog + - Application Analyze + - Application Settings + - Application Topology + - Application Alert Configuration + - Global Application Alert Configuration +- name: Infrastructure + tags: + - Infrastructure Analyze + - Infrastructure Metrics + - Infrastructure Resources + - Infrastructure Catalog + - Infrastructure Topology +- name: Logging + tags: + - Logging Analyze +- name: Synthetic Monitoring + tags: + - Synthetic Catalog + - Synthetic Metrics + - Synthetic Settings + - Synthetic Test Playback Results + - Synthetic Alert Configuration +- name: Logs + tags: + - Log Alert Configuration +- name: Events + tags: + - Events + - Event Settings +- name: Automation + tags: + - Action Catalog + - Action History + - Policies +- name: Service Levels + tags: + - SLI Settings + - SLI Report + - Apdex Settings + - Apdex Report + - Service Levels Objective(SLO) Configurations + - Service Levels Objective(SLO) Report + - Service Levels Alert Configuration + - SLO Correction Configurations + - SLO Correction Windows +- name: AI Management + tags: + - AI Management +- name: Settings + tags: + - Custom Dashboards + - User + - Groups + - Teams + - Roles + - Audit Log + - API Token + - Maintenance Configuration + - Synthetic Calls + - Session Settings + - Automation Settings + - Authentication +- name: Open Beta Features + tags: + - Infrastructure Analyze +- name: Closed Beta Features + tags: + - Infrastructure Alert Configuration +- name: Instana + tags: + - Releases + - Host Agent + - Health + - Usage diff --git a/pyproject.toml b/pyproject.toml index 97ec392..06795de 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "instana_client" -version = "1.0.7" +version = "1.0.8" description = "Instana REST API documentation" authors = [ {name = "© Instana",email = "support@instana.com"}, diff --git a/requirements.txt b/requirements.txt index 867a449..6cbb2b9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,4 +2,3 @@ urllib3 >= 2.1.0, < 3.0.0 python_dateutil >= 2.8.2 pydantic >= 2 typing-extensions >= 4.7.1 -lazy-imports >= 1, < 2 diff --git a/setup.py b/setup.py index e93fb6e..92ebcab 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.316.2780 + The version of the OpenAPI document: 1.319.1109 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -22,14 +22,13 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "instana-client" -VERSION = "1.0.7" +VERSION = "1.0.8" PYTHON_REQUIRES = ">= 3.9" REQUIRES = [ "urllib3 >= 2.1.0, < 3.0.0", "python-dateutil >= 2.8.2", "pydantic >= 2", "typing-extensions >= 4.7.1", - "lazy-imports >= 1, < 2", ] setup( diff --git a/test/test_agent_mode_update.py b/test/test_agent_mode_update.py new file mode 100644 index 0000000..53dfeb1 --- /dev/null +++ b/test/test_agent_mode_update.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.models.agent_mode_update import AgentModeUpdate + +class TestAgentModeUpdate(unittest.TestCase): + """AgentModeUpdate unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AgentModeUpdate: + """Test AgentModeUpdate + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AgentModeUpdate` + """ + model = AgentModeUpdate() + if include_optional: + return AgentModeUpdate( + agent_mode = 'INFRA0', + mode_as_integer = 56 + ) + else: + return AgentModeUpdate( + agent_mode = 'INFRA0', + ) + """ + + def testAgentModeUpdate(self): + """Test AgentModeUpdate""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_bulk_alert_config_request.py b/test/test_bulk_alert_config_request.py new file mode 100644 index 0000000..c7e1acd --- /dev/null +++ b/test/test_bulk_alert_config_request.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.models.bulk_alert_config_request import BulkAlertConfigRequest + +class TestBulkAlertConfigRequest(unittest.TestCase): + """BulkAlertConfigRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> BulkAlertConfigRequest: + """Test BulkAlertConfigRequest + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `BulkAlertConfigRequest` + """ + model = BulkAlertConfigRequest() + if include_optional: + return BulkAlertConfigRequest( + configs = { + 'key' : [ + '' + ] + } + ) + else: + return BulkAlertConfigRequest( + configs = { + 'key' : [ + '' + ] + }, + ) + """ + + def testBulkAlertConfigRequest(self): + """Test BulkAlertConfigRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_icmp_configuration.py b/test/test_icmp_configuration.py new file mode 100644 index 0000000..adc1fc3 --- /dev/null +++ b/test/test_icmp_configuration.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.models.icmp_configuration import ICMPConfiguration + +class TestICMPConfiguration(unittest.TestCase): + """ICMPConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ICMPConfiguration: + """Test ICMPConfiguration + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ICMPConfiguration` + """ + model = ICMPConfiguration() + if include_optional: + return ICMPConfiguration( + packet_count = 56, + packet_interval = '', + packet_size = 56, + packet_timeout = '', + target_host = '', + use_dns = True, + use_ipv6 = True, + validation_rules = [ + instana_client.models.icmp_validation.ICMPValidation( + key = '', + operator = 'CONTAINS', + value = 56, ) + ] + ) + else: + return ICMPConfiguration( + target_host = '', + ) + """ + + def testICMPConfiguration(self): + """Test ICMPConfiguration""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_icmp_configuration_update.py b/test/test_icmp_configuration_update.py new file mode 100644 index 0000000..b999389 --- /dev/null +++ b/test/test_icmp_configuration_update.py @@ -0,0 +1,71 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.models.icmp_configuration_update import ICMPConfigurationUpdate + +class TestICMPConfigurationUpdate(unittest.TestCase): + """ICMPConfigurationUpdate unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ICMPConfigurationUpdate: + """Test ICMPConfigurationUpdate + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ICMPConfigurationUpdate` + """ + model = ICMPConfigurationUpdate() + if include_optional: + return ICMPConfigurationUpdate( + packet_count = 56, + packet_interval = '', + packet_size = 56, + packet_timeout = '', + target_host = '', + use_dns = True, + use_ipv6 = True, + validation_rules = instana_client.models.synthetic_resource_update_list_icmp_validation_list_icmp_validation.SyntheticResourceUpdateListICMPValidationListICMPValidation( + add = [ + instana_client.models.icmp_validation.ICMPValidation( + key = '', + operator = 'CONTAINS', + value = 56, ) + ], + remove = [ + instana_client.models.icmp_validation.ICMPValidation( + key = '', + operator = 'CONTAINS', + value = 56, ) + ], ) + ) + else: + return ICMPConfigurationUpdate( + ) + """ + + def testICMPConfigurationUpdate(self): + """Test ICMPConfigurationUpdate""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_icmp_validation.py b/test/test_icmp_validation.py new file mode 100644 index 0000000..f2e378d --- /dev/null +++ b/test/test_icmp_validation.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.models.icmp_validation import ICMPValidation + +class TestICMPValidation(unittest.TestCase): + """ICMPValidation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ICMPValidation: + """Test ICMPValidation + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ICMPValidation` + """ + model = ICMPValidation() + if include_optional: + return ICMPValidation( + key = '', + operator = 'CONTAINS', + value = 56 + ) + else: + return ICMPValidation( + key = '', + operator = 'CONTAINS', + value = 56, + ) + """ + + def testICMPValidation(self): + """Test ICMPValidation""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ip_filtering.py b/test/test_ip_filtering.py new file mode 100644 index 0000000..1bee067 --- /dev/null +++ b/test/test_ip_filtering.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.models.ip_filtering import IPFiltering + +class TestIPFiltering(unittest.TestCase): + """IPFiltering unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> IPFiltering: + """Test IPFiltering + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `IPFiltering` + """ + model = IPFiltering() + if include_optional: + return IPFiltering( + active = True, + deny_all = True, + enabled = True, + last_changed_at = 56, + last_verified_at = 56, + rules = [ + instana_client.models.ip_filtering_rule_dto.IPFilteringRuleDto( + block = True, + target = '', ) + ], + support_access_enabled = True + ) + else: + return IPFiltering( + rules = [ + instana_client.models.ip_filtering_rule_dto.IPFilteringRuleDto( + block = True, + target = '', ) + ], + ) + """ + + def testIPFiltering(self): + """Test IPFiltering""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ip_filtering_api.py b/test/test_ip_filtering_api.py new file mode 100644 index 0000000..ea105f7 --- /dev/null +++ b/test/test_ip_filtering_api.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.api.ip_filtering_api import IPFilteringApi + + +class TestIPFilteringApi(unittest.TestCase): + """IPFilteringApi unit test stubs""" + + def setUp(self) -> None: + self.api = IPFilteringApi() + + def tearDown(self) -> None: + pass + + def test_delete_ip_filtering(self) -> None: + """Test case for delete_ip_filtering + + Delete current ip-filtering + """ + pass + + def test_disable_ip_filtering(self) -> None: + """Test case for disable_ip_filtering + + Disable the current ip-filtering + """ + pass + + def test_get_ip_filtering(self) -> None: + """Test case for get_ip_filtering + + Get current ip-filtering + """ + pass + + def test_upsert_ip_filtering(self) -> None: + """Test case for upsert_ip_filtering + + Upsert ip-filtering + """ + pass + + def test_verify_ip_filtering(self) -> None: + """Test case for verify_ip_filtering + + Verify current ip-filtering + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ip_filtering_rule_dto.py b/test/test_ip_filtering_rule_dto.py new file mode 100644 index 0000000..b557e8f --- /dev/null +++ b/test/test_ip_filtering_rule_dto.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.models.ip_filtering_rule_dto import IPFilteringRuleDto + +class TestIPFilteringRuleDto(unittest.TestCase): + """IPFilteringRuleDto unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> IPFilteringRuleDto: + """Test IPFilteringRuleDto + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `IPFilteringRuleDto` + """ + model = IPFilteringRuleDto() + if include_optional: + return IPFilteringRuleDto( + block = True, + target = '' + ) + else: + return IPFilteringRuleDto( + block = True, + target = '', + ) + """ + + def testIPFilteringRuleDto(self): + """Test IPFilteringRuleDto""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ip_filtering_upsert.py b/test/test_ip_filtering_upsert.py new file mode 100644 index 0000000..777dc09 --- /dev/null +++ b/test/test_ip_filtering_upsert.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.models.ip_filtering_upsert import IPFilteringUpsert + +class TestIPFilteringUpsert(unittest.TestCase): + """IPFilteringUpsert unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> IPFilteringUpsert: + """Test IPFilteringUpsert + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `IPFilteringUpsert` + """ + model = IPFilteringUpsert() + if include_optional: + return IPFilteringUpsert( + deny_all = True, + enabled = True, + rules = [ + instana_client.models.ip_filtering_rule_dto.IPFilteringRuleDto( + block = True, + target = '', ) + ], + support_access_enabled = True + ) + else: + return IPFilteringUpsert( + deny_all = True, + enabled = True, + rules = [ + instana_client.models.ip_filtering_rule_dto.IPFilteringRuleDto( + block = True, + target = '', ) + ], + support_access_enabled = True, + ) + """ + + def testIPFilteringUpsert(self): + """Test IPFilteringUpsert""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_metric_field.py b/test/test_metric_field.py new file mode 100644 index 0000000..ec9bad3 --- /dev/null +++ b/test/test_metric_field.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.models.metric_field import MetricField + +class TestMetricField(unittest.TestCase): + """MetricField unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> MetricField: + """Test MetricField + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `MetricField` + """ + model = MetricField() + if include_optional: + return MetricField( + aggregation = 'SUM', + entity_type = '', + metric_id = '', + time_window = None, + value = instana_client.models.metric_field_value.MetricFieldValue( + aggregation = 'SUM', + entity_type = '', + metric_id = '', + time_window = instana_client.models.time_window.timeWindow(), ) + ) + else: + return MetricField( + ) + """ + + def testMetricField(self): + """Test MetricField""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_metric_field_value.py b/test/test_metric_field_value.py new file mode 100644 index 0000000..be01958 --- /dev/null +++ b/test/test_metric_field_value.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.models.metric_field_value import MetricFieldValue + +class TestMetricFieldValue(unittest.TestCase): + """MetricFieldValue unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> MetricFieldValue: + """Test MetricFieldValue + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `MetricFieldValue` + """ + model = MetricFieldValue() + if include_optional: + return MetricFieldValue( + aggregation = 'SUM', + entity_type = '', + metric_id = '', + time_window = instana_client.models.time_window.timeWindow() + ) + else: + return MetricFieldValue( + aggregation = 'SUM', + metric_id = '', + ) + """ + + def testMetricFieldValue(self): + """Test MetricFieldValue""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_synthetic_resource_update_list_icmp_validation_list_icmp_validation.py b/test/test_synthetic_resource_update_list_icmp_validation_list_icmp_validation.py new file mode 100644 index 0000000..02f514d --- /dev/null +++ b/test/test_synthetic_resource_update_list_icmp_validation_list_icmp_validation.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + Instana REST API documentation + + Documentation for INSTANA REST API + + The version of the OpenAPI document: 1.319.1109 + Contact: support@instana.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from instana_client.models.synthetic_resource_update_list_icmp_validation_list_icmp_validation import SyntheticResourceUpdateListICMPValidationListICMPValidation + +class TestSyntheticResourceUpdateListICMPValidationListICMPValidation(unittest.TestCase): + """SyntheticResourceUpdateListICMPValidationListICMPValidation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> SyntheticResourceUpdateListICMPValidationListICMPValidation: + """Test SyntheticResourceUpdateListICMPValidationListICMPValidation + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `SyntheticResourceUpdateListICMPValidationListICMPValidation` + """ + model = SyntheticResourceUpdateListICMPValidationListICMPValidation() + if include_optional: + return SyntheticResourceUpdateListICMPValidationListICMPValidation( + add = [ + instana_client.models.icmp_validation.ICMPValidation( + key = '', + operator = 'CONTAINS', + value = 56, ) + ], + remove = [ + instana_client.models.icmp_validation.ICMPValidation( + key = '', + operator = 'CONTAINS', + value = 56, ) + ] + ) + else: + return SyntheticResourceUpdateListICMPValidationListICMPValidation( + ) + """ + + def testSyntheticResourceUpdateListICMPValidationListICMPValidation(self): + """Test SyntheticResourceUpdateListICMPValidationListICMPValidation""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main()