Instana Events API
The Events API from Instana — 4 operation(s) for events.
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-events-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 Events 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: Events
paths:
/api/events:
get:
description: Get all Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
operationId: getEvents
parameters:
- description: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
example: 1704096000000
in: query
name: to
schema:
type: integer
format: int64
- description: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
example: 600000
in: query
name: windowSize
schema:
type: integer
format: int64
- description: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
example: 1672560000000
in: query
name: from
schema:
type: integer
format: int64
- description: Flag to filter the results to only show events with state changes within the timeframe.
example: true
in: query
name: filterEventUpdates
schema:
type: boolean
- description: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
example: true
in: query
name: excludeTriggeredBefore
schema:
type: boolean
- deprecated: true
description: Flag to filter the results to include Agent Monitoring Issues.
example: true
in: query
name: includeAgentMonitoringIssues
schema:
type: boolean
- deprecated: true
description: Flag to filter the results to include Kubernetes Info Events.
example: true
in: query
name: includeKubernetesInfoEvents
schema:
type: boolean
- description: A string representing an event type - an INCIDENT, ISSUE, or CHANGE. This query can be repeated to use multiple filters.
example: INCIDENT
in: query
name: eventTypeFilters
schema:
type: array
items:
type: string
enum:
- INCIDENT
- ISSUE
- CHANGE
uniqueItems: true
responses:
'200':
content:
application/json:
example:
- eventId: gM73SycATrOFMcL5qspByQ
start: 1706774419000
end: 1706783931000
type: incident
state: open
problem: New Event-test-01
detail: test
severity: 5
entityName: .NET App
entityLabel: powershell.exe
metrics:
- metricName: threads.lck_crs
snapshotId: zqEuPom1v7YK61jRU8cEpRhCI1w
entityId:
steadyId: '55428'
pluginId: com.instana.forge.infrastructure.runtime.clr.ClrRuntimePlatform
host: 00:15:5d:ff:fe:98:d1:f6
entityType: INFRASTRUCTURE
fixSuggestion: test
snapshotId: zqEuPom1v7YK61jRU8cEpRhCI1w
recentEvents:
- eventId: ZzaptuusSOutGLGmqD-wzA
- eventId: oeqTbltKQw6pp1OJi_QH_Q
- eventId: Cnv-8y96SOW2CzZbn7SK7Q
- eventId: vidr6ZX9QmqhtdvBrYFR3Q
- eventId: NWfYJEUjSLSPJbxfCEW6kA
- eventId: iJ2Bm8Y5Qq-Fh-IAwAnRqQ
- eventId: kHiCKKByTdW0sMhhjxvgQg
- eventId: w-hl_-8NQXKEIemcNR5ouw
- eventId: Vn0weJOGROaFKwRtqNDaeg
- eventId: Z9yz38EOR3aR0rYlBN3oRQ
- eventId: h7-N1PT9Sim4dCbyM-sf3g
- eventId: nnWCZ2L2STi8lXFbPNUgUg
- eventId: j1NlsfUYTz69t3dqSMekPQ
probableCause: []
probableCauseMetadata: {}
schema:
type: array
items:
$ref: '#/components/schemas/EventResult'
description: OK
'400':
description: Bad request.
security:
- ApiKeyAuth:
- Default
summary: Get all Events
tags:
- Events
x-ibm-ahub-byok: true
post:
description: Gets a set of events by their IDs.
operationId: getEventsByIds
requestBody:
content:
application/json:
example:
- VOMNl0OgRv2HXlsR0iUYGg
- h66yezD9Sfi5YNh_cmeG7Q
schema:
type: array
items:
type: string
required: true
responses:
'200':
content:
application/json:
example:
- eventId: VOMNl0OgRv2HXlsR0iUYGg
start: 1722027687446
end: 1722028317446
type: issue
state: open
problem: Calls are slower than usual
detail: Calls are slower or equal to 50 ms based on latency (90th).
severity: 5
entityName: Endpoint
entityLabel: POST /integration/slack/event
metrics:
- metricAggregation: P90
metricName: latency
entityType: ENDPOINT
fixSuggestion: Calls are slower or equal to 50 ms based on latency (90th).
snapshotId: A-fDmFeA5Mzl3yIs8hXs5Megwz8
endpointId: A-fDmFeA5Mzl3yIs8hXs5Megwz8
endpointServiceId: fc3b86a089d24ed3b7d50ac3a7639c682101d6b9
applicationId: qOlcrsSlS_eWLGnBjooqWA
- eventId: h66yezD9Sfi5YNh_cmeG7Q
start: 1721764921276
end: 1722028014839
type: issue
state: open
problem: _RP Static camunda Archive Invoice for k8s-demo
detail: Calls are slower or equal to the expectation based on latency (90th).
severity: 5
entityName: Endpoint
entityLabel: Archive Invoice
metrics:
- metricAggregation: P90
metricName: latency
entityType: ENDPOINT
fixSuggestion: Calls are slower or equal to the expectation based on latency (90th).
snapshotId: MN1thidNpDc15zM-NP4ilfJs87k
endpointId: MN1thidNpDc15zM-NP4ilfJs87k
endpointServiceId: 1f0ee2b46a33c2dbfedfec9c45ad81ff1c8e7e37
applicationId: acfRC1IqTVi41OMLAJU4Cw
schema:
type: array
items:
$ref: '#/components/schemas/EventResult'
description: OK
'206':
description: Some of the requested events do not exist.
'422':
description: Unprocessable entity.
security:
- ApiKeyAuth:
- Default
summary: Get Events by IDs
tags:
- Events
x-ibm-ahub-byok: true
/api/events/agent-monitoring-events:
get:
description: Gets all Agent Monitoring Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
operationId: agentMonitoringEvents
parameters:
- description: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
example: 1704096000000
in: query
name: to
schema:
type: integer
format: int64
- description: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
example: 600000
in: query
name: windowSize
schema:
type: integer
format: int64
- description: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
example: 1672560000000
in: query
name: from
schema:
type: integer
format: int64
- description: Flag to filter the results to only show events with state changes within the timeframe.
example: true
in: query
name: filterEventUpdates
schema:
type: boolean
- description: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
example: true
in: query
name: excludeTriggeredBefore
schema:
type: boolean
responses:
'200':
content:
application/json:
example:
- eventId: n8DamRZKSs6Z2f0wiZ9tVQ
start: 1707472014671
end: 1707472674671
type: agent_monitoring_issue
state: open
problem: 'Monitoring issue: jvm_attach_generic'
detail: 'Our Agent observed a problem with monitoring the linked process. To resolve this issue, please check our docs (https://www.instana.com/docs/) for error code: jvm_attach_generic'
severity: 5
entityName: Process
entityLabel: java
entityType: INFRASTRUCTURE
fixSuggestion: 'Our Agent observed a problem with monitoring the linked process. To resolve this issue, please check our docs (https://www.instana.com/docs/) for error code: jvm_attach_generic'
snapshotId: 2fDFOytDpF4FYKrTdfwdlklDOPY
schema:
type: array
items:
$ref: '#/components/schemas/EventResult'
description: OK
'404':
description: The events do not exist in the timeframe.
security:
- ApiKeyAuth:
- Default
summary: Get Agent Monitoring Events
tags:
- Events
x-ibm-ahub-byok: true
/api/events/kubernetes-info-events:
get:
description: Gets all Kubernetes Info Events within a timeframe. The timeframe is defined as `[from, to]` or `[to - windowSize, to]`.
operationId: kubernetesInfoEvents
parameters:
- description: A Unix timestamp representing the end of the requested timeframe. Defaults to the current system time
example: 1704096000000
in: query
name: to
schema:
type: integer
format: int64
- description: The size of the requested timeframe, in milliseconds, relative to the 'to' parameter. Defaults to 10 minutes (600000 milliseconds) if neither 'windowSize' nor 'from' are provided. Resulting timeframe range = [to - windowSize, to]
example: 600000
in: query
name: windowSize
schema:
type: integer
format: int64
- description: A Unix timestamp representing the start of the requested timeframe. Can be used as an alternative to 'windowSize' to define the timeframe. If both 'from' and 'windowSize' are provided, 'from' takes precedence. Resulting timeframe range = [from, to]
example: 1672560000000
in: query
name: from
schema:
type: integer
format: int64
- description: Flag to filter the results to only show events with state changes within the timeframe.
example: true
in: query
name: filterEventUpdates
schema:
type: boolean
- description: Flag to filter the results to exclude events that have been triggered before the timeframe. This also filters out events with state changes within the timeframe if the events' start times begin before the timeframe.
example: true
in: query
name: excludeTriggeredBefore
schema:
type: boolean
responses:
'200':
content:
application/json:
example:
- eventId: nOYcBAncQIyZHdVNnBRmzQ
start: 1707472297000
end: 1707472297000
type: change
state: closed
problem: BackOff
detail: Back-off pulling image "gcr.io/kubernetes-helm/tiller:v2.14.1"
severity: -2
entityName: Kubernetes Pod
entityLabel: kube-system/tiller-deploy-7bf78cdbf7-gnjg5 (pod)
entityType: INFRASTRUCTURE
fixSuggestion: Back-off pulling image "gcr.io/kubernetes-helm/tiller:v2.14.1"
snapshotId: wTRNW3DaFeQhk7G3Cx5bKC5Psgk
schema:
type: array
items:
$ref: '#/components/schemas/EventResult'
description: OK
'404':
description: The events do not exist in the timeframe.
security:
- ApiKeyAuth:
- Default
summary: Get Kubernetes Info Events
tags:
- Events
x-ibm-ahub-byok: true
/api/events/{eventId}:
get:
description: Gets a specific event.
operationId: getEvent
parameters:
- description: ID of a specific Event to retrieve.
example: LZOGo1lXR4WeCB2ftgtGGQ
in: path
name: eventId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example:
eventId: LZOGo1lXR4WeCB2ftgtGGQ
start: 1706783553000
end: 1706783553000
type: change
state: closed
problem: Pulled
detail: Successfully pulled image "registry.redhat.io/redhat/redhat-marketplace-index:v4.14" in 830.603468ms (830.624088ms including waiting)
severity: -2
entityName: Kubernetes Pod
entityLabel: openshift-marketplace/redhat-marketplace-qbn8f (pod)
entityType: INFRASTRUCTURE
fixSuggestion: Successfully pulled image "registry.redhat.io/redhat/redhat-marketplace-index:v4.14" in 830.603468ms (830.624088ms including waiting)
snapshotId: xLziJivLyeepxBf0UnNR1ff-9MI
schema:
$ref: '#/components/schemas/EventResult'
description: OK
'404':
description: The requested event does not exist.
security:
- ApiKeyAuth:
- Default
summary: Get Event
tags:
- Events
x-ibm-ahub-byok: true
components:
schemas:
EventResult:
type: object
discriminator:
mapping:
APPLICATION: '#/components/schemas/ApplicationEventResult'
ENDPOINT: '#/components/schemas/EndpointEventResult'
INFRASTRUCTURE: '#/components/schemas/InfraEventResult'
LOG: '#/components/schemas/LogEventResult'
MOBILE_APP: '#/components/schemas/MobileAppEventResult'
SERVICE: '#/components/schemas/ServiceEventResult'
SYNTHETICS: '#/components/schemas/SyntheticsEventResult'
WEBSITE: '#/components/schemas/WebsiteEventResult'
propertyName: entityType
properties:
detail:
type: string
description: Details of the event.
end:
type: integer
format: int64
description: A Unix timestamp representing the end time of the Event.
entityLabel:
type: string
description: The label of the affected entity of the event.
entityName:
type: string
description: The name or type of the affected entity of the event.
entityType:
type: string
description: The category of the affected entity.
eventId:
type: string
description: ID of this Event.
eventSpecificationId:
type: string
description: ID of the configuration that created this event.
fixSuggestion:
type: string
deprecated: true
description: Details of the event.
metrics:
type: array
description: List of metrics associated with the Event.
items:
type: object
additionalProperties:
type: object
description: List of metrics associated with the Event.
description: List of metrics associated with the Event.
probableCause:
type: object
additionalProperties:
type: object
description: Metadata of the probable root cause for this event. Only present in case of specific "Incident" type events.
description: Metadata of the probable root cause for this event. Only present in case of specific "Incident" type events.
problem:
type: string
description: Main problem title of the Event.
recentEvents:
type: array
description: List of related recent events. Only present in case of "Incident" type events.
items:
type: object
additionalProperties:
type: object
description: List of related recent events. Only present in case of "Incident" type events.
description: List of related recent events. Only present in case of "Incident" type events.
severity:
type: integer
format: int32
description: The severity of the Event when triggered.
shortCode:
type: string
description: A short code for the event
snapshotId:
type: string
deprecated: true
description: The snapshot ID of the affected entity of this event.
start:
type: integer
format: int64
description: A Unix timestamp representing the start time of the Event.
state:
type: string
description: 'The state of the Event, "open" or "close". '
type:
type: string
description: The type of Event.
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