Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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}.

10 operations 7 paths 16 schemas 1 DELETE3 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.307.1417
Servers
https://{unit}-{tenant}.instana.io
https://{domain}
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

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.

Application Alert Configuration 10

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…

GET
/api/events/settings/application-alert-configs
Get all Smart Alert Configs
findAllActiveApplicationAlertConfigs 2 params → 200403
POST
/api/events/settings/application-alert-configs
Create Smart Alert Config
createApplicationAlertConfig body → 200400403422428
DELETE
/api/events/settings/application-alert-configs/{id}
Delete Smart Alert Config
deleteApplicationAlertConfig 1 param → 204403404
GET
/api/events/settings/application-alert-configs/{id}
Get Smart Alert Config
findApplicationAlertConfig 2 params → 200403404
POST
/api/events/settings/application-alert-configs/{id}
Update Smart Alert Config
updateApplicationAlertConfig 1 param body → 200204400403422428500
PUT
/api/events/settings/application-alert-configs/{id}/disable
Disable Smart Alert Config
disableApplicationAlertConfig 1 param body → 204403404
PUT
/api/events/settings/application-alert-configs/{id}/enable
Enable Application Alert Config
enableApplicationAlertConfig 1 param body → 204403404
PUT
/api/events/settings/application-alert-configs/{id}/restore/{created}
Restore Smart Alert Config
restoreApplicationAlertConfig 2 params body → 204403404
POST
/api/events/settings/application-alert-configs/{id}/update-baseline
Recalculate Smart Alert Config Baseline
updateApplicationHistoricBaseline 1 param → 200204400403404428
GET
/api/events/settings/application-alert-configs/{id}/versions
Get Smart Alert Config Versions
findApplicationAlertConfigVersions 1 param → 200403404

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.

ThresholdConfigRule
object
1 property 1 required
Author
object
2 properties
ApplicationAlertConfig
object
21 properties 10 required
CustomPayloadField
object
Custom payload fields to send additional information in the alert notifications. Can be left empty.
2 properties 2 required
TagFilter
object
3 required
ApplicationAlertConfigWithMetadata
object
26 properties 11 required
EndpointNode
object
2 properties 1 required
ConfigVersion
object
5 properties 1 required
ChangeSummary
object
Brief summary of changes made in this config version.
2 properties 2 required
ServiceNode
object
3 properties 2 required
ApplicationAlertRule
object
3 properties 2 required
TagFilterExpressionElement
object
Boolean expression of tag filters to define the scope of relevant calls.
1 property 1 required
ApplicationTimeThreshold
object
The type of threshold to define the criteria when the event and alert triggers and resolves.
2 properties 1 required
ApplicationNode
object
Selection of applications, services, and endpoints that this Smart Alert configuration is associated with. This selection is connected to the defined tagFilter…
3 properties 2 required
RuleWithThresholdApplicationAlertRule
object
A list of rules where each rule is associated with multiple thresholds and their corresponding severity levels. This enables more complex alert configurations…
3 properties 3 required
Threshold
object
Indicates the type of threshold this alert rule is evaluated on.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-application-alert-configuration-api-openapi.yml Raw ↑

Other APIs Instana publishes across the network.

Instana Action Catalog API
Instana Action History API
Instana AI Management API
Instana Apdex Report API
Instana Apdex Settings API
Instana API Token API
Instana Application Analyze API
Instana Application Catalog API
Instana Application Metrics API
Instana Application Resources API
Instana Application Settings API
Instana Application Topology API