GET/v1/domains/{domain}/ssl1 creditStored data by defaultThe certificate the site serves: whether browsers trust it, who issued it, the names it covers and the days left.
Send your key in the Authorization header as a Bearer token. Keys start with cd_live_ (or cd_test_ for test keys, which return sample data and use no credits). Keep keys on your server, never in front-end code. More on keys
domainstring · required | The domain to check, without https:// or a path. Subdomains work too. Example: example.com. |
|---|
fresh |
|---|
Test keys (cd_test_…) return sample data for any domain and use no credits. Make one in your account, then run the call above.
Set to true to skip our stored report and run a live check. Uses 2 credits instead of 1. On the Starter, Pro and Business plans. Default false. |
domainstring | The domain checked, lower-case. |
|---|---|
checked_atstring · date-time | When the data was collected (UTC). |
cachedboolean | True when the answer came from our stored report; false for a live check. |
sslobject | The certificate the site serves. |
ssl.string | valid, expiring (14 days or fewer), expired, not_trusted, unknown or none (no certificate). |
ssl.boolean | True when browsers accept it: the status is valid or expiring. |
ssl.string · nullable | Who issued it: the organisation, or its common name. |
ssl.string · nullable | The common name it was issued for. |
ssl.string · date · nullable | The first day it’s valid. |
ssl.string · date · nullable | The last day it’s valid. |
ssl.integer · nullable | Days until it expires; negative once it has. |
ssl.string · nullable | Why it isn’t trusted: name (it doesn’t cover the domain) or self-signed. |
ssl.array of strings | The names it covers (subject alternative names). |
valid | Trusted, with more than 14 days left. |
|---|---|
expiring | Trusted, with 14 days or fewer left. |
expired | Past its last day. |
not_trusted | Browsers won’t accept it: it doesn’t cover the domain, or it’s self-signed. problem says which. |
unknown | We couldn’t read its dates. |
none | The site serves no certificate. |
Errors return JSON like {"error": {"code": "rate_limited", "message": "…"}} and use no credits. All about errors
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_domain | The domain isn’t valid. Send just the name, like example.com, without https:// or a path. |
| 401 | invalid_key | The API key is missing, wrong or revoked. |
| 402 | out_of_credits | Not enough credits left this period for this call. |
| 403 | account_blocked | API access is blocked on this account. Contact us. |
| 403 | ip_not_allowed | The key can’t be used from this IP address (its allowlist). |
| 403 | plan_required | fresh=true isn’t on your plan. |
| 404 | domain_not_found | The domain doesn’t exist, or has nothing to show for this. |
| 429 | rate_limited | Too many requests this second. Wait for Retry-After seconds. |
| 500 | server_error | Our side failed. You weren’t charged; try again later. |
| 503 | api_unavailable | The API isn’t open. |
| 503 | maintenance | The API is down for maintenance. Try again shortly. |