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

Get the domain's acme-dns account

gethttps://api.nsin.ir/domains/{domain}/ssl/acme-dns

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

Whether this domain proves control through an acme-dns account, and which one. The password is never returned.

cname_name and cname_target are the record that must exist in your own DNS for the account to prove anything — check it against what is actually published if issuance is failing.

Path parameters

  • domainstringrequiredpath

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

Responses

200The account, or configured: false.

Content type: application/json

  • configuredboolean

    False, and nothing else set, when this domain has no account.

  • domainstring

    The domain this account was accepted for.

  • api_basestring

    The acme-dns instance challenge values are written to, derived from the account's own fulldomain.

  • usernamestring
  • full_domainstring

    The name inside acme-dns that holds this domain's challenge values.

  • allow_fromstring

    The account's IP allowlist as acme-dns reported it. Empty means the account may be used from any address; that is fixed at registration and cannot be changed from here.

  • cname_namestring

    The record that must exist in your own DNS.

  • cname_targetstring
  • updated_atstring (date-time)
json
{
  "configured": true,
  "domain": "string",
  "api_base": "string",
  "username": "string",
  "full_domain": "string",
  "allow_from": "string",
  "cname_name": "_acme-challenge.numberland.ir",
  "cname_target": "e940716e-147b-477c-80a1-3cff2e2fbccf.auth.acme-dns.io.",
  "updated_at": "2026-01-01T00:00:00Z"
}
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"
}
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"
}
429The key exceeded its request budget (300 requests per minute by default).

Content type: application/json

  • errorstringrequired

    Human-readable description of what went wrong.

json
{
  "error": "rate limit exceeded"
}

Example request

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