# Instana Synthetic Alert Configuration API

**Canonical:** https://apis.io/apis/instana/instana-synthetic-alert-configuration-api/  
**Provider:** Instana — https://apis.io/providers/instana/  
**Documentation:** https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api

Instana Synthetic Alert Configuration API is one of 62 APIs that [Instana](https://apis.io/providers/instana/) publishes on the [APIs.io](https://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.

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.

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/instana/refs/heads/main/openapi/instana-synthetic-alert-configuration-api-openapi.yml
- **Documentation** — https://instana.github.io/openapi/
- **GitHubOrganization** — https://github.com/instana/openapi

## Other Instana APIs (12)

- [Instana Action Catalog API](https://apis.io/apis/instana/instana-action-catalog-api/)
- [Instana Action History API](https://apis.io/apis/instana/instana-action-history-api/)
- [Instana AI Management API](https://apis.io/apis/instana/instana-ai-management-api/)
- [Instana Apdex Report API](https://apis.io/apis/instana/instana-apdex-report-api/)
- [Instana Apdex Settings API](https://apis.io/apis/instana/instana-apdex-settings-api/)
- [Instana API Token API](https://apis.io/apis/instana/instana-api-token-api/)
- [Instana Application Alert Configuration API](https://apis.io/apis/instana/instana-application-alert-configuration-api/)
- [Instana Application Analyze API](https://apis.io/apis/instana/instana-application-analyze-api/)
- [Instana Application Catalog API](https://apis.io/apis/instana/instana-application-catalog-api/)
- [Instana Application Metrics API](https://apis.io/apis/instana/instana-application-metrics-api/)
- [Instana Application Resources API](https://apis.io/apis/instana/instana-application-resources-api/)
- [Instana Application Settings API](https://apis.io/apis/instana/instana-application-settings-api/)

## Tags

Synthetic Alert Configuration

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/instana/instana-synthetic-alert-configuration-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/instana/.