# IPv6 readiness API

Check that your website, mail servers and nameservers work over IPv6.

`GET /v1/ipv6`

- Price: Costs 1 credit per call; cached answers cost the same. Calls that fail upstream (502) are free.
- Cache: Answers are cached for up to 15 minutes; send fresh=true to ask the source again.
- MCP tool: `check_ipv6`

IPv6 readiness of a domain's website, mail servers and nameservers: AAAA records and, when our IPv6 connection is up, probes over IPv4 and IPv6. Costs 1 credit per call; cached answers cost the same. Calls that fail upstream (502) are free. Answers are cached for up to 15 minutes; send fresh=true to ask the source again. A retry with the same `X-Request-Id` returns the stored result of the first call for 24 hours without charging again, marked with the `X-Replayed: true` header.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `domain` | string | yes | A domain; its website, mail servers and nameservers are checked. |
| `fresh` | boolean | no | Skip the cache and ask the source again; costs the same. |

## Response

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `tool` | string | yes |  |
| `target` | string | yes |  |
| `status` | "ok" | "partial" | "error" | yes |  |
| `fetched_at` | string | no |  |
| `cached` | boolean | no |  |
| `credits_used` | integer | no | Credits this call took from your balance. 0 for free tools, for a replay of an earlier call, and for a free check run on the website without signing in |
| `summary` | string | yes |  |
| `score` | integer or null | no |  |
| `findings` | array of object | no |  |
| `credits_remaining` | integer | yes | Your balance after this call. It can be below zero after a refund; free tools still work then |
| `data` | object | yes | This tool's result |
| `data.domain` | string | yes |  |
| `data.readiness` | "full" | "partial" | "none" | yes |  |
| `data.grade_basis` | "probes" | "dns" | yes |  |
| `data.probes` | "checked" | "not_checked" | yes |  |
| `data.hosts` | array of object | yes |  |
| `data.hosts.name` | string | yes |  |
| `data.hosts.role` | "web" | "www" | "mx" | "ns" | yes |  |
| `data.hosts.ipv4` | array of string | yes |  |
| `data.hosts.ipv6` | array of string | yes |  |
| `data.hosts.ipv6_kinds` | object | yes |  |
| `data.hosts.probe` | object or null | yes |  |
| `data.hosts.ns_probes` | array of object | yes |  |

## Errors

- `400` Invalid domain, URL or parameter, a TLD this tool can't check, or an X-Request-Id already used for another call (`invalid_domain`, `invalid_url`, `invalid_request`, `unsupported_tld`)
- `401` Missing, unknown or revoked API key, or one whose creator is no longer a member of the account (`unauthorized`)
- `402` Balance below the call's price (`insufficient_credits`)
- `403` Account suspended, the key's creator is over the plan's seats, or an anonymous check without a valid proof-of-work or for a tool that needs an account, or bulk checks before a first purchase (`account_suspended`, `plan_limit`, `challenge_required`, `sign_in_required`, `bulk_locked`)
- `429` Too many requests, today's free checks are used up, or too many website scans at once; wait for the number of seconds in the Retry-After header (`rate_limited`, `free_limit_reached`, `too_many_jobs`). Not charged
- `500` Unexpected error (`internal_error`)
- `502` Every upstream source failed; not charged (`source_unavailable`). A Retry-After header says how long to wait when the source asked us to
- `503` Too many open event streams on this server, the checked site is getting too many checks, or the browser or link checker is busy; try again after the seconds in the Retry-After header (`busy`, `site_busy`, `browser_busy`, `crawl_busy`). Not charged

## Example

```sh
curl "https://api.dnssuper.com/v1/ipv6?domain=example.com" \
  -H "Authorization: Bearer $DNSSUPER_API_KEY"
```

```python
import os

import httpx

client = httpx.Client(
    base_url="https://api.dnssuper.com",
    headers={"Authorization": f"Bearer {os.environ['DNSSUPER_API_KEY']}"},
    timeout=60,
)
response = client.get("/v1/ipv6", params={
    "domain": "example.com",
})
response.raise_for_status()
result = response.json()
print(result["summary"], result["credits_used"])
```

```ts
const response = await fetch(`https://api.dnssuper.com/v1/ipv6?${new URLSearchParams({"domain":"example.com"})}`, {
  headers: { Authorization: `Bearer ${process.env.DNSSUPER_API_KEY}` },
});
if (!response.ok) throw new Error((await response.json()).error.message);
const result = await response.json();
console.log(result.summary, result.credits_used);
```

Example response:

```json
{
  "tool": "ipv6-test",
  "target": "example.com",
  "status": "ok",
  "fetched_at": "2026-11-14T10:00:00Z",
  "cached": false,
  "credits_used": 1,
  "summary": "example.com is fully reachable over IPv6.",
  "findings": [
    {
      "id": "ipv6.ready",
      "severity": "pass",
      "title": "Your domain is fully reachable over IPv6",
      "detail": "",
      "fix": "Nothing to do."
    }
  ],
  "data": {
    "domain": "example.com",
    "readiness": "full",
    "grade_basis": "probes",
    "probes": "checked",
    "hosts": [
      {
        "name": "example.com",
        "role": "web",
        "ipv4": [
          "192.0.2.10"
        ],
        "ipv6": [
          "2001:db8::10"
        ],
        "ipv6_kinds": {
          "2001:db8::10": "public"
        },
        "probe": {
          "family6": {
            "status": 200,
            "title": "Example Domain",
            "ms": 0
          },
          "family4": {
            "status": 200,
            "title": "Example Domain",
            "ms": 0
          },
          "same": true
        },
        "ns_probes": []
      },
      {
        "name": "www.example.com",
        "role": "www",
        "ipv4": [
          "192.0.2.10"
        ],
        "ipv6": [
          "2001:db8::10"
        ],
        "ipv6_kinds": {
          "2001:db8::10": "public"
        },
        "probe": {
          "family6": {
            "status": 200,
            "title": "Example Domain",
            "ms": 0
          },
          "family4": {
            "status": 200,
            "title": "Example Domain",
            "ms": 0
          },
          "same": true
        },
        "ns_probes": []
      },
      {
        "name": "mail.example.com",
        "role": "mx",
        "ipv4": [
          "192.0.2.25"
        ],
        "ipv6": [
          "2001:db8::25"
        ],
        "ipv6_kinds": {
          "2001:db8::25": "public"
        },
        "ns_probes": []
      },
      {
        "name": "ns1.example.net",
        "role": "ns",
        "ipv4": [
          "192.0.2.53"
        ],
        "ipv6": [
          "2001:db8::53"
        ],
        "ipv6_kinds": {
          "2001:db8::53": "public"
        },
        "ns_probes": [
          {
            "address": "2001:db8::53",
            "answered": true,
            "authoritative": true,
            "serial": 2026111401,
            "ms": 0
          }
        ]
      },
      {
        "name": "ns2.example.net",
        "role": "ns",
        "ipv4": [
          "198.51.100.53"
        ],
        "ipv6": [
          "2001:db8:1000::53"
        ],
        "ipv6_kinds": {
          "2001:db8:1000::53": "public"
        },
        "ns_probes": [
          {
            "address": "2001:db8:1000::53",
            "answered": true,
            "authoritative": true,
            "serial": 2026111401,
            "ms": 0
          }
        ]
      }
    ]
  },
  "credits_remaining": 498
}
```

## MCP

```json
{
  "tool": "check_ipv6",
  "arguments": {
    "domain": "example.com"
  }
}
```

```text
example.com is fully reachable over IPv6.
Readiness: full (tested over IPv6)
example.com (web): IPv6 2001:db8::10, answers the same as over IPv4
www.example.com (www): IPv6 2001:db8::10, answers the same as over IPv4
mail.example.com (mx): IPv6 2001:db8::25
ns1.example.net (ns): IPv6 2001:db8::53, answers authoritatively
ns2.example.net (ns): IPv6 2001:db8:1000::53, answers authoritatively
1 check passed
Credits: 1 credit used, 498 remaining | fresh | checked 2026-11-14 10:00 UTC
```
