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 Log Alert Configuration 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: Log Alert Configuration paths: /api/events/settings/global-alert-configs/logs: get: description: Configs are sorted descending by their created date. operationId: findActiveLogAlertConfigs parameters: - in: query name: alertIds schema: type: array items: type: string maxItems: 1000 minItems: 0 uniqueItems: true responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/LogAlertConfigWithMetadata' description: OK security: - ApiKeyAuth: - Default summary: All Log Alert Configs tags: - Log Alert Configuration x-ibm-ahub-byok: true post: operationId: createLogAlertConfig requestBody: content: application/json: schema: $ref: '#/components/schemas/LogAlertConfig' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LogAlertConfigWithMetadata' description: OK '403': description: Insufficient permissions. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts summary: Create Log Alert Config tags: - Log Alert Configuration x-ibm-ahub-byok: true /api/events/settings/global-alert-configs/logs/{id}: delete: operationId: deleteLogAlertConfig parameters: - in: path name: id required: true schema: type: string responses: '204': description: Log Alert Configuration deleted. '403': description: Insufficient permissions. '404': description: Invalid Configuration ID provided. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts summary: Delete Log Alert Config tags: - Log Alert Configuration x-ibm-ahub-byok: true get: description: Find a Log Alert Config by ID. This will deliver deleted configs too. operationId: findLogAlertConfig parameters: - in: path name: id required: true schema: type: string - in: query name: validOn schema: type: integer format: int64 responses: '200': content: application/json: schema: $ref: '#/components/schemas/LogAlertConfigWithMetadata' description: OK '404': description: Invalid Configuration ID provided. security: - ApiKeyAuth: - Default summary: Get Log Alert Config tags: - Log Alert Configuration x-ibm-ahub-byok: true post: operationId: updateLogAlertConfig parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LogAlertConfig' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LogAlertConfigWithMetadata' description: Log Smart Alert successfully updated '204': description: Log Smart Alert did not change '403': description: Insufficient permissions. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts summary: Update Log Alert Config tags: - Log Alert Configuration x-ibm-ahub-byok: true /api/events/settings/global-alert-configs/logs/{id}/disable: put: operationId: disableLogAlertConfig parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: type: string nullable: true responses: '204': description: Log Alert Configuration disabled. '403': description: Insufficient permissions. '404': description: Invalid Configuration ID provided. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts summary: Disable Log Alert Config tags: - Log Alert Configuration x-ibm-ahub-byok: true /api/events/settings/global-alert-configs/logs/{id}/enable: put: operationId: enableLogAlertConfig parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: type: string nullable: true responses: '204': description: Log Alert Configuration enabled. '403': description: Insufficient permissions. '404': description: Invalid Configuration ID provided. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts summary: Enable Log Alert Config tags: - Log Alert Configuration x-ibm-ahub-byok: true /api/events/settings/global-alert-configs/logs/{id}/restore/{created}: put: operationId: restoreLogAlertConfig parameters: - in: path name: id required: true schema: type: string - in: path name: created required: true schema: type: integer format: int64 requestBody: content: application/json: schema: type: string nullable: true responses: '204': description: Log Alert Configuration restored. '403': description: Insufficient permissions. '404': description: Invalid Configuration provided. security: - ApiKeyAuth: - CanConfigureGlobalLogSmartAlerts summary: Restore Log Alert Config tags: - Log Alert Configuration x-ibm-ahub-byok: true /api/events/settings/global-alert-configs/logs/{id}/versions: get: description: Find all versions of a Log Alert Config by ID. This will deliver deleted configs too. Configs are sorted descending by their created date. operationId: findLogAlertConfigVersions parameters: - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ConfigVersion' description: OK '404': description: Invalid Configuration ID provided. security: - ApiKeyAuth: - Default summary: Get versions of Log Alert Config tags: - Log Alert Configuration x-ibm-ahub-byok: true components: schemas: ThresholdConfigRule: type: object discriminator: mapping: adaptiveBaseline: '#/components/schemas/AdaptiveThresholdRule' historicBaseline: '#/components/schemas/StaticBaselineThresholdRule' staticThreshold: '#/components/schemas/StaticThresholdRule' propertyName: type properties: type: type: string required: - type LogAlertRule: type: object discriminator: mapping: logCount: '#/components/schemas/LogCountAlertRule' propertyName: alertType properties: aggregation: type: string enum: - SUM - MEAN - MAX - MIN - P25 - P50 - P75 - P90 - P95 - P98 - P99 - P99_9 - P99_99 - DISTINCT_COUNT - SUM_POSITIVE - PER_SECOND - INCREASE alertType: type: string metricName: type: string required: - alertType - metricName Author: type: object properties: id: type: string type: type: string enum: - API - USER - INSTANA - UNKNOWN LogAlertConfigWithMetadata: type: object properties: alertChannelIds: type: array deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. items: type: string deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. maxItems: 1024 minItems: 0 uniqueItems: true alertChannels: type: object additionalProperties: type: array description: Set of alert channel IDs associated with the severity. items: type: string description: Set of alert channel IDs associated with the severity. uniqueItems: true description: Set of alert channel IDs associated with the severity. created: type: integer format: int64 minimum: 1 customPayloadFields: type: array description: Custom payload fields to send additional information in the alert notifications. Can be left empty. items: $ref: '#/components/schemas/CustomPayloadField' maxItems: 20 minItems: 0 description: type: string description: Description of the Log Smart Alert. Used as a template for the description of alert/event notifications triggered by this Smart Alert configuration. maxLength: 65536 minLength: 0 enabled: type: boolean gracePeriod: type: integer format: int64 description: The duration for which an alert remains open after conditions are no longer violated, with the alert auto-closing once the grace period expires. granularity: type: integer format: int32 default: 600000 description: The evaluation granularity used for detection of violations of the defined threshold. Defines the size of the tumbling window used. enum: - 60000 - 300000 - 600000 - 900000 - 1200000 - 1800000 groupBy: type: array description: The grouping tags used to group the metric results. items: $ref: '#/components/schemas/GroupByTag' maxItems: 1 minItems: 0 id: type: string maxLength: 64 minLength: 0 initialCreated: type: integer format: int64 minimum: 1 name: type: string description: Name of the Log Smart Alert. Used as a template for the title of alert/event notifications triggered by this Smart Alert configuration. maxLength: 256 minLength: 0 readOnly: type: boolean rules: type: array description: A list of rules where each rule is associated with multiple thresholds and their corresponding severity levels. This enables more complex alert configurations with validations to ensure consistent and logical threshold-severity combinations. items: $ref: '#/components/schemas/RuleWithThresholdLogAlertRule' maxItems: 1 minItems: 1 severity: type: integer format: int32 deprecated: true description: The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' threshold: $ref: '#/components/schemas/Threshold' timeThreshold: $ref: '#/components/schemas/LogTimeThreshold' required: - description - granularity - id - name - tagFilterExpression - timeThreshold CustomPayloadField: type: object description: Custom payload fields to send additional information in the alert notifications. Can be left empty. discriminator: mapping: dynamic: '#/components/schemas/DynamicField' staticString: '#/components/schemas/StaticStringField' propertyName: type properties: key: type: string description: A user-specified unique identifier or name for a custom payload entry. type: type: string required: - key - type ConfigVersion: type: object properties: changeSummary: $ref: '#/components/schemas/ChangeSummary' created: type: integer format: int64 description: Unix timestamp representing the creation time of this revision. minimum: 1 deleted: type: boolean deprecated: true description: Flag to indicate whether or not the configuration was deleted. enabled: type: boolean deprecated: true description: Flag to indicate whether or not the configuration is enabled. id: type: string description: ID of this configuration version. maxLength: 64 minLength: 0 required: - id ChangeSummary: type: object description: Brief summary of changes made in this config version. properties: author: $ref: '#/components/schemas/Author' changeType: type: string enum: - CREATE - UPDATE - DELETE - ENABLE - DISABLE - RESTORE - UNKNOWN required: - author - changeType LogAlertConfig: type: object properties: alertChannelIds: type: array deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. items: type: string deprecated: true description: List of IDs of alert channels defined in Instana. Can be left empty. maxItems: 1024 minItems: 0 uniqueItems: true alertChannels: type: object additionalProperties: type: array description: Set of alert channel IDs associated with the severity. items: type: string description: Set of alert channel IDs associated with the severity. uniqueItems: true description: Set of alert channel IDs associated with the severity. customPayloadFields: type: array description: Custom payload fields to send additional information in the alert notifications. Can be left empty. items: $ref: '#/components/schemas/CustomPayloadField' maxItems: 20 minItems: 0 description: type: string description: Description of the Log Smart Alert. Used as a template for the description of alert/event notifications triggered by this Smart Alert configuration. maxLength: 65536 minLength: 0 gracePeriod: type: integer format: int64 description: The duration for which an alert remains open after conditions are no longer violated, with the alert auto-closing once the grace period expires. granularity: type: integer format: int32 default: 600000 description: The evaluation granularity used for detection of violations of the defined threshold. Defines the size of the tumbling window used. enum: - 60000 - 300000 - 600000 - 900000 - 1200000 - 1800000 groupBy: type: array description: The grouping tags used to group the metric results. items: $ref: '#/components/schemas/GroupByTag' maxItems: 1 minItems: 0 name: type: string description: Name of the Log Smart Alert. Used as a template for the title of alert/event notifications triggered by this Smart Alert configuration. maxLength: 256 minLength: 0 rules: type: array description: A list of rules where each rule is associated with multiple thresholds and their corresponding severity levels. This enables more complex alert configurations with validations to ensure consistent and logical threshold-severity combinations. items: $ref: '#/components/schemas/RuleWithThresholdLogAlertRule' maxItems: 1 minItems: 1 severity: type: integer format: int32 deprecated: true description: The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical). tagFilterExpression: $ref: '#/components/schemas/TagFilterExpressionElement' threshold: $ref: '#/components/schemas/Threshold' timeThreshold: $ref: '#/components/schemas/LogTimeThreshold' required: - description - granularity - name - tagFilterExpression - timeThreshold LogTimeThreshold: type: object description: The type of threshold to define the criteria when the event and alert triggers and resolves. discriminator: mapping: violationsInSequence: '#/components/schemas/ViolationsInSequenceLogTimeThreshold' propertyName: type properties: timeWindow: type: integer format: int64 type: type: string required: - type TagFilterExpressionElement: type: object description: Boolean expression of tag filters to define the scope of relevant calls. discriminator: mapping: EXPRESSION: '#/components/schemas/TagFilterExpression' TAG_FILTER: '#/components/schemas/TagFilter' propertyName: type properties: type: type: string required: - type GroupByTag: type: object description: The grouping tags used to group the metric results. properties: key: type: string tagName: type: string required: - tagName RuleWithThresholdLogAlertRule: type: object description: A list of rules where each rule is associated with multiple thresholds and their corresponding severity levels. This enables more complex alert configurations with validations to ensure consistent and logical threshold-severity combinations. properties: rule: $ref: '#/components/schemas/LogAlertRule' thresholdOperator: type: string enum: - '>' - '>=' - < - <= thresholds: type: object additionalProperties: $ref: '#/components/schemas/ThresholdConfigRule' required: - rule - thresholdOperator - thresholds Threshold: type: object deprecated: true description: Indicates the type of threshold this alert rule is evaluated on. discriminator: mapping: adaptiveBaseline: '#/components/schemas/AdaptiveBaseline' historicBaseline: '#/components/schemas/HistoricBaseline' staticThreshold: '#/components/schemas/StaticThreshold' propertyName: type properties: operator: type: string enum: - '>' - '>=' - < - <= type: type: string required: - operator - type 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