Instana Application Alert Configuration API
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**.
Instana Application Alert Configuration API is one of 62 APIs that Instana publishes on the 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.
This API exposes 10 operations across 7 paths, and defines 16 schemas. It is described by OpenAPI 3.0.1, at version 1.307.1417.
Requests are made against 2 base URLs: https://{unit}-{tenant}.instana.io, https://{domain}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Instana Application Alert Configuration API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as authorization (ApiKeyAuth).
ApiKeyAuth— Example bash curl --request GET \ --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \ --header 'authorization: apiToken xxxxxxxx…
Paths & Operations 10
Across 7 paths, the API surfaces 10 operations — 1 DELETE, 3 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
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: Nam…
Schemas 16
The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ApplicationAlertConfigWithMetadata (26 properties), ApplicationAlertConfig (21 properties), ConfigVersion (5 properties), RuleWithThresholdApplicationAlertRule (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Instana 12
Other APIs Instana publishes across the network.