Documentation / API Domains and DNS / DNS Error Handling

DNS Error Handling

How API clients should respond to empty zones, missing records, stale caches, and propagation delays.

How API clients should respond to empty zones, missing records, stale caches, and propagation delays.

Coverage

ItemStatus
401/403 auth failuresUse deployed route documentation
Empty recordsUse deployed route documentation
Domain ownership visibilityUse deployed route documentation
External propagation delayUse deployed route documentation

Workflow

  1. Confirm each route against the deployed route documentation.
  2. Test with a staging token first.
  3. Use read endpoints to inspect current state before any write operation.
  4. Record the external workflow ID in your own system.
  5. Review jobs, request logs, and audit logs after the workflow runs.

Notes

  • Do not create production automation around undocumented routes.
  • Use idempotency keys for write endpoints.
  • Keep rollback steps documented with the integration runbook.

Diagram

flowchart TD
    A[External System] --> B[Read Current State]
    B --> C{Expected State?}
    C -- No --> D[Stop and Alert]
    C -- Yes --> E[Run Approved Workflow]
    E --> F[Read Jobs and Logs]
    F --> G[Operator Review]
← DNS Automation Workflow