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 Global Application Alert Configuration API

The API endpoints of this group can be used to manage Global Application alert configurations.## Parameters:All parameters and deprecated parameters are similar to Application Alert Configuration except **applications**- **applications:** Selection of applications, services and endpoints in scope. It allows more than one application to define a global rule across different Application Perspectives. #### Example: Select multiple Application Perspectives To select multiple applications with IDs ``, `` including all its services and endpoints,simply provide the following selection object: ```json "applications": { "": { "applicationId": "" }, "": { "applicationId": "" } } ```

Instana Global 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 Global Application Alert Configuration. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 6 paths, and defines 15 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}.

9 operations 6 paths 15 schemas 1 DELETE3 GET2 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 Global 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 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Global Application Alert Configuration 9

The API endpoints of this group can be used to manage Global Application alert configurations. Parameters: All parameters and deprecated parameters are similar to Application Aler…

GET
/api/events/settings/global-alert-configs/applications
Get all Global Smart Alert Configs
findActiveGlobalApplicationAlertConfigs 2 params → 200403
POST
/api/events/settings/global-alert-configs/applications
Create Global Smart Alert Config
createGlobalApplicationAlertConfig body → 200400403422
DELETE
/api/events/settings/global-alert-configs/applications/{id}
Delete Global Smart Alert Config
deleteGlobalApplicationAlertConfig 1 param → 204403404
GET
/api/events/settings/global-alert-configs/applications/{id}
Get Global Smart Alert Config
findGlobalApplicationAlertConfig 2 params → 200403404
POST
/api/events/settings/global-alert-configs/applications/{id}
Update Global Smart Alert Config
updateGlobalApplicationAlertConfig 1 param body → 200204400403422500
PUT
/api/events/settings/global-alert-configs/applications/{id}/disable
Disable Global Smart Alert Config
disableGlobalApplicationAlertConfig 1 param body → 204403404
PUT
/api/events/settings/global-alert-configs/applications/{id}/enable
Enable Global Smart Alert Config
enableGlobalApplicationAlertConfig 1 param body → 204403404
PUT
/api/events/settings/global-alert-configs/applications/{id}/restore/{created}
Restore Global Smart Alert Config
restoreGlobalApplicationAlertConfig 2 params body → 204403404
GET
/api/events/settings/global-alert-configs/applications/{id}/versions
Get Global Smart Alert Config Versions
findGlobalApplicationAlertConfigVersions 1 param → 200403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are GlobalApplicationAlertConfigWithMetadata (26 properties), GlobalApplicationsAlertConfig (19 properties), ConfigVersion (5 properties), RuleWithThresholdApplicationAlertRule (3 properties). Each schema is shown below with its type and property counts.

ThresholdConfigRule
object
1 property 1 required
GlobalApplicationsAlertConfig
object
19 properties 10 required
Author
object
2 properties
CustomPayloadField
object
Custom payload fields to send additional information in the alert notifications. Can be left empty.
2 properties 2 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
GlobalApplicationAlertConfigWithMetadata
object
26 properties 11 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-global-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 Alert Configuration API
Instana Application Analyze API
Instana Application Catalog API
Instana Application Metrics API
Instana Application Resources API
Instana Application Settings API