- 259 typed API operations
- 10 synced entities (
ipAddresses,macAddresses,networks,organizations,policies,scheduledReports, and 4 more) for fast.search()/.list()
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the DNSFilter API key before the first call: More: API Key
pnpm corsair setup --plugin=dnsfilter --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.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.
Example API calls
agentLocalUserBulkDeletes.counts
agentLocalUserBulkDeletes.create
Query synced data
Synced entities supporttenant.dnsfilter.db.<entity>.search() and .list(): ipAddresses, macAddresses, networks, organizations, policies, scheduledReports, subnets, unblockRequests, userAgents, users.
See Database for filters and operators.
What’s next
API reference
Every
dnsfilter.api.* operation with input and output types.Database
Synced entities, search filters, and operators.
Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.