Instana
Instana is an enterprise observability and application performance monitoring platform that provides automated full-stack visibility and AI-powered APM. Instana offers a public REST API for programmatic access to monitoring data, configurations, and integrations.
Instana publishes 62 APIs on the APIs.io network, including Action Catalog API, Action History API, AI Management API, and 59 more. Tagged areas include APM, Infrastructure, Monitoring, and Observability.
Instana’s developer surface includes documentation, support, and 4 more developer resources.
62 APIs
APMInfrastructureMonitoringObservability
Individual APIs this provider publishes, each with its own machine-readable definition.
The Action Catalog API from Instana — 5 operation(s) for action catalog.
The Action History API from Instana — 2 operation(s) for action history.
The AI Management API from Instana — 4 operation(s) for ai management.
The Apdex Report API from Instana — 1 operation(s) for apdex report.
The Apdex Settings API from Instana — 3 operation(s) for apdex settings.
API Tokens are unique strings that are used to authenticate and authorize access to the API. These are used to secure API endpoints and ensure that only authorized users can acc...
The API endpoints of this group can be used to manage Application alert configurations. ## Parameters: - **id:** ID of the application alert config which needs to be updated. - ...
The API endpoints of this group expose our analyze functionality. It includes: **Grouped Metrics** Two group endpoints to retrieve metrics for traces and calls. **List of traces...
The endpoints of this group retrieve all available resources to query application metrics. It includes: **Catalog for Application Tags** Showing a list of tags which is used for...
The endpoints of this group retrieve the metrics for defined applications, discovered services and endpoints. ### Mandatory Parameters **metrics** A list of metric objects that ...
The API endpoints of this group provides insights into resources created and discovered. It includes: **Application Perspectives** Returns a list of predefined application persp...
The API endpoints of this group provides a way to create, read, update, delete (CRUD) for various configuration settings. It includes: **Application Perspectives Configuration**...
The Application Topology API from Instana — 1 operation(s) for application topology.
The Audit Log API from Instana — 2 operation(s) for audit log.
The Authentication API from Instana — 4 operation(s) for authentication.
The Business Monitoring API from Instana — 5 operation(s) for business monitoring.
You can use these API endpoints to manage custom dashboards. We recommend that you leverage the `Edit as JSON` feature found within our user interface to construct the desired r...
The Custom Entities API from Instana — 2 operation(s) for custom entities.
The End User Monitoring API from Instana — 1 operation(s) for end user monitoring.
The Event Settings API from Instana — 37 operation(s) for event settings.
The Events API from Instana — 4 operation(s) for events.
The API endpoints of this group can be used to manage Global Application alert configurations. ## Parameters: All parameters and deprecated parameters are similar to Application...
Groups are used to permit individual users to perform specific actions and get visibility to an access scope. Each user can be assigned to multiple groups, every one coming with...
The Health API from Instana — 2 operation(s) for health.
Endpoints of this group can be used to list and configure host agents.
The Infrastructure Alert Configuration API from Instana — 6 operation(s) for infrastructure alert configuration.
This endpoint group exposes the functions that are used by the Instana **Analyze Infrastructure** dashboards. Two of the endpoints provide a [list of entity types](#operation/ge...
The endpoints of this group retrieve all available resources to query infrastructure metrics.
This endpoint retrieves the metrics for infrastructure components. ### Mandatory Parameters **plugin:** Plugins are entities' for which we collect metrics, for example : "Host",...
The Infrastructure Resources API from Instana — 5 operation(s) for infrastructure resources.
The Infrastructure Topology API from Instana — 2 operation(s) for infrastructure topology.
The Log Alert Configuration API from Instana — 6 operation(s) for log alert configuration.
The Logging Analyze API from Instana — 1 operation(s) for logging analyze.
### Maintenance Windows Maintenance windows allow you to mute alerts. ### Types of Maintenance Configurations **One-Time**: Executed once at a fixed scheduled time, after which ...
The Mobile App Analyze API from Instana — 2 operation(s) for mobile app analyze.
The Mobile App Catalog API from Instana — 3 operation(s) for mobile app catalog.
The Mobile App Configuration API from Instana — 11 operation(s) for mobile app configuration.
The Mobile App Metrics API from Instana — 3 operation(s) for mobile app metrics.
The Policies API from Instana — 3 operation(s) for policies.
These APIs can be used to create, update, delete and fetch releases. ## Mandatory Parameters when sending a request: 1. **Create release** - `name` and `start` are mandatory par...
The Roles API from Instana — 2 operation(s) for roles.
The Service Levels Alert Configuration API from Instana — 6 operation(s) for service levels alert configuration.
The Service Levels Objective(SLO) Configurations API from Instana — 3 operation(s) for service levels objective(slo) configurations.
The Service Levels Objective(SLO) Report API from Instana — 1 operation(s) for service levels objective(slo) report.
The Session Settings API from Instana — 1 operation(s) for session settings.
The SLI Report API from Instana — 1 operation(s) for sli report.
## Deprecated Parameters **tagFilters** The list of tag filters. It is replaced by **tagFilterExpression**
The SLO Correction Configurations API from Instana — 2 operation(s) for slo correction configurations.
The SLO Correction Windows API from Instana — 1 operation(s) for slo correction windows.
The API endpoints of this group can be used to manage alert configurations for Synthetic Monitoring. ## Parameters: - **id:** ID of the alert configuration. - **name:** Name for...
The API endpoints of this group can fetch, update and delete the synthetic endpoint configuration rules. **Note:** There are some following restrictions to use `matchSpecificati...
The Synthetic Catalog API from Instana — 2 operation(s) for synthetic catalog.
The endpoints of this group retrieve metrics for Synthetic test results. ### Mandatory Parameters **metrics** A list of metric objects that define which metric should be returne...
The API endpoints of this group can be used to manage Synthetic Locations, Synthetic Tests and Synthetic Credentials. ## Synthetic Location Properties: - **id** Unique identifie...
The endpoints of this group retrieve the results for defined Synthetic tests. **Note on names in TagFilter/TagFilterExpression**: From R243, the name used in a TagFilter or a Ta...
The Teams API from Instana — 2 operation(s) for teams.
The Usage API from Instana — 5 operation(s) for usage.
The User API from Instana — 7 operation(s) for user.
The following four endpoints expose our analyze functionality. ## Mandatory Parameters : **type** **group (only for group Endpoints)** It is mandatory to select a tag by which t...
The endpoints of this group retrieve all available resources to query website metrics.
The Website Configuration API from Instana — 10 operation(s) for website configuration.
The Website Metrics API from Instana — 3 operation(s) for website metrics.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
Cost, billing, and metering signals for API financial operations.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
aid: instana
name: Instana
description: Instana is an enterprise observability and application performance monitoring platform that provides automated
full-stack visibility and AI-powered APM. Instana offers a public REST API for programmatic access to monitoring data, configurations,
and integrations.
type: Index
accessModel:
pricing: freemium
onboarding: unknown
trial: false
try_now: false
public: false
label: Freemium
confidence: medium
source:
- plans
generated: '2026-07-22'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/instana.png
tags:
- APM
- Infrastructure
- Monitoring
- Observability
url: https://raw.githubusercontent.com/api-evangelist/instana/refs/heads/main/apis.yml
created: '2024-07-02'
modified: '2026-04-28'
specificationVersion: '0.19'
apis:
- aid: instana:instana-action-catalog-api
name: Instana Action Catalog API
description: The Action Catalog API from Instana — 5 operation(s) for action catalog.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Action Catalog
properties:
- type: OpenAPI
url: openapi/instana-action-catalog-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-action-history-api
name: Instana Action History API
description: The Action History API from Instana — 2 operation(s) for action history.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Action History
properties:
- type: OpenAPI
url: openapi/instana-action-history-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-ai-management-api
name: Instana AI Management API
description: The AI Management API from Instana — 4 operation(s) for ai management.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- AI Management
properties:
- type: OpenAPI
url: openapi/instana-ai-management-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-apdex-report-api
name: Instana Apdex Report API
description: The Apdex Report API from Instana — 1 operation(s) for apdex report.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Apdex Report
properties:
- type: OpenAPI
url: openapi/instana-apdex-report-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-apdex-settings-api
name: Instana Apdex Settings API
description: The Apdex Settings API from Instana — 3 operation(s) for apdex settings.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Apdex Settings
properties:
- type: OpenAPI
url: openapi/instana-apdex-settings-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-api-token-api
name: Instana API Token API
description: 'API Tokens are unique strings that are used to authenticate and authorize access to the API. These are used
to secure API endpoints and ensure that only authorized users can access certain functions. When you raise a request to
the API, you must include the API Token in the request header to verify your identity.
Instana API Tokens are specific to Tenant Unit (TU) and cannot be used across TUs. Each token has its associated set of
permissions, which are preselected when you create the token.'
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- API Token
properties:
- type: OpenAPI
url: openapi/instana-api-token-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-application-alert-configuration-api
name: Instana Application Alert Configuration API
description: "The API endpoints of this group can be used to manage Application alert configurations.\n\n## Parameters:\n\
\n- **id:** ID of the application alert config which needs to be updated.\n\n- **name:** Name for the application alert\
\ configuration.\n\n- **description:** Description for the application alert configuration.\n\n- **severity:** The severity\
\ of the alert when triggered, which is either `5` (Warning), or `10` (Critical).\n\n- **triggering:** Optional flag to\
\ indicate whether also an Incident is triggered or not.\n\n- **applications:** Selection of application, services and\
\ endpoints in scope.\n\n The selection defines a tree of included or excluded sub entities. The defined `inclusive`\
\ flag defines whether this node and his child nodes are included (`inclusive: true`) or excluded (`inclusive: false`)\
\ by default. Empty selections or unnecessary selections are not allowed. \n\n #### Example 1: Select an entire Application\
\ Perspective\n\n To select the entire application with ID `<appId>` including all its services and endpoints, simply\
\ provide the following selection object:\n\n ```json\n \"applications\": {\n \"<appId>\": {\n \"applicationId\"\
: \"<appId>\"\n }\n }\n ```\n\n Leaf nodes of the selection tree default to `true` if no `inclusive` value is\
\ defined.\n\n #### Example 2: Specific selection of services and endpoints\n\n To select not the entire application\
\ with ID `<appId>`, but only the entire serivces Service1 with ID `<service1>` and Service2 with ID `<service2>`, with\
\ the exception of endpoint `<endpoint2>` of Service2. And in addition, only Endpoint `<endpoint3>` of Service3 with id\
\ `<service3>`, then use the following selection:\n\n ```json\n \"applications\": {\n \"<appId>\": {\n \
\ \"applicationId\": \"<appId>\",\n \"inclusive\": false,\n \"services\": {\n \"<service1>\"\
: {\n \"serviceId\": \"<service1>\"\n },\n \"<service2>\": {\n \
\ \"serviceId\": \"<service2>\",\n \"inclusive\": true,\n \"endpoints\": {\n \
\ \"<endpoint2>\": {\n \"endpointId\": \"<endpoint2>\",\n \
\ \"inclusive\": false\n }\n }\n },\n \"<service3>\"\
: {\n \"serviceId\": \"<service3>\",\n \"inclusive\": false,\n \"endpoints\"\
: {\n \"<endpoint3>\": {\n \"endpointId\": \"<endpoint3>\",\n \
\ \"inclusive\": true\n }\n }\n }\n }\n \
\ }\n }\n ``` \n\n- **boundaryScope:** Boundary scope of the Application Perspective\n\n- **tagFilterExpression:**\
\ Boolean expression of tag filters to define the scope of relevant calls.\n\n- **includeInternal:** Optional flag to\
\ indicate whether also internal calls are included in the scope or not. The default is `false`.\n\n- **includeSynthetic:**\
\ Optional flag to indicate whether also synthetic calls are included in the scope or not. The default is `false`.\n\n\
- **evaluationType:** The alert evaluation type of the alert configuration. For example, this allows to configure whether\
\ calls of the configured scope is aggregated to a single metric that is then considered for alerting (`\"PER_AP\"`),\
\ or whether each service of an Appliction Perspective is is evaluated individually (`\"PER_AP_SERVICE\"`).\n\n- **granularity:**\
\ The evaluation granularity used for detection of violations of the defined threshold. In other words, it defines the\
\ size of the tumbling window used.\n\n- **rule:** Indicates the type of rule this alert configuration is about.\n\n-\
\ **threshold:** Indicates the type of threshold this alert rule is evaluated on .\n\n- **timeThreshold:** Indicates the\
\ type of violation of the defined threshold.\n\n- **alertChannelIds:** List of IDs of alert channels defined in Instana.\n\
\n## Deprecated Parameters\n\n- **applicationId:** Unique ID of the Application Perspective. It is replaced by **applications**."
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Application Alert Configuration
properties:
- type: OpenAPI
url: openapi/instana-application-alert-configuration-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-application-analyze-api
name: Instana Application Analyze API
description: "The API endpoints of this group expose our analyze functionality.\nIt includes:\n\n**Grouped Metrics**\n\n\
Two group endpoints to retrieve metrics for traces and calls. \n\n**List of traces and its detailed information**\n\n\
You can also [search and filter all traces](#operation/getTraces) and retrieve [all details](#operation/getTraceDownload)\
\ attached to the trace. Furthermore, you can also retrive [all details](#operation/getCallDetails) of a call.\n\n## Parameters\n\
### Mandatory Parameters (only for group Endpoints):\n**group** It is mandatory to select a tag by which the calls and\
\ traces are grouped for the distinct endpoint call\n* *groupByTag* select a tag by which the calls and traces are grouped\
\ \n * a full list of available tags can be retrieved from the [application tag catalog](#operation/getApplicationTagCatalog)\n\
\ * for the trace endpoint only two tags are reasonable and working: `trace.endpoint.name` and `trace.service.name` which\
\ indicate the entry endpoint or service for the trace\n* *groupByTagSecondLevelKey* tags of type KEY_VALUE_PAIR need\
\ a second parameter e.g for `kubernetes.deployment.label` you would need provide the label you want to groupBy here.\n\
\n### Optional Parameters\n**pagination**\n* *offset* set the starting point for the data retrieval\n* *retrievalSize*\
\ you set the number of returned values\n* *ingestionTime* if you want to paginate through your result set you are interested\
\ in having the data for a fixed time point, the results set has a `cursor` class that has a ingestionTime property that\
\ indicates what you have to enter here.\n**order**\n\n**timeFrame** As in our UI 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 granularity, a default\
\ granularity will be used for adjustment.\n\n**tagFilters** As in the UI you able to filter your query by a tag. To get\
\ a list of all available tags you can query the [application tag catalog](#operation/getApplicationTagCatalog)\n* *name*\
\ The name of the tag as returned by the catalog\n* *value* The filter value of the tag, possible types are:\n * \"STRING\"\
\ alphanumerical values, valid operators: \"EQUALS\", \"CONTAINS\", \"NOT_EQUAL\", \"NOT_CONTAIN\", \"NOT_EMPTY\", \"\
IS_EMPTY\"\n * \"NUMBER\" numerical values, valid operators: \"EQUALS\", \"LESS_THAN\" \"GREATER_THAN\"\n * \"KEY_VALUE_PAIR\"\
\ \n* *operator* one of the valid operators for the type of the selected tag\n\n**metrics** A list of metric objects that\
\ define which metric should be returned, with the defined aggregation. Each metrics objects consists of minimum two items:\n\
1. *metric* select a particular metric, available metrics in this context are\n * Latency Mean\n * Error Rate\n \
\ * Traces Sum\n2. *aggregation* depending on the selected metric different aggregations are available e.g. SUM, MEAN,\
\ P95. The aforementioned [catalog endpoint](#operation/getApplicationCatalogMetrics) gives you the metrics with the available\
\ aggregations.\n\n**Note**: The above mentioned list of available metrics with its supported metrics can also be found\
\ in [Get grouped call metrics](#operation/getCallGroup) and [Get grouped trace metrics](#operation/getTraceGroups).\n\
\n3. *granularity* \n * If it is not set you will get a an aggregated value for the selected timeframe\n * If the\
\ granularity is set you will get data points with the specified granularity **in seconds**\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\n### Defaults:\n**timeFrame**\n```\n\"timeFrame\": {\n\t\"windowSize\": 60000,\n\t\"to\": {current timestamp}\n\
}\n```"
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Application Analyze
properties:
- type: OpenAPI
url: openapi/instana-application-analyze-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-application-catalog-api
name: Instana Application Catalog API
description: 'The endpoints of this group retrieve all available resources to query application metrics. It includes:
**Catalog for Application Tags**
Showing a list of tags which is used for building a query in various use cases within Instana, for example, subset of
tags which are available for grouping in traces in Unbounded Analytics for Traces.
**Catalog for metrics**
Showing a list of metrics that are available for aggregations. For example, Call count can have 2 types of aggrgations:
sum and per second.'
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Application Catalog
properties:
- type: OpenAPI
url: openapi/instana-application-catalog-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-application-metrics-api
name: Instana Application Metrics API
description: "The endpoints of this group retrieve the metrics for defined applications, discovered services and endpoints.\r\
\n### Mandatory Parameters\r\n\r\n**metrics** A list of metric objects that define which metric should be returned, with\
\ the defined aggregation. Each metrics objects consists of minimum two items:\r\n1. *metric* select a particular metric\
\ to get a list of available metrics query the [catalog endpoint](#operation/getApplicationCatalogMetrics).\r\n2. *aggregation*\
\ depending on the selected metric different aggregations are available e.g. SUM, MEAN, P95. The aforementioned [catalog\
\ endpoint](#operation/getApplicationCatalogMetrics) gives you the metrics with the available aggregations.\r\n\r\n**Note**:\
\ The above mentioned list of available metrics with its supported metrics can also be found in the section **Supported\
\ Aggregation on Application metrics** below.\r\n\r\n### Optional Parameters\r\n\r\n**metrics** Default you will get an\
\ aggregated metric with for the selected timeframe \r\n\r\n* *granularity* \r\n * If it is not set you will get a an\
\ aggregated value for the selected timeframe\r\n * If the granularity is set you will get data points with the specified\
\ granularity **in seconds**\r\n * The granularity should not be greater than the `windowSize` (important: `windowSize`\
\ is expressed in **milliseconds**)\r\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)\r\n \r\n**pagination** if you use pagination\
\ you most probably want to fix the timeFrame for the retrieved metrics\r\n1. *page* select the page number you want to\
\ retrieve\r\n2. *pageSize* set the number of applications you want to return with one query\r\n\r\n**order** You can\
\ order the returned items alphanumerical by label, either ascending or descending\r\n1. *by* if the granularity is set\
\ to 1 you can use the metric name eg. \"latency.p95\" to order by that value\r\n1. *direction* either ascending or descending\r\
\n\r\n**timeFrame** As in our UI you can specify the timeframe for metrics retrieval.\r\n```\r\n windowSize \
\ to\r\n (ms) (unix-timestamp)\r\n<----------------------|\r\n```\r\n\r\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 granularity, a default granularity will\
\ be used for adjustment.\r\n\r\nTo narrow down the result set you have four options to search for an application.\r\n\
\r\n**nameFilter | applicationId | serviceId | endpointId**\r\n\r\n* *nameFilter:* filter by name with \"contains\" semantic.\r\
\n\r\n* *applicationId:* search directly for an application by applicationId \r\n\r\n* *serviceId:* search for applications\
\ that include a particular service by serviceId\r\n\r\n* *endpointId:* search for applications that include a particular\
\ endpoint by endpointId\r\n\r\n### Defaults\r\n\r\n**metrics**\r\n* *granularity:* 1\r\n\r\n**order**\r\n* by application\
\ label ascending.\r\n\r\n**timeFrame**\r\n```\r\n\"timeFrame\": {\r\n\t\"windowSize\": 60000,\r\n\t\"to\": {current timestamp}\r\
\n}\r\n```\r\n**nameFilter | applicationId | serviceId | endpointId**\r\n* no filters are applied in the default call\r\
\n\r\n\r\n## Supported Aggregation on Application Metrics\r\n\r\n| Metric | Description \
\ | Allowed Aggregations |\r\n|------------------|--------------------------------------------------------------------------------------------|----------------------|\r\
\n| `calls` | Number of received calls | `PER_SECOND`,\
\ `SUM` |\r\n| `erroneousCalls` | The number of erroneous calls \
\ |`PER_SECOND`, `SUM` |\r\n| `latency` | Latency of received calls in milliseconds \
\ | `P25`, `P50`, `P75`, `P90`, `P95`, `P98`, `P99`, `SUM`, `MEAN`, `MAX`, `MIN` \
\ |\r\n| `errors` | Error rate of received calls. A value between 0 and 1 \
\ | `MEAN` |\r\n| `applications` | The number of Application Perspectives \
\ |`DISTINCT_COUNT` |\r\n| `services` | The number of Services \
\ |`DISTINCT_COUNT` |\r\n| `endpoints` | The number of Endpoints\
\ |`DISTINCT_COUNT` |\r\n| `http.1xx` |\
\ Counts the number of occurrences of HTTP status codes where 100 <= status code <= 199 |`PER_SECOND`, `SUM` |\r\
\n| `http.2xx` | Counts the number of occurrences of HTTP status codes where 200 <= status code <= 299 |`PER_SECOND`,\
\ `SUM` |\r\n| `http.3xx` | Counts the number of occurrences of HTTP status codes where 300 <= status code <=\
\ 399 |`PER_SECOND`, `SUM` |\r\n| `http.4xx` | Counts the number of occurrences of HTTP status codes where\
\ 400 <= status code <= 499 |`PER_SECOND`, `SUM` |\r\n| `http.5xx` | Counts the number of occurrences of\
\ HTTP status codes where 500 <= status code <= 599 |`PER_SECOND`, `SUM` |"
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Application Metrics
properties:
- type: OpenAPI
url: openapi/instana-application-metrics-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-application-resources-api
name: Instana Application Resources API
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.'
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Application Resources
properties:
- type: OpenAPI
url: openapi/instana-application-resources-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-application-settings-api
name: Instana Application Settings API
description: 'The API endpoints of this group provides a way to create, read, update, delete (CRUD) for various configuration
settings. It includes:
**Application Perspectives Configuration**
Set of APIs which perform CRUD operations for Application Perspectives.
**Endpoint Mapping Configuration**
Set of APIs which perform CRUD operations when user wants to customise the endpoint mapping rules.
**Service Mapping Configuration**
Set of APIs which perform CRUD operations when user wants to customise the service mapping rules.
**Manual Service Mapping Configuration**
Set of **experimental** APIS which perform CRUD operations when user wants to tweak the service mapping rules when automatic
service mapping rules gives undesired results.'
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Application Settings
properties:
- type: OpenAPI
url: openapi/instana-application-settings-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-application-topology-api
name: Instana Application Topology API
description: The Application Topology API from Instana — 1 operation(s) for application topology.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Application Topology
properties:
- type: OpenAPI
url: openapi/instana-application-topology-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-audit-log-api
name: Instana Audit Log API
description: The Audit Log API from Instana — 2 operation(s) for audit log.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Audit Log
properties:
- type: OpenAPI
url: openapi/instana-audit-log-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-authentication-api
name: Instana Authentication API
description: The Authentication API from Instana — 4 operation(s) for authentication.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Authentication
properties:
- type: OpenAPI
url: openapi/instana-authentication-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-business-monitoring-api
name: Instana Business Monitoring API
description: The Business Monitoring API from Instana — 5 operation(s) for business monitoring.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Business Monitoring
properties:
- type: OpenAPI
url: openapi/instana-business-monitoring-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-custom-dashboards-api
name: Instana Custom Dashboards API
description: 'You can use these API endpoints to manage custom dashboards. We recommend
that you leverage the `Edit as JSON` feature found within our user interface
to construct the desired request payloads. Specifically to help you build
correct widget configurations and access rules.
To identify the correct values for the `relatedId` field of the access rules,
we recommend using the `/api/custom-dashboard/shareable-users` and
`/api/custom-dashboard/shareable-api-tokens` endpoints. These endpoints return
our internal IDs for users and API tokens.'
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Custom Dashboards
properties:
- type: OpenAPI
url: openapi/instana-custom-dashboards-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-custom-entities-api
name: Instana Custom Entities API
description: The Custom Entities API from Instana — 2 operation(s) for custom entities.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Custom Entities
properties:
- type: OpenAPI
url: openapi/instana-custom-entities-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-end-user-monitoring-api
name: Instana End User Monitoring API
description: The End User Monitoring API from Instana — 1 operation(s) for end user monitoring.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- End User Monitoring
properties:
- type: OpenAPI
url: openapi/instana-end-user-monitoring-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-event-settings-api
name: Instana Event Settings API
description: The Event Settings API from Instana — 37 operation(s) for event settings.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Event Settings
properties:
- type: OpenAPI
url: openapi/instana-event-settings-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-events-api
name: Instana Events API
description: The Events API from Instana — 4 operation(s) for events.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Events
properties:
- type: OpenAPI
url: openapi/instana-events-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-global-application-alert-configuration-api
name: Instana Global Application Alert Configuration API
description: "The API endpoints of this group can be used to manage Global Application alert configurations.\n\n## Parameters:\n\
\nAll parameters and deprecated parameters are similar to Application Alert Configuration except **applications**\n\n\
- **applications:** Selection of applications, services and endpoints in scope. It allows more than one application to\
\ define a global rule across different Application Perspectives.\n\n #### Example: Select multiple Application Perspectives\n\
\n To select multiple applications with IDs `<appId1>`, `<appId2>` including all its services and endpoints,\nsimply\
\ provide the following selection object:\n\n ```json\n \"applications\": {\n \"<appId1>\": {\n \"applicationId\"\
: \"<appId1>\"\n },\n \"<appId2>\": {\n \"applicationId\": \"<appId2>\"\n }\n }\n ```"
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Global Application Alert Configuration
properties:
- type: OpenAPI
url: openapi/instana-global-application-alert-configuration-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-groups-api
name: Instana Groups API
description: 'Groups are used to permit individual users to perform specific actions and get visibility to an access scope.
Each user can be assigned to multiple groups, every one coming with its associated permissions. In addition a group sets
the access scope and you can configure the visible areas for the group members.
When you are a member of multiple groups, your permissions have an additive effect.
Granting access to certain entities within Instana (e.g. Applications, Kubernetes Clusters etc.) is done through a corresponding
entry in the `permissionSet` payload.'
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Groups
properties:
- type: OpenAPI
url: openapi/instana-groups-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-health-api
name: Instana Health API
description: The Health API from Instana — 2 operation(s) for health.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Health
properties:
- type: OpenAPI
url: openapi/instana-health-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-host-agent-api
name: Instana Host Agent API
description: Endpoints of this group can be used to list and configure host agents.
humanURL: https://www.ibm.com/docs/en/instana-observability/current?topic=apis-rest-api
tags:
- Host Agent
properties:
- type: OpenAPI
url: openapi/instana-host-agent-api-openapi.yml
- type: Documentation
url: https://instana.github.io/openapi/
- type: GitHubOrganization
url: https://github.com/instana/openapi
- aid: instana:instana-infrastructure-alert-configuration-api
name: Instana Infrastructure Alert Configuration API
description: The Infrastructure Alert Configuration API from Instana — 6 operation(s) for infrastructure alert configuration.
humanURL: https://www.ibm.com/docs/en/instana-
# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/instana/refs/heads/main/apis.yml