Instana Synthetic Alert Configuration API

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 Synthetic Alert…
  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: Synthetic Alert Configuration
  description: The API endpoints of this group can be used to manage alert configurations for Synthetic Monitoring.
paths:
  /api/events/settings/global-alert-configs/synthetics:
    get:
      description: 'Gets all the Synthetic Smart Alert Configuration pertaining to a specific synthetic test. Configurations are sorted by creation date in descending order.

        For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.'
      operationId: findActiveSyntheticAlertConfigs
      parameters:
      - description: 'The ID of a specific Synthetic Test. '
        example: ic25Vt1T5dgKzi0K7812
        in: query
        name: syntheticTestId
        schema:
          type: string
      - description: A list of Smart Alert Configuration IDs. This allows fetching of a specific set of Configurations. This query can be repeated to use multiple IDs.
        example: smRTFp08juKWtn8I
        in: query
        name: alertIds
        schema:
          type: array
          items:
            type: string
          maxItems: 1000
          minItems: 0
          uniqueItems: true
      responses:
        '200':
          content:
            application/json:
              example:
              - name: Tests in EU are failing
                description: Tests in EU failed for 1 consecutive time
                syntheticTestIds:
                - ic25Vt1T5dgKzi0K7812
                - 2gBxQz3oKtXgFXzRoQ6O
                severity: 5
                tagFilterExpression:
                  type: EXPRESSION
                  logicalOperator: AND
                  elements:
                  - type: TAG_FILTER
                    name: synthetic.serviceId
                    stringValue: '12'
                    numberValue: null
                    booleanValue: null
                    key: null
                    value: '12'
                    operator: EQUALS
                    entity: NOT_APPLICABLE
                  - type: TAG_FILTER
                    name: synthetic.locationLabel
                    stringValue: US-west1
                    numberValue: null
                    booleanValue: null
                    key: null
                    value: '123'
                    operator: EQUALS
                    entity: NOT_APPLICABLE
                rule:
                  alertType: failure
                  metricName: status
                  aggregation: SUM
                alertChannelIds: []
                timeThreshold:
                  type: violationsInSequence
                  violationsCount: 1
                customPayloadFields: []
                id: 2K1YQIeaSQKIcIkHPH7D3g
                created: 1707486254161
                initialCreated: 1706531043586
                readOnly: false
                enabled: true
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SyntheticAlertConfigWithMetadata'
          description: Success. Returns empty result if syntheticTestId is invalid.
        '403':
          description: Insufficient permissions.
      security:
      - ApiKeyAuth:
        - Default
      summary: Get all Synthetic Smart Alert Configs
      tags:
      - Synthetic Alert Configuration
      x-ibm-ahub-byok: true
    post:
      description: 'Creates a new Synthetic Smart Alert Configuration.

        For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.'
      operationId: createSyntheticAlertConfig
      requestBody:
        content:
          application/json:
            example:
              name: 2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel}
              description: Alert created without test but with AppId - Synthetic test failed for 2 consecutive times
              syntheticTestIds:
              - ic25Vt1T5dgKzi0K7812
              - 2gBxQz3oKtXgFXzRoQ6O
              severity: 5
              tagFilterExpression:
                type: TAG_FILTER
                name: synthetic.applicationId
                stringValue: 2BPCBLz_RBG8J6mjyuxm6w
                numberValue: null
                booleanValue: null
                key: null
                value: 2BPCBLz_RBG8J6mjyuxm6w
                operator: EQUALS
                entity: NOT_APPLICABLE
              rule:
                alertType: failure
                metricName: status
                aggregation: SUM
              alertChannelIds:
              - 0o1ISHPfR8-N4iUK
              timeThreshold:
                type: violationsInSequence
                violationsCount: 2
              customPayloadFields: []
            schema:
              $ref: '#/components/schemas/SyntheticAlertConfig'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                name: 2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel}
                description: Alert created without test but with AppId - Synthetic test failed for 2 consecutive times
                syntheticTestIds:
                - ic25Vt1T5dgKzi0K7812
                - 2gBxQz3oKtXgFXzRoQ6O
                severity: 5
                tagFilterExpression:
                  type: TAG_FILTER
                  name: synthetic.applicationId
                  stringValue: 2BPCBLz_RBG8J6mjyuxm6w
                  numberValue: null
                  booleanValue: null
                  key: null
                  value: 2BPCBLz_RBG8J6mjyuxm6w
                  operator: EQUALS
                  entity: NOT_APPLICABLE
                rule:
                  alertType: failure
                  metricName: status
                  aggregation: SUM
                alertChannelIds:
                - 0o1ISHPfR8-N4iUK
                timeThreshold:
                  type: violationsInSequence
                  violationsCount: 2
                customPayloadFields: []
                id: qgEwvI0vRfe3Al_D7T7LSA
                created: 1707149760053
                initialCreated: 1707145201046
                readOnly: false
                enabled: true
              schema:
                $ref: '#/components/schemas/SyntheticAlertConfigWithMetadata'
          description: Synthetic Smart Alert Configuration created.
        '400':
          description: Invalid configuration.
        '403':
          description: Insufficient permissions.
        '422':
          description: Unprocessable entity.
      security:
      - ApiKeyAuth:
        - CanConfigureGlobalSyntheticSmartAlerts
      summary: Create Synthetic Smart Alert Config
      tags:
      - Synthetic Alert Configuration
      x-ibm-ahub-byok: true
  /api/events/settings/global-alert-configs/synthetics/{id}:
    delete:
      description: 'Deletes a Synthetic Smart Alert Configuration.

        For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.'
      operationId: deleteSyntheticAlertConfig
      parameters:
      - description: ID of a specific Synthetic Smart Alert Configuration to delete.
        example: 2K1YQIeaSQKIcIkHPH7D3g
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Synthetic Smart Alert Configuration deleted.
        '403':
          description: Insufficient permissions.
        '404':
          description: Invalid Configuration ID provided.
      security:
      - ApiKeyAuth:
        - CanConfigureGlobalSyntheticSmartAlerts
      summary: Delete Synthetic Smart Alert Config
      tags:
      - Synthetic Alert Configuration
      x-ibm-ahub-byok: true
    get:
      description: 'Gets a specific Synthetic Smart Alert Configuration. This may return a deleted Configuration.

        For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.'
      operationId: findSyntheticAlertConfig
      parameters:
      - description: ID of a specific Synthetic Smart Alert Configuration to retrieve.
        example: qgEwvI0vRfe3Al_D7T7LSA
        in: path
        name: id
        required: true
        schema:
          type: string
      - description: 'A Unix timestamp representing a specific time the Configuration was active. If no timestamp is provided, the latest active version will be retrieved. '
        example: 1707149760053
        in: query
        name: validOn
        schema:
          type: integer
          format: int64
      responses:
        '200':
          content:
            application/json:
              example:
                name: 2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel}
                description: Alert created without test but with AppId - Synthetic test failed for 2 consecutive times
                syntheticTestIds:
                - ic25Vt1T5dgKzi0K7812
                - 2gBxQz3oKtXgFXzRoQ6O
                severity: 5
                tagFilterExpression:
                  type: TAG_FILTER
                  name: synthetic.applicationId
                  stringValue: 2BPCBLz_RBG8J6mjyuxm6w
                  numberValue: null
                  booleanValue: null
                  key: null
                  value: 2BPCBLz_RBG8J6mjyuxm6w
                  operator: EQUALS
                  entity: NOT_APPLICABLE
                rule:
                  alertType: failure
                  metricName: status
                  aggregation: SUM
                alertChannelIds:
                - 0o1ISHPfR8-N4iUK
                timeThreshold:
                  type: violationsInSequence
                  violationsCount: 2
                customPayloadFields: []
                id: qgEwvI0vRfe3Al_D7T7LSA
                created: 1707149760053
                initialCreated: 1707145201046
                readOnly: false
                enabled: true
              schema:
                $ref: '#/components/schemas/SyntheticAlertConfigWithMetadata'
          description: OK
        '403':
          description: Insufficient permissions.
        '404':
          description: The requested Configuration does not exist.
      security:
      - ApiKeyAuth:
        - Default
      summary: Get Synthetic Smart Alert Config
      tags:
      - Synthetic Alert Configuration
      x-ibm-ahub-byok: true
    post:
      description: 'Updates an existing Synthetic Smart Alert Configuration.

        For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.'
      operationId: updateSyntheticAlertConfig
      parameters:
      - description: ID of a specific Synthetic Smart Alert Configuration to update.
        example: qgEwvI0vRfe3Al_D7T7LSA
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              name: 2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel}
              description: Alert created without test but with AppId - Synthetic test failed for 2 consecutive times
              syntheticTestIds:
              - ic25Vt1T5dgKzi0K7812
              - 2gBxQz3oKtXgFXzRoQ6O
              severity: 5
              tagFilterExpression:
                type: TAG_FILTER
                name: synthetic.applicationId
                stringValue: 2BPCBLz_RBG8J6mjyuxm6w
                numberValue: null
                booleanValue: null
                key: null
                value: 2BPCBLz_RBG8J6mjyuxm6w
                operator: EQUALS
                entity: NOT_APPLICABLE
              rule:
                alertType: failure
                metricName: status
                aggregation: SUM
              alertChannelIds:
              - 0o1ISHPfR8-N4iUK
              timeThreshold:
                type: violationsInSequence
                violationsCount: 2
              customPayloadFields: []
            schema:
              $ref: '#/components/schemas/SyntheticAlertConfig'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                name: 2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel}
                description: Alert created without test but with AppId - Synthetic test failed for 2 consecutive times
                syntheticTestIds:
                - ic25Vt1T5dgKzi0K7812
                - 2gBxQz3oKtXgFXzRoQ6O
                severity: 5
                tagFilterExpression:
                  type: TAG_FILTER
                  name: synthetic.applicationId
                  stringValue: 2BPCBLz_RBG8J6mjyuxm6w
                  numberValue: null
                  booleanValue: null
                  key: null
                  value: 2BPCBLz_RBG8J6mjyuxm6w
                  operator: EQUALS
                  entity: NOT_APPLICABLE
                rule:
                  alertType: failure
                  metricName: status
                  aggregation: SUM
                alertChannelIds:
                - 0o1ISHPfR8-N4iUK
                timeThreshold:
                  type: violationsInSequence
                  violationsCount: 2
                customPayloadFields: []
                id: qgEwvI0vRfe3Al_D7T7LSA
                created: 1707149760053
                initialCreated: 1707145201046
                readOnly: false
                enabled: true
              schema:
                $ref: '#/components/schemas/SyntheticAlertConfigWithMetadata'
          description: Synthetic Smart Alert Configuration updated
        '204':
          description: Synthetic Smart Alert Configuration did not change
        '400':
          description: Invalid Configuration ID provided.
        '403':
          description: Insufficient permissions.
        '422':
          description: Unprocessable entity.
        '500':
          description: Internal error.
      security:
      - ApiKeyAuth:
        - CanConfigureGlobalSyntheticSmartAlerts
      summary: Update Synthetic Smart Alert Config
      tags:
      - Synthetic Alert Configuration
      x-ibm-ahub-byok: true
  /api/events/settings/global-alert-configs/synthetics/{id}/disable:
    put:
      description: 'Disables a Synthetic Smart Alert Configuration.

        For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.'
      operationId: disableSyntheticAlertConfig
      parameters:
      - description: ID of a specific Synthetic Smart Alert Configuration to disable.
        example: 2K1YQIeaSQKIcIkHPH7D3g
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type:
              - string
              - 'null'
      responses:
        '204':
          description: Synthetic Smart Alert Configuration disabled.
        '403':
          description: Insufficient permissions.
        '404':
          description: Invalid Configuration ID provided.
      security:
      - ApiKeyAuth:
        - CanConfigureGlobalSyntheticSmartAlerts
      summary: Disable Synthetic Smart Alert Config
      tags:
      - Synthetic Alert Configuration
      x-ibm-ahub-byok: true
  /api/events/settings/global-alert-configs/synthetics/{id}/enable:
    put:
      description: 'Enables a Synthetic Smart Alert Configuration.

        For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.'
      operationId: enableSyntheticAlertConfig
      parameters:
      - description: ID of a specific Synthetic Smart Alert Configuration to enable.
        example: 2K1YQIeaSQKIcIkHPH7D3g
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type:
              - string
              - 'null'
      responses:
        '204':
          description: Synthetic Smart Alert Configuration enabled.
        '403':
          description: Insufficient permissions.
        '404':
          description: Invalid Configuration ID provided.
      security:
      - ApiKeyAuth:
        - CanConfigureGlobalSyntheticSmartAlerts
      summary: Enable Synthetic Smart Alert Config
      tags:
      - Synthetic Alert Configuration
      x-ibm-ahub-byok: true
  /api/events/settings/global-alert-configs/synthetics/{id}/restore/{created}:
    put:
      description: 'Restores a deleted Synthetic Smart Alert Configuration.

        For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.'
      operationId: restoreSyntheticAlertConfig
      parameters:
      - description: ID of a specific Synthetic Smart Alert Configuration to restore.
        example: 2K1YQIeaSQKIcIkHPH7D3g
        in: path
        name: id
        required: true
        schema:
          type: string
      - description: Unix timestamp representing the creation time of a specific Synthetic Smart Alert Configuration.
        example: 1707726529124
        in: path
        name: created
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              type:
              - string
              - 'null'
      responses:
        '204':
          description: Synthetic Smart Alert Configuration restored.
        '403':
          description: Insufficient permissions.
        '404':
          description: Invalid Configuration provided.
      security:
      - ApiKeyAuth:
        - CanConfigureGlobalSyntheticSmartAlerts
      summary: Restore Synthetic Smart Alert Config
      tags:
      - Synthetic Alert Configuration
      x-ibm-ahub-byok: true
  /api/events/settings/global-alert-configs/synthetics/{id}/versions:
    get:
      description: 'Gets all versions of a Synthetic Smart Alert Configuration. This may return deleted Configurations. Configurations are sorted by creation date in descending order.

        For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.'
      operationId: findSyntheticAlertConfigVersions
      parameters:
      - description: ID of a specific Synthetic Smart Alert Configuration to retrieve.
        example: qgEwvI0vRfe3Al_D7T7LSA
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
              - id: qgEwvI0vRfe3Al_D7T7LSA
                created: 1707149760053
                enabled: true
                deleted: false
                changeSummary:
                  changeType: UPDATE
                  author:
                    id: 6244073003b38f0001209ec5
                    type: USER
                    fullName: John Doe
              - id: qgEwvI0vRfe3Al_D7T7LSA
                created: 1707145201046
                enabled: true
                deleted: false
                changeSummary:
                  changeType: CREATE
                  author:
                    id: 6244073003b38f0001209ec5
                    type: USER
                    fullName: John Doe
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConfigVersion'
          description: OK
        '403':
          description: Insufficient permissions.
        '404':
          description: The requested Configuration does not exist.
      security:
      - ApiKeyAuth:
        - Default
      summary: Get Synthetic Smart Alert Config Versions
      tags:
      - Synthetic Alert Configuration
      x-ibm-ahub-byok: true
components:
  schemas:
    Author:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - API
          - USER
          - INSTANA
          - UNKNOWN
    SyntheticTimeThreshold:
      type: object
      description: The type of threshold to define the criteria when the event and alert triggers and resolves.
      discriminator:
        mapping:
          violationsInSequence: '#/components/schemas/ViolationsInSequenceSyntheticTimeThreshold'
        propertyName: type
      properties:
        type:
          type: string
        violationsCount:
          type: integer
          format: int32
          maximum: 12
          minimum: 1
      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
    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
    SyntheticAlertConfig:
      type: object
      properties:
        alertChannelIds:
          type: array
          description: List of IDs of alert channels defined in Instana. Can be left empty.
          items:
            type: string
            description: List of IDs of alert channels defined in Instana. Can be left empty.
          maxItems: 1024
          minItems: 0
          uniqueItems: true
        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 synthetic alert configuration. 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.
        name:
          type: string
          description: Name of the synthetic alert configuration. Used as a template for the title of alert/event notifications triggered by this Smart Alert configuration.
          maxLength: 256
          minLength: 0
        rule:
          $ref: '#/components/schemas/SyntheticAlertRule'
        severity:
          type: integer
          format: int32
          description: The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical).
          maximum: 10
          minimum: 5
        syntheticTestIds:
          type: array
          description: IDs of the synthetic tests that this Smart Alert configuration is applied to.
          items:
            type: string
            description: IDs of the synthetic tests that this Smart Alert configuration is applied to.
          uniqueItems: true
        tagFilterExpression:
          $ref: '#/components/schemas/TagFilterExpressionElement'
        timeThreshold:
          $ref: '#/components/schemas/SyntheticTimeThreshold'
      required:
      - alertChannelIds
      - customPayloadFields
      - description
      - name
      - rule
      - syntheticTestIds
      - 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
    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
    SyntheticAlertConfigWithMetadata:
      type: object
      properties:
        alertChannelIds:
          type: array
          description: List of IDs of alert channels defined in Instana. Can be left empty.
          items:
            type: string
            description: List of IDs of alert channels defined in Instana. Can be left empty.
          maxItems: 1024
          minItems: 0
          uniqueItems: true
        created:
          type: integer
          format: int64
          description: Unix timestamp representing the creation time of this revision.
          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 synthetic alert configuration. Used as a template for the description of alert/event notifications triggered by this Smart Alert configuration.
          maxLength: 65536
          minLength: 0
        enabled:
          type: boolean
          description: Flag to indicate whether or not the configuration is enabled.
        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.
        id:
          type: string
          description: 'ID of this Synthetic Alert Config. '
          maxLength: 64
          minLength: 0
        initialCreated:
          type: integer
          format: int64
          description: Unix timestamp representing the time of the initial revision.
          minimum: 1
        name:
          type: string
          description: Name of the synthetic alert configuration. Used as a template for the title of alert/event notifications triggered by this Smart Alert configuration.
          maxLength: 256
          minLength: 0
        readOnly:
          type: boolean
          description: Flag to indicate whether or not the configuration is read-only. Read-only access restricts modification of the config.
        rule:
          $ref: '#/components/schemas/SyntheticAlertRule'
        severity:
          type: integer
          format: int32
          description: The severity of the alert when triggered, which is either 5 (Warning), or 10 (Critical).
          maximum: 10
          minimum: 5
        syntheticTestIds:
          type: array
          description: IDs of the synthetic tests that this Smart Alert configuration is applied to.
          items:
            type: string
            description: IDs of the synthetic tests that this Smart Alert configuration is applied to.
          uniqueItems: true
        tagFilterExpression:
          $ref: '#/components/schemas/TagFilterExpressionElement'
        timeThreshold:
          $ref: '#/components/schemas/SyntheticTimeThreshold'
      required:
      - alertChannelIds
      - customPayloadFields
      - description
      - id
      - name
      - rule
      - syntheticTestIds
      - tagFilterExpression
      - timeThreshold
    SyntheticAlertRule:
      type: object
      description: Indicates the type of rule this alert configuration is about.
      discriminator:
        mapping:
          failure: '#/components/schemas/FailureSyntheticAlertRule'
        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
  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


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/instana/refs/heads/main/openapi/instana-synthetic-alert-configuration-api-openapi.yml