跳到主要内容
ecdsa.com

Domain health

TLS signature-health grade for a domain

GEThttps://ecdsa.com/api/v1/health/{domain}

Connects to the domain on port 443, examines the served certificate chain, key and signature algorithms, protocol versions and lifetimes, and returns a letter grade with findings, plus the leaf certificate's expiry and key algorithm as structured fields. Results are cached for 1 hour. Only public DNS hostnames are accepted — IP addresses, single-label names and private/reserved addresses are refused. Extra rate limit: 10 requests/minute per IP. A fresh scan can take several seconds.

API 密钥
可选;密钥需要 scan 范围
使用密钥时的配额消耗
每次调用 5 个单位
速率限制
每个 IP 每分钟 60 次请求,扫描另有每分钟 10 次
扫描额度
同一主机每 10 分钟 6 次实际扫描,所有扫描合计每分钟 300 次,所有人共享;来自缓存的响应不消耗额度

请求

路径参数

字段类型必需说明
domainstring是

Public DNS hostname, e.g. "github.com".

响应

200Health grade, findings and the served leaf certificate.

字段类型必需说明
domainstring是
gradeobject是
grade.letterstring是
  • "A+"、"A"、"B"、"C"、"D"或"F" 之一
grade.scoreinteger是
  • 不小于 0
  • 不大于 100
findingsHealthFinding[]是
scannedAtstring是
  • 格式 date-time
cachedboolean是

Best-effort: true when the result came from the 1-hour cache.

cacheTtlSecondsinteger是
  • 固定为 3600
reportUrlstring是

Human-readable report for the same domain.

  • 格式 uri
certificateHealthCertificate | null是

null only when the report carries no certificate.

响应头: X-Request-Id · X-RateLimit-Limit · X-RateLimit-Remaining · X-RateLimit-Reset · X-Quota-Limit · X-Quota-Remaining · X-Quota-Reset

状态码含义错误码
400Bad request. Input limits: a request body of at most 100 KB (a larger one is answered with 413) and arrays and objects nested at most 64 levels deep, JSON documents inside string fields included.
401Unauthorized.
403Forbidden.
404Not found.
405Method not allowed.
429Too many requests.
500Internal server error.
502Bad gateway.
503Service unavailable.
504Gateway timeout.

每个错误响应都带有 JSON 信封;错误表说明了每个错误码的含义和处理方法。

示例

A public domain

curl
curl -sS 'https://ecdsa.com/api/v1/health/github.com'
JavaScript (fetch)
const response = await fetch("https://ecdsa.com/api/v1/health/github.com");
console.log(response.status, await response.json());
Python (httpx)
import httpx

response = httpx.get("https://ecdsa.com/api/v1/health/github.com", timeout=30.0)
print(response.status_code, response.json())
响应 200
{
  "domain": "github.com",
  "grade": {
    "letter": "A+",
    "score": 100
  },
  "findings": [
    {
      "id": "pqc-migration-ahead",
      "severity": "info",
      "title": "Classical algorithm — post-quantum migration ahead",
      "detail": "ECDSA P-256 is a sound choice today. It is, however, quantum-vulnerable: NIST IR 8547 (draft) plans to disallow classical signature algorithms — ECDSA, EdDSA and RSA — after 2035; at this key size there is no earlier 2030 milestone — that step covers only 112-bit parameter sets such as RSA-2048. No penalty and no emergency — but certificate rotation is the easy part; knowing everywhere else your systems sign is the real migration work."
    },
    {
      "id": "key-modern",
      "severity": "ok",
      "title": "Modern signature key (ECDSA P-256)",
      "detail": "ECDSA P-256 gives compact keys and signatures at full strength — the current best practice for TLS server certificates."
    },
    {
      "id": "cert-valid",
      "severity": "ok",
      "title": "Within validity period",
      "detail": "Valid until 2026-11-29 — 41 days remaining."
    },
    {
      "id": "cert-short-lifetime",
      "severity": "ok",
      "title": "Short certificate lifetime (90 days)",
      "detail": "Lifetimes of 90 days or less are the signature of automated issuance and rotation (ACME et al.) — exactly the posture the shrinking CA/Browser Forum limits are pushing everyone toward. Well done."
    },
    {
      "id": "legacy-tls-refused",
      "severity": "ok",
      "title": "Legacy TLS refused",
      "detail": "Handshakes capped at TLS 1.1 were rejected — the deprecated protocol versions are switched off."
    },
    {
      "id": "tls13",
      "severity": "ok",
      "title": "TLS 1.3 negotiated",
      "detail": "The handshake settled on TLS 1.3 with TLS_AES_128_GCM_SHA256 — the current protocol generation, with a cleaner handshake and only AEAD ciphers."
    },
    {
      "id": "chain-complete",
      "severity": "ok",
      "title": "Certificate chain complete (as served)",
      "detail": "Every issuer → subject link matches and the chain ends at a self-signed root (chain as served)."
    }
  ],
  "scannedAt": "2026-10-20T07:14:02.839Z",
  "cached": true,
  "cacheTtlSeconds": 3600,
  "reportUrl": "https://ecdsa.com/health/github.com",
  "certificate": {
    "notAfter": "2026-11-29T23:59:59.000Z",
    "daysRemaining": 41,
    "keyAlgorithm": "ECDSA",
    "curve": "P-256"
  }
}

这是 API 对此示例的响应,于2026年10月20日为本页生成;其中的相对时间和天数都以当天为准。 github.com 的扫描结果是当天从生产环境记录的;实时调用会重新扫描,或返回一小时缓存中的结果。

错误码

错误码状态码含义
invalid_json400The body is not valid JSON or not a JSON object; or the input nests arrays and objects more than 64 levels deep (JSON documents inside string fields count too), or is too complex to inspect for private keys.
private_key_rejected400The request contains private-key material (a PEM PRIVATE KEY block, an OpenSSH, SSH2 or PuTTY private key, or a JWK with "d"). Never send private keys anywhere.
invalid_domain400Not a public DNS hostname (IP addresses, single-label names and paths are refused).
scan_dns_error400The domain does not resolve in public DNS.
scan_private_address400The domain resolves (at least partly) to a private or reserved address.
unauthorized401The Authorization or X-API-Key header is malformed, the API key is not valid (wrong checksum, unknown, revoked or expired), or the operation needs a key.
forbidden_scope403The API key is valid but lacks a scope this operation requires; the message names it.
not_found404No operation exists at this path.
method_not_allowed405The path exists but does not accept this HTTP method; see the Allow header.
rate_limited429Too many requests — see Retry-After.
quota_exceeded429A daily or monthly quota of the API key's account is used up. X-Quota-Reset (and Retry-After) say when it starts over; retrying earlier cannot succeed.
internal_error500Unexpected server error.
scan_unreachable502The domain refused or dropped the connection on port 443.
scan_tls_error502The TLS handshake failed or presented no usable certificate.
service_unavailable503API keys cannot be verified right now (the key store is unreachable); retry shortly.
scan_timeout504The scan did not finish in time.

Schema

HealthFinding

字段类型必需说明
idstring是

Stable identifier, e.g. "cert-expired" or "tls13".

severitystring是
  • "critical"、"warn"、"info"或"ok" 之一
titlestring是
detailstring是

HealthCertificate

The served leaf certificate, as structured fields.

字段类型必需说明
notAfterstring是

End of the leaf certificate's validity.

  • 格式 date-time
daysRemaininginteger是

Whole days from scannedAt until notAfter, rounded up; zero or negative once expired.

keyAlgorithmstring是

Public-key algorithm of the leaf certificate: ECDSA, RSA, Ed25519, Ed448, an ML-DSA or SLH-DSA parameter set, or the scanner's label for anything else.

curvestring | null是

Named curve of an ECDSA key ("P-256", "P-384", …); null otherwise.

Error

The error envelope of every non-2xx response.

字段类型必需说明
errorobject是
error.codestring是

Machine-readable error code. Each response lists the codes it can carry; new codes may be added within v1, so treat an unknown code by its HTTP status.

error.messagestring是

Human-readable explanation (English).

error.requestIdstring否

The X-Request-Id of this request — quote it when reporting a problem. Sent since v1.1.

error.detailobject否

Structured context for the error, such as the offending field; omitted when there is none.

  • 成员名任意
error.docsstring否

Where the error codes are explained. Sent since v1.1.

  • 格式 uri

所有操作都列在 API 参考中。