# Instana Application Alert Configuration API **Canonical:** https://apis.io/apis/instana/instana-application-alert-configuration-api/ **Provider:** Instana — https://apis.io/providers/instana/ **Documentation:** https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api Instana Application Alert Configuration API is one of 62 APIs that [Instana](https://apis.io/providers/instana/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Application Alert Configuration. The published artifact set on APIs.io includes an OpenAPI specification and API documentation. The API endpoints of this group can be used to manage Application alert configurations. ## Parameters: - **id:** ID of the application alert config which needs to be updated. - **name:** Name for the application alert configuration. - **description:** Description for the application alert configuration. - **severity:** The severity of the alert when triggered, which is either `5` (Warning), or `10` (Critical). - **triggering:** Optional flag to indicate whether also an Incident is triggered or not. - **applications:** Selection of application, services and endpoints in scope. The selection defines a tree of included or excluded sub entities. The defined `inclusive` flag defines whether this node and his child nodes are included (`inclusive: true`) or excluded (`inclusive: false`) by default. Empty selections or unnecessary selections are not allowed. #### Example 1: Select an entire Application Perspective To select the entire application with ID `` including all its services and endpoints, simply provide the following selection object: ```json "applications": { "": { "applicationId": "" } } ``` Leaf nodes of the selection tree default to `true` if no `inclusive` value is defined. #### Example 2: Specific selection of services and endpoints To select not the entire application with ID ``, but only the entire serivces Service1 with ID `` and Service2 with ID ``, with the exception of endpoint `` of Service2. And in addition, only Endpoint `` of Service3 with id ``, then use the following selection: ```json "applications": { "": { "applicationId": "", "inclusive": false, "services": { "": { "serviceId": "" }, "": { "serviceId": "", "inclusive": true, "endpoints": { "": { "endpointId": "", "inclusive": false } } }, "": { "serviceId": "", "inclusive": false, "endpoints": { "": { "endpointId": "", "inclusive": true } } } } } } ``` - **boundaryScope:** Boundary scope of the Application Perspective - **tagFilterExpression:** Boolean expression of tag filters to define the scope of relevant calls. - **includeInternal:** Optional flag to indicate whether also internal calls are included in the scope or not. The default is `false`. - **includeSynthetic:** Optional flag to indicate whether also synthetic calls are included in the scope or not. The default is `false`. - **evaluationType:** The alert evaluation type of the alert configuration. For example, this allows to configure whether calls of the configured scope is aggregated to a single metric that is then considered for alerting (`"PER_AP"`), or whether each service of an Appliction Perspective is is evaluated individually (`"PER_AP_SERVICE"`). - **granularity:** The evaluation granularity used for detection of violations of the defined threshold. In other words, it defines the size of the tumbling window used. - **rule:** Indicates the type of rule this alert configuration is about. - **threshold:** Indicates the type of threshold this alert rule is evaluated on . - **timeThreshold:** Indicates the type of violation of the defined threshold. - **alertChannelIds:** List of IDs of alert channels defined in Instana. ## Deprecated Parameters - **applicationId:** Unique ID of the Application Perspective. It is replaced by **applications**. ## Machine-readable artifacts (3) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/instana/refs/heads/main/openapi/instana-application-alert-configuration-api-openapi.yml - **Documentation** — https://instana.github.io/openapi/ - **GitHubOrganization** — https://github.com/instana/openapi ## Other Instana APIs (12) - [Instana Action Catalog API](https://apis.io/apis/instana/instana-action-catalog-api/) - [Instana Action History API](https://apis.io/apis/instana/instana-action-history-api/) - [Instana AI Management API](https://apis.io/apis/instana/instana-ai-management-api/) - [Instana Apdex Report API](https://apis.io/apis/instana/instana-apdex-report-api/) - [Instana Apdex Settings API](https://apis.io/apis/instana/instana-apdex-settings-api/) - [Instana API Token API](https://apis.io/apis/instana/instana-api-token-api/) - [Instana Application Analyze API](https://apis.io/apis/instana/instana-application-analyze-api/) - [Instana Application Catalog API](https://apis.io/apis/instana/instana-application-catalog-api/) - [Instana Application Metrics API](https://apis.io/apis/instana/instana-application-metrics-api/) - [Instana Application Resources API](https://apis.io/apis/instana/instana-application-resources-api/) - [Instana Application Settings API](https://apis.io/apis/instana/instana-application-settings-api/) - [Instana Application Topology API](https://apis.io/apis/instana/instana-application-topology-api/) ## Tags Application Alert Configuration --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/instana/instana-application-alert-configuration-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/instana/.