DNS Doctor Domains API

openapi: 3.2.0
info:
  title: Dnsdoctor Dev Domains API
  version: '1'
  contact:
    name: DNS Doctor
    email: hello@dnsdoctor.dev
  x-guidance: 'DNS Doctor scans, fixes and verifies a domain''s DNS (SPF, DMARC, DKIM, propagation, MX, DNS health, blacklists, domain/SSL expiry) and returns deterministic verdicts plus copy-paste fix records from a validating engine — never a guessed record. Scan with POST /scan or GET /report/{domain}; read verdicts failing-first (''temperror'' is transient, not a failure; a report with not_registered: true means the domain does not resolve, so propose nothing for it). Present any returned record VERBATIM and never compose one yourself; SPF is diagnose-only. A human approves every DNS change — nothing is applied automatically. Anonymous calls are free up to a per-caller limit; past it the API answers 402 (x402, USDC on Base, $0.01 per call). POST /bulk-scan is paid on every call at $0.005 per domain; POST /bulk-registration (RDAP) at $0.002 per domain; POST /bulk-propagation at $0.008 per check; POST /bulk-dmarc-reports parses DMARC aggregate reports at $0.005 per report; POST /watch/record watches one DNS record for up to 24 hours at $0.10; POST /watch/lookalikes watches a domain''s lookalike names hourly for one fixed 24-hour day at $0.50. The five token-gated reads (GET /domains, /alerts, /readiness, /lookalikes and /email-tests) need a DNS Doctor API token the account owner mints at /dashboard/settings — never ask a user to paste one.'
  description: 'Operations tagged domains across 2 of this provider''s published API definitions: dnsdoctor-dev-openapi.json, dnsdoctor-dev-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dnsdoctor.dev/api/v1
tags:
- name: Domains
paths:
  /domains:
    get:
      tags:
      - Domains
      summary: Domains
      description: 'List the token''s account''s verified monitored domains + latest statuses.


        Token required (401 without one). Each domain carries the latest

        `scan_history` snapshot''s per-check statuses + `scanned_at` — never a letter

        grade (re-validation #8). A verified domain with no snapshot yet returns

        `scanned_at: null` and empty `checks`.'
      operationId: domains_domains_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainsOut'
      security:
      - apiKey: []
    post:
      tags:
      - Domains
      summary: Add Domain Route
      description: 'Add a domain to the token''s account and return the record to publish.


        201 whether the row was created or already existed (`created` says which):

        an agent re-reading a domain it added last week needs the row, not a

        conflict to interpret. The wizard''s 409-resume stays on the session route,

        where a human is the one resuming.'
      operationId: add_domain_route_domains_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainIn'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Add Domain Route Domains Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security: []
    servers:
    - url: https://dnsdoctor.dev/api/v1
  /domains/verify:
    post:
      tags:
      - Domains
      summary: Verify Domain Route
      description: 'Check the ownership TXT record, and mark verified on a match.


        200 for every outcome, including the failures: the poll is caller-driven, so

        "not published yet" is a normal answer, not an error. `outcome` says WHICH —

        and a `transient` outcome is our lookup, never a verdict about their DNS.'
      operationId: verify_domain_route_domains_verify_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Verify Domain Route Domains Verify Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security: []
    servers:
    - url: https://dnsdoctor.dev/api/v1
  /domains/records:
    get:
      tags:
      - Domains
      summary: Domain Records Route
      description: The records an owned domain still needs, and whether ours is published yet.
      operationId: domain_records_route_domains_records_get
      parameters:
      - name: domain
        in: query
        required: true
        schema:
          type: string
          title: Domain
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Domain Records Route Domains Records Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security: []
    servers:
    - url: https://dnsdoctor.dev/api/v1
  /domains/mine:
    get:
      tags:
      - Domains
      summary: My Domains Route
      description: 'Every domain on the account with its state and next step (`monitoring:read`).


        Unlike `GET /v1/domains` (verified rows + check statuses), this lists pending

        and lapsed rows too — the onboarding question is "what is left to do".'
      operationId: my_domains_route_domains_mine_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response My Domains Route Domains Mine Get
      security:
      - apiKey: []
    servers:
    - url: https://dnsdoctor.dev/api/v1
  /change-watch:
    post:
      tags:
      - Domains
      summary: Change Watch Route
      description: '`watch_record_change`''s twin (D183): read the record, start the watch on a wait/edit.


        The same core, so the same one email to the token''s account. A lookup fault is

        the check-record route''s 503, never a started watch.'
      operationId: change_watch_route_change_watch_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckRecordRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Change Watch Route Change Watch Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - apiKey: []
    servers:
    - url: https://dnsdoctor.dev/api/v1
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DomainCheck:
      properties:
        check:
          type: string
          title: Check
        status:
          type: string
          title: Status
      type: object
      required:
      - check
      - status
      title: DomainCheck
      description: 'One check of a domain''s latest snapshot — name + status only.


        Deliberately NO letter grade: the A-F grade is `frontend/lib/grade.ts`, a

        versioned frontend contract. Recomputing it server-side would duplicate the

        rubric and drift; the API returns the raw per-check statuses instead.'
    CheckRecordRequest:
      properties:
        domain:
          type: string
          title: Domain
        kind:
          type: string
          title: Kind
        host:
          anyOf:
          - type: string
          - type: 'null'
          title: Host
        expected_value:
          anyOf:
          - type: string
            maxLength: 1024
          - type: 'null'
          title: Expected Value
      type: object
      required:
      - domain
      - kind
      title: CheckRecordRequest
      description: 'One live record read. `kind` is the sugar; `host` only where it applies.


        Validation itself is `scanner/liveread.py::resolve_query`''s — this model

        carries only the wire shape, so the two consumers cannot drift on which

        `host`/`kind` combinations are legal (the route and the MCP core both raise

        from the same function, with the same authored detail strings).'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    DomainIn:
      properties:
        domain:
          type: string
          maxLength: 253
          title: Domain
      type: object
      required:
      - domain
      title: DomainIn
      description: '`POST /v1/domains` — a bare domain, the same shape as `ScanIn`.'
    DomainOut:
      properties:
        domain:
          type: string
          title: Domain
        scanned_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Scanned At
        checks:
          items:
            $ref: '#/components/schemas/DomainCheck'
          type: array
          title: Checks
      type: object
      required:
      - domain
      - scanned_at
      - checks
      title: DomainOut
      description: 'A monitored domain with its latest scan snapshot''s per-check statuses.


        `scanned_at` is null (and `checks` empty) when the domain is verified but has

        no snapshot yet — awaiting its first monitored scan, not an error.'
    DomainsOut:
      properties:
        domains:
          items:
            $ref: '#/components/schemas/DomainOut'
          type: array
          title: Domains
      type: object
      required:
      - domains
      title: DomainsOut
      description: 'The `GET /v1/domains` response: the account''s verified monitored domains.'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'A DNS Doctor API token: `Authorization: Bearer dnsd_…`.'
x-refined-from:
- dnsdoctor-dev-openapi.json
- dnsdoctor-dev-openapi.json
x-discovery:
  ownershipProofs:
  - '0xeb49cc7d9ac04add7ee0fbe51bc806b684ebdb6bfcdc8c2d7aa7eebc02032b93403764b0986d036ed68ad7e5914edc5403209f19806f4a87e15b1a5bdb73e9ab1b'