Instana Event Settings API
The Event Settings API from Instana — 37 operation(s) for event settings.
Instana Event Settings API is one of 62 APIs that Instana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Event Settings. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 55 operations across 37 paths, and defines 53 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}.
55 operations
37 paths
53 schemas
7 DELETE20 GET16 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Instana Event Settings 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 55
Across 37 paths, the API surfaces 55 operations — 7 DELETE, 20 GET, 16 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.
Event Settings 55
GET
/api/events/settings/alertingChannels
Get all Alerting Channels
POST
/api/events/settings/alertingChannels
Create Alert Channel
GET
/api/events/settings/alertingChannels/infos
Get Overview of Alerting Channels
POST
/api/events/settings/alertingChannels/notify/{id}
Notify manually to Alerting Channel. Requires the permission called CanConfigureIntegrations.
PUT
/api/events/settings/alertingChannels/test
Test Alerting Channel
DELETE
/api/events/settings/alertingChannels/{id}
Delete Alerting Channel
GET
/api/events/settings/alertingChannels/{id}
Get Alerting Channel
PUT
/api/events/settings/alertingChannels/{id}
Update Alert Channel
GET
/api/events/settings/alerts
Get all Alert Configurations
GET
/api/events/settings/alerts/infos
All alerting configuration info
DELETE
/api/events/settings/alerts/{id}
Delete Alert Configuration
GET
/api/events/settings/alerts/{id}
Get Alert Configuration
PUT
/api/events/settings/alerts/{id}
Create or update Alert Configuration
DELETE
/api/events/settings/custom-payload-configurations
Delete Custom Payload Configuration
GET
/api/events/settings/custom-payload-configurations
Get All Global Custom Payload Configurations
PUT
/api/events/settings/custom-payload-configurations
Create/Update Global Custom Payload Configuration
GET
/api/events/settings/custom-payload-configurations/catalog
Get Tag Catalog for Custom Payload
PUT
/api/events/settings/custom-payload-configurations/v2
Create/Update Global Custom Payload Configuration
GET
/api/events/settings/event-specifications/built-in
All built-in event specification
DELETE
/api/events/settings/event-specifications/built-in/{eventSpecificationId}
Delete built-in event specification
GET
/api/events/settings/event-specifications/built-in/{eventSpecificationId}
Built-in event specifications
POST
/api/events/settings/event-specifications/built-in/{eventSpecificationId}/disable
Disable built-in event specification
POST
/api/events/settings/event-specifications/built-in/{eventSpecificationId}/enable
Enable built-in event specification
GET
/api/events/settings/event-specifications/custom
All custom event specifications
POST
/api/events/settings/event-specifications/custom
Create new custom event specification
GET
/api/events/settings/event-specifications/custom/systemRules
All system rules for custom event specifications
DELETE
/api/events/settings/event-specifications/custom/{eventSpecificationId}
Delete custom event specification
GET
/api/events/settings/event-specifications/custom/{eventSpecificationId}
Custom event specification
PUT
/api/events/settings/event-specifications/custom/{eventSpecificationId}
Create or update custom event specification
POST
/api/events/settings/event-specifications/custom/{eventSpecificationId}/disable
Disable custom event specification
POST
/api/events/settings/event-specifications/custom/{eventSpecificationId}/enable
Enable custom event specification
GET
/api/events/settings/event-specifications/infos
Summary of all built-in and custom event specifications
POST
/api/events/settings/event-specifications/infos
All built-in and custom event specifications
POST
/api/events/settings/manual-close
Manually closing multiple events
POST
/api/events/settings/manual-close/{eventId}
Manually close an event.
GET
/api/events/settings/mobile-app-alert-configs
Get all Mobile Smart Alert Configs
POST
/api/events/settings/mobile-app-alert-configs
Create Mobile Smart Alert Config
DELETE
/api/events/settings/mobile-app-alert-configs/{id}
Delete Mobile Smart Alert Config
GET
/api/events/settings/mobile-app-alert-configs/{id}
Get Mobile Smart Alert Config
POST
/api/events/settings/mobile-app-alert-configs/{id}
Update Mobile Smart Alert Config
PUT
/api/events/settings/mobile-app-alert-configs/{id}/disable
Disable Mobile Smart Alert Config
PUT
/api/events/settings/mobile-app-alert-configs/{id}/enable
Enable Mobile Smart Alert Config
PUT
/api/events/settings/mobile-app-alert-configs/{id}/restore/{created}
Restore Mobile Smart Alert Config
POST
/api/events/settings/mobile-app-alert-configs/{id}/update-baseline
Recalculate Mobile Smart Alert Config Baseline
GET
/api/events/settings/mobile-app-alert-configs/{id}/versions
Get Mobile Smart Alert Config Versions
GET
/api/events/settings/website-alert-configs
Get all Website Smart Alert Configs
POST
/api/events/settings/website-alert-configs
Create Website Smart Alert Config
DELETE
/api/events/settings/website-alert-configs/{id}
Delete Website Smart Alert Config
GET
/api/events/settings/website-alert-configs/{id}
Get Website Smart Alert Config
POST
/api/events/settings/website-alert-configs/{id}
Update Website Smart Alert Config
PUT
/api/events/settings/website-alert-configs/{id}/disable
Disable Website Smart Alert Config
PUT
/api/events/settings/website-alert-configs/{id}/enable
Enable Website Smart Alert Config
PUT
/api/events/settings/website-alert-configs/{id}/restore/{created}
Restore Website Smart Alert Config
POST
/api/events/settings/website-alert-configs/{id}/update-baseline
Recalculate Website Smart Alert Config Baseline
GET
/api/events/settings/website-alert-configs/{id}/versions
Get Website Smart Alert Config Versions.
Schemas 53
The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are WithMetadata (21 properties), WebsiteAlertConfigWithMetadata (21 properties), CustomEventSpecificationWithLastUpdated (18 properties), Event (16 properties). Each schema is shown below with its type and property counts.
WebsiteTimeThreshold
object
The type of threshold to define the criteria when the event and alert triggers and resolves.
2 properties
1 required
Json
object
MobileAppAlertRule
object
3 properties
2 required
Author
object
2 properties
EventFilteringConfiguration
object
Event Filter Configuration for supporting the scope of the Alert Configuration. Applies a filter based on the application perspective or selected entities.
4 properties
ValidatedAlertingConfiguration
object
11 properties
5 required
AlertingConfiguration
object
7 properties
5 required
TagFilterExpression
object
2 required
WebsiteAlertRule
object
3 properties
2 required
BuiltInEventSpecification
object
10 properties
5 required
TagFilterExpressionElement
object
Boolean expression of tag filters to define the scope of relevant calls.
1 property
1 required
WebsiteAlertConfigWithMetadata
object
21 properties
8 required
AlertingConfigurationWithLastUpdated
object
8 properties
5 required
StaticStringField
object
2 required
HyperParam
object
List of hyper parameters of the Built-in Event Specification
7 properties
3 required
ThresholdConfigRule
object
1 property
1 required
TagFilter
object
3 required
CustomPayloadWithVersion
object
3 properties
2 required
MetaData
object
Action metadata.
5 properties
Problem
object
4 properties
1 required
MobileAppTimeThreshold
object
The type of threshold to define the criteria when the event and alert triggers and resolves.
2 properties
1 required
Field
object
List of fields that describe an action.
5 properties
3 required
CustomEventSpecification
object
13 properties
3 required
WebsiteAlertConfig
object
16 properties
7 required
SystemRuleLabel
object
2 properties
2 required
EventSpecificationInfo
object
10 properties
4 required
Threshold
object
Indicates the type of threshold this alert rule is evaluated on.
2 properties
2 required
IntegrationOverview
object
5 properties
3 required
AbstractIntegration
object
3 properties
3 required
TagCatalog
object
2 properties
2 required
ManualAlertingChannelConfiguration
object
2 properties
2 required
RuleWithThresholdWebsiteAlertRule
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
RuleWithThresholdMobileAppAlertRule
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
Tag
object
List of queryable tags available in a tagTree. Eg: call.erroneous. Consider these tags as attributes of a tagTree. Eg: Call tagTree has have Erroneous, Call na…
9 properties
2 required
TagTreeNode
object
Children tags of tagTree
3 properties
CustomEventSpecificationWithLastUpdated
object
18 properties
4 required
TagTreeLevel
object
The name of the tag dataset (tagTree) which can contain one or more tags as its attributes or children. Eg: Call. Consider this as the root of the tree where i…
7 properties
2 required
RuleInput
object
List of input rules of the Built-in Event Specification
2 properties
2 required
CustomPayloadConfiguration
object
1 property
1 required
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
MobileAppAlertConfig
object
16 properties
7 required
ValidatedAlertingChannelInputInfo
object
9 properties
3 required
Event
object
16 properties
5 required
BuiltInEventSpecificationWithLastUpdated
object
11 properties
5 required
AbstractRule
object
2 properties
1 required
Parameter
object
List of inputs to the action.
8 properties
3 required
Action
object
Automation action definition. When this is used in policy creation request, only id should be specified.
10 properties
5 required
CustomPayloadWithLastUpdated
object
2 properties
1 required
ManualCloseInfo
object
6 properties
2 required
ApiTag
object
2 properties
2 required
WithMetadata
object
21 properties
8 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Instana 12
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
#Event Settings