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 Service Levels Alert Configuration API

The Service Levels Alert Configuration API from Instana — 6 operation(s) for service levels alert configuration.

Instana Service Levels 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 Service Levels 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 14 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 14 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 Service Levels 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.

Service Levels Alert Configuration 9
GET
/api/events/settings/global-alert-configs/service-levels
All Service levels Alert Configs
findActiveServiceLevelsAlertConfigs 2 params → 200
POST
/api/events/settings/global-alert-configs/service-levels
Create Service levels Alert Config
createServiceLevelsAlertConfig body → 200400
DELETE
/api/events/settings/global-alert-configs/service-levels/{id}
Delete Service levels Alert Config
deleteServiceLevelsAlertConfig 1 param → 204404
GET
/api/events/settings/global-alert-configs/service-levels/{id}
Get Service levels Alert Config
findServiceLevelsAlertConfig 2 params → 200404
POST
/api/events/settings/global-alert-configs/service-levels/{id}
Update Service levels Alert Config
updateServiceLevelsAlertConfig 1 param body → 200204400
PUT
/api/events/settings/global-alert-configs/service-levels/{id}/disable
Disable Service levels Alert Config
disableServiceLevelsAlertConfig 1 param body → 204404
PUT
/api/events/settings/global-alert-configs/service-levels/{id}/enable
Enable Service levels Alert Config
enableServiceLevelsAlertConfig 1 param body → 204404
PUT
/api/events/settings/global-alert-configs/service-levels/{id}/restore/{created}
Restore Service levels Alert Config
restoreServiceLevelsAlertConfig 2 params body → 204404
GET
/api/events/settings/global-alert-configs/service-levels/{id}/versions
Get versions of Service levels Alert Config
findServiceLevelsAlertConfigVersions 1 param → 200404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ServiceLevelseAlertConfigWithMetadata (17 properties), ServiceLevelsAlertConfig (12 properties), ConfigVersion (5 properties), ServiceLevelsBurnRateConfig (4 properties). Each schema is shown below with its type and property counts.

ServiceLevelseAlertConfigWithMetadata
object
17 properties 9 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
ConfigVersion
object
5 properties 1 required
ChangeSummary
object
Brief summary of changes made in this config version.
2 properties 2 required
ServiceLevelsAlertConfig
object
12 properties 8 required
ServiceLevelsStaticThresholdConfig
object
This threshold defines a static value to be evaluated with a specific operator for burn rate v2 alerts.
3 properties 1 required
ServiceLevelsBurnRateConfig
object
This is the burn rate alert configuration which defines alerting windows and corresponding thresholds. This configuration must to specified for BURNRATEV2 Aler…
4 properties 3 required
StaticThreshold
object
This threshold defines a static value to be evaluated with a specific operator.
1 required
ServiceLevelsBurnRateTimeWindows
object
This is the short and long time window setting for the burn rate alerts.
2 properties
ServiceLevelsTimeThreshold
object
This is the warm-up and cool-down setting to emit or stop alert event after threshold reached.
2 properties 2 required
ServiceLevelsAlertRule
object
This is the service levels alert type. It could be error budget alert or service levels object alert.
1 property 1 required
AlertingTimeWindow
object
3 properties 2 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-service-levels-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