openapi: 3.0.1
info:
contact:
email: support@instana.com
name: © Instana
url: http://instana.com
termsOfService: https://www.instana.com/terms-of-use/
title: Instana REST API documentation Infrastructure Analyze API
version: 1.307.1417
x-ibm-ahub-try: true
x-logo:
altText: instana logo
backgroundColor: '#FAFBFC'
url: header-logo.svg
description: "Searching for answers and best pratices? Check our [IBM Instana Community](https://community.ibm.com/community/user/aiops/communities/community-home?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f).\n\n<div style=\"background-color:#e6f0ff; padding: 12px; border-left: 6px solid #0052cc; font-size: 14px; display: flex; align-items: center;\">\n <img src=\"https://img.icons8.com/ios-filled/50/0052cc/info.png\" width=\"18\" height=\"18\" style=\"margin-right: 8px;\" alt=\"info icon\"/>\n <span>\n <b>Our API documentation is moving to</b> \n <a href=\"https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Introduction\" target=\"_blank\">API Hub</a>\n\t — please update your bookmarks now, as the current site will be deprecated after Release-306.\n </span>\n</div>\n\n## Overview\nThe Instana REST API provides programmatic access to the Instana platform. It can be used to retrieve data available through the Instana UI Dashboard -- metrics, events, traces, etc -- and also to automate configuration tasks such as user management.\n\n### Navigating the API documentation\nThe API endpoints are grouped by product area and functionality. This generally maps to how our UI Dashboard is organized, hopefully making it easier to locate which endpoints you'd use to fetch the data you see visualized in our UI. The [UI sections](https://www.ibm.com/docs/en/instana-observability/current?topic=working-user-interface#navigation-menu) include:\n- Websites & Mobile Apps\n- Applications\n- Infrastructure\n- Synthetic Monitoring\n- Events\n- Automation\n- Service Levels\n- Settings\n- etc\n\n### Rate Limiting\nA rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server.\n\n- **X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour.\n- **X-RateLimit-Remaining:** How many calls may still be executed within the current hour.\n- **X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00.\n\n### Further Reading\nWe provide additional documentation for our REST API in our [product documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api). Here you'll also find some common queries for retrieving data and configuring Instana.\n\n## Getting Started with the REST API\n\n### API base URL\nThe base URL for an specific instance of Instana can be determined using the tenant and unit information.\n- `base`: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface.\n- `apiToken`: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself.\n\n### Curl Example\nHere is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call.\n\n```bash\ncurl --request GET \\\n --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\\n --header 'authorization: apiToken xxxxxxxxxxxxxxxx'\n```\n\nNext we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example.\n\n```bash\ncurl --request POST \\\n --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\\n --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\\n --header 'content-type: application/json' \\\n --data '{\n \"group\":{\n \"groupbyTag\":\"endpoint.name\"\n },\n \"tagFilters\":[\n \t{\n \t\t\"name\":\"call.error.count\",\n \t\t\"value\":\"0\",\n \t\t\"operator\":\"GREATER_THAN\"\n \t}\n ],\n \"metrics\":[\n \t{\n \t\t\"metric\":\"errors\",\n \t\t\"aggregation\":\"MEAN\"\n \t}\n ]\n }'\n```\n\n### Generating REST API clients\n\nThe API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format.\nYou can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml).\n\nOpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made.\nTo generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator).\n\n#### Go\nFor example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit:\n\n```bash\n#!/bin/bash\n\n### This script assumes you have the `java` and `wget` commands on the path\n\nexport UNIT_NAME='myunit' # for example: prod\nexport TENANT_NAME='mytenant' # for example: awesomecompany\n\n//Download the generator to your current working directory:\nwget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\"\n\n//generate a client library that you can vendor into your repository\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\\n -o pkg/instana/openapi \\\n --skip-validate-spec\n\n//(optional) format the Go code according to the Go code standard\ngofmt -s -w pkg/instana/openapi\n```\n\nThe generated clients contain comprehensive READMEs, and you can start right away using the client from the example above:\n\n```go\nimport instana \"./pkg/instana/openapi\"\n\n// readTags will read all available application monitoring tags along with their type and category\nfunc readTags() {\n\tconfiguration := instana.NewConfiguration()\n\tconfiguration.Host = \"tenant-unit.instana.io\"\n\tconfiguration.BasePath = \"https://tenant-unit.instana.io\"\n\n\tclient := instana.NewAPIClient(configuration)\n\tauth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{\n\t\tKey: apiKey,\n\t\tPrefix: \"apiToken\",\n\t})\n\n\ttags, _, err := client.ApplicationCatalogApi.GetApplicationTagCatalog(auth)\n\tif err != nil {\n\t\tfmt.Fatalf(\"Error calling the API, aborting.\")\n\t}\n\n\tfor _, tag := range tags {\n\t\tfmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name)\n\t}\n}\n```\n\n#### Java\nFollow the instructions provided in the official documentation from [OpenAPI Tools](https://github.com/OpenAPITools) to download the [openapi-generator-cli.jar](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#13---download-jar).\n\nDepending on your environment, use one of the following java http client implementations which will create a valid client for our OpenAPI specification:\n```\n//Nativ Java HTTP Client\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8 --library native\n\n//Spring WebClient\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient\n\n//Spring RestTemplate\njava -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate\n\n```\n"
servers:
- description: Instana Backend
url: https://{unit}-{tenant}.instana.io
variables:
tenant:
default: tenant
description: Customer tenant unit
unit:
default: unit
description: Customer tenant name
- description: Instana Self-Hosted Backend
url: https://{domain}
variables:
domain:
default: example.com
description: Customer Self-Hosted domain
tags:
- name: Infrastructure Analyze
description: "This endpoint group exposes the functions that are used by the Instana **Analyze Infrastructure** dashboards.\nTwo of the endpoints provide a [list of entity types](#operation/getAvailablePlugins) and [metrics for an entity type](#operation/getAvailableMetrics).\nIt is also possible to [search and filter entities](#operation/getEntities) and [aggregate metrics on similar entities](#operation/getEntityGroups).\n\n## Important notes\n\n### Prerequisites\n\nFor self-hosted installations, BeeInstana is required for this endpoint group.\nSee this [documentation for enabling BeeInstana](https://www.ibm.com/docs/en/instana-observability/current?topic=premises-installing-instana-backend-docker#beeinstana-metric-pipeline-beta).\n\n### Timeframe\n\n**timeFrame** As in the Instana dashboards, you can specify the timeframe for metrics retrieval.\n```\n windowSize to\n (ms) (unix-timestamp)\n<----------------------|\n```\nThe 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.\n\n### Metrics\n\n**metric** refers to the metric name. Query the [list of available metrics](#operation/getAvailableMetrics) for existing metrics on an entity type.\nThis is to be used when requesting metrics or when ordering by a metric. For **order.by**, `label` may also be used.\n\n### Filtering\n\nAs in the Instana dashboards, you can **filter by a tag**. Query the [infrastructure tag catalog](#operation/getInfrastructureCatalogMetrics) to retrieve a list of available tags."
paths:
/api/infrastructure-monitoring/analyze/entities:
post:
description: 'This endpoint retrieves entities for a given entity type along with the requested metrics.
For more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze.'
operationId: getEntities
requestBody:
content:
application/json:
examples:
? This example retrieves a JVM entity labeled "custom-metrics.jar" with metrics for memory used and blocked threads (both using a one hour granularity and a one minute granularity).
: description: This example retrieves a JVM entity labeled "custom-metrics.jar" with metrics for memory used and blocked threads (both using a one hour granularity and a one minute granularity).
value:
tagFilterExpression:
type: TAG_FILTER
entity: NOT_APPLICABLE
name: label
operator: EQUALS
value: custom-metrics.jar
timeFrame:
to: 1673969562715
windowSize: 3600000
pagination:
retrievalSize: 200
type: jvmRuntimePlatform
metrics:
- metric: memory.used
granularity: 3600000
aggregation: MAX
- metric: memory.used
granularity: 600000
aggregation: MAX
- metric: threads.blocked
granularity: 3600000
aggregation: MEAN
- metric: threads.blocked
granularity: 600000
aggregation: MEAN
schema:
$ref: '#/components/schemas/GetInfrastructureQuery'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InfrastructureEntitiesResult'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get infrastructure entities
tags:
- Infrastructure Analyze
x-ibm-ahub-byok: true
/api/infrastructure-monitoring/analyze/entity-groups:
post:
description: 'This endpoint groups entities for a given entity type and aggregates metrics for these groups.
For more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze.'
operationId: getEntityGroups
requestBody:
content:
application/json:
examples:
? This example retrieves JVM entities grouped with the same host name ordered by label, aggregating memory used and blocked threads (both using a one hour granularity and a one minute granularity).
: description: This example retrieves JVM entities grouped with the same host name ordered by label, aggregating memory used and blocked threads (both using a one hour granularity and a one minute granularity).
value:
timeFrame:
to: 1674075565075
windowSize: 3600000
tagFilterExpression:
type: EXPRESSION
logicalOperator: AND
elements: []
pagination:
retrievalSize: 20
groupBy:
- host.name
type: jvmRuntimePlatform
metrics:
- metric: memory.used
granularity: 3600000
aggregation: MEAN
- metric: memory.used
granularity: 600000
aggregation: MEAN
- metric: threads.blocked
granularity: 3600000
aggregation: MEAN
- metric: threads.blocked
granularity: 600000
aggregation: MEAN
order:
by: label
direction: ASC
schema:
$ref: '#/components/schemas/GetInfrastructureGroupsQuery'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InfrastructureGroupsResult'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get grouped infrastructure entities with aggregated metrics
tags:
- Infrastructure Analyze
x-ibm-ahub-byok: true
/api/infrastructure-monitoring/analyze/entity-types:
post:
description: 'This endpoint retrieves available entity types.
For more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze.'
operationId: getAvailablePlugins
requestBody:
content:
application/json:
examples:
This example retrieves all entity types.:
description: This example retrieves all entity types.
value:
tagFilterExpression:
type: EXPRESSION
logicalOperator: AND
elements: []
timeFrame:
to: 1673969562715
windowSize: 3600000
schema:
$ref: '#/components/schemas/GetAvailablePluginsQuery'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailablePlugins'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get available entity types
tags:
- Infrastructure Analyze
x-ibm-ahub-byok: true
/api/infrastructure-monitoring/analyze/metrics:
post:
description: 'This endpoint retrieves available metrics for an entity type.
For more information on Infrastructure Analyze please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Infrastructure#infrastructure-analyze.'
operationId: getAvailableMetrics
requestBody:
content:
application/json:
examples:
This example retrieves all available metrics for JVM entities.:
description: This example retrieves all available metrics for JVM entities.
value:
tagFilterExpression:
type: EXPRESSION
logicalOperator: AND
elements: []
timeFrame:
to: 1673969562715
windowSize: 3600000
query: ''
type: jvmRuntimePlatform
schema:
$ref: '#/components/schemas/GetAvailableMetricsQuery'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailableMetrics'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get available metrics
tags:
- Infrastructure Analyze
x-ibm-ahub-byok: true
components:
schemas:
SingleValue:
type: object
allOf:
- $ref: '#/components/schemas/ArithmeticOperand'
- type: object
properties:
value:
type: number
format: double
InfrastructureEntitiesResult:
type: object
properties:
adjustedTimeframe:
$ref: '#/components/schemas/AdjustedTimeframe'
canLoadMore:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/InfrastructureItem'
next:
$ref: '#/components/schemas/InfraExploreCursor'
totalHits:
type: integer
format: int64
description: represents the total number of results
minimum: 0
required:
- items
GetAvailablePluginsQuery:
type: object
properties:
tagFilterExpression:
$ref: '#/components/schemas/TagFilterExpressionElement'
timeFrame:
$ref: '#/components/schemas/TimeFrame'
required:
- tagFilterExpression
- timeFrame
TagFilterExpressionElement:
type: object
description: Boolean expression of tag filters to define the scope of relevant calls.
discriminator:
mapping:
EXPRESSION: '#/components/schemas/TagFilterExpression'
TAG_FILTER: '#/components/schemas/TagFilter'
propertyName: type
properties:
type:
type: string
required:
- type
MetricQuery:
type: object
allOf:
- $ref: '#/components/schemas/ArithmeticOperand'
- type: object
properties:
aggregation:
type: string
enum:
- SUM
- MEAN
- MAX
- MIN
- P25
- P50
- P75
- P90
- P95
- P98
- P99
- P99_9
- P99_99
- DISTINCT_COUNT
- SUM_POSITIVE
- PER_SECOND
- INCREASE
writeOnly: true
crossSeriesAggregation:
type: string
enum:
- SUM
- MEAN
- MAX
- MIN
- P25
- P50
- P75
- P90
- P95
- P98
- P99
- P99_9
- P99_99
- DISTINCT_COUNT
- SUM_POSITIVE
- PER_SECOND
- INCREASE
writeOnly: true
granularity:
type: integer
format: int64
writeOnly: true
metric:
type: string
writeOnly: true
regex:
type: boolean
writeOnly: true
required:
type: boolean
writeOnly: true
AdjustedTimeframe:
type: object
description: '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, which is a 6 hour window size. It is adjusted to 08:05 - 14:00
Another example, In request payload, if timeframe is 08:20 - 08:20 (next day) which is a 24h window size. It is adjusted to 08:30 - 08:00 (next day)
'
properties:
to:
type: integer
format: int64
description: 'end of timeframe expressed as the Unix epoch time in milliseconds. Eg: `ISO 8601` standard time `2024-06-27T05:05:55.615Z` can be represented as `1719464755615` in Unix epoch time in milliseconds.'
windowSize:
type: integer
format: int64
description: windowSize in milliseconds
minimum: 0
required:
- to
AvailablePlugins:
type: object
properties:
plugins:
type: array
items:
type: string
uniqueItems: true
InfrastructureGroup:
type: object
description: group of infrastructure entities
properties:
count:
type: integer
format: int64
description: number of entities in this group
metrics:
type: object
additionalProperties:
type: array
description: map of metric keys to array of timestamp,value pairs
items:
type: array
description: map of metric keys to array of timestamp,value pairs
items:
type: number
description: map of metric keys to array of timestamp,value pairs
description: map of metric keys to array of timestamp,value pairs
pollRate:
type: integer
format: int64
description: max poll rate across this group
tags:
type: object
additionalProperties:
type: object
description: tag keys and values for this group
description: tag keys and values for this group
Problem:
type: object
properties:
fixSuggestion:
type: string
maxLength: 65536
minLength: 0
id:
type: string
maxLength: 64
minLength: 0
problemText:
type: string
maxLength: 2048
minLength: 0
severity:
type: integer
format: int32
required:
- id
InfrastructureGroupsResult:
type: object
properties:
adjustedTimeframe:
$ref: '#/components/schemas/AdjustedTimeframe'
canLoadMore:
type: boolean
items:
type: array
items:
$ref: '#/components/schemas/InfrastructureGroup'
next:
$ref: '#/components/schemas/InfraExploreCursor'
totalHits:
type: integer
format: int64
description: represents the total number of results
minimum: 0
required:
- items
GetInfrastructureQuery:
type: object
properties:
metrics:
type: array
items:
$ref: '#/components/schemas/InfraMetricConfiguration'
maxItems: 10
minItems: 0
missingPlaceholder:
type: string
order:
$ref: '#/components/schemas/Order'
pagination:
$ref: '#/components/schemas/CursorPaginationInfraExploreCursor'
tagFilterExpression:
$ref: '#/components/schemas/TagFilterExpressionElement'
tags:
type: array
items:
type: string
maxItems: 5
minItems: 0
timeFrame:
$ref: '#/components/schemas/TimeFrame'
type:
type: string
description: Type of entities
required:
- pagination
- tagFilterExpression
- timeFrame
TimeFrame:
type: object
description: Time range for which the data should be retrieved.
properties:
to:
type: integer
format: int64
description: 'end of timeframe expressed as the Unix epoch time in milliseconds. Eg: `ISO 8601` standard time `2024-06-27T05:05:55.615Z` can be represented as `1719464755615` in Unix epoch time in milliseconds.'
windowSize:
type: integer
format: int64
description: windowSize in milliseconds
maximum: 2678400000
minimum: 0
ArithmeticOperation:
type: object
discriminator:
mapping:
ADDITION: '#/components/schemas/Addition'
DIVISION: '#/components/schemas/Division'
MULTIPLICATION: '#/components/schemas/Multiplication'
SUBTRACTION: '#/components/schemas/Subtraction'
propertyName: operator
properties:
left:
$ref: '#/components/schemas/ArithmeticOperand'
operator:
type: string
right:
$ref: '#/components/schemas/ArithmeticOperand'
required:
- left
- operator
- right
ArithmeticOperand:
type: object
oneOf:
- $ref: '#/components/schemas/SingleValue'
- $ref: '#/components/schemas/MetricQuery'
- $ref: '#/components/schemas/NestedOperation'
InfrastructureItem:
type: object
properties:
entityHealthInfo:
$ref: '#/components/schemas/EntityHealthInfo'
label:
type: string
metrics:
type: object
additionalProperties:
type: array
items:
type: array
items:
type: number
plugin:
type: string
snapshotId:
type: string
tags:
type: object
additionalProperties:
type: string
time:
type: integer
format: int64
description: Epoch time in milliseconds if the snapshot is offline. Set to 9223372036854775807 if the snapshot is online.
GetInfrastructureGroupsQuery:
type: object
properties:
groupBy:
type: array
description: Entity grouping tag. Use the Instana Analyze Infrastructure dashboard to determine the entity grouping tag name.
items:
type: string
description: Entity grouping tag. Use the Instana Analyze Infrastructure dashboard to determine the entity grouping tag name.
maxItems: 5
minItems: 0
metrics:
type: array
items:
$ref: '#/components/schemas/InfraMetricConfiguration'
maxItems: 10
minItems: 0
missingPlaceholder:
type: string
order:
$ref: '#/components/schemas/Order'
pagination:
$ref: '#/components/schemas/CursorPaginationInfraExploreCursor'
tagFilterExpression:
$ref: '#/components/schemas/TagFilterExpressionElement'
timeFrame:
$ref: '#/components/schemas/TimeFrame'
type:
type: string
description: Type of entities
required:
- groupBy
- pagination
- tagFilterExpression
- timeFrame
InfraExploreCursor:
type: object
description: cursor to use between successive queries
NestedOperation:
type: object
allOf:
- $ref: '#/components/schemas/ArithmeticOperand'
- type: object
properties:
operation:
$ref: '#/components/schemas/ArithmeticOperation'
CursorPaginationInfraExploreCursor:
type: object
properties:
cursor:
$ref: '#/components/schemas/InfraExploreCursor'
retrievalSize:
type: integer
format: int32
description: number of values to return
required:
- retrievalSize
ArithmeticConfiguration:
type: object
allOf:
- $ref: '#/components/schemas/InfraMetricConfiguration'
- type: object
properties:
operation:
$ref: '#/components/schemas/ArithmeticOperation'
SimpleMetricConfiguration:
type: object
allOf:
- $ref: '#/components/schemas/InfraMetricConfiguration'
- type: object
properties:
aggregation:
type: string
enum:
- SUM
- MEAN
- MAX
- MIN
- P25
- P50
- P75
- P90
- P95
- P98
- P99
- P99_9
- P99_99
- DISTINCT_COUNT
- SUM_POSITIVE
- PER_SECOND
- INCREASE
crossSeriesAggregation:
type: string
enum:
- SUM
- MEAN
- MAX
- MIN
- P25
- P50
- P75
- P90
- P95
- P98
- P99
- P99_9
- P99_99
- DISTINCT_COUNT
- SUM_POSITIVE
- PER_SECOND
- INCREASE
granularity:
type: integer
format: int64
description: " * If granularity is not specified an aggregated value for the selected timeframe is returned.\n * If granularity is specified data points are returned with the specified granularity\n * The granularity should not be greater than the `windowSize` (important: `windowSize` is expressed in milliseconds)\n * The granularity should not be set too small relative to the `windowSize` to avoid creating an excessively large number of data points (max 600)\n"
title: granularity in milliseconds
metric:
type: string
regex:
type: boolean
required:
type: boolean
description: When true, metric must be present with values
required:
- aggregation
- metric
AvailableMetrics:
type: object
properties:
metrics:
type: array
items:
$ref: '#/components/schemas/MetricMetadata'
uniqueItems: true
InfraMetricConfiguration:
type: object
oneOf:
- $ref: '#/components/schemas/SimpleMetricConfiguration'
- $ref: '#/components/schemas/ArithmeticConfiguration'
GetAvailableMetricsQuery:
type: object
properties:
query:
type: string
description: Search term used to filter results using fields such as label, description, tag name or keywords
maxLength: 200
minLength: 0
tagFilterExpression:
$ref: '#/components/schemas/TagFilterExpressionElement'
timeFrame:
$ref: '#/components/schemas/TimeFrame'
type:
type: string
description: Entity type. Identifier for the monitored technology.
required:
- tagFilterExpression
- timeFrame
EntityHealthInfo:
type: object
properties:
maxSeverity:
type: number
format: double
maximum: 10
minimum: 0
openIssues:
type: array
items:
$ref: '#/components/schemas/Event'
uniqueItems: true
required:
- openIssues
Order:
type: object
description: '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 should be ordered.
'
properties:
by:
type: string
description: If the granularity is set to `1` you can use the metric name eg. `la
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/instana/refs/heads/main/openapi/instana-infrastructure-analyze-api-openapi.yml