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 Application 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? 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: Application Resources
description: 'The API endpoints of this group provides insights into resources created and discovered. It includes:
**Application Perspectives**
Returns a list of predefined application perspectives, offering an organized view of application perspectives within the system.
**Discovered Services Inside Application Perspectives**
Fetches services identified within the context of specific application perspectives.
**Discovered Services and Endpoints**
Provides a detailed list of endpoints associated with services, enabling deeper visibility into service dependencies and interactions.
It also provides a detailed list of services.
These API endpoints collectively serve as a crucial tool for managing and analyzing application-level resource structures.'
paths:
/api/application-monitoring/applications:
get:
description: 'Use this API endpoint if one wants to retrieve a list of Application Perspectives.
A use case could be to view the application id of an Application Perspective.
For more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources.'
operationId: getApplications
parameters:
- description: Name of application
in: query
name: nameFilter
schema:
type: string
- description: Size of time window in milliseconds
in: query
name: windowSize
schema:
type: integer
format: int64
- description: Timestamp since Unix Epoch in milliseconds of the end of the time window
in: query
name: to
schema:
type: integer
format: int64
- description: Page number from results
in: query
name: page
schema:
type: integer
format: int32
- description: Number of items per page
in: query
name: pageSize
schema:
type: integer
format: int32
- description: 'Filter for application scope, i.e: INBOUND or ALL'
in: query
name: applicationBoundaryScope
schema:
type: string
enum:
- ALL
- INBOUND
responses:
'200':
content:
application/json:
example:
items:
- boundaryScope: INBOUND
entityType: APPLICATION
id: e8krH1wNRV6daAo-NEmG8g
label: Robot Shop
page: 1
pageSize: 1
totalHits: 1
schema:
$ref: '#/components/schemas/ApplicationResult'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get applications
tags:
- Application Resources
x-ibm-ahub-byok: true
/api/application-monitoring/applications;id=<appId>/services:
get:
description: 'Use this API endpoint if one wants to retrieve a list of services in an Application Perspective.
A use case could be to retrieve all service ids present in an Application Perspective.
For more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources.'
operationId: getApplicationServices
parameters:
- description: Name of service (partial match allowed)
in: query
name: nameFilter
schema:
type: string
- description: Size of time window in milliseconds
in: query
name: windowSize
schema:
type: integer
format: int64
- description: Timestamp since Unix Epoch in milliseconds of the end of the time window
in: query
name: to
schema:
type: integer
format: int64
- description: Page number from results
in: query
name: page
schema:
type: integer
format: int32
- description: Number of items per page
in: query
name: pageSize
schema:
type: integer
format: int32
- description: 'Filter for application scope, i.e: INBOUND or ALL'
in: query
name: applicationBoundaryScope
schema:
type: string
enum:
- ALL
- INBOUND
- description: Include snapshot ids in the results
in: query
name: includeSnapshotIds
schema:
type: boolean
responses:
'200':
content:
application/json:
example:
items:
- entityType: SERVICE
id: 79f1430f4a42a707a97621ca00617e40bd51c31d
label: www.paypal.com
snapshotIds:
- CywiRxmGIwtQIKezVs-XMcTX2xg
technologies:
- kafkaCluster
types:
- MESSAGING
page: 1
pageSize: 1
totalHits: 1
schema:
$ref: '#/components/schemas/ServiceResult'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get applications/services
tags:
- Application Resources
x-ibm-ahub-byok: true
/api/application-monitoring/applications/services/endpoints:
get:
description: 'Use this API endpoint if one wants to retrieve a list of Endpoints.
A use case could be to view the endpoint id of an Endpoint.
For more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources.'
operationId: getApplicationEndpoints
parameters:
- description: Name of service
in: query
name: nameFilter
schema:
type: string
- description: Type of Endpoint
in: query
name: types
schema:
type: array
items:
type: string
uniqueItems: true
- description: List of technologies
in: query
name: technologies
schema:
type: array
items:
type: string
uniqueItems: true
- description: Size of time window in milliseconds
in: query
name: windowSize
schema:
type: integer
format: int64
- description: Timestamp since Unix Epoch in milliseconds of the end of the time window
in: query
name: to
schema:
type: integer
format: int64
- description: Page number from results
in: query
name: page
schema:
type: integer
format: int32
- description: Number of items per page
in: query
name: pageSize
schema:
type: integer
format: int32
- description: 'Filter for application scope, i.e: INBOUND or ALL'
in: query
name: applicationBoundaryScope
schema:
type: string
enum:
- ALL
- INBOUND
responses:
'200':
content:
application/json:
example:
items:
- entityType: ENDPOINT
id: IWeMKSzcvJHijAQoaA-luyHriDQ
label: websites
serviceId: a25c02069636022456e6139ebfe4f4bfec23ae31
synthetic: false
syntheticType: NON_SYNTHETIC
technologies:
- postgreSqlDatabase
type: DATABASE
page: 1
pageSize: 1
totalHits: 1
schema:
$ref: '#/components/schemas/EndpointResult'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get endpoints
tags:
- Application Resources
x-ibm-ahub-byok: true
/api/application-monitoring/services:
get:
description: 'Use this API endpoint if one wants to retrieve a list of Services.
A use case could be to view the service id of a Service.
For more information on Application Resources please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Applications#application-resources.'
operationId: getServices
parameters:
- description: Name of service
in: query
name: nameFilter
schema:
type: string
- description: Size of time window in milliseconds
in: query
name: windowSize
schema:
type: integer
format: int64
- description: Timestamp since Unix Epoch in milliseconds of the end of the time window
in: query
name: to
schema:
type: integer
format: int64
- description: Page number from results
in: query
name: page
schema:
type: integer
format: int32
- description: Number of items per page
in: query
name: pageSize
schema:
type: integer
format: int32
- description: Include snapshot ids in the results
in: query
name: includeSnapshotIds
schema:
type: boolean
responses:
'200':
content:
application/json:
example:
items:
- entityType: SERVICE
id: 79f1430f4a42a707a97621ca00617e40bd51c31d
label: Robot Shop
snapshotIds:
- CywiRxmGIwtQIKezVs-XMcTX2xg
technologies:
- kafkaCluster
types:
- MESSAGING
page: 1
pageSize: 1
totalHits: 1
schema:
$ref: '#/components/schemas/ServiceResult'
description: OK
security:
- ApiKeyAuth:
- Default
summary: Get services
tags:
- Application Resources
x-ibm-ahub-byok: true
components:
schemas:
ApplicationResult:
type: object
properties:
items:
type: array
description: Returns a list of Application Perspectives.
items:
$ref: '#/components/schemas/Application'
page:
type: integer
format: int32
description: Page number you want to retrieve in a request / retrieved in a response.
pageSize:
type: integer
format: int32
description: number of elements retrieved in a single query.
totalHits:
type: integer
format: int32
description: 'The number of results returned. For eg: If `items` has 5 elements, `totalhits` will be 5'
Endpoint:
type: object
properties:
entityType:
type: string
description: Since, this is a Endpoint, it will be of type `ENDPOINT`.
enum:
- APPLICATION
- SERVICE
- ENDPOINT
id:
type: string
description: 'Unique ID of the Endpoint. Eg: `NCRq5oYnan5x-PkdTPQwLLUdu5M`.'
isSynthetic:
type: boolean
writeOnly: true
label:
type: string
description: 'Name of the Endpoint. Eg: `GET /api/fetch`.'
serviceId:
type: string
description: The serviceId this endpoint belongs to.
synthetic:
type: boolean
syntheticType:
type: string
enum:
- NON_SYNTHETIC
- SYNTHETIC
- MIXED
technologies:
type: array
description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
items:
type: string
description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
uniqueItems: true
type:
type: string
description: The type of the Endpoint.
enum:
- UNDEFINED
- RPC
- EVENT
- GRAPHQL
- BATCH
- SHELL
- HTTP
- SDK
- OPENTELEMETRY
- INTERNAL
- DATABASE
- MESSAGING
- PAGE
- PAGE_RESOURCE
required:
- id
- label
- serviceId
- technologies
- type
EndpointResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Endpoint'
page:
type: integer
format: int32
description: Page number you want to retrieve in a request / retrieved in a response.
pageSize:
type: integer
format: int32
description: number of elements retrieved in a single query.
totalHits:
type: integer
format: int32
description: 'The number of results returned. For eg: If `items` has 5 elements, `totalhits` will be 5'
ServiceResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Service'
page:
type: integer
format: int32
description: Page number you want to retrieve in a request / retrieved in a response.
pageSize:
type: integer
format: int32
description: number of elements retrieved in a single query.
totalHits:
type: integer
format: int32
description: 'The number of results returned. For eg: If `items` has 5 elements, `totalhits` will be 5'
Service:
type: object
properties:
entityType:
type: string
description: Since, this is a Service, it will be of type `SERVICE`.
enum:
- APPLICATION
- SERVICE
- ENDPOINT
id:
type: string
description: 'Unique ID of the Service. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`.'
label:
type: string
description: 'Name of the Service. Eg: `payment`.'
snapshotIds:
type: array
description: A unique identifier the metrics are assigned to.
items:
type: string
description: A unique identifier the metrics are assigned to.
uniqueItems: true
technologies:
type: array
description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
items:
type: string
description: 'List of technologies: `Eg:["springbootApplicationContainer"]`'
uniqueItems: true
types:
type: array
description: 'Shows types of Endpoints a Service can consist of. It may be one or more. Eg: `HTTP` `OPENTELEMETRY` can be in 1 Service.'
items:
type: string
description: 'Shows types of Endpoints a Service can consist of. It may be one or more. Eg: `HTTP` `OPENTELEMETRY` can be in 1 Service.'
enum:
- UNDEFINED
- RPC
- EVENT
- GRAPHQL
- BATCH
- SHELL
- HTTP
- SDK
- OPENTELEMETRY
- INTERNAL
- DATABASE
- MESSAGING
- PAGE
- PAGE_RESOURCE
uniqueItems: true
required:
- id
- label
- snapshotIds
- technologies
- types
Application:
type: object
description: Returns a list of Application Perspectives.
properties:
boundaryScope:
type: string
description: Here, `ALL` Application Boundary Scope is considered.
entityType:
type: string
description: Since, this is an Application Perspective, it will be of type `APPLICATION`.
enum:
- APPLICATION
- SERVICE
- ENDPOINT
id:
type: string
description: 'Unique ID of the Application Perspective. Eg: `Av62RoIKQv-A3n6DbMQh9g`.'
label:
type: string
description: 'Name of the Application Perspective. Eg: `app1`.'
required:
- boundaryScope
- id
- label
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