2xx uses 1 unit of your monthly API Calls allowance, and a non-2xx response is refunded. Every call also counts toward the per-second rate limit. See Rate limits.
When your license is not active, both endpoints return 403:
Search
certificate_database_search takes a query of 3 to 1,024 characters. The default field is domain, so a bare domain finds certificates issued for it and for every subdomain under it. You don’t need a leading *..
createdAt clause. The query language has two fields, domain and createdAt, and three operators, AND, OR and NOT. The query contains : and spaces, so let curl -G --data-urlencode encode it.
Request parameters
Narrow with risk filters
Set any of these query parameters totrue to keep only the matching certificates.
onlyOwnDomain and excludeOwnDomain cannot both be true. Sending both returns 400:
What comes back
A page of certificates. The certificates are incontent. The other fields describe the page.
content— the certificates on this page.hasContent—truewhen this page holds at least one certificate.number— the page index, starting at0.size— the page size used.numberOfElements— certificates on this page.totalElements— matching certificates across all pages.totalPages— pages available at thissize.first/last—trueon the first and the last page.
id— the certificate’s ID, forcertificate_detail.domain— the host the certificate was issued for.issuer— the certificate authority that signed it.notBefore/notAfter— the start and end of its validity.createdAt— the record’s date in the index, the field thatcreatedAt:queries.algorithm,fingerprint,serialNumber— the certificate’s signature algorithm, fingerprint and serial number.cvssScore— a numeric score on the record, ornull.
YYYY-MM-DD HH:MM:SS.
Reading the results
Compare eachdomain with the hosts your organization knows about:
- A host you do not recognize under your domain, such as
vpn-test.acme.com, can be an unlisted service or a forgotten test system. - A certificate for a look-alike means someone set up TLS on that name. Search the look-alike itself, for example
query=acme-login.com, to list its certificates. - A
notAfterin the past marks an expired certificate. The host may still answer. - An
issueryou do not use shows a certificate obtained outside your usual provider.
Fetch one certificate
certificate_detail returns one certificate by the id from a search result. The path has no trailing slash.
content. An unknown id returns 404.
Monitor new certificates
To receive new certificates for a query without repeating the search, create a monitor on the Certificate service (3 in the service list) with your query as args, for example {"query": "acme.com"}. Read the service’s args_schema from the service list for the other parameters it takes. See Create and manage monitors.