Test the stored acme-dns credentials

POST

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

curl --request POST \
  --url https://api.nsin.ir/domains/example.com/ssl/acme-dns/test \
  --header 'Authorization: Bearer <token>'

• Production

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.

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 credentials work.

Media type application/json

object

message

string

ok

boolean

Example ^generated

{
  "message": "example",
  "ok": true
}

400

The credentials did not work (code: "verification_failed").

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

401

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

Media type application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

Example 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.

Media type 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 domain, or this domain has no acme-dns credentials.

Media type 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).

Media type application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

Example limited

{
  "error": "rate limit exceeded"
}