Instana Infrastructure Resources API
The Infrastructure Resources API from Instana — 5 operation(s) for infrastructure resources.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/instana-infrastructure-resources-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
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 Resources 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?
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 Resources
paths:
/api/infrastructure-monitoring/monitoring-state:
get:
description: This API endpoint retrieves the current monitoring state of the system, providing details about the number of monitored hosts and serverless entities. It responds with a JSON object containing this information.
operationId: getMonitoringState
responses:
'200':
content:
application/json:
example:
hasEntities: true
hostCount: 122
serverlessCount: 7
schema:
$ref: '#/components/schemas/MonitoringState'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Monitored host count
tags:
- Infrastructure Resources
x-ibm-ahub-byok: true
/api/infrastructure-monitoring/payloads/{snapshotId}/{payloadKey}:
get:
operationId: getPluginPayload
parameters:
- description: Snapshot id.
in: path
name: snapshotId
required: true
schema:
type: string
- description: Payload key. Use [getAvailablePayloadKeysByPluginId](/openapi/#operation/getAvailablePayloadKeysByPluginId) to retrieve the list of possible keys.
example: topqueries
in: path
name: payloadKey
required: true
schema:
type: string
- description: End of timeframe expressed as the Unix epoch time in milliseconds.
example: 1689018652000
in: query
name: to
schema:
type: integer
format: int64
- description: Window size in milliseconds.
example: 3600000
in: query
name: windowSize
schema:
type: integer
format: int64
responses:
'200':
content:
application/json:
example:
raw_payload:
- DEFERRED_VALUE: '64'
DEFERRED_VALUE_FLAGS: NONE
VALUE: '64'
NAME: app_ctl_heap_sz
VALUE_FLAGS: NONE
timestamp: 1707833086000
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get a payload for a snapshot
tags:
- Infrastructure Resources
x-ibm-ahub-byok: true
/api/infrastructure-monitoring/snapshots:
get:
operationId: getSnapshots
parameters:
- description: query to use to filter snapshot retrieval
example: entity.zone:myZone*
in: query
name: query
schema:
type: string
- description: end of timeframe expressed as the Unix epoch time in milliseconds
example: 1689018652000
in: query
name: to
schema:
type: integer
format: int64
- description: windowSize in milliseconds
example: 3600000
in: query
name: windowSize
schema:
type: integer
format: int64
- description: maximum number of snapshots to retrieve
example: 100
in: query
name: size
schema:
type: integer
format: int32
- description: entity type
example: host
in: query
name: plugin
schema:
type: string
- description: retrieve snapshots which were online during the timeframe, otherwise, return only snapshot which were online at the end of the timeframe
example: false
in: query
name: offline
schema:
type: boolean
responses:
'200':
content:
application/json:
example:
items:
- snapshotId: ZoKkksp277FMLSXIghPKdjZcvfE
plugin: host
from: 1706785156000
to: null
tags: []
label: ip-10-255-200-30.instana.io
host: EC2-i-03afb0ac5188f57f3
- snapshotId: ONRQyD-iztZX6QS9QnjKbFFy-oI
plugin: host
from: 1706756437000
to: null
tags: []
label: ip-10-255-218-45.instana.io
host: EC2-i-091cba86bac58cc77
- snapshotId: 0GvRrdko-0Ds9OWPzJVEm0j0vTA
plugin: host
from: 1706785131000
to: null
tags: []
label: ip-10-255-203-60.instana.io
host: EC2-i-0d2743935b9596c85
schema:
$ref: '#/components/schemas/SnapshotResult'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Search snapshots
tags:
- Infrastructure Resources
x-ibm-ahub-byok: true
description: 'These APIs can be used to retrieve information about hosts, processes, JVMs and other entities that we are calling snapshots. A snapshot represents static information about an entity as it was at a specific point in time. To clarify:
**Static information** is any information which is seldom changing, e.g. process IDs, host FQDNs or a list of host hard disks. The counterpart to static information are metrics which have a much higher change rate, e.g. host CPU usage or JVM garbage collection activity. Snapshots only contain static information.
- Snapshots are **versioned** and represent an entity''s state for a specific point in time. While snapshots only contain static information, even that information may change. For example you may add another hard disk to a server. For such a change, a new snapshot would be created.
- The **size** parameter can be used in order to limit the maximum number of retrieved snapshots.
- The **offline** parameter is used to allow deeper visibility into snapshots. Set to `false`, the query will return all snapshots that are still available on the given **to** timestamp. However, set to `true`, the query will return all snapshots that have been active within the time window, this must at least include the online result and snapshots terminated within this time.'
post:
description: This endpoint retrieves detail information for one or more snapshots. timeFrame defaults to the last 10 minutes if not specified.
operationId: postSnapshots
requestBody:
content:
application/json:
examples:
This example retrieves the detail information for two snapshots.:
description: This example retrieves the detail information for two snapshots.
value:
snapshotIds:
- AB3DeFGHIJkLm9OpQrstUVwxY_z
- ZY4XwVUTSRqPo8MlKjihGFedC_a
timeFrame:
to: 1689018652000
windowSize: 3600000
schema:
$ref: '#/components/schemas/GetSnapshotsQuery'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PostSnapshotsResult'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get snapshot details for multiple snapshots
tags:
- Infrastructure Resources
x-ibm-ahub-byok: true
/api/infrastructure-monitoring/snapshots/{id}:
get:
description: Get all snapshot information
operationId: getSnapshot
parameters:
- description: snapshot id
in: path
name: id
required: true
schema:
type: string
- description: end of timeframe expressed as the Unix epoch time in milliseconds
example: 1689018652000
in: query
name: to
schema:
type: integer
format: int64
- description: windowSize in milliseconds
example: 3600000
in: query
name: windowSize
schema:
type: integer
format: int64
responses:
'200':
content:
application/json:
example:
snapshotId: ZoKkksp277FMLSXIghPKdjZcvfE
plugin: host
from: 1706785156000
tags: []
label: ip-10-255-200-30.instana.io
entityId:
host: EC2-i-03afb0ac5188f57f3
pluginId: com.instana.forge.infrastructure.os.host.Host
steadyId: h
data:
interfaces:
eth0:
addresses:
- subnet: 10.255.200.0
fqdn:
- 10-255-200-30.instana-agent-headless.instana-agent.svc.cluster.local
- 10-255-200-30.instana-agent.instana-agent.svc.cluster.local
- 10-255-200-30.prometheus-prometheus-node-exporter.prometheus.svc.cluster.local
ip: 10.255.200.30
mac: 06:00:E9:32:99:C5
eth1:
addresses:
- subnet: 10.255.200.0
ip: 10.255.205.14
mac: 06:93:A2:5B:97:D9
cpu.model: AMD EPYC 7R13 Processor
fqdn: ip-10-255-200-30.instana.io
bootId: 3b7e2fe9-7cff-42bb-9879-6b856582fa27
os.arch: amd64
start: 1694791889000
memory.total: 65994727424
openFiles.max: 6441978
filesystems:
/dev/nvme0n1p1:
options: rw,noatime,attr2,inode64,logbufs=8,logbsize=32k,noquota
mounts:
- /var/lib/kubelet/pods/dc320aef-ef0e-499a-8eb2-56cb454c22d6/volume-subpaths/configuration/instana-agent/11
- /var/lib/kubelet/pods/dc320aef-ef0e-499a-8eb2-56cb454c22d6/volume-subpaths/configuration/instana-agent/14
- /var/lib/kubelet/pods/dc320aef-ef0e-499a-8eb2-56cb454c22d6/volume-subpaths/additional-backend-2/instana-agent/12
- /var/lib/kubelet/pods/dc320aef-ef0e-499a-8eb2-56cb454c22d6/volume-subpaths/additional-backend-3/instana-agent/13
- /
systype: xfs
icapacity: 28180816
mount: /
capacity: 83873772
os.version: 5.10.186-179.751.amzn2.x86_64
tags: []
cpu.count: 8
hostname: ip-10-255-200-30
machineId: ec2f95ff87a4a46d4672835afb9e2bb5
systemSerialNumber: ec2f95ff-87a4-a46d-4672-835afb9e2bb5
os.name: Linux
schema:
$ref: '#/components/schemas/SnapshotItem'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get snapshot details
tags:
- Infrastructure Resources
x-ibm-ahub-byok: true
/api/infrastructure-monitoring/software/versions:
get:
description: 'Retrieve information about the software that are sensed by the agent remotely, natively, or both. This includes runtime and package manager information.
The `plugin`, `name`, `version`, `discoveryType`, `softwareType` and `vendor` parameters are optional filters that can be used to reduce the result data set.
The `snapshotId` in `usedBy` is either of host or container, if available'
operationId: softwareVersions
parameters:
- description: Timeframe expressed as the Unix epoch time in milliseconds
in: query
name: time
schema:
type: integer
format: int64
- description: Filter on discoveryType
example: NATIVE_SENSOR
in: query
name: discoveryType
schema:
type: string
enum:
- NATIVE_SENSOR
- REMOTE_SENSOR
- PACKAGE_MANAGER
- OTHER
- description: Filter on softwareType
example: DEPENDENCY
in: query
name: softwareType
schema:
type: string
enum:
- DEPENDENCY
- RUNTIME
- DATABASE
- MESSAGING
- PLATFORM
- PACKAGE
- OS
- CACHE
- API_GATEWAY
- OTHER
- APPLICATION_FRAMEWORK
- description: Filter on this software name
in: query
name: name
schema:
type: string
- description: Filter on this plugin
in: query
name: plugin
schema:
type: string
- description: Filter on this version
in: query
name: version
schema:
type: string
- description: Filter on this vendor
in: query
name: vendor
schema:
type: string
responses:
'200':
content:
application/json:
example: "[\n {\n \"name\": \"errno\",\n \"plugin\": \"nodeJsRuntimePlatform\",\n \"version\": \"0.1.8\",\n \"discoveryType\": \"NATIVE_SENSOR\",\n \"softwareType\": \"DEPENDENCY\",\n \"vendor\": \"\",\n \"metadata\": {},\n \"usedBy\": [\n {\n \"host\": \"instana-centos1.fyre.ibm.com\",\n \"container\": null,\n \"process\": \"instana-payload-simulator v1.0.0\",\n \"snapshotId\": \"nQHb946M0I_rzRNuTFLVVSUorr8\"\n }\n ]\n },\n {\n \"name\": \"OpenJDK 64-Bit Server VM\",\n \"plugin\": \"jvmRuntimePlatform\"\n \"version\": \"17.0.1\",\n \"discoveryType\": \"NATIVE_SENSOR\",\n \"softwareType\": \"RUNTIME\",\n \"vendor\": \"Azul Systems, Inc.\",\n \"metadata\": {},\n \"usedBy\": [\n {\n \"host\": \"lima-rancher-desktop\",\n \"container\": \"elasticsearch/elasticsearch:7.16.2\",\n \"process\": \"docker-cluster: 0c930ef6c5af\",\n \"snapshotId\": \"cn06irROoHrvrDEa4fWw9vD6yhc\"\n }\n ]\n }\n]\n"
schema:
type: array
items:
$ref: '#/components/schemas/SoftwareVersion'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get installed software
tags:
- Infrastructure Resources
x-ibm-ahub-byok: true
components:
schemas:
SnapshotItem:
type: object
description: Detail information for requested snapshots.
properties:
data:
type: object
additionalProperties:
type: object
from:
type: integer
format: int64
description: Start of timeframe expressed as the Unix epoch time in milliseconds
host:
type: string
description: Host name
label:
type: string
description: Friendly label for the entity
plugin:
type: string
description: Plugin name
example: host
snapshotId:
type: string
description: Snapshot ID
tags:
type: array
description: Tags which can be used to search for this entity
items:
type: string
description: Tags which can be used to search for this entity
to:
type: integer
format: int64
description: End of timeframe expressed as the Unix epoch time in milliseconds
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
PostSnapshotsResult:
type: object
properties:
items:
type: array
description: Detail information for requested snapshots.
items:
$ref: '#/components/schemas/SnapshotItem'
notFoundSnapshotsIds:
type: array
description: Snapshot ids for snapshots that could not be retrieved.
items:
type: string
description: Snapshot ids for snapshots that could not be retrieved.
MonitoredEntitiesStats:
type: object
description: Statistics of monitored entities.
properties:
hostCount:
type: integer
format: int32
otelCount:
type: integer
format: int32
serverlessCount:
type: integer
format: int32
GetSnapshotsQuery:
type: object
properties:
snapshotIds:
type: array
description: List of one or more snapshot ids.
items:
type: string
description: List of one or more snapshot ids.
maxItems: 1000
minItems: 0
uniqueItems: true
timeFrame:
$ref: '#/components/schemas/TimeFrame'
required:
- snapshotIds
SnapshotResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SnapshotItem'
SoftwareVersion:
type: object
properties:
discoveryType:
type: string
enum:
- NATIVE_SENSOR
- REMOTE_SENSOR
- PACKAGE_MANAGER
- OTHER
metadata:
type: object
additionalProperties:
type: string
name:
type: string
plugin:
type: string
softwareType:
type: string
enum:
- DEPENDENCY
- RUNTIME
- DATABASE
- MESSAGING
- PLATFORM
- PACKAGE
- OS
- CACHE
- API_GATEWAY
- OTHER
- APPLICATION_FRAMEWORK
usedBy:
type: array
items:
$ref: '#/components/schemas/SoftwareUser'
uniqueItems: true
vendor:
type: string
version:
type: string
required:
- discoveryType
- name
- plugin
- softwareType
- usedBy
- vendor
- version
MonitoringState:
type: object
properties:
hasEntities:
type: boolean
description: Has entities
hostCount:
type: integer
format: int32
description: Count of hosts
monitoredEntitiesStats:
$ref: '#/components/schemas/MonitoredEntitiesStats'
openTelemetryCount:
type: integer
format: int32
description: Count of open telemetry
serverlessCount:
type: integer
format: int32
description: Count of serverless
SoftwareUser:
type: object
properties:
container:
type: string
host:
type: string
process:
type: string
snapshotId:
type: string
securitySchemes:
ApiKeyAuth:
in: header
name: authorization
type: apiKey
description: "## Example\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"
x-tagGroups:
- name: Websites & Mobile Apps
tags:
- Website Metrics
- Website Catalog
- Website Analyze
- Website Configuration
- Mobile App Metrics
- Mobile App Catalog
- Mobile App Analyze
- Mobile App Configuration
- End User Monitoring
- name: Applications
tags:
- Application Metrics
- Application Resources
- Application Catalog
- Application Analyze
- Application Settings
- Application Topology
- Application Alert Configuration
- Global Application Alert Configuration
- name: Infrastructure
tags:
- Infrastructure Analyze
- Infrastructure Metrics
- Infrastructure Resources
- Infrastructure Catalog
- Infrastructure Topology
- name: Logging
tags:
- Logging Analyze
- name: Synthetic Monitoring
tags:
- Synthetic Catalog
- Synthetic Metrics
- Synthetic Settings
- Synthetic Test Playback Results
- Synthetic Alert Configuration
- name: Logs
tags:
- Log Alert Configuration
- name: Events
tags:
- Events
- Event Settings
- name: Automation
tags:
- Action Catalog
- Action History
- Policies
- name: Service Levels
tags:
- SLI Settings
- SLI Report
- Apdex Settings
- Apdex Report
- Service Levels Objective(SLO) Configurations
- Service Levels Objective(SLO) Report
- Service Levels Alert Configuration
- SLO Correction Configurations
- SLO Correction Windows
- name: AI Management
tags:
- AI Management
- name: Settings
tags:
- Custom Dashboards
- User
- Groups
- Teams
- Roles
- Audit Log
- API Token
- Maintenance Configuration
- Synthetic Calls
- Session Settings
- Automation Settings
- Authentication
- name: Open Beta Features
tags:
- Infrastructure Analyze
- name: Closed Beta Features
tags:
- Infrastructure Alert Configuration
- name: Instana
tags:
- Releases
- Host Agent
- Health
- Usage