Instana Synthetic Calls API
The API endpoints of this group can fetch, update and delete the synthetic endpoint configuration rules.**Note:** There are some following restrictions to use `matchSpecification` parameter for Synthetic endpoint configuration: 1. `matchSpecification.type` should be `LEAF`.2. `matchSpecification.key` should be always be `endpoint.name`.3. `matchSpecification.operator` should be among the following options: `EQUALS`, `CONTAINS`, `STARTS_WITH`, `ENDS_WITH`, `NOT_STARTS_WITH`, `NOT_ENDS_WITH`.4. `matchSpecification.entity` should be `DESTINATION` as health check endpoint is considered as a destination endpoint.
Instana Synthetic Calls 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 Calls. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 1 path, and defines 4 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}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Instana Synthetic Calls 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 3
Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The API endpoints of this group can fetch, update and delete the synthetic endpoint configuration rules. Note: There are some following restrictions to use matchSpecification para…
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SyntheticCallRule (4 properties), SyntheticCallWithDefaultsConfig (3 properties), SyntheticCallConfig (2 properties), MatchExpressionDTO (1 property). 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.