Instana Infrastructure Analyze API
This endpoint group exposes the functions that are used by the Instana **Analyze Infrastructure** dashboards.Two of the endpoints provide a [list of entity types](#operation/getAvailablePlugins) and [metrics for an entity type](#operation/getAvailableMetrics).It is also possible to [search and filter entities](#operation/getEntities) and [aggregate metrics on similar entities](#operation/getEntityGroups).## Important notes### PrerequisitesFor self-hosted installations, BeeInstana is required for this endpoint group.See this [documentation for enabling BeeInstana](https://www.ibm.com/docs/en/instana-observability/current?topic=premises-installing-instana-backend-docker#beeinstana-metric-pipeline-beta).### Timeframe**timeFrame** As in the Instana dashboards, you can specify the timeframe for metrics retrieval.``` windowSize to (ms) (unix-timestamp)<----------------------|```The timeFrame might be adjusted to fit the metric granularity so that there is no partial bucket. For example, if the query timeFrame is 08:02 - 09:02 and the metric granularity is 5 minutes, the timeFrame will be adjusted to 08:05 - 09:00. The adjusted timeFrame will be returned in the response payload. If the query does not have any metric with specified granularity, a default granularity will be used for adjustment.### Metrics**metric** refers to the metric name. Query the [list of available metrics](#operation/getAvailableMetrics) for existing metrics on an entity type.This is to be used when requesting metrics or when ordering by a metric. For **order.by**, `label` may also be used.### FilteringAs in the Instana dashboards, you can **filter by a tag**. Query the [infrastructure tag catalog](#operation/getInfrastructureCatalogMetrics) to retrieve a list of available tags.
Instana Infrastructure Analyze API is one of 62 APIs that Instana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Infrastructure Analyze. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 4 operations across 4 paths, and defines 28 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 Infrastructure Analyze 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 4
Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.
This endpoint group exposes the functions that are used by the Instana Analyze Infrastructure dashboards. Two of the endpoints provide a [list of entity types](operation/getAvaila…
Schemas 28
The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Event (16 properties), MetricMetadata (9 properties), GetInfrastructureGroupsQuery (8 properties), GetInfrastructureQuery (8 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 Infrastructure Analyze 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.