API Reference · DNS

Get DNS Records

Every DNS record to add, with live status

GET/v1/applications/{application_id}/dns

Paid plan requiredMCP:get_dns_records

cURL example

cURL request

curl "https://api.verifiedinbox.ai/v1/applications/0192a5e0-1234-7000-8000-000000000001/dns" \
  -H "Authorization: Bearer vi_live_YOUR_API_KEY"

Parameters

Parameter	Type	Description
application_idpathrequired	string (uuid)	Application id.
VI-Environmentheader	string	`live` (default) or `test`. Used for anonymous callers and OAuth access tokens; API keys and web sessions carry their own environment.

Response

200 OKRecords.

application/json

Field	Type	Description
all_required_okrequired	boolean	—
checked_atrequired	string (date-time)	—
dns_hostrequired	string \| null	e.g. Cloudflare, GoDaddy.
nameserversrequired	string[]	—
recordsrequired	DnsRecord[]	— Nested fields (14) `current` (string[]): What's published right now. `from_step` (string): Set up in an earlier wizard step (shown as done there); null for records added in the DNS step. `glossary` (string) `host` (string) `host_relative` (string): Host relative to the zone (`@` for the apex). `id` (string) `note` (string) `purpose` (string) `required` (boolean) `rollout` (DmarcRollout) `rollout_stage` (string) `status` (string) `type` (string) `value` (string): Value to publish.
resolverrequired	string	— Allowed: `authoritative`
zonerequired	string	—

Example 200 response (DnsRecords)

{
  "all_required_ok": true,
  "checked_at": "2026-10-31T12:00:00Z",
  "dns_host": "string",
  "nameservers": [
    "string"
  ],
  "records": [
    {
      "current": [],
      "from_step": "domain",
      "glossary": "string",
      "host": "string",
      "host_relative": "string",
      "id": "ownership",
      "note": "string",
      "purpose": "string",
      "required": true,
      "rollout": {
        "direct_record": {
          "host": {},
          "note": {},
          "type": {},
          "value": {}
        },
        "email_usage": "none",
        "enforced": true,
        "next_stage": "missing",
        "path": "direct",
        "plan": [],
        "ready_to_advance": true,
        "reason": "Updated company logo",
        "recommended_record": {
          "host": {},
          "note": {},
          "type": {},
          "value": {}
        },
        "removed_tags": [],
        "stage": "missing"
      },
      "rollout_stage": "missing",
      "status": "ok",
      "type": "string",
      "value": "string"
    }
  ],
  "resolver": "authoritative",
  "zone": "acme.com"
}

Other responses & possible errors

Expand a status code below to see the error code, description, and example error payload.

400 (invalid_request)`invalid_request` — the request is malformed.

`invalid_request` — the request is malformed.

Example 400 error response

{
  "error": {
    "code": "invalid_request",
    "message": "Please provide a valid domain name."
  }
}

401 (unauthenticated)`unauthenticated` — sign in / send a valid credential. `next_action.kind = sign_in`.

`unauthenticated` — sign in / send a valid credential. `next_action.kind = sign_in`.

Example 401 error response

{
  "error": {
    "code": "unauthenticated",
    "message": "Sign in or provide an API key to continue.",
    "next_action": {
      "kind": "sign_in",
      "title": "Sign in or create an account",
      "url": "/login"
    }
  }
}

402 (payment_required)`payment_required` — this step needs a paid plan. `next_action.kind = checkout`.

`payment_required` — this step needs a paid plan. `next_action.kind = checkout`.

Example 402 error response

{
  "error": {
    "code": "payment_required",
    "message": "This step requires an active paid plan for this domain.",
    "next_action": {
      "kind": "checkout",
      "title": "Continue to checkout"
    }
  }
}

404 (not_found)`not_found` — doesn't exist or isn't accessible to you (never 403).

`not_found` — doesn't exist or isn't accessible to you (never 403).

Example 404 error response

{
  "error": {
    "code": "not_found",
    "message": "We couldn't find that resource."
  }
}

429 (rate_limited)`rate_limited` — retry after `Retry-After` seconds (`details.retry_after_seconds`). `limit_reached` — a quota is used up; `details.limit` names it and `next_action` offers support.

`rate_limited` — retry after `Retry-After` seconds (`details.retry_after_seconds`). `limit_reached` — a quota is used up; `details.limit` names it and `next_action` offers support.

Example 429 error response

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please wait a moment and try again."
  }
}

Was it helpful?