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

Test the stored acme-dns credentials

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

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

Re-checks the credentials already stored for this domain by writing a throwaway value through the API, exactly as the upload did.

An acme-dns account can stop working long after it was accepted — the owner rotates it, the instance moves, an allowlist starts excluding our egress — and nothing surfaces that until a renewal fails weeks later. Requires ssl.manage.

Path parameters

  • domainstringrequiredpath

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

Responses

200The credentials work.

Content type: application/json

  • messagestring
  • okboolean
json
{
  "message": "string",
  "ok": true
}
400The credentials did not work (code: "verification_failed").

Content type: application/json

  • errorstringrequired

    Human-readable description of what went wrong.

json
{
  "error": "read-only API key"
}
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 domain, or this domain has no acme-dns credentials.

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 POST "https://api.nsin.ir/domains/example.com/ssl/acme-dns/test" \
  -H "Authorization: Bearer $NSIN_API_KEY"
esc