# Web port check API

Check that a domain's web ports 80 and 443 answer on every address.

`GET /v1/ports`

- 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 1 minute; send fresh=true to ask the source again.
- MCP tool: `check_web_ports`

Whether ports 80 and 443 answer on each of a domain's addresses, with the TLS handshake and HTTP redirect for open ports. Costs 1 credit per call; cached answers cost the same. Calls that fail upstream (502) are free. Answers are cached for up to 1 minute; 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; never an IP address. Ports 80 and 443 are checked on each of its addresses. |
| `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.host` | string | yes |  |
| `data.rows` | array of object | yes |  |
| `data.rows.address` | string | yes |  |
| `data.rows.family` | 4 | 6 | yes |  |
| `data.rows.ports` | object | yes |  |
| `data.omitted` | integer | yes |  |
| `data.ipv6_checked` | boolean | 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

## Example

```sh
curl "https://api.dnssuper.com/v1/ports?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/ports", 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/ports?${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": "port-checker",
  "target": "example.com",
  "status": "ok",
  "fetched_at": "2026-11-14T10:00:00Z",
  "cached": false,
  "credits_used": 1,
  "summary": "Ports 80 and 443 answer on all 3 addresses of example.com.",
  "findings": [
    {
      "id": "ports.all_open",
      "severity": "pass",
      "title": "Ports 80 and 443 answer on every address",
      "detail": "",
      "fix": "Nothing to do."
    }
  ],
  "data": {
    "host": "example.com",
    "rows": [
      {
        "address": "192.0.2.10",
        "family": 4,
        "ports": {
          "80": {
            "state": "open",
            "ms": 0,
            "http": {
              "status": 301,
              "redirect_to": "https://example.com"
            }
          },
          "443": {
            "state": "open",
            "ms": 0,
            "tls": {
              "ok": true,
              "version": "TLSv1.3",
              "name_matches": true
            }
          }
        }
      },
      {
        "address": "198.51.100.10",
        "family": 4,
        "ports": {
          "80": {
            "state": "open",
            "ms": 0,
            "http": {
              "status": 301,
              "redirect_to": "https://example.com"
            }
          },
          "443": {
            "state": "open",
            "ms": 0,
            "tls": {
              "ok": true,
              "version": "TLSv1.3",
              "name_matches": true
            }
          }
        }
      },
      {
        "address": "2001:db8::10",
        "family": 6,
        "ports": {
          "80": {
            "state": "open",
            "ms": 0,
            "http": {
              "status": 301,
              "redirect_to": "https://example.com"
            }
          },
          "443": {
            "state": "open",
            "ms": 0,
            "tls": {
              "ok": true,
              "version": "TLSv1.3",
              "name_matches": true
            }
          }
        }
      }
    ],
    "omitted": 0,
    "ipv6_checked": true
  },
  "credits_remaining": 498
}
```

## MCP

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

```text
Ports 80 and 443 answer on all 3 addresses of example.com.
Host: example.com (3 addresses tested)
192.0.2.10 (IPv4): 443 open, TLSv1.3; 80 open, redirects to https://example.com
198.51.100.10 (IPv4): 443 open, TLSv1.3; 80 open, redirects to https://example.com
2001:db8::10 (IPv6): 443 open, TLSv1.3; 80 open, redirects to https://example.com
1 check passed
Credits: 1 credit used, 498 remaining | fresh | checked 2026-11-14 10:00 UTC
```
