# domains.checkDns

Check domain DNS records.

Queries live DNS for required records (MX, SPF, DKIM CNAMEs, DMARC, SRV) and returns validation status and required values.

```ts
openemail.domains.checkDns(
  domain: string,
  options?: DomainsCheckDnsOptions,
): ApiPromise<DomainDnsCheck>
```

It calls `POST /domains/{domain}/dns/check`: [Check domain DNS records](/docs/api/domains/post_DomainDnsCheck) in the API reference.

## Example

```ts
const domainDnsCheck = await openemail.domains.checkDns(domain)
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `domain` | `string` | Domain name (e.g. 'example.com'). The path's `{domain}`. |

## Options

The last argument, `options`, a `DomainsCheckDnsOptions`, takes:

| Option | Type | Sent as | Description |
| --- | --- | --- | --- |
| `force` | `boolean` | query `force` | Set to 'true' to bypass the cached verdict and re-query live nameservers. A live check is a dozen DNS questions, so forced checks are rate limited per account; a refused one answers 429. An unforced poll is bounded by the verdict cache instead and is never refused |

Every call also takes `signal`, `timeout`, `retry` and `headers`, which say how that one call is sent ([call options](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

Awaited, it is the API's JSON, [`DomainDnsCheck`](/docs/sdks/typescript/types/domain-dns-check). It is an [`ApiPromise`](/docs/sdks/typescript/responses): `.withResponse()` gives the same with the `Response` it came in, for its headers.

## Errors

| Status | What it means |
| --- | --- |
| `400` | validation_failed |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | Domain not found or not accessible to this principal |
| `429` | rate_limited — too many FORCED checks for this account. Only `force=true` is counted; an ordinary client polling through propagation is bounded by the verdict cache and never sees this |
| `503` | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |

A failed call rejects with a [`RequestError`](/docs/sdks/typescript/errors): its `status`, and its `code`, the API's `error`. Decide on the code: one status covers several.

## Types

It names these types of the API, each on a page of its own: [`DomainDnsCheck`](/docs/sdks/typescript/types/domain-dns-check).
