Get the domain's acme-dns account

GET

/domains/{domain}/ssl/acme-dns

const url = 'https://api.nsin.ir/domains/example.com/ssl/acme-dns';
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/ssl/acme-dns \
  --header 'Authorization: Bearer <token>'

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.

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 account, or configured: false.

application/json

A domain’s acme-dns account. The password is never returned.

object

configured

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

boolean

domain

The domain this account was accepted for.

string

api_base

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

string

username

string

full_domain

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

string

allow_from

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.

string

cname_name

The record that must exist in your own DNS.

string

cname_target

string

updated_at

string format: date-time

Example

{
  "cname_name": "_acme-challenge.numberland.ir",
  "cname_target": "e940716e-147b-477c-80a1-3cff2e2fbccf.auth.acme-dns.io."
}

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"
}

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"
}

429

The key exceeded its request budget (300 requests per minute by default).

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

limited

{
  "error": "rate limit exceeded"
}