Certificate Transparency Search APIv1
When a publicly-trusted certificate is issued, it can result in a certificate, a precertificate, or both being logged to multiple Certificate Transparency logs. SSLMate monitors public Certificate Transparency logs, coalescing all the certificates and precertificates for a particular issuance event into a single issuance object. SSLMate indexes the issuances by DNS name, and you can use the API described below to efficiently query all the issuances for a particular domain, and then poll for new issuances. Learn more
The following parameters may be specified in the query string:
Return issuances that are valid for the given DNS name, which must be a
registered domain or subordinate to
a registered domain. For example,
Omit this parameter to return all known issuances (requires subscribing to Firehose Access).
Also include issuances that are valid for sub-domains (of any depth) of
Also include issuances for wildcard DNS names that match
Return issuances that were discovered by SSLMate since the issuance with the specified ID.
Controls the behavior when the
It is an error to specify both the
||Include the given field in the response, as described below. Repeat this parameter to expand multiple fields.|
Response: JSON array of issuance objects, in the order that they were discovered by SSLMate.
An issuance is represented by a JSON object with the following fields:
||string||An opaque identifier which represents this issuance object.|
||string||The hex-encoded SHA-256 digest of the TBSCertificate, as defined in RFC 6962 Section 3.2.|
||array of strings||DNS names for which the issuance is valid, taken from both the DNS subject alternative names (SANs) and the subject common name (CN). Internationalized domain names are encoded in Punycode. Only present if expanded.|
||string||The hex-encoded SHA-256 digest of the Subject Public Key Info.|
||issuer object||Information about the issuer. Only present if expanded.|
||string||The not before date, in RFC 3339 format (e.g.
||string||The not after (expiration) date, in RFC 3339 format (e.g.
||certificate object||Information about the certificate (if known) or precertificate (if certificate not known) corresponding to this issuance. Only present if expanded.|
A certificate or precertificate is represented by a JSON object with the following fields:
||string||The hex-encoded SHA-256 digest of the X.509 (pre-)certificate, encoded in ASN.1 DER.|
||string||The base64 representation of the X.509 (pre-)certificate, encoded in ASN.1 DER.|
An issuer is represented by a JSON object with the following fields:
||string||The subject distinguished name of the issuer, formatted according to RFC 2253.|
||string||The hex-encoded SHA-256 digest of the issuer's Subject Public Key Info.|
Example Issuance (with all fields expanded)
Expanding Object Fields
As indicated in the documentation for an object, certain object fields are
not included in responses by default. To include such a field, you must specify the field name
in the request's
expand parameter. This parameter can be specified
more than once to expand multiple fields.
The API returns a limited number of issuances in a single response.
To retrieve additional issuances, take the
id field of the last
issuance and pass it to the issuances endpoint in the
parameter (leaving the other parameters as-is). Repeat until the
issuances endpoint returns an empty array.
Polling For New Issuances
When the issuances endpoint returns an empty array, it includes
Retry-After HTTP header containing a number of seconds.
After the specified time has elapsed, you may retry the request. If
SSLMate has discovered new issuances matching your query, they will
be returned. You can then request subsequent pages until another empty
response is returned.
You can make a limited number of unauthenticated API queries per hour, for personal or evaluation purposes.
When you're ready to launch in production, we ask that you sign up for an account and authenticate to the API using one the following methods:
- Specify your SSLMate API key using an OAuth2 Bearer Token.
- Specify your SSLMate API key as the username using HTTP Basic Authentication. Use an empty password.
Your API key can be found on your account page.
curl -H "Authorization: Bearer 123_sampleapikey" https://api.certspotter.com/v1/issuances?domain=example.com
curl -u 123_sampleapikey: https://api.certspotter.com/v1/issuances?domain=example.com
Provisioned indexes speed up full-domain queries of domains which have a large number of certificates. Provisioned indexes start at $100/month per domain. Contact us to set up a provisioned index.
SSLMate may make backwards-compatible changes to this API, such as adding new endpoints, adding new fields to responses, or adding new optional parameters to requests.
Backwards-incompatible changes will be avoided if at all possible, but should such a change become necessary, SSLMate will strive to provide at least 12 months notice. To ensure you receive notice, please use your API key when making requests.