DMARC Examiner Domains API

openapi: 3.2.0
info:
  title: Dmarc Examiner Com Domains API
  version: 1.0.0
  contact:
    email: support@dmarc-examiner.com
    url: https://dmarc-examiner.com
  license:
    name: Proprietary
  description: 'Operations tagged Domains 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: Domains
  description: Manage monitored domains
paths:
  /api/v1/domains:
    get:
      operationId: listDomains
      summary: List domains
      description: Returns all monitored domains for the organization.
      tags:
      - Domains
      responses:
        '200':
          description: List of domains
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Domain'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createDomain
      summary: Create a domain
      description: 'Adds a new domain to the organization. The response includes the

        `reporting_email` and `dmarc_record` strings — copy them into your DNS

        to start receiving DMARC reports.


        Returns `400` if the request body is malformed or `name` is missing,

        `409 Conflict` if the domain already exists in the organization, and

        `402 Payment Required` if the organization has hit its plan domain limit.'
      tags:
      - Domains
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDomainRequest'
      responses:
        '201':
          description: Domain created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainDetail'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PlanLimitExceeded'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://api.dmarc-examiner.com
      description: Production
  /api/v1/domains/{id}:
    get:
      operationId: getDomain
      summary: Get a domain
      tags:
      - Domains
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Domain detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    delete:
      operationId: deleteDomain
      summary: Delete a domain
      description: Removes the domain and its associated reports from the organization.
      tags:
      - Domains
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Domain deleted
        '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
  /api/v1/domains/{id}/verify:
    post:
      operationId: verifyDomain
      summary: Re-check domain verification
      description: 'Re-queries DNS for the DMARC record at `_dmarc.{domain}` and confirms it

        contains the organization''s reporting email. Updates the domain status

        to `verified` if found.


        Returns `422 Unprocessable Entity` with the reason if verification fails.'
      tags:
      - Domains
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Verification successful
          content:
            application/json:
              schema:
                type: object
                required:
                - verified
                - domain
                properties:
                  verified:
                    type: boolean
                    example: true
                  domain:
                    $ref: '#/components/schemas/DomainDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: Verification failed
          content:
            application/json:
              schema:
                type: object
                required:
                - verified
                - message
                properties:
                  verified:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: No DMARC record found at _dmarc.example.com
        '429':
          $ref: '#/components/responses/RateLimited'
    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
    Conflict:
      description: Resource already exists.
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              message:
                type: string
                example: Domain already exists in this organization
    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
    PlanLimitExceeded:
      description: 'The organization has exhausted a quota on its current plan (e.g. number of domains,

        number of users). Conceptually distinct from `FeatureNotAvailable` (HTTP 403): the feature

        IS included in the plan, but the per-organization limit has been reached. Upgrade the plan

        or remove existing resources before retrying.

        '
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            - message
            - limit_type
            - current_plan
            properties:
              error:
                type: string
                enum:
                - plan_limit_exceeded
              message:
                type: string
                example: 'Plan limit exceeded for domains. Current plan: Pro. Please upgrade.'
              limit_type:
                type: string
                description: Which quota was hit.
                enum:
                - domains
                - users
              current_plan:
                type: string
                example: pro
    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:
    CreateDomainRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Domain name. Stored lowercased.
          example: example.com
    Domain:
      type: object
      required:
      - id
      - name
      - status
      - created_at
      - updated_at
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: example.com
        status:
          type: string
          enum:
          - verified
          - pending
          - failed
        verified_at:
          type:
          - string
          - 'null'
          format: date-time
        last_report_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    DomainDetail:
      allOf:
      - $ref: '#/components/schemas/Domain'
      - type: object
        required:
        - reporting_email
        - dmarc_host
        - dmarc_record
        properties:
          reporting_email:
            type: string
            format: email
            description: Address to set in the `rua=` tag of your DNS DMARC record so reports are delivered to this organization.
            example: org-abc123@reports.dmarc-examiner.com
          dmarc_host:
            type: string
            description: DNS host where the DMARC record must be published.
            example: _dmarc.example.com
          dmarc_record:
            type: string
            description: 'DMARC record string ready to copy into your DNS as a TXT record.

              Includes a `ruf=` tag only if the current plan supports forensic reports.

              '
            example: v=DMARC1; p=none; rua=mailto:org-abc123@reports.dmarc-examiner.com
  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