Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.0.1, at version 1.307.1417.

Requests are made against 2 base URLs: https://{unit}-{tenant}.instana.io, https://{domain}.

4 operations 4 paths 28 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.307.1417
Servers
https://{unit}-{tenant}.instana.io
https://{domain}
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

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.

Infrastructure Analyze 4

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…

POST
/api/infrastructure-monitoring/analyze/entities
Get infrastructure entities
getEntities body → 200
POST
/api/infrastructure-monitoring/analyze/entity-groups
Get grouped infrastructure entities with aggregated metrics
getEntityGroups body → 200
POST
/api/infrastructure-monitoring/analyze/entity-types
Get available entity types
getAvailablePlugins body → 200
POST
/api/infrastructure-monitoring/analyze/metrics
Get available metrics
getAvailableMetrics body → 200

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), GetInfrastructureQuery (8 properties), GetInfrastructureGroupsQuery (8 properties). Each schema is shown below with its type and property counts.

SingleValue
object
InfrastructureEntitiesResult
object
5 properties 1 required
GetAvailablePluginsQuery
object
2 properties 2 required
TagFilterExpressionElement
object
Boolean expression of tag filters to define the scope of relevant calls.
1 property 1 required
MetricQuery
object
AdjustedTimeframe
object
Time frame provided in API request is slightly adjusted in response for faster API response. For example, In request payload, if timeframe is 08:03 - 14:03, wh…
2 properties 1 required
AvailablePlugins
object
1 property
InfrastructureGroup
object
group of infrastructure entities
4 properties
Problem
object
4 properties 1 required
InfrastructureGroupsResult
object
5 properties 1 required
GetInfrastructureQuery
object
8 properties 3 required
TimeFrame
object
Time range for which the data should be retrieved.
2 properties
ArithmeticOperation
object
3 properties 3 required
ArithmeticOperand
object
InfrastructureItem
object
7 properties
GetInfrastructureGroupsQuery
object
8 properties 4 required
InfraExploreCursor
object
cursor to use between successive queries
NestedOperation
object
CursorPaginationInfraExploreCursor
object
2 properties 1 required
ArithmeticConfiguration
object
SimpleMetricConfiguration
object
2 required
AvailableMetrics
object
1 property
InfraMetricConfiguration
object
GetAvailableMetricsQuery
object
4 properties 2 required
EntityHealthInfo
object
2 properties 1 required
Order
object
Specifies the ordering of the results. It contains fields that define the sorting criteria, the collation for sorting, and the direction in which the results s…
3 properties 2 required
Event
object
16 properties 5 required
MetricMetadata
object
9 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-infrastructure-analyze-api-openapi.yml Raw ↑

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