Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -1290,5 +1290,4 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_custom_metric_application_alert_rule.py
tox.ini
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/ApiToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/Application.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`. |
Expand Down
2 changes: 1 addition & 1 deletion docs/ApplicationConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`. |
Expand Down
15 changes: 7 additions & 8 deletions docs/EventSettingsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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)

Expand Down Expand Up @@ -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)

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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. | - |

Expand Down Expand Up @@ -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
Expand Down
Loading
Loading