nsindocs Search the docs⌘K
  1. Docs
  2. API reference
  3. Domains

Last result of each manual check

gethttps://api.nsin.ir/domains/{domain}/checks

Auth: Authorization: Bearer nsin_… or X-Api-Key: nsin_… — see API keys.

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. 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. Any other caller — the panel, or an NSIN SSO access token — gets 202 from the check endpoint with the job running in the background, and polls this endpoint for the verdict.

Requires domain.view.

Path parameters

  • domainstringrequiredpath

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

Responses

200The stored checks, keyed by kind.

Content type: application/json

  • checksobject

    Keyed by kind; kinds never checked are absent.

  • runningboolean

    Whether any check on this domain is in flight.

json
{
  "checks": {},
  "running": true
}
401Missing, malformed, revoked or expired API key. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

Content type: application/json

  • errorstringrequired

    Human-readable description of what went wrong.

json
{
  "error": "invalid API key"
}
403The key is read-only, your role on the domain lacks the required permission, or the domain's plan does not include the feature.

Content type: application/json

  • errorstringrequired

    Human-readable description of what went wrong.

json
{
  "error": "read-only API key"
}
404No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

Content type: application/json

  • errorstringrequired

    Human-readable description of what went wrong.

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

Example request

bash
curl -X GET "https://api.nsin.ir/domains/example.com/checks" \
  -H "Authorization: Bearer $NSIN_API_KEY"
esc