Instana Log Alert Configuration API

The Log Alert Configuration API from Instana — 6 operation(s) for log alert configuration.

Business capability
Observability Management BC-4220.20

Operations 9

GET /api/events/settings/global-alert-configs/logs All Log Alert Configs #
POST /api/events/settings/global-alert-configs/logs Create Log Alert Config #
DELETE /api/events/settings/global-alert-configs/logs/{id} Delete Log Alert Config #
GET /api/events/settings/global-alert-configs/logs/{id} Get Log Alert Config #
POST /api/events/settings/global-alert-configs/logs/{id} Update Log Alert Config #
PUT /api/events/settings/global-alert-configs/logs/{id}/disable Disable Log Alert Config #
PUT /api/events/settings/global-alert-configs/logs/{id}/enable Enable Log Alert Config #
PUT /api/events/settings/global-alert-configs/logs/{id}/restore/{created} Restore Log Alert Config #
GET /api/events/settings/global-alert-configs/logs/{id}/versions Get versions of Log Alert Config #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/instana-log-alert-configuration-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

instana-log-alert-configuration-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  contact:
    email: support@instana.com
    name: © Instana
    url: http://instana.com
  termsOfService: https://www.instana.com/terms-of-use/
  title: Instana REST API documentation 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?
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
              - 'null'
      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
              - 'null'
      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
              - 'null'
      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:
    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
    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
    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
    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
    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
    GroupByTag:
      type: object
      description: The grouping tags used to group the metric results.
      properties:
        key:
          type: string
        tagName:
          type: string
      required:
      - tagName
    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
    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
    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
    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
    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
    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