DMARC Examiner Alerts API

openapi: 3.2.0
info:
  title: Dmarc Examiner Com Alerts API
  version: 1.0.0
  contact:
    email: support@dmarc-examiner.com
    url: https://dmarc-examiner.com
  license:
    name: Proprietary
  description: 'Operations tagged Alerts across 2 of this provider''s published API definitions: dmarc-examiner-com-openapi.yaml, openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.dmarc-examiner.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Alerts
  description: View and manage security alerts
paths:
  /api/v1/alerts:
    get:
      operationId: listAlerts
      summary: List alerts
      description: Returns security alerts with optional filtering and pagination.
      tags:
      - Alerts
      parameters:
      - name: severity
        in: query
        description: Filter by severity level.
        required: false
        schema:
          type: string
          enum:
          - info
          - warning
          - critical
      - name: status
        in: query
        description: Filter by alert status.
        required: false
        schema:
          type: string
          enum:
          - pending
          - sent
          - dismissed
      - name: page
        in: query
        description: Page number (minimum 1).
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
      - name: limit
        in: query
        description: Results per page (1–100).
        required: false
        schema:
          type: integer
          default: 20
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: Paginated list of alerts
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                - pagination
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Alert'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://api.dmarc-examiner.com
      description: Production
  /api/v1/alerts/{id}/dismiss:
    put:
      operationId: dismissAlert
      summary: Dismiss an alert
      description: 'Marks an alert as dismissed. There is no endpoint to reopen a dismissed alert.


        This endpoint is **idempotent**: calling it on an already-dismissed alert returns

        the same `200` response without side effects.'
      tags:
      - Alerts
      parameters:
      - name: id
        in: path
        required: true
        description: Alert UUID.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Alert dismissed
          content:
            application/json:
              schema:
                type: object
                required:
                - id
                - status
                - message
                properties:
                  id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    example: dismissed
                  message:
                    type: string
                    example: Alert dismissed
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://api.dmarc-examiner.com
      description: Production
components:
  responses:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              message:
                type: string
                example: Report not found
    Unauthorized:
      description: 'Authentication failed. Two shapes are possible depending on cause:

        - **Invalid or revoked key** — body is `{"message": "..."}` only.

        - **Missing `X-API-Key` header** — body adds an `error: "unauthorized"` machine-readable code.

        Clients should treat both as the same outcome and read `message` for display.

        '
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              error:
                type: string
                description: Present only when the request had no `X-API-Key` header at all.
                enum:
                - unauthorized
              message:
                type: string
                example: Invalid API key
    RateLimited:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              message:
                type: string
                example: Rate limit exceeded. Maximum 100 requests per minute.
    FeatureNotAvailable:
      description: 'The organization''s current plan does not include the feature required by this endpoint

        (e.g. `apiAccess`, `forensicReports`, `advancedAlerts`). Distinct from `PlanLimitExceeded`

        (HTTP 402), which signals a *quota* exhausted on a feature the plan does include.


        If a customer downgrades to Free, all `/api/v1/*` requests will start returning this response.

        '
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            - message
            - feature
            - current_plan
            properties:
              error:
                type: string
                enum:
                - feature_not_available
              message:
                type: string
                example: 'Feature "apiAccess" is not available in your current plan: Free. Please upgrade.'
              feature:
                type: string
                example: apiAccess
              current_plan:
                type: string
                example: free
    BadRequest:
      description: "Request payload, body field, or query parameter is missing, malformed,\noutside documented bounds, or fails type/enum validation.\n\nTwo body shapes can occur:\n- **Body validation errors** (e.g. missing `name`, wrong type) come from\n  the controller and have the form `{\"message\": \"...\"}`.\n- **Query parameter errors** (e.g. `limit` out of range, `auth_failure`\n  off-enum, `domain_id` not a UUID) flow through the API exception\n  subscriber and add an `error: \"bad_request\"` machine-readable code:\n  `{\"error\": \"bad_request\", \"message\": \"Query parameter \\\"limit\\\" must be between 1 and 100, got 999\"}`.\n"
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              error:
                type: string
                description: Present on query-parameter validation errors. Absent on body validation errors.
                enum:
                - bad_request
              message:
                type: string
                example: Domain name is required
    ServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              message:
                type: string
  schemas:
    Pagination:
      type: object
      required:
      - total
      - page
      - limit
      - total_pages
      properties:
        total:
          type: integer
          description: Total number of results.
        page:
          type: integer
          description: Current page number.
        limit:
          type: integer
          description: Results per page.
        total_pages:
          type: integer
          description: Total number of pages.
    Alert:
      type: object
      required:
      - id
      - type
      - severity
      - title
      - description
      - status
      - created_at
      properties:
        id:
          type: string
          format: uuid
        domain_id:
          type:
          - string
          - 'null'
          format: uuid
          description: Domain the alert belongs to. Null for organization-level alerts.
        domain_name:
          type:
          - string
          - 'null'
          example: example.com
        type:
          type: string
          enum:
          - dmarc_fail
          - new_sender
          - volume_spike
          - dns_change
          - compliance_drop
          description: '- `dmarc_fail`: DMARC authentication failures

            - `new_sender`: New mail sender detected

            - `volume_spike`: Unusual increase in email volume

            - `dns_change`: DNS record changes detected

            - `compliance_drop`: Compliance dropped below threshold

            '
        severity:
          type: string
          enum:
          - info
          - warning
          - critical
        title:
          type: string
          example: High DMARC failure rate
        description:
          type: string
        metadata:
          type:
          - object
          - 'null'
          description: Additional context data (varies by alert type).
          additionalProperties: true
        status:
          type: string
          enum:
          - pending
          - sent
          - dismissed
          description: '- `pending`: Alert created, not yet sent

            - `sent`: Notification sent to user

            - `dismissed`: Dismissed by user

            '
        created_at:
          type: string
          format: date-time
        sent_at:
          type:
          - string
          - 'null'
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key in format `dex_` followed by 32 hex characters. Create keys in Settings > API Keys.
x-refined-from:
- dmarc-examiner-com-openapi.yaml
- openapi.yaml