> ## 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.

# Overview

> Cloud DNS security and content filtering - manage networks, policies, roaming clients, block pages, and traffic reporting.

Use **DNSFilter** through Corsair: one client, typed API calls, local DB sync.

**What you get:**

* 259 typed API operations
* 10 synced entities (`ipAddresses`, `macAddresses`, `networks`, `organizations`, `policies`, `scheduledReports`, and 4 more) for fast `.search()` / `.list()`

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/dnsfilter
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/dnsfilter
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/dnsfilter
```

```bash bun theme={null}
bun add corsair @corsair-dev/dnsfilter
```

**2. Add the plugin**

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

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

Multi-tenancy is the default — 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)
>
> No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.
>
> ```ts theme={null}
> dnsfilter()
> ```
>
> 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: 'dnsfilter',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**`agentLocalUserBulkDeletes.counts`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.dnsfilter.api.agentLocalUserBulkDeletes.counts({});
```

**`agentLocalUserBulkDeletes.create`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.dnsfilter.api.agentLocalUserBulkDeletes.create({});
```

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

## Query synced data

Synced entities support `tenant.dnsfilter.db.<entity>.search()` and `.list()`: `ipAddresses`, `macAddresses`, `networks`, `organizations`, `policies`, `scheduledReports`, `subnets`, `unblockRequests`, `userAgents`, `users`.

See [Database](https://docs.corsair.dev/plugins/dnsfilter/database.md) for filters and operators.

## What's next

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

> [card] [Database](https://docs.corsair.dev/plugins/dnsfilter/database.md)
>
> Synced entities, search filters, and operators.

> [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.