Get certificate status

GET

/domains/{domain}/ssl/

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

• Production

The domain’s current certificate — issuer, validity, SANs, key size — plus whether a manual re-issue is currently allowed, and coverage: proxied hostnames that are not on the certificate yet, with their retry state.

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

Certificate status.

Media type application/json

object

status

string

expires_at

string format: date-time

issued_at

string format: date-time

days_remaining

integer

issuer

string

subject

string

serial_number

string

sans

Array<string>

signature_algorithm

string

key_size

integer

is_wildcard

boolean

auto_renewal

boolean

has_private_key

boolean

can_manual_issue

Whether POST /domains/{domain}/ssl/issue would be accepted right now.

boolean

manual_issue_reason

Why manual issuance is unavailable, when can_manual_issue is false.

string

next_manual_issue_at

string format: date-time

last_issue_attempt_at

string format: date-time

hostname

The name the reported certificate is installed under — usually the apex, but a domain may hold a certificate for one subdomain only.

string

covered_hostnames

Every name of this domain with an active certificate, sorted.

Array<string>

uncovered_hostnames

Proxied names with no certificate behind them, sorted. External-DNS domains only — for managed domains the same gaps arrive in coverage, with the retry schedule that applies when we can issue.

Array<string>

coverage

Proxied hostnames not yet on the certificate. Absent when coverage is complete.

Array<object>

A proxied hostname that the domain’s certificate does not cover yet.

object

hostname

string

status

string

Allowed values: pending failed missing

failure_count

integer

max_retries

integer

next_retry_at

string format: date-time

last_error

The certificate authority’s own reason for the last failure.

string

Example

{
  "status": "active",
  "coverage": [
    {
      "status": "pending"
    }
  ]
}

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

404

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

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