> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# SSLMate Cert Spotter plugin

> Search Certificate Transparency logs for a domain's certificates, and follow the stream of new issuances.

Use **SSLMate Cert Spotter** through Corsair: one client, typed API calls.

Create an API key at [https://sslmate.com/account/api\_keys](https://sslmate.com/account/api_keys). The free tier allows 100 single-hostname queries an hour and 10 full-domain queries an hour; paid plans raise both.

Things to know:

* **Paging is a cursor.** The last issuance's `id` is the next call's `after`. Repeat until the answer is an empty array: you have caught up. The operation returns only the array, not the provider's `Retry-After` header, so wait a few minutes before asking again with the same cursor (Cert Spotter currently asks firehose readers to wait 5 minutes).
* **Fields need `expand`.** `dns_names`, `issuer`, `revocation`, `problem_reporting`, `cert_der` and the `pubkey` fields are left out unless named in `expand`. A nested field takes a dotted path, such as `issuer.caa_domains`.
* **`revoked` is three-state.** It is `true`, `false`, or `null` when Cert Spotter cannot determine the status. Expired certificates always report `null`.
* **Wildcards.** A request for `www.example.com` does not return a `*.example.com` certificate unless `match_wildcards` is true, and sub-domain certificates need `include_subdomains`.
* **The firehose needs its own subscription.** `firehose.list` returns every issuance across all logs. Falling too far behind answers `lagging_client`, which means restart from the end rather than retry.
* **Two failures are not retried.** `timeout` means the query exceeded your plan's limit, and `payment_required` means the subscription lapsed. Both need a plan change, not a replay.

**What you get:**

* 2 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/certspotter better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/certspotter better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/certspotter better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/certspotter better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { certspotter } from '@corsair-dev/certspotter';

export const corsair = createCorsair({
	plugins: [
		certspotter(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the SSLMate Cert Spotter API key before the first call: `pnpm corsair setup --plugin=certspotter --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> certspotter()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'certspotter',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List the certificates for a domain**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.certspotter.api.issuances.list({
	domain: 'example.com',
	expand: ['dns_names', 'issuer'],
});
```

**Write**

*No write-style endpoint inferred; pick any operation from the [API](https://docs.corsair.dev/plugins/certspotter/api.md) reference.*

See the full list on the [API](https://docs.corsair.dev/plugins/certspotter/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/certspotter/api.md)
>
> Every `certspotter.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.