diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index fef58370..9a605bbd 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -1290,5 +1290,4 @@ setup.cfg setup.py test-requirements.txt test/__init__.py -test/test_custom_metric_application_alert_rule.py tox.ini diff --git a/README.md b/README.md index 9a83ee60..91b23c43 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,7 @@ Documentation for INSTANA REST API This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: 1.324.1358 -- Package version: 1.1.0 -- Generator version: 7.13.0 -- Build package: org.openapitools.codegen.languages.PythonClientCodegen -For more information, please visit [http://instana.com](http://instana.com) +- API version: 1.325.1193 ## Requirements. @@ -437,6 +433,7 @@ Class | Method | HTTP request | Description *MobileAppConfigurationApi* | [**get_mobile_app_geo_location_configuration**](docs/MobileAppConfigurationApi.md#get_mobile_app_geo_location_configuration) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/geo-location | Get geo location configuration for mobile app *MobileAppConfigurationApi* | [**get_mobile_app_geo_mapping_rules**](docs/MobileAppConfigurationApi.md#get_mobile_app_geo_mapping_rules) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/geo-mapping-rules | Get custom geo mapping rules for mobile app *MobileAppConfigurationApi* | [**get_mobile_app_ip_masking_configuration**](docs/MobileAppConfigurationApi.md#get_mobile_app_ip_masking_configuration) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/ip-masking | Get IP masking configuration for mobile app +*MobileAppConfigurationApi* | [**get_mobile_app_session_replay**](docs/MobileAppConfigurationApi.md#get_mobile_app_session_replay) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/session-replay-config | Get session replay config for mobile app *MobileAppConfigurationApi* | [**get_mobile_app_source_map_file**](docs/MobileAppConfigurationApi.md#get_mobile_app_source_map_file) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload/{sourceMapConfigId} | Get sourcemap configuration for mobile app *MobileAppConfigurationApi* | [**get_mobile_app_source_map_files**](docs/MobileAppConfigurationApi.md#get_mobile_app_source_map_files) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload | Get all sourcemap configurations for mobile app *MobileAppConfigurationApi* | [**get_single_mobile_app_config**](docs/MobileAppConfigurationApi.md#get_single_mobile_app_config) | **GET** /api/mobile-app-monitoring/config/{mobileAppId} | Get mobile app configuration by ID @@ -446,6 +443,7 @@ Class | Method | HTTP request | Description *MobileAppConfigurationApi* | [**set_mobile_app_geo_mapping_rules**](docs/MobileAppConfigurationApi.md#set_mobile_app_geo_mapping_rules) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/geo-mapping-rules | Set custom geo mapping rules for mobile app *MobileAppConfigurationApi* | [**update_mobile_app_geo_location_configuration**](docs/MobileAppConfigurationApi.md#update_mobile_app_geo_location_configuration) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/geo-location | Update geo location configuration for mobile app *MobileAppConfigurationApi* | [**update_mobile_app_ip_masking_configuration**](docs/MobileAppConfigurationApi.md#update_mobile_app_ip_masking_configuration) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/ip-masking | Update IP masking configuration for mobile app +*MobileAppConfigurationApi* | [**update_mobile_app_session_replay**](docs/MobileAppConfigurationApi.md#update_mobile_app_session_replay) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/session-replay-config | Configure session replay for mobile app *MobileAppConfigurationApi* | [**update_mobile_app_teams**](docs/MobileAppConfigurationApi.md#update_mobile_app_teams) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/teams | Update teams assigned to the mobile app *MobileAppConfigurationApi* | [**upload_mobile_app_source_map_file**](docs/MobileAppConfigurationApi.md#upload_mobile_app_source_map_file) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload/{sourceMapConfigId}/form | Upload sourcemap file for mobile app *MobileAppMetricsApi* | [**get_mobile_app_beacon_metrics**](docs/MobileAppMetricsApi.md#get_mobile_app_beacon_metrics) | **POST** /api/mobile-app-monitoring/metrics | Get mobile app beacon metrics diff --git a/docs/ApiToken.md b/docs/ApiToken.md index 02536087..f509878b 100644 --- a/docs/ApiToken.md +++ b/docs/ApiToken.md @@ -21,6 +21,7 @@ Name | Type | Description | Notes **can_configure_bizops** | **bool** | | [optional] **can_configure_custom_entities** | **bool** | | [optional] **can_configure_database_management** | **bool** | | [optional] +**can_configure_entity_payload_transformation_rules** | **bool** | | [optional] **can_configure_eum_applications** | **bool** | | [optional] **can_configure_events_and_alerts** | **bool** | | [optional] **can_configure_gen_ai_evaluations** | **bool** | | [optional] @@ -69,6 +70,7 @@ Name | Type | Description | Notes **can_install_new_agents** | **bool** | | [optional] **can_invoke_alert_channel** | **bool** | | [optional] **can_manually_close_issue** | **bool** | | [optional] +**can_playback_session_replay** | **bool** | | [optional] **can_run_automation_actions** | **bool** | | [optional] **can_use_synthetic_credentials** | **bool** | | [optional] **can_view_account_and_billing_information** | **bool** | | [optional] diff --git a/docs/Application.md b/docs/Application.md index cbdb7859..fd893745 100644 --- a/docs/Application.md +++ b/docs/Application.md @@ -7,7 +7,7 @@ Returns a list of Application Perspectives. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **boundary_scope** | **str** | Here, `ALL` Application Boundary Scope is considered. | -**business_criticality** | **str** | Business criticality level of the application | [optional] +**business_criticality** | **int** | Represent how critical an application is to their business. | [optional] **entity_type** | **str** | Since, this is an Application Perspective, it will be of type `APPLICATION`. | [optional] **id** | **str** | Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`. | **label** | **str** | Name of the Application Perspective. Eg: `app1`. | diff --git a/docs/ApplicationConfig.md b/docs/ApplicationConfig.md index 65631200..42e27e88 100644 --- a/docs/ApplicationConfig.md +++ b/docs/ApplicationConfig.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **access_rules** | [**List[AccessRule]**](AccessRule.md) | Defines permissions and access relationships. | **boundary_scope** | **str** | **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`. | -**business_criticality** | **str** | Business criticality level of the application | +**business_criticality** | **int** | Business criticality of an application (0-5) | [optional] **created_at** | **int** | | [optional] **created_by** | **str** | | [optional] **id** | **str** | Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`. | diff --git a/docs/EventSettingsApi.md b/docs/EventSettingsApi.md index 6a74d8e7..d0236e4f 100644 --- a/docs/EventSettingsApi.md +++ b/docs/EventSettingsApi.md @@ -825,7 +825,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) - mobile_app_alert_config = {"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":[]} # MobileAppAlertConfig | + mobile_app_alert_config = {"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,"lastUpdated":0},"alertChannelIds":[],"granularity":600000,"timeThreshold":{"type":"violationsInSequence","timeWindow":600000},"customPayloadFields":[]} # MobileAppAlertConfig | try: # Create Mobile Smart Alert Config @@ -908,7 +908,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) - website_alert_config = {"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}}]} # WebsiteAlertConfig | + website_alert_config = {"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,"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}}]} # WebsiteAlertConfig | try: # Create Website Smart Alert Config @@ -3583,7 +3583,6 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | OK | - | **401** | Unauthorized access - requires user authentication. | - | -**403** | Insufficient permissions or limited in access. | - | [[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) @@ -3660,7 +3659,6 @@ This endpoint does not need any parameter. |-------------|-------------|------------------| **200** | OK | - | **401** | Unauthorized access - requires user authentication. | - | -**403** | Insufficient permissions or limited in access. | - | [[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) @@ -4845,7 +4843,7 @@ with instana_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = instana_client.EventSettingsApi(api_client) id = 'qOW5jlR5TQafXKWDIceRkA' # str | ID of a specific Mobile Smart Alert Configuration to update. - mobile_app_alert_config = {"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":[]} # MobileAppAlertConfig | + mobile_app_alert_config = {"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,"lastUpdated":0},"alertChannelIds":[],"granularity":600000,"timeThreshold":{"type":"violationsInSequence","timeWindow":600000},"customPayloadFields":[]} # MobileAppAlertConfig | try: # Update Mobile Smart Alert Config @@ -4981,7 +4979,7 @@ void (empty response body) Update shortcode prefix. -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. +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. If the provided prefix is longer than 6 characters, the request returns HTTP 400 with the message 'Prefix length exceeds maximum length'. ### Example @@ -5014,7 +5012,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":"","enabled":false} # PrefixObject | The new prefix configuration including the enabled state + prefix_object = {"prefix":"","enabled":false,"includeInTitle":false} # PrefixObject | The new prefix configuration including the enabled state try: # Update shortcode prefix. @@ -5052,6 +5050,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | The prefix and enabled state were successfully updated. | - | +**400** | The provided prefix is longer than 6 characters. | - | **401** | Unauthorized access - requires user authentication. | - | **403** | Insufficient permissions or limited in access. | - | @@ -5097,7 +5096,7 @@ with instana_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = instana_client.EventSettingsApi(api_client) id = 'G-h5p0znTHan2m2U3c-Z1Q' # str | ID of a specific Website Smart Alert Configuration to update. - website_alert_config = {"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}}]} # WebsiteAlertConfig | + website_alert_config = {"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,"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}}]} # WebsiteAlertConfig | try: # Update Website Smart Alert Config diff --git a/docs/GlobalApplicationAlertConfigurationApi.md b/docs/GlobalApplicationAlertConfigurationApi.md index 1c99802d..642f01d4 100644 --- a/docs/GlobalApplicationAlertConfigurationApi.md +++ b/docs/GlobalApplicationAlertConfigurationApi.md @@ -298,7 +298,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.GlobalApplicationAlertConfigurationApi(api_client) - global_applications_alert_config = {"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":[]} # GlobalApplicationsAlertConfig | + global_applications_alert_config = {"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,"lastUpdated":0},"alertChannelIds":[],"granularity":600000,"timeThreshold":{"type":"violationsInSequence","timeWindow":600000},"evaluationType":"PER_AP","customPayloadFields":[]} # GlobalApplicationsAlertConfig | try: # Create Global Smart Alert Config @@ -955,7 +955,7 @@ with instana_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = instana_client.GlobalApplicationAlertConfigurationApi(api_client) id = 'vlFnxhVTS3KVb-wsN26PeQ' # str | ID of a specific Global Smart Alert Configuration to update. - global_applications_alert_config = {"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":[]} # GlobalApplicationsAlertConfig | + global_applications_alert_config = {"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,"lastUpdated":0},"alertChannelIds":[],"granularity":600000,"timeThreshold":{"type":"violationsInSequence","timeWindow":600000},"evaluationType":"PER_AP","customPayloadFields":[]} # GlobalApplicationsAlertConfig | try: # Update Global Smart Alert Config diff --git a/docs/MobileAppConfigurationApi.md b/docs/MobileAppConfigurationApi.md index 98870057..a0cabb84 100644 --- a/docs/MobileAppConfigurationApi.md +++ b/docs/MobileAppConfigurationApi.md @@ -12,6 +12,7 @@ Method | HTTP request | Description [**get_mobile_app_geo_location_configuration**](MobileAppConfigurationApi.md#get_mobile_app_geo_location_configuration) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/geo-location | Get geo location configuration for mobile app [**get_mobile_app_geo_mapping_rules**](MobileAppConfigurationApi.md#get_mobile_app_geo_mapping_rules) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/geo-mapping-rules | Get custom geo mapping rules for mobile app [**get_mobile_app_ip_masking_configuration**](MobileAppConfigurationApi.md#get_mobile_app_ip_masking_configuration) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/ip-masking | Get IP masking configuration for mobile app +[**get_mobile_app_session_replay**](MobileAppConfigurationApi.md#get_mobile_app_session_replay) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/session-replay-config | Get session replay config for mobile app [**get_mobile_app_source_map_file**](MobileAppConfigurationApi.md#get_mobile_app_source_map_file) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload/{sourceMapConfigId} | Get sourcemap configuration for mobile app [**get_mobile_app_source_map_files**](MobileAppConfigurationApi.md#get_mobile_app_source_map_files) | **GET** /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload | Get all sourcemap configurations for mobile app [**get_single_mobile_app_config**](MobileAppConfigurationApi.md#get_single_mobile_app_config) | **GET** /api/mobile-app-monitoring/config/{mobileAppId} | Get mobile app configuration by ID @@ -21,6 +22,7 @@ Method | HTTP request | Description [**set_mobile_app_geo_mapping_rules**](MobileAppConfigurationApi.md#set_mobile_app_geo_mapping_rules) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/geo-mapping-rules | Set custom geo mapping rules for mobile app [**update_mobile_app_geo_location_configuration**](MobileAppConfigurationApi.md#update_mobile_app_geo_location_configuration) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/geo-location | Update geo location configuration for mobile app [**update_mobile_app_ip_masking_configuration**](MobileAppConfigurationApi.md#update_mobile_app_ip_masking_configuration) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/ip-masking | Update IP masking configuration for mobile app +[**update_mobile_app_session_replay**](MobileAppConfigurationApi.md#update_mobile_app_session_replay) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/session-replay-config | Configure session replay for mobile app [**update_mobile_app_teams**](MobileAppConfigurationApi.md#update_mobile_app_teams) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/teams | Update teams assigned to the mobile app [**upload_mobile_app_source_map_file**](MobileAppConfigurationApi.md#upload_mobile_app_source_map_file) | **PUT** /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload/{sourceMapConfigId}/form | Upload sourcemap file for mobile app @@ -678,6 +680,85 @@ 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_mobile_app_session_replay** +> get_mobile_app_session_replay(mobile_app_id) + +Get session replay config for mobile app + +API request to get the session replay configuration for a mobile app. + +### 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.MobileAppConfigurationApi(api_client) + mobile_app_id = 'K3bP-bmCRkyimNai9vvq8o' # str | Mobile App ID + + try: + # Get session replay config for mobile app + api_instance.get_mobile_app_session_replay(mobile_app_id) + except Exception as e: + print("Exception when calling MobileAppConfigurationApi->get_mobile_app_session_replay: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mobile_app_id** | **str**| Mobile App ID | + +### 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 | +|-------------|-------------|------------------| +**200** | Session replay configuration | - | +**401** | Unauthorized access - requires user authentication. | - | +**403** | Insufficient permissions or limited in access. | - | +**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_mobile_app_source_map_file** > SourceMapUploadConfig get_mobile_app_source_map_file(mobile_app_id, source_map_config_id) @@ -925,7 +1006,7 @@ 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) # **post_mobile_app_config** -> MobileApp post_mobile_app_config(name=name, api_tag=api_tag) +> MobileApp post_mobile_app_config(name=name, business_criticality=business_criticality, api_tag=api_tag) Configure new mobile app @@ -964,11 +1045,12 @@ with instana_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = instana_client.MobileAppConfigurationApi(api_client) name = 'name_example' # str | Name of the mobile app (optional) + business_criticality = 56 # int | (optional) api_tag = [{"id":"test","displayName":"test"}] # List[ApiTag] | (optional) try: # Configure new mobile app - api_response = api_instance.post_mobile_app_config(name=name, api_tag=api_tag) + api_response = api_instance.post_mobile_app_config(name=name, business_criticality=business_criticality, api_tag=api_tag) print("The response of MobileAppConfigurationApi->post_mobile_app_config:\n") pprint(api_response) except Exception as e: @@ -983,6 +1065,7 @@ with instana_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| Name of the mobile app | [optional] + **business_criticality** | **int**| | [optional] **api_tag** | [**List[ApiTag]**](ApiTag.md)| | [optional] ### Return type @@ -1435,6 +1518,86 @@ 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) +# **update_mobile_app_session_replay** +> update_mobile_app_session_replay(mobile_app_id) + +Configure session replay for mobile app + +API request to configure session replay for a mobile app. + +### 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.MobileAppConfigurationApi(api_client) + mobile_app_id = 'K3bP-bmCRkyimNai9vvq8o' # str | Mobile App ID + + try: + # Configure session replay for mobile app + api_instance.update_mobile_app_session_replay(mobile_app_id) + except Exception as e: + print("Exception when calling MobileAppConfigurationApi->update_mobile_app_session_replay: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mobile_app_id** | **str**| Mobile App ID | + +### 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 | +|-------------|-------------|------------------| +**200** | Session replay configuration successfully updated | - | +**400** | Invalid or missing request body | - | +**401** | Unauthorized access - requires user authentication. | - | +**403** | Insufficient permissions or limited in access. | - | +**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) + # **update_mobile_app_teams** > List[ApiTag] update_mobile_app_teams(mobile_app_id, api_tag=api_tag) diff --git a/docs/NewApplicationConfig.md b/docs/NewApplicationConfig.md index b60379c0..06e05c9b 100644 --- a/docs/NewApplicationConfig.md +++ b/docs/NewApplicationConfig.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **access_rules** | [**List[AccessRule]**](AccessRule.md) | Defines permissions and access relationships. | **boundary_scope** | **str** | **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`. | -**business_criticality** | **str** | Business criticality level of the application | +**business_criticality** | **int** | Business criticality of an application (0-5) | [optional] **label** | **str** | Name of the Application Perspective. Eg: `app1`. | **match_specification** | [**MatchExpressionDTO**](MatchExpressionDTO.md) | | [optional] **scope** | **str** | **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. | diff --git a/docs/PrefixObject.md b/docs/PrefixObject.md index e17f96a1..e90bc875 100644 --- a/docs/PrefixObject.md +++ b/docs/PrefixObject.md @@ -7,7 +7,8 @@ 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] +**include_in_title** | **bool** | Whether the short code should be included in the incident title | [optional] +**prefix** | **str** | The prefix to use for event short codes (e.g., 'INSTA-', 'PROD-') | [optional] ## Example diff --git a/docs/WebsiteConfigurationApi.md b/docs/WebsiteConfigurationApi.md index bcdba91e..b23e58ec 100644 --- a/docs/WebsiteConfigurationApi.md +++ b/docs/WebsiteConfigurationApi.md @@ -107,7 +107,7 @@ 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) # **create_website** -> Website create_website(name=name, create_website_request_inner=create_website_request_inner) +> Website create_website(name=name, business_criticality=business_criticality, create_website_request_inner=create_website_request_inner) Configure new website @@ -146,11 +146,12 @@ with instana_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = instana_client.WebsiteConfigurationApi(api_client) name = 'name_example' # str | (optional) + business_criticality = 56 # int | (optional) create_website_request_inner = [{"id":"test","displayName":"test"}] # List[CreateWebsiteRequestInner] | (optional) try: # Configure new website - api_response = api_instance.create_website(name=name, create_website_request_inner=create_website_request_inner) + api_response = api_instance.create_website(name=name, business_criticality=business_criticality, create_website_request_inner=create_website_request_inner) print("The response of WebsiteConfigurationApi->create_website:\n") pprint(api_response) except Exception as e: @@ -165,6 +166,7 @@ with instana_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| | [optional] + **business_criticality** | **int**| | [optional] **create_website_request_inner** | [**List[CreateWebsiteRequestInner]**](CreateWebsiteRequestInner.md)| | [optional] ### Return type diff --git a/instana_client/__init__.py b/instana_client/__init__.py index 74f15afd..dbdec295 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,7 +15,7 @@ """ # noqa: E501 -__version__ = "1.1.0" +__version__ = "1.1.2" # import apis into sdk package from instana_client.api.ai_management_api import AIManagementApi diff --git a/instana_client/api/action_catalog_api.py b/instana_client/api/action_catalog_api.py index d236bef4..95fb5087 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 62435e4a..af33d608 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ede8a583..3c932e80 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b6e8701f..5f668949 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8e9e85e0..58337988 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 31bc00b7..50f0aaf2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 db5e6316..7a4f25e0 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 69547bb1..e623fb42 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a93b7fe4..be67caa5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 902140dc..b136604e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 50a9ebfa..440fb48f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4e0c5321..acf4b398 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1d01eeee..3048fa19 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9525e548..b14f02ff 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/authentication_api.py b/instana_client/api/authentication_api.py index c4b3ef07..a1dd9a31 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 bcf7b4ae..0d0c0269 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8329a953..04920362 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3c974dcd..15deabb2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 caa92151..e164de48 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2e4b6663..2d15391a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 fa8e1794..db4148a4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -11884,7 +11884,6 @@ def get_custom_payload_configurations( _response_types_map: Dict[str, Optional[str]] = { '200': "CustomPayloadWithVersion", '401': None, - '403': None, } response_data = self.api_client.call_api( *_param, @@ -11957,7 +11956,6 @@ def get_custom_payload_configurations_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "CustomPayloadWithVersion", '401': None, - '403': None, } response_data = self.api_client.call_api( *_param, @@ -12030,7 +12028,6 @@ def get_custom_payload_configurations_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "CustomPayloadWithVersion", '401': None, - '403': None, } response_data = self.api_client.call_api( *_param, @@ -12162,7 +12159,6 @@ def get_custom_payload_tag_catalog( _response_types_map: Dict[str, Optional[str]] = { '200': "TagCatalog", '401': None, - '403': None, } response_data = self.api_client.call_api( *_param, @@ -12227,7 +12223,6 @@ def get_custom_payload_tag_catalog_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "TagCatalog", '401': None, - '403': None, } response_data = self.api_client.call_api( *_param, @@ -12292,7 +12287,6 @@ def get_custom_payload_tag_catalog_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "TagCatalog", '401': None, - '403': None, } response_data = self.api_client.call_api( *_param, @@ -16994,7 +16988,7 @@ def update_prefix( ) -> PrefixObject: """Update shortcode prefix. - 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. + 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. If the provided prefix is longer than 6 characters, the request returns HTTP 400 with the message 'Prefix length exceeds maximum length'. :param prefix_object: The new prefix configuration including the enabled state (required) :type prefix_object: PrefixObject @@ -17030,6 +17024,7 @@ def update_prefix( _response_types_map: Dict[str, Optional[str]] = { '200': "PrefixObject", + '400': None, '401': None, '403': None, } @@ -17063,7 +17058,7 @@ def update_prefix_with_http_info( ) -> ApiResponse[PrefixObject]: """Update shortcode prefix. - 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. + 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. If the provided prefix is longer than 6 characters, the request returns HTTP 400 with the message 'Prefix length exceeds maximum length'. :param prefix_object: The new prefix configuration including the enabled state (required) :type prefix_object: PrefixObject @@ -17099,6 +17094,7 @@ def update_prefix_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "PrefixObject", + '400': None, '401': None, '403': None, } @@ -17132,7 +17128,7 @@ def update_prefix_without_preload_content( ) -> RESTResponseType: """Update shortcode prefix. - 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. + 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. If the provided prefix is longer than 6 characters, the request returns HTTP 400 with the message 'Prefix length exceeds maximum length'. :param prefix_object: The new prefix configuration including the enabled state (required) :type prefix_object: PrefixObject @@ -17168,6 +17164,7 @@ def update_prefix_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "PrefixObject", + '400': None, '401': None, '403': None, } diff --git a/instana_client/api/events_api.py b/instana_client/api/events_api.py index 3207754f..526ee55c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/global_application_alert_configuration_api.py b/instana_client/api/global_application_alert_configuration_api.py index 5acf5a69..01151fc3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3aa31855..648b0803 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 83886080..08ad9ee4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a00003aa..48fbfff2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/infrastructure_alert_configuration_api.py b/instana_client/api/infrastructure_alert_configuration_api.py index 4e57d3b1..2613910b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 fe2f614a..b183a26e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a8cfb809..171a2e23 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a5eb4309..346f94a9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 751cf677..053bb311 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 aee7a1fe..18a0f48a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 index 23327f04..c30ebb53 100644 --- a/instana_client/api/ip_filtering_api.py +++ b/instana_client/api/ip_filtering_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/llm_evaluation_api.py b/instana_client/api/llm_evaluation_api.py index 8856f612..9d7ee6b9 100644 --- a/instana_client/api/llm_evaluation_api.py +++ b/instana_client/api/llm_evaluation_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/llm_price_configuration_api.py b/instana_client/api/llm_price_configuration_api.py index a568d232..b930976c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/log_alert_configuration_api.py b/instana_client/api/log_alert_configuration_api.py index f1778f44..d6267249 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4d81ad44..1b3a660e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e298e41e..f0dc892f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9141b652..80786f92 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 38adc4b4..c173bdf9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/mobile_app_configuration_api.py b/instana_client/api/mobile_app_configuration_api.py index 64d54175..6753a97b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -2267,6 +2267,269 @@ def _get_mobile_app_ip_masking_configuration_serialize( + @validate_call + def get_mobile_app_session_replay( + self, + mobile_app_id: Annotated[StrictStr, Field(description="Mobile App ID")], + _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: + """Get session replay config for mobile app + + API request to get the session replay configuration for a mobile app. + + :param mobile_app_id: Mobile App ID (required) + :type mobile_app_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_mobile_app_session_replay_serialize( + mobile_app_id=mobile_app_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + '401': None, + '403': 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_mobile_app_session_replay_with_http_info( + self, + mobile_app_id: Annotated[StrictStr, Field(description="Mobile App ID")], + _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]: + """Get session replay config for mobile app + + API request to get the session replay configuration for a mobile app. + + :param mobile_app_id: Mobile App ID (required) + :type mobile_app_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_mobile_app_session_replay_serialize( + mobile_app_id=mobile_app_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + '401': None, + '403': 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_mobile_app_session_replay_without_preload_content( + self, + mobile_app_id: Annotated[StrictStr, Field(description="Mobile App ID")], + _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 config for mobile app + + API request to get the session replay configuration for a mobile app. + + :param mobile_app_id: Mobile App ID (required) + :type mobile_app_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_mobile_app_session_replay_serialize( + mobile_app_id=mobile_app_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + '401': None, + '403': None, + '500': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _get_mobile_app_session_replay_serialize( + self, + mobile_app_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 + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/api/mobile-app-monitoring/config/{mobileAppId}/session-replay-config', + 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_mobile_app_source_map_file( self, @@ -3090,6 +3353,7 @@ def _get_single_mobile_app_config_serialize( def post_mobile_app_config( self, name: Annotated[Optional[StrictStr], Field(description="Name of the mobile app")] = None, + business_criticality: Optional[StrictInt] = None, api_tag: Optional[List[ApiTag]] = None, _request_timeout: Union[ None, @@ -3110,6 +3374,8 @@ def post_mobile_app_config( :param name: Name of the mobile app :type name: str + :param business_criticality: + :type business_criticality: int :param api_tag: :type api_tag: List[ApiTag] :param _request_timeout: timeout setting for this request. If one @@ -3136,6 +3402,7 @@ def post_mobile_app_config( _param = self._post_mobile_app_config_serialize( name=name, + business_criticality=business_criticality, api_tag=api_tag, _request_auth=_request_auth, _content_type=_content_type, @@ -3165,6 +3432,7 @@ def post_mobile_app_config( def post_mobile_app_config_with_http_info( self, name: Annotated[Optional[StrictStr], Field(description="Name of the mobile app")] = None, + business_criticality: Optional[StrictInt] = None, api_tag: Optional[List[ApiTag]] = None, _request_timeout: Union[ None, @@ -3185,6 +3453,8 @@ def post_mobile_app_config_with_http_info( :param name: Name of the mobile app :type name: str + :param business_criticality: + :type business_criticality: int :param api_tag: :type api_tag: List[ApiTag] :param _request_timeout: timeout setting for this request. If one @@ -3211,6 +3481,7 @@ def post_mobile_app_config_with_http_info( _param = self._post_mobile_app_config_serialize( name=name, + business_criticality=business_criticality, api_tag=api_tag, _request_auth=_request_auth, _content_type=_content_type, @@ -3240,6 +3511,7 @@ def post_mobile_app_config_with_http_info( def post_mobile_app_config_without_preload_content( self, name: Annotated[Optional[StrictStr], Field(description="Name of the mobile app")] = None, + business_criticality: Optional[StrictInt] = None, api_tag: Optional[List[ApiTag]] = None, _request_timeout: Union[ None, @@ -3260,6 +3532,8 @@ def post_mobile_app_config_without_preload_content( :param name: Name of the mobile app :type name: str + :param business_criticality: + :type business_criticality: int :param api_tag: :type api_tag: List[ApiTag] :param _request_timeout: timeout setting for this request. If one @@ -3286,6 +3560,7 @@ def post_mobile_app_config_without_preload_content( _param = self._post_mobile_app_config_serialize( name=name, + business_criticality=business_criticality, api_tag=api_tag, _request_auth=_request_auth, _content_type=_content_type, @@ -3310,6 +3585,7 @@ def post_mobile_app_config_without_preload_content( def _post_mobile_app_config_serialize( self, name, + business_criticality, api_tag, _request_auth, _content_type, @@ -3338,6 +3614,10 @@ def _post_mobile_app_config_serialize( _query_params.append(('name', name)) + if business_criticality is not None: + + _query_params.append(('businessCriticality', business_criticality)) + # process the header parameters # process the form parameters # process the body parameter @@ -4890,6 +5170,272 @@ def _update_mobile_app_ip_masking_configuration_serialize( + @validate_call + def update_mobile_app_session_replay( + self, + mobile_app_id: Annotated[StrictStr, Field(description="Mobile App ID")], + _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: + """Configure session replay for mobile app + + API request to configure session replay for a mobile app. + + :param mobile_app_id: Mobile App ID (required) + :type mobile_app_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._update_mobile_app_session_replay_serialize( + mobile_app_id=mobile_app_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + '400': None, + '401': None, + '403': 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 update_mobile_app_session_replay_with_http_info( + self, + mobile_app_id: Annotated[StrictStr, Field(description="Mobile App ID")], + _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]: + """Configure session replay for mobile app + + API request to configure session replay for a mobile app. + + :param mobile_app_id: Mobile App ID (required) + :type mobile_app_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._update_mobile_app_session_replay_serialize( + mobile_app_id=mobile_app_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + '400': None, + '401': None, + '403': 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 update_mobile_app_session_replay_without_preload_content( + self, + mobile_app_id: Annotated[StrictStr, Field(description="Mobile App ID")], + _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: + """Configure session replay for mobile app + + API request to configure session replay for a mobile app. + + :param mobile_app_id: Mobile App ID (required) + :type mobile_app_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._update_mobile_app_session_replay_serialize( + mobile_app_id=mobile_app_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + '400': None, + '401': None, + '403': None, + '500': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_mobile_app_session_replay_serialize( + self, + mobile_app_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 + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + + + # authentication setting + _auth_settings: List[str] = [ + 'ApiKeyAuth' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/api/mobile-app-monitoring/config/{mobileAppId}/session-replay-config', + 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_mobile_app_teams( self, diff --git a/instana_client/api/mobile_app_metrics_api.py b/instana_client/api/mobile_app_metrics_api.py index 3553e27a..db469430 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/mobile_app_session_replay_api.py b/instana_client/api/mobile_app_session_replay_api.py index 064bb9b8..be8c2c58 100644 --- a/instana_client/api/mobile_app_session_replay_api.py +++ b/instana_client/api/mobile_app_session_replay_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 94eddf42..519c45fe 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4c37cbaa..3ff1b730 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e3005e0a..80b5a5c2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 71f19264..1251b56b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 abbabe0a..9aac7b7c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 56cdc43b..11193f28 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f5d8895d..847236a5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9de7b474..bda0364c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/api/slo_catalog_for_mobile_app_api.py b/instana_client/api/slo_catalog_for_mobile_app_api.py index a35b6164..09ac354c 100644 --- a/instana_client/api/slo_catalog_for_mobile_app_api.py +++ b/instana_client/api/slo_catalog_for_mobile_app_api.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7db0ae09..0dc359fa 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b77b9d18..9316ea47 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 34dc8518..35d65d24 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7aa20222..fe90dc32 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 cd857e2b..75db4127 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 48d28305..b0d9740a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 cc343090..09c24d8c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e3f4d33f..4762f17e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 281cd894..7cf92f57 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 630ce302..6a5877c8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ec78d2c9..e2111942 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 25045b50..067cfacf 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 bf33e841..ac661754 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 286303f7..824b44d3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 78294348..5e3ea062 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated -from pydantic import Field, StrictBytes, StrictStr +from pydantic import Field, StrictBytes, StrictInt, StrictStr from typing import List, Optional, Tuple, Union from typing_extensions import Annotated from instana_client.models.api_tag import ApiTag @@ -332,6 +332,7 @@ def _clear_source_map_upload_configuration_serialize( def create_website( self, name: Optional[StrictStr] = None, + business_criticality: Optional[StrictInt] = None, create_website_request_inner: Optional[List[CreateWebsiteRequestInner]] = None, _request_timeout: Union[ None, @@ -352,6 +353,8 @@ def create_website( :param name: :type name: str + :param business_criticality: + :type business_criticality: int :param create_website_request_inner: :type create_website_request_inner: List[CreateWebsiteRequestInner] :param _request_timeout: timeout setting for this request. If one @@ -378,6 +381,7 @@ def create_website( _param = self._create_website_serialize( name=name, + business_criticality=business_criticality, create_website_request_inner=create_website_request_inner, _request_auth=_request_auth, _content_type=_content_type, @@ -407,6 +411,7 @@ def create_website( def create_website_with_http_info( self, name: Optional[StrictStr] = None, + business_criticality: Optional[StrictInt] = None, create_website_request_inner: Optional[List[CreateWebsiteRequestInner]] = None, _request_timeout: Union[ None, @@ -427,6 +432,8 @@ def create_website_with_http_info( :param name: :type name: str + :param business_criticality: + :type business_criticality: int :param create_website_request_inner: :type create_website_request_inner: List[CreateWebsiteRequestInner] :param _request_timeout: timeout setting for this request. If one @@ -453,6 +460,7 @@ def create_website_with_http_info( _param = self._create_website_serialize( name=name, + business_criticality=business_criticality, create_website_request_inner=create_website_request_inner, _request_auth=_request_auth, _content_type=_content_type, @@ -482,6 +490,7 @@ def create_website_with_http_info( def create_website_without_preload_content( self, name: Optional[StrictStr] = None, + business_criticality: Optional[StrictInt] = None, create_website_request_inner: Optional[List[CreateWebsiteRequestInner]] = None, _request_timeout: Union[ None, @@ -502,6 +511,8 @@ def create_website_without_preload_content( :param name: :type name: str + :param business_criticality: + :type business_criticality: int :param create_website_request_inner: :type create_website_request_inner: List[CreateWebsiteRequestInner] :param _request_timeout: timeout setting for this request. If one @@ -528,6 +539,7 @@ def create_website_without_preload_content( _param = self._create_website_serialize( name=name, + business_criticality=business_criticality, create_website_request_inner=create_website_request_inner, _request_auth=_request_auth, _content_type=_content_type, @@ -552,6 +564,7 @@ def create_website_without_preload_content( def _create_website_serialize( self, name, + business_criticality, create_website_request_inner, _request_auth, _content_type, @@ -580,6 +593,10 @@ def _create_website_serialize( _query_params.append(('name', name)) + if business_criticality is not None: + + _query_params.append(('businessCriticality', business_criticality)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/instana_client/api/website_metrics_api.py b/instana_client/api/website_metrics_api.py index 0368932c..1ae15871 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e5b1c24d..bcf6c8af 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -91,7 +91,7 @@ def __init__( self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/1.1.1/python' + self.user_agent = 'OpenAPI-Generator/1.1.2/python' self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/instana_client/configuration.py b/instana_client/configuration.py index f8634d08..e367c1c1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -531,8 +531,8 @@ def to_debug_report(self) -> str: return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.324.1358\n"\ - "SDK Package Version: 1.1.0".\ + "Version of the API: 1.325.1193\n"\ + "SDK Package Version: 1.1.2".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self) -> List[HostSetting]: diff --git a/instana_client/exceptions.py b/instana_client/exceptions.py index 27d2802b..b81bcc1e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e2d2ea6f..073d021f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/abstract_integration.py b/instana_client/models/abstract_integration.py index 75367da5..91f8083f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 38c67340..70cfaafe 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 33f3a369..7a35ed71 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d7db27dd..b8e0c6ae 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/action_beacon.py b/instana_client/models/action_beacon.py index 1a71b7d2..5d5ba901 100644 --- a/instana_client/models/action_beacon.py +++ b/instana_client/models/action_beacon.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 597afdf1..ecaf680c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ac1f69fe..0dd3ce7f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 79caf89b..a67ee5db 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b377c333..38ca07ab 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5bf951a1..f08d0eb0 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4f04db20..e7f7e17a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 cbe2726c..7643445a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 94483582..dfe2f13f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9211d207..3bcfa9e1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -29,7 +29,7 @@ class AdaptiveBaseline(Threshold): """ AdaptiveBaseline """ # noqa: E501 - deviation_factor: Optional[Union[Annotated[float, Field(le=16.0, strict=True, ge=0.5)], Annotated[int, Field(le=16, strict=True, ge=1)]]] = Field(default=None, alias="deviationFactor") + deviation_factor: Optional[Union[Annotated[float, Field(le=16, strict=True, ge=0.5)], Annotated[int, Field(le=16, strict=True, ge=1)]]] = Field(default=None, alias="deviationFactor") __properties: ClassVar[List[str]] = ["operator", "type", "deviationFactor"] model_config = ConfigDict( diff --git a/instana_client/models/adaptive_threshold_rule.py b/instana_client/models/adaptive_threshold_rule.py index 14f20ba1..21b7fbda 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -29,7 +29,7 @@ class AdaptiveThresholdRule(ThresholdConfigRule): """ AdaptiveThresholdRule """ # noqa: E501 - deviation_factor: Optional[Union[Annotated[float, Field(le=16.0, strict=True, ge=0.5)], Annotated[int, Field(le=16, strict=True, ge=1)]]] = Field(default=None, alias="deviationFactor") + deviation_factor: Optional[Union[Annotated[float, Field(le=16, strict=True, ge=0.5)], Annotated[int, Field(le=16, strict=True, ge=1)]]] = Field(default=None, alias="deviationFactor") __properties: ClassVar[List[str]] = ["type", "deviationFactor"] model_config = ConfigDict( diff --git a/instana_client/models/adjusted_timeframe.py b/instana_client/models/adjusted_timeframe.py index b797e5c6..bfef5044 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/advanced_custom_blueprint_indicator.py b/instana_client/models/advanced_custom_blueprint_indicator.py index b93254fb..a04d35e8 100644 --- a/instana_client/models/advanced_custom_blueprint_indicator.py +++ b/instana_client/models/advanced_custom_blueprint_indicator.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/advanced_filter.py b/instana_client/models/advanced_filter.py index 15c1661d..0024ba95 100644 --- a/instana_client/models/advanced_filter.py +++ b/instana_client/models/advanced_filter.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5c5e4054..c5b06f75 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 index ffc151b2..53ef0f38 100644 --- a/instana_client/models/agent_mode_update.py +++ b/instana_client/models/agent_mode_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/alerting_configuration.py b/instana_client/models/alerting_configuration.py index 50d09b8d..20db6e98 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a8e59fb0..347027d6 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 090ef167..1a665c85 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/apdex_alert_rule.py b/instana_client/models/apdex_alert_rule.py index f43ac795..b9e7af2f 100644 --- a/instana_client/models/apdex_alert_rule.py +++ b/instana_client/models/apdex_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/apdex_config_with_rbac_tag.py b/instana_client/models/apdex_config_with_rbac_tag.py index 1c31bb02..4329d5c3 100644 --- a/instana_client/models/apdex_config_with_rbac_tag.py +++ b/instana_client/models/apdex_config_with_rbac_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 83ab1f2b..722f004a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 204eda38..ff49ee99 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2b8809f7..307188cd 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 543930b0..fba4f5b9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b2ef49e7..2c37e812 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ac40f242..3256180c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 68fb9d84..ee5a01b3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 efea57aa..d607b2bf 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_log_item.py b/instana_client/models/api_log_item.py index a2bd3f58..ef3ff7d5 100644 --- a/instana_client/models/api_log_item.py +++ b/instana_client/models/api_log_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_log_tag.py b/instana_client/models/api_log_tag.py index 388f039a..a6c6da22 100644 --- a/instana_client/models/api_log_tag.py +++ b/instana_client/models/api_log_tag.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ee3a838c..96d22d89 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e9a7c700..64f59630 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5eadb9a5..8702bf01 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b5321975..3d70b3a1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3db04ba9..0c69fcde 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3c3c1cb2..5932b003 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e76b4bf1..a17360ec 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d8acc11f..8c30d8fd 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 949e582b..9b3773bc 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f35afd81..4e7bba9c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/api_token.py b/instana_client/models/api_token.py index 4c7c069e..2c51462e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -44,6 +44,7 @@ class ApiToken(BaseModel): can_configure_bizops: Optional[StrictBool] = Field(default=None, alias="canConfigureBizops") can_configure_custom_entities: Optional[StrictBool] = Field(default=None, alias="canConfigureCustomEntities") can_configure_database_management: Optional[StrictBool] = Field(default=None, alias="canConfigureDatabaseManagement") + can_configure_entity_payload_transformation_rules: Optional[StrictBool] = Field(default=None, alias="canConfigureEntityPayloadTransformationRules") can_configure_eum_applications: Optional[StrictBool] = Field(default=None, alias="canConfigureEumApplications") can_configure_events_and_alerts: Optional[StrictBool] = Field(default=None, alias="canConfigureEventsAndAlerts") can_configure_gen_ai_evaluations: Optional[StrictBool] = Field(default=None, alias="canConfigureGenAIEvaluations") @@ -92,6 +93,7 @@ class ApiToken(BaseModel): can_install_new_agents: Optional[StrictBool] = Field(default=None, alias="canInstallNewAgents") can_invoke_alert_channel: Optional[StrictBool] = Field(default=None, alias="canInvokeAlertChannel") can_manually_close_issue: Optional[StrictBool] = Field(default=None, alias="canManuallyCloseIssue") + can_playback_session_replay: Optional[StrictBool] = Field(default=None, alias="canPlaybackSessionReplay") can_run_automation_actions: Optional[StrictBool] = Field(default=None, alias="canRunAutomationActions") can_use_synthetic_credentials: Optional[StrictBool] = Field(default=None, alias="canUseSyntheticCredentials") can_view_account_and_billing_information: Optional[StrictBool] = Field(default=None, alias="canViewAccountAndBillingInformation") @@ -139,7 +141,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", "canCollectNetTraceLogs", "canConfigureAgentRunMode", "canConfigureAgents", "canConfigureAiAgents", "canConfigureApdex", "canConfigureApiTokens", "canConfigureApplicationBusinessCriticality", "canConfigureApplicationSmartAlerts", "canConfigureApplications", "canConfigureAuthenticationMethods", "canConfigureAutomationActions", "canConfigureAutomationPolicies", "canConfigureBizops", "canConfigureCustomEntities", "canConfigureDatabaseManagement", "canConfigureEumApplications", "canConfigureEventsAndAlerts", "canConfigureGenAIEvaluations", "canConfigureGenAISmartAlerts", "canConfigureGlobalAlertPayload", "canConfigureGlobalApplicationSmartAlerts", "canConfigureGlobalInfraSmartAlerts", "canConfigureGlobalLogSmartAlerts", "canConfigureGlobalSyntheticSmartAlerts", "canConfigureIPFiltering", "canConfigureIntegrations", "canConfigureLLM", "canConfigureLLMModelPrice", "canConfigureLogManagement", "canConfigureLogRetentionPeriod", "canConfigureLoggingPerspectives", "canConfigureMaintenanceWindows", "canConfigureMobileAppBusinessCriticality", "canConfigureMobileAppMonitoring", "canConfigureMobileAppSmartAlerts", "canConfigureNetworkIntegrations", "canConfigurePersonalApiTokens", "canConfigurePersonallyIdentifiableInformationMasking", "canConfigureReleases", "canConfigureServiceLevelCorrectionWindows", "canConfigureServiceLevelSmartAlerts", "canConfigureServiceLevels", "canConfigureServiceMapping", "canConfigureSessionSettings", "canConfigureSubtraces", "canConfigureSyntheticCredentials", "canConfigureSyntheticLocations", "canConfigureSyntheticTests", "canConfigureTeams", "canConfigureUsers", "canConfigureWebsiteBusinessCriticality", "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", "limitedLoggingPerspectivesScope", "limitedLogsScope", "limitedMobileAppsScope", "limitedNutanixScope", "limitedOpenstackScope", "limitedPcfScope", "limitedPhmcScope", "limitedPvcScope", "limitedSAPScope", "limitedServiceLevelScope", "limitedSyntheticsScope", "limitedVsphereScope", "limitedWebsitesScope", "limitedWindowsHypervisorScope", "limitedXenServerScope", "limitedZhmcScope", "name"] + __properties: ClassVar[List[str]] = ["accessGrantingToken", "canCollectNetTraceLogs", "canConfigureAgentRunMode", "canConfigureAgents", "canConfigureAiAgents", "canConfigureApdex", "canConfigureApiTokens", "canConfigureApplicationBusinessCriticality", "canConfigureApplicationSmartAlerts", "canConfigureApplications", "canConfigureAuthenticationMethods", "canConfigureAutomationActions", "canConfigureAutomationPolicies", "canConfigureBizops", "canConfigureCustomEntities", "canConfigureDatabaseManagement", "canConfigureEntityPayloadTransformationRules", "canConfigureEumApplications", "canConfigureEventsAndAlerts", "canConfigureGenAIEvaluations", "canConfigureGenAISmartAlerts", "canConfigureGlobalAlertPayload", "canConfigureGlobalApplicationSmartAlerts", "canConfigureGlobalInfraSmartAlerts", "canConfigureGlobalLogSmartAlerts", "canConfigureGlobalSyntheticSmartAlerts", "canConfigureIPFiltering", "canConfigureIntegrations", "canConfigureLLM", "canConfigureLLMModelPrice", "canConfigureLogManagement", "canConfigureLogRetentionPeriod", "canConfigureLoggingPerspectives", "canConfigureMaintenanceWindows", "canConfigureMobileAppBusinessCriticality", "canConfigureMobileAppMonitoring", "canConfigureMobileAppSmartAlerts", "canConfigureNetworkIntegrations", "canConfigurePersonalApiTokens", "canConfigurePersonallyIdentifiableInformationMasking", "canConfigureReleases", "canConfigureServiceLevelCorrectionWindows", "canConfigureServiceLevelSmartAlerts", "canConfigureServiceLevels", "canConfigureServiceMapping", "canConfigureSessionSettings", "canConfigureSubtraces", "canConfigureSyntheticCredentials", "canConfigureSyntheticLocations", "canConfigureSyntheticTests", "canConfigureTeams", "canConfigureUsers", "canConfigureWebsiteBusinessCriticality", "canConfigureWebsiteConversions", "canConfigureWebsiteSmartAlerts", "canCreateHeapDump", "canCreatePublicCustomDashboards", "canCreateThreadDump", "canDeleteAutomationActionHistory", "canDeleteLogs", "canDownloadAgentConfiguration", "canEditAllAccessibleCustomDashboards", "canInstallNewAgents", "canInvokeAlertChannel", "canManuallyCloseIssue", "canPlaybackSessionReplay", "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", "limitedLoggingPerspectivesScope", "limitedLogsScope", "limitedMobileAppsScope", "limitedNutanixScope", "limitedOpenstackScope", "limitedPcfScope", "limitedPhmcScope", "limitedPvcScope", "limitedSAPScope", "limitedServiceLevelScope", "limitedSyntheticsScope", "limitedVsphereScope", "limitedWebsitesScope", "limitedWindowsHypervisorScope", "limitedXenServerScope", "limitedZhmcScope", "name"] model_config = ConfigDict( populate_by_name=True, @@ -228,6 +230,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "canConfigureBizops": obj.get("canConfigureBizops"), "canConfigureCustomEntities": obj.get("canConfigureCustomEntities"), "canConfigureDatabaseManagement": obj.get("canConfigureDatabaseManagement"), + "canConfigureEntityPayloadTransformationRules": obj.get("canConfigureEntityPayloadTransformationRules"), "canConfigureEumApplications": obj.get("canConfigureEumApplications"), "canConfigureEventsAndAlerts": obj.get("canConfigureEventsAndAlerts"), "canConfigureGenAIEvaluations": obj.get("canConfigureGenAIEvaluations"), @@ -276,6 +279,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "canInstallNewAgents": obj.get("canInstallNewAgents"), "canInvokeAlertChannel": obj.get("canInvokeAlertChannel"), "canManuallyCloseIssue": obj.get("canManuallyCloseIssue"), + "canPlaybackSessionReplay": obj.get("canPlaybackSessionReplay"), "canRunAutomationActions": obj.get("canRunAutomationActions"), "canUseSyntheticCredentials": obj.get("canUseSyntheticCredentials"), "canViewAccountAndBillingInformation": obj.get("canViewAccountAndBillingInformation"), diff --git a/instana_client/models/app_data_metric_configuration.py b/instana_client/models/app_data_metric_configuration.py index 23c2592e..12002e45 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 08a87284..8da6a69a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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, field_validator +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 @@ -29,22 +29,12 @@ class Application(BaseModel): Returns a list of Application Perspectives. """ # noqa: E501 boundary_scope: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Here, `ALL` Application Boundary Scope is considered.", alias="boundaryScope") - business_criticality: Optional[StrictStr] = Field(default=None, description="Business criticality level of the application", alias="businessCriticality") + business_criticality: Optional[StrictInt] = Field(default=None, description="Represent how critical an application is to their business.", alias="businessCriticality") entity_type: Optional[StrictStr] = Field(default=None, description="Since, this is an Application Perspective, it will be of type `APPLICATION`.", alias="entityType") id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.") label: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Name of the Application Perspective. Eg: `app1`.") __properties: ClassVar[List[str]] = ["boundaryScope", "businessCriticality", "entityType", "id", "label"] - @field_validator('business_criticality') - def business_criticality_validate_enum(cls, value): - """Validates the enum""" - if value is None: - return value - - if value not in set(['NOT_DEFINED', 'LOWEST', 'LOW', 'MEDIUM', 'HIGH', 'HIGHEST']): - raise ValueError("must be one of enum values ('NOT_DEFINED', 'LOWEST', 'LOW', 'MEDIUM', 'HIGH', 'HIGHEST')") - return value - @field_validator('entity_type') def entity_type_validate_enum(cls, value): """Validates the enum""" diff --git a/instana_client/models/application_alert_config.py b/instana_client/models/application_alert_config.py index d5b1a2d3..f34793c0 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9b2a4ebe..155f60db 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0b9f3221..f8c4ed6d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0e0c46d9..7e94c8b2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b6e4a6ef..33493182 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -33,7 +33,7 @@ class ApplicationConfig(BaseModel): """ # noqa: E501 access_rules: Annotated[List[AccessRule], Field(min_length=1, max_length=64)] = Field(description="Defines permissions and access relationships. ", alias="accessRules") boundary_scope: StrictStr = Field(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`. ", alias="boundaryScope") - business_criticality: Optional[StrictStr] = Field(description="Business criticality level of the application", alias="businessCriticality") + business_criticality: Optional[Annotated[int, Field(le=5, strict=True, ge=0)]] = Field(default=None, description="Business criticality of an application (0-5)", alias="businessCriticality") created_at: Optional[StrictInt] = Field(default=None, alias="createdAt") created_by: Optional[StrictStr] = Field(default=None, alias="createdBy") id: Annotated[str, Field(min_length=1, strict=True, max_length=128)] = Field(description="Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.") @@ -52,16 +52,6 @@ def boundary_scope_validate_enum(cls, value): raise ValueError("must be one of enum values ('ALL', 'INBOUND', 'DEFAULT')") return value - @field_validator('business_criticality') - def business_criticality_validate_enum(cls, value): - """Validates the enum""" - if value is None: - return value - - if value not in set(['NOT_DEFINED', 'LOWEST', 'LOW', 'MEDIUM', 'HIGH', 'HIGHEST']): - raise ValueError("must be one of enum values ('NOT_DEFINED', 'LOWEST', 'LOW', 'MEDIUM', 'HIGH', 'HIGHEST')") - return value - @field_validator('scope') def scope_validate_enum(cls, value): """Validates the enum""" @@ -121,11 +111,6 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of tag_filter_expression if self.tag_filter_expression: _dict['tagFilterExpression'] = self.tag_filter_expression.to_dict() - # set to None if business_criticality (nullable) is None - # and model_fields_set contains the field - if self.business_criticality is None and "business_criticality" in self.model_fields_set: - _dict['businessCriticality'] = None - # set to None if tag_filter_expression (nullable) is None # and model_fields_set contains the field if self.tag_filter_expression is None and "tag_filter_expression" in self.model_fields_set: diff --git a/instana_client/models/application_event_result.py b/instana_client/models/application_event_result.py index 7c782989..2c0ef44a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 717b3f40..b03af8f5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 58226631..1a143ad5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2c1234d2..39b9dd13 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f0e906db..6906a6d9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 dd419dcc..9b61e01b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0c82d024..f60c1e09 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 46030ec7..2902b652 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 bfabeeea..0bbaf79e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4fb9126b..ee43ff13 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 df5aa8bc..85f965a5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/author.py b/instana_client/models/author.py index ae86b80e..7f337ac8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 093d1110..1c2f1e87 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -31,7 +31,7 @@ class AvailabilityBlueprintIndicator(ServiceLevelIndicator): AvailabilityBlueprintIndicator """ # noqa: E501 metric: Optional[EntityMetric] = None - threshold: Optional[Union[Annotated[float, Field(strict=True, ge=0.0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Threshold Value for the Blueprint") + threshold: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Threshold Value for the Blueprint") __properties: ClassVar[List[str]] = ["aggregation", "blueprint", "operator", "serviceLevelsMeasurement", "threshold", "type", "metric"] model_config = ConfigDict( diff --git a/instana_client/models/availability_sli_entity.py b/instana_client/models/availability_sli_entity.py index 35889250..a3e7a9a7 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c43b83b1..c70cc88f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 de148c56..c89a8b48 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a8eea369..2e916e64 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1b2bc092..8430aecb 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 63347676..14ac3d18 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 11a8d6ad..7afea9e9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f4e9c566..b622afa7 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 02ac9185..e174b2ab 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 52648852..c3591b9c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) 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 9741f96c..068da6bb 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/bulk_alert_config_request.py b/instana_client/models/bulk_alert_config_request.py index 4921cb6d..2e7e0e72 100644 --- a/instana_client/models/bulk_alert_config_request.py +++ b/instana_client/models/bulk_alert_config_request.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/business_activity.py b/instana_client/models/business_activity.py index 0284b5f1..22c2f03d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a4c5a08b..5b6059a3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ebabc923..91201c0a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e9fe9517..cb3721b5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 16e0e350..6fba4ad1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 171889e9..d4b9cf77 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 44708199..1f46a26a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b1ad1fbf..99b4fc73 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 172286c9..4da3ac32 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f52cdf8b..f6323b91 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8b9ffbec..957e0cbf 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 aae0c1e3..95d0ac91 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 533af79e..2cb0d59b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9683a6e9..69f484e2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/create_evaluation_request.py b/instana_client/models/create_evaluation_request.py index 5cdd0baa..5aedaab5 100644 --- a/instana_client/models/create_evaluation_request.py +++ b/instana_client/models/create_evaluation_request.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/create_evaluation_response.py b/instana_client/models/create_evaluation_response.py index ee578d00..4d62990c 100644 --- a/instana_client/models/create_evaluation_response.py +++ b/instana_client/models/create_evaluation_response.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 37ba9dd1..673977f6 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5f1b415c..fda12a20 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 25764a0c..a198af53 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 66be064a..c386d913 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 82609ef5..d9348f8c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d06243a2..fde427d3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d8bed8c9..64422632 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 71f79590..c99b2206 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 09d803d5..13f59290 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5d818933..57f16428 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f89045b2..41ac1af6 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_entity_with_metadata.py b/instana_client/models/custom_entity_with_metadata.py index 918d5bae..93d83b2c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 77b127c0..0e4c1e72 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f9e67c8b..967e4d96 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0291e5fe..87d3a8ba 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 786c465e..dca07330 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 53aa460f..b48a55da 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -61,8 +61,8 @@ def section_validate_enum(cls, value): if value is None: return value - if value not in set(['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']): - raise ValueError("must be one of enum values ('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')") + if value not in set(['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', 'ORACLE_DB', 'OTHERS', 'POSTGRESQL', 'REDIS', 'SAP', 'SELF_MONITORING', 'SOLR', 'SPARK', 'TIBCOBW', 'TUXEDO', 'VSHPERE', 'WEBSPHERE', 'CUSTOM_ENTITY']): + raise ValueError("must be one of enum values ('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', 'ORACLE_DB', 'OTHERS', 'POSTGRESQL', 'REDIS', 'SAP', 'SELF_MONITORING', 'SOLR', 'SPARK', 'TIBCOBW', 'TUXEDO', 'VSHPERE', 'WEBSPHERE', 'CUSTOM_ENTITY')") return value model_config = ConfigDict( diff --git a/instana_client/models/custom_metric_application_alert_rule.py b/instana_client/models/custom_metric_application_alert_rule.py index fe678daa..2f53da27 100644 --- a/instana_client/models/custom_metric_application_alert_rule.py +++ b/instana_client/models/custom_metric_application_alert_rule.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1a8ec288..e4f34435 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1e893cb4..16d165ed 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/custom_payload_with_last_updated.py b/instana_client/models/custom_payload_with_last_updated.py index f653e1f7..f4c842c7 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3bf89f0f..c1336f9c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5c24b29f..859c2558 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -53,8 +53,8 @@ def section_validate_enum(cls, value): if value is None: return value - if value not in set(['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']): - raise ValueError("must be one of enum values ('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')") + if value not in set(['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', 'ORACLE_DB', 'OTHERS', 'POSTGRESQL', 'REDIS', 'SAP', 'SELF_MONITORING', 'SOLR', 'SPARK', 'TIBCOBW', 'TUXEDO', 'VSHPERE', 'WEBSPHERE', 'CUSTOM_ENTITY']): + raise ValueError("must be one of enum values ('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', 'ORACLE_DB', 'OTHERS', 'POSTGRESQL', 'REDIS', 'SAP', 'SELF_MONITORING', 'SOLR', 'SPARK', 'TIBCOBW', 'TUXEDO', 'VSHPERE', 'WEBSPHERE', 'CUSTOM_ENTITY')") return value model_config = ConfigDict( diff --git a/instana_client/models/customer_email.py b/instana_client/models/customer_email.py index 0c4a36fd..e5d92201 100644 --- a/instana_client/models/customer_email.py +++ b/instana_client/models/customer_email.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 03294ef6..ad1958af 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 328e5813..dd179d25 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c0b4ce65..1cb06e5a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f4a966dd..058418e9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 40436116..4e5295f5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 574580a3..9bde9d78 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/dns_filter_target_value.py b/instana_client/models/dns_filter_target_value.py index e65d9ab5..97ffdf4e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/duration.py b/instana_client/models/duration.py index f0535eb2..1de51d67 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 afacae82..32fc0d6f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 fa4aea8e..8f26c66a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 dfb8b213..a503a041 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9d816210..d18a088b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 27eedc09..fd273094 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f6081da2..09d07e5c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ec441181..25621521 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 def53a76..18e32d1d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 abd39ed5..5faf1c2f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e885d21a..3f3d5edd 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7d209706..7c3081fe 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e5bd8703..147cdbf5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c8623cc5..be023542 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 fbedd47e..0781aa45 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 96aba024..7e468096 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 60346a34..b1127134 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 46095e09..900aa295 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 29472fc1..cd11089a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e08f3263..2e39c7d2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/entity_metric.py b/instana_client/models/entity_metric.py index 993672ca..de702ebe 100644 --- a/instana_client/models/entity_metric.py +++ b/instana_client/models/entity_metric.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/entity_metric_scope.py b/instana_client/models/entity_metric_scope.py index f26827dd..9d410d89 100644 --- a/instana_client/models/entity_metric_scope.py +++ b/instana_client/models/entity_metric_scope.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8a109a6a..47c94454 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3a7cc68e..7b90318e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7beaf621..586286fb 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/evaluation_detail_response.py b/instana_client/models/evaluation_detail_response.py index 9e0e4059..ecf75b9f 100644 --- a/instana_client/models/evaluation_detail_response.py +++ b/instana_client/models/evaluation_detail_response.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/evaluation_list_item.py b/instana_client/models/evaluation_list_item.py index 8a01582c..f394a73a 100644 --- a/instana_client/models/evaluation_list_item.py +++ b/instana_client/models/evaluation_list_item.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/evaluation_list_response.py b/instana_client/models/evaluation_list_response.py index dec88082..d0b29538 100644 --- a/instana_client/models/evaluation_list_response.py +++ b/instana_client/models/evaluation_list_response.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/evaluator.py b/instana_client/models/evaluator.py index 7cbb2c4c..f8f9375a 100644 --- a/instana_client/models/evaluator.py +++ b/instana_client/models/evaluator.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4d673741..8747153e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/event_filtering_configuration.py b/instana_client/models/event_filtering_configuration.py index 4aa6f6d0..adfae757 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7c30d426..bf171294 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 68caf230..5cfad1a8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5620aa95..c9919137 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e670f369..1151eabb 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/filter_interface.py b/instana_client/models/filter_interface.py index 3d111d01..941fc179 100644 --- a/instana_client/models/filter_interface.py +++ b/instana_client/models/filter_interface.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 be1469e5..3ad60a92 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2cd53d3a..0f8e48d3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/gateway_status_response.py b/instana_client/models/gateway_status_response.py index 6f06f8fa..3b1b42b7 100644 --- a/instana_client/models/gateway_status_response.py +++ b/instana_client/models/gateway_status_response.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e117eb13..e9d1df35 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 26ed03c9..d1b5a7f2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d3afae93..6ab0912a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1131785f..49d6e01d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_action_beacons_result.py b/instana_client/models/get_action_beacons_result.py index a104877e..596b8732 100644 --- a/instana_client/models/get_action_beacons_result.py +++ b/instana_client/models/get_action_beacons_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4226a389..ee3196f1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ef8d99f8..9540a90f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e016fb42..007fb739 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 47f53dda..f7b609c4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5ecfbfcb..2f244c18 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 60ae3e5a..d6c984ce 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 129d5f10..50558777 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_dynamic_parameter_values.py b/instana_client/models/get_dynamic_parameter_values.py index 65270e54..86e874d9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0014f002..4f1d845f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 fa9e78c6..6c5e2172 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_infrastructure_query.py b/instana_client/models/get_infrastructure_query.py index c4040f30..7f083de3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_metrics_result.py b/instana_client/models/get_metrics_result.py index 827afba8..f09e7be9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e59e07f3..7c822200 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d1c471a4..374e3396 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ebb6a032..9add44ee 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0677c426..8e24b107 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9e96dfd3..82cb1ee8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c2f33283..6660d0fe 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/get_session_replay_metadata_result.py b/instana_client/models/get_session_replay_metadata_result.py index c8aeb0dc..a3e4178c 100644 --- a/instana_client/models/get_session_replay_metadata_result.py +++ b/instana_client/models/get_session_replay_metadata_result.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ec8382d1..80b9e1ed 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 26816e9a..341efe91 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 dc28e784..1e5f8122 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9d459146..613f2b6f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 face4d70..dcb64da5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b4a3b27b..898ed4ba 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ad95071f..145e30db 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 abc1f88d..1b97a39a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b93930c2..b6e54e53 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 26e40b0a..73bb9e18 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 31300e4e..ea27ed83 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3f5932e0..18fd24d9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2cdb2af8..d6afafc4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/git_hub_configuration.py b/instana_client/models/git_hub_configuration.py index ce8a861a..94d8317d 100644 --- a/instana_client/models/git_hub_configuration.py +++ b/instana_client/models/git_hub_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 fcca353e..b046fc9c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f6accf83..15e453ce 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d8d706f8..f80efd35 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ed6ffc23..d837d4fb 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f1f05e9f..4d28b502 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 71cd138a..01fc45f3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a9f0041f..53f16949 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7cae8d22..64c99bf8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 25eb290c..8ba61a8b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 6a1fd844..b2f63dd3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 356f7b58..8dae85e2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -30,7 +30,7 @@ class HistoricBaseline(Threshold): HistoricBaseline """ # noqa: E501 baseline: Optional[List[List[Union[StrictFloat, StrictInt]]]] = None - deviation_factor: Optional[Union[Annotated[float, Field(le=16.0, strict=True, ge=0.5)], Annotated[int, Field(le=16, strict=True, ge=1)]]] = Field(default=None, alias="deviationFactor") + deviation_factor: Optional[Union[Annotated[float, Field(le=16, strict=True, ge=0.5)], Annotated[int, Field(le=16, strict=True, ge=1)]]] = Field(default=None, alias="deviationFactor") last_updated: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, alias="lastUpdated") seasonality: StrictStr __properties: ClassVar[List[str]] = ["operator", "type", "baseline", "deviationFactor", "lastUpdated", "seasonality"] diff --git a/instana_client/models/host_availability_rule.py b/instana_client/models/host_availability_rule.py index 939ab1fb..30af307f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1f5a451d..f7c2069b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ff966516..abd84350 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 16e65db6..15b67374 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0d2756c6..ee65ac5b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1a0bd8af..f3aa8305 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 34c965bb..ee261be6 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7996e1fe..409fc79b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d93aaae2..307755a9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 index 67fb140d..0456b488 100644 --- a/instana_client/models/icmp_configuration.py +++ b/instana_client/models/icmp_configuration.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/icmp_configuration_update.py b/instana_client/models/icmp_configuration_update.py index c875ca7e..16642f7b 100644 --- a/instana_client/models/icmp_configuration_update.py +++ b/instana_client/models/icmp_configuration_update.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/icmp_validation.py b/instana_client/models/icmp_validation.py index f99bdee4..c6cab654 100644 --- a/instana_client/models/icmp_validation.py +++ b/instana_client/models/icmp_validation.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/identity_provider_patch.py b/instana_client/models/identity_provider_patch.py index 8e1c6c3f..95867bb0 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7351e213..47bf2754 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c760220a..317e543e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 58b226eb..b364ed9d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7164cb31..987a9d5d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f4631352..3a3f22b4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0a014a02..bd251cc3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 376ec471..9caeed52 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 76b2405c..93c3c0a5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d2b10978..4cf6a4a7 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 78823034..ea672c96 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0d2af089..232fbcda 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7a639181..c822b1e9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c8f1cdb7..23f3183b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f10cb069..1546a9d2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d5620fd1..40b18b29 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8038d2ac..15efe650 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 659c2228..6e291711 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0f89797f..171cfc79 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 index e650f8b7..14471c49 100644 --- a/instana_client/models/ip_filtering.py +++ b/instana_client/models/ip_filtering.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/ip_filtering_rule_dto.py b/instana_client/models/ip_filtering_rule_dto.py index 0b6a3307..a019db61 100644 --- a/instana_client/models/ip_filtering_rule_dto.py +++ b/instana_client/models/ip_filtering_rule_dto.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/ip_filtering_upsert.py b/instana_client/models/ip_filtering_upsert.py index ab6353af..b4f88d44 100644 --- a/instana_client/models/ip_filtering_upsert.py +++ b/instana_client/models/ip_filtering_upsert.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/ip_masking_configuration.py b/instana_client/models/ip_masking_configuration.py index 927b888d..c9509ee5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2051a438..509a908d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f64b6c61..46640e62 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 beae0b93..f2a2a9fc 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -31,7 +31,7 @@ class LatencyBlueprintIndicator(ServiceLevelIndicator): LatencyBlueprintIndicator """ # noqa: E501 metric: Optional[EntityMetric] = None - threshold: Optional[Union[Annotated[float, Field(strict=True, ge=0.0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Threshold Value for the Blueprint") + threshold: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Threshold Value for the Blueprint") __properties: ClassVar[List[str]] = ["aggregation", "blueprint", "operator", "serviceLevelsMeasurement", "threshold", "type", "metric"] model_config = ConfigDict( diff --git a/instana_client/models/llm_egress_gateway.py b/instana_client/models/llm_egress_gateway.py index 07037039..dede4cf6 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/llm_gateway_capability.py b/instana_client/models/llm_gateway_capability.py index 304e86be..3a0fa607 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 80c16319..26b541f1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 305f6177..59b4145a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 06464d69..cc33056f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 72739136..91d4b43c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e34439d9..f8cd864f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3a07261e..6f4eb610 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4fe46373..fac06e7f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7fd6d74c..dc768846 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 30f0585d..b1ddf84c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 67634573..fee1a895 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7f37bfb4..76cc0a26 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5c6a4e22..0fe16954 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a1193a5d..00d0d441 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 fb9fb5ef..736ac50c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/log_volume_usage_result.py b/instana_client/models/log_volume_usage_result.py index e7e4c475..d74a06e1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/logs_api_response.py b/instana_client/models/logs_api_response.py index 472b70d6..27cf8c04 100644 --- a/instana_client/models/logs_api_response.py +++ b/instana_client/models/logs_api_response.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 aa78d090..0208a0e4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/logs_query.py b/instana_client/models/logs_query.py index cebe1c43..413111da 100644 --- a/instana_client/models/logs_query.py +++ b/instana_client/models/logs_query.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1b1b3992..e9698504 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 cd163a77..fddba3e5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ac0bec43..3978468a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 479e1d53..6cd23511 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 51baf029..3e05d943 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 7cebc806..e44b6591 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 27ad7788..74899511 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b6b05998..ec113285 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2e112838..8bae9449 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 451ba50d..3b0f852b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4f04c95c..024e7be1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 139171b3..110dd7fa 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 fe735152..6be94423 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 31024c1e..ed3162dc 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c3dc7b30..7ed02c91 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -30,7 +30,7 @@ class MetricConfiguration(BaseModel): """ # noqa: E501 metric_aggregation: Optional[StrictStr] = Field(default=None, 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. ", alias="metricAggregation") metric_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Defines the name of the metric to be monitored. Examples include `calls` and `latency`", alias="metricName") - threshold: Optional[Union[Annotated[float, Field(strict=True, gt=0.0)], Annotated[int, Field(strict=True, gt=0)]]] = Field(default=None, description="Specifies the threshold value for the metric being monitored") + threshold: Optional[Union[Annotated[float, Field(strict=True, gt=0)], Annotated[int, Field(strict=True, gt=0)]]] = Field(default=None, description="Specifies the threshold value for the metric being monitored") __properties: ClassVar[List[str]] = ["metricAggregation", "metricName", "threshold"] @field_validator('metric_aggregation') diff --git a/instana_client/models/metric_description.py b/instana_client/models/metric_description.py index 35930e14..b25f8502 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 index 13b73557..cd190cd2 100644 --- a/instana_client/models/metric_field.py +++ b/instana_client/models/metric_field.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metric_field_value.py b/instana_client/models/metric_field_value.py index 4ef951be..6fbd360b 100644 --- a/instana_client/models/metric_field_value.py +++ b/instana_client/models/metric_field_value.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/metric_instance.py b/instana_client/models/metric_instance.py index 76460e29..03d3069b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f8fba0a6..850ae2d3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ebbac296..26c8c820 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -62,8 +62,8 @@ def format_validate_enum(cls, value): @field_validator('infra_tag_category') def infra_tag_category_validate_enum(cls, value): """Validates the enum""" - if value not in set(['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']): - raise ValueError("must be one of enum values ('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')") + if value not in set(['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', 'ORACLE_DB', 'OTHERS', 'POSTGRESQL', 'REDIS', 'SAP', 'SELF_MONITORING', 'SOLR', 'SPARK', 'TIBCOBW', 'TUXEDO', 'VSHPERE', 'WEBSPHERE', 'CUSTOM_ENTITY']): + raise ValueError("must be one of enum values ('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', 'ORACLE_DB', 'OTHERS', 'POSTGRESQL', 'REDIS', 'SAP', 'SELF_MONITORING', 'SOLR', 'SPARK', 'TIBCOBW', 'TUXEDO', 'VSHPERE', 'WEBSPHERE', 'CUSTOM_ENTITY')") return value model_config = ConfigDict( diff --git a/instana_client/models/metric_pattern.py b/instana_client/models/metric_pattern.py index c76a1e2a..91f290c7 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f115c875..f1eddc0e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c5ead042..7eb1853f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 73e6a322..70b56c26 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2e56786f..8333042f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 130afe34..80aa5b07 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 925b49eb..5bc2ee80 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 547c3df1..fda5e528 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a2d195bf..296600be 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 79457014..d476af9b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5fb02857..a357e918 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9202303f..42576448 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 bc3d39d4..646ac1a2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8b6f7ff7..c22f079d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c82dc432..b83e01bd 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e27d6b27..cd576d64 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b1320ae7..473203f1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 58dde656..bba5c8aa 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 6c62a305..a1904241 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/mobile_slo_entity.py b/instana_client/models/mobile_slo_entity.py index 9642936c..0d99ad91 100644 --- a/instana_client/models/mobile_slo_entity.py +++ b/instana_client/models/mobile_slo_entity.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9d176fee..17265997 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a0264921..123a7445 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ded734e2..3ef86c3a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 dffe8e70..80620f9d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 afe7df61..89314f97 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -33,7 +33,7 @@ class NewApplicationConfig(BaseModel): """ # noqa: E501 access_rules: Annotated[List[AccessRule], Field(min_length=1, max_length=64)] = Field(description="Defines permissions and access relationships. ", alias="accessRules") boundary_scope: StrictStr = Field(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`. ", alias="boundaryScope") - business_criticality: Optional[StrictStr] = Field(description="Business criticality level of the application", alias="businessCriticality") + business_criticality: Optional[Annotated[int, Field(le=5, strict=True, ge=0)]] = Field(default=None, description="Business criticality of an application (0-5)", alias="businessCriticality") label: Annotated[str, Field(min_length=1, strict=True, max_length=128)] = Field(description="Name of the Application Perspective. Eg: `app1`.") match_specification: Optional[MatchExpressionDTO] = Field(default=None, alias="matchSpecification") scope: StrictStr = Field(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. ") @@ -47,16 +47,6 @@ def boundary_scope_validate_enum(cls, value): raise ValueError("must be one of enum values ('ALL', 'INBOUND', 'DEFAULT')") return value - @field_validator('business_criticality') - def business_criticality_validate_enum(cls, value): - """Validates the enum""" - if value is None: - return value - - if value not in set(['NOT_DEFINED', 'LOWEST', 'LOW', 'MEDIUM', 'HIGH', 'HIGHEST']): - raise ValueError("must be one of enum values ('NOT_DEFINED', 'LOWEST', 'LOW', 'MEDIUM', 'HIGH', 'HIGHEST')") - return value - @field_validator('scope') def scope_validate_enum(cls, value): """Validates the enum""" @@ -116,11 +106,6 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of tag_filter_expression if self.tag_filter_expression: _dict['tagFilterExpression'] = self.tag_filter_expression.to_dict() - # set to None if business_criticality (nullable) is None - # and model_fields_set contains the field - if self.business_criticality is None and "business_criticality" in self.model_fields_set: - _dict['businessCriticality'] = None - # set to None if tag_filter_expression (nullable) is None # and model_fields_set contains the field if self.tag_filter_expression is None and "tag_filter_expression" in self.model_fields_set: diff --git a/instana_client/models/new_business_perspective_config.py b/instana_client/models/new_business_perspective_config.py index 2ac6d2b4..85da3a1b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 91c092bf..d7be8b60 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/notification.py b/instana_client/models/notification.py index 73194f59..479c2737 100644 --- a/instana_client/models/notification.py +++ b/instana_client/models/notification.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5ca2d21d..8bf91c3e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 aa17275f..321bd386 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b9a29a5f..4ac81c7b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 dc79fb16..65c68c25 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 63c471f6..5fdc1fc1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 03854f4d..16bf616a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 6a1b0cfe..bead5276 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ed3b2043..10a7d5f7 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 931729c7..b8a4e942 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c891c28a..657d1f9a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c17ebd7f..8f019937 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 535fb671..9168bac3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e2fc7a2d..78c5e6d7 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2be1ad35..11d928e9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9a844dd2..f54256d9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 97e6c484..097e2c46 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 484412a0..ce05b86d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a5cd33b8..dc4e4908 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 cfc73b66..518f18b9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e8be429d..9fb6aaa3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3d30fd9f..f1d7ab0d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 fd279031..17f0c3c8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2ac65b0f..ab809852 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -28,8 +28,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]] = ["enabled", "prefix"] + include_in_title: Optional[StrictBool] = Field(default=None, description="Whether the short code should be included in the incident title", alias="includeInTitle") + prefix: Optional[StrictStr] = Field(default=None, description="The prefix to use for event short codes (e.g., 'INSTA-', 'PROD-')") + __properties: ClassVar[List[str]] = ["enabled", "includeInTitle", "prefix"] model_config = ConfigDict( populate_by_name=True, @@ -83,6 +84,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "enabled": obj.get("enabled"), + "includeInTitle": obj.get("includeInTitle"), "prefix": obj.get("prefix") }) return _obj diff --git a/instana_client/models/problem.py b/instana_client/models/problem.py index 82ee8ded..a7224ed8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 94ffd1d9..dfab147f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/rbac_restrictions.py b/instana_client/models/rbac_restrictions.py index d3320b3f..f0e394c8 100644 --- a/instana_client/models/rbac_restrictions.py +++ b/instana_client/models/rbac_restrictions.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 991b2a0d..9077531a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 57336463..80d53ab2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2553cf16..f8af03fc 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9cfd8e7f..2c0a0b88 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 71d853a7..d64dc6ed 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/role_mapping_overview.py b/instana_client/models/role_mapping_overview.py index 71d70382..f236350d 100644 --- a/instana_client/models/role_mapping_overview.py +++ b/instana_client/models/role_mapping_overview.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 423a7024..a60b6a9b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 26b1c147..6a4c1a76 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) 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 33a59473..fab8afee 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5ac36056..7a9f31db 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9efac2c3..bbd592b4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 931e9dd9..71b15e9f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9db879ef..79f410c5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c00bc1ef..28e19f27 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/run_evaluation_response.py b/instana_client/models/run_evaluation_response.py index 28a28a44..55f12f38 100644 --- a/instana_client/models/run_evaluation_response.py +++ b/instana_client/models/run_evaluation_response.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 75707cf0..53af3a82 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/sampling_metadata.py b/instana_client/models/sampling_metadata.py index 4e2ed49f..02a19335 100644 --- a/instana_client/models/sampling_metadata.py +++ b/instana_client/models/sampling_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 153ad40b..6b2f0e3a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -32,7 +32,7 @@ class SaturationBlueprintIndicator(ServiceLevelIndicator): """ # noqa: E501 metric: Optional[EntityMetric] = None metric_name: Optional[StrictStr] = Field(default=None, alias="metricName") - threshold: Optional[Union[Annotated[float, Field(strict=True, ge=0.0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Threshold Value for the Blueprint") + threshold: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Threshold Value for the Blueprint") __properties: ClassVar[List[str]] = ["aggregation", "blueprint", "operator", "serviceLevelsMeasurement", "threshold", "type", "metric", "metricName"] model_config = ConfigDict( diff --git a/instana_client/models/scope_binding.py b/instana_client/models/scope_binding.py index 08cf0f6d..8485cb12 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ff123da3..0ec9c313 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 034ee3de..1fd366c3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9d1dcc49..d053b67a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 11151f4a..82f1a4a3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 6d420b8e..15045453 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ea3c9b9d..87373616 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f00292cf..d40a58cf 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 332c4d03..7436c3fe 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ba8ac8c0..22e9e7ce 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 721945ee..f5e71ff4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 aba82177..b90b0213 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5d3caba5..ffddd12c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ab9adaae..58c562d0 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 263e42ed..53071756 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a650ec24..0cd5d30c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e03f288e..11ae07c4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9adbb85e..66c115de 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c36dea6f..8e8e7f74 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 eb51d3cd..e3fa0cae 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ef051a9f..718ab343 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9c4b558e..9e2bc14e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 6dc7d3c9..f686cfa8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 01f32183..5999a346 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f9a48d9c..a074ea84 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c286e16c..f55bbb6b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 74b777a6..b79f7704 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 842ee3b0..722557f3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5965e8ce..94c41ef7 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/session_replay_metadata.py b/instana_client/models/session_replay_metadata.py index e61cec3d..a73bee5a 100644 --- a/instana_client/models/session_replay_metadata.py +++ b/instana_client/models/session_replay_metadata.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/session_replay_timestamps.py b/instana_client/models/session_replay_timestamps.py index a4e282f1..f687f91e 100644 --- a/instana_client/models/session_replay_timestamps.py +++ b/instana_client/models/session_replay_timestamps.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 11dd84fa..94bf6f95 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8ba0db23..20f613f1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/slack_integration.py b/instana_client/models/slack_integration.py index e656f766..218ba02e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 10fdf385..dd453cd8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 45582570..c3b8c819 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9586a8cb..d9d0535a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 77751498..20880eea 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 070d01f0..98c6bd42 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -41,7 +41,7 @@ class SLOConfigWithRBACTag(BaseModel): name: StrictStr = Field(description="Name of the Service Levels Objective Configuration") rbac_tags: Optional[List[ApiTag]] = Field(default=None, alias="rbacTags") tags: List[StrictStr] = Field(description="List of tags associated with Service Levels Objective Configuration") - target: Union[Annotated[float, Field(le=0.9999, strict=True, gt=0.0)], Annotated[int, Field(le=0, strict=True, gt=0)]] = Field(description="Service Levels Objective Configuration Target") + target: Union[Annotated[float, Field(le=0.9999, strict=True, gt=0)], Annotated[int, Field(le=0, strict=True, gt=0)]] = Field(description="Service Levels Objective Configuration Target") time_window: TimeWindow = Field(alias="timeWindow") __properties: ClassVar[List[str]] = ["createdDate", "entity", "id", "indicator", "lastUpdated", "name", "rbacTags", "tags", "target", "timeWindow"] diff --git a/instana_client/models/slo_entity.py b/instana_client/models/slo_entity.py index eba84518..757598a1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0998edf4..9c697616 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 001768d3..f267a003 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c6d4cffc..067300bf 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1b913237..0d0c2c78 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e2e5579c..77230681 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4cb29119..167048a1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b692d1da..38fd5f92 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a0f1498b..4f545caf 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 54f741fa..6e0a136c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e4a68ddc..2289b7ea 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0836f575..06b2b590 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 bf7af823..d8fdda47 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 24056839..33bbe233 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b305a2da..4b3c4e30 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ee44317a..ffea41a3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 cc39412e..62d5a969 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 bd597cc9..2da2b7ba 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f9ef5086..87524750 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d135e5bc..037430a4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 05110ff5..75172031 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/stack_trace_item.py b/instana_client/models/stack_trace_item.py index 0efe548b..1b4d951e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c9917f31..23d4bfb9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9770c8ae..69f6fe03 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -30,7 +30,7 @@ class StaticBaselineThresholdRule(ThresholdConfigRule): StaticBaselineThresholdRule """ # noqa: E501 baseline: Optional[List[List[Union[StrictFloat, StrictInt]]]] = None - deviation_factor: Optional[Union[Annotated[float, Field(le=16.0, strict=True, ge=0.5)], Annotated[int, Field(le=16, strict=True, ge=1)]]] = Field(default=None, alias="deviationFactor") + deviation_factor: Optional[Union[Annotated[float, Field(le=16, strict=True, ge=0.5)], Annotated[int, Field(le=16, strict=True, ge=1)]]] = Field(default=None, alias="deviationFactor") seasonality: StrictStr __properties: ClassVar[List[str]] = ["type", "baseline", "deviationFactor", "seasonality"] diff --git a/instana_client/models/static_string_field.py b/instana_client/models/static_string_field.py index 9aa6625d..da5e2549 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 36d737ed..8aa127e6 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0f839bc9..7c40f7ce 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4356894f..0929c71d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3010a43d..bca2aa83 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 bc7a1334..1f38c400 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 07d1de5c..9b0ac94d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 bb7db264..41698c3c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5425fb78..331d041d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a567a735..e5c03316 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 831f85aa..2bfaa017 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ca8c44df..67225714 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 40fe7c93..47db3e59 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1b912101..1b341d72 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2035bfda..1d3a9a41 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 823d0b31..fa0a066b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 188ffa97..81e5452f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2c05990f..7485e3e3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 12d3a5c8..732182f7 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 da74371a..b0bb447c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 68927165..04e8e69a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c7a09ac0..1aa1a137 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 313cfa88..1c2e038b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0f36b410..e2087d0d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 055e6665..32234e0e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 d3077fe0..38427b27 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 index 93ecb698..00ee116c 100644 --- 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 @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) 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 313aa068..0a1a420b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4675faf1..5be66c15 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ad9db66a..2298c701 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5bc50c5d..ca147955 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 6d11ce43..66ac846e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4f60a28d..37eae368 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ebe74d7e..e1d38cc0 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4225fe1f..e0a8c2c8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2589ffd9..f2e4d7c1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3537c583..bc5f5e3a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8550081c..46e1130c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a533a7d4..d4ecfe99 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4ed34dea..2291768f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 6e0b4b8d..e6fc0736 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetic_type_configuration_update.py b/instana_client/models/synthetic_type_configuration_update.py index 1bf6bdc2..6ef1df03 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/synthetics_event_result.py b/instana_client/models/synthetics_event_result.py index 9776c893..d53c3a3c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 51ab5397..59c846f4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 87fb6bfe..38fd3be1 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ef1fb0b0..94534c37 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0bb0664c..e7753180 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 35bb2589..30862a9c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3e3a8ceb..bc0c7cf4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9966132f..8f5ca969 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a37191e5..d5627ade 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 62a1555c..969acbb9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b28d079e..8edac832 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 abe446ea..9fb4bb18 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/test_connection_response.py b/instana_client/models/test_connection_response.py index d0ab472f..0e60c4c4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 064dde92..431217c0 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 46253a30..91b81a5e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 6e5e94e3..28dcfd4b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4b03a976..610bb262 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 17f8baab..54d9e542 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3b32dab4..81523766 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 88615d8b..d47455ec 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 184e284e..dfccf98e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 627642e0..3a944cd3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 36987a5b..49aed114 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f6bf31cf..c22d21f8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 38316a3e..2033a246 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9ac759d5..b6411bd2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 bc8e564f..d0c275e9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f3fe05d8..44b14a37 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/time_config.py b/instana_client/models/time_config.py index cf9770e0..2be78ac4 100644 --- a/instana_client/models/time_config.py +++ b/instana_client/models/time_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 66b85fa0..8c6016a6 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8f3ae214..4d02eb79 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 734699d7..b6a8c6be 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 14fa82c7..297fefc8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c22f7c8f..ea63ce2d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f6c7804d..b8669f87 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 eba34747..aeabe8e8 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 eaee71fa..61e839c0 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a6ba1158..8a228754 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b4beefc9..5a74905d 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1277f274..438a992a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/trace_sampling_config.py b/instana_client/models/trace_sampling_config.py index d1435fe0..a334d880 100644 --- a/instana_client/models/trace_sampling_config.py +++ b/instana_client/models/trace_sampling_config.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8fd5ae30..6c12149e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -31,7 +31,7 @@ class TrafficBlueprintIndicator(ServiceLevelIndicator): TrafficBlueprintIndicator """ # noqa: E501 metric: Optional[EntityMetric] = None - threshold: Optional[Union[Annotated[float, Field(strict=True, ge=0.0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Threshold Value for the Blueprint") + threshold: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Threshold Value for the Blueprint") traffic_type: StrictStr = Field(alias="trafficType") __properties: ClassVar[List[str]] = ["aggregation", "blueprint", "operator", "serviceLevelsMeasurement", "threshold", "type", "metric", "trafficType"] diff --git a/instana_client/models/trigger.py b/instana_client/models/trigger.py index 4c5e0eb4..ca05100a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 f051bf93..b3a257ee 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3d148032..28c785a0 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/instana_client/models/update_evaluation_request.py b/instana_client/models/update_evaluation_request.py index c9d3311e..d4f86ab9 100644 --- a/instana_client/models/update_evaluation_request.py +++ b/instana_client/models/update_evaluation_request.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0dd4a143..3058b544 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5746cf90..4395b7b2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 4c5d8f37..f1317179 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b0a8439c..7e6b8cd5 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 de0c9b39..15d869f7 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -30,7 +30,7 @@ class UserImpactMobileAppTimeThreshold(MobileAppTimeThreshold): UserImpactMobileAppTimeThreshold """ # noqa: E501 impact_measurement_method: StrictStr = Field(alias="impactMeasurementMethod") - user_percentage: Optional[Union[Annotated[float, Field(le=1.0, strict=True, gt=0.0)], Annotated[int, Field(le=1, strict=True, gt=0)]]] = Field(default=None, alias="userPercentage") + user_percentage: Optional[Union[Annotated[float, Field(le=1, strict=True, gt=0)], Annotated[int, Field(le=1, strict=True, gt=0)]]] = Field(default=None, alias="userPercentage") users: Optional[Annotated[int, Field(strict=True, ge=1)]] = None __properties: ClassVar[List[str]] = ["timeWindow", "type", "impactMeasurementMethod", "userPercentage", "users"] diff --git a/instana_client/models/user_impact_website_time_threshold.py b/instana_client/models/user_impact_website_time_threshold.py index 11be37da..4a3c05f7 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.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -30,7 +30,7 @@ class UserImpactWebsiteTimeThreshold(WebsiteTimeThreshold): UserImpactWebsiteTimeThreshold """ # noqa: E501 impact_measurement_method: StrictStr = Field(alias="impactMeasurementMethod") - user_percentage: Optional[Union[Annotated[float, Field(le=1.0, strict=True, gt=0.0)], Annotated[int, Field(le=1, strict=True, gt=0)]]] = Field(default=None, alias="userPercentage") + user_percentage: Optional[Union[Annotated[float, Field(le=1, strict=True, gt=0)], Annotated[int, Field(le=1, strict=True, gt=0)]]] = Field(default=None, alias="userPercentage") users: Optional[Annotated[int, Field(strict=True, ge=1)]] = None __properties: ClassVar[List[str]] = ["timeWindow", "type", "impactMeasurementMethod", "userPercentage", "users"] diff --git a/instana_client/models/user_result.py b/instana_client/models/user_result.py index 9d4a59d5..919bca10 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ed8e6620..e9799e3b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 23bc22f0..5a071adf 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 af781c2d..b764eaf2 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 01bce013..79acec5f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a61a4f35..a80ae5de 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 aabbfb82..48ca926c 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 b4e6bbda..ae50ea97 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2319223f..8cb8f65f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 58785093..d9b24c29 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c351c8b9..bc3e27bf 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 19d2fa2e..f017131f 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1a3d81fa..8d73a6e6 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 633b7102..9e24edb6 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 01fb4a72..d00a5170 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1638d15b..7152a796 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e0547839..506fc868 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 00c5861c..4f86fc77 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 94fe81b9..302f8ffe 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 ef08bda5..08726713 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 35059bc8..5620a785 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 0fc79d38..1d07d0ad 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e1f3e13c..ad49fea3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a1c6983f..999f84ae 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 5bae710a..cbe2e1c4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 e1ce300c..9231d61e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8a6542a1..0b071c44 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1309751c..1da932dc 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 1ebf29a1..dcb9840a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 dafe1ef9..e268ad30 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 51120b55..f8fb295b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 022e5d02..072f57d4 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3e070aeb..62a69906 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9a4ff021..f28e9cd6 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 649c3e84..cb222a2b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2d60b40c..4834c4a9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a77b5416..44b2465e 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 04a86162..053311b9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9a03ee56..1a99fb99 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 3cb6f67e..fb921d39 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 c6b37102..555383ca 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 364fe609..cb5f3b0a 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 a5753466..a401ecd3 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 8d4b45cb..c7d8ef61 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 9651ec8b..accd905b 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 6f71565f..26647576 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 58000c39..14dd42f9 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 722b7499..b5994db6 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.324.1358 + The version of the OpenAPI document: 1.325.1193 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 2194aa92..78d65336 100644 --- a/openapi-generator-config.json +++ b/openapi-generator-config.json @@ -1,6 +1,6 @@ { "packageName": "instana_client", "projectName": "instana-client", - "packageVersion": "1.1.1", + "packageVersion": "1.1.2", "packageUrl": "https://github.com/instana/client-python" } diff --git a/openapi.yaml b/openapi.yaml index 683aadc9..1ef7e8c1 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -7,163 +7,164 @@ info: description: Documentation for INSTANA REST API termsOfService: https://www.instana.com/terms-of-use/ title: Instana REST API documentation - version: 1.324.1358 + version: 1.325.1193 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 Backend + url: https://{unit}-{tenant}.instana.io + variables: + tenant: + default: tenant + description: Customer tenant unit + unit: + default: unit + description: Customer tenant name 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: Roles - 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 -- name: Fleet Management - x-description: tagFleetManagement + - 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: Roles + 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 + - name: Fleet Management + x-description: tagFleetManagement 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 + - 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: @@ -173,10 +174,10 @@ paths: from: 1706713140000 to: 1706813100000 apdexScore: - - - 1706713140000 - - 0.5 - - - 1706779500000 - - 0.5 + - - 1706713140000 + - 0.5 + - - 1706779500000 + - 0.5 schema: type: array items: @@ -187,66 +188,75 @@ paths: application/json: example: errors: - - There is no Apdex configuration for the given ID. + - 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 + - ApiKeyAuth: + - Default summary: Generate Apdex report tags: - - Apdex Report + - Apdex Report /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. + 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 + - 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 + - traceId: c606ccf3578135c6 schema: type: array items: $ref: '#/components/schemas/BackendTraceReference' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Resolve Trace IDs from Monitoring Beacons. tags: - - Application Analyze + - Application Analyze /api/application-monitoring/analyze/call-groups: post: - description: |2- + description: >- - For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze. + 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 + - 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: @@ -255,11 +265,11 @@ paths: groupbyTag: service.name groupbyTagEntity: DESTINATION metrics: - - aggregation: SUM - metric: calls - - aggregation: P75 - metric: latency - granularity: 360 + - aggregation: SUM + metric: calls + - aggregation: P75 + metric: latency + granularity: 360 includeInternal: false includeSynthetic: false order: @@ -271,16 +281,16 @@ paths: 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 + - 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' @@ -293,16 +303,16 @@ paths: application/json: example: items: - - name: ratings - timestamp: 1688366520000 - cursor: - '@class': .IngestionOffsetCursor - ingestionTime: 1688980829000 - offset: 1 - metrics: - latency.p75.360: - - - 1688366520000 - - 1.0 + - name: ratings + timestamp: 1688366520000 + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1688980829000 + offset: 1 + metrics: + latency.p75.360: + - - 1688366520000 + - 1 canLoadMore: false totalHits: 1 totalRepresentedItemCount: 1 @@ -314,25 +324,29 @@ paths: $ref: '#/components/schemas/CallGroupsResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get grouped call metrics tags: - - Application Analyze + - Application Analyze x-description: getCallGroup /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." + description: >- + In this endpoint, the supported `groupbyTag` are `trace.endpoint.name` + and `trace.service.name`. + + For 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 + - 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: @@ -341,8 +355,8 @@ paths: groupbyTag: trace.endpoint.name groupbyTagEntity: NOT_APPLICABLE metrics: - - aggregation: SUM - metric: latency + - aggregation: SUM + metric: latency order: by: latency direction: ASC @@ -352,16 +366,16 @@ paths: 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 + - 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 @@ -371,16 +385,16 @@ paths: application/json: example: items: - - name: GET /api/cart-total - timestamp: 1688542673148 - cursor: - '@class': .IngestionOffsetCursor - ingestionTime: 1688543264000 - offset: 1 - metrics: - latency.sum: - - - 1688543260000 - - 31.0 + - name: GET /api/cart-total + timestamp: 1688542673148 + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1688543264000 + offset: 1 + metrics: + latency.sum: + - - 1688543260000 + - 31 canLoadMore: true totalHits: 2595 totalRepresentedItemCount: 2595 @@ -392,17 +406,18 @@ paths: $ref: '#/components/schemas/TraceGroupsResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get grouped trace metrics tags: - - Application Analyze + - Application Analyze x-description: getTraceGroups /api/application-monitoring/analyze/traces: post: - description: |2- + description: >- - For more information on Application Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-analyze. + 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: @@ -419,16 +434,16 @@ paths: 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 + - 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 @@ -441,27 +456,24 @@ paths: 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 + - 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 @@ -474,69 +486,75 @@ paths: description: OK x-example: TraceResult security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all traces tags: - - Application Analyze + - Application Analyze x-description: getTraces /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. + 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. + 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 (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: Name of application (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 responses: '200': content: application/json: example: items: - - boundaryScope: INBOUND - entityType: APPLICATION - id: e8krH1wNRV6daAo-NEmG8g - label: Robot Shop + - boundaryScope: INBOUND + entityType: APPLICATION + id: e8krH1wNRV6daAo-NEmG8g + label: Robot Shop page: 1 pageSize: 1 totalHits: 1 @@ -544,88 +562,94 @@ paths: $ref: '#/components/schemas/ApplicationResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get applications tags: - - Application Resources + - Application Resources /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. - A use case could be to retrieve all service ids present in an Application Perspective. + description: >- + Use this API endpoint if one wants to retrieve a list of services 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. + 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: - - 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 - 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 + - 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 + 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 + - entityType: SERVICE + id: 79f1430f4a42a707a97621ca00617e40bd51c31d + label: www.paypal.com + snapshotIds: + - CywiRxmGIwtQIKezVs-XMcTX2xg + technologies: + - kafkaCluster + types: + - MESSAGING page: 1 pageSize: 1 totalHits: 1 @@ -633,104 +657,108 @@ paths: $ref: '#/components/schemas/ServiceResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get applications/services tags: - - Application Resources + - Application Resources /api/application-monitoring/applications;id={applicationId}/services;id={serviceId}/endpoints;id={endpointId}: get: - description: |- + 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. + + 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 - 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: + - 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 + 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 - 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 + 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 + - entityType: ENDPOINT + id: IWeMKSzcvJHijAQoaA-luyHriDQ + label: websites + serviceId: a25c02069636022456e6139ebfe4f4bfec23ae31 + synthetic: false + syntheticType: NON_SYNTHETIC + technologies: + - postgreSqlDatabase + type: DATABASE page: 1 pageSize: 1 totalHits: 1 @@ -738,183 +766,208 @@ paths: $ref: '#/components/schemas/EndpointResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get endpoints tags: - - Application Resources + - Application Resources /api/application-monitoring/catalog: get: - description: |2- + description: >- - For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog. + 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_ADAPTIVE_BASELINE_FAST_INIT - - SMART_ALERTS_CUSTOM_PAYLOAD - - SLI_MANAGEMENT - - APPLICATION_CONFIG - - APPLICATION_CONFIG_BLUEPRINT - - MAINTENANCE_WINDOWS - - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + - 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_ADAPTIVE_BASELINE_FAST_INIT + - 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 + - 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 + - name: marathon.label + label: Label + type: KEY_VALUE_PAIR + description: marathon label + 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 + - 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 security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get application tag catalog tags: - - Application Catalog + - Application Catalog x-description: getApplicationTagsCatalog /api/application-monitoring/catalog/metrics: get: - description: |2- + description: >- - For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog. + 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 + - 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 + - ApiKeyAuth: + - Default summary: Get Metric catalog tags: - - Application Catalog + - Application Catalog x-description: getApplicationCatalogMetrics /api/application-monitoring/catalog/tags: get: deprecated: true - description: |2- + description: >- - For more information on Application Catalog please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-catalog. + 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_ADAPTIVE_BASELINE_FAST_INIT - - SMART_ALERTS_CUSTOM_PAYLOAD - - SLI_MANAGEMENT - - APPLICATION_CONFIG - - APPLICATION_CONFIG_BLUEPRINT - - MAINTENANCE_WINDOWS - - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + - 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_ADAPTIVE_BASELINE_FAST_INIT + - SMART_ALERTS_CUSTOM_PAYLOAD + - SLI_MANAGEMENT + - APPLICATION_CONFIG + - APPLICATION_CONFIG_BLUEPRINT + - MAINTENANCE_WINDOWS + - BIZOPS_CUSTOM_DASHBOARDS_FILTERING responses: '200': content: @@ -925,28 +978,35 @@ paths: $ref: '#/components/schemas/Tag' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get application tags tags: - - Application Catalog + - Application Catalog x-description: getApplicationCatalogTags /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`. + 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. + + 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 + - 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: @@ -957,8 +1017,8 @@ paths: be provided in "metrics" as well value: metrics: - - aggregation: MEAN - metric: latency + - aggregation: MEAN + metric: latency order: by: latency.mean direction: DESC @@ -977,15 +1037,15 @@ paths: application/json: example: items: - - application: - id: Jv83WpUmSKiiCWIpi-reSQ - label: demoApp - boundaryScope: ALL - entityType: APPLICATION - metrics: - latency.mean: - - - 1669190580000 - - 4.0 + - application: + id: Jv83WpUmSKiiCWIpi-reSQ + label: demoApp + boundaryScope: ALL + entityType: APPLICATION + metrics: + latency.mean: + - - 1669190580000 + - 4 page: 1 pageSize: 1 totalHits: 1616 @@ -996,41 +1056,49 @@ paths: $ref: '#/components/schemas/ApplicationMetricResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Application Metrics tags: - - Application Metrics + - Application Metrics /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`. + 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. + + 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 + - 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 + 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 + - aggregation: MEAN + metric: latency order: by: latency.mean direction: ASC @@ -1049,21 +1117,21 @@ paths: 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 + - 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 @@ -1074,45 +1142,53 @@ paths: $ref: '#/components/schemas/EndpointMetricResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Endpoint metrics tags: - - Application Metrics + - Application Metrics /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`. + 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. + + 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 + - 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 + 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 + - aggregation: mean + metric: latency order: by: latency.mean direction: DESC @@ -1121,7 +1197,7 @@ paths: pageSize: 1 serviceId: c467ca0fa21477fee3cde75a140b2963307388a7 technologies: - - springbootApplicationContainer + - springbootApplicationContainer timeFrame: to: 1669190589000 windowSize: 3600000 @@ -1134,20 +1210,19 @@ paths: application/json: example: items: - - service: - id: c467ca0fa21477fee3cde75a140b2963307388a7 - label: discount - types: - - HTTP - technologies: - - springbootApplicationContainer - snapshotIds: [ - ] - entityType: SERVICE - metrics: - endpoints.distinct_count: - - - 1669190580000 - - 4.0 + - service: + id: c467ca0fa21477fee3cde75a140b2963307388a7 + label: discount + types: + - HTTP + technologies: + - springbootApplicationContainer + snapshotIds: [] + entityType: SERVICE + metrics: + endpoints.distinct_count: + - - 1669190580000 + - 4 page: 1 pageSize: 1 totalHits: 1 @@ -1158,70 +1233,74 @@ paths: $ref: '#/components/schemas/ServiceMetricResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Service metrics tags: - - Application Metrics + - Application Metrics /api/application-monitoring/services: get: - description: |- + 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. + + 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 (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: Include snapshot ids in the results - in: query - name: includeSnapshotIds - schema: - type: boolean + - 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: 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 + - entityType: SERVICE + id: 79f1430f4a42a707a97621ca00617e40bd51c31d + label: Robot Shop + snapshotIds: + - CywiRxmGIwtQIKezVs-XMcTX2xg + technologies: + - kafkaCluster + types: + - MESSAGING page: 1 pageSize: 1 totalHits: 1 @@ -1229,94 +1308,110 @@ paths: $ref: '#/components/schemas/ServiceResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get services tags: - - Application Resources + - Application Resources /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. + 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`. + + 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. + **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 + - 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 + - ApiKeyAuth: + - ConfigureServiceMapping summary: All Application configurations tags: - - Application Settings + - Application Settings post: - description: |2- + description: >- - For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + 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 + - accessType: READ_WRITE + relationType: GLOBAL + relatedId: null boundaryScope: INBOUND label: Discount Build 6987 scope: INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING @@ -1324,49 +1419,6 @@ paths: 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 @@ -1394,41 +1446,98 @@ paths: 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 + - accessType: READ_WRITE + relationType: GLOBAL + relatedId: null schema: $ref: '#/components/schemas/ApplicationConfig' description: OK security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Add application configuration tags: - - Application Settings + - Application Settings x-description: addApplicationConfig /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. + 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. + **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`.' + - 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. @@ -1437,31 +1546,48 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Delete application configuration tags: - - Application Settings + - Application Settings get: - description: |- - Use this API endpoint if one wants to retrieve an Application Perspective with its configuration setting. + 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`. + + 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. + **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`.' + - in: path + name: id + required: true + schema: + type: string + description: >- + Unique ID of the Application Perspective. Eg: + `Av62RoIKQv-A3n6DbMQh9g`. responses: '200': content: @@ -1474,39 +1600,39 @@ paths: 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 + - 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 + - accessType: READ_WRITE + relationType: GLOBAL + relatedId: null schema: $ref: '#/components/schemas/ApplicationConfig' description: OK @@ -1515,30 +1641,33 @@ paths: '404': description: No config found for provided application id security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Application configuration tags: - - Application Settings + - Application Settings put: - description: |2- + description: >- - For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + 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`.' + - 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 + - accessType: READ + relationType: ROLE boundaryScope: INBOUND id: CxJ55sRbQwqBIfw5DzpRmQ label: Discount Build 1 @@ -1547,49 +1676,6 @@ paths: 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 @@ -1617,68 +1703,131 @@ paths: 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 + - accessType: READ_WRITE + relationType: GLOBAL + relatedId: null schema: $ref: '#/components/schemas/ApplicationConfig' description: OK security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Update application configuration tags: - - Application Settings + - Application Settings x-description: updateApplicationConfig /api/application-monitoring/settings/endpoint: get: - description: |- - Use this API endpoint if one wants to retrieve a list of all endpoint configurations. + 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. + 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 + - 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 + - ApiKeyAuth: + - CanConfigureServiceMapping summary: All Endpoint configurations tags: - - Application Settings + - Application Settings post: - description: |- - Use this API endpoint if one wants to create an endpoint configuration of a service. + 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. + 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: @@ -1707,32 +1856,49 @@ paths: $ref: '#/components/schemas/EndpointConfig' description: OK security: - - ApiKeyAuth: - - CanConfigureServiceMapping + - ApiKeyAuth: + - CanConfigureServiceMapping summary: Create endpoint configuration tags: - - Application Settings + - Application Settings /api/application-monitoring/settings/endpoint/{id}: delete: - description: |- - Use this API endpoint if one wants to delete an endpoint configuration of a service. + 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. + 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. + - 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. @@ -1741,31 +1907,48 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureServiceMapping + - ApiKeyAuth: + - CanConfigureServiceMapping summary: Delete endpoint configuration tags: - - Application Settings + - Application Settings get: - description: |- - Use this API endpoint if one wants to retrieve the endpoint configuration of a service. + 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. + 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. + - 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: @@ -1784,31 +1967,48 @@ paths: '404': description: No config found for provided service id security: - - ApiKeyAuth: - - CanConfigureServiceMapping + - ApiKeyAuth: + - CanConfigureServiceMapping summary: Endpoint configuration tags: - - Application Settings + - Application Settings put: - description: |- - Use this API endpoint if one wants to update an existing endpoint configuration of a service. + 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. + 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. + - 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: @@ -1817,14 +2017,14 @@ paths: endpointNameByCollectedPathTemplateRuleEnabled: true endpointNameByFirstPathSegmentRuleEnabled: true rules: - - enabled: true - pathSegments: - - name: api - type: FIXED - - name: version - type: PARAMETER - testCases: - - /api/v2/users + - enabled: true + pathSegments: + - name: api + type: FIXED + - name: version + type: PARAMETER + testCases: + - /api/v2/users endpointCase: UPPER schema: $ref: '#/components/schemas/EndpointConfig' @@ -1839,35 +2039,45 @@ paths: endpointNameByCollectedPathTemplateRuleEnabled: true endpointNameByFirstPathSegmentRuleEnabled: true rules: - - enabled: true - pathSegments: - - name: api - type: FIXED - - name: version - type: PARAMETER - testCases: - - /api/v2/users + - 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 + - ApiKeyAuth: + - CanConfigureServiceMapping summary: Update endpoint configuration tags: - - Application Settings + - Application Settings /api/application-monitoring/settings/http-endpoint: get: deprecated: true - description: |- - This is a deprecated endpoint. Use `All Endpoint configurations` instead. + 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. + 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': @@ -1878,36 +2088,46 @@ paths: endpointNameByFirstPathSegmentRuleEnabled: true endpointNameByCollectedPathTemplateRuleEnabled: true rules: - - enabled: true - pathSegments: - - name: api - type: FIXED - - name: version - type: PARAMETER - - type: MATCH_ALL - testCases: - - /api/v2/users + - 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 + - ApiKeyAuth: + - ConfigureServiceMapping summary: All HTTP endpoint configurations tags: - - Application Settings + - Application Settings post: deprecated: true - description: |- - This is a deprecated endpoint. Use `Create endpoint configuration` instead. + 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. + 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: @@ -1916,11 +2136,11 @@ paths: endpointNameByCollectedPathTemplateRuleEnabled: true endpointNameByFirstPathSegmentRuleEnabled: true rules: - - enabled: true - pathSegments: - - type: MATCH_ALL - testCases: - - /api/v2/users + - enabled: true + pathSegments: + - type: MATCH_ALL + testCases: + - /api/v2/users serviceId: 20ba31821b079e7d845a08096124880db3eeeb40 schema: $ref: '#/components/schemas/HttpEndpointConfig' @@ -1935,75 +2155,107 @@ paths: endpointNameByFirstPathSegmentRuleEnabled: true endpointNameByCollectedPathTemplateRuleEnabled: true rules: - - enabled: true - pathSegments: - - type: MATCH_ALL - testCases: - - /api/v2/users + - enabled: true + pathSegments: + - type: MATCH_ALL + testCases: + - /api/v2/users schema: $ref: '#/components/schemas/HttpEndpointConfig' description: OK security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Create HTTP endpoint configuration tags: - - Application Settings + - Application Settings /api/application-monitoring/settings/http-endpoint/{id}: delete: deprecated: true - description: |- - This is a deprecated endpoint. Use `Delete endpoint configuration` instead. + 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. + 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. + - 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: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Delete HTTP endpoint configuration tags: - - Application Settings + - Application Settings get: deprecated: true - description: |- + 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. + 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. + - 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: @@ -2012,46 +2264,63 @@ paths: endpointNameByCollectedPathTemplateRuleEnabled: true endpointNameByFirstPathSegmentRuleEnabled: true rules: - - enabled: true - pathSegments: - - name: api - type: FIXED - - name: version - type: PARAMETER - - type: MATCH_ALL - testCases: - - /api/v2/users + - 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 + - ApiKeyAuth: + - ConfigureServiceMapping summary: HTTP Endpoint configuration tags: - - Application Settings + - Application Settings put: deprecated: true - description: |- - This is a deprecated endpoint. Use `Update endpoint configuration` instead. + 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. + 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. + - 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: @@ -2059,15 +2328,15 @@ paths: endpointNameByCollectedPathTemplateRuleEnabled: true endpointNameByFirstPathSegmentRuleEnabled: true rules: - - enabled: true - pathSegments: - - name: api - type: FIXED - - name: version - type: PARAMETER - - type: MATCH_ALL - testCases: - - /api/v2/users + - 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' @@ -2081,67 +2350,69 @@ paths: endpointNameByCollectedPathTemplateRuleEnabled: true endpointNameByFirstPathSegmentRuleEnabled: true rules: - - enabled: true - pathSegments: - - name: api - type: FIXED - - name: version - type: PARAMETER - - type: MATCH_ALL - testCases: - - /api/v2/users + - 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 + - ApiKeyAuth: + - ConfigureServiceMapping summary: Update HTTP endpoint configuration tags: - - Application Settings + - Application Settings /api/application-monitoring/settings/manual-service: get: - description: |2- + description: >- - For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + 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 + - 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 + - ApiKeyAuth: + - ConfigureServiceMapping summary: All manual service configurations tags: - - Application Settings + - Application Settings x-description: getAllManualServiceConfigs post: - description: |2- + description: >- - For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + 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: @@ -2188,46 +2459,25 @@ paths: $ref: '#/components/schemas/ManualServiceConfig' description: OK security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Add manual service configuration tags: - - Application Settings + - Application Settings x-description: addManualServiceConfigs put: - description: |2- + description: >- - For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + 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 + - description: Map source service + enabled: true + existingServiceId: c467ca0fa21477fee3cde75a140b2963307388a7 tagFilterExpression: type: TAG_FILTER name: service.name @@ -2239,59 +2489,82 @@ paths: operator: EQUALS entity: SOURCE unmonitoredServiceName: null - existingServiceId: c467ca0fa21477fee3cde75a140b2963307388a7 - description: Map source service - enabled: true + 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 + - ApiKeyAuth: + - ConfigureServiceMapping summary: Replace all manual service configurations tags: - - Application Settings + - Application Settings x-description: replaceAllManualServiceConfigs /api/application-monitoring/settings/manual-service/{id}: delete: - description: |2- + description: >- - For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + 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. + - in: path + name: id + required: true + schema: + type: string + description: A unique id of the manual service configuration. responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Delete manual service configuration tags: - - Application Settings + - Application Settings x-description: deleteManualServiceConfigs put: - description: |2- + description: >- - For more information on Application Settings please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-settings. + 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. + - in: path + name: id + required: true + schema: + type: string + description: A unique id of the manual service configuration. requestBody: content: application/json: @@ -2338,62 +2611,86 @@ paths: $ref: '#/components/schemas/ManualServiceConfig' description: OK security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Update manual service configuration tags: - - Application Settings + - Application Settings x-description: updateManualServiceConfigs /api/application-monitoring/settings/service: get: - description: |- - Use this API endpoint if one wants to retrive a list of all service configurations. + 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. + 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: .* + - 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 + - ApiKeyAuth: + - ConfigureServiceMapping summary: All service configurations tags: - - Application Settings + - Application Settings post: - description: |- + 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`. + + 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. + + - 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. + + 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: @@ -2403,10 +2700,10 @@ paths: enabled: true label: '{gce.zone}-{jvm.args.abc}' matchSpecification: - - key: gce.zone - value: .* - - key: jvm.args.abc - value: .* + - key: gce.zone + value: .* + - key: jvm.args.abc + value: .* name: ABC is good schema: $ref: '#/components/schemas/ServiceConfig' @@ -2423,41 +2720,51 @@ paths: label: '{gce.zone}-{jvm.args.abc}' enabled: true matchSpecification: - - key: gce.zone - value: .* - - key: jvm.args.abc - value: .* + - key: gce.zone + value: .* + - key: jvm.args.abc + value: .* schema: $ref: '#/components/schemas/ServiceConfig' description: OK security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Add service configuration tags: - - Application Settings + - Application Settings put: - description: |- - Use this API endpoint if one wants to modify 1 or more existing service configuration. + 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. + 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 + - comment: null + enabled: true + id: 8C-jGYx8Rsue854tzkh8KQ + label: '{docker.container.name}' + matchSpecification: + - key: docker.container.name + value: .* + name: Rule schema: type: array items: @@ -2468,43 +2775,55 @@ paths: content: application/json: example: - - id: 9uma4MhnTTSyBzwu_FKBJA - name: Rule - comment: null - label: '{docker.container.name}' - enabled: true - matchSpecification: - - key: docker.container.name - value: .* + - 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 + - ApiKeyAuth: + - ConfigureServiceMapping summary: Replace all service configurations tags: - - Application Settings + - Application Settings /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. + 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. + 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 + - 9uma4MhnTTSyBzwu_FKBJA + - oMsVfR0fSCuTKF2TFdYRmQ schema: type: array items: @@ -2520,58 +2839,80 @@ paths: '403': description: Insufficient permissions. security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Order of service configuration tags: - - Application Settings + - Application Settings /api/application-monitoring/settings/service/{id}: delete: - description: |- + 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. + 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`' + - in: path + name: id + required: true + schema: + type: string + description: >- + A unique string for the service configuration. Eg: + `G510hmXYSDysLZ5kuj0BaQ` responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Delete service configuration tags: - - Application Settings + - Application Settings get: - description: |- - Use this API endpoint if one wants to retrieve a particular custom service rule. + 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. + 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`' + - in: path + name: id + required: true + schema: + type: string + description: >- + A unique string for the service configuration. Eg: + `G510hmXYSDysLZ5kuj0BaQ` responses: '200': content: @@ -2583,8 +2924,8 @@ paths: label: '{docker.container.name}' enabled: true matchSpecification: - - key: docker.container.name - value: .* + - key: docker.container.name + value: .* schema: $ref: '#/components/schemas/ServiceConfig' description: OK @@ -2595,28 +2936,40 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Service configuration tags: - - Application Settings + - Application Settings put: - description: |- - Use this API endpoint if one wants to update a particular custom service rule. + 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. + 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`' + - in: path + name: id + required: true + schema: + type: string + description: >- + A unique string for the service configuration. Eg: + `G510hmXYSDysLZ5kuj0BaQ` requestBody: content: application/json: @@ -2626,10 +2979,10 @@ paths: id: 9uma4MhnTTSyBzwu_FKBJA label: '{gce.zone}-{jvm.args.abc}' matchSpecification: - - key: gce.zone - value: .* - - key: jvm.args.abc - value: .* + - key: gce.zone + value: .* + - key: jvm.args.abc + value: .* name: DEF is good schema: $ref: '#/components/schemas/ServiceConfig' @@ -2645,80 +2998,90 @@ paths: label: '{gce.zone}-{jvm.args.abc}' enabled: true matchSpecification: - - key: gce.zone - value: .* - - key: jvm.args.abc - value: .* + - key: gce.zone + value: .* + - key: jvm.args.abc + value: .* schema: $ref: '#/components/schemas/ServiceConfig' description: OK security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Update service configuration tags: - - Application Settings + - Application Settings /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. + 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 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 + - 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 + - from: 8bfb4e1aa590eab8f08f837b97acf5803a5737ed + to: f17e7efb3b9b2d62bfec6b07905759fb81e99797 + calls: 2179 + latency: 1.6103717301514455 + errorRate: 0 services: - - id: f17e7efb3b9b2d62bfec6b07905759fb81e99797 - label: robot-shop - types: - - MESSAGING - technologies: - - kubernetesService - - rabbitMq - snapshotIds: [ - ] - entityType: SERVICE + - id: f17e7efb3b9b2d62bfec6b07905759fb81e99797 + label: robot-shop + types: + - MESSAGING + technologies: + - kubernetesService + - rabbitMq + snapshotIds: [] + entityType: SERVICE schema: $ref: '#/components/schemas/ServiceMap' description: OK @@ -2729,84 +3092,99 @@ paths: '403': description: Forbidden security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Gets the service topology tags: - - Application Topology + - Application Topology /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. + 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. - minLength: 1 - - 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`. + - in: path + name: id + required: true + schema: + type: string + description: An Instana generated unique identifier for a trace. + minLength: 1 + - 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 + - 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 @@ -2815,34 +3193,38 @@ paths: $ref: '#/components/schemas/TraceDownloadResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get trace detail tags: - - Application Analyze + - Application Analyze /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. + 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. + + 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. - minLength: 1 - - in: path - name: callId - required: true - schema: - type: string - description: 'The call ID. A unique identifier for an individual call. For - example: `1bcad5c82338deaf`.' - minLength: 1 + - in: path + name: traceId + required: true + schema: + type: string + description: An Instana generated unique identifier for a trace. + minLength: 1 + - in: path + name: callId + required: true + schema: + type: string + description: >- + The call ID. A unique identifier for an individual call. For + example: `1bcad5c82338deaf`. + minLength: 1 responses: '200': content: @@ -2858,8 +3240,7 @@ paths: batchSize: 1 batchSelfTime: 3597 source: - applications: [ - ] + applications: [] service: id: ROOT label: '' @@ -2867,11 +3248,9 @@ paths: id: XCjGvnwuiak0m3ISke3naE-NrGA label: Unspecified type: UNDEFINED - physicalContext: { - } + physicalContext: {} destination: - applications: [ - ] + applications: [] service: id: ce4b152bac7b99744d8314838e49b799afd6dd96 label: nginx-web @@ -2887,47 +3266,53 @@ paths: 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: [ - ] + - 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 + - ApiKeyAuth: + - Default summary: Get call detail tags: - - Application Analyze + - Application Analyze /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`. + 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. + + 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: @@ -2936,8 +3321,8 @@ paths: includeInternal: true includeSynthetic: true metrics: - - aggregation: MEAN - metric: latency + - aggregation: MEAN + metric: latency tagFilterExpression: type: TAG_FILTER name: service.name @@ -2956,8 +3341,8 @@ paths: example: metrics: latency.mean: - - - 1669190580000 - - 106.85055708882756 + - - 1669190580000 + - 106.85055708882756 adjustedTimeframe: windowSize: 3600000 to: 1669190580000 @@ -2965,97 +3350,105 @@ paths: $ref: '#/components/schemas/MetricAPIResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Application Data Metrics tags: - - Application Metrics + - Application Metrics /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. + 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: + - 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 - - 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: @@ -3070,150 +3463,160 @@ paths: '500': description: The request do not contain a valid user or API Token. security: - - ApiKeyAuth: - - canDeleteAutomationActionHistory + - ApiKeyAuth: + - canDeleteAutomationActionHistory summary: Delete automation action run results. tags: - - Action History + - Action History 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. + 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: + - 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 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: + - 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: Action IDs filter to get the action run result details for only - these actions - in: query - name: actionIds - schema: - type: array - items: + - description: Sort order direction. + example: asc or desc + in: query + name: orderDirection + schema: 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: [ - ] + - 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 @@ -3223,16 +3626,20 @@ paths: '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. + - ApiKeyAuth: + - Default + summary: >- + Get the details of automation action run results from action run + history. tags: - - Action History + - Action History 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. + 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: @@ -3242,9 +3649,9 @@ paths: actionId: d473c1b0-0740-4d08-95fe-31e5d0a9faff policyId: 2nIOVtEW-iPbsEIi89-yDqJabc inputParameters: - - name: name - type: type - value: value + - name: name + type: type + value: value eventId: M3wuBxuaSDyecZJ7ICioiw async: 'true' timeout: '600' @@ -3267,12 +3674,9 @@ paths: problemText: Test event hostSnapshotId: 2nIOVtEW-iPbsEIi89-yDqJHi2g targetSnapshotId: jfSmhACY-Oa3a8zfjJxvOxJeDSk - inputParameters: [ - ] - outputParameters: [ - ] - metadata: [ - ] + inputParameters: [] + outputParameters: [] + metadata: [] externalSourceType: '' actorId: 5ee5195fbea6150001758c40 actorName: Stan @@ -3284,53 +3688,58 @@ paths: $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) + 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 + - ApiKeyAuth: + - canRunAutomationActions summary: Run an automation action. tags: - - Action History + - Action History /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 + 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 + - 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: @@ -3339,57 +3748,63 @@ paths: 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. + 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. + - ApiKeyAuth: + - canDeleteAutomationActionHistory + summary: >- + Deletes an automation action run result from the action run history by + ID. tags: - - Action History + - Action History 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. + 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 + - 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: @@ -3409,12 +3824,9 @@ paths: eventSpecificationId: en0FW6XRWu7aRsD4055dbMLAuSU problemText: Test event hostSnapshotId: 2nIOVtEW-iPbsEIi89-yDqJHi2g - inputParameters: [ - ] - outputParameters: [ - ] - metadata: [ - ] + inputParameters: [] + outputParameters: [] + metadata: [] targetSnapshotId: jfSmhACY-Oa3a8zfjJxvOxJeDSk externalSourceType: '' actorId: 5ee5195fbea6150001758c40 @@ -3432,50 +3844,51 @@ paths: '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. + - ApiKeyAuth: + - Default + summary: >- + Get the details of an automation action run result by ID from action run + history. tags: - - Action History + - Action History /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. + 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 + - 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: 1694442511.129923 + modifiedAt: 1703191040.321448 schema: type: array items: @@ -3486,26 +3899,27 @@ paths: '500': description: Failed to retrieve the automation actions. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all automation actions. tags: - - Action Catalog + - Action Catalog /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. + 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 + - description: Automation action ID + example: d473c1b0-0740-4d08-95fe-31e5d0a9faff + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -3516,27 +3930,26 @@ paths: 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: [ - ] + - 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 + - Test + createdAt: 1694442511.129923 + modifiedAt: 1703191040.321448 schema: $ref: '#/components/schemas/Action' description: Automation action is returned. @@ -3545,35 +3958,36 @@ paths: '404': description: Automation action not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get an automation action by ID. tags: - - Action Catalog + - Action Catalog /api/automation/ai/action/match: get: - description: Get automation actions that match based on application ID or snapshot - ID within a specified time window. + 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 + - 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: @@ -3584,34 +3998,35 @@ paths: $ref: '#/components/schemas/ActionMatch' description: The automation actions that match are returned. '400': - description: Either applicationId or snapshotId must be provided, but not - both. + 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 + - ApiKeyAuth: + - Default summary: Get action matches by application ID or snapshot ID. tags: - - Action Catalog + - Action Catalog post: - description: Get automation actions that match the incident or issue data in - the request body. + 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 + - 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. + description: >- + Checks whether the system spends significant time waiting for + input/output. schema: $ref: '#/components/schemas/ActionSearchSpace' required: true @@ -3620,37 +4035,36 @@ paths: 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 + - 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: 1694442511.129923 + modifiedAt: 1703191040.321448 + color: low + confidence: low + aiEngine: NLP schema: type: array items: @@ -3661,11 +4075,11 @@ paths: '500': description: Failed to retrieve the matching automation actions. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get automation actions that match the incidents or issues. tags: - - Action Catalog + - Action Catalog /api/automation/parameters/dynamic: put: operationId: resolve @@ -3676,8 +4090,8 @@ paths: eventId: 7UPTIakhR3uVaMnSQuG3TA timestamp: 1710168530000 parameters: - - name: Application name - tagName: application.name + - name: Application name + tagName: application.name schema: $ref: '#/components/schemas/GetDynamicParameterValues' required: true @@ -3689,20 +4103,20 @@ paths: eventId: 7UPTIakhR3uVaMnSQuG3TA timestamp: 1710168530000 parameters: - - name: Application name - tagName: application.name - resolvedValue: '["Demo Application"]' + - name: Application name + tagName: application.name + resolvedValue: '["Demo Application"]' schema: $ref: '#/components/schemas/GetDynamicParameterValues' description: OK '500': description: Internal server error security: - - ApiKeyAuth: - - canRunAutomationActions + - ApiKeyAuth: + - canRunAutomationActions summary: Resolve dynamic parameter values tags: - - Action Catalog + - Action Catalog /api/automation/parameters/dynamic/catalog: get: operationId: getDynamicParametersTagCatalog @@ -3712,116 +4126,120 @@ paths: 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 + - 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 + - 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 + - ApiKeyAuth: + - Default summary: Get tag catalog for dynamic parameters tags: - - Action Catalog + - Action Catalog x-description: getDynamicParametersTagCatalog /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. + 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 + - 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: 1694442511.129923 + modifiedAt: 1703191040.321448 schema: type: array items: @@ -3832,13 +4250,14 @@ paths: '500': description: Failed to retrieve the automation policies. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all automation policies. tags: - - Policies + - Policies post: - description: Creates a new automation policy. Policy creation requires `Configuration + description: >- + Creates a new automation policy. Policy creation requires `Configuration of automation policies` permission. operationId: addPolicy requestBody: @@ -3851,14 +4270,14 @@ paths: 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 + - 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 @@ -3875,39 +4294,38 @@ paths: 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 + - 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: 1694442511.129923 + modifiedAt: 1703191040.321448 schema: $ref: '#/components/schemas/Policy' description: New policy created. @@ -3920,14 +4338,15 @@ paths: '500': description: Internal Server Error. security: - - ApiKeyAuth: - - canConfigureAutomationPolicies + - ApiKeyAuth: + - canConfigureAutomationPolicies summary: Create an automation policy. tags: - - Policies + - Policies /api/automation/policies/bulk: post: - description: Creates a list of automation policies. Policy creation requires + description: >- + Creates a list of automation policies. Policy creation requires `Configuration of automation policies` permission. operationId: addPolicies requestBody: @@ -3956,26 +4375,27 @@ paths: '500': description: Internal Server Error. security: - - ApiKeyAuth: - - canConfigureAutomationPolicies + - ApiKeyAuth: + - canConfigureAutomationPolicies summary: Create automation policies. tags: - - Policies + - Policies /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. + 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 + - 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 @@ -3984,25 +4404,27 @@ paths: '404': description: Automation policy not found. security: - - ApiKeyAuth: - - canConfigureAutomationPolicies + - ApiKeyAuth: + - canConfigureAutomationPolicies summary: Deletes an automation policy by identifier. tags: - - Policies + - Policies 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. + 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 + - description: Automation policy ID + example: a14700b0-401b-47eb-a751-deda0035fde3 + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -4016,39 +4438,38 @@ paths: 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 + - 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: 1694442511.129923 + modifiedAt: 1703191040.321448 schema: $ref: '#/components/schemas/Policy' description: Automation policy filtered by the ID in request parameter. @@ -4057,23 +4478,24 @@ paths: '404': description: Automation policy not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get an automation policy by ID. tags: - - Policies + - Policies 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. + 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 + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -4084,14 +4506,14 @@ paths: 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 + - 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 @@ -4108,39 +4530,38 @@ paths: 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 + - 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: 1694442511.129923 + modifiedAt: 1703191040.321448 schema: $ref: '#/components/schemas/Policy' description: Automation policy successfully updated. @@ -4153,11 +4574,11 @@ paths: '500': description: Server Error. security: - - ApiKeyAuth: - - canConfigureAutomationPolicies + - ApiKeyAuth: + - canConfigureAutomationPolicies summary: Updates an automation policy by identifier. tags: - - Policies + - Policies /api/business-monitoring/activities: post: operationId: getActivities @@ -4175,11 +4596,11 @@ paths: $ref: '#/components/schemas/CursorPaginatedBusinessActivityItem' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Business Activities tags: - - Business Monitoring + - Business Monitoring /api/business-monitoring/activities/csv: post: operationId: getActivitiesCsv @@ -4197,11 +4618,11 @@ paths: $ref: '#/components/schemas/BusinessActivity' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Download Business Activities tags: - - Business Monitoring + - Business Monitoring /api/business-monitoring/business-perspectives: get: operationId: getBusinessPerspectives @@ -4210,50 +4631,50 @@ paths: 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 + - 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: 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 + - 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 + - ApiKeyAuth: + - Default summary: Get all business perspectives tags: - - Business Monitoring + - Business Monitoring post: operationId: createBusinessPerspective requestBody: @@ -4264,36 +4685,36 @@ paths: name: biz-perspective description: This is an example business perspective rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 tagFilterExpression: type: EXPRESSION logicalOperator: AND elements: - - type: EXPRESSION - logicalOperator: AND - elements: - type: EXPRESSION - logicalOperator: OR + logicalOperator: AND 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 + - 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 @@ -4308,75 +4729,74 @@ paths: name: biz-perspective description: This is an example business perspective rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 tagFilterExpression: type: EXPRESSION logicalOperator: AND elements: - - type: EXPRESSION - logicalOperator: AND - elements: - type: EXPRESSION - logicalOperator: OR + logicalOperator: AND 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 + - 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 + - ApiKeyAuth: + - Default summary: Create business perspective tags: - - Business Monitoring + - Business Monitoring x-description: createBusinessPerspective /api/business-monitoring/business-perspectives/{id}: delete: operationId: deleteBusinessPerspective parameters: - - in: path - name: id - required: true - schema: - type: string + - in: path + name: id + required: true + schema: + type: string responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Delete business perspective tags: - - Business Monitoring + - Business Monitoring get: operationId: getBusinessPerspective parameters: - - in: path - name: id - required: true - schema: - type: string + - in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -4387,53 +4807,53 @@ paths: name: biz-perspective description: This is an example business perspective rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 tagFilterExpression: type: EXPRESSION logicalOperator: AND elements: - - type: EXPRESSION - logicalOperator: AND - elements: - type: EXPRESSION - logicalOperator: OR + logicalOperator: AND 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 + - 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 + - ApiKeyAuth: + - Default summary: Get business perspective tags: - - Business Monitoring + - Business Monitoring put: operationId: updateBusinessPerspective parameters: - - in: path - name: id - required: true - schema: - type: string + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -4441,36 +4861,36 @@ paths: label: biz-perspective name: biz-perspective rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 tagFilterExpression: type: EXPRESSION logicalOperator: AND elements: - - type: EXPRESSION - logicalOperator: AND - elements: - type: EXPRESSION - logicalOperator: OR + logicalOperator: AND 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 + - 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 @@ -4485,234 +4905,233 @@ paths: name: biz-perspective description: This is an example business perspective rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 tagFilterExpression: type: EXPRESSION logicalOperator: AND elements: - - type: EXPRESSION - logicalOperator: AND - elements: - type: EXPRESSION - logicalOperator: OR + logicalOperator: AND 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 + - 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 + - ApiKeyAuth: + - Default summary: Update business perspective tags: - - Business Monitoring + - Business Monitoring x-description: updateBusinessPerspective /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_ADAPTIVE_BASELINE_FAST_INIT - - SMART_ALERTS_CUSTOM_PAYLOAD - - SLI_MANAGEMENT - - APPLICATION_CONFIG - - APPLICATION_CONFIG_BLUEPRINT - - MAINTENANCE_WINDOWS - - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + - 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_ADAPTIVE_BASELINE_FAST_INIT + - 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 + - label: Region or Environment 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 + - 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 - type: LEVEL - queryable: false - - label: custom - description: null - icon: null - children: - - label: HTTP + - label: custom 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 + - 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 - - 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: [ - ] + tags: [] schema: $ref: '#/components/schemas/TagCatalog' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get business tag catalog tags: - - Business Monitoring + - Business Monitoring x-description: getBusinessTagCatalog /api/cassandra/metrics: post: @@ -4732,69 +5151,72 @@ paths: description: OK summary: Cassandra metrics tags: - - Infrastructure Metrics + - Infrastructure Metrics x-description: getCassandraMetrics /api/custom-dashboard: get: - description: |- + 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. + + 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 + - 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 + - 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 + - ApiKeyAuth: + - Default summary: Get accessible custom dashboards tags: - - Custom Dashboards + - Custom Dashboards post: - description: |2- + description: >- - For more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#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: addCustomDashboard requestBody: content: @@ -4810,110 +5232,119 @@ paths: $ref: '#/components/schemas/CustomDashboard' description: OK '403': - description: When attempting to share dashboards without the canCreatePublicCustomDashboards - permission. + description: >- + When attempting to share dashboards without the + canCreatePublicCustomDashboards permission. '422': description: When the custom dashboard payload is invalid. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Add custom dashboard tags: - - Custom Dashboards + - Custom Dashboards /api/custom-dashboard/shareable-api-tokens: get: - description: |- + 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. + + 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 + - 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 + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - CreatePublicCustomDashboards summary: Get all API tokens. tags: - - Custom Dashboards + - Custom Dashboards /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. + 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 + - 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 + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - CreatePublicCustomDashboards summary: Get all users (without invitations). tags: - - Custom Dashboards + - Custom Dashboards /api/custom-dashboard/{customDashboardId}: delete: - description: |2- + description: >- - For more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#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: deleteCustomDashboard parameters: - - in: path - name: customDashboardId - required: true - schema: - type: string + - in: path + name: customDashboardId + required: true + schema: + type: string responses: '204': description: Custom dashboard successfully removed security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Remove custom dashboard tags: - - Custom Dashboards + - Custom Dashboards get: - description: |- + 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. + + 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 + - description: customDashboardId + example: alHaYV5aSkKku_wcg53teQ + in: path + name: customDashboardId + required: true + schema: + type: string responses: '200': content: @@ -4970,25 +5401,27 @@ paths: "ownerId": {string} } schema: - $ref: '#/components/schemas/CustomDashboardWithUserSpecificInformation' + $ref: >- + #/components/schemas/CustomDashboardWithUserSpecificInformation description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get custom dashboard tags: - - Custom Dashboards + - Custom Dashboards put: - description: |2- + description: >- - For more information on custom dashboards please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#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: updateCustomDashboard parameters: - - in: path - name: customDashboardId - required: true - schema: - type: string + - in: path + name: customDashboardId + required: true + schema: + type: string requestBody: content: application/json: @@ -5003,16 +5436,17 @@ paths: $ref: '#/components/schemas/CustomDashboard' description: OK '403': - description: When attempting to share dashboards without the canCreatePublicCustomDashboards - permission. + description: >- + When attempting to share dashboards without the + canCreatePublicCustomDashboards permission. '422': description: When the custom dashboard payload is invalid. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Update custom dashboard tags: - - Custom Dashboards + - Custom Dashboards /api/custom-entitytypes: get: description: This end point lists custom Entity Type Definition @@ -5025,11 +5459,11 @@ paths: $ref: '#/components/schemas/CustomEntityWithMetadata' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: List custom Entity Type Definition tags: - - Custom Entities + - Custom Entities post: description: This end point creates a custom entity type operationId: createCustomEntities @@ -5047,23 +5481,23 @@ paths: $ref: '#/components/schemas/CustomEntityWithMetadata' description: OK security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canConfigureCustomEntities + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureCustomEntities summary: Create a Custom Entity type tags: - - Custom Entities + - Custom Entities /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 + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -5078,22 +5512,22 @@ paths: $ref: '#/components/schemas/CustomEntityWithMetadata' description: Entity Deleted security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canConfigureCustomEntities + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureCustomEntities summary: Delete a Custom Entity Type tags: - - Custom Entities + - Custom Entities get: description: This endpoint gets custom Entity Type by ID operationId: getCustomEntity parameters: - - in: path - name: id - required: true - schema: - type: string + - in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -5102,20 +5536,20 @@ paths: $ref: '#/components/schemas/CustomEntityWithMetadata' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get custom Entity Types tags: - - Custom Entities + - Custom Entities 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 + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -5130,13 +5564,13 @@ paths: $ref: '#/components/schemas/CustomEntityWithMetadata' description: OK security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canConfigureCustomEntities + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureCustomEntities summary: Update a Custom Entity Type tags: - - Custom Entities + - Custom Entities /api/encrypt: post: operationId: encrypt @@ -5154,20 +5588,20 @@ paths: description: default response /api/eum/impact/report/{eventId}: get: - description: Gets a report of users impacted by an event which was created from - a smart alert violation + 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 + - in: path + name: eventId + required: true + schema: + type: string responses: '200': content: - text/csv: { - } + text/csv: {} description: OK '401': description: Unauthorized access - requires user authentication. @@ -5178,11 +5612,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get impacted users report tags: - - End User Monitoring + - End User Monitoring /api/evaluator: get: description: Fetch all evaluator configurations for the current tenant unit. @@ -5195,13 +5629,14 @@ paths: $ref: '#/components/schemas/Evaluator' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all evaluators tags: - - LLM Evaluation + - LLM Evaluation put: - description: Create a new evaluator or update an existing one. Returns the evaluator + description: >- + Create a new evaluator or update an existing one. Returns the evaluator ID. operationId: upsertEvaluator requestBody: @@ -5221,23 +5656,23 @@ paths: $ref: '#/components/schemas/Evaluator' description: OK security: - - ApiKeyAuth: - - CanConfigureGenAiEvaluations + - ApiKeyAuth: + - CanConfigureGenAiEvaluations summary: Create or update evaluator tags: - - LLM Evaluation + - LLM Evaluation /api/evaluator/{evaluatorId}: delete: description: Delete an evaluator configuration by its ID. operationId: deleteEvaluator parameters: - - in: path - name: evaluatorId - required: true - schema: - type: string - description: Evaluator ID - example: 123e4567-e89b-12d3-a456-426614174000 + - in: path + name: evaluatorId + required: true + schema: + type: string + description: Evaluator ID + example: 123e4567-e89b-12d3-a456-426614174000 responses: '204': description: No Content - Successfully deleted @@ -5246,22 +5681,22 @@ paths: '500': description: Internal Server Error security: - - ApiKeyAuth: - - CanConfigureGenAiEvaluations + - ApiKeyAuth: + - CanConfigureGenAiEvaluations summary: Delete evaluator tags: - - LLM Evaluation + - LLM Evaluation get: description: Fetch a specific evaluator by its ID. operationId: getEvaluator parameters: - - in: path - name: evaluatorId - required: true - schema: - type: string - description: Evaluator ID - example: 123e4567-e89b-12d3-a456-426614174000 + - in: path + name: evaluatorId + required: true + schema: + type: string + description: Evaluator ID + example: 123e4567-e89b-12d3-a456-426614174000 responses: '200': content: @@ -5272,24 +5707,25 @@ paths: '404': description: Not Found security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get evaluator by ID tags: - - LLM Evaluation + - LLM Evaluation /api/evaluator/{evaluatorId}/reset: post: - description: Reset a built-in evaluator to its system default configuration - by soft-deleting the user's customized version. + description: >- + Reset a built-in evaluator to its system default configuration by + soft-deleting the user's customized version. operationId: resetEvaluator parameters: - - in: path - name: evaluatorId - required: true - schema: - type: string - description: Evaluator ID - example: 123e4567-e89b-12d3-a456-426614174000 + - in: path + name: evaluatorId + required: true + schema: + type: string + description: Evaluator ID + example: 123e4567-e89b-12d3-a456-426614174000 responses: '204': description: No Content - Successfully reset @@ -5301,133 +5737,140 @@ paths: description: Internal Server Error summary: Reset built-in evaluator tags: - - LLM Evaluation + - LLM Evaluation /api/events: get: - description: 'Get all Events within a timeframe. The timeframe is defined as - `[from, to]` or `[to - windowSize, to]`. ' + 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 - - description: Option to include event metadata - example: true - in: query - name: includeMetadata - schema: - type: boolean + - 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 + - description: Option to include event metadata + example: true + in: query + name: includeMetadata + schema: + type: boolean 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 + - 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 - 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: { - } + 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: @@ -5436,27 +5879,27 @@ paths: '400': description: Bad request. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all Events tags: - - Events + - Events post: description: 'Gets a set of events by their IDs. ' operationId: getEventsByIds parameters: - - description: Option to include event metadata - example: true - in: query - name: includeMetadata - schema: - type: boolean + - description: Option to include event metadata + example: true + in: query + name: includeMetadata + schema: + type: boolean requestBody: content: application/json: example: - - VOMNl0OgRv2HXlsR0iUYGg - - h66yezD9Sfi5YNh_cmeG7Q + - VOMNl0OgRv2HXlsR0iUYGg + - h66yezD9Sfi5YNh_cmeG7Q schema: type: array items: @@ -5467,47 +5910,48 @@ paths: 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 + - 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: @@ -5518,82 +5962,93 @@ paths: '422': description: Unprocessable entity. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Events by IDs tags: - - Events + - Events /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]`. ' + 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 + - 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 + - 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: @@ -5602,78 +6057,89 @@ paths: '404': description: The events do not exist in the timeframe. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Agent Monitoring Events tags: - - Events + - Events /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]`. ' + 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 + - 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 + - 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: @@ -5682,19 +6148,21 @@ paths: '404': description: The events do not exist in the timeframe. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Kubernetes Info Events tags: - - Events + - Events /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. + 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: @@ -5702,13 +6170,13 @@ paths: example: configs: WEBSITE: - - id1 - - id2 + - id1 + - id2 APPLICATION: - - id3 - - id4 + - id3 + - id4 INFRA: - - id5 + - id5 schema: $ref: '#/components/schemas/BulkAlertConfigRequest' description: Map of alert config types to sets of IDs to delete @@ -5721,22 +6189,23 @@ paths: '401': description: Unauthorized - No valid authentication provided '403': - description: Forbidden - Missing required permissions for one or more alert + description: >- + Forbidden - Missing required permissions for one or more alert config types security: - - ApiKeyAuth: [ - ] + - ApiKeyAuth: [] summary: Bulk delete alert configurations across multiple types tags: - - Event Settings - - Events + - Event Settings + - Events /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. + 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: @@ -5744,13 +6213,13 @@ paths: example: configs: WEBSITE: - - id1 - - id2 + - id1 + - id2 APPLICATION: - - id3 - - id4 + - id3 + - id4 INFRA: - - id5 + - id5 schema: $ref: '#/components/schemas/BulkAlertConfigRequest' description: Map of alert config types to sets of IDs to disable @@ -5763,22 +6232,23 @@ paths: '401': description: Unauthorized - No valid authentication provided '403': - description: Forbidden - Missing required permissions for one or more alert + description: >- + Forbidden - Missing required permissions for one or more alert config types security: - - ApiKeyAuth: [ - ] + - ApiKeyAuth: [] summary: Bulk disable alert configurations across multiple types tags: - - Event Settings - - Events + - Event Settings + - Events /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. + 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: @@ -5786,13 +6256,13 @@ paths: example: configs: WEBSITE: - - id1 - - id2 + - id1 + - id2 APPLICATION: - - id3 - - id4 + - id3 + - id4 INFRA: - - id5 + - id5 schema: $ref: '#/components/schemas/BulkAlertConfigRequest' description: Map of alert config types to sets of IDs to enable @@ -5805,65 +6275,67 @@ paths: '401': description: Unauthorized - No valid authentication provided '403': - description: Forbidden - Missing required permissions for one or more alert + description: >- + Forbidden - Missing required permissions for one or more alert config types security: - - ApiKeyAuth: [ - ] + - ApiKeyAuth: [] summary: Bulk enable alert configurations across multiple types tags: - - Event Settings - - Events + - Event Settings + - Events /api/events/settings/alertingChannels: get: - description: Gets all the alerting channels. Requires the permission called + 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 + - 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 + - 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 + - ApiKeyAuth: + - CanConfigureIntegrations summary: Get all Alerting Channels tags: - - Event Settings + - Event Settings post: - description: Creates an alerting channel. Requires the permission called CanConfigureIntegrations. + description: >- + Creates an alerting channel. Requires the permission called + CanConfigureIntegrations. operationId: postAlertingChannel requestBody: content: @@ -5880,14 +6352,15 @@ paths: name: Email Alert Channel customEmailSubjectPrefix: null emails: - - youremail@email.com + - 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 ' + description: >- + Redirect to the integration service for continuing the configuration + with the 3rd party system '400': content: application/json: @@ -5895,71 +6368,71 @@ paths: type: string description: Failed creating the alert channel setting security: - - ApiKeyAuth: - - CanConfigureIntegrations + - ApiKeyAuth: + - CanConfigureIntegrations summary: Create Alert Channel tags: - - Event Settings + - Event Settings /api/events/settings/alertingChannels/infos: get: - description: Gets the overview information of all alerting channels. Requires - the permission called CanConfigureIntegrations. + 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 + - 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 + - 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 + - ApiKeyAuth: + - CanConfigureIntegrations summary: Get Overview of Alerting Channels tags: - - Event Settings + - Event Settings /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 + 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 + - 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: @@ -5969,20 +6442,21 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureIntegrations - summary: Notify manually to Alerting Channel. Requires the permission called + - ApiKeyAuth: + - CanConfigureIntegrations + summary: >- + Notify manually to Alerting Channel. Requires the permission called CanConfigureIntegrations. tags: - - Event Settings + - Event Settings /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 + 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: @@ -6006,47 +6480,52 @@ paths: description: Success value: status: success - message: Alerting Channel was successfully triggered, please check + message: >- + Alerting Channel was successfully triggered, please check the channel! description: Test alerting channel response security: - - ApiKeyAuth: - - CanConfigureIntegrations + - ApiKeyAuth: + - CanConfigureIntegrations summary: Test Alerting Channel tags: - - Event Settings + - Event Settings /api/events/settings/alertingChannels/{id}: delete: - description: Deletes an alert channel. Requires the permission called CanConfigureIntegrations. + 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 + - 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 + - ApiKeyAuth: + - CanConfigureIntegrations summary: Delete Alerting Channel tags: - - Event Settings + - Event Settings get: - description: Gets an alerting channel. Requires the permission called CanConfigureIntegrations. + 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 + - description: ID of the Alerting Channel to get. + example: YbcFlaG8k5oIkxD0 + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -6056,28 +6535,30 @@ paths: name: Email Alert Channel customEmailSubjectPrefix: null emails: - - youremail@email.com + - youremail@email.com kind: EMAIL schema: $ref: '#/components/schemas/AbstractIntegration' description: OK security: - - ApiKeyAuth: - - CanConfigureIntegrations + - ApiKeyAuth: + - CanConfigureIntegrations summary: Get Alerting Channel tags: - - Event Settings + - Event Settings put: - description: Updates an alerting channel. Requires the permission called CanConfigureIntegrations. + 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 + - description: ID of the Alerting Channel to update. + example: YbcFlaG8k5oIkxD0 + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -6093,14 +6574,15 @@ paths: name: Email Alert Channel customEmailSubjectPrefix: null emails: - - youremail@email.com + - 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 ' + description: >- + Redirect to the integration service for continuing the configuration + with the 3rd party system '400': content: application/json: @@ -6108,11 +6590,11 @@ paths: type: string description: Failed updating the alert channel setting security: - - ApiKeyAuth: - - CanConfigureIntegrations + - ApiKeyAuth: + - CanConfigureIntegrations summary: Update Alert Channel tags: - - Event Settings + - Event Settings /api/events/settings/alerts: get: description: Gets all Alert Configurations @@ -6122,74 +6604,63 @@ paths: 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: [ - ] + - 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: @@ -6200,47 +6671,46 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Get all Alert Configurations tags: - - Event Settings + - Event Settings /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 + - 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 + - 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: @@ -6251,45 +6721,45 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: All alerting configuration info tags: - - Event Settings + - Event Settings /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 + - 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 + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Delete Alert Configuration tags: - - Event Settings + - Event Settings 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 + - description: ID of a specific Alert Configuration to retrieve. + example: iSjG7UWK3Dy6bDUc + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -6299,20 +6769,17 @@ paths: alertName: test-email-alert muteUntil: 0 integrationIds: - - B1PdA6BUdA9JJRZG + - B1PdA6BUdA9JJRZG eventFilteringConfiguration: query: event.text:*BRUCE* - ruleIds: [ - ] + ruleIds: [] eventTypes: - - warning - - incident - - critical - applicationAlertConfigIds: [ - ] + - warning + - incident + - critical + applicationAlertConfigIds: [] validVersion: 1 - customPayloadFields: [ - ] + customPayloadFields: [] lastUpdated: 1718828552918 schema: $ref: '#/components/schemas/AlertingConfigurationWithLastUpdated' @@ -6324,22 +6791,22 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Get Alert Configuration tags: - - Event Settings + - Event Settings 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 + - 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: @@ -6348,49 +6815,6 @@ paths: 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 @@ -6399,17 +6823,15 @@ paths: - IbQkmZ46_oUGV-L7 - wpWi9SYL7cJOu_UZ - ds1Lpvix2WVoWTKg - eventFilteringConfiguration: - query: null - ruleIds: [ - ] - eventTypes: + eventFilteringConfiguration: + query: null + ruleIds: [] + eventTypes: - incident - critical - applicationAlertConfigIds: [ - ] - validVersion: 1 - customPayloadFields: + applicationAlertConfigIds: [] + validVersion: 1 + customPayloadFields: - type: staticString key: assignment_group value: ITSM App-Dev @@ -6422,6 +6844,47 @@ paths: - 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 @@ -6432,109 +6895,115 @@ paths: '422': description: Unprocessable request - missing/invalid data. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Create or update Alert Configuration tags: - - Event Settings + - Event Settings /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. + 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 - nullable: true - - 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: + - description: The ID of a specific Application. + example: IYS1XOEcTNiT1eOD8pxgXg + in: query + name: applicationId + required: true + schema: type: string - maxItems: 1000 - minItems: 0 - uniqueItems: true + nullable: true + - 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 + - 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 security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all Smart Alert Configs tags: - - Application Alert Configuration + - Application Alert Configuration post: - description: |- + 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. + + 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 + description: >- + Calls are slower or equal to the expectation based on latency (90th). boundaryScope: INBOUND applicationId: ZOi0te_ERE-mRm-9zsbwdg @@ -6542,8 +7011,7 @@ paths: ZOi0te_ERE-mRm-9zsbwdg: applicationId: ZOi0te_ERE-mRm-9zsbwdg inclusive: true - services: { - } + services: {} severity: 5 triggering: false tagFilterExpression: @@ -6567,23 +7035,21 @@ paths: operator: '>=' seasonality: DAILY baseline: - - - 0 - - 1 - - 3 - - - 600000 - - 1 - - 3 + - - 0 + - 1 + - 3 + - - 600000 + - 1 + - 3 deviationFactor: 3 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 evaluationType: PER_AP - customPayloadFields: [ - ] + customPayloadFields: [] schema: $ref: '#/components/schemas/ApplicationAlertConfig' required: true @@ -6593,16 +7059,16 @@ paths: application/json: example: name: Calls are slower than usual - description: Calls are slower or equal to the expectation based on - latency (90th). + 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: { - } + services: {} severity: 5 triggering: false tagFilterExpression: @@ -6626,23 +7092,21 @@ paths: operator: '>=' seasonality: DAILY baseline: - - - 0 - - 1 - - 3 - - - 600000 - - 1 - - 3 + - - 0 + - 1 + - 3 + - - 600000 + - 1 + - 3 deviationFactor: 3 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 evaluationType: PER_AP - customPayloadFields: [ - ] + customPayloadFields: [] id: DKp0JArJRAiQIav9CoKSWQ created: 1706617456952 initialCreated: 1706617456952 @@ -6661,24 +7125,25 @@ paths: '428': description: Baseline calculation failed due to insufficient data. security: - - ApiKeyAuth: - - CanConfigureApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts summary: Create Smart Alert Config tags: - - Application Alert Configuration + - Application Alert Configuration /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. + 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 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: string required: true @@ -6692,24 +7157,25 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts summary: Bulk Delete Application Smart Alert Configs tags: - - Application Alert Configuration + - Application Alert Configuration /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. + 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 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: string required: true @@ -6723,24 +7189,25 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts summary: Bulk Disable Application Smart Alert Configs tags: - - Application Alert Configuration + - Application Alert Configuration /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. + 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 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: string required: true @@ -6754,25 +7221,28 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts summary: Bulk Enable Application Smart Alert Configs tags: - - Application Alert Configuration + - Application Alert Configuration /api/events/settings/application-alert-configs/{id}: delete: - description: |- + 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. + + 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 + - description: ID of a specific Smart Alert Configuration to delete. + example: DKp0JArJRAiQIav9CoKSWQ + in: path + name: id + required: true + schema: + type: string responses: '204': description: Successful - no content to return. @@ -6781,49 +7251,54 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts summary: Delete Smart Alert Config tags: - - Application Alert Configuration + - Application Alert Configuration 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. + 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 + - 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). + 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: { - } + services: {} severity: 5 triggering: false tagFilterExpression: @@ -6847,23 +7322,21 @@ paths: operator: '>=' seasonality: DAILY baseline: - - - 0 - - 1 - - 3 - - - 600000 - - 1 - - 3 + - - 0 + - 1 + - 3 + - - 600000 + - 1 + - 3 deviationFactor: 3 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 evaluationType: PER_AP - customPayloadFields: [ - ] + customPayloadFields: [] id: DKp0JArJRAiQIav9CoKSWQ created: 1706617456952 initialCreated: 1706617456952 @@ -6878,30 +7351,34 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Smart Alert Config tags: - - Application Alert Configuration + - Application Alert Configuration post: - description: |- + 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. + + 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 + - 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 + description: >- + Calls are slower or equal to the expectation based on latency (90th). boundaryScope: INBOUND applicationId: ZOi0te_ERE-mRm-9zsbwdg @@ -6909,8 +7386,7 @@ paths: ZOi0te_ERE-mRm-9zsbwdg: applicationId: ZOi0te_ERE-mRm-9zsbwdg inclusive: true - services: { - } + services: {} severity: 5 triggering: false tagFilterExpression: @@ -6934,23 +7410,21 @@ paths: operator: '>=' seasonality: DAILY baseline: - - - 0 - - 1 - - 3 - - - 600000 - - 1 - - 3 + - - 0 + - 1 + - 3 + - - 600000 + - 1 + - 3 deviationFactor: 3 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 evaluationType: PER_AP - customPayloadFields: [ - ] + customPayloadFields: [] schema: $ref: '#/components/schemas/ApplicationAlertConfig' required: true @@ -6960,16 +7434,16 @@ paths: application/json: example: name: Calls are slower than usual - description: Calls are slower or equal to the expectation based on - latency (90th). + 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: { - } + services: {} severity: 5 triggering: false tagFilterExpression: @@ -6993,23 +7467,21 @@ paths: operator: '>=' seasonality: DAILY baseline: - - - 0 - - 1 - - 3 - - - 600000 - - 1 - - 3 + - - 0 + - 1 + - 3 + - - 600000 + - 1 + - 3 deviationFactor: 3 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 evaluationType: PER_AP - customPayloadFields: [ - ] + customPayloadFields: [] id: DKp0JArJRAiQIav9CoKSWQ created: 1706617456952 initialCreated: 1706617456952 @@ -7032,25 +7504,28 @@ paths: '500': description: Bad request. security: - - ApiKeyAuth: - - CanConfigureApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts summary: Update Smart Alert Config tags: - - Application Alert Configuration + - Application Alert Configuration /api/events/settings/application-alert-configs/{id}/disable: put: - description: |- + 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. + + 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 + - 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: @@ -7065,25 +7540,28 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts summary: Disable Smart Alert Config tags: - - Application Alert Configuration + - Application Alert Configuration /api/events/settings/application-alert-configs/{id}/enable: put: - description: |- + 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. + + 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 + - 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: @@ -7098,34 +7576,38 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts summary: Enable Application Alert Config tags: - - Application Alert Configuration + - Application Alert Configuration /api/events/settings/application-alert-configs/{id}/restore/{created}: put: - description: |- + 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. + + 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 + - 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: @@ -7140,25 +7622,30 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts summary: Restore Smart Alert Config tags: - - Application Alert Configuration + - Application Alert Configuration /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. + 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 + - description: ID of a specific Smart Alert Configuration to recalculate. + example: DKp0JArJRAiQIav9CoKSWQ + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -7167,8 +7654,9 @@ paths: nullable: true responses: '200': - description: Smart Alert Configuration baseline successfully recalculated - and updated. + description: >- + Smart Alert Configuration baseline successfully recalculated and + updated. '204': description: Baseline recalculation completed with no changes needed. '400': @@ -7180,40 +7668,45 @@ paths: '428': description: Baseline calculation failed due to insufficient data. security: - - ApiKeyAuth: - - CanConfigureApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureApplicationSmartAlerts summary: Recalculate Smart Alert Config Baseline tags: - - Application Alert Configuration + - Application Alert Configuration /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. + 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 + - 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 + - id: DKp0JArJRAiQIav9CoKSWQ + created: 1706617456952 + enabled: true + deleted: false + changeSummary: + changeType: CREATE + author: + id: 5ee8a3e8cd70020001ecb007 + type: USER + fullName: Stan schema: type: array items: @@ -7224,11 +7717,11 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Smart Alert Config Versions tags: - - Application Alert Configuration + - Application Alert Configuration /api/events/settings/custom-payload-configurations: delete: description: Deletes a Global Custom Payload Configuration. @@ -7241,63 +7734,62 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureGlobalAlertPayload + - ApiKeyAuth: + - CanConfigureGlobalAlertPayload summary: Delete Custom Payload Configuration tags: - - Event Settings + - Event Settings 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 - - in: query - name: ownerType - schema: - type: string - nullable: true + - 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 + - in: query + name: ownerType + schema: + type: string + nullable: true 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 + - 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 or limited in access. security: - - ApiKeyAuth: - - CanConfigureGlobalAlertPayload + - ApiKeyAuth: + - CanConfigureGlobalAlertPayload summary: Get All Global Custom Payload Configurations tags: - - Event Settings + - Event Settings put: description: Creates or Updates Global Custom Payload Configuration. operationId: upsertCustomPayloadConfiguration @@ -7306,14 +7798,14 @@ paths: application/json: example: fields: - - type: staticString - key: string - value: customValue - - type: dynamic - key: string - value: - tagName: agent.zone + - type: staticString key: string + value: customValue + - type: dynamic + key: string + value: + tagName: agent.zone + key: string schema: $ref: '#/components/schemas/CustomPayloadConfiguration' required: true @@ -7322,16 +7814,16 @@ paths: content: application/json: example: - - fields: - - type: staticString - key: string - value: customValue - - type: dynamic - key: string - value: - tagName: agent.zone - key: string - lastUpdated: 1723212859513 + - fields: + - type: staticString + key: string + value: customValue + - type: dynamic + key: string + value: + tagName: agent.zone + key: string + lastUpdated: 1723212859513 schema: type: array items: @@ -7346,15 +7838,16 @@ paths: '422': description: Unable to process request, request data is invalid. security: - - ApiKeyAuth: - - CanConfigureGlobalAlertPayload + - ApiKeyAuth: + - CanConfigureGlobalAlertPayload summary: Create/Update Global Custom Payload Configuration tags: - - Event Settings + - Event Settings /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 + 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: @@ -7362,40 +7855,38 @@ paths: 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 + - 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 or limited in access. security: - - ApiKeyAuth: - - CanConfigureGlobalAlertPayload + - ApiKeyAuth: + - CanConfigureGlobalAlertPayload summary: Get Tag Catalog for Custom Payload tags: - - Event Settings + - Event Settings /api/events/settings/custom-payload-configurations/v2: put: description: Creates or Updates Global Custom Payload Configuration. @@ -7429,17 +7920,17 @@ paths: 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 + - 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: @@ -7456,126 +7947,134 @@ paths: '422': description: Unable to process request, request data is invalid. security: - - ApiKeyAuth: - - CanConfigureGlobalAlertPayload + - ApiKeyAuth: + - CanConfigureGlobalAlertPayload summary: Create/Update Global Custom Payload Configuration tags: - - Event Settings + - Event Settings /api/events/settings/event-specifications/built-in: get: - description: Get all built-in event specifications. Can be filtered by event - IDs or plugin IDs. + description: >- + Get all built-in event specifications. Can be filtered by event IDs or + plugin IDs. operationId: getBuiltInEventSpecifications parameters: - - in: query - name: ids - schema: - type: array - items: - type: string - uniqueItems: true - - in: query - name: plugins - schema: - type: array - items: - type: string - uniqueItems: true + - in: query + name: ids + schema: + type: array + items: + type: string + uniqueItems: true + - in: query + name: plugins + 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 + - 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' + $ref: >- + #/components/schemas/BuiltInEventSpecificationWithLastUpdated description: OK '401': description: Unauthorized access - requires user authentication. '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: All built-in event specification tags: - - Event Settings + - Event Settings /api/events/settings/event-specifications/built-in/{eventSpecificationId}: delete: operationId: deleteBuiltInEventSpecification parameters: - - in: path - name: eventSpecificationId - required: true - schema: - type: string + - in: path + name: eventSpecificationId + required: true + schema: + type: string responses: '204': description: Successful - no content to return. @@ -7584,19 +8083,19 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Delete built-in event specification tags: - - Event Settings + - Event Settings get: operationId: getBuiltInEventSpecification parameters: - - in: path - name: eventSpecificationId - required: true - schema: - type: string + - in: path + name: eventSpecificationId + required: true + schema: + type: string responses: '200': content: @@ -7611,20 +8110,20 @@ paths: '404': description: Built-in event specification not found security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Built-in event specifications tags: - - Event Settings + - Event Settings /api/events/settings/event-specifications/built-in/{eventSpecificationId}/disable: post: operationId: disableBuiltInEventSpecification parameters: - - in: path - name: eventSpecificationId - required: true - schema: - type: string + - in: path + name: eventSpecificationId + required: true + schema: + type: string requestBody: content: application/json: @@ -7645,20 +8144,20 @@ paths: '404': description: Built-in event specification not found security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Disable built-in event specification tags: - - Event Settings + - Event Settings /api/events/settings/event-specifications/built-in/{eventSpecificationId}/enable: post: operationId: enableBuiltInEventSpecification parameters: - - in: path - name: eventSpecificationId - required: true - schema: - type: string + - in: path + name: eventSpecificationId + required: true + schema: + type: string requestBody: content: application/json: @@ -7679,11 +8178,11 @@ paths: '404': description: Built-in event specification not found security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Enable built-in event specification tags: - - Event Settings + - Event Settings /api/events/settings/event-specifications/custom: get: description: ' This API helps in getting all the custom event specifications.' @@ -7693,31 +8192,31 @@ paths: 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 + - 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 + severity: 5 + ruleLogicalOperator: AND + lastUpdated: 1670404707763 + validVersion: 1 + actions: null + migrated: false + applicationAlertConfigId: null + deleted: false schema: type: array items: @@ -7728,11 +8227,11 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: All custom event specifications tags: - - Event Settings + - Event Settings post: operationId: postCustomEventSpecification requestBody: @@ -7755,23 +8254,25 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Create new custom event specification tags: - - Event Settings + - Event Settings x-description: postCustomEventSpecification /api/events/settings/event-specifications/custom/systemRules: get: - description: This API helps to get all the system rules for custom event specifications. + 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) + - id: entity.offline + name: Offline event detection (System Rule) schema: type: array items: @@ -7782,20 +8283,20 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: All system rules for custom event specifications tags: - - Event Settings + - Event Settings /api/events/settings/event-specifications/custom/{eventSpecificationId}: delete: operationId: deleteCustomEventSpecification parameters: - - in: path - name: eventSpecificationId - required: true - schema: - type: string + - in: path + name: eventSpecificationId + required: true + schema: + type: string responses: '204': description: Successful - no content to return. @@ -7804,24 +8305,23 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Delete custom event specification tags: - - Event Settings + - Event Settings x-description: deleteCustomEventSpecification get: - description: This API helps to get the Custom Event specification for the given - ID. + 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 + - description: eventSpecificationId + example: Yojfl6Yn9SXaFhJG + in: path + name: eventSpecificationId + required: true + schema: + type: string responses: '200': content: @@ -7836,17 +8336,17 @@ paths: 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 + - ruleType: threshold + severity: 5 + metricName: currentMemUsage + rollup: 0 + window: 600000 + metricPattern: null + aggregation: avg + conditionOperator: '>=' + conditionValue: 0 + metricLabel: Current Memory Usage + metricFormat: PERCENTAGE ruleLogicalOperator: AND lastUpdated: 1670404707763 validVersion: 1 @@ -7864,23 +8364,23 @@ paths: '404': description: Custom Event does not exist security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Custom event specification tags: - - Event Settings + - Event Settings put: operationId: putCustomEventSpecification parameters: - - in: path - name: eventSpecificationId - required: true - schema: - type: string - - in: query - name: allowRestore - schema: - type: boolean + - in: path + name: eventSpecificationId + required: true + schema: + type: string + - in: query + name: allowRestore + schema: + type: boolean requestBody: content: application/json: @@ -7895,8 +8395,9 @@ paths: $ref: '#/components/schemas/CustomEventSpecificationWithLastUpdated' description: OK '400': - description: 'Invalid request: unsupported entity type, incorrect query, - or event is deleted or migrated.' + description: >- + Invalid request: unsupported entity type, incorrect query, or event + is deleted or migrated. '401': description: Unauthorized access - requires user authentication. '403': @@ -7904,21 +8405,21 @@ paths: '500': description: Custom event cannot be updated. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Create or update custom event specification tags: - - Event Settings + - Event Settings x-description: putCustomEventSpecification /api/events/settings/event-specifications/custom/{eventSpecificationId}/disable: post: operationId: disableCustomEventSpecification parameters: - - in: path - name: eventSpecificationId - required: true - schema: - type: string + - in: path + name: eventSpecificationId + required: true + schema: + type: string requestBody: content: application/json: @@ -7941,20 +8442,20 @@ paths: '404': description: Custom Event does not exist security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Disable custom event specification tags: - - Event Settings + - Event Settings /api/events/settings/event-specifications/custom/{eventSpecificationId}/enable: post: operationId: enableCustomEventSpecification parameters: - - in: path - name: eventSpecificationId - required: true - schema: - type: string + - in: path + name: eventSpecificationId + required: true + schema: + type: string requestBody: content: application/json: @@ -7977,14 +8478,15 @@ paths: '404': description: Custom Event does not exist security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Enable custom event specification tags: - - Event Settings + - Event Settings /api/events/settings/event-specifications/infos: get: - description: This API helps to get the summary of all build-in and custom event + description: >- + This API helps to get the summary of all build-in and custom event specifications operationId: getEventSpecificationInfos responses: @@ -7992,17 +8494,18 @@ paths: 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 + - 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: @@ -8013,11 +8516,11 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: Summary of all built-in and custom event specifications tags: - - Event Settings + - Event Settings post: description: Summary of all built-in and custom event specifications by IDs operationId: getEventSpecificationInfosByIds @@ -8043,102 +8546,105 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureCustomAlerts + - ApiKeyAuth: + - CanConfigureCustomAlerts summary: All built-in and custom event specifications tags: - - Event Settings + - Event Settings /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. + 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 + - 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 + - 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 + 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' + $ref: >- + #/components/schemas/GlobalApplicationAlertConfigWithMetadata description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all Global Smart Alert Configs tags: - - Global Application Alert Configuration + - Global Application Alert Configuration post: - description: |- + 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. + + 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: @@ -8151,17 +8657,15 @@ paths: j02SxMRTSf-NCBXf5IdsjQ: applicationId: j02SxMRTSf-NCBXf5IdsjQ inclusive: true - services: { - } + services: {} applicationIds: - - j02SxMRTSf-NCBXf5IdsjQ + - j02SxMRTSf-NCBXf5IdsjQ severity: 5 triggering: false tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] includeInternal: false includeSynthetic: false rule: @@ -8171,17 +8675,15 @@ paths: threshold: type: staticThreshold operator: '>=' - value: 2.0 + value: 2 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 evaluationType: PER_AP - customPayloadFields: [ - ] + customPayloadFields: [] schema: $ref: '#/components/schemas/GlobalApplicationsAlertConfig' required: true @@ -8197,17 +8699,15 @@ paths: j02SxMRTSf-NCBXf5IdsjQ: applicationId: j02SxMRTSf-NCBXf5IdsjQ inclusive: true - services: { - } + services: {} applicationIds: - - j02SxMRTSf-NCBXf5IdsjQ + - j02SxMRTSf-NCBXf5IdsjQ severity: 5 triggering: false tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] includeInternal: false includeSynthetic: false rule: @@ -8217,17 +8717,15 @@ paths: threshold: type: staticThreshold operator: '>=' - value: 2.0 + value: 2 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 evaluationType: PER_AP - customPayloadFields: [ - ] + customPayloadFields: [] id: vlFnxhVTS3KVb-wsN26PeQ created: 1707305626330 initialCreated: 1707305626330 @@ -8244,17 +8742,20 @@ paths: '422': description: Unprocessable request - missing/invalid data. security: - - ApiKeyAuth: - - CanConfigureGlobalApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts summary: Create Global Smart Alert Config tags: - - Global Application Alert Configuration + - Global Application Alert Configuration /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." + 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. + + 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: bulkDeleteGlobalApplicationAlertConfigs requestBody: content: @@ -8274,17 +8775,20 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts summary: Bulk Delete Global Smart Alert Configs tags: - - Global Application Alert Configuration + - Global Application Alert Configuration /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." + description: >- + Disables multiple Global Smart Alert Configurations in a single request. + Only processes configs that are currently enabled and the user has + access to. + + 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: bulkDisableGlobalApplicationAlertConfigs requestBody: content: @@ -8304,17 +8808,20 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts summary: Bulk Disable Global Smart Alert Configs tags: - - Global Application Alert Configuration + - Global Application Alert Configuration /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." + description: >- + Enables multiple Global Smart Alert Configurations in a single request. + Only processes configs that are currently disabled and the user has + access to. + + 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: bulkEnableGlobalApplicationAlertConfigs requestBody: content: @@ -8334,25 +8841,27 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts summary: Bulk Enable Global Smart Alert Configs tags: - - Global Application Alert Configuration + - Global Application Alert Configuration /api/events/settings/global-alert-configs/applications/{id}: delete: - description: |- + description: >- 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. + + 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 + - 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: Successful - no content to return. @@ -8361,33 +8870,37 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts summary: Delete Global Smart Alert Config tags: - - Global Application Alert Configuration + - Global Application Alert Configuration 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. + 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 + - 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: @@ -8400,17 +8913,15 @@ paths: j02SxMRTSf-NCBXf5IdsjQ: applicationId: j02SxMRTSf-NCBXf5IdsjQ inclusive: true - services: { - } + services: {} applicationIds: - - j02SxMRTSf-NCBXf5IdsjQ + - j02SxMRTSf-NCBXf5IdsjQ severity: 5 triggering: false tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] includeInternal: false includeSynthetic: false rule: @@ -8420,17 +8931,15 @@ paths: threshold: type: staticThreshold operator: '>=' - value: 2.0 + value: 2 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 evaluationType: PER_AP - customPayloadFields: [ - ] + customPayloadFields: [] id: vlFnxhVTS3KVb-wsN26PeQ created: 1707305626330 initialCreated: 1707305626330 @@ -8445,24 +8954,26 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Global Smart Alert Config tags: - - Global Application Alert Configuration + - Global Application Alert Configuration post: - description: |- + 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. + + 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 + - 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: @@ -8474,17 +8985,15 @@ paths: j02SxMRTSf-NCBXf5IdsjQ: applicationId: j02SxMRTSf-NCBXf5IdsjQ inclusive: true - services: { - } + services: {} applicationIds: - - j02SxMRTSf-NCBXf5IdsjQ + - j02SxMRTSf-NCBXf5IdsjQ severity: 5 triggering: false tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] includeInternal: false includeSynthetic: false rule: @@ -8494,17 +9003,15 @@ paths: threshold: type: staticThreshold operator: '>=' - value: 2.0 + value: 2 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 evaluationType: PER_AP - customPayloadFields: [ - ] + customPayloadFields: [] schema: $ref: '#/components/schemas/GlobalApplicationsAlertConfig' required: true @@ -8520,17 +9027,15 @@ paths: j02SxMRTSf-NCBXf5IdsjQ: applicationId: j02SxMRTSf-NCBXf5IdsjQ inclusive: true - services: { - } + services: {} applicationIds: - - j02SxMRTSf-NCBXf5IdsjQ + - j02SxMRTSf-NCBXf5IdsjQ severity: 5 triggering: false tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] includeInternal: false includeSynthetic: false rule: @@ -8540,17 +9045,15 @@ paths: threshold: type: staticThreshold operator: '>=' - value: 2.0 + value: 2 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 evaluationType: PER_AP - customPayloadFields: [ - ] + customPayloadFields: [] id: vlFnxhVTS3KVb-wsN26PeQ created: 1707305626330 initialCreated: 1707305626330 @@ -8573,25 +9076,27 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureGlobalApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts summary: Update Global Smart Alert Config tags: - - Global Application Alert Configuration + - Global Application Alert Configuration /api/events/settings/global-alert-configs/applications/{id}/disable: put: - description: |- + 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. + + 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 + - 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: @@ -8606,25 +9111,27 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts summary: Disable Global Smart Alert Config tags: - - Global Application Alert Configuration + - Global Application Alert Configuration /api/events/settings/global-alert-configs/applications/{id}/enable: put: - description: |- + 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. + + 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 + - 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: @@ -8639,34 +9146,37 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts summary: Enable Global Smart Alert Config tags: - - Global Application Alert Configuration + - Global Application Alert Configuration /api/events/settings/global-alert-configs/applications/{id}/restore/{created}: put: - description: |- + 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. + + 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 + - 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: @@ -8681,40 +9191,44 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalApplicationSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalApplicationSmartAlerts summary: Restore Global Smart Alert Config tags: - - Global Application Alert Configuration + - Global Application Alert Configuration /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. + 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 + - 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 + - id: vlFnxhVTS3KVb-wsN26PeQ + created: 1707305626330 + enabled: true + deleted: false + changeSummary: + changeType: CREATE + author: + id: 5ee8a3e8cd70020001ecb007 + type: USER + fullName: Stan schema: type: array items: @@ -8725,25 +9239,25 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Global Smart Alert Config Versions tags: - - Global Application Alert Configuration + - Global Application Alert Configuration /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 + - in: query + name: alertIds + schema: + type: array + items: + type: string + maxItems: 1000 + minItems: 0 + uniqueItems: true responses: '200': content: @@ -8754,11 +9268,11 @@ paths: $ref: '#/components/schemas/LogAlertConfigWithMetadata' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: All Log Alert Configs tags: - - Log Alert Configuration + - Log Alert Configuration post: operationId: createLogAlertConfig requestBody: @@ -8777,16 +9291,17 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureGlobalLogSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts summary: Create Log Alert Config tags: - - Log Alert Configuration + - Log Alert Configuration x-description: createLogAlertConfig /api/events/settings/global-alert-configs/logs/bulk/delete: put: - description: Delete multiple log alert configurations at once. Maximum 1000 - IDs per request. + description: >- + Delete multiple log alert configurations at once. Maximum 1000 IDs per + request. operationId: bulkDeleteLogAlertConfigs requestBody: content: @@ -8795,9 +9310,9 @@ paths: Log Alert Config IDs: description: Array of log alert configuration IDs value: - - alert-id-1 - - alert-id-2 - - alert-id-3 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: array items: @@ -8813,15 +9328,16 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalLogSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts summary: Bulk Delete Log Alert Configs tags: - - Log Alert Configuration + - Log Alert Configuration /api/events/settings/global-alert-configs/logs/bulk/disable: put: - description: Disable multiple log alert configurations at once. Maximum 1000 - IDs per request. + description: >- + Disable multiple log alert configurations at once. Maximum 1000 IDs per + request. operationId: bulkDisableLogAlertConfigs requestBody: content: @@ -8830,9 +9346,9 @@ paths: Log Alert Config IDs: description: Array of log alert configuration IDs value: - - alert-id-1 - - alert-id-2 - - alert-id-3 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: array items: @@ -8848,15 +9364,16 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalLogSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts summary: Bulk Disable Log Alert Configs tags: - - Log Alert Configuration + - Log Alert Configuration /api/events/settings/global-alert-configs/logs/bulk/enable: put: - description: Enable multiple log alert configurations at once. Maximum 1000 - IDs per request. + description: >- + Enable multiple log alert configurations at once. Maximum 1000 IDs per + request. operationId: bulkEnableLogAlertConfigs requestBody: content: @@ -8865,9 +9382,9 @@ paths: Log Alert Config IDs: description: Array of log alert configuration IDs value: - - alert-id-1 - - alert-id-2 - - alert-id-3 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: array items: @@ -8883,20 +9400,20 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalLogSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts summary: Bulk Enable Log Alert Configs tags: - - Log Alert Configuration + - Log Alert Configuration /api/events/settings/global-alert-configs/logs/{id}: delete: operationId: deleteLogAlertConfig parameters: - - in: path - name: id - required: true - schema: - type: string + - in: path + name: id + required: true + schema: + type: string responses: '204': description: Successful - no content to return. @@ -8905,26 +9422,25 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalLogSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts summary: Delete Log Alert Config tags: - - Log Alert Configuration + - Log Alert Configuration get: - description: Find a Log Alert Config by ID. This will deliver deleted configs - too. + 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 + - in: path + name: id + required: true + schema: + type: string + - in: query + name: validOn + schema: + type: integer + format: int64 responses: '200': content: @@ -8935,19 +9451,19 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Log Alert Config tags: - - Log Alert Configuration + - Log Alert Configuration post: operationId: updateLogAlertConfig parameters: - - in: path - name: id - required: true - schema: - type: string + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -8966,21 +9482,21 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureGlobalLogSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts summary: Update Log Alert Config tags: - - Log Alert Configuration + - Log Alert Configuration x-description: updateLogAlertConfig /api/events/settings/global-alert-configs/logs/{id}/disable: put: operationId: disableLogAlertConfig parameters: - - in: path - name: id - required: true - schema: - type: string + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -8995,20 +9511,20 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalLogSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts summary: Disable Log Alert Config tags: - - Log Alert Configuration + - Log Alert Configuration /api/events/settings/global-alert-configs/logs/{id}/enable: put: operationId: enableLogAlertConfig parameters: - - in: path - name: id - required: true - schema: - type: string + - in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -9023,26 +9539,26 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalLogSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts summary: Enable Log Alert Config tags: - - Log Alert Configuration + - Log Alert Configuration /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 + - in: path + name: id + required: true + schema: + type: string + - in: path + name: created + required: true + schema: + type: integer + format: int64 requestBody: content: application/json: @@ -9057,22 +9573,23 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalLogSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalLogSmartAlerts summary: Restore Log Alert Config tags: - - Log Alert Configuration + - Log Alert Configuration /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. + 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 + - in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -9085,105 +9602,103 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get versions of Log Alert Config tags: - - Log Alert Configuration + - Log Alert Configuration /api/events/settings/global-alert-configs/service-levels: get: description: Configs are sorted descending by their created date. operationId: findActiveServiceLevelsAlertConfigs parameters: - - description: SLO Configuration ID - example: SLOEANnWh9tQOa2h88kGxK6wQ - in: query - name: sloId - schema: - type: string - nullable: true - - description: Apdex Configuration ID - example: APDXEANnWh9tQOa2h88kGxK6wQ - in: query - name: apdexId - schema: - type: string - nullable: true - - description: Alert Type filter - either 'SLO' or 'APDEX' - example: SLO - in: query - name: alertType - schema: - type: string - nullable: true - - description: List of Service Levels Alert Configuration IDs - example: ln3IGogYS-S7CPqcOQYTNA - in: query - name: alertIds - schema: - type: array - items: + - description: SLO Configuration ID + example: SLOEANnWh9tQOa2h88kGxK6wQ + in: query + name: sloId + schema: type: string - maxItems: 1000 - minItems: 0 - uniqueItems: true + nullable: true + - description: Apdex Configuration ID + example: APDXEANnWh9tQOa2h88kGxK6wQ + in: query + name: apdexId + schema: + type: string + nullable: true + - description: Alert Type filter - either 'SLO' or 'APDEX' + example: SLO + in: query + name: alertType + schema: + type: string + nullable: true + - 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 + - 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 + - ApiKeyAuth: + - Default summary: All Service levels Alert Configs tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration post: operationId: createServiceLevelsAlertConfig requestBody: content: application/json: example: - alertChannelIds: [ - ] + alertChannelIds: [] customPayloadFields: - - key: foo - id: avvh9tbxpfRE65t - type: staticString - value: bar + - 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: @@ -9191,7 +9706,7 @@ paths: metric: BURNED_PERCENTAGE severity: 5 sloIds: - - SLOEANnWh9tQOa2h88kGxK6wQ + - SLOEANnWh9tQOa2h88kGxK6wQ threshold: type: staticThreshold value: 0.05 @@ -9222,16 +9737,15 @@ paths: value: 0.05 lastUpdated: 1716454787342 sloIds: - - SLOEANnWh9tQOa2h88kGxK6wQ - alertChannelIds: [ - ] + - SLOEANnWh9tQOa2h88kGxK6wQ + alertChannelIds: [] timeThreshold: expiry: null timeWindow: 600000 customPayloadFields: - - type: staticString - key: foo - value: bar + - type: staticString + key: foo + value: bar id: ln3IGogYS-S7CPqcOQYTNA created: 1717668384754 initialCreated: 1717668384754 @@ -9245,24 +9759,26 @@ paths: application/json: example: errors: - - Website SLOs do not support triggering -> true + - Website SLOs do not support triggering -> true schema: type: array items: type: string - description: Service levels Alert Config with Website SLOs do not support + description: >- + Service levels Alert Config with Website SLOs do not support triggering security: - - ApiKeyAuth: - - canConfigureServiceLevelSmartAlerts + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts summary: Create Service levels Alert Config tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration x-description: createServiceLevelsAlertConfig /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. + 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: @@ -9276,20 +9792,22 @@ paths: '204': description: Service Levels Alert Configurations Deleted Successfully '403': - description: Forbidden - User does not have permission to configure Service + description: >- + Forbidden - User does not have permission to configure Service Levels Smart Alerts '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - canConfigureServiceLevelSmartAlerts + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts summary: Bulk Delete Service Levels Smart Alert Configs tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration /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. + 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: @@ -9303,20 +9821,22 @@ paths: '204': description: Service Levels Alert Configurations Disabled Successfully '403': - description: Forbidden - User does not have permission to configure Service + description: >- + Forbidden - User does not have permission to configure Service Levels Smart Alerts '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - canConfigureServiceLevelSmartAlerts + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts summary: Bulk Disable Service Levels Smart Alert Configs tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration /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. + 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: @@ -9330,63 +9850,66 @@ paths: '204': description: Service Levels Alert Configurations Enabled Successfully '403': - description: Forbidden - User does not have permission to configure Service + description: >- + Forbidden - User does not have permission to configure Service Levels Smart Alerts '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - canConfigureServiceLevelSmartAlerts + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts summary: Bulk Enable Service Levels Smart Alert Configs tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration /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 + - 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"]}' + 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 + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts summary: Delete Service levels Alert Config tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration get: - description: Find a Service levels Alert Config by ID. This will deliver deleted + 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 + - 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: @@ -9405,19 +9928,18 @@ paths: value: 0.05 lastUpdated: 1716454787342 sloIds: - - SLOEANnWh9tQOa2h88kGxK6wQ - alertChannelIds: [ - ] + - SLOEANnWh9tQOa2h88kGxK6wQ + alertChannelIds: [] timeThreshold: expiry: null timeWindow: 600000 customPayloadFields: - - type: staticString - key: foo - value: bar + - type: staticString + key: foo + value: bar rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 id: ln3IGogYS-S7CPqcOQYTNA created: 1717668384754 initialCreated: 1717668384754 @@ -9429,38 +9951,38 @@ paths: '404': content: application/json: - example: '{"errors":["Config with id: -DZZjflTQTmZ7yGvBilPlQ is not - found"]}' + 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 + - ApiKeyAuth: + - Default summary: Get Service levels Alert Config tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration post: operationId: updateServiceLevelsAlertConfig parameters: - - description: Service Levels Alert Configuration ID - example: ln3IGogYS-S7CPqcOQYTNA - in: path - name: id - required: true - schema: - type: string + - description: Service Levels Alert Configuration ID + example: ln3IGogYS-S7CPqcOQYTNA + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: example: - alertChannelIds: [ - ] + alertChannelIds: [] customPayloadFields: - - key: foo - id: avvh9tbxpfRE65t - type: staticString - value: bar + - 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: @@ -9468,7 +9990,7 @@ paths: metric: BURNED_PERCENTAGE severity: 5 sloIds: - - SLOEANnWh9tQOa2h88kGxK6wQ + - SLOEANnWh9tQOa2h88kGxK6wQ threshold: type: staticThreshold value: 0.05 @@ -9499,16 +10021,15 @@ paths: value: 0.05 lastUpdated: 1716454787342 sloIds: - - SLOEANnWh9tQOa2h88kGxK6wQ - alertChannelIds: [ - ] + - SLOEANnWh9tQOa2h88kGxK6wQ + alertChannelIds: [] timeThreshold: expiry: null timeWindow: 600000 customPayloadFields: - - type: staticString - key: foo - value: bar + - type: staticString + key: foo + value: bar id: ln3IGogYS-S7CPqcOQYTNA created: 1717668384754 initialCreated: 1717668384754 @@ -9524,31 +10045,32 @@ paths: application/json: example: errors: - - Website SLOs do not support triggering -> true + - Website SLOs do not support triggering -> true schema: type: array items: type: string - description: Service levels Alert Config with Website SLOs do not support + description: >- + Service levels Alert Config with Website SLOs do not support triggering security: - - ApiKeyAuth: - - canConfigureServiceLevelSmartAlerts + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts summary: Update Service levels Alert Config tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration x-description: updateServiceLevelsAlertConfig /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 + - description: Service Levels Alert Configuration ID + example: ln3IGogYS-S7CPqcOQYTNA + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -9561,28 +10083,29 @@ paths: '404': content: application/json: - example: '{"errors":["Config with id: -DZZjflTQTmZ7yGvBilPlQ is not - found"]}' + 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 + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts summary: Disable Service levels Alert Config tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration /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 + - description: Service Levels Alert Configuration ID + example: ln3IGogYS-S7CPqcOQYTNA + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -9595,36 +10118,37 @@ paths: '404': content: application/json: - example: '{"errors":["Config with id: -DZZjflTQTmZ7yGvBilPlQ is not - found"]}' + 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 + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts summary: Enable Service levels Alert Config tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration /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 + - 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: @@ -9637,181 +10161,193 @@ paths: '404': content: application/json: - example: '{"errors":["Config with id: -DZZjflTQTmZ7yGvBilPlQ is not - found"]}' + 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 + - ApiKeyAuth: + - canConfigureServiceLevelSmartAlerts summary: Restore Service levels Alert Config tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration /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. + 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 + - 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 + - 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 + description: >- + Fetched list of Service Level Alert Configuration Versions Successfully '404': content: application/json: - example: '{"errors":["Config with id: -DZZjflTQTmZ7yGvBilPlQ is not - found"]}' + 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 + - ApiKeyAuth: + - Default summary: Get versions of Service levels Alert Config tags: - - Service Levels Alert Configuration + - Service Levels Alert Configuration /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. + 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 - nullable: true - - 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: + - description: 'The ID of a specific Synthetic Test. ' + example: ic25Vt1T5dgKzi0K7812 + in: query + name: syntheticTestId + schema: type: string - maxItems: 1000 - minItems: 0 - uniqueItems: true + nullable: true + - 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: - - rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 - 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 + - rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 + 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. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all Synthetic Smart Alert Configs tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration post: - description: |- + 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. + + 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 + 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 + - ic25Vt1T5dgKzi0K7812 + - 2gBxQz3oKtXgFXzRoQ6O severity: 5 tagFilterExpression: type: TAG_FILTER @@ -9828,12 +10364,11 @@ paths: metricName: status aggregation: SUM alertChannelIds: - - 0o1ISHPfR8-N4iUK + - 0o1ISHPfR8-N4iUK timeThreshold: type: violationsInSequence violationsCount: 2 - customPayloadFields: [ - ] + customPayloadFields: [] schema: $ref: '#/components/schemas/SyntheticAlertConfig' required: true @@ -9842,12 +10377,15 @@ paths: 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 + 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 + - ic25Vt1T5dgKzi0K7812 + - 2gBxQz3oKtXgFXzRoQ6O severity: 5 tagFilterExpression: type: TAG_FILTER @@ -9864,12 +10402,11 @@ paths: metricName: status aggregation: SUM alertChannelIds: - - 0o1ISHPfR8-N4iUK + - 0o1ISHPfR8-N4iUK timeThreshold: type: violationsInSequence violationsCount: 2 - customPayloadFields: [ - ] + customPayloadFields: [] id: qgEwvI0vRfe3Al_D7T7LSA created: 1707149760053 initialCreated: 1707145201046 @@ -9885,16 +10422,18 @@ paths: '422': description: Unprocessable request - missing/invalid data. security: - - ApiKeyAuth: - - CanConfigureGlobalSyntheticSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts summary: Create Synthetic Smart Alert Config tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration /api/events/settings/global-alert-configs/synthetics/bulk/delete: put: - description: |- + 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. + + 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: @@ -9903,9 +10442,9 @@ paths: Synthetic Alert Config IDs: description: Array of synthetic alert configuration IDs value: - - alert-id-1 - - alert-id-2 - - alert-id-3 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: array items: @@ -9921,16 +10460,18 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalSyntheticSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts summary: Bulk Delete Synthetic Smart Alert Configs tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration /api/events/settings/global-alert-configs/synthetics/bulk/disable: put: - description: |- + 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. + + 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: @@ -9939,9 +10480,9 @@ paths: Synthetic Alert Config IDs: description: Array of synthetic alert configuration IDs value: - - alert-id-1 - - alert-id-2 - - alert-id-3 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: array items: @@ -9957,16 +10498,18 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalSyntheticSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts summary: Bulk Disable Synthetic Smart Alert Configs tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration /api/events/settings/global-alert-configs/synthetics/bulk/enable: put: - description: |- + 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. + + 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: @@ -9975,9 +10518,9 @@ paths: Synthetic Alert Config IDs: description: Array of synthetic alert configuration IDs value: - - alert-id-1 - - alert-id-2 - - alert-id-3 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: array items: @@ -9993,25 +10536,27 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalSyntheticSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts summary: Bulk Enable Synthetic Smart Alert Configs tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration /api/events/settings/global-alert-configs/synthetics/{id}: delete: - description: |- + 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. + + 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 + - 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: Successful - no content to return. @@ -10020,44 +10565,51 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalSyntheticSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts summary: Delete Synthetic Smart Alert Config tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration 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. + 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 + - 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 + 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 + - ic25Vt1T5dgKzi0K7812 + - 2gBxQz3oKtXgFXzRoQ6O severity: 5 tagFilterExpression: type: TAG_FILTER @@ -10074,15 +10626,14 @@ paths: metricName: status aggregation: SUM alertChannelIds: - - 0o1ISHPfR8-N4iUK + - 0o1ISHPfR8-N4iUK timeThreshold: type: violationsInSequence violationsCount: 2 - customPayloadFields: [ - ] + customPayloadFields: [] rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 id: qgEwvI0vRfe3Al_D7T7LSA created: 1707149760053 initialCreated: 1707145201046 @@ -10096,34 +10647,39 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Synthetic Smart Alert Config tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration post: - description: |- + 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. + + 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 + - 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 + 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 + - ic25Vt1T5dgKzi0K7812 + - 2gBxQz3oKtXgFXzRoQ6O severity: 5 tagFilterExpression: type: TAG_FILTER @@ -10140,12 +10696,11 @@ paths: metricName: status aggregation: SUM alertChannelIds: - - 0o1ISHPfR8-N4iUK + - 0o1ISHPfR8-N4iUK timeThreshold: type: violationsInSequence violationsCount: 2 - customPayloadFields: [ - ] + customPayloadFields: [] schema: $ref: '#/components/schemas/SyntheticAlertConfig' required: true @@ -10154,12 +10709,15 @@ paths: 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 + 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 + - ic25Vt1T5dgKzi0K7812 + - 2gBxQz3oKtXgFXzRoQ6O severity: 5 tagFilterExpression: type: TAG_FILTER @@ -10176,12 +10734,11 @@ paths: metricName: status aggregation: SUM alertChannelIds: - - 0o1ISHPfR8-N4iUK + - 0o1ISHPfR8-N4iUK timeThreshold: type: violationsInSequence violationsCount: 2 - customPayloadFields: [ - ] + customPayloadFields: [] id: qgEwvI0vRfe3Al_D7T7LSA created: 1707149760053 initialCreated: 1707145201046 @@ -10201,25 +10758,27 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureGlobalSyntheticSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts summary: Update Synthetic Smart Alert Config tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration /api/events/settings/global-alert-configs/synthetics/{id}/disable: put: - description: |- + 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. + + 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 + - 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: @@ -10234,25 +10793,27 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalSyntheticSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts summary: Disable Synthetic Smart Alert Config tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration /api/events/settings/global-alert-configs/synthetics/{id}/enable: put: - description: |- + 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. + + 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 + - 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: @@ -10267,34 +10828,37 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalSyntheticSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts summary: Enable Synthetic Smart Alert Config tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration /api/events/settings/global-alert-configs/synthetics/{id}/restore/{created}: put: - description: |- + 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. + + 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 + - 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: @@ -10309,50 +10873,54 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalSyntheticSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalSyntheticSmartAlerts summary: Restore Synthetic Smart Alert Config tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration /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. + 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 + - 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 + - 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: @@ -10363,85 +10931,54 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Synthetic Smart Alert Config Versions tags: - - Synthetic Alert Configuration + - Synthetic Alert Configuration /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 + - 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: '>=' + - 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 @@ -10449,24 +10986,55 @@ paths: aggregation: MEAN crossSeriesAggregation: MEAN regex: false - thresholds: - WARNING: - type: staticThreshold - value: 1 - CRITICAL: - type: staticThreshold - value: 4 + 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 + - ApiKeyAuth: + - Default summary: All Infra Alert Configs tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration post: operationId: createInfraAlertConfig requestBody: @@ -10487,19 +11055,19 @@ paths: 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 + - 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 + - kubernetes.cluster.name + - kubernetes.namespace.name + - kubernetes.pod.name rule: alertType: genericRule metricName: memory.usage @@ -10514,8 +11082,8 @@ paths: lastUpdated: 1724720573744 forecastingConfig: null alertChannelIds: - - VjS1NvcXpOARmTvA - - CrLI3QeIZKygaNLH + - VjS1NvcXpOARmTvA + - CrLI3QeIZKygaNLH granularity: 60000 timeThreshold: type: violationsInSequence @@ -10526,25 +11094,25 @@ paths: readOnly: false enabled: false customPayloadFields: - - type: staticString - key: testKey - value: team-ar + - 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 + - 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 @@ -10553,14 +11121,15 @@ paths: '422': description: Unprocessable request - missing/invalid data. security: - - ApiKeyAuth: - - CanConfigureGlobalInfraSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts summary: Create Infra Alert Config tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration /api/events/settings/infra-alert-configs/bulk/delete: put: - description: Delete multiple Infra Smart Alert configurations in a single operation. + description: >- + Delete multiple Infra Smart Alert configurations in a single operation. Only configs that are not already deleted will be updated. operationId: bulkDeleteInfraAlertConfigs requestBody: @@ -10579,14 +11148,15 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalInfraSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts summary: Bulk Delete Infra Smart Alert Configs tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration /api/events/settings/infra-alert-configs/bulk/disable: put: - description: Disable multiple Infra Smart Alert configurations in a single operation. + description: >- + Disable multiple Infra Smart Alert configurations in a single operation. Only configs that are currently enabled will be updated. operationId: bulkDisableInfraAlertConfigs requestBody: @@ -10605,14 +11175,15 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalInfraSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts summary: Bulk Disable Infra Smart Alert Configs tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration /api/events/settings/infra-alert-configs/bulk/enable: put: - description: Enable multiple Infra Smart Alert configurations in a single operation. + description: >- + Enable multiple Infra Smart Alert configurations in a single operation. Only configs that are currently disabled will be updated. operationId: bulkEnableInfraAlertConfigs requestBody: @@ -10631,22 +11202,22 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureGlobalInfraSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts summary: Bulk Enable Infra Smart Alert Configs tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration /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 + - 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. @@ -10655,31 +11226,32 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalInfraSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts summary: Delete Infra Alert Config tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration get: - description: Find a Infra Alert Config by ID. This will deliver deleted configs - too. + 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 + - 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: @@ -10692,19 +11264,19 @@ paths: 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 + - 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 + - kubernetes.cluster.name + - kubernetes.namespace.name + - kubernetes.pod.name rule: alertType: genericRule metricName: memory.usage @@ -10719,8 +11291,8 @@ paths: lastUpdated: 1724720573744 forecastingConfig: null alertChannelIds: - - VjS1NvcXpOARmTvA - - CrLI3QeIZKygaNLH + - VjS1NvcXpOARmTvA + - CrLI3QeIZKygaNLH granularity: 60000 timeThreshold: type: violationsInSequence @@ -10731,46 +11303,46 @@ paths: readOnly: false enabled: false customPayloadFields: - - type: staticString - key: testKey - value: team-ar + - 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 + - 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 + - ApiKeyAuth: + - Default summary: Get Infra Alert Config tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration 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 + - 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: @@ -10789,19 +11361,19 @@ paths: 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 + - 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 + - kubernetes.cluster.name + - kubernetes.namespace.name + - kubernetes.pod.name rule: alertType: genericRule metricName: memory.usage @@ -10816,8 +11388,8 @@ paths: lastUpdated: 1724720573744 forecastingConfig: null alertChannelIds: - - VjS1NvcXpOARmTvA - - CrLI3QeIZKygaNLH + - VjS1NvcXpOARmTvA + - CrLI3QeIZKygaNLH granularity: 60000 timeThreshold: type: violationsInSequence @@ -10828,25 +11400,25 @@ paths: readOnly: false enabled: false customPayloadFields: - - type: staticString - key: testKey - value: team-ar + - 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 + - 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 @@ -10859,22 +11431,22 @@ paths: '422': description: Unprocessable request - missing/invalid data. security: - - ApiKeyAuth: - - CanConfigureGlobalInfraSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts summary: Update Infra Alert Config tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration /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 + - 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: @@ -10889,22 +11461,22 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalInfraSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts summary: Disable Infra Alert Config tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration /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 + - 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: @@ -10919,30 +11491,30 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalInfraSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts summary: Enable Infra Alert Config tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration /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 + - 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: @@ -10957,39 +11529,41 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureGlobalInfraSmartAlerts + - ApiKeyAuth: + - CanConfigureGlobalInfraSmartAlerts summary: Restore Infra Alert Config tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration /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. + 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 + - 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 + - id: 4kxgJAXdSDiu6swQaKXrJw + created: 1724720587414 + enabled: false + deleted: false + changeSummary: + changeType: DISABLE + author: + id: 5ee8a3e8cd70020001ecb007 + type: USER + fullName: Stan schema: type: array items: @@ -10998,23 +11572,24 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get versions of Infra Alert Config tags: - - Infrastructure Alert Configuration + - Infrastructure Alert Configuration /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 + 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 + - DPmhOKanQ3KmQCCElqOBeg + - PRYfcm_7QRid9IRRhW3Y4w username: user123 reasonForClosing: Routine maintenance completed closeTimestamp: 1691505637000 @@ -11028,10 +11603,9 @@ paths: application/json: example: successfulRequests: - - DPmhOKanQ3KmQCCElqOBeg - - PRYfcm_7QRid9IRRhW3Y4w - failedRequests: [ - ] + - DPmhOKanQ3KmQCCElqOBeg + - PRYfcm_7QRid9IRRhW3Y4w + failedRequests: [] schema: $ref: '#/components/schemas/Json' description: The multi close operation was successful @@ -11044,23 +11618,24 @@ paths: '501': description: The multi close feature is not enabled. security: - - ApiKeyAuth: - - CanManuallyCloseIssue + - ApiKeyAuth: + - CanManuallyCloseIssue summary: Manually closing multiple events tags: - - Event Settings + - Event Settings /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. + 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 + - example: exampleEventId + in: path + name: eventId + required: true + schema: + type: string requestBody: content: application/json: @@ -11151,117 +11726,119 @@ paths: '404': description: The event id refers to an event that is not open. '422': - description: Validation failed. The request body contains invalid or missing + description: >- + Validation failed. The request body contains invalid or missing required fields (e.g., blank username or reasonForClosing). security: - - ApiKeyAuth: - - CanManuallyCloseIssue + - ApiKeyAuth: + - CanManuallyCloseIssue summary: Manually close an event. tags: - - Event Settings + - Event Settings /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. + 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 - nullable: true - - 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 - in: query - name: alertIds - schema: - type: array - items: + - description: The ID of a specific Mobile Application. + example: tk2OLeusR3aQJD5h-rBh2A + in: query + name: mobileAppId + required: true + schema: type: string - maxItems: 1000 - minItems: 0 - uniqueItems: true + nullable: true + - 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 + 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: [ - ] - rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 - 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' + - 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 - entity: NOT_APPLICABLE + value: '5' + aggregation: SUM + threshold: + type: staticThreshold + operator: '>=' + value: 5 + lastUpdated: 0 + alertChannelIds: [] + granularity: 600000 + timeThreshold: + type: violationsInSequence + timeWindow: 600000 + customPayloadFields: [] + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 + 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/MobileAppAlertConfigWithRBACTag' description: OK security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Get all Mobile Smart Alert Configs tags: - - Event Settings + - Event Settings post: description: 'Creates a new Mobile Smart Alert Configuration. ' operationId: createMobileAppAlertConfig @@ -11270,16 +11847,16 @@ paths: application/json: example: name: 'HTTP Status Code(s): 5XX' - description: Occurrences of HTTP Status Code 5XX (Server Error) is above - the expectation. + 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: [ - ] + elements: [] rule: alertType: statusCode metricName: httpxxx @@ -11289,16 +11866,14 @@ paths: threshold: type: staticThreshold operator: '>=' - value: 5.0 + value: 5 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 - customPayloadFields: [ - ] + customPayloadFields: [] schema: $ref: '#/components/schemas/MobileAppAlertConfig' required: true @@ -11308,16 +11883,16 @@ paths: application/json: example: name: 'HTTP Status Code(s): 5XX' - description: Occurrences of HTTP Status Code 5XX (Server Error) is - above the expectation. + 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: [ - ] + elements: [] rule: alertType: statusCode metricName: httpxxx @@ -11327,16 +11902,14 @@ paths: threshold: type: staticThreshold operator: '>=' - value: 5.0 + value: 5 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 - customPayloadFields: [ - ] + customPayloadFields: [] id: qOW5jlR5TQafXKWDIceRkA created: 1707224011842 initialCreated: 1707224011842 @@ -11346,24 +11919,24 @@ paths: 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 + - 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 @@ -11374,15 +11947,14 @@ paths: '422': description: Unprocessable request - missing/invalid data. security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Create Mobile Smart Alert Config tags: - - Event Settings + - Event Settings /api/events/settings/mobile-app-alert-configs/bulk/delete: put: - description: Deletes multiple Mobile Smart Alert Configurations in a single - request. + description: Deletes multiple Mobile Smart Alert Configurations in a single request. operationId: bulkDeleteMobileAppAlertConfigs requestBody: content: @@ -11403,15 +11975,14 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Bulk delete Mobile Smart Alert Configs tags: - - Event Settings + - Event Settings /api/events/settings/mobile-app-alert-configs/bulk/disable: put: - description: Disables multiple Mobile Smart Alert Configurations in a single - request. + description: Disables multiple Mobile Smart Alert Configurations in a single request. operationId: bulkDisableMobileAppAlertConfigs requestBody: content: @@ -11432,15 +12003,14 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Bulk disable Mobile Smart Alert Configs tags: - - Event Settings + - Event Settings /api/events/settings/mobile-app-alert-configs/bulk/enable: put: - description: Enables multiple Mobile Smart Alert Configurations in a single - request. + description: Enables multiple Mobile Smart Alert Configurations in a single request. operationId: bulkEnableMobileAppAlertConfigs requestBody: content: @@ -11461,23 +12031,23 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Bulk enable Mobile Smart Alert Configs tags: - - Event Settings + - Event Settings /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 + - 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: Successful - no content to return. @@ -11486,48 +12056,50 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Delete Mobile Smart Alert Config tags: - - Event Settings + - Event Settings get: - description: Gets a specific Mobile Smart Alert Configuration. This may return - a deleted Configuration. + 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 + - 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. + 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: [ - ] + elements: [] rule: alertType: statusCode metricName: httpxxx @@ -11537,19 +12109,17 @@ paths: threshold: type: staticThreshold operator: '>=' - value: 5.0 + value: 5 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 - customPayloadFields: [ - ] + customPayloadFields: [] rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 id: qOW5jlR5TQafXKWDIceRkA created: 1707224011842 initialCreated: 1707224011842 @@ -11559,24 +12129,24 @@ paths: 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 + - 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/MobileAppAlertConfigWithRBACTag' description: OK @@ -11585,37 +12155,37 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Get Mobile Smart Alert Config tags: - - Event Settings + - Event Settings 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 + - 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. + 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: [ - ] + elements: [] rule: alertType: statusCode metricName: httpxxx @@ -11625,16 +12195,14 @@ paths: threshold: type: staticThreshold operator: '>=' - value: 5.0 + value: 5 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 - customPayloadFields: [ - ] + customPayloadFields: [] schema: $ref: '#/components/schemas/MobileAppAlertConfig' required: true @@ -11644,16 +12212,16 @@ paths: application/json: example: name: 'HTTP Status Code(s): 5XX' - description: Occurrences of HTTP Status Code 5XX (Server Error) is - above the expectation. + 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: [ - ] + elements: [] rule: alertType: statusCode metricName: httpxxx @@ -11663,16 +12231,14 @@ paths: threshold: type: staticThreshold operator: '>=' - value: 5.0 + value: 5 lastUpdated: 0 - alertChannelIds: [ - ] + alertChannelIds: [] granularity: 600000 timeThreshold: type: violationsInSequence timeWindow: 600000 - customPayloadFields: [ - ] + customPayloadFields: [] id: qOW5jlR5TQafXKWDIceRkA created: 1707224011842 initialCreated: 1707224011842 @@ -11682,24 +12248,24 @@ paths: 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 + - 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 @@ -11716,23 +12282,23 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Update Mobile Smart Alert Config tags: - - Event Settings + - Event Settings /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 + - 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: @@ -11747,23 +12313,23 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Disable Mobile Smart Alert Config tags: - - Event Settings + - Event Settings /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 + - 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: @@ -11778,32 +12344,33 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Enable Mobile Smart Alert Config tags: - - Event Settings + - Event Settings /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 + - 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: @@ -11818,25 +12385,26 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Restore Mobile Smart Alert Config tags: - - Event Settings + - Event Settings /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. + 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 + - description: ID of a specific Mobile Smart Alert Configuration to recalculate. + example: qOW5jlR5TQafXKWDIceRkA + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -11845,7 +12413,8 @@ paths: nullable: true responses: '200': - description: Mobile Smart Alert Configuration baseline successfully recalculated + description: >- + Mobile Smart Alert Configuration baseline successfully recalculated and updated. '204': description: Baseline recalculation completed with no changes needed. @@ -11858,40 +12427,41 @@ paths: '428': description: Baseline calculation failed due to insufficient data. security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Recalculate Mobile Smart Alert Config Baseline tags: - - Event Settings + - Event Settings /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. + 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 + - 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 + - id: qOW5jlR5TQafXKWDIceRkA + created: 1706686318650 + enabled: true + deleted: false + changeSummary: + changeType: CREATE + author: + id: 5ee8a3e8cd70020001ecb007 + type: USER + fullName: Stan schema: type: array items: @@ -11902,15 +12472,14 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureMobileAppSmartAlerts + - ApiKeyAuth: + - CanConfigureMobileAppSmartAlerts summary: Get Mobile Smart Alert Config Versions tags: - - Event Settings + - Event Settings /api/events/settings/shortcode/current-prefix: get: - description: Returns the current shortcode prefix and enabled state used for - events. + description: Returns the current shortcode prefix and enabled state used for events. operationId: getCurrentPrefix responses: '200': @@ -11919,6 +12488,7 @@ paths: example: prefix: INSTANA- enabled: true + includeInTitle: false schema: $ref: '#/components/schemas/PrefixObject' description: The current shortcode prefix and enabled state. @@ -11927,17 +12497,19 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: [ - ] + - ApiKeyAuth: [] summary: Get current shortcode prefix. tags: - - Event Settings + - Event Settings 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. + 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. If the + provided prefix is longer than 6 characters, the request returns HTTP + 400 with the message 'Prefix length exceeds maximum length'. operationId: updatePrefix requestBody: content: @@ -11948,16 +12520,21 @@ paths: value: prefix: '' enabled: false - Enable with custom prefix: - description: Enable shortcodes with INSTANA- prefix (default) + includeInTitle: false + Enable with custom prefix and include in title: + description: >- + Enable shortcodes with INSTA- prefix (default) and include in + incident title value: - prefix: INSTANA- + prefix: INSTA- enabled: true + includeInTitle: true Enable with production prefix: description: Enable shortcodes with PROD- prefix for production incidents value: prefix: PROD- enabled: true + includeInTitle: false schema: $ref: '#/components/schemas/PrefixObject' description: The new prefix configuration including the enabled state @@ -11969,119 +12546,124 @@ paths: example: prefix: PROD- enabled: true + includeInTitle: false schema: $ref: '#/components/schemas/PrefixObject' description: The prefix and enabled state were successfully updated. + '400': + content: + application/json: + example: + message: Prefix length exceeds maximum length + description: The provided prefix is longer than 6 characters. '401': description: Unauthorized access - requires user authentication. '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: [ - ] + - ApiKeyAuth: [] summary: Update shortcode prefix. tags: - - Event Settings + - Event Settings /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. + 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 - nullable: true - - 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: + - description: The ID of a specific Website + example: XIZGGVT1TX2O-0OFeT2Yig + in: query + name: websiteId + required: true + schema: type: string - maxItems: 1000 - minItems: 0 - uniqueItems: true + nullable: true + - 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 - rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 + - 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 + 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 + rbacTags: + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 schema: type: array items: $ref: '#/components/schemas/WebsiteAlertConfigWithRBACTag' description: OK security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Get all Website Smart Alert Configs tags: - - Event Settings + - Event Settings post: description: Creates a new Website Smart Alert Configuration. operationId: createWebsiteAlertConfig @@ -12097,8 +12679,7 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] rule: alertType: slowness metricName: onLoadTime @@ -12108,35 +12689,34 @@ paths: 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 + - - 0 + - 239.164 + - 6.1026 + - - 600000 + - 240.0013 + - 7.4109 + - - 85200000 + - 241.3653 + - 3 + - - 85800000 + - 239.4759 + - 3.9012 + deviationFactor: 3 lastUpdated: 0 - alertChannelIds: [ - ] + 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 + - type: staticString + key: '1' + value: '2' + - type: dynamic + key: '2' + value: + tagName: beacon.website.name + key: null schema: $ref: '#/components/schemas/WebsiteAlertConfig' required: true @@ -12153,8 +12733,7 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] rule: alertType: slowness metricName: onLoadTime @@ -12164,35 +12743,34 @@ paths: 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 + - - 0 + - 239.164 + - 6.1026 + - - 600000 + - 240.0013 + - 7.4109 + - - 85200000 + - 241.3653 + - 3 + - - 85800000 + - 239.4759 + - 3.9012 + deviationFactor: 3 lastUpdated: 0 - alertChannelIds: [ - ] + 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 + - 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 @@ -12210,24 +12788,25 @@ paths: '428': description: Baseline calculation failed due to insufficient data. security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Create Website Smart Alert Config tags: - - Event Settings + - Event Settings /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. + 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 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: string required: true @@ -12241,24 +12820,25 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Bulk Delete Website Smart Alert Configs tags: - - Event Settings + - Event Settings /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. + 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 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: string required: true @@ -12272,24 +12852,25 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Bulk Disable Website Smart Alert Configs tags: - - Event Settings + - Event Settings /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. + 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 + - alert-id-1 + - alert-id-2 + - alert-id-3 schema: type: string required: true @@ -12303,23 +12884,23 @@ paths: '422': description: A non-empty ids set containing 1 to 1000 items is required security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Bulk Enable Website Smart Alert Configs tags: - - Event Settings + - Event Settings /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 + - 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: Successful - no content to return. @@ -12328,31 +12909,34 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Delete Website Smart Alert Config tags: - - Event Settings + - Event Settings get: - description: Gets a specific Website Smart Alert Configuration. This may return - a deleted Configuration. + 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 + - 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: @@ -12366,8 +12950,7 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] rule: alertType: slowness metricName: onLoadTime @@ -12377,43 +12960,42 @@ paths: 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 + - - 0 + - 239.164 + - 6.1026 + - - 600000 + - 240.0013 + - 7.4109 + - - 85200000 + - 241.3653 + - 3 + - - 85800000 + - 239.4759 + - 3.9012 + deviationFactor: 3 lastUpdated: 0 - alertChannelIds: [ - ] + 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 + - 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 rbacTags: - - id: 0xHKaxfaS161Al6Qc23g4w - displayName: team 1 + - id: 0xHKaxfaS161Al6Qc23g4w + displayName: team 1 schema: $ref: '#/components/schemas/WebsiteAlertConfigWithRBACTag' description: OK @@ -12422,22 +13004,22 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Get Website Smart Alert Config tags: - - Event Settings + - Event Settings 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 + - 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: @@ -12450,8 +13032,7 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] rule: alertType: slowness metricName: onLoadTime @@ -12461,35 +13042,34 @@ paths: 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 + - - 0 + - 239.164 + - 6.1026 + - - 600000 + - 240.0013 + - 7.4109 + - - 85200000 + - 241.3653 + - 3 + - - 85800000 + - 239.4759 + - 3.9012 + deviationFactor: 3 lastUpdated: 0 - alertChannelIds: [ - ] + 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 + - type: staticString + key: '1' + value: '2' + - type: dynamic + key: '2' + value: + tagName: beacon.website.name + key: null schema: $ref: '#/components/schemas/WebsiteAlertConfig' required: true @@ -12506,8 +13086,7 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] rule: alertType: slowness metricName: onLoadTime @@ -12517,35 +13096,34 @@ paths: 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 + - - 0 + - 239.164 + - 6.1026 + - - 600000 + - 240.0013 + - 7.4109 + - - 85200000 + - 241.3653 + - 3 + - - 85800000 + - 239.4759 + - 3.9012 + deviationFactor: 3 lastUpdated: 0 - alertChannelIds: [ - ] + 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 + - 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 @@ -12569,23 +13147,23 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Update Website Smart Alert Config tags: - - Event Settings + - Event Settings /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 + - 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: @@ -12600,23 +13178,23 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Disable Website Smart Alert Config tags: - - Event Settings + - Event Settings /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 + - 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: @@ -12631,32 +13209,33 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Enable Website Smart Alert Config tags: - - Event Settings + - Event Settings /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 + - 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: @@ -12671,25 +13250,26 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Restore Website Smart Alert Config tags: - - Event Settings + - Event Settings /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. + 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 + - description: ID of a specific Website Smart Alert Configuration to recalculate. + example: G-h5p0znTHan2m2U3c-Z1Q + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -12698,7 +13278,8 @@ paths: nullable: true responses: '200': - description: Website Smart Alert Configuration baseline successfully recalculated + description: >- + Website Smart Alert Configuration baseline successfully recalculated and updated. '204': description: Baseline recalculation completed with no changes needed. @@ -12711,40 +13292,41 @@ paths: '428': description: Baseline calculation failed due to insufficient data. security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: Recalculate Website Smart Alert Config Baseline tags: - - Event Settings + - Event Settings /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. + 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 + - 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 + - id: G-h5p0znTHan2m2U3c-Z1Q + created: 1706709825308 + enabled: true + deleted: false + changeSummary: + changeType: CREATE + author: + id: 5ee8a3e8cd70020001ecb007 + type: USER + fullName: Stan schema: type: array items: @@ -12755,29 +13337,29 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureWebsiteSmartAlerts + - ApiKeyAuth: + - CanConfigureWebsiteSmartAlerts summary: 'Get Website Smart Alert Config Versions. ' tags: - - Event Settings + - Event Settings /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 - - description: Option to include event metadata - example: true - in: query - name: includeMetadata - schema: - type: boolean + - description: ID of a specific Event to retrieve. + example: LZOGo1lXR4WeCB2ftgtGGQ + in: path + name: eventId + required: true + schema: + type: string + - description: Option to include event metadata + example: true + in: query + name: includeMetadata + schema: + type: boolean responses: '200': content: @@ -12789,14 +13371,18 @@ paths: 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) + 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) + 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' @@ -12804,67 +13390,63 @@ paths: '404': description: The requested event does not exist. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Event tags: - - Events + - Events /api/filters: get: operationId: get responses: default: content: - application/json: { - } + application/json: {} description: default response post: operationId: post responses: default: content: - application/json: { - } + application/json: {} description: default response /api/filters/{id}: delete: operationId: delete parameters: - - in: path - name: id - required: true - schema: - type: string + - in: path + name: id + required: true + schema: + type: string responses: default: content: - application/json: { - } + application/json: {} description: default response put: operationId: put parameters: - - in: path - name: id - required: true - schema: - type: string + - in: path + name: id + required: true + schema: + type: string responses: default: content: - application/json: { - } + application/json: {} description: default response /api/genai-monitoring/analyze/tasks/{rootId}: get: operationId: getTaskFlowsByRootId parameters: - - in: path - name: rootId - required: true - schema: - type: string - minLength: 1 + - in: path + name: rootId + required: true + schema: + type: string + minLength: 1 responses: '200': description: Task hierarchy retrieved successfully @@ -12873,19 +13455,19 @@ paths: '500': description: Failed to retrieve task hierarchy security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get task flow hierarchy by root ID (built in genai-analytics-reader) tags: - - Application Analyze + - Application Analyze /api/genai-monitoring/evaluations: get: operationId: getEvaluations parameters: - - in: query - name: clientId - schema: - type: string + - in: query + name: clientId + schema: + type: string responses: '200': content: @@ -12896,11 +13478,11 @@ paths: '500': description: Failed to retrieve evaluations security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all evaluations tags: - - LLM Evaluation + - LLM Evaluation post: operationId: createEvaluation requestBody: @@ -12920,11 +13502,11 @@ paths: '500': description: Failed to create evaluation security: - - ApiKeyAuth: - - CanConfigureGenAiEvaluations + - ApiKeyAuth: + - CanConfigureGenAiEvaluations summary: Create a new evaluation definition tags: - - LLM Evaluation + - LLM Evaluation /api/genai-monitoring/evaluations/gateway-status: get: operationId: getGatewayStatus @@ -12938,27 +13520,27 @@ paths: '500': description: Failed to check gateway status security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Check gateway status for evaluation capability tags: - - LLM Evaluation + - LLM Evaluation /api/genai-monitoring/evaluations/runs: get: operationId: getEvaluationRuns parameters: - - in: query - name: windowSize - schema: - type: integer - format: int64 - description: 'Time window size in milliseconds (default: 30 days)' - - in: query - name: to - schema: - type: integer - format: int64 - description: 'End time in milliseconds since epoch (default: current time)' + - in: query + name: windowSize + schema: + type: integer + format: int64 + description: 'Time window size in milliseconds (default: 30 days)' + - in: query + name: to + schema: + type: integer + format: int64 + description: 'End time in milliseconds since epoch (default: current time)' responses: '200': content: @@ -12971,20 +13553,20 @@ paths: '500': description: Failed to retrieve evaluation runs security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all evaluation runs tags: - - LLM Evaluation + - LLM Evaluation /api/genai-monitoring/evaluations/{evaluationId}: delete: operationId: deleteEvaluation parameters: - - in: path - name: evaluationId - required: true - schema: - type: string + - in: path + name: evaluationId + required: true + schema: + type: string responses: '200': description: Evaluation deleted successfully @@ -12993,19 +13575,19 @@ paths: '500': description: Failed to delete evaluation security: - - ApiKeyAuth: - - CanConfigureGenAiEvaluations + - ApiKeyAuth: + - CanConfigureGenAiEvaluations summary: Delete an evaluation tags: - - LLM Evaluation + - LLM Evaluation get: operationId: getEvaluation parameters: - - in: path - name: evaluationId - required: true - schema: - type: string + - in: path + name: evaluationId + required: true + schema: + type: string responses: '200': content: @@ -13018,19 +13600,19 @@ paths: '500': description: Failed to retrieve evaluation security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get evaluation details by ID tags: - - LLM Evaluation + - LLM Evaluation put: operationId: updateEvaluation parameters: - - in: path - name: evaluationId - required: true - schema: - type: string + - in: path + name: evaluationId + required: true + schema: + type: string requestBody: content: '*/*': @@ -13044,20 +13626,20 @@ paths: '500': description: Failed to update evaluation security: - - ApiKeyAuth: - - CanConfigureGenAiEvaluations + - ApiKeyAuth: + - CanConfigureGenAiEvaluations summary: Update an evaluation tags: - - LLM Evaluation + - LLM Evaluation /api/genai-monitoring/evaluations/{evaluationId}/run: post: operationId: runEvaluation parameters: - - in: path - name: evaluationId - required: true - schema: - type: string + - in: path + name: evaluationId + required: true + schema: + type: string responses: '200': content: @@ -13072,38 +13654,38 @@ paths: '500': description: Failed to run evaluation security: - - ApiKeyAuth: - - CanConfigureGenAiEvaluations + - ApiKeyAuth: + - CanConfigureGenAiEvaluations summary: Run an evaluation tags: - - LLM Evaluation + - LLM Evaluation /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 + - 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: @@ -13126,38 +13708,38 @@ paths: $ref: '#/components/schemas/SnapshotResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Query host agent snapshots tags: - - Host Agent + - Host Agent /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 + - 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: @@ -13167,33 +13749,32 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canConfigureAgents + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents summary: Update agent configuration by query tags: - - Host Agent + - Host Agent x-description: updateConfigurationByQuery /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 + - in: query + name: query + required: true + schema: + type: string + minLength: 1 + - in: query + name: size + schema: + type: integer + format: int32 requestBody: content: application/json: @@ -13203,79 +13784,76 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canConfigureAgentRunMode + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgentRunMode summary: Update agent run mode by query tags: - - Host Agent + - Host Agent x-description: updateModeByQuery /api/host-agent/{hostId}/clr-logs: get: operationId: getAgentClrLogs parameters: - - in: path - name: hostId - required: true - schema: - type: string - minLength: 1 - - in: query - name: download - schema: - type: boolean + - in: path + name: hostId + required: true + schema: + type: string + minLength: 1 + - in: query + name: download + schema: + type: boolean responses: default: content: - application/octet-stream: { - } + application/octet-stream: {} description: default response security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canConfigureAgents + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents summary: Agent CLR download logs tags: - - Host Agent + - Host Agent /api/host-agent/{hostId}/configuration: get: operationId: getAgentConfigurationByHost parameters: - - in: path - name: hostId - required: true - schema: - type: string - minLength: 1 + - in: path + name: hostId + required: true + schema: + type: string + minLength: 1 responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canDownloadAgentConfiguration + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canDownloadAgentConfiguration summary: Get effective Agent configuration tags: - - Host Agent + - Host Agent post: operationId: updateConfigurationByHost parameters: - - in: path - name: hostId - required: true - schema: - type: string - minLength: 1 + - in: path + name: hostId + required: true + schema: + type: string + minLength: 1 requestBody: content: application/json: @@ -13285,64 +13863,62 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canConfigureAgents + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents summary: Update agent configuration by host tags: - - Host Agent + - Host Agent x-description: updateConfigurationByHost /api/host-agent/{hostId}/logs: get: operationId: getAgentLogs parameters: - - in: path - name: hostId - required: true - schema: - type: string - minLength: 1 - - in: query - name: download - schema: - type: boolean - - in: query - name: file - required: true - schema: - type: array - items: + - in: path + name: hostId + required: true + schema: type: string - uniqueItems: true + minLength: 1 + - 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: { - } + application/octet-stream: {} description: default response security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canConfigureAgents + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents summary: Agent download logs tags: - - Host Agent + - Host Agent /api/host-agent/{hostId}/mode: post: operationId: updateModeByHost parameters: - - in: path - name: hostId - required: true - schema: - type: string - minLength: 1 + - in: path + name: hostId + required: true + schema: + type: string + minLength: 1 requestBody: content: application/json: @@ -13352,92 +13928,89 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canConfigureAgentRunMode + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgentRunMode summary: Update agent run mode by host tags: - - Host Agent + - Host Agent x-description: updateModeByHost /api/host-agent/{hostId}/support-info: get: operationId: getAgentSupportInformation parameters: - - in: path - name: hostId - required: true - schema: - type: string - minLength: 1 - - in: query - name: supportInfoId - required: true - schema: - type: string - minLength: 1 + - in: path + name: hostId + required: true + schema: + type: string + minLength: 1 + - in: query + name: supportInfoId + required: true + schema: + type: string + minLength: 1 responses: default: content: - application/octet-stream: { - } + application/octet-stream: {} description: default response security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canConfigureAgents + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents summary: Agent download support information tags: - - Host Agent + - Host Agent /api/host-agent/{hostId}/update: post: operationId: updateAgent parameters: - - in: path - name: hostId - required: true - schema: - type: string - minLength: 1 + - in: path + name: hostId + required: true + schema: + type: string + minLength: 1 responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - Default - - ApiKeyAuth: - - canConfigureAgents + - ApiKeyAuth: + - Default + - ApiKeyAuth: + - canConfigureAgents summary: Agent update tags: - - Host Agent + - Host Agent /api/host-agent/{id}: get: operationId: getAgentSnapshot parameters: - - in: path - name: id - required: true - schema: - type: string - minLength: 1 - - in: query - name: to - schema: - type: integer - format: int64 - - in: query - name: windowSize - schema: - type: integer - format: int64 + - in: path + name: id + required: true + schema: + type: string + minLength: 1 + - in: query + name: to + schema: + type: integer + format: int64 + - in: query + name: windowSize + schema: + type: integer + format: int64 responses: '200': content: @@ -13526,24 +14099,28 @@ paths: $ref: '#/components/schemas/SnapshotItem' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get host agent snapshot details tags: - - Host Agent + - Host Agent /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. + 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 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. + description: >- + This example retrieves first 20 hosts by name with metrics for + cpu and memory used. value: timeFrame: to: 1764687385227 @@ -13551,22 +14128,22 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] pagination: retrievalSize: 20 type: host metrics: - - metric: cpu.used - aggregation: MEAN - - metric: memory.used - aggregation: MEAN + - metric: cpu.used + aggregation: MEAN + - metric: memory.used + aggregation: MEAN 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. + description: >- + This example retrieves the next 20 hosts by name with metrics + for cpu and memory used. value: timeFrame: to: 1764687385227 @@ -13574,8 +14151,7 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] pagination: retrievalSize: 20 totalHits: 101 @@ -13584,10 +14160,10 @@ paths: offset: 20 type: host metrics: - - metric: cpu.used - aggregation: MEAN - - metric: memory.used - aggregation: MEAN + - metric: cpu.used + aggregation: MEAN + - metric: memory.used + aggregation: MEAN order: by: label direction: ASC @@ -13602,27 +14178,32 @@ paths: $ref: '#/components/schemas/InfrastructureEntitiesResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get infrastructure entities tags: - - Infrastructure Analyze + - Infrastructure Analyze /api/infrastructure-monitoring/analyze/entity-groups: post: - description: |- - This endpoint groups entities for a given entity type and aggregates metrics for these groups. Optional group sampling can be enabled to reduce BeeInstana load by fetching metrics for only 50% of groups, providing faster response times with representative data. - For more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze. + description: >- + This endpoint groups entities for a given entity type and aggregates + metrics for these groups. Optional group sampling can be enabled to + reduce BeeInstana load by fetching metrics for only 50% of groups, + providing faster response times with representative data. + + 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). + 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 @@ -13630,26 +14211,25 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] pagination: retrievalSize: 20 groupBy: - - host.name + - 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 + - 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 @@ -13664,16 +14244,18 @@ paths: $ref: '#/components/schemas/InfrastructureGroupsResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get grouped infrastructure entities with aggregated metrics tags: - - Infrastructure Analyze + - Infrastructure Analyze /api/infrastructure-monitoring/analyze/entity-types: post: - description: |- + 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. + + 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: @@ -13685,8 +14267,7 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] timeFrame: to: 1673969562715 windowSize: 3600000 @@ -13701,30 +14282,30 @@ paths: $ref: '#/components/schemas/AvailablePlugins' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get available entity types tags: - - Infrastructure Analyze + - Infrastructure Analyze /api/infrastructure-monitoring/analyze/metrics: post: - description: |- + 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. + + 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. + description: This example retrieves all available metrics for JVM entities. value: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] timeFrame: to: 1673969562715 windowSize: 3600000 @@ -13741,33 +14322,33 @@ paths: $ref: '#/components/schemas/AvailableMetrics' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get available metrics tags: - - Infrastructure Analyze + - Infrastructure Analyze /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 + - 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: @@ -13778,25 +14359,26 @@ paths: $ref: '#/components/schemas/MetricInstance' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get metric catalog tags: - - Infrastructure Catalog + - Infrastructure Catalog x-description: getInfrastructureCatalogMetrics /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. ' + 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 + - description: plugin id + example: db2Database + in: path + name: pluginId + required: true + schema: + type: string responses: '200': content: @@ -13812,11 +14394,11 @@ paths: parameters: payloadKey: $response.body#/[*] security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get payload keys for plugin tags: - - Infrastructure Catalog + - Infrastructure Catalog x-description: getAvailablePayloadKeysByPluginId /api/infrastructure-monitoring/catalog/plugins: get: @@ -13831,16 +14413,15 @@ paths: $ref: '#/components/schemas/PluginResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get plugin catalog tags: - - Infrastructure Catalog + - Infrastructure Catalog x-description: getInfrastructureCatalogPlugins /api/infrastructure-monitoring/catalog/plugins-with-custom-metrics: get: - description: This endpoint retrieves a list of all plugins that have custom - metrics + description: This endpoint retrieves a list of all plugins that have custom metrics operationId: getInfrastructureCatalogPluginsWithCustomMetrics responses: '200': @@ -13852,11 +14433,11 @@ paths: $ref: '#/components/schemas/PluginResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all plugins with custom metrics catalog tags: - - Infrastructure Catalog + - Infrastructure Catalog x-description: getInfrastructureCatalogPluginsWithCustomMetrics /api/infrastructure-monitoring/catalog/search: get: @@ -13871,11 +14452,11 @@ paths: $ref: '#/components/schemas/SearchFieldResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: get search field catalog tags: - - Infrastructure Catalog + - Infrastructure Catalog x-description: getInfrastructureCatalogSearchFields /api/infrastructure-monitoring/catalog/tags: get: @@ -13889,23 +14470,23 @@ paths: $ref: '#/components/schemas/TagCatalog' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get available tags tags: - - Infrastructure Catalog + - Infrastructure Catalog /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 + - description: plugin + example: host + in: path + name: plugin + required: true + schema: + type: string responses: '200': content: @@ -13914,72 +14495,84 @@ paths: $ref: '#/components/schemas/TagCatalog' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get available tags for a particular plugin tags: - - Infrastructure Catalog + - Infrastructure Catalog /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 - nullable: true - - description: Timestamp since Unix Epoch in milliseconds of the end of the - time window - in: query - name: to - schema: - type: integer - format: int64 - nullable: true + - 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 + nullable: true + - description: >- + Timestamp since Unix Epoch in milliseconds of the end of the time + window + in: query + name: to + schema: + type: integer + format: int64 + nullable: true responses: '200': content: application/json: example: - - ZoKkksp277FMLSXIghPKdjZcvfE + - ZoKkksp277FMLSXIghPKdjZcvfE schema: type: array items: type: string description: Returns the snapshot ID of the hosts security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Related hosts tags: - - Infrastructure Topology + - Infrastructure Topology /api/infrastructure-monitoring/metrics: post: - description: |2- + description: >- + + For more information on Infrastructure Metrics please access the + https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-metrics. - 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) + + - 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 - name: offline - schema: - type: boolean + - in: query + name: offline + schema: + type: boolean requestBody: content: application/json: @@ -14001,41 +14594,48 @@ paths: description: Invalid query value: errors: - - Invalid metric query, query should not be empty or wildcard(*) + - >- + 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. + - >- + 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! + - 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 + - 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 + - >- + The rollup in relation to the windowSize provides too + many values description: 'Bad Request - Invalid request parameters. Possible error messages:' security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get infrastructure metrics tags: - - Infrastructure Metrics + - Infrastructure Metrics x-description: getInfrastructureMetrics /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 + 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: @@ -14050,151 +14650,154 @@ paths: $ref: '#/components/schemas/MonitoringState' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Monitored host count tags: - - Infrastructure Resources + - Infrastructure Resources /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. + 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 + - 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 + - DEFERRED_VALUE: '64' + DEFERRED_VALUE_FLAGS: NONE + VALUE: '64' + NAME: app_ctl_heap_sz + VALUE_FLAGS: NONE timestamp: 1707833086000 description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get a payload for a snapshot tags: - - Infrastructure Resources + - Infrastructure Resources x-description: getPluginPayload /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 + - 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 + - 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 + - ApiKeyAuth: + - Default summary: Search snapshots tags: - - Infrastructure Resources + - Infrastructure Resources x-description: getSnapshots post: - description: This endpoint retrieves detail information for one or more snapshots. + description: >- + This endpoint retrieves detail information for one or more snapshots. timeFrame defaults to the last 10 minutes if not specified. operationId: postSnapshots requestBody: @@ -14202,12 +14805,13 @@ paths: application/json: examples: This example retrieves the detail information for two snapshots.: - description: This example retrieves the detail information for two + description: >- + This example retrieves the detail information for two snapshots. value: snapshotIds: - - AB3DeFGHIJkLm9OpQrstUVwxY_z - - ZY4XwVUTSRqPo8MlKjihGFedC_a + - AB3DeFGHIJkLm9OpQrstUVwxY_z + - ZY4XwVUTSRqPo8MlKjihGFedC_a timeFrame: to: 1689018652000 windowSize: 3600000 @@ -14222,36 +14826,36 @@ paths: $ref: '#/components/schemas/PostSnapshotsResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get snapshot details for multiple snapshots tags: - - Infrastructure Resources + - Infrastructure Resources /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 + - 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: @@ -14260,8 +14864,7 @@ paths: snapshotId: ZoKkksp277FMLSXIghPKdjZcvfE plugin: host from: 1706785156000 - tags: [ - ] + tags: [] label: ip-10-255-200-30.instana.io entityId: host: EC2-i-03afb0ac5188f57f3 @@ -14271,17 +14874,20 @@ paths: 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 + - 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 + - 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 @@ -14294,18 +14900,21 @@ paths: /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 - - / + - >- + /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: [ - ] + tags: [] cpu.count: 8 hostname: ip-10-255-200-30 machineId: ec2f95ff87a4a46d4672835afb9e2bb5 @@ -14315,82 +14924,89 @@ paths: $ref: '#/components/schemas/SnapshotItem' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get snapshot details tags: - - Infrastructure Resources + - Infrastructure Resources /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. + 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 + 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 - nullable: true - - description: Filter on discoveryType - example: NATIVE_SENSOR - in: query - name: discoveryType - schema: - type: string - enum: - - NATIVE_SENSOR - - REMOTE_SENSOR - - PACKAGE_MANAGER - - OTHER - nullable: true - - 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 - nullable: true - - description: Filter on this software name - in: query - name: name - schema: - type: string - nullable: true - - description: Filter on this plugin - in: query - name: plugin - schema: - type: string - nullable: true - - description: Filter on this version - in: query - name: version - schema: - type: string - nullable: true - - description: Filter on this vendor - in: query - name: vendor - schema: - type: string - nullable: true + - description: Timeframe expressed as the Unix epoch time in milliseconds + in: query + name: time + schema: + type: integer + format: int64 + nullable: true + - description: Filter on discoveryType + example: NATIVE_SENSOR + in: query + name: discoveryType + schema: + type: string + enum: + - NATIVE_SENSOR + - REMOTE_SENSOR + - PACKAGE_MANAGER + - OTHER + nullable: true + - 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 + nullable: true + - description: Filter on this software name + in: query + name: name + schema: + type: string + nullable: true + - description: Filter on this plugin + in: query + name: plugin + schema: + type: string + nullable: true + - description: Filter on this version + in: query + name: version + schema: + type: string + nullable: true + - description: Filter on this vendor + in: query + name: vendor + schema: + type: string + nullable: true responses: '200': content: @@ -14438,46 +15054,47 @@ paths: $ref: '#/components/schemas/SoftwareVersion' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get installed software tags: - - Infrastructure Resources + - Infrastructure Resources /api/infrastructure-monitoring/topology: get: operationId: getTopology parameters: - - description: Include snapshot data in nodes - in: query - name: includeData - schema: - type: boolean + - 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 + - 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 + - source: i5wh2JGMSHMiSt_TH2sHo1rNLaQ + destination: k67B5nn-7mpx6i0oCEiIWvP46ko + relation: in schema: $ref: '#/components/schemas/Topology' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Gets the infrastructure topology tags: - - Infrastructure Topology + - Infrastructure Topology /api/instana/health: get: description: Get basic health of application. @@ -14488,17 +15105,16 @@ paths: application/json: example: health: GREEN - messages: [ - ] + messages: [] schema: $ref: '#/components/schemas/HealthState' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Basic health traffic light tags: - - Health + - Health x-description: getHealthState /api/instana/usage/api: get: @@ -14513,33 +15129,33 @@ paths: $ref: '#/components/schemas/UsageResult' description: OK security: - - ApiKeyAuth: - - CanViewAccountAndBillingInformation + - ApiKeyAuth: + - CanViewAccountAndBillingInformation summary: API usage by customer tags: - - Usage + - Usage /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 + - 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: @@ -14550,27 +15166,27 @@ paths: $ref: '#/components/schemas/UsageResult' description: OK security: - - ApiKeyAuth: - - CanViewAccountAndBillingInformation + - ApiKeyAuth: + - CanViewAccountAndBillingInformation summary: API usage day / month / year tags: - - Usage + - Usage /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 + - 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: @@ -14581,33 +15197,33 @@ paths: $ref: '#/components/schemas/UsageResult' description: OK security: - - ApiKeyAuth: - - CanViewAccountAndBillingInformation + - ApiKeyAuth: + - CanViewAccountAndBillingInformation summary: API usage month / year tags: - - Usage + - Usage /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 + - 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: @@ -14618,27 +15234,27 @@ paths: $ref: '#/components/schemas/UsageResult' description: OK security: - - ApiKeyAuth: - - CanViewAccountAndBillingInformation + - ApiKeyAuth: + - CanViewAccountAndBillingInformation summary: Host count day / month / year tags: - - Usage + - Usage /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 + - 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: @@ -14649,11 +15265,11 @@ paths: $ref: '#/components/schemas/UsageResult' description: OK security: - - ApiKeyAuth: - - CanViewAccountAndBillingInformation + - ApiKeyAuth: + - CanViewAccountAndBillingInformation summary: Host count month / year tags: - - Usage + - Usage /api/instana/version: get: description: Get lastest API version information. @@ -14670,77 +15286,74 @@ paths: $ref: '#/components/schemas/InstanaVersionInfo' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: API version information tags: - - Health + - Health x-description: getVersion /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 + - 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: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default /api/internal/custom-dashboard/{dashboardId}: get: operationId: getInternalDashboard parameters: - - in: path - name: dashboardId - required: true - schema: - type: string + - in: path + name: dashboardId + required: true + schema: + type: string responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default /api/license: get: operationId: get_1 responses: default: content: - application/json: { - } + application/json: {} description: default response /api/llm/capabilities: get: @@ -14751,94 +15364,97 @@ paths: 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 + - 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 - - KUBERNETES_ASSISTANT - - SLO_ASSISTANT - - GENAI_EVALUATION - - EUM_QUERY_ASSISTANT + - INCIDENT_INVESTIGATION + - INCIDENT_SUMMARIZATION + - AI_ASSISTANT + - MANUAL_ACTION_GENERATION + - SCRIPT_GENERATION + - KUBERNETES_ASSISTANT + - SLO_ASSISTANT + - GENAI_EVALUATION + - EUM_QUERY_ASSISTANT description: OK '401': description: Unauthorized access - requires user authentication. '500': description: Internal server error. security: - - ApiKeyAuth: [ - ] + - ApiKeyAuth: [] summary: Get all LLM capabilities tags: - - AI Management + - AI Management /api/llm/gateways: get: - description: Retrieve all AI connections. Optionally filter by enabled status - or capability. + description: >- + Retrieve all AI connections. 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 + - 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 + - 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:00.000Z' + modifiedAt: '2024-05-02T15:30:00.000Z' schema: type: array items: @@ -14853,11 +15469,10 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: [ - ] + - ApiKeyAuth: [] summary: Get all AI connections tags: - - AI Management + - AI Management post: description: Create a new AI connection operationId: addLLMEgressGateway @@ -14870,8 +15485,8 @@ paths: aiModel: watsonx-gpt-4 supports: capabilities: - - anomaly-detection - - remediation + - anomaly-detection + - remediation metadata: source: user version: 1.0.0 @@ -14882,8 +15497,8 @@ paths: watsonxUrl: https://watsonx.example.com instanaAgents: agents: - - agent-1 - - agent-2 + - agent-1 + - agent-2 schema: $ref: '#/components/schemas/LLMEgressGateway' required: true @@ -14898,8 +15513,8 @@ paths: aiModel: watsonx-gpt-4 supports: capabilities: - - anomaly-detection - - remediation + - anomaly-detection + - remediation metadata: source: user version: 1.0.0 @@ -14910,8 +15525,8 @@ paths: watsonxUrl: https://watsonx.example.com instanaAgents: agents: - - agent-1 - - agent-2 + - agent-1 + - agent-2 schema: $ref: '#/components/schemas/LLMEgressGateway' description: OK @@ -14922,11 +15537,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureLLM + - ApiKeyAuth: + - canConfigureLLM summary: Create a new AI connection tags: - - AI Management + - AI Management /api/llm/gateways/test: post: description: Test AI connection connection parameters @@ -14965,22 +15580,22 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureLLM + - ApiKeyAuth: + - canConfigureLLM summary: Test AI connection connection parameters tags: - - AI Management + - AI Management /api/llm/gateways/{id}: delete: description: Delete an AI connection by ID. operationId: deleteLLMEgressGateway parameters: - - description: AI connection ID - in: path - name: id - required: true - schema: - type: string + - description: AI connection ID + in: path + name: id + required: true + schema: + type: string responses: '204': description: Successful - no content to return. @@ -14993,21 +15608,21 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureLLM + - ApiKeyAuth: + - canConfigureLLM summary: Delete an AI connection tags: - - AI Management + - AI Management get: description: Retrieve an AI connection by ID. operationId: getLLMEgressGatewayById parameters: - - description: AI connection ID - in: path - name: id - required: true - schema: - type: string + - description: AI connection ID + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -15019,8 +15634,8 @@ paths: aiModel: watsonx-gpt-4 supports: capabilities: - - anomaly-detection - - remediation + - anomaly-detection + - remediation metadata: source: user version: 1.0.0 @@ -15031,10 +15646,10 @@ paths: watsonxUrl: https://watsonx.example.com instanaAgents: agents: - - agent-1 - - agent-2 - createdAt: 2024-05-01T10:00:00Z - modifiedAt: 2024-05-02T15:30:00Z + - agent-1 + - agent-2 + createdAt: '2024-05-01T10:00:00.000Z' + modifiedAt: '2024-05-02T15:30:00.000Z' schema: $ref: '#/components/schemas/LLMEgressGateway' description: OK @@ -15047,21 +15662,21 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get an AI connection by ID tags: - - AI Management + - AI Management put: description: Update an existing AI connection by ID. operationId: updateLLMEgressGateway parameters: - - description: AI connection ID - in: path - name: id - required: true - schema: - type: string + - description: AI connection ID + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -15071,8 +15686,8 @@ paths: aiModel: watsonx-gpt-4 supports: capabilities: - - anomaly-detection - - remediation + - anomaly-detection + - remediation metadata: source: user version: 1.0.0 @@ -15083,8 +15698,8 @@ paths: watsonxUrl: https://watsonx.example.com instanaAgents: agents: - - agent-1 - - agent-2 + - agent-1 + - agent-2 schema: $ref: '#/components/schemas/LLMEgressGateway' required: true @@ -15099,8 +15714,8 @@ paths: aiModel: watsonx-gpt-4 supports: capabilities: - - anomaly-detection - - remediation + - anomaly-detection + - remediation metadata: source: user version: 1.0.0 @@ -15111,8 +15726,8 @@ paths: watsonxUrl: https://watsonx.example.com instanaAgents: agents: - - agent-1 - - agent-2 + - agent-1 + - agent-2 schema: $ref: '#/components/schemas/LLMEgressGateway' description: OK @@ -15125,22 +15740,22 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureLLM + - ApiKeyAuth: + - canConfigureLLM summary: Update an existing AI connection. tags: - - AI Management + - AI Management /api/llm/gateways/{id}/disable: put: description: Disable an AI connection by ID. operationId: disableLLMEgressGateway parameters: - - description: AI connection ID - in: path - name: id - required: true - schema: - type: string + - description: AI connection ID + in: path + name: id + required: true + schema: + type: string responses: '204': description: Successful - no content to return. @@ -15153,23 +15768,24 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureLLM + - ApiKeyAuth: + - canConfigureLLM summary: Disable an AI connection tags: - - AI Management + - AI Management /api/llm/gateways/{id}/enable: put: - description: Enable an AI connection by ID. Any other enabled connection for - the same capability will be automatically disabled. + description: >- + Enable an AI connection by ID. Any other enabled connection for the same + capability will be automatically disabled. operationId: enableLLMEgressGateway parameters: - - description: AI connection ID - in: path - name: id - required: true - schema: - type: string + - description: AI connection ID + in: path + name: id + required: true + schema: + type: string responses: '204': description: Successful - no content to return. @@ -15182,44 +15798,51 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureLLM + - ApiKeyAuth: + - canConfigureLLM summary: Enable an AI connection tags: - - AI Management + - AI Management /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`). + 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 + - 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: @@ -15229,47 +15852,44 @@ paths: 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 + - 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: [ - ] + - 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 @@ -15278,35 +15898,47 @@ paths: '500': description: Unexpected server error security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Log Volume Usage tags: - - Logging Analyze + - Logging Analyze /api/logging/logs/getLogs/v1: post: - description: | - Returns logs (up to the specified retrievalSize) for a given time range with optional filters to help users + description: > + Returns logs (up to the specified retrievalSize) for a given time range + with optional filters to help users + efficiently troubleshoot and resolve issues. + **The JSON payload must include:** - - `timeConfig`: Time range configuration with `to` (Unix timestamp in milliseconds) and `windowSize` (duration in ms). - - `retrievalSize`: Maximum number of logs to return per request (required, range: `1`-`200`). + - `timeConfig`: Time range configuration with `to` (Unix timestamp in + milliseconds) and `windowSize` (duration in ms). + + + - `retrievalSize`: Maximum number of logs to return per request + (required, range: `1`-`200`). * If you specify a value > `200`, it will be automatically reduced to `200`. * Returns `HTTP 500 Internal Server Error` for values < `0`, non-integer types, or if missing. - - `orderDirection`: Sort order - "ASC" (oldest first) or "DESC" (newest first). + - `orderDirection`: Sort order - "ASC" (oldest first) or "DESC" (newest + first). + - - `offset`: (Optional) Pagination offset specifies the number of log entries to skip before returning results. + - `offset`: (Optional) Pagination offset specifies the number of + log entries to skip before returning results. * Defaults to `0`, with permitted value range: [`0`,`2000`]. * This field controls pagination by skipping a specified number of logs from the beginning of the result set. * Example: With retrievalSize=`200` and offset=`0`, you get logs `1`-`200`. To get the next page, set offset=`200` to skip the first `200` logs and retrieve logs `201`-`400`. * Example: Setting offset=10 skips the first `10` log entries and starts returning results from the 11th entry onwards * Returns `HTTP 500 Internal Server Error` response if value is negative or non-integer. - - `tagFilterExpression`: (Optional) Filter criteria for log attributes. + - `tagFilterExpression`: (Optional) Filter criteria for log + attributes. + - `requestedTags`: Array of tag names to include in the response. * You can select up to 10 tags from the available list: @@ -15343,13 +15975,17 @@ paths: **Response Payload Fields:** + - `items`: Array of log entries matching the query criteria. - - `totalHits`: Total number of log entries matching the query across all pages (not just the current page). + + - `totalHits`: Total number of log entries matching the query across all + pages (not just the current page). * Use this value to calculate total pages or display result counts to users. * Example: If totalHits=`450` and retrievalSize=`200`, you have 3 pages total (200 + 200 + 50). - - `canLoadMore`: Boolean indicating whether more log entries are available beyond the current page. + - `canLoadMore`: Boolean indicating whether more log entries are + available beyond the current page. * When true, increment the offset parameter to retrieve the next page. * Example: If retrievalSize=`200`, offset=`0`, and canLoadMore=`true`, set offset=`200` for the next request. * When false, you have reached the end of the result set. @@ -15359,11 +15995,19 @@ paths: Refer to the RequestBody section for the complete LogsQuery schema. - When using the UI to construct the curl request, select the desired filters and time window, then click the "API Query" button to automatically generate a curl request with current UI selections. By default, 4 tags are always included in requests generated by the "API Query" button, but may be changed as needed. + + When using the UI to construct the curl request, select the desired + filters and time window, then click the "API Query" button to + automatically generate a curl request with current UI selections. By + default, 4 tags are always included in requests generated by the "API + Query" button, but may be changed as needed. + ```"log.timestamp", "log.level", "log.message", "log.custom"``` - Example curl request (can be auto-generated via the "API Query" button in the Instana UI): + + Example curl request (can be auto-generated via the "API Query" button + in the Instana UI): ``` curl -X POST /api/logging/logs/getLogs/v1 \ -H "Authorization: apiToken YOUR_API_TOKEN" \ @@ -15419,26 +16063,26 @@ paths: autoRefresh: false windowSize: 3600000 requestedTags: - - log.traceId - - log.applications - - process.id - - host.name - - docker.containerName - - kubernetes.pod.name + - log.traceId + - log.applications + - process.id + - host.name + - docker.containerName + - kubernetes.pod.name tagFilterExpression: type: EXPRESSION logicalOperator: AND elements: - - type: TAG_FILTER - name: log.streamName - operator: EQUALS - entity: NOT_APPLICABLE - value: log.go - - type: TAG_FILTER - name: service.name - operator: EQUALS - entity: DESTINATION - value: dispatch + - type: TAG_FILTER + name: log.streamName + operator: EQUALS + entity: NOT_APPLICABLE + value: log.go + - type: TAG_FILTER + name: service.name + operator: EQUALS + entity: DESTINATION + value: dispatch retrievalSize: 200 offset: 0 orderDirection: DESC @@ -15454,81 +16098,83 @@ paths: description: 200 Logs value: items: - - message: Test Message - timestamp: '1234567890000' - logLevel: INFO - tags: - - name: log.custom - key: endpoint_type - value: INTERNAL - traceId: 000000000000000043500e1469c2f17a - applicationIds: - - C3lB8JC0TxaaVxKhUTc9rA - - D1YPvO1ZS7ac79DmBSw1jQ - processId: test_process_id - hostName: test_host_name - dockerContainerName: test_docker_container_name - kubernetesPodName: test_kubernetes_pod_name + - message: Test Message + timestamp: '1234567890000' + logLevel: INFO + tags: + - name: log.custom + key: endpoint_type + value: INTERNAL + traceId: 000000000000000043500e1469c2f17a + applicationIds: + - C3lB8JC0TxaaVxKhUTc9rA + - D1YPvO1ZS7ac79DmBSw1jQ + processId: test_process_id + hostName: test_host_name + dockerContainerName: test_docker_container_name + kubernetesPodName: test_kubernetes_pod_name adjustedTimeFrame: null canLoadMore: true totalHits: 225 Zero Logs: description: Zero Logs value: - items: [ - ] + items: [] adjustedTimeFrame: null canLoadMore: false totalHits: 0 schema: $ref: '#/components/schemas/LogsApiResponse' - description: Successfully retrieved logs matching the query criteria. Returns - an array of log items with metadata and pagination information. + description: >- + Successfully retrieved logs matching the query criteria. Returns an + array of log items with metadata and pagination information. '500': - description: Unexpected server error - An internal error occurred while + description: >- + Unexpected server error - An internal error occurred while processing the request. '503': - description: Service unavailable - The logging service is temporarily unavailable. - Please retry after some time. + description: >- + Service unavailable - The logging service is temporarily + unavailable. Please retry after some time. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Retrieve logs via REST API tags: - - Logging Analyze + - Logging Analyze /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 + - in: query + name: fillTimeSeries + schema: + type: boolean requestBody: content: application/json: example: metrics: - - metric: beaconCount - aggregation: SUM - granularity: 60 + - 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 + - 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 @@ -15542,18 +16188,18 @@ paths: 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 + - name: Products + earliestTimestamp: 1707023340857 + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1707026879283 + offset: 1 + metrics: + beaconCount.sum.60: + - - 1707023340000 + - 47 + - - 1707023400000 + - 43 canLoadMore: false totalHits: 1 totalRepresentedItemCount: 1 @@ -15569,11 +16215,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get grouped beacon metrics tags: - - Mobile App Analyze + - Mobile App Analyze /api/mobile-app-monitoring/analyze/beacons: post: description: API request to get all mobile app beacons with matching type. @@ -15583,10 +16229,10 @@ paths: application/json: example: tagFilters: - - entity: NOT_APPLICABLE - name: mobileBeacon.mobileApp.name - operator: EQUALS - value: robot-warehouse + - entity: NOT_APPLICABLE + name: mobileBeacon.mobileApp.name + operator: EQUALS + value: robot-warehouse timeFrame: to: null windowSize: 60000 @@ -15600,75 +16246,72 @@ paths: 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 + - 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 @@ -15680,66 +16323,68 @@ paths: $ref: '#/components/schemas/MobileAppBeaconResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all beacons tags: - - Mobile App Analyze + - Mobile App Analyze /api/mobile-app-monitoring/catalog: get: operationId: getMobileAppTagCatalog parameters: - - in: query - name: beaconType - required: true - schema: - type: string - minLength: 1 - - 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_ADAPTIVE_BASELINE_FAST_INIT - - SMART_ALERTS_CUSTOM_PAYLOAD - - SLI_MANAGEMENT - - APPLICATION_CONFIG - - APPLICATION_CONFIG_BLUEPRINT - - MAINTENANCE_WINDOWS - - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + - in: query + name: beaconType + required: true + schema: + type: string + minLength: 1 + - 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_ADAPTIVE_BASELINE_FAST_INIT + - 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 + - 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. + 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 + - ApiKeyAuth: + - Default summary: Get mobile app tag catalog tags: - - Mobile App Catalog + - Mobile App Catalog x-description: getMobileAppTagCatalog /api/mobile-app-monitoring/catalog/metrics: get: @@ -15750,25 +16395,25 @@ paths: 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 + - 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: @@ -15779,11 +16424,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Metric catalog tags: - - Mobile App Catalog + - Mobile App Catalog x-description: getMobileAppMetricCatalog /api/mobile-app-monitoring/catalog/tags: get: @@ -15794,12 +16439,12 @@ paths: content: application/json: example: - - name: mobileBeacon.view.name - type: STRING - category: MOBILE - canApplyToSource: false - canApplyToDestination: false - sourceValueAvailableFrom: 0 + - name: mobileBeacon.view.name + type: STRING + category: MOBILE + canApplyToSource: false + canApplyToDestination: false + sourceValueAvailableFrom: 0 schema: type: array items: @@ -15810,11 +16455,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all existing mobile app tags tags: - - Mobile App Catalog + - Mobile App Catalog x-description: getAllMobileAppCatalogTags /api/mobile-app-monitoring/config: get: @@ -15825,11 +16470,11 @@ paths: content: application/json: example: - - id: K3bP-bmCRkyimNai9vvq8o - name: example_mobile_app - rbacTags: - - id: test - displayName: test + - id: K3bP-bmCRkyimNai9vvq8o + name: example_mobile_app + rbacTags: + - id: test + displayName: test schema: type: array items: @@ -15840,26 +16485,31 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get configured mobile apps tags: - - Mobile App Configuration + - Mobile App Configuration 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 + - description: Name of the mobile app + in: query + name: name + schema: + type: string + - in: query + name: businessCriticality + schema: + type: integer + format: int32 requestBody: content: application/json: example: - - id: test - displayName: test + - id: test + displayName: test schema: type: array items: @@ -15869,13 +16519,14 @@ paths: content: application/json: example: - - id: K3bP-bmCRkyimNai9vvq8o - name: example_mobile_app + - 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 + description: >- + Missing name query parameter or name already used for a configured mobile app. '401': description: Unauthorized access - requires user authentication. @@ -15884,23 +16535,23 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Configure new mobile app tags: - - Mobile App Configuration + - Mobile App Configuration /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 + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string responses: '204': description: Mobile app successfully removed @@ -15911,22 +16562,22 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Remove mobile app tags: - - Mobile App Configuration + - Mobile App Configuration 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 + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string responses: '200': content: @@ -15935,8 +16586,8 @@ paths: id: K3bP-bmCRkyimNai9vvq8o name: example_mobile_app rbacTags: - - id: test - displayName: test + - id: test + displayName: test schema: $ref: '#/components/schemas/MobileApp' description: OK @@ -15947,34 +16598,34 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get mobile app configuration by ID tags: - - Mobile App Configuration + - Mobile App Configuration 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 + - 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 + - id: K3bP-bmCRkyimNai9vvq8o + name: example_mobile_app schema: $ref: '#/components/schemas/MobileApp' description: Mobile app successfully renamed @@ -15987,29 +16638,28 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Rename mobile app tags: - - Mobile App Configuration + - Mobile App Configuration /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 + - in: path + name: mobileAppId + required: true + schema: + type: string responses: '200': content: application/json: example: geoDetailRemoval: NO_REMOVAL - geoMappingRules: [ - ] + geoMappingRules: [] schema: $ref: '#/components/schemas/GeoLocationConfiguration' description: OK @@ -16022,22 +16672,22 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Get geo location configuration for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration 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 + - description: Mobile App ID + example: iiLxP1zaTuCS7fyk9m4W0W + in: path + name: mobileAppId + required: true + schema: + type: string requestBody: content: application/json: @@ -16059,26 +16709,25 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Update geo location configuration for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration /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 + - in: path + name: mobileAppId + required: true + schema: + type: string responses: '200': content: - text/csv: { - } + text/csv: {} description: OK '401': description: Unauthorized access - requires user authentication. @@ -16089,20 +16738,20 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Get custom geo mapping rules for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration 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 + - in: path + name: mobileAppId + required: true + schema: + type: string requestBody: content: text/csv: @@ -16111,8 +16760,7 @@ paths: responses: '200': content: - text/csv: { - } + text/csv: {} description: OK '401': description: Unauthorized access - requires user authentication. @@ -16125,21 +16773,21 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Set custom geo mapping rules for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration /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 + - in: path + name: mobileAppId + required: true + schema: + type: string responses: '200': content: @@ -16158,22 +16806,22 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Get IP masking configuration for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration 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 + - description: Mobile App ID + example: iiLxP1zaTuCS7fyk9m4W0W + in: path + name: mobileAppId + required: true + schema: + type: string requestBody: content: application/json: @@ -16195,44 +16843,99 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Update IP masking configuration for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration + /api/mobile-app-monitoring/config/{mobileAppId}/session-replay-config: + get: + description: API request to get the session replay configuration for a mobile app. + operationId: getMobileAppSessionReplay + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + responses: + '200': + description: Session replay configuration + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions or limited in access. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Get session replay config for mobile app + tags: + - Mobile App Configuration + put: + description: API request to configure session replay for a mobile app. + operationId: updateMobileAppSessionReplay + parameters: + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string + responses: + '200': + description: Session replay configuration successfully updated + '400': + description: Invalid or missing request body + '401': + description: Unauthorized access - requires user authentication. + '403': + description: Insufficient permissions or limited in access. + '500': + description: Internal server error. + security: + - ApiKeyAuth: + - ConfigureMobileAppMonitoring + summary: Configure session replay for mobile app + tags: + - Mobile App Configuration /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 + - 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 + - id: 26ae11a865ec8c24 + description: InstanaAgentExample_v1 + createdAt: 1739864150.9596016 + modifiedAt: 1739864314.1402564 + 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 @@ -16241,22 +16944,22 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all sourcemap configurations for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration 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 + - description: Mobile App ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: mobileAppId + required: true + schema: + type: string requestBody: content: application/json: @@ -16276,10 +16979,9 @@ paths: example: id: 1f4acfd2da7c53f1 description: InstanaAgentExample_v2 - createdAt: 1.7478923068642304E9 - modifiedAt: 1.7478923068642304E9 - metadata: [ - ] + createdAt: 1747892306.8642304 + modifiedAt: 1747892306.8642304 + metadata: [] schema: $ref: '#/components/schemas/SourceMapUploadConfig' description: Mobile App sourcemap configuration added successfully @@ -16294,34 +16996,33 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Add new sourcemap configuration for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration /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 + - 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 + description: Sourcemap configuration successfully deleted or sourcemap not found '401': description: Unauthorized access - requires user authentication. '403': @@ -16329,29 +17030,29 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Delete sourcemap configuration for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration 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 + - 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: @@ -16359,19 +17060,19 @@ paths: example: id: 53467e4fb60c1ba2 description: InstanaAgentExample_v1 - createdAt: 1.7216977227669933E9 - modifiedAt: 1.7216983084051073E9 + createdAt: 1721697722.7669933 + modifiedAt: 1721698308.4051073 metadata: - - type: DWARF - format: TGZ - url: com.instana.ios.InstanaAgentExample/dwarf - size: 3301023 - sizeOnDisk: 3287984 - blobs: - - blobIndex: 1 + - type: DWARF + format: TGZ + url: com.instana.ios.InstanaAgentExample/dwarf size: 3301023 sizeOnDisk: 3287984 - meta: null + blobs: + - blobIndex: 1 + size: 3301023 + sizeOnDisk: 3287984 + meta: null schema: $ref: '#/components/schemas/SourceMapUploadConfig' description: OK @@ -16380,35 +17081,33 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get sourcemap configuration for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration /api/mobile-app-monitoring/config/{mobileAppId}/sourcemap-upload/{sourceMapConfigId}/clear: put: - description: API request to clear sourcemap files of a configuration for mobile - app. + 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 + - 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 + description: Sourcemap files in the sourcemap configuration successfully cleared '401': description: Unauthorized access - requires user authentication. '403': @@ -16418,30 +17117,30 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Clear sourcemap files for sourcemap upload configuration tags: - - Mobile App Configuration + - Mobile App Configuration /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 + - 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: @@ -16459,19 +17158,19 @@ paths: example: id: fb3e868cd69f0647 description: InstanaAgentExample_v2 - createdAt: 1.7479543183628924E9 - modifiedAt: 1.7479550970266616E9 + createdAt: 1747954318.3628924 + modifiedAt: 1747955097.0266616 metadata: - - type: DWARF - format: TGZ - url: com.instana.ios.InstanaAgentExample/dwarf - size: 3454658 - sizeOnDisk: 3442288 - blobs: - - blobIndex: 1 + - type: DWARF + format: TGZ + url: com.instana.ios.InstanaAgentExample/dwarf size: 3454658 sizeOnDisk: 3442288 - meta: null + blobs: + - blobIndex: 1 + size: 3454658 + sizeOnDisk: 3442288 + meta: null schema: $ref: '#/components/schemas/SourceMapUploadConfig' description: Successfully committed sourcemap file upload. @@ -16482,30 +17181,30 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Commit sourcemap file upload for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration /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 + - 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: @@ -16521,21 +17220,24 @@ paths: description: File format. Example tgz fileId: type: string - description: Identifier of your app. For example, com.instana.ios.InstanaExampleApp + 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 + 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 + - blobIndex + - fileFormat + - fileId + - fileType + - sourceMap responses: '200': content: @@ -16543,19 +17245,19 @@ paths: example: id: 77e4c6c8c9855973 description: InstanaAgentExample_v2 - createdAt: 1.7479473508836377E9 - modifiedAt: 1.7479484622585921E9 + createdAt: 1747947350.8836377 + modifiedAt: 1747948462.2585921 metadata: - - type: DWARF - format: TGZ - url: com.instana.ios.InstanaAgentExample/dwarf - size: 3455633 - sizeOnDisk: 3443584 - blobs: - - blobIndex: 1 + - type: DWARF + format: TGZ + url: com.instana.ios.InstanaAgentExample/dwarf size: 3455633 sizeOnDisk: 3443584 - meta: null + blobs: + - blobIndex: 1 + size: 3455633 + sizeOnDisk: 3443584 + meta: null schema: $ref: '#/components/schemas/SourceMapUploadConfig' description: OK @@ -16570,27 +17272,27 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Upload sourcemap file for mobile app tags: - - Mobile App Configuration + - Mobile App Configuration /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 + - in: path + name: mobileAppId + required: true + schema: + type: string requestBody: content: application/json: example: - - id: test - displayName: test + - id: test + displayName: test schema: type: array items: @@ -16600,8 +17302,8 @@ paths: content: application/json: example: - - id: test - displayName: test + - id: test + displayName: test schema: type: array items: @@ -16616,11 +17318,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - ConfigureMobileAppMonitoring + - ApiKeyAuth: + - ConfigureMobileAppMonitoring summary: Update teams assigned to the mobile app tags: - - Mobile App Configuration + - Mobile App Configuration /api/mobile-app-monitoring/metrics: post: deprecated: true @@ -16640,81 +17342,85 @@ paths: $ref: '#/components/schemas/MobileAppMetricResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get mobile app beacon metrics tags: - - Mobile App Metrics + - Mobile App Metrics /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/action-beacons: get: - description: 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. + description: >- + 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. operationId: getActionBeacons parameters: - - description: Mobile app identifier - example: app-456 - in: path - name: mobileAppId - required: true - schema: - type: string - minLength: 1 - - description: Session identifier - example: session-123 - in: path - name: sessionId - required: true - schema: - type: string - minLength: 1 - - description: Offset cursor for pagination (number of items already retrieved). - Omit for first page. - example: 100 - in: query - name: cursor - schema: - type: integer - format: int64 - - description: 'Number of items per page (default: 100, max: 1000)' - example: 100 - in: query - name: pageSize - schema: - type: integer - format: int32 - default: 100 + - description: Mobile app identifier + example: app-456 + in: path + name: mobileAppId + required: true + schema: + type: string + minLength: 1 + - description: Session identifier + example: session-123 + in: path + name: sessionId + required: true + schema: + type: string + minLength: 1 + - description: >- + Offset cursor for pagination (number of items already retrieved). + Omit for first page. + example: 100 + in: query + name: cursor + schema: + type: integer + format: int64 + - description: 'Number of items per page (default: 100, max: 1000)' + example: 100 + in: query + name: pageSize + schema: + type: integer + format: int32 + default: 100 responses: '200': content: application/json: example: beacons: - - timestamp: 1757339999715 - beaconType: ued - sessionId: 24c6c1d4-161f-4243-85eb-3d0f46edbcbf - sessionReplayVersion: 0.0.1 - eventType: st - orientationChange: null - viewComponentId: resetDirectory - viewComponentClassName: MaterialButton - mobileAppId: KVJIyIPsTUGfvNORN_07uQ - keyboardOperation: null - frustrationSignal: null - scrollDirection: null - scrollDuration: null - beaconId: ab3d7d1251f75ac5 - beaconClockskew: 1234 - appState: foreground + - timestamp: 1757339999715 + beaconType: ued + sessionId: 24c6c1d4-161f-4243-85eb-3d0f46edbcbf + sessionReplayVersion: 0.0.1 + eventType: st + orientationChange: null + viewComponentId: resetDirectory + viewComponentClassName: MaterialButton + mobileAppId: KVJIyIPsTUGfvNORN_07uQ + keyboardOperation: null + frustrationSignal: null + scrollDirection: null + scrollDuration: null + beaconId: ab3d7d1251f75ac5 + beaconClockskew: 1234 + appState: foreground nextCursor: 100 hasMore: true schema: $ref: '#/components/schemas/GetActionBeaconsResult' description: OK '400': - description: Bad Request - Invalid mobile app ID, session ID, or pagination + description: >- + Bad Request - Invalid mobile app ID, session ID, or pagination parameters '401': description: Unauthorized access - requires user authentication. @@ -16726,78 +17432,81 @@ paths: description: Internal server error. summary: Get action beacons for a session tags: - - Mobile App Session Replay + - Mobile App Session Replay /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/replay-metadata: get: - description: 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. + description: >- + 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. operationId: getSessionReplayMetadata parameters: - - description: Mobile app identifier - example: app-456 - in: path - name: mobileAppId - required: true - schema: - type: string - minLength: 1 - - description: Session identifier - example: session-123 - in: path - name: sessionId - required: true - schema: - type: string - minLength: 1 - - description: Timestamp cursor for pagination (epoch milliseconds). Retrieves - metadata from this timestamp onwards. - example: 1234567890 - in: query - name: cursor - schema: - type: integer - format: int64 - - description: 'Time window size in milliseconds (default: 20000ms = 20 seconds)' - example: 20000 - in: query - name: pageSize - schema: - type: integer - format: int32 - default: 20000 + - description: Mobile app identifier + example: app-456 + in: path + name: mobileAppId + required: true + schema: + type: string + minLength: 1 + - description: Session identifier + example: session-123 + in: path + name: sessionId + required: true + schema: + type: string + minLength: 1 + - description: >- + Timestamp cursor for pagination (epoch milliseconds). Retrieves + metadata from this timestamp onwards. + example: 1234567890 + in: query + name: cursor + schema: + type: integer + format: int64 + - description: 'Time window size in milliseconds (default: 20000ms = 20 seconds)' + example: 20000 + in: query + name: pageSize + schema: + type: integer + format: int32 + default: 20000 responses: '200': content: application/json: example: metadata: - - id: abc-123 - sessionId: session-xyz - timestamp: 1234567890 - type: screenshot - imageFormat: png - bytesIngestedImage: 50000 - bytesIngestedMetadata: 1024 - eventType: click - viewComponentId: button-submit - viewComponentClassName: android.widget.Button - sessionReplayVersion: '2.0' - orientationChange: false - keyboardOperation: true - frustrationSignal: false - scrollDirection: down - scrollDuration: 500 + - id: abc-123 + sessionId: session-xyz + timestamp: 1234567890 + type: screenshot + imageFormat: png + bytesIngestedImage: 50000 + bytesIngestedMetadata: 1024 + eventType: click + viewComponentId: button-submit + viewComponentClassName: android.widget.Button + sessionReplayVersion: '2.0' + orientationChange: false + keyboardOperation: true + frustrationSignal: false + scrollDirection: down + scrollDuration: 500 nextCursor: 1234567895 hasMore: true schema: $ref: '#/components/schemas/GetSessionReplayMetadataResult' description: OK '400': - description: Bad Request - Invalid mobile app ID, session ID, or pagination + description: >- + Bad Request - Invalid mobile app ID, session ID, or pagination parameters '401': description: Unauthorized access - requires user authentication. @@ -16809,29 +17518,30 @@ paths: description: Internal server error. summary: Get session replay metadata tags: - - Mobile App Session Replay + - Mobile App Session Replay /api/mobile-app-monitoring/mobile-apps/{mobileAppId}/sessions/{sessionId}/replay-timestamps: get: - description: Retrieves the first and last image timestamps for a mobile app - session. Returns null values if the session has no images. + description: >- + Retrieves the first and last image timestamps for a mobile app session. + Returns null values if the session has no images. operationId: getSessionReplayTimestamps parameters: - - description: Mobile app identifier - example: app-456 - in: path - name: mobileAppId - required: true - schema: - type: string - minLength: 1 - - description: Session identifier - example: session-123 - in: path - name: sessionId - required: true - schema: - type: string - minLength: 1 + - description: Mobile app identifier + example: app-456 + in: path + name: mobileAppId + required: true + schema: + type: string + minLength: 1 + - description: Session identifier + example: session-123 + in: path + name: sessionId + required: true + schema: + type: string + minLength: 1 responses: '200': content: @@ -16862,98 +17572,95 @@ paths: description: Internal server error. summary: Get session replay timestamps tags: - - Mobile App Session Replay + - Mobile App Session Replay /api/mobile-app-monitoring/session;id={id};timestamp={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 + - 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: '' + - 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: @@ -16968,11 +17675,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get mobile app session tags: - - Mobile App Metrics + - Mobile App Metrics /api/mobile-app-monitoring/v2/metrics: post: description: API request to get mobile app monitoring beacon metrics. @@ -16982,23 +17689,23 @@ paths: application/json: example: metrics: - - metric: beaconCount - aggregation: SUM - granularity: 60 + - 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 + - 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 @@ -17013,10 +17720,10 @@ paths: example: metrics: beaconCount.sum.60: - - - 1707026940000 - - 75.0 - - - 1707027000000 - - 75.0 + - - 1707026940000 + - 75 + - - 1707027000000 + - 75 adjustedTimeframe: windowSize: 3540000 to: 1707030480000 @@ -17028,77 +17735,75 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get beacon metrics tags: - - Mobile App Metrics + - Mobile App Metrics /api/permissions: get: operationId: getUserPermissions responses: default: content: - application/json: { - } + application/json: {} description: default response /api/permissions/{userId}: get: operationId: getUserPermissionsById parameters: - - in: path - name: userId - required: true - schema: - type: string + - in: path + name: userId + required: true + schema: + type: string responses: default: content: - application/json: { - } + application/json: {} description: default response /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 + - 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 + - id: Tiu16hLCTniHDtHb_uDV1w + name: demo-app/main-** + start: 1709091782000 + lastUpdated: 1709091782533 schema: type: array items: $ref: '#/components/schemas/ReleaseWithMetadata' description: OK security: - - ApiKeyAuth: - - CanConfigureReleases + - ApiKeyAuth: + - CanConfigureReleases summary: Get all releases tags: - - Releases + - Releases x-description: getAllReleases post: operationId: postRelease @@ -17116,46 +17821,45 @@ paths: $ref: '#/components/schemas/ReleaseWithMetadata' description: OK security: - - ApiKeyAuth: - - CanConfigureReleases + - ApiKeyAuth: + - CanConfigureReleases summary: Create release tags: - - Releases + - Releases x-description: postRelease /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 + - 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: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureReleases + - ApiKeyAuth: + - CanConfigureReleases summary: Delete release tags: - - Releases + - Releases x-description: deleteRelease 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 + - 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: @@ -17169,22 +17873,22 @@ paths: $ref: '#/components/schemas/ReleaseWithMetadata' description: OK security: - - ApiKeyAuth: - - CanConfigureReleases + - ApiKeyAuth: + - CanConfigureReleases summary: Get release tags: - - Releases + - Releases x-description: getRelease 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 + - 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: @@ -17199,37 +17903,37 @@ paths: $ref: '#/components/schemas/ReleaseWithMetadata' description: OK security: - - ApiKeyAuth: - - CanConfigureReleases + - ApiKeyAuth: + - CanConfigureReleases summary: Update release tags: - - Releases + - Releases x-description: putRelease /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 + - 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: @@ -17237,21 +17941,21 @@ paths: example: total: 1977 entries: - - tenantId: tenantId - tenantUnitId: unitId - action: LOGIN - email: username@example.com - fullName: Any User - timestamp: 1723035109091 + - tenantId: tenantId + tenantUnitId: unitId + action: LOGIN + email: username@example.com + fullName: Any User + timestamp: 1723035109091 schema: $ref: '#/components/schemas/AuditLogUiResponse' description: OK security: - - ApiKeyAuth: - - CanViewAuditLog + - ApiKeyAuth: + - CanViewAuditLog summary: Access log tags: - - Audit Log + - Audit Log /api/settings/apdex: get: description: API to Get All Apdex Configurations. @@ -17261,62 +17965,59 @@ paths: 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 + - 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 + - ApiKeyAuth: + - Default summary: Get All Apdex Configurations tags: - - Apdex Settings + - Apdex Settings 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 + - 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 @@ -17328,199 +18029,200 @@ paths: $ref: '#/components/schemas/ApdexConfiguration' description: OK security: - - ApiKeyAuth: - - canConfigureApdex + - ApiKeyAuth: + - canConfigureApdex summary: Create Apdex Configuration tags: - - Apdex Settings + - Apdex Settings x-description: createApdexConfiguration /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: array - description: Type of the Apdex Configuration, it could be APPLICATION or - WEBSITE. - example: APPLICATION - items: + - 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: Type of the Apdex Configuration, it could be APPLICATION - or WEBSITE. + description: Order By Value enum: - - APPLICATION - - WEBSITE + - 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: array + description: >- + Type of the Apdex Configuration, it could be APPLICATION or + WEBSITE. example: APPLICATION - uniqueItems: true - - in: query - name: entityId - schema: - type: string - description: Application or Website ID - example: XIZGGVT1TX2O-0OFeT2Yig - - in: query - name: apdexIds - schema: - type: array - description: List of APDEX IDs for which details need to be fetched - example: APDWMaA2yKuSS6z50LR0-cGZA - items: - type: string + items: + type: string + description: >- + Type of the Apdex Configuration, it could be APPLICATION or + WEBSITE. + enum: + - APPLICATION + - WEBSITE + example: APPLICATION + uniqueItems: true + - in: query + name: entityId + schema: + type: string + description: Application or Website ID + example: XIZGGVT1TX2O-0OFeT2Yig + - in: query + name: apdexIds + schema: + type: array description: List of APDEX IDs for which details need to be fetched example: APDWMaA2yKuSS6z50LR0-cGZA - - in: query - name: tag - schema: - type: array - description: List of tags which needs to be searched - example: Testing - items: - type: string + items: + type: string + description: List of APDEX IDs for which details need to be fetched + example: APDWMaA2yKuSS6z50LR0-cGZA + - in: query + name: tag + schema: + type: array description: List of tags which needs to be searched example: Testing - uniqueItems: true - - in: query - name: rbacTags - schema: - type: array - description: Filter by RBAC tags (team IDs) - example: team-123 - items: - type: string + items: + type: string + description: List of tags which needs to be searched + example: Testing + uniqueItems: true + - in: query + name: rbacTags + schema: + type: array description: Filter by RBAC tags (team IDs) example: team-123 - uniqueItems: true + items: + type: string + description: Filter by RBAC tags (team IDs) + example: team-123 + uniqueItems: true 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 + - 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/ApdexConfigWithRBACTag' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get All Apdex Configurations tags: - - Apdex Settings + - Apdex Settings 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 + - 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 @@ -17532,11 +18234,11 @@ paths: $ref: '#/components/schemas/ApdexConfigWithRBACTag' description: OK security: - - ApiKeyAuth: - - canConfigureApdex + - ApiKeyAuth: + - canConfigureApdex summary: Create Apdex Configuration tags: - - Apdex Settings + - Apdex Settings x-description: createApdexConfiguration /api/settings/apdex/v2/apdex-levels: get: @@ -17552,111 +18254,111 @@ paths: $ref: '#/components/schemas/ApdexLevel' description: Fetched list of Apdex Levels Successfully security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get All Apdex Levels tags: - - Apdex Settings + - Apdex Settings /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: + - 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 - uniqueItems: true - - in: query - name: entityType - schema: - type: array - description: Apdex Entity Type which needs to be filtered. - example: APPLICATION - items: - type: string + items: + type: string + description: List of tags which needs to be searched + example: Testing + uniqueItems: true + - in: query + name: entityType + schema: + type: array description: Apdex Entity Type which needs to be filtered. - enum: - - APPLICATION - - WEBSITE example: APPLICATION - uniqueItems: true + items: + type: string + description: Apdex Entity Type which needs to be filtered. + enum: + - APPLICATION + - WEBSITE + example: APPLICATION + uniqueItems: true 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 + - 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 + - ApiKeyAuth: + - Default summary: Get All Apdex Config tags tags: - - Apdex Settings + - Apdex Settings /api/settings/apdex/v2/{id}: delete: operationId: deleteApdexConfigurationV2 parameters: - - description: Apdex Configuration ID - example: NCAoNKqySWSK1U5GkmyZgQ - in: path - name: id - required: true - schema: - type: string + - 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 + - ApiKeyAuth: + - canConfigureApdex summary: Delete Apdex Configuration tags: - - Apdex Settings + - Apdex Settings 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 + - description: Apdex Configuration ID + example: NCAoNKqySWSK1U5GkmyZgQ + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -17672,8 +18374,7 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] beaconType: httpRequest schema: $ref: '#/components/schemas/ApdexConfigWithRBACTag' @@ -17686,36 +18387,35 @@ paths: type: string description: Apdex Configuration not found security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Apdex Configuration tags: - - Apdex Settings + - Apdex Settings put: operationId: updateApdexConfigV2 parameters: - - in: path - name: id - required: true - schema: - type: string - description: Apdex Configuration ID - example: APD0jhg2CWmR_iPYtg-iTOzPw + - 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 + - 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 @@ -17734,8 +18434,7 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] beaconType: httpRequest schema: $ref: '#/components/schemas/ApdexConfigWithRBACTag' @@ -17745,71 +18444,70 @@ paths: application/json: example: errors: - - Apdex Configuration not found + - Apdex Configuration not found schema: type: string description: Bad Request security: - - ApiKeyAuth: - - canConfigureApdex + - ApiKeyAuth: + - canConfigureApdex summary: Update an existing Apdex Config tags: - - Apdex Settings + - Apdex Settings x-description: updateApdexConfiguration /api/settings/apdex/{entityType}/{entityId}: get: - description: API to Get All Apdex Configurations for specified entity type and - entity id. + 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 + - 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 + - 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: @@ -17818,48 +18516,49 @@ paths: '400': content: application/json: - example: '{"code":400,"message":"path param entityType must be one of - [APPLICATION, WEBSITE]"}' + example: >- + {"code":400,"message":"path param entityType must be one of + [APPLICATION, WEBSITE]"} schema: type: string description: Bad Request security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all Apdex configurations for entity type and entity id tags: - - Apdex Settings + - Apdex Settings /api/settings/apdex/{id}: delete: operationId: deleteApdexConfiguration parameters: - - description: Apdex Configuration ID - example: NCAoNKqySWSK1U5GkmyZgQ - in: path - name: id - required: true - schema: - type: string + - 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 + - ApiKeyAuth: + - canConfigureApdex summary: Delete Apdex Configuration tags: - - Apdex Settings + - Apdex Settings 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 + - description: Apdex Configuration ID + example: NCAoNKqySWSK1U5GkmyZgQ + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -17875,8 +18574,7 @@ paths: tagFilterExpression: type: EXPRESSION logicalOperator: AND - elements: [ - ] + elements: [] beaconType: httpRequest schema: $ref: '#/components/schemas/ApdexConfiguration' @@ -17889,16 +18587,18 @@ paths: type: string description: Apdex Configuration not found security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Apdex Configuration tags: - - Apdex Settings + - Apdex Settings /api/settings/api-tokens: get: - description: |- + 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. + + For more information on APIToken please access the + https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#apitoken. operationId: getApiTokens responses: '200': @@ -18073,15 +18773,18 @@ paths: '404': description: No API Tokens found security: - - ApiKeyAuth: - - CanConfigureApiTokens + - ApiKeyAuth: + - CanConfigureApiTokens summary: Get all API Tokens tags: - - API Token + - API Token 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. + 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: @@ -18187,43 +18890,47 @@ paths: $ref: '#/components/schemas/ApiToken' description: OK security: - - ApiKeyAuth: - - CanConfigureApiTokens + - ApiKeyAuth: + - CanConfigureApiTokens summary: Create an API token tags: - - API Token + - API Token /api/settings/api-tokens/{internalId}: delete: - description: |- + 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. + + 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 + - in: path + name: internalId + required: true + schema: + type: string responses: '204': description: Successful - no content to return. security: - - ApiKeyAuth: - - CanConfigureApiTokens + - ApiKeyAuth: + - CanConfigureApiTokens summary: Delete API token tags: - - API Token + - API Token get: - description: |- + 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. + + 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 + - in: path + name: internalId + required: true + schema: + type: string responses: '200': content: @@ -18315,22 +19022,24 @@ paths: '404': description: No ApiToken found with internalId security: - - ApiKeyAuth: - - CanConfigureApiTokens + - ApiKeyAuth: + - CanConfigureApiTokens summary: Get API token tags: - - API Token + - API Token put: - description: |- + 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. + + 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 + - in: path + name: internalId + required: true + schema: + type: string requestBody: content: application/json: @@ -18435,36 +19144,36 @@ paths: $ref: '#/components/schemas/ApiToken' description: OK security: - - ApiKeyAuth: - - CanConfigureApiTokens + - ApiKeyAuth: + - CanConfigureApiTokens summary: Create or update an API token tags: - - API Token + - API Token /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 + - 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: @@ -18472,35 +19181,35 @@ paths: 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 + - 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 + - ApiKeyAuth: + - CanViewAuditLog summary: Audit log tags: - - Audit Log + - Audit Log /api/settings/authentication/2fa/credentials: get: operationId: getTwoFactorCredentials responses: default: content: - application/json: { - } + application/json: {} description: default response /api/settings/authentication/2fa/toggle: post: @@ -18508,24 +19217,22 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response /api/settings/authentication/2fa/verify/{token}: post: operationId: toggle2Fa_1 parameters: - - in: path - name: token - required: true - schema: - type: integer - format: int64 + - in: path + name: token + required: true + schema: + type: integer + format: int64 responses: default: content: - application/json: { - } + application/json: {} description: default response /api/settings/authentication/changePassword: post: @@ -18533,8 +19240,7 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response /api/settings/authentication/googleSSO: delete: @@ -18544,15 +19250,16 @@ paths: '204': description: Successful - no content to return. security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Delete Google SSO configuration tags: - - Authentication + - Authentication /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 + 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: @@ -18575,11 +19282,11 @@ paths: '404': description: No IdP configuration found for tenant security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Enable or disable IdP configuration tags: - - Authentication + - Authentication /api/settings/authentication/ldap: delete: description: Delete the corresponding tenants LDAP configuration. @@ -18588,11 +19295,11 @@ paths: '204': description: Successful - no content to return. security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Delete LDAP configuration tags: - - Authentication + - Authentication /api/settings/authentication/oidc: delete: description: Delete the corresponding tenants OIDC configuration. @@ -18601,11 +19308,11 @@ paths: '204': description: Successful - no content to return. security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Delete OIDC configuration tags: - - Authentication + - Authentication /api/settings/authentication/saml: delete: description: Delete the corresponding tenants SAML configuration. @@ -18614,162 +19321,166 @@ paths: '204': description: Successful - no content to return. security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Delete SAML configuration tags: - - Authentication + - Authentication /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: + - 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 - 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 + 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 - - 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 + 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 - - in: query - name: refresh - schema: - type: boolean - description: Boolean operator which specifies if the cache needs to be refreshed - example: false + 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: [ - ] + - 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 + description: >- + Fetched list of the SLO Correction Window Configurations + Successfully security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get All SLO Correction Window Configs tags: - - SLO Correction Configurations + - SLO Correction Configurations post: operationId: createSloCorrectionWindowConfig requestBody: @@ -18785,10 +19496,10 @@ paths: durationUnit: HOUR recurrentRule: FREQ=DAILY;INTERVAL=1 sloIds: - - SLO4s-fs-GuT56c3v4KzQKBuQ + - SLO4s-fs-GuT56c3v4KzQKBuQ tags: - - test - - rrule + - test + - rrule schema: $ref: '#/components/schemas/CorrectionConfiguration' required: true @@ -18810,66 +19521,69 @@ paths: recurrentRule: FREQ=DAILY;INTERVAL=1 recurrent: true sloIds: - - SLO4s-fs-GuT56c3v4KzQKBuQ + - SLO4s-fs-GuT56c3v4KzQKBuQ tags: - - rrule - - test + - 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"]}' + example: >- + {"errors":["SloConfiguration with id: SLOeDPoToCSTyOtd2ZQ was + not found"]} schema: type: string description: Bad Request '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureServiceLevelCorrectionWindows + - ApiKeyAuth: + - canConfigureServiceLevelCorrectionWindows summary: Create a new SLO Correction Window Config tags: - - SLO Correction Configurations + - SLO Correction Configurations x-description: createSloCorrectionConfiguration /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 + - 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 + - ApiKeyAuth: + - canConfigureServiceLevelCorrectionWindows summary: Delete an existing SLO Correction Window Configuration tags: - - SLO Correction Configurations + - SLO Correction Configurations 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 + - 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: @@ -18888,10 +19602,10 @@ paths: recurrentRule: FREQ=DAILY;INTERVAL=1 recurrent: true sloIds: - - SLO4s-fs-GuT56c3v4KzQKBuQ + - SLO4s-fs-GuT56c3v4KzQKBuQ tags: - - rrule - - test + - rrule + - test schema: $ref: '#/components/schemas/CorrectionConfiguration' description: Fetched SLO Correction Window Configuration Successfully @@ -18900,27 +19614,28 @@ paths: application/json: example: errors: - - The SLO Correction Window Configuration you are looking for does - not exist. + - >- + 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 + - ApiKeyAuth: + - Default summary: Get an existing SLO Correction Window Config tags: - - SLO Correction Configurations + - SLO Correction Configurations put: operationId: updateSloCorrectionWindowConfig parameters: - - in: path - name: id - required: true - schema: - type: string - description: SLO Correction Window Configuration ID - example: cvLxfzNJQriV86MQTqOu1g + - in: path + name: id + required: true + schema: + type: string + description: SLO Correction Window Configuration ID + example: cvLxfzNJQriV86MQTqOu1g requestBody: content: application/json: @@ -18934,10 +19649,10 @@ paths: durationUnit: HOUR recurrentRule: FREQ=DAILY;INTERVAL=1 sloIds: - - SLO4s-fs-GuT56c3v4KzQKBuQ + - SLO4s-fs-GuT56c3v4KzQKBuQ tags: - - test - - rrule + - test + - rrule schema: $ref: '#/components/schemas/CorrectionConfiguration' required: true @@ -18959,10 +19674,10 @@ paths: recurrentRule: FREQ=DAILY;INTERVAL=1 recurrent: true sloIds: - - SLO4s-fs-GuT56c3v4KzQKBuQ + - SLO4s-fs-GuT56c3v4KzQKBuQ tags: - - rrule - - test + - rrule + - test schema: $ref: '#/components/schemas/CorrectionConfiguration' description: Updated SLO Correction Window Configuration Successfully @@ -18971,18 +19686,18 @@ paths: application/json: example: errors: - - 'SloConfiguration with id: SLOeDPoToCSTyOtd2ZQ was not found' + - 'SloConfiguration with id: SLOeDPoToCSTyOtd2ZQ was not found' schema: type: string description: Bad Request '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureServiceLevelCorrectionWindows + - ApiKeyAuth: + - canConfigureServiceLevelCorrectionWindows summary: Update an existing SLO Correction Window Config tags: - - SLO Correction Configurations + - SLO Correction Configurations x-description: updateSloCorrectionConfiguration /api/settings/invitation/share: post: @@ -18991,10 +19706,10 @@ paths: content: application/json: example: - - email: username@example.com - groupId: '-1' - message: hello message - path: /testpath + - email: username@example.com + groupId: '-1' + message: hello message + path: /testpath schema: type: array items: @@ -19006,8 +19721,8 @@ paths: application/json: example: invitationResults: - - userEmail: username@example.com - invitationStatus: SUCCESS + - userEmail: username@example.com + invitationStatus: SUCCESS schema: type: array items: @@ -19018,42 +19733,41 @@ paths: application/json: example: errors: - - Please set at least one email + - Please set at least one email schema: type: string description: Bad Request Error security: - - ApiKeyAuth: - - CanConfigureUsers + - ApiKeyAuth: + - CanConfigureUsers summary: Send user invitations tags: - - User + - User x-description: inviteUsers /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 - format: email - minLength: 1 + - description: Email of the invite for removal + example: username@example.com + in: query + name: email + required: true + schema: + type: string + format: email + minLength: 1 responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureUsers + - ApiKeyAuth: + - CanConfigureUsers summary: Revoke pending invitation tags: - - User + - User x-description: revokePendingInvitation get: operationId: getInvitations @@ -19067,11 +19781,11 @@ paths: $ref: '#/components/schemas/InvitationResult' description: OK security: - - ApiKeyAuth: - - CanConfigureUsers + - ApiKeyAuth: + - CanConfigureUsers summary: All pending invitations tags: - - User + - User x-description: getInvitations post: operationId: inviteUsers @@ -19079,8 +19793,8 @@ paths: content: application/json: example: - - email: username@example.com - groupId: '-1' + - email: username@example.com + groupId: '-1' schema: type: array items: @@ -19092,8 +19806,8 @@ paths: application/json: example: invitationResults: - - userEmail: username@example.com - invitationStatus: SUCCESS + - userEmail: username@example.com + invitationStatus: SUCCESS schema: type: array items: @@ -19104,20 +19818,21 @@ paths: application/json: example: errors: - - Please set at least one email + - Please set at least one email schema: type: string description: Bad Request Error security: - - ApiKeyAuth: - - CanConfigureUsers + - ApiKeyAuth: + - CanConfigureUsers summary: Send user invitations tags: - - User + - User x-description: inviteUsers /api/settings/ip-filtering: delete: - description: Delete the currently configured ip-filtering for the current tenant + description: >- + Delete the currently configured ip-filtering for the current tenant unit. operationId: deleteIPFiltering responses: @@ -19128,7 +19843,7 @@ paths: application/json: example: errors: - - no ip-filtering setting set + - no ip-filtering setting set schema: type: string description: Resource not found. @@ -19137,19 +19852,18 @@ paths: application/json: example: errors: - - failed to delete ip-filtering setting + - failed to delete ip-filtering setting schema: type: string description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureIPFiltering + - ApiKeyAuth: + - CanConfigureIPFiltering summary: Delete current ip-filtering tags: - - IP Filtering + - IP Filtering get: - description: Retrieve currently configured ip-filtering for the current tenant - unit. + description: Retrieve currently configured ip-filtering for the current tenant unit. operationId: getIPFiltering responses: '200': @@ -19161,10 +19875,10 @@ paths: enabled: true supportAccessEnabled: true rules: - - target: 127.0.0.1 - block: true - - target: 0:0:0:0:0:0:0:1 - block: false + - target: 127.0.0.1 + block: true + - target: '0:0:0:0:0:0:0:1' + block: false lastChangedAt: 1762356274224 lastVerifiedAt: null schema: @@ -19175,7 +19889,7 @@ paths: application/json: example: errors: - - no ip-filtering setting set + - no ip-filtering setting set schema: type: string description: Resource not found. @@ -19184,20 +19898,21 @@ paths: application/json: example: errors: - - failed to retrieve ip-filtering setting + - failed to retrieve ip-filtering setting schema: type: string description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureIPFiltering + - ApiKeyAuth: + - CanConfigureIPFiltering summary: Get current ip-filtering tags: - - IP Filtering + - IP Filtering 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. + 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: @@ -19207,10 +19922,10 @@ paths: enabled: true supportAccessEnabled: true rules: - - target: 127.0.0.1 - block: true - - target: 0:0:0:0:0:0:0:1 - block: false + - 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 @@ -19224,10 +19939,10 @@ paths: enabled: true supportAccessEnabled: true rules: - - target: 127.0.0.1 - block: true - - target: 0:0:0:0:0:0:0:1 - block: false + - target: 127.0.0.1 + block: true + - target: '0:0:0:0:0:0:0:1' + block: false lastChangedAt: 1762356274224 lastVerifiedAt: null schema: @@ -19238,8 +19953,9 @@ paths: application/json: example: errors: - - Denying all access is prevented. You need to provide at least one - allow rule. + - >- + Denying all access is prevented. You need to provide at + least one allow rule. schema: type: string description: Bad request. @@ -19248,12 +19964,12 @@ paths: 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 + - 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. @@ -19262,20 +19978,21 @@ paths: application/json: example: errors: - - failed to upsert ip-filtering setting + - failed to upsert ip-filtering setting schema: type: string description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureIPFiltering + - ApiKeyAuth: + - CanConfigureIPFiltering summary: Upsert ip-filtering tags: - - IP Filtering + - IP Filtering /api/settings/ip-filtering/disable: patch: - description: Disable and retrieve the currently configured ip-filtering for - the current tenant unit. + description: >- + Disable and retrieve the currently configured ip-filtering for the + current tenant unit. operationId: disableIPFiltering responses: '200': @@ -19287,10 +20004,10 @@ paths: enabled: false supportAccessEnabled: true rules: - - target: 127.0.0.1 - block: true - - target: 0:0:0:0:0:0:0:1 - block: false + - target: 127.0.0.1 + block: true + - target: '0:0:0:0:0:0:0:1' + block: false lastChangedAt: 1762356861555 lastVerifiedAt: 1762356492161 schema: @@ -19301,7 +20018,7 @@ paths: application/json: example: errors: - - no ip-filtering setting set + - no ip-filtering setting set schema: type: string description: Resource not found. @@ -19310,22 +20027,23 @@ paths: application/json: example: errors: - - failed to disable ip-filtering setting + - failed to disable ip-filtering setting schema: type: string description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureIPFiltering + - ApiKeyAuth: + - CanConfigureIPFiltering summary: Disable the current ip-filtering tags: - - IP Filtering + - IP Filtering /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. + 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': @@ -19337,10 +20055,10 @@ paths: enabled: true supportAccessEnabled: true rules: - - target: 127.0.0.1 - block: true - - target: 0:0:0:0:0:0:0:1 - block: false + - target: 127.0.0.1 + block: true + - target: '0:0:0:0:0:0:0:1' + block: false lastChangedAt: 1762356274224 lastVerifiedAt: 1762356492161 schema: @@ -19351,7 +20069,7 @@ paths: application/json: example: errors: - - unable to verify either no ip-filtering set or not active + - unable to verify either no ip-filtering set or not active schema: type: string description: Resource not found. @@ -19360,52 +20078,55 @@ paths: application/json: example: errors: - - failed to verify ip-filtering setting + - failed to verify ip-filtering setting schema: type: string description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureIPFiltering + - ApiKeyAuth: + - CanConfigureIPFiltering summary: Verify current ip-filtering tags: - - IP Filtering + - IP Filtering /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. + 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 + - 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 + - ApiKeyAuth: + - CanConfigureLlmModelPrice summary: Delete LLM model price tags: - - LLM Price Configuration + - LLM Price Configuration get: description: Fetch all LLM price configurations for the current tenant unit. operationId: getAllLlmModelPrices @@ -19417,14 +20138,15 @@ paths: $ref: '#/components/schemas/LlmModelPrice' description: OK security: - - ApiKeyAuth: - - CanConfigureLlmModelPrice + - ApiKeyAuth: + - CanConfigureLlmModelPrice summary: Get all LLM model prices tags: - - LLM Price Configuration + - LLM Price Configuration put: - description: Create or update price for a specific provider+model. Optionally - specify a platform for platform-specific pricing. + description: >- + Create or update price for a specific provider+model. Optionally specify + a platform for platform-specific pricing. operationId: upsertLlmModelPriceFromBody requestBody: content: @@ -19440,11 +20162,11 @@ paths: '200': description: OK security: - - ApiKeyAuth: - - CanConfigureLlmModelPrice + - ApiKeyAuth: + - CanConfigureLlmModelPrice summary: Upsert LLM model price tags: - - LLM Price Configuration + - LLM Price Configuration /api/settings/llm-pricing/currency: get: description: Fetch the currency code used for LLM model pricing. @@ -19459,11 +20181,11 @@ paths: '404': description: Not Found security: - - ApiKeyAuth: - - CanConfigureLlmModelPrice + - ApiKeyAuth: + - CanConfigureLlmModelPrice summary: Get currency for LLM model prices tags: - - LLM Price Configuration + - LLM Price Configuration put: description: Set the currency code used for LLM model pricing. operationId: setLLMModelCurrency @@ -19482,62 +20204,66 @@ paths: $ref: '#/components/schemas/LlmModelPriceMetadata' description: OK security: - - ApiKeyAuth: - - CanConfigureLlmModelPrice + - ApiKeyAuth: + - CanConfigureLlmModelPrice summary: Set currency for LLM model prices tags: - - LLM Price Configuration + - LLM Price Configuration /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. + 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 + - 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 + - ApiKeyAuth: + - CanConfigureLlmModelPrice summary: Delete LLM model price without provider tags: - - LLM Price Configuration + - LLM Price Configuration get: - description: Fetch the price for a model without specifying provider. Optionally + 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 + - 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: @@ -19548,30 +20274,32 @@ paths: '404': description: Not Found security: - - ApiKeyAuth: - - CanConfigureLlmModelPrice + - ApiKeyAuth: + - CanConfigureLlmModelPrice summary: Get LLM model price without provider tags: - - LLM Price Configuration + - LLM Price Configuration put: - description: Create or update price for a model without specifying provider. + 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 + - 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: @@ -19584,75 +20312,80 @@ paths: '200': description: OK security: - - ApiKeyAuth: - - CanConfigureLlmModelPrice + - ApiKeyAuth: + - CanConfigureLlmModelPrice summary: Upsert LLM model price without provider tags: - - LLM Price Configuration + - LLM Price Configuration /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. + 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 + - 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 + - ApiKeyAuth: + - CanConfigureLlmModelPrice summary: Delete LLM model price tags: - - LLM Price Configuration + - LLM Price Configuration get: - description: Fetch the price for a specific provider+model. Optionally specify - a platform for platform-specific pricing. + 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 + - 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: @@ -19663,37 +20396,39 @@ paths: '404': description: Not Found security: - - ApiKeyAuth: - - CanConfigureLlmModelPrice + - ApiKeyAuth: + - CanConfigureLlmModelPrice summary: Get LLM model price tags: - - LLM Price Configuration + - LLM Price Configuration put: - description: Create or update price for a specific provider+model. Optionally - specify a platform for platform-specific pricing. + 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 + - 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: @@ -19706,17 +20441,18 @@ paths: '200': description: OK security: - - ApiKeyAuth: - - CanConfigureLlmModelPrice + - ApiKeyAuth: + - CanConfigureLlmModelPrice summary: Upsert LLM model price tags: - - LLM Price Configuration + - LLM Price Configuration /api/settings/maintenance: get: deprecated: true - description: |2- + description: >- - For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + 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': @@ -19728,52 +20464,53 @@ paths: $ref: '#/components/schemas/ValidatedMaintenanceConfigWithStatus' description: OK security: - - ApiKeyAuth: - - CanConfigureMaintenanceWindows + - ApiKeyAuth: + - CanConfigureMaintenanceWindows summary: All maintenance configurations tags: - - Maintenance Configuration + - Maintenance Configuration /api/settings/maintenance/{id}: delete: deprecated: true - description: |2- + description: >- - For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + 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 + - 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: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureMaintenanceWindows + - ApiKeyAuth: + - CanConfigureMaintenanceWindows summary: Delete maintenance configuration tags: - - Maintenance Configuration + - Maintenance Configuration get: deprecated: true - description: |2- + description: >- - For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + 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 + - description: ID of the Maintenance Window Configuration to get. + example: MPhKWoXRp0PBelqk + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -19782,25 +20519,26 @@ paths: $ref: '#/components/schemas/MaintenanceConfigWithLastUpdated' description: OK security: - - ApiKeyAuth: - - CanConfigureMaintenanceWindows + - ApiKeyAuth: + - CanConfigureMaintenanceWindows summary: Maintenance configuration tags: - - Maintenance Configuration + - Maintenance Configuration put: deprecated: true - description: |2- + description: >- - For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + 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 + - description: ID of the Maintenance Window Configuration to update. + example: MPhKWoXRp0PBelqk + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -19809,45 +20547,48 @@ paths: required: true responses: '200': - description: Maintenance config has been created or updated, and successfully + 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 + 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 + - ApiKeyAuth: + - CanConfigureMaintenanceWindows summary: Create or update maintenance configuration tags: - - Maintenance Configuration + - Maintenance Configuration /api/settings/rbac/groups: get: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + 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 + - 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: @@ -19856,16 +20597,17 @@ paths: '404': description: No groups found security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Get groups tags: - - Groups + - Groups x-description: getGroups post: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + For more information on groups please access the + https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. operationId: createGroup requestBody: content: @@ -19873,25 +20615,21 @@ paths: example: name: group name members: - - userId: userId - email: username@example.com + - userId: userId + email: username@example.com permissionSet: permissions: - - CAN_VIEW_LOGS + - CAN_VIEW_LOGS applicationIds: - - scopeId: scopeId1 - scopeRoleId: '-102' - kubernetesClusterUUIDs: [ - ] - kubernetesNamespaceUIDs: [ - ] - websiteIds: [ - ] - mobileAppIds: [ - ] + - scopeId: scopeId1 + scopeRoleId: '-102' + kubernetesClusterUUIDs: [] + kubernetesNamespaceUIDs: [] + websiteIds: [] + mobileAppIds: [] syntheticTestIds: - - scopeId: scopeId10 - scopeRoleId: '-1' + - scopeId: scopeId10 + scopeRoleId: '-1' restrictedApplicationFilter: label: group name tagFilterExpression: @@ -19921,25 +20659,21 @@ paths: example: name: group name members: - - userId: userId - email: username@example.com + - userId: userId + email: username@example.com permissionSet: permissions: - - CAN_VIEW_LOGS + - CAN_VIEW_LOGS applicationIds: - - scopeId: scopeId1 - scopeRoleId: '-102' - kubernetesClusterUUIDs: [ - ] - kubernetesNamespaceUIDs: [ - ] - websiteIds: [ - ] - mobileAppIds: [ - ] + - scopeId: scopeId1 + scopeRoleId: '-102' + kubernetesClusterUUIDs: [] + kubernetesNamespaceUIDs: [] + websiteIds: [] + mobileAppIds: [] syntheticTestIds: - - scopeId: scopeId10 - scopeRoleId: '-1' + - scopeId: scopeId10 + scopeRoleId: '-1' restrictedApplicationFilter: label: group name tagFilterExpression: @@ -19963,17 +20697,19 @@ paths: $ref: '#/components/schemas/ApiGroup' description: OK security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Create group tags: - - Groups + - Groups x-description: createGroup /api/settings/rbac/groups/delete: put: - description: |- + description: >- Delete multiple groups - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#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: @@ -19987,78 +20723,73 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Delete groups tags: - - Groups + - Groups /api/settings/rbac/groups/user/{email}: get: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + 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' + - 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: @@ -20067,34 +20798,35 @@ paths: '404': description: No groups found security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Get groups of a single user tags: - - Groups + - Groups x-description: getGroupsByUser /api/settings/rbac/groups/{groupId}/permissions: put: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + 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 + - 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 + - CAN_VIEW_SYNTHETIC_TESTS + - CAN_VIEW_SYNTHETIC_LOCATIONS + - CAN_CONFIGURE_AUTOMATION_ACTIONS schema: type: array items: @@ -20108,26 +20840,20 @@ paths: id: groupId name: group name members: - - userId: userId1 - email: username1@example.com + - 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: [ - ] + - 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' @@ -20138,33 +20864,34 @@ paths: $ref: '#/components/schemas/ApiGroup' description: OK security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Add permissions to group tags: - - Groups + - Groups x-description: updateGroup /api/settings/rbac/groups/{groupId}/users: put: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + 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 + - 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 + - userId1 + - userId3 schema: type: array items: @@ -20178,27 +20905,21 @@ paths: id: groupId name: group name members: - - userId: userId1 - email: username1@example.com - - userId: userId2 - email: username2@example.com - - userId: userId3 - email: username3@example.com + - 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: [ - ] + - CAN_VIEW_LOGS + applicationIds: [] + kubernetesClusterUUIDs: [] + kubernetesNamespaceUIDs: [] + websiteIds: [] + mobileAppIds: [] + syntheticTestIds: [] infraDfqFilter: scopeId: '' scopeRoleId: '-1' @@ -20209,26 +20930,28 @@ paths: $ref: '#/components/schemas/ApiGroup' description: OK security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Add users to group tags: - - Groups + - Groups x-description: addUsersToGroup /api/settings/rbac/groups/{id}: delete: - description: |- + 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. + + 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 + - 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 @@ -20239,27 +20962,29 @@ paths: schema: type: string example: Deletion of this group is not allowed - description: Pre-Condition Failed - Returned when attempting to delete protected + description: >- + Pre-Condition Failed - Returned when attempting to delete protected system groups. security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Delete group tags: - - Groups + - Groups get: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + 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 + - description: Id of the group for retrieval + example: groupId + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -20268,49 +20993,45 @@ paths: id: groupId name: group name members: - - userId: userId - email: username@example.com + - 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 + - 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: [ - ] + - 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' + - scopeId: scopeId10 + scopeRoleId: '-1' restrictedApplicationFilter: label: filter name tagFilterExpression: @@ -20334,50 +21055,47 @@ paths: $ref: '#/components/schemas/ApiGroup' description: OK security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Get group tags: - - Groups + - Groups x-description: getGroup put: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + 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 + - 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 + - userId: userId + email: username@example.com permissionSet: permissions: - - CAN_VIEW_LOGS + - CAN_VIEW_LOGS applicationIds: - - scopeId: scopeId1 - scopeRoleId: '-102' - kubernetesClusterUUIDs: [ - ] - kubernetesNamespaceUIDs: [ - ] - websiteIds: [ - ] - mobileAppIds: [ - ] + - scopeId: scopeId1 + scopeRoleId: '-102' + kubernetesClusterUUIDs: [] + kubernetesNamespaceUIDs: [] + websiteIds: [] + mobileAppIds: [] syntheticTestIds: - - scopeId: scopeId10 - scopeRoleId: '-1' + - scopeId: scopeId10 + scopeRoleId: '-1' restrictedApplicationFilter: label: group name tagFilterExpression: @@ -20407,25 +21125,21 @@ paths: example: name: group name members: - - userId: userId - email: username@example.com + - userId: userId + email: username@example.com permissionSet: permissions: - - CAN_VIEW_LOGS + - CAN_VIEW_LOGS applicationIds: - - scopeId: scopeId1 - scopeRoleId: '-102' - kubernetesClusterUUIDs: [ - ] - kubernetesNamespaceUIDs: [ - ] - websiteIds: [ - ] - mobileAppIds: [ - ] + - scopeId: scopeId1 + scopeRoleId: '-102' + kubernetesClusterUUIDs: [] + kubernetesNamespaceUIDs: [] + websiteIds: [] + mobileAppIds: [] syntheticTestIds: - - scopeId: scopeId10 - scopeRoleId: '-1' + - scopeId: scopeId10 + scopeRoleId: '-1' restrictedApplicationFilter: label: group name tagFilterExpression: @@ -20457,63 +21171,66 @@ paths: schema: type: string example: Modification of this group is not allowed - description: Pre-Condition Failed - Returned when attempting to modify protected + description: >- + Pre-Condition Failed - Returned when attempting to modify protected groups in a forbidden way. security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Update group tags: - - Groups + - Groups x-description: updateGroup /api/settings/rbac/groups/{id}/user/{userId}: delete: - description: |- + 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. + + 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 + - 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: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Remove user from group tags: - - Groups + - Groups /api/settings/rbac/mappings: get: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + 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' + - id: mappingId + key: roles + value: analyst + groupId: '-3' schema: type: array items: @@ -20522,16 +21239,17 @@ paths: '404': description: No group mapping found security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Get all group mappings tags: - - Groups + - Groups x-description: getGroupMappings post: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + For more information on groups please access the + https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. operationId: createGroupMapping requestBody: content: @@ -20556,17 +21274,18 @@ paths: $ref: '#/components/schemas/GroupMapping' description: OK security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Create group mapping tags: - - Groups + - Groups x-description: createGroupMapping /api/settings/rbac/mappings/identityProvider/restrictEmptyIdpGroups: get: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + For more information on groups please access the + https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. operationId: getIdentityProviderPatch responses: '200': @@ -20580,16 +21299,17 @@ paths: '404': description: No group mapping restriction found security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Check user restrictions for empty Idp group mapping tags: - - Groups + - Groups x-description: getIdentityProviderPatch put: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + For more information on groups please access the + https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. operationId: updateIdentityProvider requestBody: content: @@ -20602,32 +21322,32 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Allow/Restrict users with empty Idp group mapping tags: - - Groups + - Groups x-description: updateIdentityProvider /api/settings/rbac/mappings/overview: get: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + 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 + - id: mappingId + key: roles + value: analyst + role: default + team: testing schema: type: array items: @@ -20636,50 +21356,51 @@ paths: '404': description: No group mapping overviews found security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Get all group mappings overview tags: - - Groups + - Groups x-description: getGroupMappingsOverview /api/settings/rbac/mappings/{id}: delete: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + 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 + - description: Id of the group mapping to delete + example: mappingId + in: path + name: id + required: true + schema: + type: string responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Delete group mapping tags: - - Groups + - Groups x-description: deleteGroupMapping get: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + 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 + - in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -20695,25 +21416,26 @@ paths: '404': description: No group mapping found security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Get group mapping tags: - - Groups + - Groups x-description: getGroupMapping put: - description: |2- + description: >- - For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups. + 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 + - description: Id of the group mapping to update + example: mappingId + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -20738,11 +21460,11 @@ paths: $ref: '#/components/schemas/GroupMapping' description: OK security: - - ApiKeyAuth: - - CanConfigureAuthenticationMethods + - ApiKeyAuth: + - CanConfigureAuthenticationMethods summary: Update group mapping tags: - - Groups + - Groups x-description: updateGroupMapping /api/settings/rbac/roles: get: @@ -20753,35 +21475,35 @@ paths: content: application/json: example: - - id: role-1 - name: Administrator - description: null - 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 - description: my optional description (< 500 characters) - 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 + - id: role-1 + name: Administrator + description: null + 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 + description: my optional description (< 500 characters) + 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: @@ -20790,11 +21512,11 @@ paths: '404': description: No roles found security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Get all roles tags: - - Roles + - Roles post: description: Create a new role. operationId: createRole @@ -20805,12 +21527,12 @@ paths: name: New Role description: optional attribute members: - - userId: user-5 - email: newuser@example.com - name: New User + - userId: user-5 + email: newuser@example.com + name: New User permissions: - - CAN_VIEW_APPLICATIONS - - CAN_VIEW_EVENTS + - CAN_VIEW_APPLICATIONS + - CAN_VIEW_EVENTS schema: $ref: '#/components/schemas/ApiCreateRole' description: Role to create @@ -20824,35 +21546,35 @@ paths: name: New Role description: optional attribute members: - - userId: user-5 - email: newuser@example.com - name: New User + - userId: user-5 + email: newuser@example.com + name: New User permissions: - - CAN_VIEW_APPLICATIONS - - CAN_VIEW_EVENTS + - CAN_VIEW_APPLICATIONS + - CAN_VIEW_EVENTS schema: $ref: '#/components/schemas/ApiRole' description: OK '422': description: Unprocessable entity. security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Create role tags: - - Roles + - Roles /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 + - description: Id of the role to delete + example: roleId + in: path + name: id + required: true + schema: + type: string responses: '204': description: Role successfully deleted @@ -20865,29 +21587,30 @@ paths: schema: type: string example: Deletion of this group is not allowed - description: Pre-Condition Failed - Returned when attempting to delete protected + description: >- + Pre-Condition Failed - Returned when attempting to delete protected system roles. security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Delete role tags: - - Roles + - Roles 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 + - 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: @@ -20896,39 +21619,39 @@ paths: 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 + - 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 + - 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 + - ApiKeyAuth: + - CanConfigureTeams summary: Get role by ID tags: - - Roles + - Roles 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 + - description: Id of the role to update + example: roleId + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -20937,20 +21660,20 @@ paths: name: Updated Developer Role description: optional attribute 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 + - 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 + - CAN_VIEW_APPLICATIONS + - CAN_VIEW_EVENTS + - CAN_VIEW_INFRASTRUCTURE + - CAN_CONFIGURE_APPLICATIONS schema: $ref: '#/components/schemas/ApiRole' description: Updated role data @@ -20964,20 +21687,20 @@ paths: name: Updated Developer Role description: optional attribute 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 + - 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 + - CAN_VIEW_APPLICATIONS + - CAN_VIEW_EVENTS + - CAN_VIEW_INFRASTRUCTURE + - CAN_CONFIGURE_APPLICATIONS schema: $ref: '#/components/schemas/ApiRole' description: OK @@ -20990,24 +21713,25 @@ paths: schema: type: string example: Modification of this group is not allowed - description: Pre-Condition Failed - Returned when attempting to modify protected + description: >- + Pre-Condition Failed - Returned when attempting to modify protected roles in a forbidden way. security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Update role tags: - - Roles + - Roles /api/settings/rbac/roles/{roleId}/mappings: get: description: Retrieve IdP role mappings applicable to a specific role operationId: getRoleMappings parameters: - - in: path - name: roleId - required: true - schema: - type: string + - in: path + name: roleId + required: true + schema: + type: string responses: '200': content: @@ -21020,11 +21744,11 @@ paths: '404': description: role mapping not found security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Get role mappings tags: - - Roles + - Roles /api/settings/rbac/teams: get: description: Retrieve all user teams for the current tenant unit. @@ -21034,96 +21758,82 @@ paths: 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 + - 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: @@ -21132,11 +21842,11 @@ paths: '404': description: No teams found security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Get all teams tags: - - Teams + - Teams post: description: Create a new team. operationId: createTeam @@ -21151,50 +21861,49 @@ paths: '200': description: Team created successfully security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Create team tags: - - Teams + - Teams /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 + - description: Id of the team to delete + example: teamId + in: path + name: id + required: true + schema: + type: string responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Delete team tags: - - Teams + - Teams 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 + - 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: @@ -21206,70 +21915,69 @@ paths: description: Team responsible for application development scope: accessPermissions: - - CAN_CONFIGURE_APPLICATIONS - - CAN_CONFIGURE_EVENTS + - CAN_CONFIGURE_APPLICATIONS + - CAN_CONFIGURE_EVENTS restrictedApplicationFilter: restrictingApplicationId: app-123 applications: - - app-123 - - app-456 + - app-123 + - app-456 websites: - - website-1 + - website-1 mobileApps: - - mobile-1 + - mobile-1 kubernetesClusters: - - cluster-1 + - cluster-1 kubernetesNamespaces: - - namespace-1 + - namespace-1 syntheticTests: - - test-1 - syntheticCredentials: [ - ] + - test-1 + syntheticCredentials: [] businessPerspectives: - - bp-1 + - bp-1 tagIds: - - tag-1 - - tag-2 + - 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 + - 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 + - ApiKeyAuth: + - CanConfigureTeams summary: Get team by ID tags: - - Teams + - Teams 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 + - description: Id of the team to update + example: teamId + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -21285,21 +21993,21 @@ paths: '404': description: Team not found security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Update team tags: - - Teams + - Teams /api/settings/rbac/teams/{teamId}/mappings: get: description: Retrieve IdP role mappings applicable to a specific team operationId: getTeamRoleMappings parameters: - - in: path - name: teamId - required: true - schema: - type: string + - in: path + name: teamId + required: true + schema: + type: string responses: '200': content: @@ -21312,11 +22020,11 @@ paths: '404': description: role mapping not found security: - - ApiKeyAuth: - - CanConfigureTeams + - ApiKeyAuth: + - CanConfigureTeams summary: Get team role mappings tags: - - Teams + - Teams /api/settings/session: delete: description: Delete tenant unit session settings. @@ -21324,15 +22032,14 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureSessionSettings + - ApiKeyAuth: + - CanConfigureSessionSettings summary: Delete session settings tags: - - Session Settings + - Session Settings get: description: Get the tenant unit session settings operationId: getSessionSettings @@ -21349,11 +22056,11 @@ paths: $ref: '#/components/schemas/SessionSettings' description: OK security: - - ApiKeyAuth: - - CanConfigureSessionSettings + - ApiKeyAuth: + - CanConfigureSessionSettings summary: Get session settings tags: - - Session Settings + - Session Settings put: description: Update individual tenant unit session settings. operationId: setSessionSettings @@ -21380,11 +22087,11 @@ paths: $ref: '#/components/schemas/SessionSettings' description: OK security: - - ApiKeyAuth: - - CanConfigureSessionSettings + - ApiKeyAuth: + - CanConfigureSessionSettings summary: Configure session settings tags: - - Session Settings + - Session Settings /api/settings/sli: get: deprecated: true @@ -21414,11 +22121,11 @@ paths: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get All SLI Configs tags: - - SLI Settings + - SLI Settings post: deprecated: true operationId: createSliConfig @@ -21463,47 +22170,46 @@ paths: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK security: - - ApiKeyAuth: - - canConfigureServiceLevels + - ApiKeyAuth: + - canConfigureServiceLevels summary: Create SLI Config tags: - - SLI Settings + - SLI Settings x-description: createSliConfiguration /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 + - in: path + name: id + required: true + schema: + type: string + description: Service Levels Indicator ID + example: 7iydEfqJQP6AKzd3yR3byw responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - canConfigureServiceLevels + - ApiKeyAuth: + - canConfigureServiceLevels summary: Delete SLI Config tags: - - SLI Settings + - SLI Settings get: deprecated: true operationId: getSliConfig parameters: - - in: path - name: id - required: true - schema: - type: string - description: Service Levels Indicator ID - example: 3J0RDgfyQz-P_hVzbNNb4A + - in: path + name: id + required: true + schema: + type: string + description: Service Levels Indicator ID + example: 3J0RDgfyQz-P_hVzbNNb4A responses: '200': content: @@ -21527,22 +22233,22 @@ paths: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get SLI Config tags: - - SLI Settings + - SLI Settings put: deprecated: true operationId: updateSliConfig parameters: - - in: path - name: id - required: true - schema: - type: string - description: Service Levels Indicator ID - example: 3J0RDgfyQz-P_hVzbNNb4A + - in: path + name: id + required: true + schema: + type: string + description: Service Levels Indicator ID + example: 3J0RDgfyQz-P_hVzbNNb4A requestBody: content: application/json: @@ -21587,244 +22293,253 @@ paths: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK security: - - ApiKeyAuth: - - canConfigureServiceLevels + - ApiKeyAuth: + - canConfigureServiceLevels summary: Update SLI Config tags: - - SLI Settings + - SLI Settings /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: + - 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 - 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 - - mobile + 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 - 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 + items: + type: string + description: >- + SLO Entity Type which needs to be filtered. (This filter could + occurs multiple times.) + enum: + - application + - website + - synthetic + - infrastructure + - mobile + 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 - 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 - - advanced-custom + 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 - 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 + items: + type: string + description: >- + SLO blueprint Type which needs to be filtered. (This filter + could occurs multiple times.) + enum: + - latency + - availability + - traffic + - saturation + - custom + - advanced-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 - - 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 + 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 - - 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 + 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 - uniqueItems: true + 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 + - 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 @@ -21832,11 +22547,11 @@ paths: $ref: '#/components/schemas/PaginatedResult' description: Fetched list of the SLO Configurations Successfully security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get All SLO Configs tags: - - SLO Configurations + - SLO Configurations post: operationId: createSloConfig requestBody: @@ -21846,8 +22561,8 @@ paths: name: Stans test SLO 4 target: 0.99 rbacTags: - - id: R3_hPrHXSMe0yGsnlFdReA - displayName: team 1 + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 entity: type: application applicationId: VTNvC_sATZqMj4vSZfsjKA @@ -21867,8 +22582,8 @@ paths: duration: 1 durationUnit: week tags: - - Stan - - testing + - Stan + - testing schema: $ref: '#/components/schemas/SLOConfigWithRBACTag' required: true @@ -21879,8 +22594,8 @@ paths: example: id: SLOdCTspkHlS_OzNOATQWgsuw rbacTags: - - id: R3_hPrHXSMe0yGsnlFdReA - displayName: team 1 + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 createdDate: 1680182236227 name: Stans test SLO 4 target: 0.99 @@ -21904,8 +22619,8 @@ paths: duration: 1 durationUnit: week tags: - - Stan - - testing + - Stan + - testing schema: $ref: '#/components/schemas/SLOConfigWithRBACTag' description: New SLO Configuration Created Successfully @@ -21917,115 +22632,117 @@ paths: type: string description: Invalid Tag Filter security: - - ApiKeyAuth: - - canConfigureServiceLevels + - ApiKeyAuth: + - canConfigureServiceLevels summary: Create a new SLO Config tags: - - SLO Configurations + - SLO Configurations x-description: createSloConfiguration /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: + - 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 - uniqueItems: true - - in: query - name: entityType - schema: - type: string - description: SLO Entity Type which needs to be filtered - enum: - - application - - website - - synthetic - - infrastructure - - mobile - 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 + 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 + - mobile + 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 + - ApiKeyAuth: + - Default summary: Get All SLO Config tags tags: - - SLO Configurations + - SLO Configurations /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 + - 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 + - ApiKeyAuth: + - canConfigureServiceLevels summary: Delete an existing SLO Config tags: - - SLO Configurations + - SLO Configurations 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 + - 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: @@ -22033,8 +22750,8 @@ paths: example: id: SLOdCTspkHlS_OzNOATQWgsuw rbacTags: - - id: R3_hPrHXSMe0yGsnlFdReA - displayName: team 1 + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 createdDate: 1680182236227 name: Stans test SLO 4 target: 0.99 @@ -22058,8 +22775,8 @@ paths: duration: 1 durationUnit: week tags: - - Stan - - testing + - Stan + - testing schema: $ref: '#/components/schemas/SLOConfigWithRBACTag' description: Fetched SLO Configuration Successfully @@ -22068,26 +22785,26 @@ paths: application/json: example: errors: - - The sloConfiguration you are looking for does not exist. + - The sloConfiguration you are looking for does not exist. schema: type: string description: SLO Configuration Not Found security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get an existing SLO Config tags: - - SLO Configurations + - SLO Configurations put: operationId: updateSloConfig parameters: - - in: path - name: id - required: true - schema: - type: string - description: Service Levels Objective Configuration ID - example: SLOdCTspkHlS_OzNOATQWgsuw + - in: path + name: id + required: true + schema: + type: string + description: Service Levels Objective Configuration ID + example: SLOdCTspkHlS_OzNOATQWgsuw requestBody: content: application/json: @@ -22095,8 +22812,8 @@ paths: name: Stans test SLO 4 target: 0.99 rbacTags: - - id: R3_hPrHXSMe0yGsnlFdReA - displayName: team 1 + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 entity: type: application applicationId: VTNvC_sATZqMj4vSZfsjKA @@ -22116,8 +22833,8 @@ paths: duration: 1 durationUnit: week tags: - - Stan - - testing + - Stan + - testing schema: $ref: '#/components/schemas/SLOConfigWithRBACTag' required: true @@ -22128,8 +22845,8 @@ paths: example: id: SLOdCTspkHlS_OzNOATQWgsuw rbacTags: - - id: R3_hPrHXSMe0yGsnlFdReA - displayName: team 1 + - id: R3_hPrHXSMe0yGsnlFdReA + displayName: team 1 createdDate: 1680182236227 name: Stans test SLO 4 target: 0.99 @@ -22153,8 +22870,8 @@ paths: duration: 1 durationUnit: week tags: - - Stan - - testing + - Stan + - testing schema: $ref: '#/components/schemas/SLOConfigWithRBACTag' description: Updated SLO Configuration Successfully @@ -22163,49 +22880,70 @@ paths: application/json: example: errors: - - 'SloConfiguration with id: GC8r6gbZT4WIhtsMx_YgLg was not found' + - >- + SloConfiguration with id: GC8r6gbZT4WIhtsMx_YgLg was not + found schema: type: string description: Bad Request security: - - ApiKeyAuth: - - canConfigureServiceLevels + - ApiKeyAuth: + - canConfigureServiceLevels summary: Update an existing SLO Config tags: - - SLO Configurations + - SLO Configurations x-description: updateSloConfiguration /api/settings/synthetic-calls: delete: - description: |- - Use this API endpoint if one wants to delete all custom synthetic call configurations. + 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. + 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: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Delete synthetic call configurations tags: - - Synthetic Calls + - Synthetic Calls get: - description: |- - Use this API endpoint if one wants to get all custom synthetic call configurations. + 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. + 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': @@ -22215,20 +22953,30 @@ paths: $ref: '#/components/schemas/SyntheticCallWithDefaultsConfig' description: OK security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Synthetic call configurations tags: - - Synthetic Calls + - Synthetic Calls put: - description: |- - Use this API endpoint if one wants to get all custom synthetic call configurations. + 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. + 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: @@ -22244,11 +22992,11 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - ConfigureServiceMapping + - ApiKeyAuth: + - ConfigureServiceMapping summary: Update synthetic call configurations tags: - - Synthetic Calls + - Synthetic Calls /api/settings/trace-sampling: delete: description: Deletes the trace sampling configuration for the current tenant @@ -22263,8 +23011,8 @@ paths: '500': description: Internal server error security: - - ApiKeyAuth: - - ConfigureApplications + - ApiKeyAuth: + - ConfigureApplications summary: Delete trace sampling configuration get: description: Retrieves the trace sampling configuration for the current tenant @@ -22283,11 +23031,12 @@ paths: '500': description: Internal server error security: - - ApiKeyAuth: - - ConfigureApplications + - ApiKeyAuth: + - ConfigureApplications summary: Get trace sampling configuration put: - description: Creates or updates the trace sampling configuration for the current + description: >- + Creates or updates the trace sampling configuration for the current tenant operationId: updateTraceSamplingConfig requestBody: @@ -22311,27 +23060,27 @@ paths: '500': description: Internal server error security: - - ApiKeyAuth: - - ConfigureApplications + - ApiKeyAuth: + - ConfigureApplications summary: Update trace sampling configuration /api/settings/users: get: - description: Retrieves all users with access to the tenant. The result will - not contain pending invitations. + 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 - teamNames: [ - ] - tfaEnabled: false + - id: userId + email: username@example.com + fullName: username + lastLoggedIn: 1636434847190 + groupCount: 1 + teamNames: [] + tfaEnabled: false schema: type: array items: @@ -22342,15 +23091,16 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureUsers + - ApiKeyAuth: + - CanConfigureUsers summary: All users (without invitations) tags: - - User + - User /api/settings/users/overview: get: - description: Retrieves all users with access to the tenant. The result will - also contain pending invitations. + description: >- + Retrieves all users with access to the tenant. The result will also + contain pending invitations. operationId: getUsersIncludingInvitations responses: '200': @@ -22358,16 +23108,16 @@ paths: application/json: example: users: - - id: userId1 - email: username@example.com - fullName: fullName - lastLoggedIn: 1699313025975 - groupCount: null - tfaEnabled: null + - id: userId1 + email: username@example.com + fullName: fullName + lastLoggedIn: 1699313025975 + groupCount: null + tfaEnabled: null invitations: - - id: userId2 - email: username2@example.com - groupId: '-3' + - id: userId2 + email: username2@example.com + groupId: '-3' schema: $ref: '#/components/schemas/UsersResult' description: OK @@ -22376,21 +23126,21 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureUsers + - ApiKeyAuth: + - CanConfigureUsers summary: All users (incl. invitations) tags: - - User + - User /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 + - in: path + name: email + required: true + schema: + type: string requestBody: content: application/json: @@ -22408,24 +23158,25 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - CanConfigureUsers + - ApiKeyAuth: + - CanConfigureUsers summary: Change user name of single user tags: - - User + - User /api/settings/users/{userId}: delete: - description: Remove the users access to the tenant. Removing a user from a tenant + 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 + - 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. @@ -22434,23 +23185,23 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureUsers + - ApiKeyAuth: + - CanConfigureUsers summary: Remove user from tenant tags: - - User + - User 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 + - description: Id of the user for retrieval + example: userId + in: path + name: userId + required: true + schema: + type: string + style: simple responses: '200': content: @@ -22466,14 +23217,12 @@ paths: timestampAcceptedPrivacyAgreement: 1696404223545 acceptedTosVersion: 6 acceptedPrivacyAgreementVersion: 9 - tenantsWhereMainContact: [ - ] - tenants: [ - ] + tenantsWhereMainContact: [] + tenants: [] createDate: 1696404196256 emailConfirmed: true tenantIds: - - 55557f97186b9c0007857730 + - 55557f97186b9c0007857730 passwordResetAttempt: 0 groupCount: null tfaEnabled: null @@ -22488,23 +23237,23 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureUsers + - ApiKeyAuth: + - CanConfigureUsers summary: Get single user tags: - - User + - User /api/settings/users/{userId}/mappings: get: description: Retrieves all IdP role mappings applicable to the specified user. operationId: getUserMappings parameters: - - description: Id of the user - example: userId - in: path - name: userId - required: true - schema: - type: string + - description: Id of the user + example: userId + in: path + name: userId + required: true + schema: + type: string responses: '200': content: @@ -22519,176 +23268,177 @@ paths: '403': description: Insufficient permissions or limited in access. security: - - ApiKeyAuth: - - CanConfigureUsers + - ApiKeyAuth: + - CanConfigureUsers summary: Get user role mappings tags: - - User + - User /api/settings/users/{userId}/mergedPermissions: get: operationId: getMergedUserPermissions parameters: - - in: path - name: userId - required: true - schema: - type: string + - in: path + name: userId + required: true + schema: + type: string responses: default: content: - application/json: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureUsers + - ApiKeyAuth: + - CanConfigureUsers /api/settings/v2/maintenance: get: - description: |2- + description: >- - For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + 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 + - 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' + $ref: >- + #/components/schemas/ValidatedMaintenanceConfigV2WithStateAndOccurrence description: OK security: - - ApiKeyAuth: - - CanConfigureMaintenanceWindows + - ApiKeyAuth: + - CanConfigureMaintenanceWindows summary: All maintenance configurations tags: - - Maintenance Configuration + - Maintenance Configuration x-description: getMaintenanceConfigs /api/settings/v2/maintenance/{id}: delete: - description: |2- + description: >- - For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + 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 + - 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: { - } + application/json: {} description: default response security: - - ApiKeyAuth: - - CanConfigureMaintenanceWindows + - ApiKeyAuth: + - CanConfigureMaintenanceWindows summary: Delete maintenance configuration tags: - - Maintenance Configuration + - Maintenance Configuration x-description: deleteMaintenanceConfig get: - description: |2- + description: >- - For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + 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 + - description: Id of the Maintenance Window Configuration to get. + example: 8924aa6b + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -22714,25 +23464,26 @@ paths: $ref: '#/components/schemas/MaintenanceConfigV2WithStateAndOccurrence' description: OK security: - - ApiKeyAuth: - - CanConfigureMaintenanceWindows + - ApiKeyAuth: + - CanConfigureMaintenanceWindows summary: Get maintenance configuration tags: - - Maintenance Configuration + - Maintenance Configuration x-description: getMaintenanceConfig put: - description: |2- + description: >- - For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + 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 + - description: Id of the Maintenance Window configuration to update. + example: 8924aa6b + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -22760,24 +23511,24 @@ paths: 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 + - 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 @@ -22785,38 +23536,42 @@ paths: occurrence: start: 1698938631036 end: 1698945831036 - description: Maintenance config has been created or updated, and successfully + 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 + 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. + description: >- + The provided maintenance configuration is incomplete or cannot be + processed. security: - - ApiKeyAuth: - - CanConfigureMaintenanceWindows + - ApiKeyAuth: + - CanConfigureMaintenanceWindows summary: Create or update maintenance configuration tags: - - Maintenance Configuration + - Maintenance Configuration x-description: putMaintenanceConfig /api/settings/v2/maintenance/{id}/pause: put: - description: |2- + description: >- - For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + 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 + - description: Id of the Maintenance Window configuration to pause. + example: 8924aa6b + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -22842,26 +23597,27 @@ paths: $ref: '#/components/schemas/MaintenanceConfigV2WithStateAndOccurrence' description: OK security: - - ApiKeyAuth: - - CanConfigureMaintenanceWindows + - ApiKeyAuth: + - CanConfigureMaintenanceWindows summary: Pause maintenance configuration tags: - - Maintenance Configuration + - Maintenance Configuration x-description: pauseMaintenanceConfig /api/settings/v2/maintenance/{id}/resume: put: - description: |2- + description: >- - For more information on Maintenance Configurations please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#maintenance-configurations. + 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 + - description: Id of the Maintenance Window configuration to resume. + example: 8924aa6b + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -22887,11 +23643,11 @@ paths: $ref: '#/components/schemas/MaintenanceConfigV2WithStateAndOccurrence' description: OK security: - - ApiKeyAuth: - - CanConfigureMaintenanceWindows + - ApiKeyAuth: + - CanConfigureMaintenanceWindows summary: Resume maintenance configuration tags: - - Maintenance Configuration + - Maintenance Configuration x-description: resumeMaintenanceConfig /api/settings/v2/sli: get: @@ -22901,31 +23657,31 @@ paths: 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 + - id: T0yCMBR4G + sliName: Siva SLI test + initialEvaluationTimestamp: 1637758860000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 100 + 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 + - ApiKeyAuth: + - Default summary: Get All SLI Configs tags: - - SLI Settings + - SLI Settings post: operationId: createSliConfigV2 requestBody: @@ -22983,111 +23739,111 @@ paths: type: string description: Unprocessable Entity security: - - ApiKeyAuth: - - canConfigureServiceLevels + - ApiKeyAuth: + - canConfigureServiceLevels summary: Create SLI Config tags: - - SLI Settings + - SLI Settings x-description: createSliConfiguration /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 + - 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 + - id: HXcNRWhDSWiZs3HiUAKr7g + sliName: turbo time 1 + initialEvaluationTimestamp: 1648133520000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 300 + 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 + - ApiKeyAuth: + - Default summary: Get all SLI configs for entity type and entity id tags: - - SLI Settings + - SLI Settings /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 + - 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 + - ApiKeyAuth: + - canConfigureServiceLevels summary: Delete SLI Config tags: - - SLI Settings + - SLI Settings get: operationId: getSliConfigV2 parameters: - - description: ID of the Service Level Indicator (SLI) - example: HXcNRWhDSWiZs3HiUAKr7g - in: path - name: id - required: true - schema: - type: string + - 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 + - id: HXcNRWhDSWiZs3HiUAKr7g + sliName: turbo time 1 + initialEvaluationTimestamp: 1648133520000 + metricConfiguration: + metricName: latency + metricAggregation: P90 + threshold: 300 + sliEntity: + sliType: application + applicationId: 1qvXgVfLTNqi8gGTcCaNUw + serviceId: null + endpointId: null + boundaryScope: INBOUND + lastUpdated: 1648133508938 schema: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK @@ -23096,51 +23852,51 @@ paths: application/json: example: errors: - - The SLI Configuration you are looking for does not exist. + - The SLI Configuration you are looking for does not exist. schema: type: string description: SLI Configuration Not Found security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get SLI Config tags: - - SLI Settings + - SLI Settings /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 + - 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: @@ -23163,36 +23919,40 @@ paths: application/json: example: errors: - - There is no SLI configuration for the given ID or the report hasn't - been generated yet. + - >- + 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 + 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 /api/slo/catalog/metrics/mobile: get: - description: API request to get mobile app SLI metric catalog filtered by golden + description: >- + API request to get mobile app SLI metric catalog filtered by golden signal and beacon type. operationId: getMobileAppSliMetricCatalog parameters: - - in: query - name: sloBlueprint - schema: - type: string - - in: query - name: beaconType - schema: - type: string + - in: query + name: sloBlueprint + schema: + type: string + - in: query + name: beaconType + schema: + type: string responses: '200': content: @@ -23299,436 +24059,421 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Mobile app SLI metric catalog tags: - - SLO Catalog for Mobile App + - SLO Catalog for Mobile App /api/slo/catalog/tags/mobile: get: operationId: getMobileAppSloTagCatalog parameters: - - in: query - name: beaconType - schema: - type: string + - in: query + name: beaconType + schema: + type: string responses: '200': content: application/json: example: tagTree: - - label: Commonly Used - description: null - icon: null - children: - - label: HTTP Call URL - description: The fully qualified URL of the executed HTTP request. - tagName: mobileBeacon.http.url - type: TAG - scoreBoost: 10 - type: LEVEL - queryable: false - - label: HTTP - description: null - icon: null - children: - - label: URL - description: The fully qualified URL of the executed HTTP request. - tagName: mobileBeacon.http.url - type: TAG - - label: Origin - description: The URL path of the executed HTTP request, i.e., - the combination of scheme, host and (optionally) port. - tagName: mobileBeacon.http.origin - type: TAG - - label: Path - description: The URL path of the executed HTTP request. - tagName: mobileBeacon.http.path - type: TAG - - label: Method - description: The HTTP method used for the request (e.g., GET, - POST, PUT, DELETE) - tagName: mobileBeacon.http.method - type: TAG - - label: Status Code - description: The HTTP status code returned by the server in response - to the mobile app's request - tagName: mobileBeacon.http.status - type: TAG - - label: Backend Trace ID - description: Unique identifier that connects the mobile app beacon - with backend traces - tagName: mobileBeacon.backend.traceId - type: TAG - - label: HTTP Headers - description: HTTP Headers collected via our Mobile App agent. - tagName: mobileBeacon.http.headers - type: TAG - - label: Cache + - label: Commonly Used + description: null + icon: null + children: + - label: HTTP Call URL + description: The fully qualified URL of the executed HTTP request. + tagName: mobileBeacon.http.url + type: TAG + scoreBoost: 10 + type: LEVEL + queryable: false + - label: HTTP description: null icon: null children: - - label: Encoded Body Size - description: The size in bytes of a response body, e.g. HTTP - entity or cache retrieval, with any content-encoding, e.g. - gzip, still applied. - tagName: mobileBeacon.http.encodedBodySize - type: TAG - - label: Decoded Body Size - description: The size in bytes of a response body, e.g. HTTP - entity or cache retrieval, after content decoding, e.g. after - decompression. - tagName: mobileBeacon.http.decodedBodySize - type: TAG - - label: Transfer Size - description: The size in bytes of HTTP responses. - tagName: mobileBeacon.http.transferSize - type: TAG + - label: URL + description: The fully qualified URL of the executed HTTP request. + tagName: mobileBeacon.http.url + type: TAG + - label: Origin + description: >- + The URL path of the executed HTTP request, i.e., the + combination of scheme, host and (optionally) port. + tagName: mobileBeacon.http.origin + type: TAG + - label: Path + description: The URL path of the executed HTTP request. + tagName: mobileBeacon.http.path + type: TAG + - label: Method + description: >- + The HTTP method used for the request (e.g., GET, POST, + PUT, DELETE) + tagName: mobileBeacon.http.method + type: TAG + - label: Status Code + description: >- + The HTTP status code returned by the server in + response to the mobile app's request + tagName: mobileBeacon.http.status + type: TAG + - label: Backend Trace ID + description: >- + Unique identifier that connects the mobile app beacon + with backend traces + tagName: mobileBeacon.backend.traceId + type: TAG + - label: HTTP Headers + description: HTTP Headers collected via our Mobile App agent. + tagName: mobileBeacon.http.headers + type: TAG + - label: Cache + description: null + icon: null + children: + - label: Encoded Body Size + description: >- + The size in bytes of a response body, e.g. HTTP + entity or cache retrieval, with any + content-encoding, e.g. gzip, still applied. + tagName: mobileBeacon.http.encodedBodySize + type: TAG + - label: Decoded Body Size + description: >- + The size in bytes of a response body, e.g. HTTP + entity or cache retrieval, after content decoding, + e.g. after decompression. + tagName: mobileBeacon.http.decodedBodySize + type: TAG + - label: Transfer Size + description: The size in bytes of HTTP responses. + tagName: mobileBeacon.http.transferSize + type: TAG + scoreBoost: null + type: LEVEL + queryable: false scoreBoost: null type: LEVEL queryable: false - scoreBoost: null - type: LEVEL - queryable: false - - label: Error - description: null - icon: null - children: - - label: Error Count - description: The number of errors recorded for a single beacon. - tagName: mobileBeacon.error.count - type: TAG - - label: Erroneous - description: Whether or not a beacon has an error count > 0. - tagName: mobileBeacon.erroneous - type: TAG - - label: ID - description: A hash over a subset of the error properties. - tagName: mobileBeacon.error.id - type: TAG - - label: Error Type - description: The type or classification of the error that occurred - in the mobile app - tagName: mobileBeacon.error.type - type: TAG - - label: Error Message - description: The detailed error message describing what went wrong - in the mobile app - tagName: mobileBeacon.error.message - type: TAG - - label: Stack Trace + - label: Error description: null icon: null children: - - label: Stack Trace - description: The stack trace of errors passed to our reportEvent - API. - tagName: mobileBeacon.stackTrace - type: TAG + - label: Error Count + description: The number of errors recorded for a single beacon. + tagName: mobileBeacon.error.count + type: TAG + - label: Erroneous + description: Whether or not a beacon has an error count > 0. + tagName: mobileBeacon.erroneous + type: TAG + - label: ID + description: A hash over a subset of the error properties. + tagName: mobileBeacon.error.id + type: TAG + - label: Error Type + description: >- + The type or classification of the error that occurred + in the mobile app + tagName: mobileBeacon.error.type + type: TAG + - label: Error Message + description: >- + The detailed error message describing what went wrong + in the mobile app + tagName: mobileBeacon.error.message + type: TAG + - label: Stack Trace + description: null + icon: null + children: + - label: Stack Trace + description: >- + The stack trace of errors passed to our + reportEvent API. + tagName: mobileBeacon.stackTrace + type: TAG + scoreBoost: null + type: LEVEL + queryable: false scoreBoost: null type: LEVEL queryable: false - scoreBoost: null - type: LEVEL - queryable: false tags: - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.http.status - availability: [ - ] - idTag: false - level1: Mobile - level2: HTTP - namePartsWithoutCategory: - - mobileBeacon - - http - - status - name: mobileBeacon.http.status - type: STRING - aliases: [ - ] - label: Status Code - description: The HTTP status code returned by the server in response - to the mobile app's request - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.error.type - availability: [ - ] - idTag: false - level1: Mobile - level2: null - namePartsWithoutCategory: - - mobileBeacon - - error - - type - name: mobileBeacon.error.type - type: STRING - aliases: [ - ] - label: Error Type - description: The type or classification of the error that occurred - in the mobile app - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.http.origin - availability: [ - ] - idTag: false - level1: Mobile - level2: HTTP - namePartsWithoutCategory: - - mobileBeacon - - http - - origin - name: mobileBeacon.http.origin - type: STRING - aliases: [ - ] - label: Origin - description: The URL path of the executed HTTP request, i.e., the - combination of scheme, host and (optionally) port. - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.http.method - availability: [ - ] - idTag: false - level1: Mobile - level2: HTTP - namePartsWithoutCategory: - - mobileBeacon - - http - - method - name: mobileBeacon.http.method - type: STRING - aliases: [ - ] - label: Method - description: The HTTP method used for the request (e.g., GET, POST, - PUT, DELETE) - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.error.id - availability: [ - ] - idTag: true - level1: Mobile - level2: null - namePartsWithoutCategory: - - mobileBeacon - - error - - id - name: mobileBeacon.error.id - type: STRING - aliases: [ - ] - label: ID - description: A hash over a subset of the error properties. - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.http.path - availability: [ - ] - idTag: false - level1: Mobile - level2: HTTP - namePartsWithoutCategory: - - mobileBeacon - - http - - path - name: mobileBeacon.http.path - type: STRING - aliases: [ - ] - label: Path - description: The URL path of the executed HTTP request. - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.stackTrace - availability: [ - ] - idTag: false - level1: Mobile - level2: null - namePartsWithoutCategory: - - mobileBeacon - - stackTrace - name: mobileBeacon.stackTrace - type: STRING - aliases: [ - ] - label: Stack Trace - description: The stack trace of errors passed to our reportEvent - API. - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.http.transferSize - availability: [ - ] - idTag: false - level1: Mobile - level2: HTTP - namePartsWithoutCategory: - - mobileBeacon - - http - - transferSize - name: mobileBeacon.http.transferSize - type: NUMBER - aliases: [ - ] - label: Transfer Size - description: The size in bytes of HTTP responses. - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.backend.traceId - availability: [ - ] - idTag: true - level1: Mobile - level2: null - namePartsWithoutCategory: - - mobileBeacon - - backend - - traceId - name: mobileBeacon.backend.traceId - type: STRING - aliases: [ - ] - label: Backend Trace ID - description: Unique identifier that connects the mobile app beacon - with backend traces - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.http.headers - availability: [ - ] - idTag: false - level1: Mobile - level2: null - namePartsWithoutCategory: - - mobileBeacon - - http - - headers - name: mobileBeacon.http.headers - type: KEY_VALUE_PAIR - aliases: [ - ] - label: HTTP Headers - description: HTTP Headers collected via our Mobile App agent. - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.error.count - availability: [ - ] - idTag: false - level1: Mobile - level2: null - namePartsWithoutCategory: - - mobileBeacon - - error - - count - name: mobileBeacon.error.count - type: NUMBER - aliases: [ - ] - label: Error Count - description: The number of errors recorded for a single beacon. - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.http.encodedBodySize - availability: [ - ] - idTag: false - level1: Mobile - level2: HTTP - namePartsWithoutCategory: - - mobileBeacon - - http - - encodedBodySize - name: mobileBeacon.http.encodedBodySize - type: NUMBER - aliases: [ - ] - label: Encoded Body Size - description: The size in bytes of a response body, e.g. HTTP entity - or cache retrieval, with any content-encoding, e.g. gzip, still - applied. - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.http.url - availability: [ - ] - idTag: false - level1: Mobile - level2: HTTP - namePartsWithoutCategory: - - mobileBeacon - - http - - url - name: mobileBeacon.http.url - type: STRING - aliases: [ - ] - label: URL - description: The fully qualified URL of the executed HTTP request. - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.erroneous - availability: [ - ] - idTag: false - level1: Mobile - level2: null - namePartsWithoutCategory: - - mobileBeacon - - erroneous - name: mobileBeacon.erroneous - type: BOOLEAN - aliases: [ - ] - label: Erroneous - description: Whether or not a beacon has an error count > 0. - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.http.decodedBodySize - availability: [ - ] - idTag: false - level1: Mobile - level2: HTTP - namePartsWithoutCategory: - - mobileBeacon - - http - - decodedBodySize - name: mobileBeacon.http.decodedBodySize - type: NUMBER - aliases: [ - ] - label: Decoded Body Size - description: The size in bytes of a response body, e.g. HTTP entity - or cache retrieval, after content decoding, e.g. after decompression. - - canApplyToDestination: false - canApplyToSource: false - nameWithoutCategory: mobileBeacon.error.message - availability: [ - ] - idTag: false - level1: Mobile - level2: null - namePartsWithoutCategory: - - mobileBeacon - - error - - message - name: mobileBeacon.error.message - type: STRING - aliases: [ - ] - label: Error Message - description: The detailed error message describing what went wrong - in the mobile app + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.http.status + availability: [] + idTag: false + level1: Mobile + level2: HTTP + namePartsWithoutCategory: + - mobileBeacon + - http + - status + name: mobileBeacon.http.status + type: STRING + aliases: [] + label: Status Code + description: >- + The HTTP status code returned by the server in response to + the mobile app's request + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.error.type + availability: [] + idTag: false + level1: Mobile + level2: null + namePartsWithoutCategory: + - mobileBeacon + - error + - type + name: mobileBeacon.error.type + type: STRING + aliases: [] + label: Error Type + description: >- + The type or classification of the error that occurred in + the mobile app + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.http.origin + availability: [] + idTag: false + level1: Mobile + level2: HTTP + namePartsWithoutCategory: + - mobileBeacon + - http + - origin + name: mobileBeacon.http.origin + type: STRING + aliases: [] + label: Origin + description: >- + The URL path of the executed HTTP request, i.e., the + combination of scheme, host and (optionally) port. + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.http.method + availability: [] + idTag: false + level1: Mobile + level2: HTTP + namePartsWithoutCategory: + - mobileBeacon + - http + - method + name: mobileBeacon.http.method + type: STRING + aliases: [] + label: Method + description: >- + The HTTP method used for the request (e.g., GET, POST, + PUT, DELETE) + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.error.id + availability: [] + idTag: true + level1: Mobile + level2: null + namePartsWithoutCategory: + - mobileBeacon + - error + - id + name: mobileBeacon.error.id + type: STRING + aliases: [] + label: ID + description: A hash over a subset of the error properties. + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.http.path + availability: [] + idTag: false + level1: Mobile + level2: HTTP + namePartsWithoutCategory: + - mobileBeacon + - http + - path + name: mobileBeacon.http.path + type: STRING + aliases: [] + label: Path + description: The URL path of the executed HTTP request. + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.stackTrace + availability: [] + idTag: false + level1: Mobile + level2: null + namePartsWithoutCategory: + - mobileBeacon + - stackTrace + name: mobileBeacon.stackTrace + type: STRING + aliases: [] + label: Stack Trace + description: The stack trace of errors passed to our reportEvent API. + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.http.transferSize + availability: [] + idTag: false + level1: Mobile + level2: HTTP + namePartsWithoutCategory: + - mobileBeacon + - http + - transferSize + name: mobileBeacon.http.transferSize + type: NUMBER + aliases: [] + label: Transfer Size + description: The size in bytes of HTTP responses. + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.backend.traceId + availability: [] + idTag: true + level1: Mobile + level2: null + namePartsWithoutCategory: + - mobileBeacon + - backend + - traceId + name: mobileBeacon.backend.traceId + type: STRING + aliases: [] + label: Backend Trace ID + description: >- + Unique identifier that connects the mobile app beacon with + backend traces + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.http.headers + availability: [] + idTag: false + level1: Mobile + level2: null + namePartsWithoutCategory: + - mobileBeacon + - http + - headers + name: mobileBeacon.http.headers + type: KEY_VALUE_PAIR + aliases: [] + label: HTTP Headers + description: HTTP Headers collected via our Mobile App agent. + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.error.count + availability: [] + idTag: false + level1: Mobile + level2: null + namePartsWithoutCategory: + - mobileBeacon + - error + - count + name: mobileBeacon.error.count + type: NUMBER + aliases: [] + label: Error Count + description: The number of errors recorded for a single beacon. + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.http.encodedBodySize + availability: [] + idTag: false + level1: Mobile + level2: HTTP + namePartsWithoutCategory: + - mobileBeacon + - http + - encodedBodySize + name: mobileBeacon.http.encodedBodySize + type: NUMBER + aliases: [] + label: Encoded Body Size + description: >- + The size in bytes of a response body, e.g. HTTP entity or + cache retrieval, with any content-encoding, e.g. gzip, + still applied. + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.http.url + availability: [] + idTag: false + level1: Mobile + level2: HTTP + namePartsWithoutCategory: + - mobileBeacon + - http + - url + name: mobileBeacon.http.url + type: STRING + aliases: [] + label: URL + description: The fully qualified URL of the executed HTTP request. + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.erroneous + availability: [] + idTag: false + level1: Mobile + level2: null + namePartsWithoutCategory: + - mobileBeacon + - erroneous + name: mobileBeacon.erroneous + type: BOOLEAN + aliases: [] + label: Erroneous + description: Whether or not a beacon has an error count > 0. + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.http.decodedBodySize + availability: [] + idTag: false + level1: Mobile + level2: HTTP + namePartsWithoutCategory: + - mobileBeacon + - http + - decodedBodySize + name: mobileBeacon.http.decodedBodySize + type: NUMBER + aliases: [] + label: Decoded Body Size + description: >- + The size in bytes of a response body, e.g. HTTP entity or + cache retrieval, after content decoding, e.g. after + decompression. + - canApplyToDestination: false + canApplyToSource: false + nameWithoutCategory: mobileBeacon.error.message + availability: [] + idTag: false + level1: Mobile + level2: null + namePartsWithoutCategory: + - mobileBeacon + - error + - message + name: mobileBeacon.error.message + type: STRING + aliases: [] + label: Error Message + description: >- + The detailed error message describing what went wrong in + the mobile app schema: $ref: '#/components/schemas/TagCatalog' description: OK @@ -23739,69 +24484,68 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get mobile app monitoring tag catalog for Mobile App SLOs tags: - - SLO Catalog for Mobile App + - SLO Catalog for Mobile App x-description: getMobileAppSloTagCatalog /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 + - in: query + name: sloId + schema: + type: array + 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 + 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: @@ -23810,51 +24554,50 @@ paths: 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: + - 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 - sloConfigs: - - SLO4s-fs-GuT56c3v4KzQKBuQ - - from: 1750172400000 - to: 1750176418243 - correctionConfigs: + - uvP7Z03pSUuybDT8-WHLDA + - CpCe85NeQC2xOKXQluC30g - 9Uf9TtvVRgOIMR0DkLB2Ng - sloConfigs: [ - ] - - from: 1750125600000 - to: 1750136400000 - correctionConfigs: - 96MtLg5zRP-lmT4WOUE3Yg - sloConfigs: - - SLO4s-fs-GuT56c3v4KzQKBuQ - activeCorrectionConfigIds: - - S8rHrE93Rz2TXScTjBw1eg - - uvP7Z03pSUuybDT8-WHLDA - - CpCe85NeQC2xOKXQluC30g - - 9Uf9TtvVRgOIMR0DkLB2Ng - - 96MtLg5zRP-lmT4WOUE3Yg - - p9kWax0uS7K2Who1WegsSg + - p9kWax0uS7K2Who1WegsSg inActiveCorrectionConfigIds: - - nNMSbRwFQEKoQ1Wj0BCWcg + - nNMSbRwFQEKoQ1Wj0BCWcg schema: type: array items: @@ -23865,79 +24608,83 @@ paths: application/json: example: errors: - - No SLO Correction Windows found for the given parameters in this - time range + - >- + No SLO Correction Windows found for the given parameters in + this time range schema: type: array items: type: string - description: No SLO Correction Windows found for the given parameters in - this time range + description: >- + No SLO Correction Windows found for the given parameters in this + time range security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Generate SLO Correction Windows tags: - - SLO Correction Windows + - SLO Correction Windows /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 + - 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 + - 0KmqAFCLeONAGzW4NRbV + - 174tEB4Oe7YsedZA25bh + - 1gV7O4bmdpGZYDG4Ojdd + - 1oYkh2uPmFQAEa3IraUq + - 1tHGNPXKWeaLV2pAN0gT + - 1uZxs5rQvJdf1jwMH6zq + - 3hmyDjiWBJotlh06MKGR + - 4H6WNu3RoluhkEo7iNJC + - 6K627mcw5jxHOkAUXHkm + - 7MKJz441px6U5U0L7Xcb page: 1 pageSize: 10 totalHits: 100 @@ -23958,69 +24705,82 @@ paths: 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 + - ApiKeyAuth: + - Default + summary: >- + Get the entities monitored by a SLO (Service Level Objective) + configuration tags: - - Service Levels Objective(SLO) Report + - Service Levels Objective(SLO) Report /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" + - 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: |2 + **Slo overview** + - Name: sample-application-availability-eventBased-fixed-1-week + - Target: 99% + - Time window: fixed 1 week + + **Entity context** + - Type: application + - Application id: jo2-TgULSnqzJp2UgN9oLA + - Label: All Services + - Scope: include immediate downstream database and messaging, inbound boundary + - Tag filter: call.type not empty + - Access: read/write global + + **Current performance status** + - Sli: 92.08% (below target) + - Error budget total: 467 units + - Error budget remaining: -3232 (overrun) + - Error budget spent: 3699 units + - Error burn rate: 7 (seven times the allowed rate) + - Error accumulation exhausted the error budget by the fourth interval + - Violation distribution: none reported (budget exhausted) + + **Key insights** + - Slo is significantly breached, indicating major availability issues. + - Error budget was exhausted quickly, suggesting a sustained high error rate. + - Burn rate consistently above 7, far exceeding the safe threshold of 1. + - Most errors occurred early in the reporting period (first 4 intervals). + - No specific violation distribution provided, implying widespread impact across the application. + + **Recommendations** + - Initiate immediate incident response to identify root causes of availability failures. + - Review downstream database and messaging dependencies for latency or failures. + - Increase monitoring granularity on the affected services and error events. + - Implement automated alerts when burn rate exceeds 2× the target. + - Consider short‑term remediation (restart services, roll back recent changes) to restore availability. + - Conduct a post‑mortem and update runbooks to prevent recurrence. + - Re‑evaluate the slo target or threshold if the current environment cannot realistically meet 99% availability. schema: type: array items: @@ -24031,63 +24791,67 @@ paths: application/json: example: errors: - - There is no SLO configuration for the given ID or the report hasn't - been generated yet. + - >- + 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. + description: >- + There is no SLO configuration for the given ID or the explain result + hasn't been generated yet. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Explain Service Levels objective with more details. tags: - - Service Levels Objective(SLO) Report + - Service Levels Objective(SLO) Report /api/slo/report/{sloId}: get: operationId: getSlo parameters: - - description: 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: + - description: SLO Configuration ID + example: SLOEANnWh9tQOa2h88kGxK6wQ + in: path + name: sloId + required: true + schema: 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: + - description: >- + Starting point for the data retrieval, specified as 13 digit Unix + Timestamp milliseconds + example: 1706713140000 + in: query + name: from + schema: type: string - uniqueItems: true + - 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: @@ -24786,51 +25550,62 @@ paths: application/json: example: errors: - - There is no SLO configuration for the given ID or the report hasn't - been generated yet. + - >- + 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. + description: >- + There is no SLO configuration for the given ID or the report hasn't + been generated yet. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Generate Service Levels report tags: - - Service Levels Objective(SLO) Report + - Service Levels Objective(SLO) Report /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 + - 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. + 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: @@ -24841,193 +25616,195 @@ paths: application/json: example: errors: - - There is no SLO configuration for the given ID or the report hasn't - been generated yet. + - >- + 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 + description: >- + There is no SLO configuration for the given ID or the summarization result hasn't been generated yet. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Summarize Service Levels objective results. tags: - - Service Levels Objective(SLO) Report + - Service Levels Objective(SLO) Report /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_ADAPTIVE_BASELINE_FAST_INIT - - SMART_ALERTS_CUSTOM_PAYLOAD - - SLI_MANAGEMENT - - APPLICATION_CONFIG - - APPLICATION_CONFIG_BLUEPRINT - - MAINTENANCE_WINDOWS - - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + - 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_ADAPTIVE_BASELINE_FAST_INIT + - 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 + - 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 + - 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 @@ -25038,11 +25815,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get synthetic tag catalog tags: - - Synthetic Catalog + - Synthetic Catalog x-description: getSyntheticTagCatalog /api/synthetics/catalog/metrics: get: @@ -25053,21 +25830,21 @@ paths: 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 + - 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: @@ -25078,17 +25855,19 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Metric catalog tags: - - Synthetic Catalog + - Synthetic Catalog x-description: getSyntheticCatalogMetrics /api/synthetics/metrics: post: - description: |- + 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. + + 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: @@ -25098,15 +25877,15 @@ paths: page: 1 pageSize: 3 metrics: - - metric: synthetic.metricsResponseTime - aggregation: SUM + - metric: synthetic.metricsResponseTime + aggregation: SUM timeFrame: to: 0 windowSize: 3600000 groups: - - groupbyTag: synthetic.applicationId - - groupbyTag: synthetic.tags - groupbyTagSecondLevelTag: region + - groupbyTag: synthetic.applicationId + - groupbyTag: synthetic.tags + groupbyTagSecondLevelTag: region schema: $ref: '#/components/schemas/GetMetricsResult' x-payload: getMetricsResult @@ -25116,41 +25895,41 @@ paths: 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 + - 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 @@ -25164,16 +25943,20 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Synthetic Metrics tags: - - Synthetic Metrics + - Synthetic Metrics /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. + 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: @@ -25183,8 +25966,8 @@ paths: page: 1 pageSize: 3 metrics: - - metric: synthetic.metricsResponseTime - aggregation: SUM + - metric: synthetic.metricsResponseTime + aggregation: SUM order: by: synthetic.startTime direction: DESC @@ -25200,24 +25983,24 @@ paths: 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 + - 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 @@ -25231,16 +26014,20 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Synthetic test playback results tags: - - Synthetic Test Playback Results + - Synthetic Test Playback Results /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. + 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: @@ -25250,9 +26037,9 @@ paths: page: 1 pageSize: 3 syntheticMetrics: - - synthetic.metricsResponseTime - - status - - synthetic.errors + - synthetic.metricsResponseTime + - status + - synthetic.errors order: by: start_time direction: DESC @@ -25262,12 +26049,12 @@ paths: TagFilterExpression: type: EXPRESSION elements: - - type: EXPRESSION - elements: - - name: synthetic.errors - stringValue: Exception - operator: CONTAINS - logicalOperator: OR + - type: EXPRESSION + elements: + - name: synthetic.errors + stringValue: Exception + operator: CONTAINS + logicalOperator: OR logicalOperator: OR analyticFunction: LAST_VALUE schema: @@ -25279,77 +26066,87 @@ paths: 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 + - 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 @@ -25363,16 +26160,20 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get a list of Synthetic tests based on the specified analytic function tags: - - Synthetic Test Playback Results + - Synthetic Test Playback Results /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. + 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: @@ -25382,9 +26183,9 @@ paths: page: 1 pageSize: 3 syntheticMetrics: - - synthetic.metricsResponseTime - - status - - synthetic.errors + - synthetic.metricsResponseTime + - status + - synthetic.errors order: by: start_time direction: DESC @@ -25394,12 +26195,12 @@ paths: TagFilterExpression: type: EXPRESSION elements: - - type: EXPRESSION - elements: - - name: synthetic.errors - stringValue: Exception - operator: CONTAINS - logicalOperator: OR + - type: EXPRESSION + elements: + - name: synthetic.errors + stringValue: Exception + operator: CONTAINS + logicalOperator: OR logicalOperator: OR schema: $ref: '#/components/schemas/GetTestResultList' @@ -25410,77 +26211,87 @@ paths: 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 + - 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 @@ -25494,16 +26305,20 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get a list of Synthetic test playback results tags: - - Synthetic Test Playback Results + - Synthetic Test Playback Results /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. + 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: @@ -25524,46 +26339,45 @@ paths: 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 + - 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.2 + - 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 @@ -25577,32 +26391,37 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default - summary: Get a list of Synthetic locations with last run test on each location + - ApiKeyAuth: + - Default + summary: >- + Get a list of Synthetic locations with last run test on each location data tags: - - Synthetic Test Playback Results + - Synthetic Test Playback Results /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. + 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 + - aggregation: MEAN + metric: success_rate + granularity: 600 TagFilterExpression: type: EXPRESSION elements: - - name: synthetic.testActive - booleanValue: true - operator: EQUALS + - name: synthetic.testActive + booleanValue: true + operator: EQUALS logicalOperator: AND timeFrame: to: 0 @@ -25619,125 +26438,125 @@ paths: 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 + - 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 @@ -25751,41 +26570,47 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default - summary: Get a list of Synthetic tests with success rate and average response + - ApiKeyAuth: + - Default + summary: >- + Get a list of Synthetic tests with success rate and average response time data tags: - - Synthetic Test Playback Results + - Synthetic Test Playback Results /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. + 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 + - 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: @@ -25796,7 +26621,7 @@ paths: startTime: 1730295066008 metadata: logs.tgz: - - console.log + - console.log schema: $ref: '#/components/schemas/TestResultMetadata' description: OK @@ -25809,59 +26634,64 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Synthetic test playback detail result description(metadata) tags: - - Synthetic Test Playback Results + - Synthetic Test Playback Results /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. + 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 - - 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 - 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 + - 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 + - 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 + 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: @@ -25869,21 +26699,41 @@ paths: 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 + 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 + + 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 + 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 + + 2024-01-18T19:56:01.103Z [SyntheticPoP] synthetic playback + ends schema: $ref: '#/components/schemas/TestResultDetailData' description: OK @@ -25896,57 +26746,60 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get Synthetic test playback result detail data tags: - - Synthetic Test Playback Results + - Synthetic Test Playback Results /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. + 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 + - 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: { - } + application/octet-stream: {} description: OK '401': description: Unauthorized access - requires user authentication. @@ -25957,37 +26810,39 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Download the synthetic test playback result detail data file tags: - - Synthetic Test Playback Results + - Synthetic Test Playback Results x-description: getSyntheticResultDetailDataFile /api/synthetics/settings/credentials: get: - description: |- + 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. + + 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 + - 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: @@ -26002,16 +26857,18 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canUseSyntheticCredentials - - canConfigureSyntheticTests + - ApiKeyAuth: + - canUseSyntheticCredentials + - canConfigureSyntheticTests summary: All Synthetic credential names tags: - - Synthetic Settings + - Synthetic Settings post: - description: |- + 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. + + 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: @@ -26020,16 +26877,15 @@ paths: credentialName: userPassword credentialValue: '123456' rbacTags: - - id: test - displayName: test + - id: test + displayName: test schema: $ref: '#/components/schemas/SyntheticCredential' required: true responses: '200': content: - application/json: { - } + application/json: {} description: OK '401': description: Unauthorized access - requires user authentication. @@ -26038,33 +26894,35 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticCredentials + - ApiKeyAuth: + - canConfigureSyntheticCredentials summary: Create a Synthetic credential tags: - - Synthetic Settings + - Synthetic Settings x-payload: createSyntheticCredential /api/synthetics/settings/credentials/associations: get: - description: |- + 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. + + 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 + - credentialName: password1 + createdAt: 1717617206785 + modifiedAt: 1717617206785 + - credentialName: password2 + applications: + - f4KX5zd8RW2pERKKFUCZgQ + applicationLabels: + - All Services + createdAt: 1717620972843 + modifiedAt: 1717620972843 schema: type: array items: @@ -26079,26 +26937,28 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canUseSyntheticCredentials - - canConfigureSyntheticTests + - ApiKeyAuth: + - canUseSyntheticCredentials + - canConfigureSyntheticTests summary: All Synthetic credentials tags: - - Synthetic Settings + - Synthetic Settings /api/synthetics/settings/credentials/associations/{name}: get: - description: |- + 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. + + 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 + - description: Name of the credential to be retrieved + example: password4test + in: path + name: name + required: true + schema: + type: string responses: '200': content: @@ -26106,9 +26966,9 @@ paths: example: credentialName: password4test applications: - - f4KX5zd8RW2pERKKFUCZgQ + - f4KX5zd8RW2pERKKFUCZgQ applicationLabels: - - All Services + - All Services createdAt: 1717620972843 modifiedAt: 1717620972843 schema: @@ -26123,26 +26983,28 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canUseSyntheticCredentials - - canConfigureSyntheticTests + - ApiKeyAuth: + - canUseSyntheticCredentials + - canConfigureSyntheticTests summary: A Synthetic credential tags: - - Synthetic Settings + - Synthetic Settings /api/synthetics/settings/credentials/{name}: delete: - description: |- + 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. + + 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 + - 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. @@ -26153,42 +27015,43 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticCredentials + - ApiKeyAuth: + - canConfigureSyntheticCredentials summary: Delete a Synthetic credential tags: - - Synthetic Settings + - Synthetic Settings patch: - description: |- + 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. + + 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 + - 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 + - f4KX5zd8RW2pERKKFUCZgQ rbacTags: - - id: test - displayName: test + - id: test + displayName: test schema: $ref: '#/components/schemas/SyntheticCredential' required: true responses: '200': content: - application/json: { - } + application/json: {} description: OK '401': description: Unauthorized access - requires user authentication. @@ -26197,26 +27060,28 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canUseSyntheticCredentials - - canConfigureSyntheticTests + - ApiKeyAuth: + - canUseSyntheticCredentials + - canConfigureSyntheticTests summary: Patch a Synthetic credential tags: - - Synthetic Settings + - Synthetic Settings x-description: patchSyntheticCredential put: - description: |- + 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. + + 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 + - description: Name of the credential to be updated + example: password4db2 + in: path + name: name + required: true + schema: + type: string requestBody: content: application/json: @@ -26224,18 +27089,17 @@ paths: credentialName: password4db2 credentialValue: '123456' applications: - - f4KX5zd8RW2pERKKFUCZgQ + - f4KX5zd8RW2pERKKFUCZgQ rbacTags: - - id: test - displayName: test + - id: test + displayName: test schema: $ref: '#/components/schemas/SyntheticCredential' required: true responses: '201': content: - application/json: { - } + application/json: {} description: Successful - resource created '401': description: Unauthorized access - requires user authentication. @@ -26244,51 +27108,53 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticCredentials + - ApiKeyAuth: + - canConfigureSyntheticCredentials summary: Update a Synthetic credential tags: - - Synthetic Settings + - Synthetic Settings x-payload: updateSyntheticCredential /api/synthetics/settings/datacenters: get: - description: |- + 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. + + 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 + - 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: @@ -26301,25 +27167,27 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticLocations + - ApiKeyAuth: + - canConfigureSyntheticLocations summary: All Synthetic datacenters tags: - - Synthetic Settings + - Synthetic Settings /api/synthetics/settings/datacenters/{datacenterId}: get: - description: |- + 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. + + 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 + - 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: @@ -26336,7 +27204,7 @@ paths: modifiedAt: 1728096600396 configuration: ipAddresses: - - 34.226.13.189 + - 34.226.13.189 locationLabel: instana-test-aws-us-east-1-NVirginia datacenterId: aws-us-east-1-NVirginia schema: @@ -26351,115 +27219,119 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticLocations + - ApiKeyAuth: + - canConfigureSyntheticLocations summary: A Synthetic datacenter tags: - - Synthetic Settings + - Synthetic Settings /api/synthetics/settings/locations: get: - description: |- + 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. + + 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: ' {}' + - 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 + - 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.2 + 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: @@ -26470,26 +27342,28 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canViewSyntheticLocations + - ApiKeyAuth: + - canViewSyntheticLocations summary: All Synthetic locations tags: - - Synthetic Settings + - Synthetic Settings x-description: getSyntheticLocations /api/synthetics/settings/locations/{id}: delete: - description: |- + 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. + + 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 + - 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. @@ -26498,25 +27372,27 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticLocations + - ApiKeyAuth: + - canConfigureSyntheticLocations summary: Delete a Synthetic location tags: - - Synthetic Settings + - Synthetic Settings x-description: deleteSyntheticLocation get: - description: |- + 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. + + 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 + - description: Identifier of the location to be retrieved + example: OjJPXWHmsE9deLzanNAW + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -26525,18 +27401,18 @@ paths: id: OjJPXWHmsE9deLzanNAW label: Austin displayLabel: AUTOscaling - popVersion: 1.1.1 + popVersion: 1.1.2 description: Test Location 101 locationType: Private playbackCapabilities: syntheticType: - - HTTPAction - - HTTPScript - - BrowserScript - - WebpageScript + - HTTPAction + - HTTPScript + - BrowserScript + - WebpageScript browserType: - - firefox - - chrome + - firefox + - chrome geoPoint: cityName: austin countryName: india @@ -26545,8 +27421,7 @@ paths: totalTests: 0 configuration: namespace: andy - customProperties: { - } + customProperties: {} createdAt: 1698988890723 modifiedAt: 1700116951600 observedAt: 1705556766316 @@ -26561,169 +27436,185 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canViewSyntheticLocations + - ApiKeyAuth: + - canViewSyntheticLocations summary: A Synthetic location tags: - - Synthetic Settings + - Synthetic Settings /api/synthetics/settings/tests: get: - description: |- + 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. + + 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: ' {}' + - 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'); + - 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'); - // 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 - } - }; + $got('https://www.ibm.com').then(response=>{ + console.log('request 1/2:', response.statusCode); + assert.equal(response.statusCode, 200, 'it should be 200') + + setTimeout(()=>{ + $got('https://www.bing.com').then(response=>{ + console.log('request 2/2:', response.statusCode); + assert.equal(response.statusCode, 200, 'it should be 200') + }) - // 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"); + }, 70000); + }); + 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'); - 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"); - }; + // 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 + } + }; - // Initial test - performAPITest(); - scriptType: Basic - customProperties: - test: '123' - createdAt: 1696625954210 - modifiedAt: 1701216106812 - modifiedBy: Internal - rbacTags: - - id: test - displayName: test + // 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: @@ -26736,16 +27627,18 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canViewSyntheticTests + - ApiKeyAuth: + - canViewSyntheticTests summary: All Synthetic tests tags: - - Synthetic Settings + - Synthetic Settings x-description: getSyntheticTests post: - description: |- + 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. + + 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: @@ -26758,7 +27651,7 @@ paths: testFrequency: 1 playbackMode: Simultaneous locations: - - saas_instana_test + - saas_instana_test configuration: syntheticType: HTTPAction url: https://httpbin.org/post @@ -26771,8 +27664,8 @@ paths: Team: DevTeam Purpose: Demo rbacTags: - - id: test - displayName: test + - id: test + displayName: test schema: $ref: '#/components/schemas/SyntheticTest' required: true @@ -26790,7 +27683,7 @@ paths: testFrequency: 1 playbackMode: Simultaneous locations: - - saas_instana_test + - saas_instana_test configuration: syntheticType: HTTPAction url: https://httpbin.org/post @@ -26803,8 +27696,8 @@ paths: Team: DevTeam Purpose: Demo rbacTags: - - id: test - displayName: test + - id: test + displayName: test schema: $ref: '#/components/schemas/SyntheticTest' description: Successful - resource created @@ -26815,11 +27708,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticTests + - ApiKeyAuth: + - canConfigureSyntheticTests summary: Create a Synthetic test tags: - - Synthetic Settings + - Synthetic Settings x-description: createSyntheticTest /api/synthetics/settings/tests/bulk-delete: post: @@ -26829,10 +27722,10 @@ paths: content: application/json: example: - - ic25Vt1T5dgKzi0K7812 - - EFNRoPd39SgZBkULeQIf - - kaj02pbxbW0XmQP9qu4b - - FrhxAJzKdsXU6V4WxWrY + - ic25Vt1T5dgKzi0K7812 + - EFNRoPd39SgZBkULeQIf + - kaj02pbxbW0XmQP9qu4b + - FrhxAJzKdsXU6V4WxWrY schema: type: array items: @@ -26844,14 +27737,14 @@ paths: 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 + - 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: @@ -26864,11 +27757,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticTests + - ApiKeyAuth: + - canConfigureSyntheticTests summary: Delete Synthetic tests tags: - - Synthetic Settings + - Synthetic Settings /api/synthetics/settings/tests/bulk-update: post: description: API request to update a list of Synthetic Tests. @@ -26910,14 +27803,14 @@ paths: 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 + - 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: @@ -26930,75 +27823,80 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticTests + - ApiKeyAuth: + - canConfigureSyntheticTests summary: Update Synthetic tests tags: - - Synthetic Settings + - Synthetic Settings /api/synthetics/settings/tests/ci-cd: get: - description: |- + 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. + + 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 + - 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 + - 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: @@ -27011,32 +27909,34 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticTests + - ApiKeyAuth: + - canConfigureSyntheticTests summary: All Synthetic test CI/CDs tags: - - Synthetic Settings + - Synthetic Settings x-description: getSyntheticTestCICDs post: - description: |- + 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. + + 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 + - testId: K331gkuCbelN1HI5y1wl + customization: + locations: + - 8mCxCPOI7oEmMSee4ec0 + - lalQTzq7MwO6hZ6c6xDd + configuration: + timeout: 100ms + retries: 2 + customProperties: + Team: DevTeam + Purpose: Demo schema: type: array items: @@ -27048,12 +27948,12 @@ paths: content: application/json: example: - - testResultId: f078443e-468c-4e35-b614-979ad9200fe4 - testId: K331gkuCbelN1HI5y1wl - locationId: 8mCxCPOI7oEmMSee4ec0 - - testResultId: 2cba4974-c73a-45ea-ad63-77c44c19bd36 - testId: K331gkuCbelN1HI5y1wl - locationId: lalQTzq7MwO6hZ6c6xDd + - testResultId: f078443e-468c-4e35-b614-979ad9200fe4 + testId: K331gkuCbelN1HI5y1wl + locationId: 8mCxCPOI7oEmMSee4ec0 + - testResultId: 2cba4974-c73a-45ea-ad63-77c44c19bd36 + testId: K331gkuCbelN1HI5y1wl + locationId: lalQTzq7MwO6hZ6c6xDd schema: type: array items: @@ -27066,26 +27966,29 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticTests + - ApiKeyAuth: + - canConfigureSyntheticTests summary: Create a Synthetic test CI/CD tags: - - Synthetic Settings + - Synthetic Settings x-description: createSyntheticTestCICD /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. + 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 + - 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: @@ -27115,26 +28018,28 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticTests + - ApiKeyAuth: + - canConfigureSyntheticTests summary: A Synthetic test CI/CD. tags: - - Synthetic Settings + - Synthetic Settings x-description: getSyntheticTestCICD /api/synthetics/settings/tests/{id}: delete: - description: |- + 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. + + 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 + - 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. @@ -27145,24 +28050,26 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticTests + - ApiKeyAuth: + - canConfigureSyntheticTests summary: Delete a Synthetic test tags: - - Synthetic Settings + - Synthetic Settings get: - description: |- + 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. + + 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 + - description: Id of the synthetic test to be retrieved + example: EFNRoPd39SgZBkULeQIf + in: path + name: id + required: true + schema: + type: string responses: '200': content: @@ -27177,11 +28084,11 @@ paths: applicationId: UOGJ3jBOSMOgN2EBCoOghw applicationLabel: test_cb locations: - - 18WyhtDb5jpVOsjlNdeV + - 18WyhtDb5jpVOsjlNdeV locationLabels: - - Syne2e + - Syne2e locationDisplayLabels: - - E2ETest PoP + - E2ETest PoP configuration: syntheticType: HTTPScript markSyntheticCall: true @@ -27222,8 +28129,8 @@ paths: modifiedAt: 1701216106812 modifiedBy: Internal rbacTags: - - id: test - displayName: test + - id: test + displayName: test schema: $ref: '#/components/schemas/SyntheticTest' description: OK @@ -27236,24 +28143,26 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canViewSyntheticTests + - ApiKeyAuth: + - canViewSyntheticTests summary: A Synthetic test tags: - - Synthetic Settings + - Synthetic Settings patch: - description: |- + 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. + + 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 + - description: Id of the synthetic test to be patched + example: ic25Vt1T5dgKzi0K7812 + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -27263,8 +28172,8 @@ paths: scripts: null script: //script goes here rbacTags: - - id: test - displayName: test + - id: test + displayName: test schema: $ref: '#/components/schemas/SyntheticTest' required: true @@ -27272,8 +28181,7 @@ paths: responses: '200': content: - application/json: { - } + application/json: {} description: OK '400': description: Bad request. @@ -27284,25 +28192,27 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticTests + - ApiKeyAuth: + - canConfigureSyntheticTests summary: Patch a Synthetic test tags: - - Synthetic Settings + - Synthetic Settings x-description: patchSyntheticTest put: - description: |- + 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. + + 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 + - description: Id of the synthetic test to be updated + example: ic25Vt1T5dgKzi0K7812 + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -27315,7 +28225,7 @@ paths: testFrequency: 1 playbackMode: Simultaneous locations: - - saas_instana_test + - saas_instana_test configuration: syntheticType: HTTPAction url: https://httpbin.org/post @@ -27328,8 +28238,8 @@ paths: Team: DevTeam Purpose: Demo rbacTags: - - id: JxrVZtRtTUGug71K1oYMcw - displayName: tests + - id: JxrVZtRtTUGug71K1oYMcw + displayName: tests schema: $ref: '#/components/schemas/SyntheticTest' required: true @@ -27337,8 +28247,7 @@ paths: responses: '200': content: - application/json: { - } + application/json: {} description: OK '400': description: Bad request. @@ -27349,11 +28258,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - canConfigureSyntheticTests + - ApiKeyAuth: + - canConfigureSyntheticTests summary: Update a Synthetic test tags: - - Synthetic Settings + - Synthetic Settings x-description: updateSyntheticTest /api/tos-privacy-agreement: post: @@ -27361,8 +28270,7 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response /api/tos-privacy-agreement/checkUserAcceptance: get: @@ -27380,8 +28288,7 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response /api/ui/settings: get: @@ -27389,31 +28296,28 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response put: operationId: putUiSettings responses: default: content: - application/json: { - } + application/json: {} description: default response /api/ui/settings/{setting}: put: operationId: putUiSetting parameters: - - in: path - name: setting - required: true - schema: - type: string + - in: path + name: setting + required: true + schema: + type: string responses: default: content: - application/json: { - } + application/json: {} description: default response /api/user-settings: get: @@ -27421,52 +28325,52 @@ paths: responses: default: content: - application/json: { - } + application/json: {} description: default response put: operationId: put_1 responses: default: content: - application/json: { - } + application/json: {} description: default response /api/website-monitoring/analyze/beacon-groups: post: - description: |- + 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. + + 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 + - in: query + name: fillTimeSeries + schema: + type: boolean requestBody: content: application/json: example: metrics: - - metric: beaconCount - aggregation: SUM - granularity: 60 + - 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 + - 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 @@ -27480,18 +28384,18 @@ paths: 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 + - name: Check Out + earliestTimestamp: 1707019058453 + cursor: + '@class': .IngestionOffsetCursor + ingestionTime: 1707022593250 + offset: 1 + metrics: + beaconCount.sum.60: + - - 1707019020000 + - 1 + - - 1707019080000 + - 3 canLoadMore: false totalHits: 1 totalRepresentedItemCount: 1 @@ -27507,16 +28411,18 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get grouped beacon metrics tags: - - Website Analyze + - Website Analyze /api/website-monitoring/analyze/beacons: post: - description: |- + 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. + + 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: @@ -27541,109 +28447,106 @@ paths: 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 + - 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 + 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 @@ -27652,83 +28555,86 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all beacons tags: - - Website Analyze + - Website Analyze /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 - minLength: 1 - - 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_ADAPTIVE_BASELINE_FAST_INIT - - SMART_ALERTS_CUSTOM_PAYLOAD - - SLI_MANAGEMENT - - APPLICATION_CONFIG - - APPLICATION_CONFIG_BLUEPRINT - - MAINTENANCE_WINDOWS - - BIZOPS_CUSTOM_DASHBOARDS_FILTERING + - description: beaconType + example: pageLoad + in: query + name: beaconType + required: true + schema: + type: string + minLength: 1 + - 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_ADAPTIVE_BASELINE_FAST_INIT + - 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 + - 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 + - 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. + 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 + - ApiKeyAuth: + - Default summary: Get website tag catalog tags: - - Website Catalog + - Website Catalog x-description: getWebsiteTagCatalog /api/website-monitoring/catalog/metrics: get: @@ -27739,44 +28645,45 @@ paths: 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 + - 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: @@ -27787,11 +28694,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Metric catalog tags: - - Website Catalog + - Website Catalog x-description: getWebsiteCatalogMetrics /api/website-monitoring/catalog/tags: get: @@ -27802,12 +28709,12 @@ paths: content: application/json: example: - - name: beacon.sessionId - type: STRING - category: WEBSITE - canApplyToSource: false - canApplyToDestination: false - sourceValueAvailableFrom: 0 + - name: beacon.sessionId + type: STRING + category: WEBSITE + canApplyToSource: false + canApplyToDestination: false + sourceValueAvailableFrom: 0 schema: type: array items: @@ -27818,11 +28725,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get all existing website tags tags: - - Website Catalog + - Website Catalog x-description: getWebsiteCatalogTags /api/website-monitoring/config: get: @@ -27833,12 +28740,12 @@ paths: content: application/json: example: - - id: K3bP-bmCRkyimNai9vvq8o - name: example_website - appName: example_website - rbacTags: - - id: test - displayName: test + - id: K3bP-bmCRkyimNai9vvq8o + name: example_website + appName: example_website + rbacTags: + - id: test + displayName: test schema: type: array items: @@ -27851,25 +28758,30 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get configured websites tags: - - Website Configuration + - Website Configuration post: description: API request to add new website. operationId: createWebsite parameters: - - in: query - name: name - schema: - type: string + - in: query + name: name + schema: + type: string + - in: query + name: businessCriticality + schema: + type: integer + format: int32 requestBody: content: application/json: example: - - id: test - displayName: test + - id: test + displayName: test schema: type: array description: Array of team tags @@ -27894,7 +28806,8 @@ paths: $ref: '#/components/schemas/Website' description: Website successfully configured '400': - description: Missing name query parameter or name already used for a configured + description: >- + Missing name query parameter or name already used for a configured website '401': description: Unauthorized access - requires user authentication. @@ -27903,23 +28816,23 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Configure new website tags: - - Website Configuration + - Website Configuration /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 + - description: Website ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: websiteId + required: true + schema: + type: string responses: '204': description: Website successfully removed @@ -27930,22 +28843,22 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Remove website tags: - - Website Configuration + - Website Configuration 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 + - description: Website ID + example: 1ELrNt-eQ9SlK4D_EgLMiA + in: path + name: websiteId + required: true + schema: + type: string responses: '200': content: @@ -27968,26 +28881,26 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get configured website tags: - - Website Configuration + - Website Configuration 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 + - 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: @@ -28000,7 +28913,8 @@ paths: $ref: '#/components/schemas/Website' description: Website successfully renamed '400': - description: Missing name query parameter or name already used for a configured + description: >- + Missing name query parameter or name already used for a configured website '401': description: Unauthorized access - requires user authentication. @@ -28009,32 +28923,32 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Rename website tags: - - Website Configuration + - Website Configuration /api/website-monitoring/config/{websiteId}/geo-location: get: - description: API request to get geo-location configuration of a website specified - by its websiteId + 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 + - 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: [ - ] + geoMappingRules: [] schema: $ref: '#/components/schemas/GeoLocationConfiguration' description: OK @@ -28047,22 +28961,22 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Get geo location configuration for website tags: - - Website Configuration + - Website Configuration 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 + - description: Website ID + example: iiLxP1zaTuCS7fyk9m4W0W + in: path + name: websiteId + required: true + schema: + type: string requestBody: content: application/json: @@ -28084,28 +28998,27 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Update geo location configuration for website tags: - - Website Configuration + - Website Configuration /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 + - description: Website ID + example: iiLxP1zaTuCS7fyk9m4W0W + in: path + name: websiteId + required: true + schema: + type: string responses: '200': content: - text/csv: { - } + text/csv: {} description: OK '401': description: Unauthorized access - requires user authentication. @@ -28116,22 +29029,22 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Get custom geo mapping rules for website tags: - - Website Configuration + - Website Configuration 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 + - description: Website ID + example: K3bP-bmCRkyimNai9vvq8o + in: path + name: websiteId + required: true + schema: + type: string requestBody: content: text/csv: @@ -28140,8 +29053,7 @@ paths: responses: '200': content: - text/csv: { - } + text/csv: {} description: OK '401': description: Unauthorized access - requires user authentication. @@ -28154,24 +29066,25 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Set custom geo mapping rules for website tags: - - Website Configuration + - Website Configuration /api/website-monitoring/config/{websiteId}/ip-masking: get: - description: API request to get IP masking configuration of a website specified - by its websiteId + 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 + - description: Website ID + example: 1ELrNt-eQ9SlK4D_EgLMiA + in: path + name: websiteId + required: true + schema: + type: string responses: '200': content: @@ -28190,22 +29103,22 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Get IP masking configuration for website tags: - - Website Configuration + - Website Configuration 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 + - description: Website ID + example: iiLxP1zaTuCS7fyk9m4W0W + in: path + name: websiteId + required: true + schema: + type: string requestBody: content: application/json: @@ -28227,35 +29140,34 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Update IP masking configuration for website tags: - - Website Configuration + - Website Configuration /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 + - 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: [ - ] + - id: 67f84a0b117c99e + description: websiteSourcemapUploadConfig1 + createdAt: 1747978171.2347815 + modifiedAt: 1747978171.2347815 + metadata: [] schema: $ref: '#/components/schemas/SourceMapUploadConfigs' description: OK @@ -28265,18 +29177,18 @@ paths: description: Internal server error. summary: Get all sourcemap upload configurations for website tags: - - Website Configuration + - Website Configuration 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 + - description: Website ID + example: 1ELrNt-eQ9SlK4D_EgLMiA + in: path + name: websiteId + required: true + schema: + type: string requestBody: content: application/json: @@ -28296,10 +29208,9 @@ paths: example: id: 5894971d635094e7 description: websiteSourcemapConfig2 - createdAt: 1.7479800626018546E9 - modifiedAt: 1.7479800626018546E9 - metadata: [ - ] + createdAt: 1747980062.6018546 + modifiedAt: 1747980062.6018546 + metadata: [] schema: $ref: '#/components/schemas/SourceMapUploadConfig' description: Website sourcemap upload configuration added successfully @@ -28315,30 +29226,29 @@ paths: description: Internal server error. summary: Add new sourcemap upload configuration for website tags: - - Website Configuration + - Website Configuration /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 + - 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 + description: Sourcemap configuration successfully deleted or sourcemap not found '401': description: Unauthorized access - requires user authentication. '403': @@ -28347,23 +29257,23 @@ paths: description: Internal server error. summary: Delete sourcemap upload configuration for website tags: - - Website Configuration + - Website Configuration 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 + - 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: @@ -28371,10 +29281,9 @@ paths: example: id: 67f84a0b117c99e description: websiteSourcemapUploadConfig1 - createdAt: 1.7479781712347815E9 - modifiedAt: 1.7479781712347815E9 - metadata: [ - ] + createdAt: 1747978171.2347815 + modifiedAt: 1747978171.2347815 + metadata: [] schema: $ref: '#/components/schemas/SourceMapUploadConfig' description: OK @@ -28384,29 +29293,32 @@ paths: description: Internal server error. summary: Get sourcemap upload configurations for website tags: - - Website Configuration + - Website Configuration /api/website-monitoring/config/{websiteId}/sourcemap-upload/{sourceMapConfigId}/clear: put: - description: API request to clear source map files for sourcemap upload configuration. + 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 + - 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 + description: >- + Source map files in the source map upload configuration successfully cleared '401': description: Unauthorized access - requires user authentication. @@ -28417,30 +29329,30 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Clear source map files for sourcemap upload configuration tags: - - Website Configuration + - Website Configuration /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 + - 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: @@ -28457,8 +29369,8 @@ paths: type: string description: URL of the website required: - - sourceMap - - url + - sourceMap + - url responses: '200': content: @@ -28466,10 +29378,9 @@ paths: example: id: 67f84a0b117c99e description: websiteSourcemapUploadConfig1 - createdAt: 1.7479781712347815E9 - modifiedAt: 1.7479781712347815E9 - metadata: [ - ] + createdAt: 1747978171.2347815 + modifiedAt: 1747978171.2347815 + metadata: [] schema: $ref: '#/components/schemas/SourceMapUploadConfig' description: OK @@ -28484,27 +29395,27 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Upload sourcemap file for website tags: - - Website Configuration + - Website Configuration /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 + - in: path + name: websiteId + required: true + schema: + type: string requestBody: content: application/json: example: - - id: test - displayName: test + - id: test + displayName: test schema: type: array items: @@ -28514,8 +29425,8 @@ paths: content: application/json: example: - - id: test - displayName: test + - id: test + displayName: test schema: type: array items: @@ -28530,11 +29441,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - CanConfigureEumApplications + - ApiKeyAuth: + - CanConfigureEumApplications summary: Update teams assigned to the website tags: - - Website Configuration + - Website Configuration /api/website-monitoring/metrics: post: deprecated: true @@ -28554,138 +29465,135 @@ paths: $ref: '#/components/schemas/WebsiteMetricResult' description: OK security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get beacon metrics tags: - - Website Metrics + - Website Metrics /api/website-monitoring/page-load;id={id};timestamp={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 + - 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 + - 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 + cspBlockedUri: '' + cspEffectiveDirective: '' + cspOriginalPolicy: '' + cspDisposition: '' + cspSample: '' + cspSourceFile: '' + cspLineNumber: -1 + cspColumnNumber: -1 + snippetVersion: '2' + httpCallHeaders: {} + parentBeaconId: '' + interactionNextPaint: -1 schema: type: array items: @@ -28696,11 +29604,11 @@ paths: '404': description: Resource not found. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get page load tags: - - Website Metrics + - Website Metrics /api/website-monitoring/v2/metrics: post: description: API request to get website monitoring beacon metrics. @@ -28710,22 +29618,22 @@ paths: application/json: example: metrics: - - metric: beaconCount - aggregation: SUM + - 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: / + - 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 @@ -28740,8 +29648,8 @@ paths: example: metrics: beaconCount.sum: - - - 1706856180000 - - 100.0 + - - 1706856180000 + - 100 adjustedTimeFrame: windowSize: 3540000 to: 1706856180000 @@ -28757,11 +29665,11 @@ paths: '500': description: Internal server error. security: - - ApiKeyAuth: - - Default + - ApiKeyAuth: + - Default summary: Get beacon metrics tags: - - Website Metrics + - Website Metrics components: schemas: AbstractIntegration: @@ -28803,9 +29711,9 @@ components: type: string description: The timezone to be used for DateTime required: - - id - - kind - - name + - id + - kind + - name AbstractRule: type: object discriminator: @@ -28824,47 +29732,73 @@ components: type: integer format: int32 required: - - ruleType + - ruleType 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" + description: >+ + Specifies the type of access permitted. + + + `READ`: Only viewing Application Perspective is allowed. + + + `READ_WRITE`: Both viewing and modifying Application Perspective are + permitted. + enum: - - READ - - READ_WRITE + - 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" + description: > + An identifier that connects the access rule to a specific entity. + + For example, if the `relationType` is `USER`, the corresponding + `relatedId` would be a user id. + + + **Note**: when `relationType` is `GLOBAL`, `relatedId` is `null`. maxLength: 64 minLength: 0 nullable: true 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" + description: > + Defines the type of relationship or subject to which the access rule + applies. + + + `USER`: Access is granted to an individual user. + + + `API_TOKEN`: Access is granted to a specific API token. + + + `ROLE`: Access is granted based on a user role, applying to any user + with that role. + + + `TEAM`: Access is granted to a team, likely applying to all team + members. + + + `GLOBAL`: Access is granted to every user or service. enum: - - USER - - API_TOKEN - - ROLE - - TEAM - - GLOBAL - required: - - accessType - - relationType + - USER + - API_TOKEN + - ROLE + - TEAM + - GLOBAL + required: + - accessType + - relationType Action: type: object - description: Automation action definition. When this is used in policy creation + description: >- + Automation action definition. When this is used in policy creation request, only `id` should be specified. properties: createdAt: @@ -28911,26 +29845,27 @@ components: minLength: 1 type: type: string - description: 'Action type can be one of the following values: SCRIPT, HTTP, - ANSIBLE, EXTERNAL, GITHUB, GITLAB, JIRA, MANUAL, DOC_LINK' + 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 + - SCRIPT + - HTTP + - ANSIBLE + - EXTERNAL + - GITHUB + - GITLAB + - JIRA + - MANUAL + - DOC_LINK maxLength: 128 minLength: 0 required: - - createdAt - - id - - modifiedAt - - name - - type + - createdAt + - id + - modifiedAt + - name + - type ActionBeacon: type: object description: List of action beacons for the current page @@ -28962,7 +29897,8 @@ components: nullable: true eventType: type: string - description: Event type (e.g., st=start, fs=frustration signal, oc=orientation + description: >- + Event type (e.g., st=start, fs=frustration signal, oc=orientation change) example: st nullable: true @@ -29017,11 +29953,11 @@ components: example: resetDirectory nullable: true required: - - beaconId - - beaconType - - mobileAppId - - sessionId - - timestamp + - beaconId + - beaconType + - mobileAppId + - sessionId + - timestamp ActionConfiguration: type: object description: List of action configurations. @@ -29038,13 +29974,14 @@ components: $ref: '#/components/schemas/ParameterValue' notifications: type: array - description: Optional notifications configuration for action execution events. - Each notification specifies a condition (started, fail, success) and associated - alert channels. + description: >- + Optional notifications configuration for action execution events. + Each notification specifies a condition (started, fail, success) and + associated alert channels. items: $ref: '#/components/schemas/Notification' required: - - action + - action ActionInstance: type: object properties: @@ -29069,20 +30006,22 @@ components: readOnly: true actorId: type: string - description: User identifier, API token or the policy identifier that started - the action run. + 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. + 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 + - ACTOR_UNKNOWN + - USER + - APITOKEN + - POLICY clientId: type: string description: Client ID (tenant key) where the action instance is stored. @@ -29090,31 +30029,34 @@ components: createdDate: type: integer format: int64 - description: Action run created timestamp. The timestamp at which the action - run got submitted. + 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. + 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. + 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. + 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. + 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. @@ -29130,8 +30072,7 @@ components: $ref: '#/components/schemas/ActionInstanceMetadataEntry' originatorClientId: type: string - description: Client ID (tenant key) where the action/policy was executed - from. + description: Client ID (tenant key) where the action/policy was executed from. readOnly: true output: type: string @@ -29141,8 +30082,7 @@ components: 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. + description: Event problem text of the event that triggered this action run. returnCode: type: integer format: int32 @@ -29150,41 +30090,43 @@ components: startDate: type: integer format: int64 - description: Action run start timestamp. The timestamp at which the action - run started on the agent host. + 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 + - 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. + 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 + - 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. @@ -29197,7 +30139,7 @@ components: type: string description: Metadata value. required: - - name + - name ActionInstanceParameter: type: object description: List of input parameters to this action run. @@ -29217,8 +30159,8 @@ components: type: string description: Parameter value. required: - - displayName - - name + - displayName + - name ActionInstanceRequest: type: object properties: @@ -29227,8 +30169,9 @@ components: 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"`.' + 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. @@ -29242,14 +30185,15 @@ components: $ref: '#/components/schemas/ActionInstanceRequestParameters' policyId: type: string - description: Policy identifier that associates the action trigger (incident - or issue) to the action to run. + 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 + - actionId + - hostId ActionInstanceRequestParameters: type: object description: Action run input parameters. @@ -29259,14 +30203,15 @@ components: 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`. + 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 + - name + - value ActionMatch: type: object properties: @@ -29275,12 +30220,12 @@ components: aiEngine: type: string enum: - - POLICY - - EVENT_SIMILARITY - - NLP - - SUCCESS_RATE - - TURBONOMIC - - WATSONX + - POLICY + - EVENT_SIMILARITY + - NLP + - SUCCESS_RATE + - TURBONOMIC + - WATSONX confidence: type: string policy: @@ -29305,109 +30250,116 @@ components: description: The name of an incident or issue. minLength: 1 required: - - name + - 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 + - $ref: '#/components/schemas/Threshold' + - type: object + properties: + deviationFactor: + type: number + format: double + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 16 + minimum: 0.5 required: - - operator + - 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 + - $ref: '#/components/schemas/ThresholdConfigRule' + - type: object + properties: + deviationFactor: + type: number + format: double + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 16 + minimum: 0.5 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) + 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) nullable: true 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.' + 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 + - to AdvancedCustomBlueprintIndicator: type: object allOf: - - $ref: '#/components/schemas/ServiceLevelIndicator' - - type: object - properties: - badEvents: - $ref: '#/components/schemas/AdvancedFilter' - goodEvents: - $ref: '#/components/schemas/AdvancedFilter' - required: - - goodEvents - - type + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + properties: + badEvents: + $ref: '#/components/schemas/AdvancedFilter' + goodEvents: + $ref: '#/components/schemas/AdvancedFilter' + required: + - goodEvents + - type AdvancedFilter: 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 + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE metric: $ref: '#/components/schemas/EntityMetric' operator: type: string enum: - - '>' - - '>=' - - < - - <= + - '>' + - '>=' + - < + - <= threshold: type: number format: double required: - - aggregation - - metric - - operator - - threshold + - aggregation + - metric + - operator + - threshold AgentConfigurationUpdate: type: object properties: @@ -29434,7 +30386,7 @@ components: type: integer format: int32 required: - - agent-mode + - agent-mode AlertingConfiguration: type: object properties: @@ -29445,8 +30397,9 @@ components: minLength: 0 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Supports both static and dynamic fields. Can be left + description: >- + Custom payload fields to send additional information in the alert + notifications. Supports both static and dynamic fields. Can be left empty. items: $ref: '#/components/schemas/CustomPayloadField' @@ -29461,8 +30414,9 @@ components: minLength: 0 includeEntityNameInLegacyAlerts: type: boolean - description: To include the entity name in a legacy alert based on built-in/custom - events. + 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. @@ -29476,15 +30430,16 @@ components: 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. + 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 + - alertName + - customPayloadFields + - eventFilteringConfiguration + - id + - integrationIds AlertingConfigurationWithLastUpdated: type: object properties: @@ -29495,8 +30450,9 @@ components: minLength: 0 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Supports both static and dynamic fields. Can be left + description: >- + Custom payload fields to send additional information in the alert + notifications. Supports both static and dynamic fields. Can be left empty. items: $ref: '#/components/schemas/CustomPayloadField' @@ -29511,8 +30467,9 @@ components: minLength: 0 includeEntityNameInLegacyAlerts: type: boolean - description: To include the entity name in a legacy alert based on built-in/custom - events. + 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. @@ -29526,21 +30483,23 @@ components: lastUpdated: type: integer format: int64 - description: Unix timestamp representing the time the configuration was - last updated. + 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. + 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 + - alertName + - customPayloadFields + - eventFilteringConfiguration + - id + - integrationIds AlertingTimeWindow: type: object properties: @@ -29550,41 +30509,42 @@ components: durationType: type: string enum: - - millisecond - - second - - minute - - hour - - day - - week - - month + - millisecond + - second + - minute + - hour + - day + - week + - month durationUnit: type: string enum: - - millisecond - - second - - minute - - hour - - day - - week - - month + - millisecond + - second + - minute + - hour + - day + - week + - month writeOnly: true required: - - duration - - durationType + - duration + - durationType ApdexAlertRule: type: object allOf: - - $ref: '#/components/schemas/ServiceLevelsAlertRule' - - type: object - properties: - metric: - type: string - description: This is the Apdex metric type. Apdex alert uses SCORE - metric. - enum: - - SCORE + - $ref: '#/components/schemas/ServiceLevelsAlertRule' + - type: object + properties: + metric: + type: string + description: >- + This is the Apdex metric type. Apdex alert uses SCORE + metric. + enum: + - SCORE required: - - metric + - metric ApdexConfigWithRBACTag: type: object properties: @@ -29606,7 +30566,8 @@ components: lastUpdated: type: integer format: int64 - description: Last updated date of Apdex Configuration (Unix timestamp in + description: >- + Last updated date of Apdex Configuration (Unix timestamp in milliseconds) rbacTags: type: array @@ -29620,9 +30581,9 @@ components: type: string description: List of tags associated with Apdex Configuration required: - - apdexEntity - - apdexName - - id + - apdexEntity + - apdexName + - id ApdexConfiguration: type: object properties: @@ -29644,7 +30605,8 @@ components: lastUpdated: type: integer format: int64 - description: Last updated date of Apdex Configuration (Unix timestamp in + description: >- + Last updated date of Apdex Configuration (Unix timestamp in milliseconds) tags: type: array @@ -29653,9 +30615,9 @@ components: type: string description: List of tags associated with Apdex Configuration required: - - apdexEntity - - apdexName - - id + - apdexEntity + - apdexName + - id ApdexConfigurationInput: type: object properties: @@ -29673,8 +30635,8 @@ components: type: string description: List of tags associated with Apdex Configuration required: - - apdexEntity - - apdexName + - apdexEntity + - apdexName ApdexEntity: type: object description: Entity which holds the information of Apdex Configuration @@ -29696,9 +30658,9 @@ components: format: int32 minimum: 1 required: - - apdexType - - entityId - - tagFilterExpression + - apdexType + - entityId + - tagFilterExpression ApdexLevel: type: object description: Apdex satisfaction level definition with threshold boundaries @@ -29721,7 +30683,7 @@ components: type: number format: double description: Upper threshold boundary (inclusive) - example: 1.0 + example: 1 ApdexReport: type: object properties: @@ -29730,26 +30692,31 @@ components: description: Apdex Configuration ID apdexScore: type: array - description: Apdex Score in different timestamps from starting to the ending + 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 + 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 + 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 + 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 + description: >- + Ending point for the data retrieval, specified as 13 digit Unix + Timestamp milliseconds ApiCreateGroup: type: object properties: @@ -29769,9 +30736,9 @@ components: permissionSet: $ref: '#/components/schemas/ApiPermissionSet' required: - - members - - name - - permissionSet + - members + - name + - permissionSet ApiCreateRole: type: object properties: @@ -29799,7 +30766,7 @@ components: nullable: true uniqueItems: true required: - - name + - name ApiGroup: type: object properties: @@ -29823,10 +30790,10 @@ components: permissionSet: $ref: '#/components/schemas/ApiPermissionSet' required: - - id - - members - - name - - permissionSet + - id + - members + - name + - permissionSet ApiLogItem: type: object properties: @@ -29916,7 +30883,7 @@ components: userId: type: string required: - - userId + - userId ApiPermissionSet: type: object properties: @@ -30005,18 +30972,18 @@ components: minItems: 0 uniqueItems: true required: - - apdexIds - - applicationIds - - businessPerspectiveIds - - infraDfqFilter - - kubernetesClusterUUIDs - - kubernetesNamespaceUIDs - - mobileAppIds - - permissions - - sloIds - - syntheticCredentialKeys - - syntheticTestIds - - websiteIds + - apdexIds + - applicationIds + - businessPerspectiveIds + - infraDfqFilter + - kubernetesClusterUUIDs + - kubernetesNamespaceUIDs + - mobileAppIds + - permissions + - sloIds + - syntheticCredentialKeys + - syntheticTestIds + - websiteIds ApiRestrictedApplicationFilter: type: object properties: @@ -30029,14 +30996,14 @@ components: scope: type: string enum: - - INCLUDE_NO_DOWNSTREAM - - INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING - - INCLUDE_ALL_DOWNSTREAM + - INCLUDE_NO_DOWNSTREAM + - INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING + - INCLUDE_ALL_DOWNSTREAM tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' required: - - label - - scope + - label + - scope ApiRole: type: object properties: @@ -30061,10 +31028,10 @@ components: type: string uniqueItems: true required: - - id - - members - - name - - permissions + - id + - members + - name + - permissions ApiTag: type: object properties: @@ -30077,8 +31044,8 @@ components: maxLength: 64 minLength: 0 required: - - displayName - - id + - displayName + - id ApiTeam: type: object properties: @@ -30100,7 +31067,7 @@ components: maxLength: 256 minLength: 0 required: - - tag + - tag ApiTeamInfo: type: object properties: @@ -30123,7 +31090,7 @@ components: userId: type: string required: - - userId + - userId ApiTeamRole: type: object properties: @@ -30134,7 +31101,7 @@ components: viaIdP: type: boolean required: - - roleId + - roleId ApiTeamScope: type: object properties: @@ -30143,32 +31110,32 @@ components: 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_LOGGING_PERSPECTIVES_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 + - 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_LOGGING_PERSPECTIVES_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 uniqueItems: true actionFilter: type: string @@ -30274,6 +31241,8 @@ components: type: boolean canConfigureDatabaseManagement: type: boolean + canConfigureEntityPayloadTransformationRules: + type: boolean canConfigureEumApplications: type: boolean canConfigureEventsAndAlerts: @@ -30370,6 +31339,8 @@ components: type: boolean canManuallyCloseIssue: type: boolean + canPlaybackSessionReplay: + type: boolean canRunAutomationActions: type: boolean canUseSyntheticCredentials: @@ -30474,39 +31445,41 @@ components: type: string minLength: 1 required: - - accessGrantingToken - - internalId - - name + - accessGrantingToken + - internalId + - name AppDataMetricConfiguration: type: object properties: aggregation: type: string - description: 'Set aggregation that can be applied to a series of values. - Eg: `MEAN`.' + 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 + - 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' + description: >- + If the granularity is set you will get data points with the + specified granularity in seconds. Default: `1000` milliseconds nullable: true metric: type: string @@ -30515,8 +31488,8 @@ components: numeratorTagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' required: - - aggregation - - metric + - aggregation + - metric Application: type: object description: Returns a list of Application Perspectives. @@ -30526,48 +31499,45 @@ components: description: Here, `ALL` Application Boundary Scope is considered. minLength: 1 businessCriticality: - type: string - description: Business criticality level of the application - enum: - - NOT_DEFINED - - LOWEST - - LOW - - MEDIUM - - HIGH - - HIGHEST + type: integer + format: int32 + description: Represent how critical an application is to their business. entityType: type: string - description: Since, this is an Application Perspective, it will be of type + description: >- + Since, this is an Application Perspective, it will be of type `APPLICATION`. enum: - - APPLICATION - - SERVICE - - ENDPOINT + - APPLICATION + - SERVICE + - ENDPOINT id: type: string - description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.' + 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 - - label + - 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. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -30589,29 +31559,33 @@ components: 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 + 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 + 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 + - ALL + - INBOUND customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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 + 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 @@ -30620,46 +31594,53 @@ components: 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. + 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 + - 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 + 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. nullable: true 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. + 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 + - 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. + 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. ' + 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 + 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 @@ -30667,10 +31648,11 @@ components: $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. + 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 @@ -30680,7 +31662,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). maximum: 10 minimum: 5 @@ -30699,32 +31682,33 @@ components: $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 + 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. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -30742,25 +31726,28 @@ components: applicationId: type: string deprecated: true - description: ID of the application that this Smart Alert configuration is - applied to. + 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 + 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 + 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 + - ALL + - INBOUND created: type: integer format: int64 @@ -30768,16 +31755,18 @@ components: minimum: 1 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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 + 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 @@ -30786,34 +31775,37 @@ components: 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. + 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 + - 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 + 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. nullable: true 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. + 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 + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 id: type: string description: 'ID of this Application App Alert Config. ' @@ -30821,12 +31813,15 @@ components: 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. + 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. ' + 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 @@ -30834,23 +31829,26 @@ components: 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 + 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. + 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. + 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 @@ -30860,7 +31858,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). maximum: 10 minimum: 5 @@ -30879,20 +31878,21 @@ components: $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 + 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: @@ -30909,64 +31909,66 @@ components: 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 + - 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 minLength: 1 required: - - alertType - - metricName + - 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 - minLength: 1 - 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 + - $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 + minLength: 1 + 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: @@ -30980,29 +31982,35 @@ components: 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. + 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. + - **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`. - **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`. + 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 + - ALL + - INBOUND + - DEFAULT businessCriticality: - type: string - description: Business criticality level of the application - enum: - - NOT_DEFINED - - LOWEST - - LOW - - MEDIUM - - HIGH - - HIGHEST - nullable: true + type: integer + format: int32 + description: Business criticality of an application (0-5) + maximum: 5 + minimum: 0 createdAt: type: integer format: int64 @@ -31010,7 +32018,9 @@ components: type: string id: type: string - description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.' + description: >- + Unique ID of the Application Perspective. Eg: + `Av62RoIKQv-A3n6DbMQh9g`. maxLength: 128 minLength: 1 label: @@ -31027,39 +32037,53 @@ components: type: string scope: type: string - description: | - **INCLUDE_NO_DOWNSTREAM** : Only the selected services from the filters are included (call this the core set). + 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. + **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 + - INCLUDE_NO_DOWNSTREAM + - INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING + - INCLUDE_ALL_DOWNSTREAM tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' required: - - accessRules - - boundaryScope - - businessCriticality - - id - - label - - scope + - accessRules + - boundaryScope + - id + - label + - scope ApplicationEventResult: type: object allOf: - - $ref: '#/components/schemas/EventResult' - - type: object - properties: - applicationId: - type: string - description: ID of the application. + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + applicationId: + type: string + description: ID of the application. ApplicationItem: type: object properties: @@ -31074,8 +32098,8 @@ components: items: type: number required: - - application - - metrics + - application + - metrics ApplicationMetricResult: type: object properties: @@ -31099,11 +32123,12 @@ components: format: int64 minimum: 0 required: - - items + - 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 + 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: @@ -31117,8 +32142,8 @@ components: additionalProperties: $ref: '#/components/schemas/ServiceNode' required: - - applicationId - - services + - applicationId + - services ApplicationResult: type: object properties: @@ -31130,8 +32155,9 @@ components: page: type: integer format: int32 - description: Page number you want to retrieve in a request / retrieved in - a response. + description: >- + Page number you want to retrieve in a request / retrieved in a + response. pageSize: type: integer format: int32 @@ -31139,8 +32165,9 @@ components: totalHits: type: integer format: int32 - description: 'The number of results returned. For eg: If `items` has 5 elements, - `totalhits` will be 5' + 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. @@ -31151,92 +32178,99 @@ components: maxLength: 256 minLength: 0 required: - - name + - 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`.' + description: >- + Unique ID of the Application Perspective. Eg: + `Av62RoIKQv-A3n6DbMQh9g`. minLength: 1 name: type: string description: 'Name of the Application Perspective. Eg: `app1`.' nullable: true required: - - id + - 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 - nullable: true - endpointId: - type: string - description: Specifies the ID of the Endpoint to be monitored by the application - SLO - nullable: true - serviceId: - type: string - description: Identifies the service to be monitored by the application - SLO - nullable: true + - $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 + nullable: true + endpointId: + type: string + description: >- + Specifies the ID of the Endpoint to be monitored by the + application SLO + nullable: true + serviceId: + type: string + description: Identifies the service to be monitored by the application SLO + nullable: true required: - - boundaryScope + - boundaryScope ApplicationSloEntity: type: object allOf: - - $ref: '#/components/schemas/SloEntity' - - type: object - properties: - applicationId: - type: string - description: The ID of the Application - minLength: 1 - boundaryScope: - type: string - description: The Boundary Scope of the Application - enum: - - ALL - - INBOUND - endpointId: - type: string - description: The Endpoint ID of the Application - nullable: true - 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 - nullable: true + - $ref: '#/components/schemas/SloEntity' + - type: object + properties: + applicationId: + type: string + description: The ID of the Application + minLength: 1 + boundaryScope: + type: string + description: The Boundary Scope of the Application + enum: + - ALL + - INBOUND + endpointId: + type: string + description: The Endpoint ID of the Application + nullable: true + 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 + nullable: true required: - - applicationId - - boundaryScope - - includeInternal - - includeSynthetic + - applicationId + - boundaryScope + - includeInternal + - includeSynthetic ApplicationTimeThreshold: type: object - description: The type of threshold to define the criteria when the event and - alert triggers and resolves. + description: >- + The type of threshold to define the criteria when the event and alert + triggers and resolves. discriminator: mapping: requestImpact: '#/components/schemas/TraceImpactApplicationTimeThreshold' @@ -31250,7 +32284,7 @@ components: type: type: string required: - - type + - type AuditLogUiResponse: type: object properties: @@ -31270,86 +32304,94 @@ components: type: type: string enum: - - API - - USER - - INSTANA - - UNKNOWN + - API + - USER + - INSTANA + - UNKNOWN AvailabilityBlueprintIndicator: type: object allOf: - - $ref: '#/components/schemas/ServiceLevelIndicator' - - type: object - properties: - metric: - $ref: '#/components/schemas/EntityMetric' - threshold: - type: number - format: double - description: Threshold Value for the Blueprint - exclusiveMinimum: false - minimum: 0.0 + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + properties: + metric: + $ref: '#/components/schemas/EntityMetric' + threshold: + type: number + format: double + description: Threshold Value for the Blueprint + exclusiveMinimum: false + minimum: 0 required: - - type + - 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 - nullable: true - 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 - nullable: true - endpointId: - type: string - description: Specifies the ID of the Endpoint to be monitored by the availability-based - application SLO - nullable: true - 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 - nullable: true - 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 - nullable: true + - $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 + nullable: true + 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 + nullable: true + endpointId: + type: string + description: >- + Specifies the ID of the Endpoint to be monitored by the + availability-based application SLO + nullable: true + 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 + nullable: true + 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 + nullable: true required: - - boundaryScope + - boundaryScope AvailableMetrics: type: object properties: @@ -31371,150 +32413,151 @@ components: properties: traceId: type: string - description: 'The corresponding trace ID. For eg: `07eaf10c1d051234` or - `000000000000000007eaf10c1d051234`' + description: >- + The corresponding trace ID. For eg: `07eaf10c1d051234` or + `000000000000000007eaf10c1d051234` required: - - traceId + - traceId BidirectionalMsTeamsAppIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - 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: - - apiTokenId - - channelId - - channelName - - id - - instanaUrl - - kind - - name - - teamId - - tenantId + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + 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: + - 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 + - $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 + - 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 + - $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 - github: - $ref: '#/components/schemas/GitHubConfiguration' - recordVideo: - type: boolean - script: - type: string - maxLength: 1048576 - minLength: 0 - scriptType: - type: string - enum: - - Basic - - Jest - scripts: - $ref: '#/components/schemas/MultipleScriptsConfiguration' - required: - - markSyntheticCall - - syntheticType + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + browser: + type: string + enum: + - chrome + - firefox + fileName: + type: string + github: + $ref: '#/components/schemas/GitHubConfiguration' + 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 - github: - $ref: '#/components/schemas/GitHubConfiguration' - recordVideo: - type: boolean - script: - type: string - scriptType: - type: string - enum: - - Basic - - Jest - scripts: - $ref: '#/components/schemas/MultipleScriptsConfiguration' + - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - type: object + properties: + browser: + type: string + enum: + - chrome + - firefox + fileName: + type: string + github: + $ref: '#/components/schemas/GitHubConfiguration' + recordVideo: + type: boolean + script: + type: string + scriptType: + type: string + enum: + - Basic + - Jest + scripts: + $ref: '#/components/schemas/MultipleScriptsConfiguration' BuiltInEventSpecification: type: object properties: @@ -31569,11 +32612,11 @@ components: type: boolean description: Flag to show whether the Built-in Event Specification is triggering required: - - hyperParams - - id - - name - - ruleInputs - - shortPluginId + - hyperParams + - id + - name + - ruleInputs + - shortPluginId BuiltInEventSpecificationWithLastUpdated: type: object properties: @@ -31632,11 +32675,11 @@ components: type: boolean description: Flag to show whether the Built-in Event Specification is triggering required: - - hyperParams - - id - - name - - ruleInputs - - shortPluginId + - hyperParams + - id + - name + - ruleInputs + - shortPluginId BulkAlertConfigRequest: type: object properties: @@ -31648,14 +32691,13 @@ components: type: string uniqueItems: true required: - - configs + - configs BusinessActivity: type: object properties: activityId: type: string - description: Unique identifier for the activity generated by the source - BPM tool + description: Unique identifier for the activity generated by the source BPM tool example: ApproveInvoiceTask nullable: true activityName: @@ -31698,7 +32740,7 @@ components: example: 486cbb3b-e633-11ee-8707-0242ac110002 nullable: true required: - - activityType + - activityType BusinessPerspectiveConfig: type: object properties: @@ -31717,12 +32759,15 @@ components: tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' required: - - id + - 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. + 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' @@ -31730,26 +32775,44 @@ components: type: object additionalProperties: type: array - description: | + 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]`. + + 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: | + 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]`. + + 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: | + 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: | + + 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]`. + + 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. @@ -31760,9 +32823,9 @@ components: description: Earliest timestamp of the call from the group minimum: 0 required: - - cursor - - metrics - - name + - cursor + - metrics + - name CallGroupsResult: type: object properties: @@ -31770,13 +32833,17 @@ components: $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. + 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. + 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: @@ -31787,20 +32854,24 @@ components: totalRepresentedItemCount: type: integer format: int64 - description: For calls and EUM beacons, one row can represent multiple real - items (batched call, sample multiplicity) + 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. + 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 + - items CallRelation: type: object - description: It shows from where the call is destined to. It includes destination + 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: @@ -31822,23 +32893,29 @@ components: changeType: type: string enum: - - CREATE - - UPDATE - - DELETE - - ENABLE - - DISABLE - - RESTORE - - UNKNOWN - required: - - author - - changeType + - CREATE + - UPDATE + - DELETE + - ENABLE + - DISABLE + - RESTORE + - UNKNOWN + required: + - author + - changeType CloudfoundryPhysicalContext: type: object - description: | - Contains physical context of Cloudfoundry. It contains the following information: + 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. + + 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. nullable: true properties: @@ -31846,8 +32923,9 @@ components: $ref: '#/components/schemas/SnapshotPreview' cfInstanceIndex: type: string - description: A unique ID of the container created and managed by Garden - in the Cloud Foundry environment. + description: >- + A unique ID of the container created and managed by Garden in the + Cloud Foundry environment. nullable: true organization: $ref: '#/components/schemas/SnapshotPreview' @@ -31855,13 +32933,15 @@ components: $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. + 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. + description: >- + Dynamic Focus Query string that selects a list of entities on which + the policy is run. ConfigVersion: type: object properties: @@ -31886,7 +32966,7 @@ components: maxLength: 64 minLength: 0 required: - - id + - id ContainerNode: type: object Correction: @@ -31949,11 +33029,13 @@ components: $ref: '#/components/schemas/CorrectionScheduling' sloIds: type: array - description: This is the list of SLO configurations related to this Correction + 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 + description: >- + This is the list of SLO configurations related to this Correction Window. minLength: 1 maxItems: 1024 @@ -31967,8 +33049,8 @@ components: description: List of tags associated with SLO Correction Window Configuration uniqueItems: true required: - - name - - scheduling + - name + - scheduling CorrectionScheduling: type: object description: Time scheduling of the SLO Correction Window configurations. @@ -31976,36 +33058,40 @@ components: duration: type: integer format: int32 - description: Duration of the correction window, defined by the count of - time units. + 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 - - calendar_month + - millisecond + - second + - minute + - hour + - day + - week + - calendar_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' + 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 + description: >- + Start time of the correction window in milliseconds since epoch (UTC) (e.g., `1706713140000`). required: - - duration - - durationUnit + - duration + - durationUnit CorrectionWindow: type: object description: List of Correction Windows @@ -32035,9 +33121,9 @@ components: CrashMobileAppAlertRule: type: object allOf: - - $ref: '#/components/schemas/MobileAppAlertRule' + - $ref: '#/components/schemas/MobileAppAlertRule' required: - - metricName + - metricName CreateEvaluationRequest: type: object properties: @@ -32098,8 +33184,8 @@ components: items: type: string required: - - evaluation_name - - evaluator_ids + - evaluation_name + - evaluator_ids CreateEvaluationResponse: type: object properties: @@ -32123,82 +33209,112 @@ components: items: type: number required: - - cursor + - cursor CursorPagination: type: object - description: | + 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. + + 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. + 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`. + + For example, `Thursday, 5 September 2024 07:03:13 GMT` can be + represented as `1725519793`. offset: type: integer format: int32 - description: | + 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. + + 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: | + 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`. + + 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 CursorPaginationWithUiCursorInfraExploreCursor: type: object - description: | + 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. + + 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. + 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`. + + For example, `Thursday, 5 September 2024 07:03:13 GMT` can be + represented as `1725519793`. offset: type: integer format: int32 - description: | + 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. + + 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: | + 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`. + + 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: - - $ref: '#/components/schemas/ServiceLevelIndicator' - - type: object - properties: - badEventInfraMetric: - type: string - badEventsFilter: - $ref: '#/components/schemas/TagFilterExpressionElement' - goodEventInfraMetric: - type: string - goodEventsFilter: - $ref: '#/components/schemas/TagFilterExpressionElement' + - $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 + - goodEventsFilter + - type CustomDashboard: type: object properties: @@ -32221,9 +33337,9 @@ components: minItems: 0 uniqueItems: true required: - - accessRules - - title - - widgets + - accessRules + - title + - widgets CustomDashboardPreview: type: object properties: @@ -32232,8 +33348,8 @@ components: items: type: string enum: - - SHARED - - WRITABLE + - SHARED + - WRITABLE maxItems: 8 minItems: 0 uniqueItems: true @@ -32248,10 +33364,10 @@ components: type: string minLength: 1 required: - - annotations - - id - - ownerId - - title + - annotations + - id + - ownerId + - title CustomDashboardWithUserSpecificInformation: type: object properties: @@ -32278,37 +33394,40 @@ components: writable: type: boolean required: - - accessRules - - ownerId - - title - - widgets - - writable + - accessRules + - ownerId + - title + - widgets + - writable CustomDependency: type: object properties: direction: type: string enum: - - outgoing - - incoming + - 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 + 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 nullable: true identifiers: type: array - description: Will take the identifiers values for building the key of the + 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. + description: >- + Will take the identifiers values for building the key of the + dependency. maxItems: 512 minItems: 0 name: @@ -32317,21 +33436,23 @@ components: minLength: 1 separator: type: string - description: Separator between identifiers for building the key of the dependency. + description: >- + Separator between identifiers for building the key of the + dependency. nullable: true type: type: string enum: - - in - - is - - to - - of - - connected - - describes - - of20 - - to20 - - dummy - - parent + - in + - is + - to + - of + - connected + - describes + - of20 + - to20 + - dummy + - parent maxLength: 8 minLength: 1 CustomEmailSubjectPrefix: @@ -32341,12 +33462,15 @@ components: 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 + 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 @@ -32354,23 +33478,28 @@ components: type: object additionalProperties: type: string - description: A map containing the open and close email subject value of - a given change event + 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 + 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 + 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 @@ -32378,12 +33507,15 @@ components: 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 + 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 @@ -32427,9 +33559,9 @@ components: nullable: true uniqueItems: true required: - - identifiers - - label - - tagFilterExpression + - identifiers + - label + - tagFilterExpression CustomEntityWithMetadata: type: object properties: @@ -32444,25 +33576,25 @@ components: version: type: string required: - - data - - id + - data + - id CustomEventMobileAppAlertRule: type: object allOf: - - $ref: '#/components/schemas/MobileAppAlertRule' - - type: object - properties: - customEventName: - type: string - minLength: 1 - metricName: - type: string - minLength: 1 - nullable: true + - $ref: '#/components/schemas/MobileAppAlertRule' + - type: object + properties: + customEventName: + type: string + minLength: 1 + metricName: + type: string + minLength: 1 + nullable: true required: - - aggregation - - customEventName - - metricName + - aggregation + - customEventName + - metricName CustomEventSpecification: type: object properties: @@ -32495,8 +33627,8 @@ components: type: string description: Set AND / OR enum: - - AND - - OR + - AND + - OR nullable: true rules: type: array @@ -32517,9 +33649,9 @@ components: triggering: type: boolean required: - - entityType - - name - - rules + - entityType + - name + - rules CustomEventSpecificationWithLastUpdated: type: object properties: @@ -32574,8 +33706,8 @@ components: type: string description: Set AND / OR enum: - - AND - - OR + - AND + - OR nullable: true rules: type: array @@ -32596,27 +33728,27 @@ components: triggering: type: boolean required: - - entityType - - id - - name - - rules + - entityType + - id + - name + - rules CustomEventWebsiteAlertRule: type: object allOf: - - $ref: '#/components/schemas/WebsiteAlertRule' - - type: object - properties: - customEventName: - type: string - minLength: 1 - metricName: - type: string - minLength: 1 - nullable: true + - $ref: '#/components/schemas/WebsiteAlertRule' + - type: object + properties: + customEventName: + type: string + minLength: 1 + metricName: + type: string + minLength: 1 + nullable: true required: - - aggregation - - customEventName - - metricName + - aggregation + - customEventName + - metricName CustomMetric: type: object properties: @@ -32624,8 +33756,8 @@ components: type: string description: Aggregation to apply on the metric for every member. enum: - - MEAN - - SUM + - MEAN + - SUM category: type: string description: Category of the metric in the catalog @@ -32634,41 +33766,60 @@ components: description: Description to be used in the catalog formatter: type: string - description: | + 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 + + * 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 + - 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 @@ -32679,44 +33830,45 @@ components: 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 - - MSSQL - - OTHERS - - POSTGRESQL - - REDIS - - SAP - - SELF_MONITORING - - SOLR - - SPARK - - TIBCOBW - - TUXEDO - - VSHPERE - - WEBSPHERE - - CUSTOM_ENTITY + - 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 + - ORACLE_DB + - OTHERS + - POSTGRESQL + - REDIS + - SAP + - SELF_MONITORING + - SOLR + - SPARK + - TIBCOBW + - TUXEDO + - VSHPERE + - WEBSPHERE + - CUSTOM_ENTITY nullable: true source: type: string @@ -32725,21 +33877,21 @@ components: type: string description: Type of entity for the source metric required: - - aggregation - - source + - aggregation + - source CustomMetricApplicationAlertRule: type: object allOf: - - $ref: '#/components/schemas/ApplicationAlertRule' - - type: object - properties: - metricKey: - type: string - minLength: 1 + - $ref: '#/components/schemas/ApplicationAlertRule' + - type: object + properties: + metricKey: + type: string + minLength: 1 required: - - aggregation - - metricKey - - metricName + - aggregation + - metricKey + - metricName CustomPayloadConfiguration: type: object properties: @@ -32751,10 +33903,11 @@ components: maxItems: 20 minItems: 0 required: - - fields + - fields CustomPayloadField: type: object - description: Custom payload fields to send additional information in the alert + description: >- + Custom payload fields to send additional information in the alert notifications. Can be left empty. discriminator: mapping: @@ -32765,14 +33918,15 @@ components: properties: key: type: string - description: A user-specified unique identifier or name for a custom payload + description: >- + A user-specified unique identifier or name for a custom payload entry. minLength: 1 type: type: string required: - - key - - type + - key + - type CustomPayloadWithLastUpdated: type: object properties: @@ -32786,12 +33940,13 @@ components: lastUpdated: type: integer format: int64 - description: Unix timestamp representing the time (in milliseconds) the + description: >- + Unix timestamp representing the time (in milliseconds) the configuration was last updated. minimum: 1 readOnly: true required: - - fields + - fields CustomPayloadWithVersion: type: object properties: @@ -32805,7 +33960,8 @@ components: lastUpdated: type: integer format: int64 - description: Unix timestamp representing the time (in milliseconds) the + description: >- + Unix timestamp representing the time (in milliseconds) the configuration was last updated. minimum: 1 readOnly: true @@ -32814,8 +33970,8 @@ components: format: int32 description: Global custom payloads version. required: - - fields - - version + - fields + - version CustomTag: type: object properties: @@ -32823,9 +33979,9 @@ components: type: string description: Aggregation to apply on the tag for every member. enum: - - FIRST - - UNIQUE - - LIST + - FIRST + - UNIQUE + - LIST category: type: string description: Category of the tag in the catalog @@ -32837,51 +33993,53 @@ components: 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. + description: >- + Name of the tag. Will use the same value as the source tag if not + specified. nullable: true 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 + - 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 + - ORACLE_DB + - OTHERS + - POSTGRESQL + - REDIS + - SAP + - SELF_MONITORING + - SOLR + - SPARK + - TIBCOBW + - TUXEDO + - VSHPERE + - WEBSPHERE + - CUSTOM_ENTITY source: type: string description: Name of the source tag @@ -32899,92 +34057,93 @@ components: 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 + - $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 + - $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: @@ -32993,53 +34152,53 @@ components: operator: type: string enum: - - CONTAINS - - EQUALS - - GREATER_THAN - - GREATER_THAN_OR_EQUALS - - IS - - LESS_THAN - - LESS_THAN_OR_EQUALS - - MATCHES - - NOT_MATCHES + - 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 + - key + - operator + - value DNSFilterTargetValue: type: object properties: key: type: string enum: - - ALL - - ALL_CONDITIONS - - ANY - - A - - AAAA - - CNAME - - NS + - ALL + - ALL_CONDITIONS + - ANY + - A + - AAAA + - CNAME + - NS operator: type: string enum: - - CONTAINS - - EQUALS - - GREATER_THAN - - GREATER_THAN_OR_EQUALS - - IS - - LESS_THAN - - LESS_THAN_OR_EQUALS - - MATCHES - - NOT_MATCHES + - CONTAINS + - EQUALS + - GREATER_THAN + - GREATER_THAN_OR_EQUALS + - IS + - LESS_THAN + - LESS_THAN_OR_EQUALS + - MATCHES + - NOT_MATCHES value: type: string required: - - key - - operator - - value + - key + - operator + - value DashboardApiToken: type: object properties: @@ -33050,8 +34209,8 @@ components: type: string minLength: 1 required: - - id - - name + - id + - name DatabaseIntegration: type: object properties: @@ -33065,40 +34224,40 @@ components: entity: type: string enum: - - NOT_APPLICABLE - - DESTINATION - - SOURCE + - NOT_APPLICABLE + - DESTINATION + - SOURCE name: type: string minLength: 1 operator: type: string enum: - - EQUALS - - CONTAINS - - IN - - NOT_IN - - 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 + - EQUALS + - CONTAINS + - IN + - NOT_IN + - 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 + - name + - operator + - value Duration: type: object properties: @@ -33109,38 +34268,40 @@ components: unit: type: string enum: - - MINUTES - - HOURS - - DAYS + - MINUTES + - HOURS + - DAYS required: - - amount - - unit + - amount + - unit DynamicField: type: object allOf: - - $ref: '#/components/schemas/CustomPayloadField' - - type: object - properties: - value: - $ref: '#/components/schemas/DynamicFieldValue' - required: - - key - - value + - $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.' + description: >- + Key for selected dynamic tag: specifies which dictionary style value + user is interested in. nullable: true tagName: type: string - description: Each dynamic payload entry is associated with tag from Instana's - tag catalog + description: >- + Each dynamic payload entry is associated with tag from Instana's tag + catalog minLength: 1 required: - - tagName + - tagName DynamicParameter: type: object description: List of dynamic parameters @@ -33195,7 +34356,7 @@ components: type: string description: Type of the tag required: - - prefix + - prefix EditUser: type: object properties: @@ -33203,35 +34364,35 @@ components: type: string minLength: 1 required: - - fullName + - fullName EmailIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - customEmailSubjectPrefix: - $ref: '#/components/schemas/CustomEmailSubjectPrefix' - emails: - type: array - items: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + customEmailSubjectPrefix: + $ref: '#/components/schemas/CustomEmailSubjectPrefix' + emails: + type: array + items: + type: string + minLength: 1 + minItems: 1 + transformationExpression: type: string - minLength: 1 - minItems: 1 - transformationExpression: - type: string required: - - emails - - id - - kind - - name + - emails + - id + - kind + - name EmptyConfiguration: type: object allOf: - - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - $ref: '#/components/schemas/SyntheticTypeConfiguration' required: - - markSyntheticCall - - syntheticType + - markSyntheticCall + - syntheticType Endpoint: type: object properties: @@ -33239,9 +34400,9 @@ components: type: string description: Since, this is a Endpoint, it will be of type `ENDPOINT`. enum: - - APPLICATION - - SERVICE - - ENDPOINT + - APPLICATION + - SERVICE + - ENDPOINT id: type: string description: 'Unique ID of the Endpoint. Eg: `NCRq5oYnan5x-PkdTPQwLLUdu5M`.' @@ -33262,9 +34423,9 @@ components: syntheticType: type: string enum: - - NON_SYNTHETIC - - SYNTHETIC - - MIXED + - NON_SYNTHETIC + - SYNTHETIC + - MIXED technologies: type: array description: 'List of technologies: `Eg:["springbootApplicationContainer"]`' @@ -33276,96 +34437,134 @@ components: type: string description: The type of the Endpoint. enum: - - UNDEFINED - - RPC - - EVENT - - GRAPHQL - - BATCH - - SHELL - - HTTP - - SDK - - OPENTELEMETRY - - INTERNAL - - RPG - - DATABASE - - MESSAGING - - PAGE - - PAGE_RESOURCE - required: - - id - - label - - serviceId - - technologies - - type + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - RPG + - 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" + description: > + This represents case sensitivity of endpoints of a service. + + Let's say in a service there are three endpoints, `user`, `Order` + and `PAYMENT`: + + + For example, if `endpointCase` is `UPPER`, then endpoint names are + converted to `USER`, `ORDER` and `PAYMENT`. + + + If `endpointCase` is `LOWER`, then endpoint names are converted to + `user`, `order` and `payment`. + + + If `endpointCase` is `ORIGINAL`, then endpoint names are converted + to `user`, `Order` and `PAYMENT`. enum: - - ORIGINAL - - LOWER - - UPPER + - ORIGINAL + - LOWER + - UPPER endpointNameByCollectedPathTemplateRuleEnabled: type: boolean - description: | - The highest default precedence of endpoint rule is creating endpoint is based on path template. For example, + 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. + + 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`. + 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. + 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. + 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. minLength: 1 required: - - endpointCase - - serviceId + - 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. + - $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: @@ -33380,8 +34579,8 @@ components: items: type: number required: - - endpoint - - metrics + - endpoint + - metrics EndpointMetricResult: type: object properties: @@ -33405,7 +34604,7 @@ components: format: int64 minimum: 0 required: - - items + - items EndpointNode: type: object properties: @@ -33416,7 +34615,7 @@ components: inclusive: type: boolean required: - - endpointId + - endpointId EndpointResult: type: object properties: @@ -33427,8 +34626,9 @@ components: page: type: integer format: int32 - description: Page number you want to retrieve in a request / retrieved in - a response. + description: >- + Page number you want to retrieve in a request / retrieved in a + response. pageSize: type: integer format: int32 @@ -33436,8 +34636,9 @@ components: totalHits: type: integer format: int32 - description: 'The number of results returned. For eg: If `items` has 5 elements, - `totalhits` will be 5' + 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. @@ -33452,80 +34653,80 @@ components: type: string description: The type of the Endpoint. enum: - - UNDEFINED - - RPC - - EVENT - - GRAPHQL - - BATCH - - SHELL - - HTTP - - SDK - - OPENTELEMETRY - - INTERNAL - - RPG - - DATABASE - - MESSAGING - - PAGE - - PAGE_RESOURCE + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - RPG + - 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 + - $ref: '#/components/schemas/AbstractRule' + - type: object + properties: + conditionOperator: + type: string + enum: + - '>' + - '>=' + - < + - <= + - '=' + - '!=' + conditionValue: + type: number + format: double required: - - conditionOperator + - conditionOperator EntityCountVerificationRule: type: object allOf: - - $ref: '#/components/schemas/AbstractRule' - - type: object - properties: - conditionOperator: - type: string - enum: - - '>' - - '>=' - - < - - <= - - = - - '!=' - conditionValue: - type: number - format: double - minimum: 0 - 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 + - $ref: '#/components/schemas/AbstractRule' + - type: object + properties: + conditionOperator: + type: string + enum: + - '>' + - '>=' + - < + - <= + - '=' + - '!=' + conditionValue: + type: number + format: double + minimum: 0 + 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: @@ -33540,7 +34741,7 @@ components: $ref: '#/components/schemas/Event' uniqueItems: true required: - - openIssues + - openIssues EntityId: type: object properties: @@ -33555,9 +34756,9 @@ components: description: Steady identifier for the entity. nullable: true required: - - host - - pluginId - - steadyId + - host + - pluginId + - steadyId EntityMetric: type: object properties: @@ -33567,7 +34768,7 @@ components: scope: $ref: '#/components/schemas/EntityMetricScope' required: - - name + - name EntityMetricScope: type: object properties: @@ -33575,67 +34776,69 @@ components: $ref: '#/components/schemas/TagFilterExpressionElement' type: type: string - description: Type of the Entity Metric. Eg. For Mobile App SLO it would - be any of the supported beaconTypes + description: >- + Type of the Entity Metric. Eg. For Mobile App SLO it would be any of + the supported beaconTypes required: - - type + - type 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 + - $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 + - $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' - - type: object - properties: - metricName: - type: string - minLength: 1 - nullable: true + - $ref: '#/components/schemas/ApplicationAlertRule' + - type: object + properties: + metricName: + type: string + minLength: 1 + nullable: true required: - - metricName + - metricName EvaluationDetailResponse: type: object description: Detailed evaluation information @@ -33836,9 +35039,9 @@ components: threshold: type: number required: - - criteria - - evaluatorName - - threshold + - criteria + - evaluatorName + - threshold Event: type: object properties: @@ -33863,14 +35066,14 @@ components: entityType: type: string enum: - - Entity10 - - App20 - - Service20 - - Endpoint20 - - Website - - Synthetic - - MobileApp - - Log + - Entity10 + - App20 + - Service20 + - Endpoint20 + - Website + - Synthetic + - MobileApp + - Log eventConfigurationType: type: string id: @@ -33922,16 +35125,17 @@ components: maxLength: 64 minLength: 0 required: - - entityId - - id - - plugin - - state - - type + - 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. + 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 @@ -33947,15 +35151,15 @@ components: items: type: string enum: - - incident - - critical - - warning - - change - - online - - offline - - agent_monitoring_issue - - cve_issue - - none + - incident + - critical + - warning + - change + - online + - offline + - agent_monitoring_issue + - cve_issue + - none maxItems: 1024 minItems: 0 nullable: true @@ -34035,24 +35239,29 @@ components: 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. + 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" + 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 + 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" + description: >- + List of related recent events. Only present in case of "Incident" type events. severity: type: integer @@ -34107,13 +35316,13 @@ components: type: type: string enum: - - BUILT_IN - - CUSTOM + - BUILT_IN + - CUSTOM required: - - entityType - - id - - name - - type + - entityType + - id + - name + - type ExtendedService: type: object description: List of services in the topology. @@ -34127,12 +35336,14 @@ components: type: string description: Since, this is a Service, it will be of type `SERVICE`. enum: - - APPLICATION - - SERVICE - - ENDPOINT + - APPLICATION + - SERVICE + - ENDPOINT id: type: string - description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.' + description: >- + Unique ID of the Service. Eg: + `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. minLength: 1 label: type: string @@ -34163,42 +35374,44 @@ components: 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.' + 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.' + 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 - - RPG - - DATABASE - - MESSAGING - - PAGE - - PAGE_RESOURCE + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - RPG + - DATABASE + - MESSAGING + - PAGE + - PAGE_RESOURCE uniqueItems: true required: - - applications - - id - - label - - snapshotIds - - technologies - - types + - applications + - id + - label + - snapshotIds + - technologies + - types FailureSyntheticAlertRule: type: object allOf: - - $ref: '#/components/schemas/SyntheticAlertRule' + - $ref: '#/components/schemas/SyntheticAlertRule' required: - - metricName + - metricName Field: type: object description: List of fields that describe an action. @@ -34217,9 +35430,9 @@ components: type: string minLength: 1 required: - - encoding - - name - - value + - encoding + - name + - value FilterInterface: type: object properties: @@ -34230,31 +35443,32 @@ components: 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. - minLength: 1 + - $ref: '#/components/schemas/HttpPathSegmentMatchingRule' + - type: object + properties: + name: + type: string + description: > + Given `/api/{version}/users` URI, `FIXED` names are `api` and + `users` in order. + minLength: 1 required: - - name - - type + - 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 + - $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 + - duration + - durationUnit + - startTimestamp GatewayStatusResponse: type: object description: Gateway status for evaluation capability @@ -34277,35 +35491,35 @@ components: GenericInfraAlertRule: type: object allOf: - - $ref: '#/components/schemas/InfraAlertRule' - - type: object - properties: - entityType: - type: string - minLength: 1 - metricGroupBy: - type: array - items: + - $ref: '#/components/schemas/InfraAlertRule' + - type: object + properties: + entityType: type: string - maxItems: 1 - minItems: 0 - required: - - aggregation - - crossSeriesAggregation - - entityType - - metricGroupBy - - metricName - - metricTagFilterExpression + minLength: 1 + 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 + - NO_REMOVAL + - REMOVE_COORDINATES + - REMOVE_CITY + - REMOVE_ALL geoMappingRules: type: array items: @@ -34313,7 +35527,7 @@ components: maxItems: 512 minItems: 0 required: - - geoDetailRemoval + - geoDetailRemoval GeoMappingRule: type: object properties: @@ -34355,8 +35569,8 @@ components: maxItems: 8 minItems: 0 required: - - cidr - - subdivisions + - cidr + - subdivisions GeoSubdivision: type: object properties: @@ -34369,7 +35583,7 @@ components: maxLength: 256 minLength: 0 required: - - name + - name GetActionBeaconsResult: type: object properties: @@ -34380,19 +35594,19 @@ components: $ref: '#/components/schemas/ActionBeacon' hasMore: type: boolean - description: Indicates whether more beacons are available beyond the current - page + description: Indicates whether more beacons are available beyond the current page example: true nextCursor: type: integer format: int64 - description: Cursor for the next page (timestamp). Use this value in the - next request to fetch more beacons. + description: >- + Cursor for the next page (timestamp). Use this value in the next + request to fetch more beacons. example: 1757340000000 nullable: true required: - - beacons - - hasMore + - beacons + - hasMore GetActivities: type: object properties: @@ -34407,9 +35621,9 @@ components: timeframe: $ref: '#/components/schemas/TimeFrame' required: - - order - - pagination - - timeFrame + - order + - pagination + - timeFrame GetApplicationMetrics: type: object properties: @@ -34428,33 +35642,48 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - metrics - - timeFrame + - 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)" + description: |- + Use when querying calls of an application: + `INBOUND`: only inbound calls + `ALL`: all the calls to that application (inbound + internal) enum: - - ALL - - INBOUND + - 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. + 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. + 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: @@ -34462,39 +35691,41 @@ components: items: type: string enum: - - UNDEFINED - - RPC - - EVENT - - GRAPHQL - - BATCH - - SHELL - - HTTP - - SDK - - OPENTELEMETRY - - INTERNAL - - RPG - - DATABASE - - MESSAGING - - PAGE - - PAGE_RESOURCE + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - RPG + - 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`.' + 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' + 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: @@ -34503,10 +35734,17 @@ components: $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. + 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: @@ -34518,13 +35756,14 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - metrics + - metrics GetAvailableMetricsQuery: type: object properties: query: type: string - description: Search term used to filter results using fields such as label, + description: >- + Search term used to filter results using fields such as label, description, tag name or keywords maxLength: 200 minLength: 0 @@ -34538,8 +35777,8 @@ components: description: Entity type. Identifier for the monitored technology. nullable: true required: - - tagFilterExpression - - timeFrame + - tagFilterExpression + - timeFrame GetAvailablePluginsQuery: type: object properties: @@ -34548,8 +35787,8 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - tagFilterExpression - - timeFrame + - tagFilterExpression + - timeFrame GetCallGroups: type: object properties: @@ -34557,19 +35796,23 @@ components: $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. + 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. + 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`.' + 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 @@ -34590,18 +35833,20 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - group - - metrics + - group + - metrics GetCombinedMetrics: type: object properties: metrics: type: array - description: Id of the exact metric you want to retrieve, eg. "cpu.user", + 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", + description: >- + Id of the exact metric you want to retrieve, eg. "cpu.user", "clientrequests.read.mean" minLength: 1 maxItems: 15 @@ -34633,8 +35878,8 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - metrics - - plugin + - metrics + - plugin GetDynamicParameterValues: type: object properties: @@ -34650,87 +35895,108 @@ components: timestamp: type: integer format: int64 - description: The start of the timestamp expressed in Unix epoch time in + description: >- + The start of the timestamp expressed in Unix epoch time in milliseconds. required: - - eventId - - parameters - - timestamp + - 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)" + description: |- + Use when querying calls of an application: + `INBOUND`: only inbound calls + `ALL`: all the calls to that application (inbound + internal) enum: - - ALL - - INBOUND + - 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. + 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. + 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. + 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 + 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 - - RPG - - DATABASE - - MESSAGING - - PAGE - - PAGE_RESOURCE + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - RPG + - 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. + 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`.' + 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.' + 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: @@ -34739,26 +36005,35 @@ components: $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. + 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 + - metrics GetInfrastructureGroupsQuery: type: object properties: groupBy: type: array - description: Entity grouping tag. Use the Instana Analyze Infrastructure + 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 + description: >- + Entity grouping tag. Use the Instana Analyze Infrastructure dashboard to determine the entity grouping tag name. maxItems: 5 minItems: 0 @@ -34786,10 +36061,10 @@ components: description: Type of entities nullable: true required: - - groupBy - - pagination - - tagFilterExpression - - timeFrame + - groupBy + - pagination + - tagFilterExpression + - timeFrame GetInfrastructureQuery: type: object properties: @@ -34822,9 +36097,9 @@ components: description: Type of entities nullable: true required: - - pagination - - tagFilterExpression - - timeFrame + - pagination + - tagFilterExpression + - timeFrame GetMetricsResult: type: object properties: @@ -34833,8 +36108,7 @@ components: writeOnly: true groups: type: array - description: ' Grouping of data under `groupbyTag`, where `groupbyTagEntity` - and `groupbyTagSecondLevelKey` are aspects of `groupbyTag`.' + description: ' Grouping of data under `groupbyTag`, where `groupbyTagEntity` and `groupbyTagSecondLevelKey` are aspects of `groupbyTag`.' items: $ref: '#/components/schemas/SyntheticMetricTagGroup' includeAggregatedTestIds: @@ -34842,11 +36116,12 @@ components: 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`.' + 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: @@ -34856,7 +36131,7 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - metrics + - metrics GetMobileAppBeaconGroups: type: object properties: @@ -34886,17 +36161,17 @@ components: type: type: string enum: - - SESSION_START - - HTTP_REQUEST - - CRASH - - CUSTOM - - VIEW_CHANGE - - DROP_BEACON - - PERF - required: - - group - - metrics - - type + - SESSION_START + - HTTP_REQUEST + - CRASH + - CUSTOM + - VIEW_CHANGE + - DROP_BEACON + - PERF + required: + - group + - metrics + - type GetMobileAppBeacons: type: object properties: @@ -34913,15 +36188,15 @@ components: type: type: string enum: - - SESSION_START - - HTTP_REQUEST - - CRASH - - CUSTOM - - VIEW_CHANGE - - DROP_BEACON - - PERF - required: - - type + - SESSION_START + - HTTP_REQUEST + - CRASH + - CUSTOM + - VIEW_CHANGE + - DROP_BEACON + - PERF + required: + - type GetMobileAppMetrics: type: object properties: @@ -34942,16 +36217,16 @@ components: type: type: string enum: - - SESSION_START - - HTTP_REQUEST - - CRASH - - CUSTOM - - VIEW_CHANGE - - DROP_BEACON - - PERF - required: - - metrics - - type + - SESSION_START + - HTTP_REQUEST + - CRASH + - CUSTOM + - VIEW_CHANGE + - DROP_BEACON + - PERF + required: + - metrics + - type GetMobileAppMetricsV2: type: object properties: @@ -34968,16 +36243,16 @@ components: type: type: string enum: - - SESSION_START - - HTTP_REQUEST - - CRASH - - CUSTOM - - VIEW_CHANGE - - DROP_BEACON - - PERF - required: - - metrics - - type + - SESSION_START + - HTTP_REQUEST + - CRASH + - CUSTOM + - VIEW_CHANGE + - DROP_BEACON + - PERF + required: + - metrics + - type GetPayloadKeysResult: type: object properties: @@ -34993,18 +36268,26 @@ components: 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)" + description: |- + Use when querying calls of an application: + `INBOUND`: only inbound calls + `ALL`: all the calls to that application (inbound + internal) enum: - - ALL - - INBOUND + - 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. + 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: @@ -35015,25 +36298,27 @@ components: - downstream is filtered on source service and groups on destination service - none is filtered on destination service and no grouping enum: - - NONE - - UPSTREAM - - DOWNSTREAM + - 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`.' + 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.' + 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: @@ -35042,21 +36327,30 @@ components: $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. + 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. + 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, + 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 @@ -35065,7 +36359,7 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - metrics + - metrics GetSessionReplayMetadataResult: type: object properties: @@ -35085,8 +36379,8 @@ components: example: 1234587890 nullable: true required: - - hasMore - - metadata + - hasMore + - metadata GetSnapshotsQuery: type: object properties: @@ -35102,7 +36396,7 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - snapshotIds + - snapshotIds GetTestResult: type: object properties: @@ -35139,7 +36433,7 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - metrics + - metrics GetTestResultAnalytic: type: object properties: @@ -35165,7 +36459,7 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - syntheticMetrics + - syntheticMetrics GetTestResultBase: type: object properties: @@ -35205,7 +36499,7 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - syntheticMetrics + - syntheticMetrics GetTestSummaryResult: type: object properties: @@ -35226,12 +36520,15 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - metrics + - 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. + 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 @@ -35244,27 +36541,31 @@ components: 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. + 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 + 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`.' + 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. + 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`.' @@ -35274,14 +36575,16 @@ components: description: exit span duration - entry span duration parentId: type: string - description: The parent call id, referring to another call in the same trace + 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` + 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: @@ -35289,19 +36592,23 @@ components: $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. + 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. + 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`.' + 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 @@ -35322,19 +36629,22 @@ components: timeFrame: $ref: '#/components/schemas/TimeFrame' required: - - group - - metrics + - 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. + 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. + 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: @@ -35379,16 +36689,16 @@ components: type: type: string enum: - - PAGELOAD - - RESOURCELOAD - - HTTPREQUEST - - ERROR - - CUSTOM - - PAGE_CHANGE - required: - - group - - metrics - - type + - PAGELOAD + - RESOURCELOAD + - HTTPREQUEST + - ERROR + - CUSTOM + - PAGE_CHANGE + required: + - group + - metrics + - type GetWebsiteBeacons: type: object properties: @@ -35405,14 +36715,14 @@ components: type: type: string enum: - - PAGELOAD - - RESOURCELOAD - - HTTPREQUEST - - ERROR - - CUSTOM - - PAGE_CHANGE - required: - - type + - PAGELOAD + - RESOURCELOAD + - HTTPREQUEST + - ERROR + - CUSTOM + - PAGE_CHANGE + required: + - type GetWebsiteMetrics: type: object properties: @@ -35433,15 +36743,15 @@ components: type: type: string enum: - - PAGELOAD - - RESOURCELOAD - - HTTPREQUEST - - ERROR - - CUSTOM - - PAGE_CHANGE - required: - - metrics - - type + - PAGELOAD + - RESOURCELOAD + - HTTPREQUEST + - ERROR + - CUSTOM + - PAGE_CHANGE + required: + - metrics + - type GetWebsiteMetricsV2: type: object properties: @@ -35458,15 +36768,15 @@ components: type: type: string enum: - - PAGELOAD - - RESOURCELOAD - - HTTPREQUEST - - ERROR - - CUSTOM - - PAGE_CHANGE - required: - - metrics - - type + - PAGELOAD + - RESOURCELOAD + - HTTPREQUEST + - ERROR + - CUSTOM + - PAGE_CHANGE + required: + - metrics + - type GitHubConfiguration: type: object properties: @@ -35482,20 +36792,20 @@ components: url: type: string required: - - url + - url GlobalApplicationAlertConfigWithMetadata: type: object properties: alertChannelIds: type: array deprecated: true - description: List of IDs of alert channels defined in Instana. Can be left - empty. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -35515,29 +36825,31 @@ components: 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. + description: IDs of the applications that this Smart Alert is applied to. minLength: 1 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 + 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 + 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 + - ALL + - INBOUND builtIn: type: boolean - description: 'Flag that indicates whether this configuration is a built-in - Smart Alert. ' + description: >- + Flag that indicates whether this configuration is a built-in Smart + Alert. created: type: integer format: int64 @@ -35545,16 +36857,18 @@ components: minimum: 1 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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 + 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 @@ -35563,34 +36877,37 @@ components: 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. + 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 + - 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 + 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. nullable: true 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. + 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 + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 id: type: string description: ID of this Global Application Alert Configuration. @@ -35598,12 +36915,15 @@ components: 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. + 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. ' + 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 @@ -35611,23 +36931,26 @@ components: 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 + 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. + 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. + 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 @@ -35637,7 +36960,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). maximum: 10 minimum: 5 @@ -35650,33 +36974,34 @@ components: $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 + 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. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -35695,74 +37020,85 @@ components: 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 + 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 + 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 + - ALL + - INBOUND customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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 + 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. + 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 + - 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 + 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. nullable: true 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. + 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 + - 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. + 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. ' + 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 + 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 @@ -35770,10 +37106,11 @@ components: $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. + 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 @@ -35783,7 +37120,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). maximum: 10 minimum: 5 @@ -35796,33 +37134,34 @@ components: $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 + 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 - minLength: 1 + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + webhookUrl: + type: string + minLength: 1 required: - - id - - kind - - name - - webhookUrl + - id + - kind + - name + - webhookUrl GraphEdge: type: object properties: @@ -35833,16 +37172,16 @@ components: type: string description: Type of dependency between the source and the destination. enum: - - in - - is - - to - - of - - connected - - describes - - of20 - - to20 - - dummy - - parent + - in + - is + - to + - of + - connected + - describes + - of20 + - to20 + - dummy + - parent source: type: string description: ID of the incoming GraphEdge. @@ -35866,8 +37205,7 @@ components: description: Name of the plugin Group: type: object - description: ' Grouping of data under `groupbyTag`, where `groupbyTagEntity` - and `groupbyTagSecondLevelKey` are aspects of `groupbyTag`.' + description: ' Grouping of data under `groupbyTag`, where `groupbyTagEntity` and `groupbyTagSecondLevelKey` are aspects of `groupbyTag`.' properties: groupbyTag: type: string @@ -35876,26 +37214,36 @@ components: minLength: 0 groupbyTagEntity: type: string - description: | + description: > The entity by which the data should be grouped. - This field supports three possible values: `NOT_APPLICABLE`, `DESTINATION`, and `SOURCE`. + + 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). + + `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 + - NOT_APPLICABLE + - DESTINATION + - SOURCE groupbyTagSecondLevelKey: type: string - description: If present, it's the 2nd level key part (e.g. `customKey` on + description: >- + If present, it's the 2nd level key part (e.g. `customKey` on `docker.label.customKey`) maxLength: 256 minLength: 0 nullable: true required: - - groupbyTag - - groupbyTagEntity + - groupbyTag + - groupbyTagEntity GroupByTag: type: object description: The grouping tags used to group the metric results. @@ -35907,7 +37255,7 @@ components: type: string minLength: 1 required: - - tagName + - tagName GroupMapping: type: object properties: @@ -35933,9 +37281,9 @@ components: maxLength: 65536 minLength: 0 required: - - groupId - - key - - value + - groupId + - key + - value GroupMappingOverview: type: object properties: @@ -35955,9 +37303,9 @@ components: health: type: string enum: - - RED - - YELLOW - - GREEN + - RED + - YELLOW + - GREEN messages: type: array items: @@ -35965,243 +37313,320 @@ components: HistoricBaseline: type: object allOf: - - $ref: '#/components/schemas/Threshold' - - type: object - properties: - baseline: - type: array - items: + - $ref: '#/components/schemas/Threshold' + - type: object + properties: + baseline: type: array items: - type: number - nullable: true - 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 + type: array + items: + type: number + nullable: true + deviationFactor: + type: number + format: double + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 16 + minimum: 0.5 + lastUpdated: + type: integer + format: int64 + minimum: 0 + seasonality: + type: string + enum: + - WEEKLY + - DAILY required: - - operator - - seasonality + - 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' + - $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: + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + allowInsecure: + type: boolean + body: type: string - minLength: 1 - expectJson: - $ref: '#/components/schemas/ContainerNode' - expectMatch: - type: string - expectNotEmpty: - type: array - items: + expectExists: + type: array + items: + type: string + minLength: 1 + expectJson: + $ref: '#/components/schemas/ContainerNode' + expectMatch: type: string - minLength: 1 - expectStatus: - type: integer - format: int32 - followRedirect: - type: boolean - headers: - type: object - additionalProperties: + expectNotEmpty: + type: array + items: + type: string + minLength: 1 + 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 - 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 + - 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 + - $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, + 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. + + 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`. + 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. + 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. + 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. minLength: 1 required: - - rules - - serviceId + - 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 + 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. + 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" + description: >+ + A list of path segment matching rules, each defining how a segment + of the HTTP path should be matched. + + Each object in this array represents a segment rule, allowing for + fixed segments, dynamic parameters, wildcards, or unsupported + segments. + + + **UNSUPPORTED**: A path segment that is not recognized by the + system. + + + **FIXED**: This type represents a static, unchanging part of the URL + path. + + For example, `/api/{version}/users`, `api` and `users` would be + `FIXED` segment. + + + **PARAMETER**: This type represents a variable part of the URL path, + often used to capture specific parameters or IDs that change with + each request. + + For example, `/api/{version}/users`, `version` would be `PARAMETER` + segment. `version` can be `v1`, `v2`, `v3` etc. + + + **MATCH_ALL**: This type represents a wildcard, capturing all + remaining segments from this point onward in the URL path. + + For example, `/api/{version}/users/*` — Matches all paths like + `/api/v1/users/123`. `/api/v3/users/456` etc. + 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. + 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. + 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 + - 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" + description: >+ + A list of path segment matching rules, each defining how a segment of + the HTTP path should be matched. + + Each object in this array represents a segment rule, allowing for fixed + segments, dynamic parameters, wildcards, or unsupported segments. + + + **UNSUPPORTED**: A path segment that is not recognized by the system. + + + **FIXED**: This type represents a static, unchanging part of the URL + path. + + For example, `/api/{version}/users`, `api` and `users` would be `FIXED` + segment. + + + **PARAMETER**: This type represents a variable part of the URL path, + often used to capture specific parameters or IDs that change with each + request. + + For example, `/api/{version}/users`, `version` would be `PARAMETER` + segment. `version` can be `v1`, `v2`, `v3` etc. + + + **MATCH_ALL**: This type represents a wildcard, capturing all remaining + segments from this point onward in the URL path. + + For example, `/api/{version}/users/*` — Matches all paths like + `/api/v1/users/123`. `/api/v3/users/456` etc. + discriminator: mapping: FIXED: '#/components/schemas/FixedHttpPathSegmentMatchingRule' @@ -36213,55 +37638,55 @@ components: type: type: string enum: - - UNSUPPORTED - - FIXED - - PARAMETER - - MATCH_ALL + - UNSUPPORTED + - FIXED + - PARAMETER + - MATCH_ALL required: - - type + - type HttpScriptConfiguration: type: object allOf: - - $ref: '#/components/schemas/SyntheticTypeConfiguration' - - type: object - properties: - fileName: - type: string - github: - $ref: '#/components/schemas/GitHubConfiguration' - script: - type: string - maxLength: 1048576 - minLength: 0 - scriptType: - type: string - enum: - - Basic - - Jest - scripts: - $ref: '#/components/schemas/MultipleScriptsConfiguration' - required: - - markSyntheticCall - - syntheticType + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + fileName: + type: string + github: + $ref: '#/components/schemas/GitHubConfiguration' + 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 - github: - $ref: '#/components/schemas/GitHubConfiguration' - script: - type: string - scriptType: - type: string - enum: - - Basic - - Jest - scripts: - $ref: '#/components/schemas/MultipleScriptsConfiguration' + - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - type: object + properties: + fileName: + type: string + github: + $ref: '#/components/schemas/GitHubConfiguration' + 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 @@ -36289,99 +37714,119 @@ components: minLength: 0 valueFormat: type: string - description: | + 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 + + * 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 + - 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 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' + - $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 + - 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' + - $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: @@ -36390,36 +37835,39 @@ components: operator: type: string enum: - - CONTAINS - - EQUALS - - GREATER_THAN - - GREATER_THAN_OR_EQUALS - - IS - - LESS_THAN - - LESS_THAN_OR_EQUALS - - MATCHES - - NOT_MATCHES + - 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 + - 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). + 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. + description: >- + If the configuration should be enforced. See active status if it is + actually enforced. lastChangedAt: type: integer format: int64 @@ -36427,36 +37875,41 @@ components: lastVerifiedAt: type: integer format: int64 - description: When the configuration was last verified. Can be used to assume - if a configuration needs to be verified. + 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. + 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: Optional flag for future support access functionality. Currently - has no effect and defaults to false if not provided. Instana support is + description: >- + Optional flag for future support access functionality. Currently has + no effect and defaults to false if not provided. Instana support is still able to deactivate the configuration for you (manual process). required: - - rules + - rules IPFilteringRuleDto: type: object - description: Actual traffic rules. Enforcing allow / block based on incoming - IP address. Are evaluated in given order. + 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 + description: >- + Target of this rule, can be either a IP address or a IP address range. required: - - block - - target + - block + - target IPFilteringUpsert: type: object properties: @@ -36465,25 +37918,28 @@ components: 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. + 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. + 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: Optional flag for future support access functionality. Currently - has no effect and defaults to false if not provided. Instana support is + description: >- + Optional flag for future support access functionality. Currently has + no effect and defaults to false if not provided. Instana support is still able to deactivate the configuration for you (manual process). required: - - denyAll - - enabled - - rules + - denyAll + - enabled + - rules IdentityProviderPatch: type: object properties: @@ -36513,13 +37969,13 @@ components: alertChannelIds: type: array deprecated: true - description: List of IDs of alert channels defined in Instana. Can be left - empty. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -36538,47 +37994,52 @@ components: nullable: true customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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. + 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. + description: >- + Determines whether we evaluate each infra entity independently or + group of entities will be evaluated together. enum: - - PER_ENTITY - - CUSTOM + - PER_ENTITY + - CUSTOM nullable: true 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 + 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. nullable: true 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. + 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 + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 groupBy: type: array description: The grouping tags used to group the metric results. @@ -36590,8 +38051,9 @@ components: 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 + 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 @@ -36601,15 +38063,16 @@ components: type: string description: Set AND / OR enum: - - AND - - OR + - AND + - OR nullable: true 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. + 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 @@ -36619,7 +38082,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). nullable: true tagFilterExpression: @@ -36630,30 +38094,31 @@ components: $ref: '#/components/schemas/InfraTimeThreshold' triggering: type: boolean - description: Optional flag to indicate whether an Incident is also triggered - or not. + description: >- + Optional flag to indicate whether an Incident is also triggered or + not. nullable: true required: - - customPayloadFields - - description - - granularity - - groupBy - - name - - tagFilterExpression - - timeThreshold + - 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. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -36675,48 +38140,53 @@ components: minimum: 1 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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. + 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. + description: >- + Determines whether we evaluate each infra entity independently or + group of entities will be evaluated together. enum: - - PER_ENTITY - - CUSTOM + - 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 + 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. nullable: true 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. + 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 + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 groupBy: type: array description: The grouping tags used to group the metric results. @@ -36736,8 +38206,9 @@ components: 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 + 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 @@ -36749,14 +38220,15 @@ components: type: string description: Set AND / OR enum: - - AND - - OR + - AND + - OR 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. + 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 @@ -36766,7 +38238,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). nullable: true tagFilterExpression: @@ -36777,18 +38250,19 @@ components: $ref: '#/components/schemas/InfraTimeThreshold' triggering: type: boolean - description: Optional flag to indicate whether an Incident is also triggered - or not. + description: >- + Optional flag to indicate whether an Incident is also triggered or + not. nullable: true required: - - customPayloadFields - - description - - granularity - - groupBy - - id - - name - - tagFilterExpression - - timeThreshold + - customPayloadFields + - description + - granularity + - groupBy + - id + - name + - tagFilterExpression + - timeThreshold InfraAlertRule: type: object discriminator: @@ -36799,45 +38273,45 @@ components: 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 + - 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 + - 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: @@ -36852,56 +38326,62 @@ components: regex: type: boolean required: - - alertType - - metricName + - 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: + - $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 - 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. - snapshotIds: - type: array - description: IDs of all affected snapshots. Only present for Infra Smart - Alert events. - items: + 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: IDs of all affected snapshots. Only present for Infra Smart + description: ID of the snapshot. + snapshotIds: + type: array + description: >- + IDs of all affected snapshots. Only present for Infra Smart Alert events. - uniqueItems: true + items: + type: string + description: >- + IDs of all affected snapshots. Only present for Infra Smart + Alert events. + uniqueItems: true InfraExploreCursor: type: object description: cursor to use between successive queries InfraSloEntity: type: object allOf: - - $ref: '#/components/schemas/SloEntity' - - type: object - properties: - infraType: - type: string - description: Infrastructure Type + - $ref: '#/components/schemas/SloEntity' + - type: object + properties: + infraType: + type: string + description: Infrastructure Type required: - - infraType + - infraType InfraTimeThreshold: type: object - description: The type of threshold to define the criteria when the event and - alert triggers and resolves. + description: >- + The type of threshold to define the criteria when the event and alert + triggers and resolves. discriminator: mapping: violationsInSequence: '#/components/schemas/ViolationsInSequenceInfraTimeThreshold' @@ -36913,7 +38393,7 @@ components: type: type: string required: - - type + - type InfrastructureEntitiesResult: type: object properties: @@ -36933,7 +38413,7 @@ components: description: represents the total number of results minimum: 0 required: - - items + - items InfrastructureGroup: type: object description: group of infrastructure entities @@ -36992,7 +38472,7 @@ components: description: represents the total number of results minimum: 0 required: - - items + - items InfrastructureItem: type: object properties: @@ -37026,8 +38506,9 @@ components: time: type: integer format: int64 - description: Epoch time in milliseconds if the snapshot is offline. Set - to 9223372036854775807 if the snapshot is online. + description: >- + Epoch time in milliseconds if the snapshot is offline. Set to + 9223372036854775807 if the snapshot is online. InfrastructureMetricResult: type: object properties: @@ -37075,9 +38556,9 @@ components: nullable: true uniqueItems: true required: - - id - - kind - - name + - id + - kind + - name Invitation: type: object properties: @@ -37096,8 +38577,8 @@ components: type: string nullable: true required: - - email - - groupId + - email + - groupId InvitationResponse: type: object properties: @@ -37111,12 +38592,12 @@ components: 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 + - 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: @@ -37125,11 +38606,11 @@ components: ipMasking: type: string enum: - - DEFAULT - - STRICT - - REMOVE_ALL_DETAILS + - DEFAULT + - STRICT + - REMOVE_ALL_DETAILS required: - - ipMasking + - ipMasking JsStackTraceLine: type: object properties: @@ -37155,15 +38636,16 @@ components: format: int32 minimum: -1 required: - - file + - 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. + description: >- + Contains physical context of Kubernetes which contains information about + the cluster, namespace, node and pod. nullable: true properties: cluster: @@ -37213,12 +38695,12 @@ components: type: string minLength: 1 required: - - capabilities - - id - - model - - name - - service - - tenantUnitId + - capabilities + - id + - model + - name + - service + - tenantUnitId LLMGatewayCapability: type: object properties: @@ -37230,7 +38712,7 @@ components: name: type: string required: - - id + - id LLMGatewayModel: type: object properties: @@ -37253,7 +38735,7 @@ components: name: type: string required: - - id + - id LLMGatewayTestConnectionRequest: type: object properties: @@ -37266,23 +38748,23 @@ components: serviceId: type: string required: - - serviceId + - serviceId LatencyBlueprintIndicator: type: object allOf: - - $ref: '#/components/schemas/ServiceLevelIndicator' - - type: object - properties: - metric: - $ref: '#/components/schemas/EntityMetric' - threshold: - type: number - format: double - description: Threshold Value for the Blueprint - exclusiveMinimum: false - minimum: 0.0 + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + properties: + metric: + $ref: '#/components/schemas/EntityMetric' + threshold: + type: number + format: double + description: Threshold Value for the Blueprint + exclusiveMinimum: false + minimum: 0 required: - - type + - type LlmModelPrice: type: object properties: @@ -37309,8 +38791,8 @@ components: provider: type: string required: - - inputCost - - outputCost + - inputCost + - outputCost LlmModelPriceMetadata: type: object properties: @@ -37318,7 +38800,7 @@ components: type: string minLength: 1 required: - - currencyCode + - currencyCode LocationStatus: type: object properties: @@ -37339,20 +38821,20 @@ components: type: integer format: int64 required: - - locationId + - locationId LogAlertConfig: type: object properties: alertChannelIds: type: array deprecated: true - description: List of IDs of alert channels defined in Instana. Can be left - empty. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -37371,39 +38853,43 @@ components: nullable: true customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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. + 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 + 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. nullable: true 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. + 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 + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 groupBy: type: array description: The grouping tags used to group the metric results. @@ -37413,16 +38899,19 @@ components: 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. + 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. + 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 @@ -37432,7 +38921,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). nullable: true tagFilterExpression: @@ -37442,24 +38932,24 @@ components: timeThreshold: $ref: '#/components/schemas/LogTimeThreshold' required: - - description - - granularity - - name - - tagFilterExpression - - timeThreshold + - 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. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -37481,17 +38971,19 @@ components: minimum: 1 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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. + 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: @@ -37499,23 +38991,25 @@ components: 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 + 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. nullable: true 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. + 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 + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 groupBy: type: array description: The grouping tags used to group the metric results. @@ -37533,18 +39027,21 @@ components: 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. + 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. + 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 @@ -37554,7 +39051,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). nullable: true tagFilterExpression: @@ -37564,12 +39062,12 @@ components: timeThreshold: $ref: '#/components/schemas/LogTimeThreshold' required: - - description - - granularity - - id - - name - - tagFilterExpression - - timeThreshold + - description + - granularity + - id + - name + - tagFilterExpression + - timeThreshold LogAlertRule: type: object discriminator: @@ -37580,50 +39078,51 @@ components: 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 + - 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 minLength: 1 required: - - alertType - - metricName + - alertType + - metricName LogCountAlertRule: type: object allOf: - - $ref: '#/components/schemas/LogAlertRule' + - $ref: '#/components/schemas/LogAlertRule' required: - - metricName + - metricName LogEventResult: type: object allOf: - - $ref: '#/components/schemas/EventResult' - - type: object - properties: - snapshotId: - type: string - description: ID of the snapshot. + - $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. + description: >- + The type of threshold to define the criteria when the event and alert + triggers and resolves. discriminator: mapping: violationsInSequence: '#/components/schemas/ViolationsInSequenceLogTimeThreshold' @@ -37635,7 +39134,7 @@ components: type: type: string required: - - type + - type LogVolumeGroup: type: object properties: @@ -37647,8 +39146,8 @@ components: type: integer format: int64 required: - - label - - logVolume + - label + - logVolume LogVolumeUsageItem: type: object properties: @@ -37666,8 +39165,8 @@ components: items: $ref: '#/components/schemas/RetentionPeriod' required: - - logVolume - - retentionPeriods + - logVolume + - retentionPeriods LogVolumeUsageResult: type: object properties: @@ -37676,7 +39175,7 @@ components: items: $ref: '#/components/schemas/LogVolumeUsageItem' required: - - logVolumeUsageItems + - logVolumeUsageItems LogsApiResponse: type: object properties: @@ -37694,51 +39193,51 @@ components: 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 - nullable: true - operator: - type: string - enum: - - EQUALS - - CONTAINS - - IN - - NOT_IN - - 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 + - $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 + nullable: true + operator: + type: string + enum: + - EQUALS + - CONTAINS + - IN + - NOT_IN + - 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 LogsQuery: type: object properties: @@ -37752,8 +39251,8 @@ components: orderDirection: type: string enum: - - ASC - - DESC + - ASC + - DESC nullable: true requestedTags: type: array @@ -37786,23 +39285,25 @@ components: minLength: 0 query: type: string - description: Dynamic Focus Query that determines the scope of the Maintenance + 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. + 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 + - id + - name + - query MaintenanceConfigScheduling: type: object description: Time scheduling of the Maintenance Window configurations. @@ -37823,9 +39324,9 @@ components: maxLength: 2048 minLength: 0 required: - - duration - - start - - type + - duration + - start + - type MaintenanceConfigV2: type: object properties: @@ -37841,18 +39342,21 @@ components: minLength: 0 paused: type: boolean - description: Boolean flag to determine if the Maintenance Window configuration - is paused or still live. + 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 + 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, + 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' @@ -37862,10 +39366,10 @@ components: type: boolean description: Boolean flag to determine if the tagFilterExpression is enabled. required: - - id - - name - - query - - scheduling + - id + - name + - query + - scheduling MaintenanceConfigV2WithStateAndOccurrence: type: object properties: @@ -37887,42 +39391,46 @@ components: $ref: '#/components/schemas/Occurrence' paused: type: boolean - description: Boolean flag to determine if the Maintenance Window configuration - is paused or still live. + 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 + 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, + 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.' + description: >- + State of the Maintenance Window, it can be: UNSCHEDULED, SCHEDULED, + ACTIVE, PAUSED, EXPIRED. enum: - - UNSCHEDULED - - SCHEDULED - - ACTIVE - - PAUSED - - EXPIRED + - 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 + - id + - name + - occurrence + - query + - scheduling MaintenanceConfigWithLastUpdated: type: object properties: @@ -37942,27 +39450,30 @@ components: minLength: 0 query: type: string - description: Dynamic Focus Query that determines the scope of the Maintenance + 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. + 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 + - id + - name + - query MaintenanceWindow: type: object - description: A set of time periods when the Maintenance Window Configuration - is active. + description: >- + A set of time periods when the Maintenance Window Configuration is + active. properties: end: type: integer @@ -37977,14 +39488,15 @@ components: format: int64 minimum: 0 required: - - id + - id ManualAlertingChannelConfiguration: type: object properties: customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + description: >- + Custom payload fields to send additional information in the alert + notifications. Can be left empty. items: $ref: '#/components/schemas/StaticStringField' maxItems: 20 @@ -37995,8 +39507,8 @@ components: maxLength: 256 minLength: 0 required: - - customPayloadFields - - eventId + - customPayloadFields + - eventId ManualCloseInfo: type: object properties: @@ -38030,8 +39542,8 @@ components: maxLength: 256 minLength: 0 required: - - reasonForClosing - - username + - reasonForClosing + - username ManualServiceConfig: type: object properties: @@ -38041,12 +39553,14 @@ components: nullable: true enabled: type: boolean - description: Enable or disable the manual service configuration. By default - it is enabled. + 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. + description: >- + The service ID of the existing monitored service to which the calls + should be linked. nullable: true id: type: string @@ -38060,18 +39574,17 @@ components: description: A service name if you want to map calls to an unmonitored service. nullable: true required: - - id - - tagFilterExpression + - id + - tagFilterExpression MatchAllHttpPathSegmentMatchingRule: type: object allOf: - - $ref: '#/components/schemas/HttpPathSegmentMatchingRule' + - $ref: '#/components/schemas/HttpPathSegmentMatchingRule' required: - - type + - type MatchExpressionDTO: type: object - description: ' Specify the expression to match, For example, `endpoint.name - contains health`.' + description: ' Specify the expression to match, For example, `endpoint.name contains health`.' discriminator: mapping: BINARY_OP: '#/components/schemas/BinaryOperatorDTO' @@ -38081,7 +39594,7 @@ components: type: type: string required: - - type + - type MetaData: type: object description: Action metadata. @@ -38097,19 +39610,23 @@ components: 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. + 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 + 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` + 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 + description: >- + Sensor imported action flag. Value is `true` if action is imported from sensor `false` otherwise. MetricAPIResult: type: object @@ -38125,83 +39642,94 @@ components: items: type: number required: - - metrics + - 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`.' + 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`.' + 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 + - 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' + description: >- + If the granularity is set you will get data points with the + specified granularity in seconds. Default: `1000` milliseconds nullable: true metric: type: string description: 'Set a particular metric, eg: `latency`.' minLength: 1 required: - - aggregation - - metric + - aggregation + - metric MetricConfiguration: type: object - description: Details regarding the metric to be configured, including the metric + 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. + 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 + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE nullable: true metricName: type: string - description: Defines the name of the metric to be monitored. Examples include + description: >- + Defines the name of the metric to be monitored. Examples include `calls` and `latency` minLength: 1 threshold: @@ -38209,25 +39737,58 @@ components: format: double description: Specifies the threshold value for the metric being monitored exclusiveMinimum: true - minimum: 0.0 + minimum: 0 required: - - metricName + - metricName MetricDescription: type: object properties: aggregations: type: array - description: | + 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`. + + 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`. + 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 @@ -38245,97 +39806,95 @@ components: - 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` + 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: | + 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 + + * `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 minLength: 1 label: type: string - description: The name of the metric. For example, `Call count`, `Erroneous + 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`, + description: >- + The unique id of the metric. For example, `calls`, `erroneousCalls`, `latency` etc. minLength: 1 required: - - aggregations - - formatter - - label - - metricId + - aggregations + - formatter + - label + - metricId MetricField: type: object allOf: - - $ref: '#/components/schemas/CustomPayloadField' - - type: object - properties: - aggregation: - type: string - enum: - - SUM - - MEAN - - MIN - - MAX - - PER_SECOND - entityType: - type: string - metricId: - type: string - source: - type: string - enum: - - INFRA - - APPLICATION - timeWindow: - type: object - value: - $ref: '#/components/schemas/MetricFieldValue' + - $ref: '#/components/schemas/CustomPayloadField' + - type: object + properties: + aggregation: + type: string + enum: + - SUM + - MEAN + - MIN + - MAX + - PER_SECOND + entityType: + type: string + metricId: + type: string + source: + type: string + enum: + - INFRA + - APPLICATION + timeWindow: + type: object + value: + $ref: '#/components/schemas/MetricFieldValue' required: - - key + - key MetricFieldValue: type: object description: Configuration for a metric-based custom payload field @@ -38344,11 +39903,11 @@ components: type: string description: The aggregation type to apply to the metric enum: - - SUM - - MEAN - - MIN - - MAX - - PER_SECOND + - SUM + - MEAN + - MIN + - MAX + - PER_SECOND entityType: type: string description: The entity type for the metric query @@ -38359,14 +39918,14 @@ components: type: string description: The source catalog the metric was selected from enum: - - INFRA - - APPLICATION + - INFRA + - APPLICATION timeWindow: type: object description: The time window in milliseconds for metric aggregation required: - - aggregation - - metricId + - aggregation + - metricId MetricInstance: type: object properties: @@ -38377,41 +39936,60 @@ components: minLength: 1 formatter: type: string - description: | + 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 + + * 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 + - 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 minLength: 1 @@ -38422,11 +40000,11 @@ components: type: string minLength: 1 required: - - description - - formatter - - label - - metricId - - pluginId + - description + - formatter + - label + - metricId + - pluginId MetricItem: type: object properties: @@ -38453,7 +40031,8 @@ components: description: Plugin name snapshotId: type: string - description: Id of the exact metric you want to retrieve, eg. "cpu.user", + description: >- + Id of the exact metric you want to retrieve, eg. "cpu.user", "clientrequests.read.mean" tags: type: array @@ -38478,64 +40057,83 @@ components: 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 + - 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: | + 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 + + * 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 + - 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 @@ -38543,44 +40141,45 @@ components: 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 - - MSSQL - - OTHERS - - POSTGRESQL - - REDIS - - SAP - - SELF_MONITORING - - SOLR - - SPARK - - TIBCOBW - - TUXEDO - - VSHPERE - - WEBSPHERE - - CUSTOM_ENTITY + - 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 + - ORACLE_DB + - OTHERS + - POSTGRESQL + - REDIS + - SAP + - SELF_MONITORING + - SOLR + - SPARK + - TIBCOBW + - TUXEDO + - VSHPERE + - WEBSPHERE + - CUSTOM_ENTITY label: type: string description: Label for the metric @@ -38594,10 +40193,10 @@ components: type: string description: Metric tags required: - - id - - infraTagCategory - - label - - ownerType + - id + - infraTagCategory + - label + - ownerType MetricPattern: type: object nullable: true @@ -38605,11 +40204,11 @@ components: operator: type: string enum: - - is - - contains - - startsWith - - endsWith - - any + - is + - contains + - startsWith + - endsWith + - any placeholder: type: string nullable: true @@ -38620,8 +40219,8 @@ components: type: string minLength: 1 required: - - operator - - prefix + - operator + - prefix MetricsResult: type: object properties: @@ -38630,7 +40229,7 @@ components: items: $ref: '#/components/schemas/MetricsResultItem' required: - - metricsResult + - metricsResult MetricsResultItem: type: object properties: @@ -38638,57 +40237,65 @@ components: 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. + 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. + 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. + 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 nullable: true 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. + 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 + - 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. + 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 + 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. + 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. @@ -38697,11 +40304,13 @@ components: 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 + 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 + description: >- + A list of the mobile applications associated with the Synthetic test. serviceId: type: string @@ -38720,7 +40329,7 @@ components: type: string description: A list of the websites associated with the Synthetic test. required: - - testId + - testId MobileApp: type: object properties: @@ -38736,21 +40345,21 @@ components: maxLength: 128 minLength: 0 required: - - id - - name + - 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. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -38771,16 +40380,18 @@ components: $ref: '#/components/schemas/TagFilterExpression' customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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 + 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 @@ -38790,36 +40401,40 @@ components: 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 + 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. nullable: true 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. + 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 + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 id: type: string writeOnly: true mobileAppId: type: string - description: ID of the mobile app that this Smart Alert configuration is - applied to. + 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 + 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 @@ -38827,10 +40442,11 @@ components: $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. + 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 @@ -38840,7 +40456,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). maximum: 10 minimum: 5 @@ -38853,29 +40470,30 @@ components: $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 + description: >- + Optional flag to indicate whether an Incident is also triggered or + not. + required: + - customPayloadFields + - description + - granularity + - mobileAppId + - 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. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -38901,16 +40519,18 @@ components: minimum: 1 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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 + 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 @@ -38920,23 +40540,25 @@ components: 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 + 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. nullable: true 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. + 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 + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 id: type: string description: 'ID of this Mobile App Alert Config. ' @@ -38949,14 +40571,16 @@ components: minimum: 1 mobileAppId: type: string - description: ID of the mobile app that this Smart Alert configuration is - applied to. + 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 + 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 @@ -38968,16 +40592,18 @@ components: uniqueItems: true readOnly: type: boolean - description: Flag to indicate whether or not the configuration is read-only. + 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. + 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 @@ -38987,7 +40613,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). maximum: 10 minimum: 5 @@ -39000,17 +40627,18 @@ components: $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 + 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: @@ -39025,36 +40653,39 @@ components: 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 + - 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 minLength: 1 required: - - alertType - - metricName + - 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. + 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' @@ -39074,9 +40705,9 @@ components: type: string minLength: 1 required: - - cursor - - metrics - - name + - cursor + - metrics + - name MobileAppBeaconGroupsResult: type: object properties: @@ -39084,13 +40715,17 @@ components: $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. + 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. + 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: @@ -39101,17 +40736,20 @@ components: totalRepresentedItemCount: type: integer format: int64 - description: For calls and EUM beacons, one row can represent multiple real - items (batched call, sample multiplicity) + 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. + 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 + - items MobileAppBeaconResult: type: object properties: @@ -39119,13 +40757,17 @@ components: $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. + 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. + 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: @@ -39136,17 +40778,20 @@ components: totalRepresentedItemCount: type: integer format: int64 - description: For calls and EUM beacons, one row can represent multiple real - items (batched call, sample multiplicity) + 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. + 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 + - items MobileAppBeaconTagGroup: type: object properties: @@ -39157,31 +40802,44 @@ components: minLength: 0 groupbyTagEntity: type: string - description: | + description: > The entity by which the data should be grouped. - This field supports three possible values: `NOT_APPLICABLE`, `DESTINATION`, and `SOURCE`. + + 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). + + `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 + - NOT_APPLICABLE + - DESTINATION + - SOURCE groupbyTagSecondLevelKey: type: string - description: If present, it's the 2nd level key part (e.g. `customKey` on + description: >- + If present, it's the 2nd level key part (e.g. `customKey` on `docker.label.customKey`) maxLength: 256 minLength: 0 nullable: true required: - - groupbyTag - - groupbyTagEntity + - 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. + 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' @@ -39190,17 +40848,17 @@ components: impactedBeaconInfo: $ref: '#/components/schemas/ImpactedBeaconInfo' required: - - beacon - - cursor + - beacon + - cursor MobileAppEventResult: type: object allOf: - - $ref: '#/components/schemas/EventResult' - - type: object - properties: - mobileAppId: - type: string - description: ID of the mobile app. + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + mobileAppId: + type: string + description: ID of the mobile app. MobileAppMetricResult: type: object additionalProperties: @@ -39628,27 +41286,67 @@ components: format: int64 minimum: -1 required: - - beaconId - - mobileAppId - - performanceSubtype - - rateLimitBeaconType - - type + - beaconId + - mobileAppId + - performanceSubtype + - rateLimitBeaconType + - type MobileAppMonitoringMetricDescription: type: object properties: aggregations: type: array - description: | + 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`. + + 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`. + 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 + minLength: 1 + minItems: 1 + 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 @@ -39666,68 +41364,59 @@ components: - SUM_POSITIVE - PER_SECOND - INCREASE - uniqueItems: true - beaconTypes: - type: array - items: - type: string - minLength: 1 - minItems: 1 - 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` + 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: | + 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 + + * `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 minLength: 1 label: type: string - description: The name of the metric. For example, `Call count`, `Erroneous + 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`, + description: >- + The unique id of the metric. For example, `calls`, `erroneousCalls`, `latency` etc. minLength: 1 pathToValueInBeacon: @@ -39747,41 +41436,43 @@ components: type: string nullable: true required: - - aggregations - - beaconTypes - - formatter - - label - - metricId + - 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`.' + 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 + - 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' + description: >- + If the granularity is set you will get data points with the + specified granularity in seconds. Default: `1000` milliseconds nullable: true metric: type: string @@ -39790,14 +41481,15 @@ components: numeratorTagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' required: - - aggregation - - metric + - aggregation + - metric MobileAppSloMetricCatalog: type: object MobileAppTimeThreshold: type: object - description: The type of threshold to define the criteria when the event and - alert triggers and resolves. + description: >- + The type of threshold to define the criteria when the event and alert + triggers and resolves. discriminator: mapping: userImpactOfViolationsInSequence: '#/components/schemas/UserImpactMobileAppTimeThreshold' @@ -39811,21 +41503,21 @@ components: type: type: string required: - - type + - type MobileSloEntity: type: object allOf: - - $ref: '#/components/schemas/SloEntity' - - type: object - properties: - mobileIds: - type: array - description: The ID(s) of the Mobile Apps - items: - type: string + - $ref: '#/components/schemas/SloEntity' + - type: object + properties: + mobileIds: + type: array description: The ID(s) of the Mobile Apps - nullable: true - uniqueItems: true + items: + type: string + description: The ID(s) of the Mobile Apps + nullable: true + uniqueItems: true MonitoredEntitiesStats: type: object description: Statistics of monitored entities. @@ -39867,8 +41559,8 @@ components: format: int32 description: Count of serverless required: - - hasEntities - - monitoredEntitiesStats + - hasEntities + - monitoredEntitiesStats MultipleScriptsConfiguration: type: object properties: @@ -39879,27 +41571,27 @@ components: NS1Integration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - feedLabel: - type: string - headers: - type: array - items: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + feedLabel: type: string - minLength: 1 - webhookUrls: - type: array - items: - type: string - minLength: 1 - minItems: 1 + headers: + type: array + items: + type: string + minLength: 1 + webhookUrls: + type: array + items: + type: string + minLength: 1 + minItems: 1 required: - - id - - kind - - name - - webhookUrls + - id + - kind + - name + - webhookUrls NewApplicationConfig: type: object properties: @@ -39913,29 +41605,35 @@ components: 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. + 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. - **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`. + **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 + - ALL + - INBOUND + - DEFAULT businessCriticality: - type: string - description: Business criticality level of the application - enum: - - NOT_DEFINED - - LOWEST - - LOW - - MEDIUM - - HIGH - - HIGHEST - nullable: true + type: integer + format: int32 + description: Business criticality of an application (0-5) + maximum: 5 + minimum: 0 label: type: string description: 'Name of the Application Perspective. Eg: `app1`.' @@ -39945,29 +41643,43 @@ components: $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). + 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. + **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 + - INCLUDE_NO_DOWNSTREAM + - INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING + - INCLUDE_ALL_DOWNSTREAM tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' required: - - accessRules - - boundaryScope - - businessCriticality - - label - - scope + - accessRules + - boundaryScope + - label + - scope NewBusinessPerspectiveConfig: type: object properties: @@ -39990,12 +41702,14 @@ components: nullable: true enabled: type: boolean - description: Enable or disable the manual service configuration. By default - it is enabled. + 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. + description: >- + The service ID of the existing monitored service to which the calls + should be linked. nullable: true tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' @@ -40004,38 +41718,42 @@ components: description: A service name if you want to map calls to an unmonitored service. nullable: true required: - - tagFilterExpression + - tagFilterExpression Notification: type: object - description: Optional notifications configuration for action execution events. - Each notification specifies a condition (started, fail, success) and associated - alert channels. + description: >- + Optional notifications configuration for action execution events. Each + notification specifies a condition (started, fail, success) and + associated alert channels. properties: alertChannelIds: type: array - description: List of alert channel identifiers to send notifications to - for this condition. + description: >- + List of alert channel identifiers to send notifications to for this + condition. items: type: string - description: List of alert channel identifiers to send notifications to - for this condition. + description: >- + List of alert channel identifiers to send notifications to for + this condition. minItems: 1 condition: type: string - description: Notification condition. Determines when the notification is - sent. Each notification object represents a single condition with its + description: >- + Notification condition. Determines when the notification is sent. + Each notification object represents a single condition with its associated alert channels. enum: - - STATUS_UNKNOWN - - SUBMITTED - - IN_PROGRESS - - SUCCESS - - FAILED - - READY - - TIMEOUT - required: - - alertChannelIds - - condition + - STATUS_UNKNOWN + - SUBMITTED + - IN_PROGRESS + - SUCCESS + - FAILED + - READY + - TIMEOUT + required: + - alertChannelIds + - condition OAuthConfig: type: object properties: @@ -40052,8 +41770,8 @@ components: grantType: type: string enum: - - CLIENT_CREDENTIALS - - PASSWORD + - CLIENT_CREDENTIALS + - PASSWORD password: type: string writeOnly: true @@ -40064,9 +41782,9 @@ components: type: string writeOnly: true required: - - clientId - - clientSecret - - tokenUrl + - clientId + - clientSecret + - tokenUrl OAuthIntegration: type: object properties: @@ -40090,8 +41808,8 @@ components: status: type: string enum: - - VALID - - INVALID + - VALID + - INVALID tokenType: type: string valid: @@ -40111,91 +41829,94 @@ components: Office365Integration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - webhookUrl: - type: string - minLength: 1 + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + webhookUrl: + type: string + minLength: 1 required: - - id - - kind - - name - - webhookUrl + - id + - kind + - name + - webhookUrl OneTimeMaintenanceWindow: type: object allOf: - - $ref: '#/components/schemas/MaintenanceConfigScheduling' + - $ref: '#/components/schemas/MaintenanceConfigScheduling' required: - - duration - - start - - type + - duration + - start + - type OpsgenieIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - alias: - type: string - nullable: true - apiKey: - type: string - minLength: 1 - region: - type: string - enum: - - US - - EU - tags: - type: string - nullable: true + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + alias: + type: string + nullable: true + apiKey: + type: string + minLength: 1 + region: + type: string + enum: + - US + - EU + tags: + type: string + nullable: true required: - - apiKey - - id - - kind - - name - - region + - apiKey + - id + - kind + - name + - region Order: type: object - description: | + 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. + + 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. + 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 - queries. + description: Language code used for sorting. Ignored for infrastructure queries. nullable: true direction: type: string - description: The order in which results will be sorted, either `ASC` for + description: >- + The order in which results will be sorted, either `ASC` for ascending or `DESC` for descending. enum: - - ASC - - DESC + - ASC + - DESC required: - - by - - direction + - by + - direction PagerdutyIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - serviceIntegrationKey: - type: string - minLength: 1 + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + serviceIntegrationKey: + type: string + minLength: 1 required: - - id - - kind - - name - - serviceIntegrationKey + - id + - kind + - name + - serviceIntegrationKey PaginatedResult: type: object properties: @@ -40217,22 +41938,24 @@ components: format: int64 minimum: 0 required: - - items + - 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 + 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.' + 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: @@ -40264,16 +41987,17 @@ components: nullable: true type: type: string - description: Parameter type. Valid values are `static`, `dynamic`, or `vault`. + description: >- + Parameter type. Valid values are `static`, `dynamic`, or `vault`. Default value is `static` minLength: 1 value: type: string description: Parameter value. required: - - label - - name - - type + - label + - name + - type ParameterValue: type: object description: List of action input parameters. @@ -40286,31 +42010,39 @@ components: type: string description: Parameter value. required: - - name - - value + - 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`. - minLength: 1 + - $ref: '#/components/schemas/HttpPathSegmentMatchingRule' + - type: object + properties: + name: + type: string + description: | + Given `/api/{version}/users` URI, `PARAMETER` name is `version`. + minLength: 1 required: - - name - - type + - 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. + 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. + + 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. nullable: true properties: @@ -40365,20 +42097,22 @@ components: $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. + 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' minItems: 1 required: - - id - - name - - trigger - - typeConfigurations + - id + - name + - trigger + - typeConfigurations PolicyRunnable: type: object - description: Runnable associated with the policy. It can be a `workflow` or - `action`. Currently only supports `action`. + description: >- + Runnable associated with the policy. It can be a `workflow` or `action`. + Currently only supports `action`. properties: id: type: string @@ -40390,26 +42124,29 @@ components: type: string description: Type of runnable. Supported value is `action`. enum: - - action - - workflow + - action + - workflow required: - - id - - runConfiguration - - type + - 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' + 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`). + description: >- + The time to run the policy action in milliseconds since epoch (UTC) + (e.g., `1706713140000`). PostSnapshotsResult: type: object properties: @@ -40434,11 +42171,14 @@ components: type: boolean description: Whether the shortcode prefix feature is enabled example: true + includeInTitle: + type: boolean + description: Whether the short code should be included in the incident title + example: false prefix: type: string - description: The prefix to use for event short codes (e.g., 'INSTANA-', - 'PROD-') - example: INSTANA- + description: The prefix to use for event short codes (e.g., 'INSTA-', 'PROD-') + example: INSTA- Problem: type: object properties: @@ -40458,24 +42198,24 @@ components: type: integer format: int32 required: - - id + - id PrometheusWebhookIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - receiver: - type: string - nullable: true - webhookUrl: - type: string - minLength: 1 + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + receiver: + type: string + nullable: true + webhookUrl: + type: string + minLength: 1 required: - - id - - kind - - name - - webhookUrl + - id + - kind + - name + - webhookUrl RbacRestrictions: type: object properties: @@ -40557,26 +42297,27 @@ components: RecurrentMaintenanceWindow: type: object allOf: - - $ref: '#/components/schemas/MaintenanceConfigScheduling' - - type: object - properties: - rrule: - type: string - minLength: 1 - timezoneId: - type: string + - $ref: '#/components/schemas/MaintenanceConfigScheduling' + - type: object + properties: + rrule: + type: string + minLength: 1 + timezoneId: + type: string required: - - duration - - rrule - - start - - type + - duration + - rrule + - start + - type Release: type: object properties: applications: type: array - description: The list of application perspectives where the release can - be viewed. + description: >- + The list of application perspectives where the release can be + viewed. items: $ref: '#/components/schemas/ApplicationScope' maxItems: 10 @@ -40598,13 +42339,14 @@ components: 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`.' + 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 + - name + - start ReleaseScope: type: object properties: @@ -40621,8 +42363,9 @@ components: properties: applications: type: array - description: The list of application perspectives where the release can - be viewed. + description: >- + The list of application perspectives where the release can be + viewed. items: $ref: '#/components/schemas/ApplicationScopeWithMetadata' maxItems: 10 @@ -40636,9 +42379,10 @@ components: 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`.' + 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 @@ -40661,13 +42405,14 @@ components: 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`.' + 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 + - id + - name RetentionPeriod: type: object properties: @@ -40685,7 +42430,7 @@ components: maximum: 90 minimum: 7 required: - - logVolume + - logVolume RoleMappingOverview: type: object properties: @@ -40706,18 +42451,18 @@ components: value: type: string required: - - id - - key - - role - - roleId - - value + - id + - key + - role + - roleId + - value RollingTimeWindow: type: object allOf: - - $ref: '#/components/schemas/TimeWindow' + - $ref: '#/components/schemas/TimeWindow' required: - - duration - - durationUnit + - duration + - durationUnit RuleInput: type: object description: List of input rules of the Built-in Event Specification @@ -40725,11 +42470,11 @@ components: inputKind: type: string enum: - - METRIC - - SNAPSHOT_FIELD - - EVENT - - DERIVED_METRIC - - METRIC_PATTERN + - METRIC + - SNAPSHOT_FIELD + - EVENT + - DERIVED_METRIC + - METRIC_PATTERN inputName: type: string maxLength: 256 @@ -40739,133 +42484,143 @@ components: format: int32 nullable: true required: - - inputKind - - inputName + - 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. + 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: - - '>' - - '>=' - - < - - <= - - OUTSIDE - - BETWEEN + - '>' + - '>=' + - < + - <= + - OUTSIDE + - BETWEEN thresholds: type: object additionalProperties: $ref: '#/components/schemas/ThresholdConfigRule' required: - - rule - - thresholdOperator - - thresholds + - 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. + 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: - - '>' - - '>=' - - < - - <= - - OUTSIDE - - BETWEEN + - '>' + - '>=' + - < + - <= + - OUTSIDE + - BETWEEN thresholds: type: object additionalProperties: $ref: '#/components/schemas/ThresholdConfigRule' required: - - rule - - thresholdOperator - - thresholds + - 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. + 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: - - '>' - - '>=' - - < - - <= - - OUTSIDE - - BETWEEN + - '>' + - '>=' + - < + - <= + - OUTSIDE + - BETWEEN thresholds: type: object additionalProperties: $ref: '#/components/schemas/ThresholdConfigRule' required: - - rule - - thresholdOperator - - thresholds + - 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. + 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: - - '>' - - '>=' - - < - - <= - - OUTSIDE - - BETWEEN + - '>' + - '>=' + - < + - <= + - OUTSIDE + - BETWEEN thresholds: type: object additionalProperties: $ref: '#/components/schemas/ThresholdConfigRule' required: - - rule - - thresholdOperator - - thresholds + - 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. + 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: - - '>' - - '>=' - - < - - <= - - OUTSIDE - - BETWEEN + - '>' + - '>=' + - < + - <= + - OUTSIDE + - BETWEEN thresholds: type: object additionalProperties: $ref: '#/components/schemas/ThresholdConfigRule' required: - - rule - - thresholdOperator - - thresholds + - rule + - thresholdOperator + - thresholds RunConfiguration: type: object description: Action run configuration. @@ -40877,7 +42632,7 @@ components: $ref: '#/components/schemas/ActionConfiguration' minItems: 1 required: - - actions + - actions RunEvaluationResponse: type: object description: Response from running an evaluation @@ -40922,7 +42677,9 @@ components: description: List of tags associated with Service Levels Objective Configuration items: type: string - description: List of tags associated with Service Levels Objective Configuration + description: >- + List of tags associated with Service Levels Objective + Configuration target: type: number format: double @@ -40930,63 +42687,64 @@ components: exclusiveMaximum: false exclusiveMinimum: true maximum: 0.9999 - minimum: 0.0 + minimum: 0 timeWindow: $ref: '#/components/schemas/TimeWindow' required: - - entity - - indicator - - name - - tags - - target - - timeWindow + - 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' + - $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 + - 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' + - $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: @@ -40995,48 +42753,48 @@ components: operator: type: string enum: - - CONTAINS - - EQUALS - - GREATER_THAN - - GREATER_THAN_OR_EQUALS - - IS - - LESS_THAN - - LESS_THAN_OR_EQUALS - - MATCHES - - NOT_MATCHES + - CONTAINS + - EQUALS + - GREATER_THAN + - GREATER_THAN_OR_EQUALS + - IS + - LESS_THAN + - LESS_THAN_OR_EQUALS + - MATCHES + - NOT_MATCHES value: type: object required: - - key - - operator - - value + - key + - operator + - value SalesforceIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - bearerToken: - type: string - nullable: true - clientId: - type: string - minLength: 1 - nullable: true - clientSecret: - type: string - minLength: 1 - nullable: true - salesforceUrl: - type: string - minLength: 1 + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + bearerToken: + type: string + nullable: true + clientId: + type: string + minLength: 1 + nullable: true + clientSecret: + type: string + minLength: 1 + nullable: true + salesforceUrl: + type: string + minLength: 1 required: - - clientId - - clientSecret - - id - - kind - - name - - salesforceUrl + - clientId + - clientSecret + - id + - kind + - name + - salesforceUrl SamplingMetadata: type: object description: Metadata about sampling applied to infrastructure metrics query @@ -41052,7 +42810,8 @@ components: description: Number of unique groups that were not sampled samplingApplied: type: boolean - description: Whether sampling was actually applied (true if any groups were + description: >- + Whether sampling was actually applied (true if any groups were sampled) totalMembersAfter: type: integer @@ -41066,21 +42825,21 @@ components: SaturationBlueprintIndicator: type: object allOf: - - $ref: '#/components/schemas/ServiceLevelIndicator' - - type: object - properties: - metric: - $ref: '#/components/schemas/EntityMetric' - metricName: - type: string - threshold: - type: number - format: double - description: Threshold Value for the Blueprint - exclusiveMinimum: false - minimum: 0.0 + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + properties: + metric: + $ref: '#/components/schemas/EntityMetric' + metricName: + type: string + threshold: + type: number + format: double + description: Threshold Value for the Blueprint + exclusiveMinimum: false + minimum: 0 required: - - type + - type ScopeBinding: type: object nullable: true @@ -41101,13 +42860,13 @@ components: type: string description: Field context enum: - - entities - - events - - applications - - services - - endpoints - - appdata_shared - - default_field + - entities + - events + - applications + - services + - endpoints + - appdata_shared + - default_field example: Entity data, trace data, even data description: type: string @@ -41125,12 +42884,12 @@ components: type: string description: Term type enum: - - string - - long - - double - - bool - - key_value - - id + - string + - long + - double + - bool + - key_value + - id Service: type: object properties: @@ -41138,12 +42897,14 @@ components: type: string description: Since, this is a Service, it will be of type `SERVICE`. enum: - - APPLICATION - - SERVICE - - ENDPOINT + - APPLICATION + - SERVICE + - ENDPOINT id: type: string - description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.' + description: >- + Unique ID of the Service. Eg: + `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. minLength: 1 label: type: string @@ -41165,43 +42926,50 @@ components: 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.' + 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.' + 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 - - RPG - - DATABASE - - MESSAGING - - PAGE - - PAGE_RESOURCE + - UNDEFINED + - RPC + - EVENT + - GRAPHQL + - BATCH + - SHELL + - HTTP + - SDK + - OPENTELEMETRY + - INTERNAL + - RPG + - DATABASE + - MESSAGING + - PAGE + - PAGE_RESOURCE uniqueItems: true required: - - id - - label - - snapshotIds - - technologies - - types + - 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. + 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: @@ -41209,18 +42977,25 @@ components: description: If enabled, calls will be mapped to the rule. id: type: string - description: 'A unique string for the service configuration. Eg: `G510hmXYSDysLZ5kuj0BaQ`' + 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`. + 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 - in this field. + description: >- + Calls will be matched with the array of key-value tags present in + this field. items: $ref: '#/components/schemas/ServiceMatchingRule' maxItems: 20 @@ -41231,23 +43006,23 @@ components: maxLength: 128 minLength: 1 required: - - enabled - - id - - label - - matchSpecification - - name + - 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. + - $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: @@ -41262,11 +43037,12 @@ components: service: $ref: '#/components/schemas/Service' required: - - metrics - - service + - metrics + - service ServiceLevelIndicator: type: object - description: Indicator of the Service Levels Objective Configuration, it indicates + description: >- + Indicator of the Service Levels Objective Configuration, it indicates the type of metric by which the SLO should be evaluated discriminator: mapping: @@ -41282,48 +43058,48 @@ components: 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 + - 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 - - advanced-custom + - latency + - availability + - traffic + - saturation + - custom + - advanced-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 + - eventBased + - timeBased + - erroneous + - all threshold: type: number format: double @@ -41331,52 +43107,54 @@ components: type: type: string enum: - - eventBased - - timeBased + - 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 + - $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. + 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. + description: This is the list of channel IDs when alert triggered and sent to. minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true apdexIds: type: array - description: This is the list of Apdex configurations related to this alert + description: >- + This is the list of Apdex configurations related to this alert (mutually exclusive with sloIds). items: type: string - description: This is the list of Apdex configurations related to this - alert (mutually exclusive with sloIds). + description: >- + This is the list of Apdex configurations related to this alert + (mutually exclusive with sloIds). 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. + 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' nullable: true @@ -41385,16 +43163,16 @@ components: $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. + 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. + description: The description of the alert. It is also the alert message content. maxLength: 65536 minLength: 0 name: @@ -41407,8 +43185,9 @@ components: severity: type: integer format: int32 - description: 'This is the severity of the alert. The value can be: 5: - warning, 10: critical.' + 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. @@ -41425,50 +43204,50 @@ components: $ref: '#/components/schemas/ServiceLevelsTimeThreshold' triggering: type: boolean - description: Incident flag. If value is true, this alert will become an - accident. - required: - - alertChannelIds - - apdexIds - - customPayloadFields - - description - - name - - rule - - severity - - sloIds - - timeThreshold + description: Incident flag. If value is true, this alert will become an accident. + required: + - alertChannelIds + - apdexIds + - customPayloadFields + - description + - name + - rule + - severity + - sloIds + - timeThreshold ServiceLevelsAlertConfigWithRBACTag: type: object properties: alertChannelIds: type: array - description: This is the list of channel IDs when alert triggered and sent - to. + 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. + description: This is the list of channel IDs when alert triggered and sent to. minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true apdexIds: type: array - description: This is the list of Apdex configurations related to this alert + description: >- + This is the list of Apdex configurations related to this alert (mutually exclusive with sloIds). items: type: string - description: This is the list of Apdex configurations related to this - alert (mutually exclusive with sloIds). + description: >- + This is the list of Apdex configurations related to this alert + (mutually exclusive with sloIds). 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. + 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' nullable: true @@ -41478,26 +43257,28 @@ components: created: type: integer format: int64 - description: Created Date of the version of Service Levels Smart Alerts + 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. + 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. + 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 + description: >- + Boolean Parameter specifying the enabled state of Service Levels Smart Alerts Configuration. id: type: string @@ -41507,8 +43288,9 @@ components: initialCreated: type: integer format: int64 - description: Created Date of the Initial version of Service Levels Smart - Alerts Configuration. + description: >- + Created Date of the Initial version of Service Levels Smart Alerts + Configuration. minimum: 1 name: type: string @@ -41523,15 +43305,17 @@ components: uniqueItems: true readOnly: type: boolean - description: Boolean Parameter specifying the readonly access to Service - Levels Smart Alerts Configuration. + 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.' + 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. @@ -41548,23 +43332,23 @@ components: $ref: '#/components/schemas/ServiceLevelsTimeThreshold' triggering: type: boolean - description: Incident flag. If value is true, this alert will become an - accident. - required: - - alertChannelIds - - apdexIds - - customPayloadFields - - description - - id - - name - - rule - - severity - - sloIds - - timeThreshold + description: Incident flag. If value is true, this alert will become an accident. + required: + - alertChannelIds + - apdexIds + - customPayloadFields + - description + - id + - name + - rule + - severity + - sloIds + - timeThreshold ServiceLevelsAlertRule: type: object - description: This is the service levels alert type. It could be error budget - alert, service levels object alert, or Apdex alert. + description: >- + This is the service levels alert type. It could be error budget alert, + service levels object alert, or Apdex alert. discriminator: mapping: APDEX: '#/components/schemas/ApdexAlertRule' @@ -41575,22 +43359,24 @@ components: alertType: type: string required: - - alertType + - 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. + 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.' + 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 + - SINGLE + - LONG + - SHORT duration: type: integer format: int32 @@ -41599,24 +43385,23 @@ components: type: string description: Duration Unit Type of the Burn Rate Alerting Window. enum: - - millisecond - - second - - minute - - hour - - day - - week - - month + - millisecond + - second + - minute + - hour + - day + - week + - month threshold: $ref: '#/components/schemas/ServiceLevelsStaticThresholdConfig' required: - - duration - - durationUnitType - - threshold + - duration + - durationUnitType + - threshold ServiceLevelsBurnRateTimeWindows: type: object deprecated: true - description: This is the short and long time window setting for the burn rate - alerts. + description: This is the short and long time window setting for the burn rate alerts. nullable: true properties: longTimeWindow: @@ -41625,7 +43410,8 @@ components: $ref: '#/components/schemas/AlertingTimeWindow' ServiceLevelsStaticThresholdConfig: type: object - description: This threshold defines a static value to be evaluated with a specific + description: >- + This threshold defines a static value to be evaluated with a specific operator for burn rate v2 alerts. properties: lastUpdated: @@ -41635,68 +43421,72 @@ components: operator: type: string enum: - - '>' - - '>=' - - < - - <= - - OUTSIDE - - BETWEEN + - '>' + - '>=' + - < + - <= + - OUTSIDE + - BETWEEN value: type: number format: double minimum: 0 required: - - operator + - operator ServiceLevelsTimeThreshold: type: object - description: This is the warm-up and cool-down setting to emit or stop alert - event after threshold reached. + 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 + 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. + description: >- + This is the grace period when the threshold is reached and the alert + becomes active to emit notification. required: - - expiry - - timeWindow + - expiry + - timeWindow ServiceLevelseAlertConfigWithMetadata: type: object properties: alertChannelIds: type: array - description: This is the list of channel IDs when alert triggered and sent - to. + 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. + description: This is the list of channel IDs when alert triggered and sent to. minLength: 1 maxItems: 1024 minItems: 0 uniqueItems: true apdexIds: type: array - description: This is the list of Apdex configurations related to this alert + description: >- + This is the list of Apdex configurations related to this alert (mutually exclusive with sloIds). items: type: string - description: This is the list of Apdex configurations related to this - alert (mutually exclusive with sloIds). + description: >- + This is the list of Apdex configurations related to this alert + (mutually exclusive with sloIds). 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. + 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' nullable: true @@ -41706,26 +43496,28 @@ components: created: type: integer format: int64 - description: Created Date of the version of Service Levels Smart Alerts + 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. + 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. + 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 + description: >- + Boolean Parameter specifying the enabled state of Service Levels Smart Alerts Configuration. id: type: string @@ -41735,8 +43527,9 @@ components: initialCreated: type: integer format: int64 - description: Created Date of the Initial version of Service Levels Smart - Alerts Configuration. + description: >- + Created Date of the Initial version of Service Levels Smart Alerts + Configuration. minimum: 1 name: type: string @@ -41745,15 +43538,17 @@ components: minLength: 0 readOnly: type: boolean - description: Boolean Parameter specifying the readonly access to Service - Levels Smart Alerts Configuration. + 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.' + 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. @@ -41770,26 +43565,26 @@ components: $ref: '#/components/schemas/ServiceLevelsTimeThreshold' triggering: type: boolean - description: Incident flag. If value is true, this alert will become an - accident. - required: - - alertChannelIds - - apdexIds - - customPayloadFields - - description - - id - - name - - rule - - severity - - sloIds - - timeThreshold + description: Incident flag. If value is true, this alert will become an accident. + required: + - alertChannelIds + - apdexIds + - 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. + description: >- + A list which indicates which services are consumers and which are + providers in the communication chain. items: $ref: '#/components/schemas/ServiceMapConnection' uniqueItems: true @@ -41800,79 +43595,113 @@ components: $ref: '#/components/schemas/ExtendedService' uniqueItems: true required: - - connections - - services + - connections + - services ServiceMapConnection: type: object - description: A list which indicates which services are consumers and which are + 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" + description: > + The number of calls between the 2 services. + + Eg: The number of calls from + `24558242fdeb52571cfb9fa42f1b334aa65d7e61` service to + `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa` service over the + mentioned timeframe is `200`. + + + If no timeframe (`to` and `windowSize` in query paramter) is + mentioned, the timeframe is taken as last hour. 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" + description: > + The error rate of the calls between the 2 services. + + Eg: The error rate of calls from + `24558242fdeb52571cfb9fa42f1b334aa65d7e61` service to + `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa` service over the + mentioned timeframe is `0.1`. + + + The value is between 0 and 1. + + + If no timeframe (`to` and `windowSize` in query paramter) is + mentioned, the timeframe is taken as last hour. maximum: 1 minimum: 0 from: type: string - description: | + description: > The service that initiates a request to another service. - It contains a unique service id. Eg: `24558242fdeb52571cfb9fa42f1b334aa65d7e61`. + + It contains a unique service id. Eg: + `24558242fdeb52571cfb9fa42f1b334aa65d7e61`. minLength: 1 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" + description: > + The mean latency of the calls between the 2 services. + + Eg: The mean latency of calls from + `24558242fdeb52571cfb9fa42f1b334aa65d7e61` service to + `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa` service over the + mentioned timeframe is `4.46`. + + + The value is in milliseconds. + + + If no timeframe (`to` and `windowSize` in query paramter) is + mentioned, the timeframe is taken as last hour. minimum: 0 to: type: string - description: | + description: > The service that receives the request sent by the source service. - It contains a unique service id. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. + + It contains a unique service id. Eg: + `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. minLength: 1 required: - - from - - to + - from + - to ServiceMatchingRule: type: object - description: Calls will be matched with the array of key-value tags present - in this field. + description: >- + Calls will be matched with the array of key-value tags present in this + field. properties: key: type: string - description: | + description: > In Instana UI, this is shown as `Tag`. - One can select a variety of pre-defined tags. Eg: `host.fqdn`, `container.label` etc. + + One can select a variety of pre-defined tags. Eg: `host.fqdn`, + `container.label` etc. minLength: 1 value: type: string - description: | + 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`. + + 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 + - key + - value ServiceMetricResult: type: object properties: @@ -41896,7 +43725,7 @@ components: format: int64 minimum: 0 required: - - items + - items ServiceNode: type: object properties: @@ -41911,79 +43740,79 @@ components: maxLength: 64 minLength: 0 required: - - endpoints - - serviceId + - 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 - 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 + - $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 + 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 - - name - - password - - serviceNowUrl - - tenant - - unit - - username + - 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 - minLength: 1 - serviceNowUrl: - type: string - minLength: 1 - username: - type: string - minLength: 1 + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + autoCloseIncidents: + type: boolean + password: + type: string + minLength: 1 + serviceNowUrl: + type: string + minLength: 1 + username: + type: string + minLength: 1 required: - - id - - kind - - name - - password - - serviceNowUrl - - username + - id + - kind + - name + - password + - serviceNowUrl + - username ServiceResult: type: object properties: @@ -41994,8 +43823,9 @@ components: page: type: integer format: int32 - description: Page number you want to retrieve in a request / retrieved in - a response. + description: >- + Page number you want to retrieve in a request / retrieved in a + response. pageSize: type: integer format: int32 @@ -42003,8 +43833,9 @@ components: totalHits: type: integer format: int32 - description: 'The number of results returned. For eg: If `items` has 5 elements, - `totalhits` will be 5' + 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. @@ -42017,14 +43848,16 @@ components: scopedTo: $ref: '#/components/schemas/ServiceScopedTo' required: - - name + - 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`.' + description: >- + Unique ID of the Service. Eg: + `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. minLength: 1 name: type: string @@ -42033,7 +43866,7 @@ components: scopedTo: $ref: '#/components/schemas/ServiceScopedToWithMetadata' required: - - id + - id ServiceScopedTo: type: object description: 'The list of application perspectives where the service is present. ' @@ -42046,30 +43879,32 @@ components: maxItems: 10 minItems: 1 required: - - applications + - applications ServiceScopedToWithMetadata: type: object - description: The release marker would be present in the service but not for - other services within the Application perspective. + description: >- + The release marker would be present in the service but not for other + services within the Application perspective. nullable: true properties: applications: type: array - description: 'The list of application perspectives where the service is - present. ' + description: 'The list of application perspectives where the service is present. ' items: $ref: '#/components/schemas/ApplicationScopeWithMetadata' maxItems: 10 minItems: 1 required: - - applications + - applications ServiceSimple: type: object description: The destination service. properties: id: type: string - description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.' + description: >- + Unique ID of the Service. Eg: + `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. label: type: string description: 'Name of the Service. Eg: `payment`.' @@ -42089,7 +43924,8 @@ components: imageData: type: string description: Base64-encoded image data loaded from external storage - example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg== + example: >- + iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg== nullable: true imageFormat: type: string @@ -42109,26 +43945,28 @@ components: description: Type of record example: screenshot required: - - bytesIngestedImage - - id - - imageFormat - - sessionId - - timestamp - - type + - bytesIngestedImage + - id + - imageFormat + - sessionId + - timestamp + - type SessionReplayTimestamps: type: object properties: firstImageTimestamp: type: integer format: int64 - description: Timestamp of the first image in the session (epoch milliseconds). + description: >- + Timestamp of the first image in the session (epoch milliseconds). Null if no images exist. example: 1234567890 nullable: true lastImageTimestamp: type: integer format: int64 - description: Timestamp of the last image in the session (epoch milliseconds). + description: >- + Timestamp of the last image in the session (epoch milliseconds). Null if no images exist. example: 1234567990 nullable: true @@ -42151,43 +43989,43 @@ components: 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 + - 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 + - SUM + - MEAN + - MAX + - MIN + - P25 + - P50 + - P75 + - P90 + - P95 + - P98 + - P99 + - P99_9 + - P99_99 + - DISTINCT_COUNT + - SUM_POSITIVE + - PER_SECOND + - INCREASE nullable: true granularity: type: integer @@ -42212,30 +44050,30 @@ components: type: boolean description: When true, metric must be present with values required: - - aggregation - - metric + - aggregation + - metric SlackIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - channel: - type: string - nullable: true - emojiRendering: - type: boolean - iconUrl: - type: string - nullable: true - webhookUrl: - type: string - minLength: 1 + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + channel: + type: string + nullable: true + emojiRendering: + type: boolean + iconUrl: + type: string + nullable: true + webhookUrl: + type: string + minLength: 1 required: - - id - - kind - - name - - webhookUrl + - id + - kind + - name + - webhookUrl SliConfiguration: type: object properties: @@ -42254,14 +44092,15 @@ components: $ref: '#/components/schemas/SliEntity' sliName: type: string - description: The name of the Service Level Indicator (SLI) specified during - its creation + description: >- + The name of the Service Level Indicator (SLI) specified during its + creation maxLength: 256 minLength: 0 required: - - id - - sliEntity - - sliName + - id + - sliEntity + - sliName SliConfigurationWithLastUpdated: type: object properties: @@ -42285,14 +44124,15 @@ components: $ref: '#/components/schemas/SliEntity' sliName: type: string - description: The name of the Service Level Indicator (SLI) specified during - its creation + description: >- + The name of the Service Level Indicator (SLI) specified during its + creation maxLength: 256 minLength: 0 required: - - id - - sliEntity - - sliName + - id + - sliEntity + - sliName SliEntity: type: object description: Entity Type of the SLI Configuration @@ -42307,14 +44147,15 @@ components: sliType: type: string required: - - sliType + - sliType SliReport: type: object properties: errorBudgetRemaining: type: integer format: int64 - description: This is the error budget remaining compared to the total error + description: >- + This is the error budget remaining compared to the total error budget fromTimestamp: type: integer @@ -42323,13 +44164,15 @@ components: sli: type: number format: double - description: 'Service Level Indicator: This indicates the actual performance - measure of the service' + 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' + description: >- + Service Level Objective: This is the target value that should be met + by the SLI toTimestamp: type: integer format: int64 @@ -42345,8 +44188,9 @@ components: format: int32 SloEntity: type: object - description: Entity of the Service Levels Objective Configuration, it could - be either Application nor Website + description: >- + Entity of the Service Levels Objective Configuration, it could be either + Application nor Website discriminator: mapping: application: '#/components/schemas/ApplicationSloEntity' @@ -42361,7 +44205,7 @@ components: type: type: string required: - - type + - type SloReport: type: object properties: @@ -42370,18 +44214,22 @@ components: 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 + 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 + 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 + description: >- + Error Budget Remain value of SLO configuration in different timestamps from starting to ending point errorBudgetRemaining: type: integer @@ -42400,24 +44248,30 @@ components: additionalProperties: type: integer format: int32 - description: Budget Rate value of SLO configuration in different timestamps + 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 + 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 + 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 + description: >- + Starting point of the data retrieval, specified as 13 digit Unix + Timestamp milliseconds sli: type: number format: double @@ -42429,7 +44283,8 @@ components: toTimestamp: type: integer format: int64 - description: Ending point of the data retrieval, specified as 13 digit Unix + description: >- + Ending point of the data retrieval, specified as 13 digit Unix Timestamp milliseconds totalErrorBudget: type: integer @@ -42440,31 +44295,33 @@ components: additionalProperties: type: integer format: int32 - description: Value indicating violation of SLO configuration in different + description: >- + Value indicating violation of SLO configuration in different timestamps from starting to ending point - description: Value indicating violation of SLO configuration in different + description: >- + Value indicating violation of SLO configuration in different timestamps from starting to ending point SlownessApplicationAlertRule: type: object allOf: - - $ref: '#/components/schemas/ApplicationAlertRule' + - $ref: '#/components/schemas/ApplicationAlertRule' required: - - aggregation - - metricName + - aggregation + - metricName SlownessMobileAppAlertRule: type: object allOf: - - $ref: '#/components/schemas/MobileAppAlertRule' + - $ref: '#/components/schemas/MobileAppAlertRule' required: - - aggregation - - metricName + - aggregation + - metricName SlownessWebsiteAlertRule: type: object allOf: - - $ref: '#/components/schemas/WebsiteAlertRule' + - $ref: '#/components/schemas/WebsiteAlertRule' required: - - aggregation - - metricName + - aggregation + - metricName SnapshotItem: type: object description: Detail information for requested snapshots. @@ -42508,15 +44365,18 @@ components: 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. + 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. nullable: true id: type: string - description: This is a snapshot ID. A unique identifier the metrics are - assigned to. + description: >- + This is a snapshot ID. A unique identifier the metrics are assigned + to. minLength: 1 label: type: string @@ -42527,11 +44387,12 @@ components: time: type: integer format: int64 - description: Specifies the exact point at which the id, label and plugin - are valid. + description: >- + Specifies the exact point at which the id, label and plugin are + valid. minimum: 1 required: - - id + - id SnapshotResult: type: object properties: @@ -42560,10 +44421,10 @@ components: discoveryType: type: string enum: - - NATIVE_SENSOR - - REMOTE_SENSOR - - PACKAGE_MANAGER - - OTHER + - NATIVE_SENSOR + - REMOTE_SENSOR + - PACKAGE_MANAGER + - OTHER metadata: type: object additionalProperties: @@ -42577,17 +44438,17 @@ components: softwareType: type: string enum: - - DEPENDENCY - - RUNTIME - - DATABASE - - MESSAGING - - PLATFORM - - PACKAGE - - OS - - CACHE - - API_GATEWAY - - OTHER - - APPLICATION_FRAMEWORK + - DEPENDENCY + - RUNTIME + - DATABASE + - MESSAGING + - PLATFORM + - PACKAGE + - OS + - CACHE + - API_GATEWAY + - OTHER + - APPLICATION_FRAMEWORK minLength: 1 usedBy: type: array @@ -42601,13 +44462,13 @@ components: type: string minLength: 1 required: - - discoveryType - - name - - plugin - - softwareType - - usedBy - - vendor - - version + - discoveryType + - name + - plugin + - softwareType + - usedBy + - vendor + - version SourceMapFileBlob: type: object properties: @@ -42641,17 +44502,17 @@ components: type: type: string enum: - - JS_MAP - - JS - - R8PG_MAP - - DWARF + - JS_MAP + - JS + - R8PG_MAP + - DWARF url: type: string minLength: 1 required: - - format - - type - - url + - format + - type + - url SourceMapUploadConfig: type: object properties: @@ -42673,7 +44534,7 @@ components: type: string format: date-time required: - - metadata + - metadata SourceMapUploadConfigs: type: object properties: @@ -42689,7 +44550,7 @@ components: maxItems: 1024 minItems: 0 required: - - configs + - configs SpanExcerpt: type: object description: Information about the logs attached to the call, if available. @@ -42698,11 +44559,13 @@ components: 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, + 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, + 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 @@ -42711,15 +44574,17 @@ components: 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. + 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 + description: >- + Represents whether the span is erroneous or not. 0 is not erroneous and 1 is erroneous. minimum: 0 foreignParentId: @@ -42727,62 +44592,80 @@ components: nullable: true id: type: string - description: 'The call ID. A unique identifier for an individual call. For - example: `1bcad5c82338deaf`.' + description: >- + The call ID. A unique identifier for an individual call. For + example: `1bcad5c82338deaf`. kind: type: string - description: | + 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. + + 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 + - UNKNOWN + - ENTRY + - EXIT + - INTERMEDIATE name: type: string - description: The technical type of the span. For example, `node.http.client` - or `jdbc`. + 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 + description: >- + The parent call id, referring to another call in the same trace which triggered the processing associated with this call. nullable: true samplingRate: type: number format: double - description: The probability at which this span was sampled by the tracer. - Only present if the span was subjected to sampling. + description: >- + The probability at which this span was sampled by the tracer. Only + present if the span was subjected to sampling. nullable: true 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. + 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` + 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 + - data + - id + - kind + - name + - stackTrace SpanRelation: type: object - description: | - It shows from where the call is destined to. It includes the following information: + 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. nullable: true properties: @@ -42798,63 +44681,64 @@ components: service: $ref: '#/components/schemas/Service' required: - - applications + - applications SpecificJsErrorsWebsiteAlertRule: type: object allOf: - - $ref: '#/components/schemas/WebsiteAlertRule' - - type: object - properties: - operator: - type: string - enum: - - EQUALS - - CONTAINS - - IN - - NOT_IN - - 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 - nullable: true + - $ref: '#/components/schemas/WebsiteAlertRule' + - type: object + properties: + operator: + type: string + enum: + - EQUALS + - CONTAINS + - IN + - NOT_IN + - 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 + nullable: true required: - - metricName - - operator + - metricName + - operator SplunkIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - token: - type: string - minLength: 1 - url: - type: string - minLength: 1 + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + token: + type: string + minLength: 1 + url: + type: string + minLength: 1 required: - - id - - kind - - name - - token - - url + - 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. + 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 @@ -42866,8 +44750,9 @@ components: nullable: true method: type: string - description: The name of the method or function being executed at the time - the stack trace item was generated. + description: >- + The name of the method or function being executed at the time the + stack trace item was generated. nullable: true StackTraceLine: type: object @@ -42894,191 +44779,192 @@ components: format: int32 minimum: -1 required: - - file + - file StaticBaselineThresholdRule: type: object allOf: - - $ref: '#/components/schemas/ThresholdConfigRule' - - type: object - properties: - baseline: - type: array - items: + - $ref: '#/components/schemas/ThresholdConfigRule' + - type: object + properties: + baseline: type: array items: - type: number - nullable: true - deviationFactor: - type: number - format: double - exclusiveMaximum: false - exclusiveMinimum: false - maximum: 16.0 - minimum: 0.5 - seasonality: - type: string - enum: - - WEEKLY - - DAILY + type: array + items: + type: number + nullable: true + deviationFactor: + type: number + format: double + exclusiveMaximum: false + exclusiveMinimum: false + maximum: 16 + minimum: 0.5 + seasonality: + type: string + enum: + - WEEKLY + - DAILY required: - - seasonality + - seasonality StaticStringField: type: object allOf: - - $ref: '#/components/schemas/CustomPayloadField' - - type: object - properties: - value: - type: string - description: Custom value for static type custom payload - minLength: 1 + - $ref: '#/components/schemas/CustomPayloadField' + - type: object + properties: + value: + type: string + description: Custom value for static type custom payload + minLength: 1 required: - - key - - value + - key + - value StaticThreshold: type: object allOf: - - $ref: '#/components/schemas/Threshold' - - type: object - properties: - lastUpdated: - type: integer - format: int64 - minimum: 0 - lowerBound: - type: number - format: double - minimum: 0 - nullable: true - upperBound: - type: number - format: double - minimum: 0 - nullable: true - value: - type: number - format: double - minimum: 0 - nullable: true - description: This threshold defines a static value to be evaluated with a specific + - $ref: '#/components/schemas/Threshold' + - type: object + properties: + lastUpdated: + type: integer + format: int64 + minimum: 0 + lowerBound: + type: number + format: double + minimum: 0 + nullable: true + upperBound: + type: number + format: double + minimum: 0 + nullable: true + value: + type: number + format: double + minimum: 0 + nullable: true + description: >- + This threshold defines a static value to be evaluated with a specific operator. required: - - operator + - operator StaticThresholdRule: type: object allOf: - - $ref: '#/components/schemas/ThresholdConfigRule' - - type: object - properties: - lowerBound: - type: number - format: double - minimum: 0 - nullable: true - upperBound: - type: number - format: double - minimum: 0 - nullable: true - value: - type: number - format: double - minimum: 0 - nullable: true + - $ref: '#/components/schemas/ThresholdConfigRule' + - type: object + properties: + lowerBound: + type: number + format: double + minimum: 0 + nullable: true + upperBound: + type: number + format: double + minimum: 0 + nullable: true + value: + type: number + format: double + minimum: 0 + nullable: true StatusCodeApplicationAlertRule: type: object allOf: - - $ref: '#/components/schemas/ApplicationAlertRule' - - type: object - properties: - metricName: - type: string - minLength: 1 - nullable: true - statusCodeEnd: - type: integer - format: int32 - minimum: 1 - statusCodeStart: - type: integer - format: int32 - minimum: 1 - required: - - metricName + - $ref: '#/components/schemas/ApplicationAlertRule' + - type: object + properties: + metricName: + type: string + minLength: 1 + nullable: true + 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: - metricName: - type: string - minLength: 1 - nullable: true - operator: - type: string - enum: - - EQUALS - - CONTAINS - - IN - - NOT_IN - - 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 - minLength: 1 + - $ref: '#/components/schemas/MobileAppAlertRule' + - type: object + properties: + metricName: + type: string + minLength: 1 + nullable: true + operator: + type: string + enum: + - EQUALS + - CONTAINS + - IN + - NOT_IN + - 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 + minLength: 1 required: - - metricName - - operator - - value + - metricName + - operator + - value StatusCodeWebsiteAlertRule: type: object allOf: - - $ref: '#/components/schemas/WebsiteAlertRule' - - type: object - properties: - operator: - type: string - enum: - - EQUALS - - CONTAINS - - IN - - NOT_IN - - 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 - minLength: 1 + - $ref: '#/components/schemas/WebsiteAlertRule' + - type: object + properties: + operator: + type: string + enum: + - EQUALS + - CONTAINS + - IN + - NOT_IN + - 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 + minLength: 1 required: - - metricName - - operator - - value + - metricName + - operator + - value SyntheticAlertConfig: type: object properties: @@ -43090,60 +44976,67 @@ components: nullable: true alertChannelIds: type: array - description: List of IDs of alert channels defined in Instana. Can be left - empty. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 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. + 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. + 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 evaluationType: type: string - description: Determines whether synthetic test results are evaluated per - location independently or grouped across all locations. + description: >- + Determines whether synthetic test results are evaluated per location + independently or grouped across all locations. enum: - - PER_LOCATION - - PER_SYNTHETIC_TEST + - PER_LOCATION + - PER_SYNTHETIC_TEST nullable: true 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 + 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. nullable: true includeOnDemand: type: boolean - description: 'Controls whether on-demand synthetic test runs should be included - in alert evaluation. When true, both scheduled and on-demand test runs - are evaluated. When false, only scheduled test runs are evaluated. Default - behavior when not provided: (1) If tagFilterExpression contains RUN_TYPE - filter that is NOT ''Scheduled'' → defaults to true; (2) If tagFilterExpression - contains RUN_TYPE EQUALS ''Scheduled'' → defaults to false; (3) If no - RUN_TYPE filter exists → defaults to false.' + description: >- + Controls whether on-demand synthetic test runs should be included in + alert evaluation. When true, both scheduled and on-demand test runs + are evaluated. When false, only scheduled test runs are evaluated. + Default behavior when not provided: (1) If tagFilterExpression + contains RUN_TYPE filter that is NOT 'Scheduled' → defaults to true; + (2) If tagFilterExpression contains RUN_TYPE EQUALS 'Scheduled' → + defaults to false; (3) If no RUN_TYPE filter exists → defaults to + false. nullable: true 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 + 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 @@ -43152,32 +45045,35 @@ components: severity: type: integer format: int32 - description: The severity of the alert when triggered, which is either 5 + 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. + 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. + 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 + - alertChannelIds + - customPayloadFields + - description + - name + - rule + - syntheticTestIds + - tagFilterExpression + - timeThreshold SyntheticAlertConfigWithMetadata: type: object properties: @@ -43189,12 +45085,12 @@ components: nullable: true alertChannelIds: type: array - description: List of IDs of alert channels defined in Instana. Can be left - empty. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -43206,17 +45102,19 @@ components: minimum: 1 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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. + 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: @@ -43224,17 +45122,19 @@ components: description: Flag to indicate whether or not the configuration is enabled. evaluationType: type: string - description: Determines whether synthetic test results are evaluated per - location independently or grouped across all locations. + description: >- + Determines whether synthetic test results are evaluated per location + independently or grouped across all locations. enum: - - PER_LOCATION - - PER_SYNTHETIC_TEST + - PER_LOCATION + - PER_SYNTHETIC_TEST nullable: true 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 + 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. nullable: true id: @@ -43244,13 +45144,15 @@ components: minLength: 0 includeOnDemand: type: boolean - description: 'Controls whether on-demand synthetic test runs should be included - in alert evaluation. When true, both scheduled and on-demand test runs - are evaluated. When false, only scheduled test runs are evaluated. Default - behavior when not provided: (1) If tagFilterExpression contains RUN_TYPE - filter that is NOT ''Scheduled'' → defaults to true; (2) If tagFilterExpression - contains RUN_TYPE EQUALS ''Scheduled'' → defaults to false; (3) If no - RUN_TYPE filter exists → defaults to false.' + description: >- + Controls whether on-demand synthetic test runs should be included in + alert evaluation. When true, both scheduled and on-demand test runs + are evaluated. When false, only scheduled test runs are evaluated. + Default behavior when not provided: (1) If tagFilterExpression + contains RUN_TYPE filter that is NOT 'Scheduled' → defaults to true; + (2) If tagFilterExpression contains RUN_TYPE EQUALS 'Scheduled' → + defaults to false; (3) If no RUN_TYPE filter exists → defaults to + false. nullable: true initialCreated: type: integer @@ -43259,47 +45161,52 @@ components: 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 + 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. + 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 + 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. + 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. + 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 + - alertChannelIds + - customPayloadFields + - description + - id + - name + - rule + - syntheticTestIds + - tagFilterExpression + - timeThreshold SyntheticAlertConfigWithRBACTag: type: object properties: @@ -43311,12 +45218,12 @@ components: nullable: true alertChannelIds: type: array - description: List of IDs of alert channels defined in Instana. Can be left - empty. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -43328,17 +45235,19 @@ components: minimum: 1 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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. + 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: @@ -43346,17 +45255,19 @@ components: description: Flag to indicate whether or not the configuration is enabled. evaluationType: type: string - description: Determines whether synthetic test results are evaluated per - location independently or grouped across all locations. + description: >- + Determines whether synthetic test results are evaluated per location + independently or grouped across all locations. enum: - - PER_LOCATION - - PER_SYNTHETIC_TEST + - PER_LOCATION + - PER_SYNTHETIC_TEST nullable: true 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 + 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. nullable: true id: @@ -43366,13 +45277,15 @@ components: minLength: 0 includeOnDemand: type: boolean - description: 'Controls whether on-demand synthetic test runs should be included - in alert evaluation. When true, both scheduled and on-demand test runs - are evaluated. When false, only scheduled test runs are evaluated. Default - behavior when not provided: (1) If tagFilterExpression contains RUN_TYPE - filter that is NOT ''Scheduled'' → defaults to true; (2) If tagFilterExpression - contains RUN_TYPE EQUALS ''Scheduled'' → defaults to false; (3) If no - RUN_TYPE filter exists → defaults to false.' + description: >- + Controls whether on-demand synthetic test runs should be included in + alert evaluation. When true, both scheduled and on-demand test runs + are evaluated. When false, only scheduled test runs are evaluated. + Default behavior when not provided: (1) If tagFilterExpression + contains RUN_TYPE filter that is NOT 'Scheduled' → defaults to true; + (2) If tagFilterExpression contains RUN_TYPE EQUALS 'Scheduled' → + defaults to false; (3) If no RUN_TYPE filter exists → defaults to + false. nullable: true initialCreated: type: integer @@ -43381,8 +45294,9 @@ components: 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 + 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 @@ -43394,40 +45308,44 @@ components: uniqueItems: true readOnly: type: boolean - description: Flag to indicate whether or not the configuration is read-only. + 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 + 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. + 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. + 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 + - alertChannelIds + - customPayloadFields + - description + - id + - name + - rule + - syntheticTestIds + - tagFilterExpression + - timeThreshold SyntheticAlertRule: type: object description: Indicates the type of rule this alert configuration is about. @@ -43439,31 +45357,31 @@ components: 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 + - 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 minLength: 1 required: - - alertType - - metricName + - alertType + - metricName SyntheticBulkResponse: type: object properties: @@ -43478,33 +45396,36 @@ components: properties: customRules: type: array - description: The list of custom rules for synthetic endpoints defined by - the user. + 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. + description: >- + A flag to enable/disable the default synthetic endpoint + configurations defined by Instana. required: - - customRules + - customRules SyntheticCallRule: type: object - description: The list of custom rules for synthetic endpoints defined by the - user. + 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. + 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. + description: >- + A flag to enable/disable the custom synthetic endpoint + configurations defined by the user. matchSpecification: $ref: '#/components/schemas/MatchExpressionDTO' name: @@ -43513,15 +45434,16 @@ components: maxLength: 128 minLength: 1 required: - - matchSpecification - - name + - matchSpecification + - name SyntheticCallWithDefaultsConfig: type: object properties: customRules: type: array - description: The list of custom rules for synthetic endpoints defined by - the user. + description: >- + The list of custom rules for synthetic endpoints defined by the + user. items: $ref: '#/components/schemas/SyntheticCallRule' maxItems: 500 @@ -43532,11 +45454,12 @@ components: $ref: '#/components/schemas/SyntheticCallRule' defaultRulesEnabled: type: boolean - description: A flag to enable/disable the default synthetic endpoint configurations - defined by Instana. + description: >- + A flag to enable/disable the default synthetic endpoint + configurations defined by Instana. required: - - customRules - - defaultRules + - customRules + - defaultRules SyntheticConfiguration: type: object properties: @@ -43631,8 +45554,8 @@ components: items: type: string required: - - credentialName - - credentialValue + - credentialName + - credentialValue SyntheticDatacenter: type: object properties: @@ -43673,11 +45596,11 @@ components: status: type: string required: - - cityName - - code - - countryName - - label - - provider + - cityName + - code + - countryName + - label + - provider SyntheticDatacenterConfiguration: type: object properties: @@ -43699,10 +45622,10 @@ components: type: number format: double required: - - cityName - - countryName - - latitude - - longitude + - cityName + - countryName + - latitude + - longitude SyntheticLocation: type: object properties: @@ -43753,10 +45676,10 @@ components: type: integer format: int32 required: - - geoPoint - - label - - locationType - - playbackCapabilities + - geoPoint + - label + - locationType + - playbackCapabilities SyntheticLocationConfiguration: type: object properties: @@ -43767,56 +45690,57 @@ components: tenantType: type: string enum: - - Multi - - Single + - Multi + - Single SyntheticMetricConfiguration: type: object properties: aggregation: type: string - description: 'Set aggregation that can be applied to a series of values. - Eg: `MEAN`.' + 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 + - 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' + description: >- + If the granularity is set you will get data points with the + specified granularity in seconds. Default: `1000` milliseconds nullable: true metric: type: string description: 'Set a particular metric, eg: `latency`.' minLength: 1 required: - - aggregation - - metric + - aggregation + - metric SyntheticMetricTagGroup: type: object - description: ' Grouping of data under `groupbyTag`, where `groupbyTagEntity` - and `groupbyTagSecondLevelKey` are aspects of `groupbyTag`.' + description: ' Grouping of data under `groupbyTag`, where `groupbyTagEntity` and `groupbyTagSecondLevelKey` are aspects of `groupbyTag`.' properties: direction: type: string enum: - - ASC - - DESC + - ASC + - DESC groupbyTag: type: string description: The name of the group tag (e.g. `agent.tag` or `docker.label`). @@ -43824,19 +45748,29 @@ components: minLength: 0 groupbyTagEntity: type: string - description: | + description: > The entity by which the data should be grouped. - This field supports three possible values: `NOT_APPLICABLE`, `DESTINATION`, and `SOURCE`. + + 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). + + `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 + - NOT_APPLICABLE + - DESTINATION + - SOURCE groupbyTagSecondLevelKey: type: string - description: If present, it's the 2nd level key part (e.g. `customKey` on + description: >- + If present, it's the 2nd level key part (e.g. `customKey` on `docker.label.customKey`) maxLength: 256 minLength: 0 @@ -43849,9 +45783,9 @@ components: maximum: 50 minimum: 1 required: - - direction - - groupbyTag - - groupbyTagEntity + - direction + - groupbyTag + - groupbyTagEntity SyntheticPlaybackCapabilities: type: object properties: @@ -43860,28 +45794,28 @@ components: items: type: string enum: - - chrome - - firefox + - chrome + - firefox executionType: type: array items: type: string enum: - - CI/CD + - CI/CD extensions: type: array items: type: string enum: - - GitHub - - PW + - GitHub + - PW syntheticType: type: array items: type: string required: - - browserType - - syntheticType + - browserType + - syntheticType SyntheticResourceUpdateListDNSFilterTargetValueListDNSFilterTargetValue: type: object properties: @@ -43940,20 +45874,20 @@ components: 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 + - $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 ' - nullable: true - uniqueItems: true + items: + type: string + description: 'List of Unique Synthetic Tests IDs ' + nullable: true + uniqueItems: true SyntheticTest: type: object properties: @@ -44040,8 +45974,8 @@ components: playbackMode: type: string enum: - - Simultaneous - - Staggered + - Simultaneous + - Staggered rbacTags: type: array items: @@ -44065,11 +45999,11 @@ components: items: type: string required: - - active - - configuration - - label - - locations - - testFrequency + - active + - configuration + - label + - locations + - testFrequency SyntheticTestCICD: type: object properties: @@ -44080,8 +46014,8 @@ components: testId: type: string required: - - customization - - testId + - customization + - testId SyntheticTestCICDCustomization: type: object properties: @@ -44096,7 +46030,7 @@ components: items: type: string required: - - configuration + - configuration SyntheticTestCICDItem: type: object properties: @@ -44131,14 +46065,14 @@ components: items: type: string required: - - completed - - customization - - locationId - - locationLabel - - testId - - testLabel - - testResultId - - testType + - completed + - customization + - locationId + - locationLabel + - testId + - testLabel + - testResultId + - testType SyntheticTestCICDResponse: type: object properties: @@ -44149,32 +46083,33 @@ components: testResultId: type: string required: - - locationId - - testId - - testResultId + - locationId + - testId + - testResultId SyntheticTestDeepUpdate: type: object allOf: - - $ref: '#/components/schemas/SyntheticTestUpdate' - - type: object - properties: - configuration: - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - $ref: '#/components/schemas/SyntheticTestUpdate' + - type: object + properties: + configuration: + $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' required: - - syntheticUpdateType + - syntheticUpdateType SyntheticTestShallowUpdate: type: object allOf: - - $ref: '#/components/schemas/SyntheticTestUpdate' - - type: object - properties: - configuration: - $ref: '#/components/schemas/SyntheticConfigurationUpdate' + - $ref: '#/components/schemas/SyntheticTestUpdate' + - type: object + properties: + configuration: + $ref: '#/components/schemas/SyntheticConfigurationUpdate' required: - - syntheticUpdateType + - syntheticUpdateType SyntheticTestUpdate: type: object - description: Identifies the type of the synthetic tests updated on this request. + description: >- + Identifies the type of the synthetic tests updated on this request. Valid types are Deep and Shallow. discriminator: mapping: @@ -44187,7 +46122,8 @@ components: applications: $ref: '#/components/schemas/SyntheticResourceUpdateListStringListString' customProperties: - $ref: '#/components/schemas/SyntheticResourceUpdateMapStringStringListString' + $ref: >- + #/components/schemas/SyntheticResourceUpdateMapStringStringListString ids: type: array items: @@ -44209,13 +46145,17 @@ components: 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 + 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 + - Deep + - Shallow testFrequency: type: integer format: int32 @@ -44224,11 +46164,12 @@ components: websites: $ref: '#/components/schemas/SyntheticResourceUpdateListStringListString' required: - - syntheticUpdateType + - syntheticUpdateType SyntheticTimeThreshold: type: object - description: The type of threshold to define the criteria when the event and - alert triggers and resolves. + description: >- + The type of threshold to define the criteria when the event and alert + triggers and resolves. discriminator: mapping: violationsInSequence: '#/components/schemas/ViolationsInSequenceSyntheticTimeThreshold' @@ -44242,12 +46183,15 @@ components: maximum: 12 minimum: 1 required: - - type + - type SyntheticTypeConfiguration: type: object - description: |- - Synthetic test configuration that is unique to a synthetic type. Valid types are BrowserScript, - DNS, ICMP, HTTPAction, HTTPScript, SSLCertificate, WebpageAction, and WebpageScript. + description: >- + Synthetic test configuration that is unique to a synthetic type. Valid + types are BrowserScript, + + DNS, ICMP, HTTPAction, HTTPScript, SSLCertificate, WebpageAction, and + WebpageScript. discriminator: mapping: BrowserScript: '#/components/schemas/BrowserScriptConfiguration' @@ -44276,25 +46220,28 @@ components: syntheticType: type: string enum: - - BrowserScript - - DNS - - HTTPAction - - HTTPScript - - ICMP - - SSLCertificate - - WebpageAction - - WebpageScript - - NotConfigured + - BrowserScript + - DNS + - HTTPAction + - HTTPScript + - ICMP + - SSLCertificate + - WebpageAction + - WebpageScript + - NotConfigured timeout: type: string required: - - markSyntheticCall - - syntheticType + - markSyntheticCall + - syntheticType SyntheticTypeConfigurationUpdate: type: object - description: |- - Synthetic test configuration that is unique to a synthetic type. Valid types are BrowserScript, - DNS, HTTPAction, HTTPScript, ICMP, SSLCertificate, WebpageAction, and WebpageScript. + description: >- + Synthetic test configuration that is unique to a synthetic type. Valid + types are BrowserScript, + + DNS, HTTPAction, HTTPScript, ICMP, SSLCertificate, WebpageAction, and + WebpageScript. discriminator: mapping: BrowserScript: '#/components/schemas/BrowserScriptConfigurationUpdate' @@ -44322,55 +46269,55 @@ components: syntheticTest: type: string enum: - - BrowserScript - - DNS - - HTTPAction - - HTTPScript - - ICMP - - SSLCertificate - - WebpageAction - - WebpageScript - - NotConfigured + - BrowserScript + - DNS + - HTTPAction + - HTTPScript + - ICMP + - SSLCertificate + - WebpageAction + - WebpageScript + - NotConfigured writeOnly: true syntheticType: type: string enum: - - BrowserScript - - DNS - - HTTPAction - - HTTPScript - - ICMP - - SSLCertificate - - WebpageAction - - WebpageScript - - NotConfigured + - BrowserScript + - DNS + - HTTPAction + - HTTPScript + - ICMP + - 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 + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + locationIds: + type: array description: IDs of the locations. - syntheticTestId: - type: string - description: ID of the synthetic test. + 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 + - $ref: '#/components/schemas/AbstractRule' + - type: object + properties: + systemRuleId: + type: string required: - - systemRuleId + - systemRuleId SystemRuleLabel: type: object properties: @@ -44380,13 +46327,15 @@ components: name: type: string required: - - id - - name + - id + - name Tag: type: object - description: | + 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. + + Consider these tags as attributes of a tagTree. Eg: `Call` tagTree has + have `Erroneous`, `Call name`, `Latency` etc as attributes. properties: aliases: type: array @@ -44406,45 +46355,51 @@ components: 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 + - 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: | + 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`. + + 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: | + 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`. + + 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. nullable: true idTag: type: boolean - description: | + 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. + + Eg: `idTag` for `endpoint.id` is true but for `call.rpc.method` it + is false. nullable: true label: type: string @@ -44458,20 +46413,19 @@ components: minLength: 1 type: type: string - description: 'The data type of the tag. Eg: `call.name` accepts `STRING` - value.' + 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 + - BOOLEAN + - STRING + - NUMBER + - STRING_SET + - STRING_LIST + - KEY_VALUE_PAIR + - FLOAT_LIST + - KEY_NUMBER_PAIR + required: + - name + - type TagCatalog: type: object properties: @@ -44483,102 +46437,108 @@ components: $ref: '#/components/schemas/DynamicTag' 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. + 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' minItems: 1 tags: type: array - description: | + 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. + + 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 + - 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 - nullable: true - name: - type: string - description: Name of the tag. - maxLength: 128 - minLength: 0 - operator: - type: string - enum: - - EQUALS - - CONTAINS - - IN - - NOT_IN - - 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. - nullable: true + - $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 + nullable: true + name: + type: string + description: Name of the tag. + maxLength: 128 + minLength: 0 + operator: + type: string + enum: + - EQUALS + - CONTAINS + - IN + - NOT_IN + - 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. + nullable: true required: - - entity - - name - - operator + - 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 + - $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 + - elements + - logicalOperator TagFilterExpressionElement: type: object - description: Boolean expression of tag filters to define the scope of relevant - calls. + description: Boolean expression of tag filters to define the scope of relevant calls. discriminator: mapping: EXPRESSION: '#/components/schemas/TagFilterExpression' @@ -44589,54 +46549,57 @@ components: type: type: string required: - - type + - type TagMatcherDTO: type: object allOf: - - $ref: '#/components/schemas/MatchExpressionDTO' - - type: object - properties: - entity: - type: string - enum: - - NOT_APPLICABLE - - DESTINATION - - SOURCE - nullable: true - key: - type: string - minLength: 1 - 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 - nullable: true + - $ref: '#/components/schemas/MatchExpressionDTO' + - type: object + properties: + entity: + type: string + enum: + - NOT_APPLICABLE + - DESTINATION + - SOURCE + nullable: true + key: + type: string + minLength: 1 + 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 + nullable: true required: - - entity - - key - - operator + - 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. + 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 @@ -44652,10 +46615,14 @@ components: nullable: true icon: type: string - description: | - Each tag has an Icon which can be seen on the drop down list in Unbounded Analytics. + 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`. + + Eg: For for all `TAG` under `Call` tagTreeNode, the `icon` value is + `lib_application_call`. maxLength: 128 minLength: 0 nullable: true @@ -44669,19 +46636,26 @@ components: scoreBoost: type: integer format: int32 - description: | + 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`. + + 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. nullable: true type: type: string - description: Type would be either `LEVEL` or `TAG` depending on whether - the tag has any child tags or not respectively. + description: >- + Type would be either `LEVEL` or `TAG` depending on whether the tag + has any child tags or not respectively. required: - - children - - label + - children + - label TagTreeNode: type: object description: Children tags of tagTree @@ -44697,60 +46671,73 @@ components: 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. + 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 - nullable: true - hidden: - type: boolean - description: If true, the tag will not be available for query in Unbounded - Analytics. - nullable: true - icon: - type: string - maxLength: 128 - minLength: 0 - nullable: true - 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 - nullable: true - 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. - nullable: true - tagName: - type: string - maxLength: 128 - minLength: 0 + - $ref: '#/components/schemas/TagTreeNode' + - type: object + properties: + description: + type: string + maxLength: 512 + minLength: 0 + nullable: true + hidden: + type: boolean + description: >- + If true, the tag will not be available for query in Unbounded + Analytics. + nullable: true + icon: + type: string + maxLength: 128 + minLength: 0 + nullable: true + 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 + nullable: true + 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. + nullable: true + tagName: + type: string + maxLength: 128 + minLength: 0 required: - - label - - tagName + - label + - tagName TestCommonProperties: type: object properties: @@ -44832,35 +46819,38 @@ components: type: string writeOnly: true required: - - active - - frequency - - id - - label - - type + - active + - frequency + - 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 + 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 + 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 + description: >- + The HTTP status code returned by the remote service during the + connection test example: 200 required: - - connected - - message - - statusCode + - connected + - message + - statusCode TestLastError: type: object nullable: true @@ -44953,8 +46943,8 @@ components: testName: type: string required: - - clientId - - testId + - clientId + - testId TestResultDetailData: type: object properties: @@ -45027,7 +47017,7 @@ components: items: type: string required: - - testId + - testId TestResultListItem: type: object properties: @@ -45042,8 +47032,8 @@ components: testResultCommonProperties: $ref: '#/components/schemas/TestResultCommonProperties' required: - - metrics - - testResultCommonProperties + - metrics + - testResultCommonProperties TestResultListResult: type: object properties: @@ -45065,7 +47055,7 @@ components: format: int64 minimum: 0 required: - - items + - items TestResultMetadata: type: object properties: @@ -45082,7 +47072,7 @@ components: testResultId: type: string required: - - testId + - testId TestResultSubtransaction: type: object properties: @@ -45095,8 +47085,8 @@ components: additionalProperties: type: object required: - - metrics - - properties + - metrics + - properties Threshold: type: object deprecated: true @@ -45112,17 +47102,17 @@ components: operator: type: string enum: - - '>' - - '>=' - - < - - <= - - OUTSIDE - - BETWEEN + - '>' + - '>=' + - < + - <= + - OUTSIDE + - BETWEEN type: type: string required: - - operator - - type + - operator + - type ThresholdConfigRule: type: object discriminator: @@ -45135,68 +47125,68 @@ components: type: type: string required: - - type + - type ThresholdRule: type: object allOf: - - $ref: '#/components/schemas/AbstractRule' - - type: object - properties: - aggregation: - type: string - enum: - - sum - - avg - - min - - max - - absolute_diff - - relative_diff - nullable: true - conditionOperator: - type: string - enum: - - '>' - - '>=' - - < - - <= - - = - - '!=' - conditionValue: - type: number - format: double - metricName: - type: string - maxLength: 512 - minLength: 0 - nullable: true - metricPattern: - $ref: '#/components/schemas/MetricPattern' - rollup: - type: integer - format: int64 - window: - type: integer - format: int64 - required: - - conditionOperator + - $ref: '#/components/schemas/AbstractRule' + - type: object + properties: + aggregation: + type: string + enum: + - sum + - avg + - min + - max + - absolute_diff + - relative_diff + nullable: true + conditionOperator: + type: string + enum: + - '>' + - '>=' + - < + - <= + - '=' + - '!=' + conditionValue: + type: number + format: double + metricName: + type: string + maxLength: 512 + minLength: 0 + nullable: true + 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' + - $ref: '#/components/schemas/ApplicationAlertRule' required: - - metricName + - metricName ThroughputMobileAppAlertRule: type: object allOf: - - $ref: '#/components/schemas/MobileAppAlertRule' + - $ref: '#/components/schemas/MobileAppAlertRule' required: - - metricName + - metricName ThroughputWebsiteAlertRule: type: object allOf: - - $ref: '#/components/schemas/WebsiteAlertRule' + - $ref: '#/components/schemas/WebsiteAlertRule' required: - - metricName + - metricName TimeConfig: type: object properties: @@ -45220,9 +47210,10 @@ components: 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.' + 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. nullable: true windowSize: type: integer @@ -45247,22 +47238,22 @@ components: type: string description: Unit of the Time Window Duration enum: - - millisecond - - second - - minute - - hour - - day - - week - - calendar_month + - millisecond + - second + - minute + - hour + - day + - week + - calendar_month timezone: type: string description: Timezone string type: type: string required: - - duration - - durationUnit - - type + - duration + - durationUnit + - type Topology: type: object properties: @@ -45292,8 +47283,9 @@ components: 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`. + description: >- + The trace ID. All spans of the same trace must have the same trace + ID. For example, `e93282c0d5018320`. minLength: 1 label: type: string @@ -45307,17 +47299,21 @@ components: description: The start time of the trace. minimum: 1 required: - - id - - label + - id + - label TraceActivityTreeNodeDetails: type: object properties: batchSelfTime: type: integer format: int64 - description: | + 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, + + 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. nullable: true batchSize: @@ -45330,21 +47326,24 @@ components: 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. + 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 + 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`.' + description: >- + The call ID. A unique identifier for an individual call. For + example: `1bcad5c82338deaf`. minLength: 1 isSynthetic: type: boolean @@ -45363,32 +47362,35 @@ components: 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. + 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. nullable: true 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 + 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. nullable: true rawSpanLoadError: type: string description: Whether an error occurred loading raw spans from external storage. enum: - - UNKNOWN_ERROR - - NOT_FOUND - - PERMISSION_DENIED - - NO_ERROR + - UNKNOWN_ERROR + - 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. + 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: @@ -45402,17 +47404,18 @@ components: 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` + 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 + - id + - label + - logs + - spans TraceDownloadResult: type: object properties: @@ -45420,13 +47423,17 @@ components: $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. + 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. + 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: @@ -45437,22 +47444,28 @@ components: totalRepresentedItemCount: type: integer format: int64 - description: For calls and EUM beacons, one row can represent multiple real - items (batched call, sample multiplicity) + 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. + 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 + - 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. + 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' @@ -45460,26 +47473,44 @@ components: type: object additionalProperties: type: array - description: | + 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]`. + + 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: | + 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]`. + + 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: | + 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: | + + 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]`. + + 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. @@ -45490,9 +47521,9 @@ components: description: Earliest timestamp of the trace from the group minimum: 0 required: - - cursor - - metrics - - name + - cursor + - metrics + - name TraceGroupsResult: type: object properties: @@ -45500,13 +47531,17 @@ components: $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. + 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. + 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: @@ -45517,40 +47552,46 @@ components: totalRepresentedItemCount: type: integer format: int64 - description: For calls and EUM beacons, one row can represent multiple real - items (batched call, sample multiplicity) + 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. + 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 + - items TraceImpactApplicationTimeThreshold: type: object allOf: - - $ref: '#/components/schemas/ApplicationTimeThreshold' - - type: object - properties: - requests: - type: integer - format: int32 - minimum: 1 + - $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. + 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 + - cursor + - trace TraceResult: type: object properties: @@ -45558,13 +47599,17 @@ components: $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. + 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. + 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: @@ -45575,17 +47620,20 @@ components: totalRepresentedItemCount: type: integer format: int64 - description: For calls and EUM beacons, one row can represent multiple real - items (batched call, sample multiplicity) + 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. + 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 + - items TraceSamplingConfig: type: object properties: @@ -45623,36 +47671,37 @@ components: volumeStrategy: type: string required: - - enabled - - samplingType - - volumeStrategy + - enabled + - samplingType + - volumeStrategy TrafficBlueprintIndicator: type: object allOf: - - $ref: '#/components/schemas/ServiceLevelIndicator' - - type: object - properties: - metric: - $ref: '#/components/schemas/EntityMetric' - threshold: - type: number - format: double - description: Threshold Value for the Blueprint - exclusiveMinimum: false - minimum: 0.0 - trafficType: - type: string - enum: - - erroneous - - all + - $ref: '#/components/schemas/ServiceLevelIndicator' + - type: object + properties: + metric: + $ref: '#/components/schemas/EntityMetric' + threshold: + type: number + format: double + description: Threshold Value for the Blueprint + exclusiveMinimum: false + minimum: 0 + trafficType: + type: string + enum: + - erroneous + - all required: - - trafficType - - type + - 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`. + 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 @@ -45667,61 +47716,66 @@ components: $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. + 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 + - 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. + 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' maintenanceWindowIds: type: array - description: Optional list of maintenance window identifiers. When set, - the policy will only run outside of the specified maintenance windows. + description: >- + Optional list of maintenance window identifiers. When set, the + policy will only run outside of the specified maintenance windows. items: type: string - description: Optional list of maintenance window identifiers. When set, - the policy will only run outside of the specified maintenance windows. + description: >- + Optional list of maintenance window identifiers. When set, the + policy will only run outside of the specified maintenance windows. 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. + 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 + - automatic + - manual runnable: $ref: '#/components/schemas/PolicyRunnable' required: - - name - - runnable + - name + - runnable UnsupportedHttpPathSegmentMatchingRule: type: object allOf: - - $ref: '#/components/schemas/HttpPathSegmentMatchingRule' - - type: object - properties: - unsupportedType: - type: string + - $ref: '#/components/schemas/HttpPathSegmentMatchingRule' + - type: object + properties: + unsupportedType: + type: string required: - - type + - type UpdateEvaluationRequest: type: object properties: @@ -45785,9 +47839,9 @@ components: items: type: string required: - - evaluation_id - - evaluation_name - - evaluator_ids + - evaluation_id + - evaluation_name + - evaluator_ids UpdatedBusinessPerspectiveConfig: type: object properties: @@ -45832,57 +47886,57 @@ components: type: string minLength: 1 required: - - email - - fullName - - id + - 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 + - $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 + minimum: 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 + - $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 + minimum: 0 + users: + type: integer + format: int32 + minimum: 1 + required: + - impactMeasurementMethod UserResult: type: object properties: @@ -45912,9 +47966,9 @@ components: type: boolean nullable: true required: - - email - - fullName - - id + - email + - fullName + - id UsersResult: type: object properties: @@ -45936,7 +47990,8 @@ components: 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, + description: >- + The entity ID in case of Smart Alerts, such as for the application, website or mobile app. nullable: true eventTypes: @@ -45946,15 +48001,15 @@ components: type: string description: The selected event types, if applicable. enum: - - incident - - critical - - warning - - change - - online - - offline - - agent_monitoring_issue - - cve_issue - - none + - incident + - critical + - warning + - change + - online + - offline + - agent_monitoring_issue + - cve_issue + - none maxItems: 6 minItems: 0 nullable: true @@ -45986,20 +48041,20 @@ components: type: string description: The alert type. enum: - - Alert - - WebsiteSmartAlert - - MobileSmartAlert - - ApplicationSmartAlert - - GlobalApplicationSmartAlert - - SyntheticSmartAlert - - InfraSmartAlert - - ServiceLevelSmartAlert - - ApdexSmartAlert - - LogSmartAlert - required: - - id - - label - - type + - Alert + - WebsiteSmartAlert + - MobileSmartAlert + - ApplicationSmartAlert + - GlobalApplicationSmartAlert + - SyntheticSmartAlert + - InfraSmartAlert + - ServiceLevelSmartAlert + - ApdexSmartAlert + - LogSmartAlert + required: + - id + - label + - type ValidatedAlertingConfiguration: type: object properties: @@ -46017,15 +48072,20 @@ components: minLength: 0 applicationNames: type: array - description: Set of Application Perspective names added in the Alert Configuration. + 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. + 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. Supports both static and dynamic fields. Can be left + description: >- + Custom payload fields to send additional information in the alert + notifications. Supports both static and dynamic fields. Can be left empty. items: $ref: '#/components/schemas/CustomPayloadField' @@ -46040,8 +48100,9 @@ components: minLength: 0 includeEntityNameInLegacyAlerts: type: boolean - description: To include the entity name in a legacy alert based on built-in/custom - events. + 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. @@ -46058,32 +48119,36 @@ components: lastUpdated: type: integer format: int64 - description: Unix timestamp representing the time the configuration was - last updated. + 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. + 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 + - 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 + 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 + description: >- + Name set of the Application Perspectives within the scope of the + Maintenance Window uniqueItems: true id: type: string @@ -46092,8 +48157,7 @@ components: minLength: 0 invalid: type: boolean - description: Boolean flag that tells if the Dynamic Focus Query(DFQ) is - invalid. + description: Boolean flag that tells if the Dynamic Focus Query(DFQ) is invalid. lastUpdated: type: integer format: int64 @@ -46107,42 +48171,46 @@ components: $ref: '#/components/schemas/Occurrence' paused: type: boolean - description: Boolean flag to determine if the Maintenance Window configuration - is paused or still live. + 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 + 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, + 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.' + description: >- + State of the Maintenance Window, it can be: UNSCHEDULED, SCHEDULED, + ACTIVE, PAUSED, EXPIRED. enum: - - UNSCHEDULED - - SCHEDULED - - ACTIVE - - PAUSED - - EXPIRED + - 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 + - id + - name + - occurrence + - query + - scheduling ValidatedMaintenanceConfigWithStatus: type: object properties: @@ -46153,8 +48221,7 @@ components: minLength: 0 invalid: type: boolean - description: Boolean flag that tells if the Dynamic Focus Query(DFQ) is - invalid. + description: Boolean flag that tells if the Dynamic Focus Query(DFQ) is invalid. lastUpdated: type: integer format: int64 @@ -46166,250 +48233,253 @@ components: minLength: 0 query: type: string - description: Dynamic Focus Query that determines the scope of the Maintenance + 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.' + description: >- + Status of the Maintenance Window Configuration. It can be one of: + UNSCHEDULED, SCHEDULED, ACTIVE, FINISHED, PAUSED. enum: - - UNSCHEDULED - - SCHEDULED - - ACTIVE - - FINISHED - - PAUSED + - UNSCHEDULED + - SCHEDULED + - ACTIVE + - FINISHED + - PAUSED windows: type: array - description: A set of time periods when the Maintenance Window Configuration - is active. + 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 + - id + - name + - query + - status VictorOpsIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - apiKey: - type: string - minLength: 1 - routingKey: - type: string - minLength: 1 + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + apiKey: + type: string + minLength: 1 + routingKey: + type: string + minLength: 1 required: - - apiKey - - id - - kind - - name - - routingKey + - 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 + - $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 + - $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 + - $ref: '#/components/schemas/WebsiteTimeThreshold' + - type: object + properties: + violations: + type: integer + format: int32 + maximum: 12 + minimum: 1 ViolationsInSequenceApplicationTimeThreshold: type: object allOf: - - $ref: '#/components/schemas/ApplicationTimeThreshold' + - $ref: '#/components/schemas/ApplicationTimeThreshold' ViolationsInSequenceInfraTimeThreshold: type: object allOf: - - $ref: '#/components/schemas/InfraTimeThreshold' + - $ref: '#/components/schemas/InfraTimeThreshold' ViolationsInSequenceLogTimeThreshold: type: object allOf: - - $ref: '#/components/schemas/LogTimeThreshold' + - $ref: '#/components/schemas/LogTimeThreshold' ViolationsInSequenceMobileAppTimeThreshold: type: object allOf: - - $ref: '#/components/schemas/MobileAppTimeThreshold' + - $ref: '#/components/schemas/MobileAppTimeThreshold' ViolationsInSequenceSyntheticTimeThreshold: type: object allOf: - - $ref: '#/components/schemas/SyntheticTimeThreshold' + - $ref: '#/components/schemas/SyntheticTimeThreshold' ViolationsInSequenceWebsiteTimeThreshold: type: object allOf: - - $ref: '#/components/schemas/WebsiteTimeThreshold' + - $ref: '#/components/schemas/WebsiteTimeThreshold' WatsonAIOpsWebhookIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - headers: - type: array - items: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + headers: + type: array + items: + type: string + minLength: 1 + nullable: true + webhookUrl: type: string minLength: 1 - nullable: true - webhookUrl: - type: string - minLength: 1 required: - - id - - kind - - name - - webhookUrl + - id + - kind + - name + - webhookUrl WebexTeamsWebhookIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - webhookUrl: - type: string - minLength: 1 + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + webhookUrl: + type: string + minLength: 1 required: - - id - - kind - - name - - webhookUrl + - id + - kind + - name + - webhookUrl WebhookIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - headers: - type: array - items: - type: string - minLength: 1 - oauth: - $ref: '#/components/schemas/OAuthIntegration' - oauthEnabled: - type: boolean - transformationExpression: - type: string - webhookUrls: - type: array - items: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + headers: + type: array + items: + type: string + minLength: 1 + oauth: + $ref: '#/components/schemas/OAuthIntegration' + oauthEnabled: + type: boolean + transformationExpression: type: string - minLength: 1 - minItems: 1 + webhookUrls: + type: array + items: + type: string + minLength: 1 + minItems: 1 required: - - id - - kind - - name - - webhookUrls + - 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 + - $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 + - 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 + - $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 - github: - $ref: '#/components/schemas/GitHubConfiguration' - recordVideo: - type: boolean - script: - type: string - maxLength: 1048576 - minLength: 0 + - $ref: '#/components/schemas/SyntheticTypeConfiguration' + - type: object + properties: + browser: + type: string + enum: + - chrome + - firefox + fileName: + type: string + github: + $ref: '#/components/schemas/GitHubConfiguration' + recordVideo: + type: boolean + script: + type: string + maxLength: 1048576 + minLength: 0 required: - - markSyntheticCall - - syntheticType + - markSyntheticCall + - syntheticType WebpageScriptConfigurationUpdate: type: object allOf: - - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' - - type: object - properties: - browser: - type: string - enum: - - chrome - - firefox - fileName: - type: string - github: - $ref: '#/components/schemas/GitHubConfiguration' - recordVideo: - type: boolean - script: - type: string + - $ref: '#/components/schemas/SyntheticTypeConfigurationUpdate' + - type: object + properties: + browser: + type: string + enum: + - chrome + - firefox + fileName: + type: string + github: + $ref: '#/components/schemas/GitHubConfiguration' + recordVideo: + type: boolean + script: + type: string Website: type: object properties: @@ -46425,21 +48495,21 @@ components: type: string minLength: 1 required: - - id - - name + - 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. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -46458,17 +48528,19 @@ components: nullable: true customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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. + 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: @@ -46477,27 +48549,30 @@ components: 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 + 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. nullable: true 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. + 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 + - 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 + 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 @@ -46505,10 +48580,11 @@ components: $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. + 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 @@ -46518,7 +48594,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). maximum: 10 minimum: 5 @@ -46537,35 +48614,35 @@ components: $ref: '#/components/schemas/WebsiteTimeThreshold' triggering: type: boolean - description: Optional flag to indicate whether an Incident is also triggered - or not. + 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. + 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 + - 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. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -46589,17 +48666,19 @@ components: minimum: 1 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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. + 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: @@ -46608,23 +48687,25 @@ components: 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 + 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. nullable: true 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. + 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 + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 id: type: string description: 'ID of this Website Alert Config. ' @@ -46637,23 +48718,26 @@ components: 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 + 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. + 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. + 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 @@ -46663,7 +48747,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). maximum: 10 minimum: 5 @@ -46682,36 +48767,36 @@ components: $ref: '#/components/schemas/WebsiteTimeThreshold' triggering: type: boolean - description: Optional flag to indicate whether an Incident is also triggered - or not. + 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. + 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 + - 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. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -46735,17 +48820,19 @@ components: minimum: 1 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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. + 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: @@ -46754,23 +48841,25 @@ components: 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 + 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. nullable: true 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. + 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 + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 id: type: string description: 'ID of this Website Alert Config. ' @@ -46783,8 +48872,9 @@ components: 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 + 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 @@ -46796,16 +48886,18 @@ components: uniqueItems: true readOnly: type: boolean - description: Flag to indicate whether or not the configuration is read-only. + 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. + 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 @@ -46815,7 +48907,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). maximum: 10 minimum: 5 @@ -46834,23 +48927,23 @@ components: $ref: '#/components/schemas/WebsiteTimeThreshold' triggering: type: boolean - description: Optional flag to indicate whether an Incident is also triggered - or not. + 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. + 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 + - customPayloadFields + - description + - granularity + - id + - name + - tagFilterExpression + - timeThreshold + - websiteId WebsiteAlertRule: type: object discriminator: @@ -46865,65 +48958,68 @@ components: 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 + - 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 minLength: 1 required: - - alertType - - metricName + - 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 - minLength: 1 - threshold: - type: integer - format: int32 - description: Value of the Apdex Threshold - minimum: 1 - required: - - beaconType - - entityId - - tagFilterExpression + - $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 + minLength: 1 + 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. + 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' @@ -46943,9 +49039,9 @@ components: type: string minLength: 1 required: - - cursor - - metrics - - name + - cursor + - metrics + - name WebsiteBeaconGroupsResult: type: object properties: @@ -46953,13 +49049,17 @@ components: $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. + 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. + 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: @@ -46970,17 +49070,20 @@ components: totalRepresentedItemCount: type: integer format: int64 - description: For calls and EUM beacons, one row can represent multiple real - items (batched call, sample multiplicity) + 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. + 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 + - items WebsiteBeaconResult: type: object properties: @@ -46988,13 +49091,17 @@ components: $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. + 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. + 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: @@ -47005,17 +49112,20 @@ components: totalRepresentedItemCount: type: integer format: int64 - description: For calls and EUM beacons, one row can represent multiple real - items (batched call, sample multiplicity) + 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. + 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 + - items WebsiteBeaconTagGroup: type: object properties: @@ -47026,31 +49136,44 @@ components: minLength: 0 groupbyTagEntity: type: string - description: | + description: > The entity by which the data should be grouped. - This field supports three possible values: `NOT_APPLICABLE`, `DESTINATION`, and `SOURCE`. + + 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). + + `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 + - NOT_APPLICABLE + - DESTINATION + - SOURCE groupbyTagSecondLevelKey: type: string - description: If present, it's the 2nd level key part (e.g. `customKey` on + description: >- + If present, it's the 2nd level key part (e.g. `customKey` on `docker.label.customKey`) maxLength: 256 minLength: 0 nullable: true required: - - groupbyTag - - groupbyTagEntity + - 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. + 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' @@ -47059,44 +49182,44 @@ components: impactedBeaconInfo: $ref: '#/components/schemas/ImpactedBeaconInfo' required: - - beacon - - cursor + - 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 + - $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 + - badEventFilterExpression + - beaconType + - goodEventFilterExpression WebsiteEventResult: type: object allOf: - - $ref: '#/components/schemas/EventResult' - - type: object - properties: - websiteId: - type: string - description: ID of the website. + - $ref: '#/components/schemas/EventResult' + - type: object + properties: + websiteId: + type: string + description: ID of the website. WebsiteMetricResult: type: object additionalProperties: @@ -47461,26 +49584,66 @@ components: format: int32 minimum: -1 required: - - beaconId - - type - - websiteId - - websiteLabel + - beaconId + - type + - websiteId + - websiteLabel WebsiteMonitoringMetricDescription: type: object properties: aggregations: type: array - description: | + 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`. + + 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`. + 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 + minLength: 1 + minItems: 1 + 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 @@ -47498,68 +49661,59 @@ components: - SUM_POSITIVE - PER_SECOND - INCREASE - uniqueItems: true - beaconTypes: - type: array - items: - type: string - minLength: 1 - minItems: 1 - 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` + 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: | + 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 + + * `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 minLength: 1 label: type: string - description: The name of the metric. For example, `Call count`, `Erroneous + 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`, + description: >- + The unique id of the metric. For example, `calls`, `erroneousCalls`, `latency` etc. minLength: 1 pathToValueInBeacon: @@ -47573,98 +49727,101 @@ components: type: string nullable: true required: - - aggregations - - beaconTypes - - formatter - - label - - metricId + - 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`.' + 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 + - 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' + description: >- + If the granularity is set you will get data points with the + specified granularity in seconds. Default: `1000` milliseconds nullable: true metric: type: string description: 'Set a particular metric, eg: `latency`.' minLength: 1 required: - - aggregation - - metric + - 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 + - $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 + - 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 + - $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 + - beaconType WebsiteTimeThreshold: type: object - description: The type of threshold to define the criteria when the event and - alert triggers and resolves. + description: >- + The type of threshold to define the criteria when the event and alert + triggers and resolves. discriminator: mapping: userImpactOfViolationsInSequence: '#/components/schemas/UserImpactWebsiteTimeThreshold' @@ -47678,7 +49835,7 @@ components: type: type: string required: - - type + - type Widget: type: object properties: @@ -47707,27 +49864,27 @@ components: format: int32 maximum: 11 minimum: 0 - y: + 'y': type: integer format: int32 minimum: 0 required: - - config - - id - - type + - 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. + 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. + description: >- + List of IDs of alert channels defined in Instana. Can be left + empty. minLength: 1 maxItems: 1024 minItems: 0 @@ -47753,16 +49910,18 @@ components: minimum: 1 customPayloadFields: type: array - description: Custom payload fields to send additional information in the - alert notifications. Can be left empty. + 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 + 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 @@ -47772,23 +49931,25 @@ components: 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 + 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. nullable: true 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. + 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 + - 60000 + - 300000 + - 600000 + - 900000 + - 1200000 + - 1800000 id: type: string description: 'ID of this Mobile App Alert Config. ' @@ -47801,29 +49962,33 @@ components: minimum: 1 mobileAppId: type: string - description: ID of the mobile app that this Smart Alert configuration is - applied to. + 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 + 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. + 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. + 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 @@ -47833,7 +49998,8 @@ components: type: integer format: int32 deprecated: true - description: The severity of the alert when triggered, which is either 5 + description: >- + The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). maximum: 10 minimum: 5 @@ -47846,155 +50012,157 @@ components: $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 + 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 + - $ref: '#/components/schemas/Author' + - type: object + properties: + fullName: + type: string ZChatOpsIntegration: type: object allOf: - - $ref: '#/components/schemas/AbstractIntegration' - - type: object - properties: - bearerAuthToken: - type: string - minLength: 1 - channels: - type: array - items: + - $ref: '#/components/schemas/AbstractIntegration' + - type: object + properties: + bearerAuthToken: + type: string + minLength: 1 + channels: + type: array + items: + type: string + minLength: 1 + maxItems: 1 + minItems: 0 + nullable: true + zchatOpsIncidentsUrl: type: string minLength: 1 - maxItems: 1 - minItems: 0 - nullable: true - zchatOpsIncidentsUrl: - type: string - minLength: 1 required: - - bearerAuthToken - - id - - kind - - name - - zchatOpsIncidentsUrl + - 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 → Security & access. In the Access control - section, click API tokens. + 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 → Security & access. In the + Access control section, click 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 - - SLO Configurations - - Service Levels Objective(SLO) Report - - Service Levels Alert Configuration - - SLO Correction Configurations - - SLO Correction Windows - - SLO Catalog for Mobile App -- 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 - - IP Filtering -- name: Open Beta Features - tags: - - Infrastructure Analyze -- name: Closed Beta Features - tags: - - Infrastructure Alert Configuration -- name: Instana - tags: - - Releases - - Host Agent - - Health - - Usage -- name: Fleet Management - tags: - - Fleet Management + - 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 + - SLO Configurations + - Service Levels Objective(SLO) Report + - Service Levels Alert Configuration + - SLO Correction Configurations + - SLO Correction Windows + - SLO Catalog for Mobile App + - 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 + - IP Filtering + - name: Open Beta Features + tags: + - Infrastructure Analyze + - name: Closed Beta Features + tags: + - Infrastructure Alert Configuration + - name: Instana + tags: + - Releases + - Host Agent + - Health + - Usage + - name: Fleet Management + tags: + - Fleet Management diff --git a/openapi.yaml.bak b/openapi.yaml.bak index 70114857..389c2a73 100644 --- a/openapi.yaml.bak +++ b/openapi.yaml.bak @@ -21592,7 +21592,7 @@ paths: maxSeverity: 0 openIssues: [ ] - popVersion: 1.1.1 + popVersion: 1.1.2 - id: c7sXV7jZcuiD2ewGAjYI label: Aggie displayLabel: Aggie popLoc @@ -22487,7 +22487,7 @@ paths: - id: OjJPXWHmsE9deLzanNAW label: Dallas displayLabel: AUTOscaling - popVersion: 1.1.1 + popVersion: 1.1.2 description: My Location 101 locationType: Private playbackCapabilities: @@ -22580,7 +22580,7 @@ paths: id: OjJPXWHmsE9deLzanNAW label: Austin displayLabel: AUTOscaling - popVersion: 1.1.1 + popVersion: 1.1.2 description: Test Location 101 locationType: Private playbackCapabilities: diff --git a/pyproject.toml b/pyproject.toml index 020ddda7..70c7111c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "instana_client" -version = "1.1.1" +version = "1.1.2" description = "Instana REST API documentation" authors = [ {name = "© Instana",email = "support@instana.com"}, diff --git a/setup.py b/setup.py index a7517994..4815751f 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ Documentation for INSTANA REST API - The version of the OpenAPI document: 1.324.1358 + The version of the OpenAPI document: 1.325.1193 Contact: support@instana.com Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -22,7 +22,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "instana-client" -VERSION = "1.1.1" +VERSION = "1.1.2" PYTHON_REQUIRES = ">= 3.9" REQUIRES = [ "urllib3 >= 2.1.0, < 3.0.0",