AnomalyArmor Alert Rules Bulk API

openapi: 3.2.0
info:
  title: Anomalyarmor Ai Alert Rules Bulk API
  version: 1.0.0
  contact:
    name: AnomalyArmor Support
    url: https://anomalyarmor.ai/support
  license:
    name: Proprietary
  description: 'Operations tagged alert-rules-bulk 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-bulk
paths:
  /api/v1/alert-rules/bulk/preview:
    post:
      tags:
      - alert-rules-bulk
      summary: Bulk Preview
      description: 'Preview which tables will be affected by a bulk rule generation.


        Shows matching tables and identifies those that already have rules.'
      operationId: bulk_preview_api_v1_alert_rules_bulk_preview_post
      parameters:
      - name: asset_id
        in: query
        required: true
        schema:
          type: string
          description: Asset UUID to search within
          title: Asset Id
        description: Asset UUID to search within
      - name: event_types
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Event types to check for existing rules (comma-separated)
          title: Event Types
        description: Event types to check for existing rules (comma-separated)
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkPreviewRequest'
      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/bulk/generate:
    post:
      tags:
      - alert-rules-bulk
      summary: Bulk Generate
      description: 'Generate multiple alert rules from a filter and template.


        Creates one rule per matching table. Transaction ensures all-or-nothing.'
      operationId: bulk_generate_api_v1_alert_rules_bulk_generate_post
      parameters:
      - name: asset_id
        in: query
        required: true
        schema:
          type: string
          description: Asset UUID to create rules within
          title: Asset Id
        description: Asset UUID to create rules within
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkGenerateRequest'
      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/bulk/:
    patch:
      tags:
      - alert-rules-bulk
      summary: Bulk Update
      description: 'Update multiple alert rules at once.


        Allowed updates: is_active, cooldown_minutes, max_alerts_per_day


        Transaction guarantee: All-or-nothing. If any rule fails validation

        (not found, not authorized), the entire operation is rolled back.'
      operationId: bulk_update_api_v1_alert_rules_bulk__patch
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateRequest'
      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-bulk
      summary: Bulk Delete
      description: 'Delete multiple alert rules at once.


        Transaction guarantee: All-or-nothing. If any rule fails validation

        (not found, not authorized), the entire operation is rolled back.'
      operationId: bulk_delete_api_v1_alert_rules_bulk__delete
      parameters:
      - 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_bulk__BulkDeleteRequest'
      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/bulk/enable:
    post:
      tags:
      - alert-rules-bulk
      summary: Bulk Enable
      description: Enable multiple alert rules at once.
      operationId: bulk_enable_api_v1_alert_rules_bulk_enable_post
      parameters:
      - name: rule_ids
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
            format: uuid
          description: Rule IDs to enable
          title: Rule Ids
        description: Rule IDs to enable
      - 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/bulk/disable:
    post:
      tags:
      - alert-rules-bulk
      summary: Bulk Disable
      description: Disable multiple alert rules at once.
      operationId: bulk_disable_api_v1_alert_rules_bulk_disable_post
      parameters:
      - name: rule_ids
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
            format: uuid
          description: Rule IDs to disable
          title: Rule Ids
        description: Rule IDs to disable
      - 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
components:
  schemas:
    SchemaFilter:
      properties:
        schema_pattern:
          type: string
          maxLength: 255
          minLength: 1
          title: Schema Pattern
          description: 'Schema name pattern (SQL LIKE syntax: % for any, _ for single char)'
      type: object
      required:
      - schema_pattern
      title: SchemaFilter
      description: "Filter for selecting tables by schema name pattern.\n\nUses SQL LIKE syntax (% for any chars, _ for single char).\n\nExample:\n    {\n        \"schema_pattern\": \"analytics%\"\n    }"
    app__domains__feature__alerts__api__v1__alert_rules_bulk__BulkDeleteRequest:
      properties:
        rule_ids:
          items:
            type: string
            format: uuid
          type: array
          maxItems: 500
          minItems: 1
          title: Rule Ids
      type: object
      required:
      - rule_ids
      title: BulkDeleteRequest
      description: Request to delete multiple rules.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    BulkPreviewRequest:
      properties:
        filter:
          $ref: '#/components/schemas/BulkFilter'
      type: object
      required:
      - filter
      title: BulkPreviewRequest
      description: Request to preview bulk rule generation.
    RuleTemplate:
      properties:
        name_pattern:
          type: string
          maxLength: 255
          minLength: 1
          title: Name Pattern
          description: 'Name pattern with variables: {schema}, {table}, {full_name}'
        description:
          anyOf:
          - type: string
            maxLength: 1000
          - type: 'null'
          title: Description
          description: Optional description pattern with variables
        event_types:
          items:
            type: string
          type: array
          minItems: 1
          title: Event Types
          description: Event types to monitor
        severities:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Severities
          description: Severity levels to match (null = all)
        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
        destination_ids:
          items:
            type: string
            format: uuid
          type: array
          minItems: 1
          title: Destination Ids
      type: object
      required:
      - name_pattern
      - event_types
      - destination_ids
      title: RuleTemplate
      description: 'Template for generating alert rules.


        Supports variable substitution using {schema}, {table}, {full_name}.'
    BulkUpdateRequest:
      properties:
        rule_ids:
          items:
            type: string
            format: uuid
          type: array
          maxItems: 500
          minItems: 1
          title: Rule Ids
        updates:
          additionalProperties: true
          type: object
          title: Updates
          description: 'Fields to update: is_active, cooldown_minutes, max_alerts_per_day'
      type: object
      required:
      - rule_ids
      - updates
      title: BulkUpdateRequest
      description: Request to update multiple rules.
    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.
    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    }"
    BulkFilter:
      properties:
        schema_filter:
          anyOf:
          - $ref: '#/components/schemas/SchemaFilter'
          - type: 'null'
          description: Filter by schema name pattern
        table_pattern_filter:
          anyOf:
          - $ref: '#/components/schemas/TablePatternFilter'
          - type: 'null'
          description: Filter by table name pattern
        tag_filter:
          anyOf:
          - $ref: '#/components/schemas/TagFilter'
          - type: 'null'
          description: Filter by tags
        lineage_filter:
          anyOf:
          - $ref: '#/components/schemas/LineageFilter'
          - type: 'null'
          description: Filter by lineage relationships
      type: object
      title: BulkFilter
      description: 'Combined filter for bulk table selection.


        At least one filter must be specified. Multiple filters are combined with OR.'
    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    }"
    BulkGenerateRequest:
      properties:
        filter:
          $ref: '#/components/schemas/BulkFilter'
        rule_template:
          $ref: '#/components/schemas/RuleTemplate'
        skip_existing:
          type: boolean
          title: Skip Existing
          description: Skip tables that already have rules with same event_types
          default: true
        is_dynamic:
          type: boolean
          title: Is Dynamic
          description: When true, rules will automatically include new tables matching the filter
          default: false
      type: object
      required:
      - filter
      - rule_template
      title: BulkGenerateRequest
      description: Request to generate bulk alert rules.
    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
    TablePatternFilter:
      properties:
        table_pattern:
          type: string
          maxLength: 255
          minLength: 1
          title: Table Pattern
          description: Table name pattern (SQL LIKE syntax, must include wildcard)
        schema_pattern:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Schema Pattern
          description: Optional schema pattern to restrict search
      type: object
      required:
      - table_pattern
      title: TablePatternFilter
      description: "Filter for selecting tables by table name pattern.\n\nUses SQL LIKE syntax (% for any chars, _ for single char).\nMust include at least one wildcard character.\n\nExample:\n    {\n        \"table_pattern\": \"%_fact\",\n        \"schema_pattern\": \"analytics\"  # Optional: restrict to specific schema\n    }"
x-refined-from:
- anomalyarmor.ai-openapi.json
- app.anomalyarmor.ai-openapi.json
- docs.anomalyarmor.ai-openapi.json