Last result of each manual check

GET

/domains/{domain}/checks

const url = 'https://api.nsin.ir/domains/example.com/checks';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.nsin.ir/domains/example.com/checks \
  --header 'Authorization: Bearer <token>'

The stored outcome of every user-triggered “check now” on this domain: nameserver delegation (ns), external-DNS verification (txt), the SSL delegation record (dv), the proxied-record edge check (edge) and email routing DNS (email_dns). Kinds that have never been checked are absent.

These checks query public DNS, which can take up to a minute. In the panel they run in the background and this endpoint is what reports the verdict; an API key gets its verdict inline from the check endpoint it called, and can use this to read the last one at any time.

Requires domain.view.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

domain

required

string

The domain name (for example example.com) — not a numeric id.

Example

example.com

Responses

200

The stored checks, keyed by kind.

application/json

object

checks

Keyed by kind; kinds never checked are absent.

object

key

additional properties

One manual check and its last outcome.

object

kind

string

Allowed values: ns txt dv edge email_dns

state

running — the check is in flight; poll again. done — it completed and ok carries the verdict. error — it could not reach an answer (a resolver was unreachable). An error is never a verdict about the domain’s DNS.

string

Allowed values: running done error

The verdict of a done check.

boolean

message

What to show the user.

string

started_at

string format: date-time

finished_at

string format: date-time

running

Whether any check on this domain is in flight.

boolean

Example

{
  "checks": {
    "additionalProperty": {
      "kind": "ns",
      "state": "running"
    }
  }
}

401

Missing, malformed, revoked or expired API key — or the owning account is inactive.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

403

The key is read-only, your role on the domain lacks the required permission, or the domain’s plan does not include the feature.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

404

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}