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 Catalog API

The endpoints of this group retrieve all available resources to query infrastructure metrics.

Instana Infrastructure Catalog 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 Catalog. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 8 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}.

7 operations 7 paths 8 schemas 7 GET

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 Catalog 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 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Infrastructure Catalog 7

The endpoints of this group retrieve all available resources to query infrastructure metrics.

GET
/api/infrastructure-monitoring/catalog/metrics/{plugin}
Get metric catalog
getInfrastructureCatalogMetrics 4 params → 200
GET
/api/infrastructure-monitoring/catalog/payloads/{pluginId}
Get payload keys for plugin
getAvailablePayloadKeysByPluginId 1 param → 200
GET
/api/infrastructure-monitoring/catalog/plugins
Get plugin catalog
getInfrastructureCatalogPlugins → 200
GET
/api/infrastructure-monitoring/catalog/plugins-with-custom-metrics
Get all plugins with custom metrics catalog
getInfrastructureCatalogPluginsWithCustomMetrics → 200
GET
/api/infrastructure-monitoring/catalog/search
get search field catalog
getInfrastructureCatalogSearchFields → 200
GET
/api/infrastructure-monitoring/catalog/tags
Get available tags
getTagCatalogAll → 200
GET
/api/infrastructure-monitoring/catalog/tags/{plugin}
Get available tags for a particular plugin
getTagCatalog 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Tag (9 properties), TagTreeLevel (7 properties), MetricInstance (6 properties), SearchFieldResult (5 properties). Each schema is shown below with its type and property counts.

TagCatalog
object
2 properties 2 required
PluginResult
object
2 properties
Tag
object
List of queryable tags available in a tagTree. Eg: call.erroneous. Consider these tags as attributes of a tagTree. Eg: Call tagTree has have Erroneous, Call na…
9 properties 2 required
GetPayloadKeysResult
object
1 property
TagTreeNode
object
Children tags of tagTree
3 properties
MetricInstance
object
6 properties 5 required
SearchFieldResult
object
5 properties
TagTreeLevel
object
The name of the tag dataset (tagTree) which can contain one or more tags as its attributes or children. Eg: Call. Consider this as the root of the tree where i…
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-infrastructure-catalog-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