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 SLI Settings 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
\n \"info\n \n Our API documentation is moving to \n API Hub\n\t — please update your bookmarks now, as the current site will be deprecated after Release-306.\n \n
\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: SLI Settings description: '## Deprecated Parameters **tagFilters** The list of tag filters. It is replaced by **tagFilterExpression**' paths: /api/settings/sli: get: deprecated: true operationId: getAllSliConfigs responses: '200': content: application/json: example: id: 3J0RDgfyQz-P_hVzbNNb4A sliName: test-application-sli initialEvaluationTimestamp: 1732017600000 metricConfiguration: metricName: latency metricAggregation: P90 threshold: 555 sliEntity: sliType: application applicationId: btg-B709IU6o9QNXUS4TVw serviceId: null endpointId: null boundaryScope: INBOUND lastUpdated: 1732017541059 schema: type: array items: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK security: - ApiKeyAuth: - Default summary: Get All SLI Configs tags: - SLI Settings x-ibm-ahub-byok: true post: deprecated: true operationId: createSliConfig requestBody: content: application/json: example: sliName: test-application-sli metricConfiguration: metricName: latency metricAggregation: P90 threshold: 555 sliEntity: sliType: application applicationId: btg-B709IU6o9QNXUS4TVw serviceId: null endpointId: null boundaryScope: INBOUND schema: $ref: '#/components/schemas/SliConfiguration' required: true responses: '200': content: application/json: example: id: 3J0RDgfyQz-P_hVzbNNb4A sliName: test-application-sli initialEvaluationTimestamp: 1732017600000 metricConfiguration: metricName: latency metricAggregation: P90 threshold: 555 sliEntity: sliType: application applicationId: btg-B709IU6o9QNXUS4TVw serviceId: null endpointId: null boundaryScope: INBOUND lastUpdated: 1732017541059 schema: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK security: - ApiKeyAuth: - canConfigureServiceLevels summary: Create SLI Config tags: - SLI Settings x-ibm-ahub-byok: true description: 'This endpoint creates the Service Level Indicator Configuration ## Mandatory Parameters: - **id** A unique identifier for each SLI configuration - **sliName:** Name for the SLI configuration - **sliEntity:** Entity of the SLI configuration ### SLI Entity specific parameters Depending on the chosen `sliType` in the `sliEntity`, there are further required parameters: #### Application SLI entity This option can be used to create a Time-Based SLI - **sliEntity.applicationId:** The Id of the Application Perspective - **sliEntity.boundaryScope:** Boundary scope of the Application Perspective - **metricConfiguration.metricName:** The metric name on which to compute the SLI - **metricConfiguration.metricAggregation:** The aggregation of the metric - **metricConfiguration.threshold:** Threshold for the metric #### Availability SLI entity This opetion can be used to create an Event-Based SLI - **sliEntity.applicationId:** The Id of the Application Perspective - **sliEntity.boundaryScope:** Boundary scope of the Application Perspective ## Deprecated Parameters for Availability SLI entity: - **sliEntity.serviceId:** The ID if the Service in he context of an Application Perspective - **sliEntity.endpointId:** The ID of an Endpoint belonging to a Service - **sliEntity.goodEventFilters:** The list of TagFilters to match good events / calls - **sliEntity.badEventFilters:** The list of TagFilters to match bad events / calls All of these filters can be included using the list of TagFilterExpressions via **sliEntity.goodEventFilterExpression** and **sliEntity.badEventFilterExpression**. These parameters will be removed in the upcoming releases. ' /api/settings/sli/{id}: delete: deprecated: true operationId: deleteSliConfig parameters: - in: path name: id required: true schema: type: string description: Service Levels Indicator ID example: 7iydEfqJQP6AKzd3yR3byw responses: default: content: application/json: {} description: default response security: - ApiKeyAuth: - canConfigureServiceLevels summary: Delete SLI Config tags: - SLI Settings x-ibm-ahub-byok: true get: deprecated: true operationId: getSliConfig parameters: - in: path name: id required: true schema: type: string description: Service Levels Indicator ID example: 3J0RDgfyQz-P_hVzbNNb4A responses: '200': content: application/json: example: id: 3J0RDgfyQz-P_hVzbNNb4A sliName: test-application-sli initialEvaluationTimestamp: 1732017600000 metricConfiguration: metricName: latency metricAggregation: P90 threshold: 555 sliEntity: sliType: application applicationId: btg-B709IU6o9QNXUS4TVw serviceId: null endpointId: null boundaryScope: INBOUND lastUpdated: 1732017541059 schema: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK security: - ApiKeyAuth: - Default summary: Get SLI Config tags: - SLI Settings x-ibm-ahub-byok: true put: deprecated: true operationId: updateSliConfig parameters: - in: path name: id required: true schema: type: string description: Service Levels Indicator ID example: 3J0RDgfyQz-P_hVzbNNb4A requestBody: content: application/json: example: id: 3J0RDgfyQz-P_hVzbNNb4A sliName: test-application-sli initialEvaluationTimestamp: 1732017600000 metricConfiguration: metricName: latency metricAggregation: P90 threshold: 555 sliEntity: sliType: application applicationId: btg-B709IU6o9QNXUS4TVw serviceId: null endpointId: null boundaryScope: INBOUND lastUpdated: 1732017541059 schema: $ref: '#/components/schemas/SliConfiguration' required: true responses: '200': content: application/json: example: id: 3J0RDgfyQz-P_hVzbNNb4A sliName: test-application-sli initialEvaluationTimestamp: 1732017600000 metricConfiguration: metricName: latency metricAggregation: P90 threshold: 555 sliEntity: sliType: application applicationId: btg-B709IU6o9QNXUS4TVw serviceId: null endpointId: null boundaryScope: INBOUND lastUpdated: 1732017541059 schema: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK security: - ApiKeyAuth: - canConfigureServiceLevels summary: Update SLI Config tags: - SLI Settings x-ibm-ahub-byok: true /api/settings/v2/sli: get: operationId: getAllSliConfigsV2 responses: '200': content: application/json: example: - id: T0yCMBR4G sliName: Siva SLI test initialEvaluationTimestamp: 1637758860000 metricConfiguration: metricName: latency metricAggregation: P90 threshold: 100 sliEntity: sliType: application applicationId: 1qvXgVfLTNqi8gGTcCaNUw serviceId: 6097d596c3d9024034b3d03b2b5c43acea65e5a4 endpointId: oETFj2WyPusvXgRW_181J3fH_t8 boundaryScope: INBOUND lastUpdated: 1637758839104 schema: type: array items: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK security: - ApiKeyAuth: - Default summary: Get All SLI Configs tags: - SLI Settings x-ibm-ahub-byok: true post: operationId: createSliConfigV2 requestBody: content: application/json: example: sliName: test-application-sli metricConfiguration: metricName: latency metricAggregation: P90 threshold: 555 sliEntity: sliType: application applicationId: btg-B709IU6o9QNXUS4TVw serviceId: null endpointId: null boundaryScope: INBOUND schema: $ref: '#/components/schemas/SliConfiguration' required: true responses: '200': content: application/json: example: id: 3J0RDgfyQz-P_hVzbNNb4A sliName: test-application-sli initialEvaluationTimestamp: 1732017600000 metricConfiguration: metricName: latency metricAggregation: P90 threshold: 555 sliEntity: sliType: application applicationId: btg-B709IU6o9QNXUS4TVw serviceId: null endpointId: null boundaryScope: INBOUND lastUpdated: 1732017541059 schema: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: New SLI Configuration Created Successfully '400': content: application/json: example: '{"errors":["Unknown tag filter: call.eron"]}' schema: type: string description: Bad Request '422': content: application/json: example: '{"errors":["sliEntity.entityId must not be blank"]}' schema: type: string description: Unprocessable Entity security: - ApiKeyAuth: - canConfigureServiceLevels summary: Create SLI Config tags: - SLI Settings x-ibm-ahub-byok: true description: 'This endpoint creates the Service Level Indicator Configuration ## Mandatory Parameters: - **id** A unique identifier for each SLI configuration - **sliName:** Name for the SLI configuration - **sliEntity:** Entity of the SLI configuration ### SLI Entity specific parameters Depending on the chosen `sliType` in the `sliEntity`, there are further required parameters: #### Application SLI entity This option can be used to create a Time-Based SLI - **sliEntity.applicationId:** The Id of the Application Perspective - **sliEntity.boundaryScope:** Boundary scope of the Application Perspective - **metricConfiguration.metricName:** The metric name on which to compute the SLI - **metricConfiguration.metricAggregation:** The aggregation of the metric - **metricConfiguration.threshold:** Threshold for the metric #### Availability SLI entity This opetion can be used to create an Event-Based SLI - **sliEntity.applicationId:** The Id of the Application Perspective - **sliEntity.boundaryScope:** Boundary scope of the Application Perspective ## Deprecated Parameters for Availability SLI entity: - **sliEntity.serviceId:** The ID if the Service in he context of an Application Perspective - **sliEntity.endpointId:** The ID of an Endpoint belonging to a Service - **sliEntity.goodEventFilters:** The list of TagFilters to match good events / calls - **sliEntity.badEventFilters:** The list of TagFilters to match bad events / calls All of these filters can be included using the list of TagFilterExpressions via **sliEntity.goodEventFilterExpression** and **sliEntity.badEventFilterExpression**. These parameters will be removed in the upcoming releases. ' /api/settings/v2/sli/{entityType}/{entityId}: get: operationId: getSliConfigsForEntityTypeAndIdV2 parameters: - description: Type of the Entity, whether it is an application or website in: path name: entityType required: true schema: type: string enum: - APPLICATION - WEBSITE - description: Unique ID of the Entity example: DkPX-x9VQuKBKopuilrkYw in: path name: entityId required: true schema: type: string responses: '200': content: application/json: example: - id: HXcNRWhDSWiZs3HiUAKr7g sliName: turbo time 1 initialEvaluationTimestamp: 1648133520000 metricConfiguration: metricName: latency metricAggregation: P90 threshold: 300 sliEntity: sliType: application applicationId: 1qvXgVfLTNqi8gGTcCaNUw serviceId: null endpointId: null boundaryScope: INBOUND lastUpdated: 1648133508938 schema: type: array items: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK security: - ApiKeyAuth: - Default summary: Get all SLI configs for entity type and entity id tags: - SLI Settings x-ibm-ahub-byok: true /api/settings/v2/sli/{id}: delete: operationId: deleteSliConfigV2 parameters: - description: ID of the Service Level Indicator (SLI) example: HXcNRWhDSWiZs3HiUAKr7g in: path name: id required: true schema: type: string responses: '204': description: SLI Configuration Deleted Successfully security: - ApiKeyAuth: - canConfigureServiceLevels summary: Delete SLI Config tags: - SLI Settings x-ibm-ahub-byok: true get: operationId: getSliConfigV2 parameters: - description: ID of the Service Level Indicator (SLI) example: HXcNRWhDSWiZs3HiUAKr7g in: path name: id required: true schema: type: string responses: '200': content: application/json: example: - id: HXcNRWhDSWiZs3HiUAKr7g sliName: turbo time 1 initialEvaluationTimestamp: 1648133520000 metricConfiguration: metricName: latency metricAggregation: P90 threshold: 300 sliEntity: sliType: application applicationId: 1qvXgVfLTNqi8gGTcCaNUw serviceId: null endpointId: null boundaryScope: INBOUND lastUpdated: 1648133508938 schema: $ref: '#/components/schemas/SliConfigurationWithLastUpdated' description: OK '404': content: application/json: example: errors: - The SLI Configuration you are looking for does not exist. schema: type: string description: SLI Configuration Not Found security: - ApiKeyAuth: - Default summary: Get SLI Config tags: - SLI Settings x-ibm-ahub-byok: true components: schemas: SliEntity: type: object description: Entity Type of the SLI Configuration discriminator: mapping: application: '#/components/schemas/ApplicationSliEntity' availability: '#/components/schemas/AvailabilitySliEntity' websiteEventBased: '#/components/schemas/WebsiteEventBasedSliEntity' websiteTimeBased: '#/components/schemas/WebsiteTimeBasedSliEntity' propertyName: sliType properties: sliType: type: string required: - sliType MetricConfiguration: type: object description: Details regarding the metric to be configured, including the metric name, threshold, and aggregation method properties: metricAggregation: type: string description: 'Specifies the types of aggregations that can be applied to a series of values. For example, `P25` refers to the 25th percentile. Note that not all aggregation methods are available for every metric. For instance, the `Call count` metric supports only the `SUM` aggregation, whereas the `Error rate` metric only supports the `MEAN` aggregation. ' enum: - SUM - MEAN - MAX - MIN - P25 - P50 - P75 - P90 - P95 - P98 - P99 - P99_9 - P99_99 - DISTINCT_COUNT - SUM_POSITIVE - PER_SECOND - INCREASE metricName: type: string description: Defines the name of the metric to be monitored. Examples include `calls` and `latency` threshold: type: number format: double description: Specifies the threshold value for the metric being monitored exclusiveMinimum: true minimum: 0 required: - metricName SliConfigurationWithLastUpdated: type: object properties: id: type: string description: Unique ID for each SLI maxLength: 64 minLength: 0 initialEvaluationTimestamp: type: integer format: int64 description: Initial evaluation timestamp in milliseconds (13-digit) lastUpdated: type: integer format: int64 description: Last Updated timestamp in milliseconds (13-digit) minimum: 1 metricConfiguration: $ref: '#/components/schemas/MetricConfiguration' sliEntity: $ref: '#/components/schemas/SliEntity' sliName: type: string description: The name of the Service Level Indicator (SLI) specified during its creation maxLength: 256 minLength: 0 required: - id - sliEntity - sliName SliConfiguration: type: object properties: id: type: string description: Unique ID for each SLI maxLength: 64 minLength: 0 initialEvaluationTimestamp: type: integer format: int64 description: Initial evaluation timestamp in milliseconds (13-digit) metricConfiguration: $ref: '#/components/schemas/MetricConfiguration' sliEntity: $ref: '#/components/schemas/SliEntity' sliName: type: string description: The name of the Service Level Indicator (SLI) specified during its creation maxLength: 256 minLength: 0 required: - id - sliEntity - sliName 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