Instana Synthetic Alert Configuration API
The API endpoints of this group can be used to manage alert configurations for Synthetic Monitoring.## Parameters:- **id:** ID of the alert configuration.- **name:** Name for the synthetic alert configuration, which is used as the title of the event when triggered.- **description:** Description for the synthetic alert configuration, which is used as the detials of the triggerd event.- **severity:** The severity of the alert when triggered, which is either `5` (Warning), or `10` (Critical).- **syntheticTestIds:** List of synthetic test IDs this alert configuration is applied to. Check out APIs in [Synthetic Monitoring](#tag/Synthetic-Settings) to e.g. get a [list of all synthetic tests](#operation/getSyntheticTests) available.- **rule:** Indicates the type of rule this alert configuration is about. The only `alertType` available so far is `"failure"`, where the metric name `"status"` is expected. This boolean metric requires no threshold to be specified, because value of `status=0` indicates a test failure.- **timeThreshold:** Defines the triggering condition in time, such as how many consecutive test failures are required to open an event. Setting a higher value for `violationsCount` helps to reduce the number of alerts.- **alertChannelIds:** List of IDs of alert channels defined in Instana.
Instana Synthetic 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 Synthetic 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 9 schemas. It is described by OpenAPI 3.2.0, 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 Synthetic 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.
The API endpoints of this group can be used to manage alert configurations for Synthetic Monitoring.
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SyntheticAlertConfigWithMetadata (15 properties), SyntheticAlertConfig (10 properties), ConfigVersion (5 properties), SyntheticAlertRule (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.
This is an independent, third-party profile of Instana Synthetic Alert Configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.