AnomalyArmor Alert Rules API

openapi: 3.2.0
info:
  title: Anomalyarmor Ai Alert Rules API
  version: 1.0.0
  contact:
    name: AnomalyArmor Support
    url: https://anomalyarmor.ai/support
  license:
    name: Proprietary
  description: 'Operations tagged alert-rules across 3 of this provider''s published API definitions: anomalyarmor.ai-openapi.json, app.anomalyarmor.ai-openapi.json, docs.anomalyarmor.ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:8000
  description: Development server
- url: https://api.anomalyarmor.ai
  description: Production server
tags:
- name: Alert Rules
paths:
  /api/v1/alert-rules/:
    post:
      tags:
      - Alert Rules
      summary: Create Alert Rule
      description: Create a new alert rule with destinations.
      operationId: create_alert_rule_api_v1_alert_rules__post
      parameters:
      - name: asset_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Asset UUID for resolving tags/lineage filters (required if using filters)
          title: Asset Id
        description: Asset UUID for resolving tags/lineage filters (required if using filters)
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/app__domains__feature__alerts__api__v1__alert_rules__CreateAlertRuleRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Alert Rules
      summary: List Alert Rules
      description: Get all alert rules for the current company.
      operationId: list_alert_rules_api_v1_alert_rules__get
      parameters:
      - name: active_only
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Active Only
      - name: destination_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Filter by destination ID
          title: Destination Id
        description: Filter by destination ID
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Items per page
          default: 20
          title: Limit
        description: Items per page
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Items to skip
          default: 0
          title: Offset
        description: Items to skip
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/alert-rules/meta/schema-change-types:
    get:
      tags:
      - Alert Rules
      summary: Get Schema Change Types Meta
      description: 'Return the ChangeType enum grouped by category for the rule config UI.


        Derives labels from `to_display_case` and breaking status from

        `ChangeType.is_breaking_change`. This endpoint is the single source of

        truth for the ChangeType vocabulary; the frontend does not maintain a

        hand-written mirror (TECH-963).'
      operationId: get_schema_change_types_meta_api_v1_alert_rules_meta_schema_change_types_get
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/alert-rules/{rule_id}:
    get:
      tags:
      - Alert Rules
      summary: Get Alert Rule
      description: Get alert rule details with destinations.
      operationId: get_alert_rule_api_v1_alert_rules__rule_id__get
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Rule Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Alert Rules
      summary: Update Alert Rule
      description: Update alert rule configuration.
      operationId: update_alert_rule_api_v1_alert_rules__rule_id__put
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Rule Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/app__domains__feature__alerts__api__v1__alert_rules__UpdateAlertRuleRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Alert Rules
      summary: Delete Alert Rule
      description: Delete an alert rule.
      operationId: delete_alert_rule_api_v1_alert_rules__rule_id__delete
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Rule Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/alert-rules/{rule_id}/toggle:
    post:
      tags:
      - Alert Rules
      summary: Toggle Alert Rule
      description: Toggle an alert rule's active status.
      operationId: toggle_alert_rule_api_v1_alert_rules__rule_id__toggle_post
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Rule Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToggleAlertRuleRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/alert-rules/{rule_id}/test:
    post:
      tags:
      - Alert Rules
      summary: Test Alert Rule
      description: Test an alert rule by sending a test notification to all destinations.
      operationId: test_alert_rule_api_v1_alert_rules__rule_id__test_post
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Rule Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/alert-rules/test-all:
    post:
      tags:
      - Alert Rules
      summary: Test All Alert Rules
      description: Test all active alert rules for the current company.
      operationId: test_all_alert_rules_api_v1_alert_rules_test_all_post
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/alert-rules/{rule_id}/destinations:
    post:
      tags:
      - Alert Rules
      summary: Add Destination To Rule
      description: Add a destination to an alert rule.
      operationId: add_destination_to_rule_api_v1_alert_rules__rule_id__destinations_post
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Rule Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddDestinationRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/alert-rules/{rule_id}/destinations/{destination_id}:
    delete:
      tags:
      - Alert Rules
      summary: Remove Destination From Rule
      description: Remove a destination from an alert rule.
      operationId: remove_destination_from_rule_api_v1_alert_rules__rule_id__destinations__destination_id__delete
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Rule Id
      - name: destination_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Destination Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/alert-rules/{rule_id}/refresh:
    post:
      tags:
      - Alert Rules
      summary: Refresh Dynamic Rule
      description: Manually refresh a dynamic alert rule.
      operationId: refresh_dynamic_rule_api_v1_alert_rules__rule_id__refresh_post
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Rule Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/alert-rules/preview:
    post:
      tags:
      - Alert Rules
      summary: Preview Alert Targets
      description: Preview which tables will be monitored by an alert rule.
      operationId: preview_alert_targets_api_v1_alert_rules_preview_post
      parameters:
      - name: asset_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Asset UUID for resolving tags/lineage filters (required if using filters)
          title: Asset Id
        description: Asset UUID for resolving tags/lineage filters (required if using filters)
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewAlertTargetsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
components:
  schemas:
    PreviewAlertTargetsRequest:
      properties:
        asset_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Asset Ids
        tag_filter:
          anyOf:
          - $ref: '#/components/schemas/TagFilter'
          - type: 'null'
        lineage_filter:
          anyOf:
          - $ref: '#/components/schemas/LineageFilter'
          - type: 'null'
      type: object
      title: PreviewAlertTargetsRequest
      description: Request schema for previewing alert rule targets.
    app__domains__feature__alerts__api__v1__alert_rules__CreateAlertRuleRequest:
      properties:
        name:
          type: string
          maxLength: 255
          minLength: 1
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        is_active:
          type: boolean
          title: Is Active
          default: true
        cooldown_minutes:
          type: integer
          maximum: 10080.0
          minimum: 1.0
          title: Cooldown Minutes
          default: 60
        max_alerts_per_day:
          type: integer
          maximum: 1000.0
          minimum: 0.0
          title: Max Alerts Per Day
          default: 50
        event_types:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Event Types
        severities:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Severities
        asset_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Asset Ids
        tag_filter:
          anyOf:
          - $ref: '#/components/schemas/TagFilter'
          - type: 'null'
        lineage_filter:
          anyOf:
          - $ref: '#/components/schemas/LineageFilter'
          - type: 'null'
        grouping:
          anyOf:
          - $ref: '#/components/schemas/GroupingConfig'
          - type: 'null'
        destination_ids:
          items:
            type: string
            format: uuid
          type: array
          minItems: 1
          title: Destination Ids
        is_notify_code_authors:
          type: boolean
          title: Is Notify Code Authors
          default: false
        code_author_min_confidence:
          type: number
          maximum: 1.0
          minimum: 0.0
          title: Code Author Min Confidence
          default: 0.7
        operating_schedule_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Operating Schedule Id
        schema_change_config:
          anyOf:
          - $ref: '#/components/schemas/SchemaChangeConfig'
          - type: 'null'
      type: object
      required:
      - name
      - destination_ids
      title: CreateAlertRuleRequest
      description: Request schema for creating an alert rule.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    app__domains__feature__alerts__api__v1__alert_rules__UpdateAlertRuleRequest:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 255
            minLength: 1
          - type: 'null'
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        is_active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Active
        cooldown_minutes:
          anyOf:
          - type: integer
            maximum: 10080.0
            minimum: 1.0
          - type: 'null'
          title: Cooldown Minutes
        max_alerts_per_day:
          anyOf:
          - type: integer
            maximum: 1000.0
            minimum: 0.0
          - type: 'null'
          title: Max Alerts Per Day
        event_types:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Event Types
        severities:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Severities
        asset_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Asset Ids
        grouping:
          anyOf:
          - $ref: '#/components/schemas/GroupingConfig'
          - type: 'null'
        is_notify_code_authors:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Notify Code Authors
        code_author_min_confidence:
          anyOf:
          - type: number
            maximum: 1.0
            minimum: 0.0
          - type: 'null'
          title: Code Author Min Confidence
        operating_schedule_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Operating Schedule Id
        schema_change_config:
          anyOf:
          - $ref: '#/components/schemas/SchemaChangeConfig'
          - type: 'null'
      type: object
      title: UpdateAlertRuleRequest
      description: Request schema for updating an alert rule.
    SchemaChangeConfig:
      properties:
        trigger_on:
          type: string
          enum:
          - any
          - breaking
          - non_breaking
          - specific_types
          title: Trigger On
        change_types:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Change Types
      additionalProperties: false
      type: object
      required:
      - trigger_on
      title: SchemaChangeConfig
      description: "Per-rule trigger configuration for schema_change event-type rules.\n\nScopes which kinds of detected schema change should fire the rule.\nNormalization rules enforced by validators:\n\n- `trigger_on=\"any\"` with no `change_types` is the default-equivalent state.\n  Callers should normally send `null` for that case; the API accepts either.\n- `trigger_on=\"specific_types\"` requires a non-empty `change_types` list\n  whose values all appear in the backend `ChangeType` enum.\n- Any other value of `trigger_on` must not carry `change_types`.\n\nThe evaluation service reads this alongside the schema alert service's\n`change_types_present` context projection (TECH-963)."
    LineageFilter:
      properties:
        upstream_of:
          anyOf:
          - type: string
          - type: 'null'
          title: Upstream Of
          description: Unique ID or table path to find upstream nodes of
        downstream_of:
          anyOf:
          - type: string
          - type: 'null'
          title: Downstream Of
          description: Unique ID or table path to find downstream nodes of
        max_hops:
          anyOf:
          - type: integer
            maximum: 10.0
            minimum: 1.0
          - type: 'null'
          title: Max Hops
          description: Maximum hops to traverse (1-10, null=unlimited)
      type: object
      title: LineageFilter
      description: "Filter for selecting tables by lineage relationships.\n\nExample:\n    {\n        \"upstream_of\": \"dbt://models/gold/customer_summary\",\n        \"downstream_of\": null,\n        \"max_hops\": 5\n    }"
    StandardResponse:
      properties:
        success:
          type: boolean
          title: Success
        data:
          anyOf:
          - {}
          - type: 'null'
          title: Data
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      required:
      - success
      title: StandardResponse
      description: Standard API response wrapper.
    GroupingConfig:
      properties:
        enabled:
          type: boolean
          title: Enabled
          description: Whether to enable alert grouping for this rule
          default: false
        window_minutes:
          type: integer
          maximum: 1440.0
          minimum: 5.0
          title: Window Minutes
          description: Time window for collecting alerts to group (5-1440 minutes)
          default: 60
        min_alerts_to_group:
          type: integer
          maximum: 100.0
          minimum: 2.0
          title: Min Alerts To Group
          description: Minimum alerts before grouping kicks in (2-100)
          default: 2
      type: object
      title: GroupingConfig
      description: "Configuration for alert grouping/digest behavior.\n\nWhen enabled, alerts are grouped into digest notifications to prevent alert fatigue.\nThe first alert always sends immediately; subsequent alerts within the window are grouped.\n\nExample:\n    {\n        \"enabled\": true,\n        \"window_minutes\": 60,\n        \"min_alerts_to_group\": 2\n    }"
    TagFilter:
      properties:
        tag_names:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tag Names
          description: List of tag names to match
        tag_categories:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tag Categories
          description: List of tag categories to match
        match_mode:
          type: string
          enum:
          - any
          - all
          title: Match Mode
          description: '''any'' for OR logic, ''all'' for AND logic'
          default: any
      type: object
      title: TagFilter
      description: "Filter for selecting tables by tags.\n\nExample:\n    {\n        \"tag_names\": [\"revenue\", \"orders\"],\n        \"tag_categories\": [\"business\"],\n        \"match_mode\": \"any\"\n    }"
    ToggleAlertRuleRequest:
      properties:
        is_active:
          type: boolean
          title: Is Active
      type: object
      required:
      - is_active
      title: ToggleAlertRuleRequest
      description: Request schema for toggling an alert rule.
    AddDestinationRequest:
      properties:
        destination_id:
          type: string
          format: uuid
          title: Destination Id
      type: object
      required:
      - destination_id
      title: AddDestinationRequest
      description: Request schema for adding a destination to a rule.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
x-refined-from:
- anomalyarmor.ai-openapi.json
- app.anomalyarmor.ai-openapi.json
- docs.anomalyarmor.ai-openapi.json