> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to DNSFilter

The DNSFilter connector lets your AI agent act in each user's DNSFilter account. Each user connects their own DNSFilter API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.

**Authentication:** API Key
**Categories:** Monitoring, Developer Tools
**Tools:** 59: 33 read, 20 write, 6 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=DNSFILTER)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the DNSFilter connection

   In **AgentKit > Connections**, create a DNSFilter connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'dnsfilter'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize DNSFilter:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'dnsfilter_current_user_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "dnsfilter"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize DNSFilter:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="dnsfilter_current_user_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their DNSFilter credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'dnsfilter_agent_local_user_get',
  toolInput: {
    id: 12345,
  },
  connector: 'dnsfilter',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="dnsfilter_agent_local_user_get",
    tool_input={
        "id": 12345,
    },
    connection_name="dnsfilter",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `dnsfilter_agent_local_user_get`

Get Agent Local User · Read-only

Get one local device user seen by DNSFilter roaming clients.
Returns the user with name, login, policy and the devices they use.
Use this for a user's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Agent local user ID. Example: 12345.

Example input: `{"id":12345}`

### `dnsfilter_agent_local_users_list`

List Agent Local Users · Read-only

List the local device users seen by DNSFilter roaming clients.
Returns users with ID, UUID, name, login, policy and first and last seen dates.
Use this to find users for per-user reports and policies.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `msp_id` (`integer`, optional): MSP ID. When provided, returns agent local users across all organizations belonging to this MSP. Example: 10.
- `name` (`string`, optional): filter by name. If friendly_name not found, will search by user_name. Example: office.
- `organization_ids` (`string`, optional): Organization IDs. Accepts a comma-separated string (organization_ids=1,2) or an array (organization_ids[]=1&organization_ids[]=2). Defaults to the current user's first organization. Comma-separated. Example: 4567.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `search` (`string`, optional): Filter by name or user_login. Example: office.
- `sort` (`string`, optional): Sort options, valid attributes: name, first_seen, last_seen. Prefix with - for descending (e.g. -first_seen). Example: -last_seen.

Example input: `{}`

### `dnsfilter_applications_list`

List Applications · Read-only

List the applications DNSFilter can block or allow.
Returns applications with ID, name and category.
Use this to find application names and IDs for policies and reports.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category_ids` (`string`, optional): Category IDs, defaults to all. Comma-separated. Example: 12,33.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.

Example input: `{}`

### `dnsfilter_block_page_get`

Get Block Page · Read-only

Get one DNSFilter block page.
Returns the block page with name, organization name, contact email and logo.
Use this for a block page's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): BlockPage ID. Example: 12345.
- `include_relationships` (`boolean`, optional): Include relationships in the response true/false, defaults to true. Example: true.

Example input: `{"id":12345}`

### `dnsfilter_block_pages_list`

List Block Pages · Read-only

List the DNSFilter block pages, shown to users when a site is blocked.
Returns block pages with ID, name, organization name and contact email.
Use this to find block page IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `organization_id` (`integer`, optional): Organization ID. Example: 4567.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.

Example input: `{}`

### `dnsfilter_categories_list`

List Categories · Read-only

List all DNSFilter content categories.
Returns categories with ID, name, description and whether they are security threats.
Use this to find category IDs for policies and reports.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.

Example input: `{}`

### `dnsfilter_current_user_get`

Get Current User · Read-only

Get the DNSFilter user the API key belongs to.
Returns the user's ID, name, email, role and organization.
Use this to check the connection and find your organization.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `dnsfilter_domain_lookup`

Look Up Domain · Read-only

Look up how DNSFilter categorizes a domain or FQDN.
Returns the domains associated with the FQDN and their categories.
Use this to check why a site is blocked or allowed.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `fqdn` (`string`, optional): FQDN to lookup. Example: mail.example.com.

Example input: `{}`

### `dnsfilter_ip_address_get`

Get IP Address · Read-only

Get one IP address registered in DNSFilter.
Returns the address with its network, organization and dynamic hostname.
Use this for an IP's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): IP address ID. Example: 12345.

Example input: `{"id":12345}`

### `dnsfilter_ip_addresses_list`

List IP Addresses · Read-only

List the public IP addresses registered to DNSFilter networks.
Returns IP addresses with ID, address, network, organization and dynamic hostname.
Use this to see which IPs belong to which site.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `search` (`string`, optional): Search specific IP information. Example: office.

Example input: `{}`

### `dnsfilter_network_get`

Get Network · Read-only

Get one DNSFilter network (site).
Returns the network with name, organization, policies, block page, IP addresses and local resolvers.
Use this for a site's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Network ID. Example: 12345.
- `count_network_ips` (`boolean`, optional): Return count of IP Addresses. Defaults to False. Example: true.

Example input: `{"id":12345}`

### `dnsfilter_network_lookup`

Look Up Network by IP · Read-only

Find the DNSFilter network that a public IP address belongs to.
Returns basic information about the matching network.
Use this to tell which site traffic comes from.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `requesting_ip_address` (`string`, required): IP address to lookup. Example: 203.0.113.10.

Example input: `{"requesting_ip_address":"<requesting_ip_address>"}`

### `dnsfilter_networks_list`

List Networks · Read-only

List the DNSFilter networks (sites) the user can access.
Returns networks with ID, name, organization, policies, block page and IP addresses.
Use this to browse sites. Use dnsfilter_network_lookup to find a network by IP.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `basic_info` (`boolean`, optional): Return most basic Network Info only. Defaults to False. Example: true.
- `count_network_ips` (`boolean`, optional): Return count of IP Addresses. Defaults to False. Example: true.
- `force_truncate_ips` (`boolean`, optional): Return Network info without IP Addresses. Defaults to False. Example: true.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `protected` (`boolean`, optional): Filter networks with assigned policy. Example: true.
- `search` (`string`, optional): Search for the given value among the network name, hostname, ip address, etc. Example: office.
- `unprotected` (`boolean`, optional): Filter networks without assigned policy. Example: true.

Example input: `{}`

### `dnsfilter_organization_get`

Get Organization · Read-only

Get one DNSFilter organization.
Returns the organization with name, type, billing contact, address and settings.
Use this for an organization's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Organization ID. Example: 12345.
- `include_current_mrr` (`boolean`, optional): Optionally Include current MRR information. Example: true.

Example input: `{"id":12345}`

### `dnsfilter_organization_users_list`

List Organization Users · Read-only

List the dashboard users of a DNSFilter organization.
Returns users with ID, name, email, role and status.
Use this to see who can manage an organization.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `organization_id` (`integer`, required): The ID of the organization to search. Example: 4567.
- `include_auth_providers` (`boolean`, optional): Return user's authentication providers if true (default: false). Example: true.

Example input: `{"organization_id":4567}`

### `dnsfilter_organizations_list`

List Organizations · Read-only

List the DNSFilter organizations the user can access, including MSP sub-organizations.
Returns organizations with ID, name, type and settings.
Use this to find organization IDs. Use dnsfilter_organization_get for one organization.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `basic_info` (`boolean`, optional): just return organizations basic info true/false, defaults to false. Example: true.
- `managed_by_msp_id` (`integer`, optional): MSPs sub-organizations whose MSP ID matches this value. Example: 10.
- `name` (`string`, optional): Filter by organization name. Example: office.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `type` (`string`, optional): Filter by organization type. Example: normal. One of: `normal`, `msp`, `sub_organization`.

Example input: `{}`

### `dnsfilter_policies_list`

List Policies · Read-only

List the DNSFilter filtering policies the user can access.
Returns policies with ID, name, organization and basic settings.
Use this to find policy IDs. Use dnsfilter_policy_get for a policy's full lists.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include_global_policies` (`boolean`, optional): include global policies to listing. Example: true.
- `organization_id` (`integer`, optional): Organization ID. Example: 4567.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.

Example input: `{}`

### `dnsfilter_policy_get`

Get Policy · Read-only

Get one DNSFilter policy.
Returns the policy with its blocked categories, applications, allowlist, blocklist and SafeSearch settings.
Use this to read a policy before changing it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Policy ID. Example: 12345.
- `include_relationships` (`boolean`, optional): Include relationships in the response true/false, defaults to true. Example: true.

Example input: `{"id":12345}`

### `dnsfilter_policy_permissive_mode_get`

Get Policy Permissive Mode · Read-only

Get whether permissive mode is on for a DNSFilter policy; in permissive mode traffic is logged but not blocked.
Returns the permissive mode value.
Use this before changing it with dnsfilter_policy_permissive_mode_update.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Policy ID. Example: 12345.

Example input: `{"id":12345}`

### `dnsfilter_query_logs_list`

List Query Logs · Read-only

List raw DNS query logs for a time period, filtered by result, network, roaming client, user, category or domain; pages hold up to 1,000 rows.
Returns each query with time, FQDN, domain, categories, result (allowed or blocked), policy and source.
Use this to investigate traffic. Use the top_* and total_* report tools for aggregates.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `agent_id` (`string`, optional): User agent UUID. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
- `category_ids` (`string`, optional): Comma separated list of category IDs to include, defaults to all. Example: 12,33.
- `domain` (`string`, optional): Only returns records whose registered domain exactly matches this value (case insensitive); can be combined with exclude_domain. Example: example.com.
- `fqdn` (`string`, optional): search for FQDNs that contains this value. Example: mail.example.com.
- `from` (`string`, optional): Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400. Example: 2026-11-01T00:00:00Z.
- `network_id` (`integer`, optional): Network ID. Example: 10.
- `network_ids` (`string`, optional): Comma separated list of networks IDs. Example: 2201,2202.
- `organization_id` (`integer`, optional): Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `policy_ids` (`string`, optional): Comma separated list of policy IDs, defaults to all. Example: 901.
- `question_type` (`string`, optional): Question Type of queries (exact match); comma separated for multiple values, defaults to all. Example: A.
- `result` (`string`, optional): Type of report (all, blocked only, allowed only), defaults to all. Example: all. One of: `all`, `allowed`, `blocked`.
- `security_report` (`boolean`, optional): Threats report true/false, *both* (threats and non-threats) if it is empty or not sent. Example: true.
- `source` (`string`, optional): Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all. clientless is only a valid, filterable value for organizations with the clientless feature flag enabled. Example: all. One of: `all`, `networks`, `agents`, `proxies`, `clientless`.
- `to` (`string`, optional): Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400. Example: 2026-11-07T23:59:59Z.
- `user_id` (`integer`, optional): User local ID. Example: 10.

Example input: `{}`

### `dnsfilter_roaming_client_get`

Get Roaming Client · Read-only

Get one DNSFilter roaming client.
Returns the client with hostname, friendly name, OS, agent version, state, policy and network.
Use this for a device's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): User agent UUID. Example: 12345.

Example input: `{"id":"<id>"}`

### `dnsfilter_roaming_clients_list`

List Roaming Clients · Read-only

List DNSFilter roaming clients (agents installed on devices), filtered by state, policy, network or keyword.
Returns clients with UUID, hostname, friendly name, agent version, state, policy and last sync.
Use this to find devices. Use dnsfilter_roaming_client_get for one device.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `agent_state` (`string`, optional): filter by agent state. Example: protected. One of: `protected`, `unprotected`, `bypassed`, `pending_uninstall`, `uninstalled`, `offline`.
- `network_ids` (`string`, optional): Networks IDs, defaults to all. Comma-separated. Example: 2201,2202.
- `organization_ids` (`string`, optional): Organization IDs, defaults to user organization ID. Comma-separated. Example: 4567.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `policy_id` (`integer`, optional): Filter user agents by policy ID. Example: 10.
- `search` (`string`, optional): User agent list by keyword(s) (space delimited), this could be: status, hostname, friendly name, current logged in user. Example: office.
- `sort` (`string`, optional): Sort options, valid attributes: hostname, friendly_name, agent_version, last_sync, agent_state, vpn_status, private_network (connected, not_connected, disabled). Example: -last_seen.
- `state` (`string`, optional): filter by user agent online/offline state. Example: online. One of: `online`, `offline`.
- `status` (`string`, optional): filter by user agent status, valid attributes: active, disabled, uninstalled, uninstall_queued, uninstalling. Example: active.
- `type` (`string`, optional): User agent type, defaults to non-proxy/no-relays user agents. Example: proxy. One of: `proxy`, `agents`.

Example input: `{}`

### `dnsfilter_scheduled_policies_list`

List Scheduled Policies · Read-only

List the DNSFilter scheduled policies, which switch policies by time of day and weekday.
Returns scheduled policies with ID, name and schedule.
Use this to find scheduled policy IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.

Example input: `{}`

### `dnsfilter_scheduled_policy_get`

Get Scheduled Policy · Read-only

Get one DNSFilter scheduled policy.
Returns the scheduled policy with its time blocks and the policy used in each.
Use this for a schedule's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ScheduledPolicy ID. Example: 12345.

Example input: `{"id":12345}`

### `dnsfilter_top_categories_get`

Get Top Categories · Read-only

Get the most requested content categories for a period.
Returns categories with request counts.
Use this to see what kind of content users reach.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `agent_ids` (`string`, optional): Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
- `from` (`string`, optional): Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400. Example: 2026-11-01T00:00:00Z.
- `name` (`string`, optional): Only categories whose name contains this value. Example: office.
- `network_ids` (`string`, optional): Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
- `organization_ids` (`string`, optional): Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `security_report` (`string`, optional): Threats report true/false, *both* (threats and non-threats) if set to all. Example: all. One of: `all`, `true`, `false`.
- `source` (`string`, optional): Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all. clientless is only a valid, filterable value for organizations with the clientless feature flag enabled. Example: all. One of: `all`, `networks`, `agents`, `proxies`, `clientless`.
- `to` (`string`, optional): Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400. Example: 2026-11-07T23:59:59Z.
- `type` (`string`, optional): Type of report (all, allowed, blocked), defaults to all. Example: all. One of: `all`, `allowed`, `blocked`.
- `user_ids` (`string`, optional): Comma separated list of local user IDs, defaults to all. Example: 880,881.

Example input: `{}`

### `dnsfilter_top_domains_get`

Get Top Domains · Read-only

Get the most requested domains for a period, optionally only allowed or blocked ones.
Returns domains with request counts and categories.
Use this to see where traffic goes. Use dnsfilter_top_categories_get for categories.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `agent_ids` (`string`, optional): Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
- `domain` (`string`, optional): Only search for domains that starts with this value. Example: example.com.
- `fqdn` (`string`, optional): search for FQDNs that contains this value. Example: mail.example.com.
- `from` (`string`, optional): Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400. Example: 2026-11-01T00:00:00Z.
- `network_ids` (`string`, optional): Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
- `organization_ids` (`string`, optional): Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `security_report` (`string`, optional): Threats report true/false, *both* (threats and non-threats) if set to all. Example: all. One of: `all`, `true`, `false`.
- `source` (`string`, optional): Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all. clientless is only a valid, filterable value for organizations with the clientless feature flag enabled. Example: all. One of: `all`, `networks`, `agents`, `proxies`, `clientless`.
- `to` (`string`, optional): Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400. Example: 2026-11-07T23:59:59Z.
- `type` (`string`, optional): Type of report (all, allowed, blocked), defaults to all. Example: all. One of: `all`, `allowed`, `blocked`.
- `user_ids` (`string`, optional): Comma separated list of local user IDs, defaults to all. Example: 880,881.

Example input: `{}`

### `dnsfilter_top_networks_get`

Get Top Networks · Read-only

Get the networks (sites) with the most DNS requests for a period.
Returns networks with request counts.
Use this to compare sites.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `agent_ids` (`string`, optional): Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
- `from` (`string`, optional): Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400. Example: 2026-11-01T00:00:00Z.
- `name` (`string`, optional): Only networks whose name contains this value. Example: office.
- `network_ids` (`string`, optional): Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
- `organization_ids` (`string`, optional): Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `security_report` (`boolean`, optional): Threats report true/false, *both* (threats and non-threats) if it is empty or not sent. Example: true.
- `source` (`string`, optional): Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all. clientless is only a valid, filterable value for organizations with the clientless feature flag enabled. Example: all. One of: `all`, `networks`, `agents`, `proxies`, `clientless`.
- `to` (`string`, optional): Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400. Example: 2026-11-07T23:59:59Z.
- `type` (`string`, optional): Type of report (all, allowed, blocked), defaults to all. Example: all. One of: `all`, `allowed`, `blocked`.
- `user_ids` (`string`, optional): Comma separated list of local user IDs, defaults to all. Example: 880,881.

Example input: `{}`

### `dnsfilter_top_roaming_clients_get`

Get Top Roaming Clients · Read-only

Get the roaming clients with the most DNS requests for a period.
Returns clients with request counts.
Use this to find the busiest or riskiest devices.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `agent_ids` (`string`, optional): Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
- `from` (`string`, optional): Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400. Example: 2026-11-01T00:00:00Z.
- `name` (`string`, optional): Only user agents whose name contains this value. Example: office.
- `network_ids` (`string`, optional): Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
- `organization_ids` (`string`, optional): Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `security_report` (`boolean`, optional): Threats report true/false, *both* (threats and non-threats) if it is empty or not sent. Example: true.
- `source` (`string`, optional): Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all. clientless is only a valid, filterable value for organizations with the clientless feature flag enabled. Example: all. One of: `all`, `networks`, `agents`, `proxies`, `clientless`.
- `to` (`string`, optional): Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400. Example: 2026-11-07T23:59:59Z.
- `type` (`string`, optional): Type of report (all, allowed, blocked), defaults to all. Example: all. One of: `all`, `allowed`, `blocked`.
- `user_ids` (`string`, optional): Comma separated list of local user IDs, defaults to all. Example: 880,881.

Example input: `{}`

### `dnsfilter_top_users_get`

Get Top Users · Read-only

Get the local users with the most DNS requests for a period.
Returns users with request counts.
Use this to find the busiest or riskiest users.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `agent_ids` (`string`, optional): Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
- `from` (`string`, optional): Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400. Example: 2026-11-01T00:00:00Z.
- `name` (`string`, optional): Only local users whose name contains this value. Example: office.
- `network_ids` (`string`, optional): Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
- `organization_ids` (`string`, optional): Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `security_report` (`boolean`, optional): Threats report true/false, *both* (threats and non-threats) if it is empty or not sent. Example: true.
- `source` (`string`, optional): Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all. clientless is only a valid, filterable value for organizations with the clientless feature flag enabled. Example: all. One of: `all`, `networks`, `agents`, `proxies`, `clientless`.
- `to` (`string`, optional): Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400. Example: 2026-11-07T23:59:59Z.
- `type` (`string`, optional): Type of report (all, allowed, blocked), defaults to all. Example: all. One of: `all`, `allowed`, `blocked`.
- `user_ids` (`string`, optional): Comma separated list of local user IDs, defaults to all. Example: 880,881.

Example input: `{}`

### `dnsfilter_total_requests_get`

Get Total Requests · Read-only

Get DNS request counts over time for a period, split into time buckets.
Returns the allowed, blocked and total request counts per bucket.
Use this for traffic trends. Use dnsfilter_total_threats_get for threats only.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `agent_ids` (`string`, optional): Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
- `bucket_size` (`string`, optional): Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto* *Auto*: If report from/to range is less than 24 hours (ex.: "Today" and "Yesterday"), bucket size is fifteen minutes If report from/to range is greater than 24 hours (ex.: "Last 7 days" and "Last 14 days"), bucket size is one day. Example: 1day.
- `from` (`string`, optional): Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400. Example: 2026-11-01T00:00:00Z.
- `network_ids` (`string`, optional): Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
- `organization_ids` (`string`, optional): Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
- `security_report` (`boolean`, optional): Threats report true/false, *both* (threats and non-threats) if it is empty or not sent. Example: true.
- `show_individual_networks` (`boolean`, optional): Group report result by network id, defaults to false. Example: true.
- `source` (`string`, optional): Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all. clientless is only a valid, filterable value for organizations with the clientless feature flag enabled. Example: all. One of: `all`, `networks`, `agents`, `proxies`, `clientless`.
- `to` (`string`, optional): Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400. Example: 2026-11-07T23:59:59Z.
- `type` (`string`, optional): Type of report (all, allowed, blocked), defaults to all. Example: all. One of: `all`, `allowed`, `blocked`.
- `user_ids` (`string`, optional): Comma separated list of local user IDs, defaults to all. Example: 880,881.

Example input: `{}`

### `dnsfilter_total_threats_get`

Get Total Threats · Read-only

Get counts of security threats blocked over time for a period, split into time buckets.
Returns the threat counts per bucket.
Use this for threat trends. Use dnsfilter_query_logs_list with security_report true for the queries.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `agent_ids` (`string`, optional): Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
- `bucket_size` (`string`, optional): Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto* *Auto*: If report from/to range is less than 24 hours (ex.: "Today" and "Yesterday"), bucket size fifteen minutes If report from/to range is greater than 24 hours (ex.: "Last 7 days" and "Last 14 days"), bucket size is one day. Example: 1day.
- `from` (`string`, optional): Report UTC lower limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (start of that day); defaults to current UTC datetime minus 1 day; an unrecognized format returns a 400. Example: 2026-11-01T00:00:00Z.
- `network_ids` (`string`, optional): Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
- `organization_ids` (`string`, optional): Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
- `show_individual_networks` (`boolean`, optional): Group report result by network id, defaults to false. Example: true.
- `source` (`string`, optional): Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all. clientless is only a valid, filterable value for organizations with the clientless feature flag enabled. Example: all. One of: `all`, `networks`, `agents`, `proxies`, `clientless`.
- `to` (`string`, optional): Report UTC upper limit. Accepts YYYY-MM-DDThh:mm:ss[Z], YYYY-MM-DDThh:mm[Z], or a bare YYYY-MM-DD date (end of that day, inclusive); defaults to current UTC datetime; an unrecognized format returns a 400. Example: 2026-11-07T23:59:59Z.
- `type` (`string`, optional): Type of report (all, allowed, blocked), defaults to all. Example: all. One of: `all`, `allowed`, `blocked`.
- `user_ids` (`string`, optional): Comma separated list of local user IDs, defaults to all. Example: 880,881.

Example input: `{}`

### `dnsfilter_unblock_request_get`

Get Unblock Request · Read-only

Get one unblock request with everything needed to decide on it.
Returns the request context and the allowlists it could be added to.
Use this before dnsfilter_unblock_request_decide.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Unblock request UUID. Example: 12345.

Example input: `{"id":"<id>"}`

### `dnsfilter_unblock_requests_list`

List Unblock Requests · Read-only

List users' requests to unblock sites, on the active tab (pending) or the history tab.
Returns requests with ID, domain, requester, policy, site, reason, time and status.
Use this to review the unblock queue. Use dnsfilter_unblock_request_decide to act on one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `msp_id` (`integer`, optional): MSP ID. When provided, returns requests across all organizations belonging to this MSP. Example: 10.
- `organization_id` (`integer`, optional): Organization ID. Optional. Omit for the caller's full administrable set (all EDIT_POLICIES orgs, including MSP-inherited). Example: 4567.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page. Example: 25.
- `search` (`string`, optional): Free-text search across the tab's text-bearing columns. Example: office.
- `sort` (`string`, optional): JSON:API sort, comma separated, "-" prefix for descending (e.g. "-decided_at,domain"). Allowed: requested_at, decided_at, status, domain, policy_name, logged_in_user_name, requester_name, requester_email, organization_name, site_name, deployment_name, deployment_type, actioned_by. Example: -last_seen.
- `tab` (`string`, optional): Which grid to populate: "active" (default) or "history". Example: active.

Example input: `{}`

### `dnsfilter_block_page_create`

Create Block Page · Write

Create a DNSFilter block page with the organization name and contact email to show.
Returns the created block page.
Use this to brand what users see when a site is blocked.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Block page name. Example: Acme block page.
- `block_email_addr` (`string`, optional): Contact email shown on the block page. Example: it@acme.com.
- `block_org_name` (`string`, optional): Organization name shown on the block page. Example: Acme IT.
- `organization_id` (`integer`, optional): ID of the organization that owns the block page. Example: 4567.

Example input: `{"name":"<name>"}`

### `dnsfilter_block_page_update`

Update Block Page · Write

Update a DNSFilter block page's name, organization name or contact email.
Returns the updated block page.
Use this to change what blocked users see.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): BlockPage ID. Example: 12345.
- `name` (`string`, required): Block page name. Example: Acme block page.
- `block_email_addr` (`string`, optional): Contact email shown on the block page. Example: it@acme.com.
- `block_org_name` (`string`, optional): Organization name shown on the block page. Example: Acme IT.
- `organization_id` (`integer`, optional): ID of the organization that owns the block page. Example: 4567.

Example input: `{"id":12345,"name":"<name>"}`

### `dnsfilter_ip_address_create`

Add IP Address · Write

Register a public IP address (or dynamic hostname) to a DNSFilter network so its DNS traffic is filtered.
Returns the created IP address.
Use this to add an IP to an existing site.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `address` (`string`, required): Public IPv4 or IPv6 address. Example: 203.0.113.10.
- `network_id` (`integer`, required): ID of the network to add it to. Example: 2201.
- `organization_id` (`integer`, required): ID of the network's organization. Example: 4567.
- `dynamic_hostname` (`string`, optional): Dynamic DNS hostname that tracks the IP, for sites without a static IP. Example: office.dyndns.org.

Example input: `{"address":"<address>","network_id":2201,"organization_id":4567}`

### `dnsfilter_network_create`

Create Network · Write

Create a DNSFilter network (site) whose DNS traffic is filtered by its policies.
Returns the created network with its ID.
Use this to protect a new site. Use dnsfilter_ip_address_create to add more public IPs later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Network (site) name. Example: Head office.
- `organization_id` (`integer`, required): ID of the organization the network belongs to, from dnsfilter_organizations_list. Example: 4567.
- `block_page_id` (`integer`, optional): ID of the block page to show when a site is blocked. Example: 55.
- `external_id` (`string`, optional): Your own ID for the network. Example: site-001.
- `ip_addresses_attributes` (`array`, optional): Public IP addresses to add to the network, each an object with address and an optional dynamic_hostname. Example: [{"address": "203.0.113.10"}]
- `local_domains` (`array`, optional): Local domains resolved by the local resolvers. Example: ["corp.local"]
- `local_resolvers` (`array`, optional): IP addresses of local DNS resolvers for the local domains. Example: ["10.0.0.2"]
- `physical_address` (`string`, optional): Street address of the site. Example: 1 Main St, Austin, TX.
- `policy_ids` (`array`, optional): IDs of the policies to apply to the network. Example: [901]

Example input: `{"name":"<name>","organization_id":4567}`

### `dnsfilter_network_update`

Update Network · Write

Update a DNSFilter network (site): name, policies, block page, address or local resolvers; name and organization_id are required.
Returns the updated network.
Use this to change a site's policy or settings.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Network ID. Example: 12345.
- `name` (`string`, required): Network (site) name. Example: Head office.
- `organization_id` (`integer`, required): ID of the organization the network belongs to, from dnsfilter_organizations_list. Example: 4567.
- `block_page_id` (`integer`, optional): ID of the block page to show when a site is blocked. Example: 55.
- `external_id` (`string`, optional): Your own ID for the network. Example: site-001.
- `ip_addresses_attributes` (`array`, optional): Public IP addresses to add to the network, each an object with address and an optional dynamic_hostname. Example: [{"address": "203.0.113.10"}]
- `local_domains` (`array`, optional): Local domains resolved by the local resolvers. Example: ["corp.local"]
- `local_resolvers` (`array`, optional): IP addresses of local DNS resolvers for the local domains. Example: ["10.0.0.2"]
- `physical_address` (`string`, optional): Street address of the site. Example: 1 Main St, Austin, TX.
- `policy_ids` (`array`, optional): IDs of the policies to apply to the network. Example: [901]

Example input: `{"id":12345,"name":"<name>","organization_id":4567}`

### `dnsfilter_organization_update`

Update Organization · Write

Update a DNSFilter organization's name, billing contact or address.
Returns the updated organization.
Use this to change organization details; name and managed_by_msp_id are required on every update.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Organization ID. Example: 12345.
- `managed_by_msp_id` (`integer`, required): ID of the MSP that manages the organization; send its current value to keep it. Example: 321.
- `name` (`string`, required): Organization name. Example: Acme Inc.
- `address` (`string`, optional): Organization address. Example: 1 Main St, Austin, TX.
- `billing_contact_email` (`string`, optional): Billing contact email. Example: billing@acme.com.
- `billing_contact_name` (`string`, optional): Billing contact name. Example: Jane Doe.
- `billing_contact_phone` (`string`, optional): Billing contact phone. Example: +15125550123.

Example input: `{"id":12345,"managed_by_msp_id":321,"name":"<name>"}`

### `dnsfilter_organization_user_add`

Add Organization User · Write

Add a new or existing dashboard user to a DNSFilter organization by email; new users get an invite.
Returns the added user.
Use this to give someone dashboard access. Use dnsfilter_organization_user_remove to revoke it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): User's email address. Example: jane@acme.com.
- `organization_id` (`integer`, required): The ID of the organization. Example: 4567.
- `first_name` (`string`, optional): First name. Example: Jane.
- `last_name` (`string`, optional): Last name. Example: Doe.
- `role` (`string`, optional): Dashboard role, such as owner, super_administrator, administrator, policy_manager or read_only. Example: read_only.

Example input: `{"email":"<email>","organization_id":4567}`

### `dnsfilter_policy_allow_domain_add`

Add Allowed Domain · Write

Add one domain to a DNSFilter policy's allowlist.
Returns the updated policy.
Use this to always allow a site. Use dnsfilter_policy_allow_domain_remove to undo it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `domain` (`string`, required): Domain to allow. Example: badsite.com.
- `id` (`integer`, required): Policy ID. Example: 12345.
- `note` (`string`, required): Note explaining the change. Example: Requested by IT ticket 4521.
- `include_relationships` (`boolean`, optional): Include related objects in the response (default true). Example: false.

Example input: `{"domain":"<domain>","id":12345,"note":"<note>"}`

### `dnsfilter_policy_allow_domain_remove`

Remove Allowed Domain · Write

Remove one domain from a DNSFilter policy's allowlist.
Returns the updated policy.
Use this to stop always allowing a site.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `domain` (`string`, required): Domain to remove from the allowlist. Example: badsite.com.
- `id` (`integer`, required): Policy ID. Example: 12345.
- `note` (`string`, required): Note explaining the change. Example: Requested by IT ticket 4521.
- `include_relationships` (`boolean`, optional): Include related objects in the response (default true). Example: false.

Example input: `{"domain":"<domain>","id":12345,"note":"<note>"}`

### `dnsfilter_policy_block_application_add`

Add Blocked Application · Write

Block one application in a DNSFilter policy.
Returns the updated policy.
Use this to block an app such as TikTok. Use dnsfilter_applications_list for names.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Policy ID. Example: 12345.
- `name` (`string`, required): Name of the application to block, from dnsfilter_applications_list. Example: TikTok.
- `include_relationships` (`boolean`, optional): Include related objects in the response (default true). Example: false.

Example input: `{"id":12345,"name":"<name>"}`

### `dnsfilter_policy_block_application_remove`

Remove Blocked Application · Write

Unblock one application in a DNSFilter policy.
Returns the updated policy.
Use this to undo dnsfilter_policy_block_application_add.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Policy ID. Example: 12345.
- `name` (`string`, required): Name of the application to unblock. Example: TikTok.
- `include_relationships` (`boolean`, optional): Include related objects in the response (default true). Example: false.

Example input: `{"id":12345,"name":"<name>"}`

### `dnsfilter_policy_block_category_add`

Add Blocked Category · Write

Block one content category in a DNSFilter policy.
Returns the updated policy.
Use this to block a category such as gambling. Use dnsfilter_categories_list for category IDs.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category_id` (`integer`, required): ID of the category to block, from dnsfilter_categories_list. Example: 12.
- `id` (`integer`, required): Policy ID. Example: 12345.
- `include_relationships` (`boolean`, optional): Include related objects in the response (default true). Example: false.

Example input: `{"category_id":12,"id":12345}`

### `dnsfilter_policy_block_category_remove`

Remove Blocked Category · Write

Unblock one content category in a DNSFilter policy.
Returns the updated policy.
Use this to undo dnsfilter_policy_block_category_add.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category_id` (`integer`, required): ID of the category to unblock. Example: 12.
- `id` (`integer`, required): Policy ID. Example: 12345.
- `include_relationships` (`boolean`, optional): Include related objects in the response (default true). Example: false.

Example input: `{"category_id":12,"id":12345}`

### `dnsfilter_policy_block_domain_add`

Add Blocked Domain · Write

Add one domain to a DNSFilter policy's blocklist.
Returns the updated policy.
Use this to block a site. Use dnsfilter_policy_block_domain_remove to undo it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `domain` (`string`, required): Domain to block. Example: badsite.com.
- `id` (`integer`, required): Policy ID. Example: 12345.
- `note` (`string`, required): Note explaining the change. Example: Requested by IT ticket 4521.
- `include_relationships` (`boolean`, optional): Include related objects in the response (default true). Example: false.

Example input: `{"domain":"<domain>","id":12345,"note":"<note>"}`

### `dnsfilter_policy_block_domain_remove`

Remove Blocked Domain · Write

Remove one domain from a DNSFilter policy's blocklist.
Returns the updated policy.
Use this to unblock a site you blocked.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `domain` (`string`, required): Domain to remove from the blocklist. Example: badsite.com.
- `id` (`integer`, required): Policy ID. Example: 12345.
- `note` (`string`, required): Note explaining the change. Example: Requested by IT ticket 4521.
- `include_relationships` (`boolean`, optional): Include related objects in the response (default true). Example: false.

Example input: `{"domain":"<domain>","id":12345,"note":"<note>"}`

### `dnsfilter_policy_create`

Create Policy · Write

Create a DNSFilter filtering policy with blocked categories, applications and domains and SafeSearch settings.
Returns the created policy with its ID.
Use this for a new policy. Use the add and remove tools to change one list entry at a time.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Policy name. Example: Default office policy.
- `organization_id` (`integer`, required): ID of the organization the policy belongs to. Example: 4567.
- `allow_applications` (`array`, optional): Names of applications to allow. Example: ["Zoom"]
- `allow_list_only` (`boolean`, optional): Block everything except the allowlist. Example: false.
- `allow_unknown_domains` (`boolean`, optional): Allow domains that DNSFilter has not categorized yet. Example: true.
- `bing_safe_search` (`boolean`, optional): Enforce Bing SafeSearch. Example: true.
- `blacklist_categories` (`array`, optional): IDs of categories to block, from dnsfilter_categories_list. Example: [12, 33]
- `blacklist_domains` (`array`, optional): Domains to block. Example: ["badsite.com"]
- `block_applications` (`array`, optional): Names of applications to block, from dnsfilter_applications_list. Example: ["TikTok"]
- `blocked_countries` (`array`, optional): Country codes whose domains to block. Example: ["KP"]
- `google_safesearch` (`boolean`, optional): Enforce Google SafeSearch. Example: true.
- `interstitial` (`boolean`, optional): Show an interstitial page instead of a hard block. Example: false.
- `whitelist_domains` (`array`, optional): Domains to always allow. Example: ["partner.com"]
- `youtube_restricted` (`boolean`, optional): Enforce YouTube Restricted Mode. Example: true.
- `youtube_restricted_level` (`string`, optional): YouTube Restricted Mode level: strict or none. Example: strict. One of: `strict`, `none`.

Example input: `{"name":"<name>","organization_id":4567}`

### `dnsfilter_policy_permissive_mode_update`

Update Policy Permissive Mode · Write

Turn permissive mode on or off for a DNSFilter policy; in permissive mode traffic is logged but not blocked.
Returns the new permissive mode value.
Use this to test a policy without blocking users.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Policy ID. Example: 12345.
- `permissive_mode` (`boolean`, required): Updated permissive mode value. Example: true.

Example input: `{"id":12345,"permissive_mode":true}`

### `dnsfilter_policy_update`

Update Policy · Write

Update a DNSFilter policy's settings and lists; name and organization_id are required. Domain lists replace the stored ones unless append_domains is true.
Returns the updated policy.
Use this for bulk changes. Use dnsfilter_policy_block_domain_add and similar tools for one entry.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Policy ID. Example: 12345.
- `name` (`string`, required): Policy name. Example: Default office policy.
- `organization_id` (`integer`, required): ID of the organization the policy belongs to. Example: 4567.
- `allow_applications` (`array`, optional): Names of applications to allow. Example: ["Zoom"]
- `allow_list_only` (`boolean`, optional): Block everything except the allowlist. Example: false.
- `allow_unknown_domains` (`boolean`, optional): Allow domains that DNSFilter has not categorized yet. Example: true.
- `append_domains` (`boolean`, optional): True appends the allowlist and blocklist domains to the existing ones instead of replacing them. Example: true.
- `bing_safe_search` (`boolean`, optional): Enforce Bing SafeSearch. Example: true.
- `blacklist_categories` (`array`, optional): IDs of categories to block, from dnsfilter_categories_list. Example: [12, 33]
- `blacklist_domains` (`array`, optional): Domains to block. Example: ["badsite.com"]
- `block_applications` (`array`, optional): Names of applications to block, from dnsfilter_applications_list. Example: ["TikTok"]
- `blocked_countries` (`array`, optional): Country codes whose domains to block. Example: ["KP"]
- `google_safesearch` (`boolean`, optional): Enforce Google SafeSearch. Example: true.
- `interstitial` (`boolean`, optional): Show an interstitial page instead of a hard block. Example: false.
- `whitelist_domains` (`array`, optional): Domains to always allow. Example: ["partner.com"]
- `youtube_restricted` (`boolean`, optional): Enforce YouTube Restricted Mode. Example: true.
- `youtube_restricted_level` (`string`, optional): YouTube Restricted Mode level: strict or none. Example: strict. One of: `strict`, `none`.

Example input: `{"id":12345,"name":"<name>","organization_id":4567}`

### `dnsfilter_roaming_client_update`

Update Roaming Client · Write

Update a DNSFilter roaming client's name, status, policy, scheduled policy, block page or network.
Returns the updated client.
Use this to change a device's policy or disable it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): User agent UUID. Example: 12345.
- `block_page_id` (`integer`, optional): ID of the block page for the client. Example: 55.
- `friendly_name` (`string`, optional): Display name of the roaming client. Example: Jane's laptop.
- `network_id` (`integer`, optional): ID of the network (site) to associate the client with. Example: 2201.
- `policy_id` (`integer`, optional): ID of the policy to apply to the client. Example: 901.
- `scheduled_policy_id` (`integer`, optional): ID of the scheduled policy to apply to the client. Example: 77.
- `status` (`string`, optional): Client status: active, disabled or uninstalled. Example: active. One of: `active`, `disabled`, `uninstalled`.

Example input: `{"id":"<id>"}`

### `dnsfilter_unblock_request_decide`

Decide Unblock Request · Write

Allow, deny or resolve a pending DNSFilter unblock request; allowing adds the domains to the request's policy (or the universal allowlist).
Returns the updated request.
Use this to act on the unblock queue.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `decision` (`string`, required): Action: allow, allow-universal, deny, deny-and-ignore or resolve-already-allowed. Example: allow. One of: `allow`, `allow-universal`, `deny`, `deny-and-ignore`, `resolve-already-allowed`.
- `id` (`string`, required): Unblock request UUID. Example: 12345.
- `domains` (`array`, optional): Allow and allow-universal only: the domains to add to the allowlist. Defaults to the requested domain. Example: ["example.com"]
- `internal_notes` (`string`, optional): Admin-only notes, up to 512 characters. Example: Approved by IT lead.
- `message` (`string`, optional): Deny only: message to the requester, up to 500 characters. Example: This site is not needed for work.

Example input: `{"decision":"allow","id":"<id>"}`

### `dnsfilter_block_page_delete`

Delete Block Page · Destructive

Delete a DNSFilter block page.
Returns an empty success response.
Use this to remove a block page no network or client uses.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): BlockPage ID. Example: 12345.

Example input: `{"id":12345}`

### `dnsfilter_ip_address_delete`

Delete IP Address · Destructive

Remove a public IP address from its DNSFilter network.
Returns an empty success response.
Use this when a site no longer uses an IP.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): IP address ID. Example: 12345.

Example input: `{"id":12345}`

### `dnsfilter_network_delete`

Delete Network · Destructive

Delete a DNSFilter network (site); its traffic is no longer filtered.
Returns an empty success response.
Use this to remove a site for good.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Network ID. Example: 12345.

Example input: `{"id":12345}`

### `dnsfilter_organization_user_remove`

Remove Organization User · Destructive

Remove a dashboard user from a DNSFilter organization; the user account itself is not deleted.
Returns an empty success response.
Use this to revoke a user's access to one organization.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the dashboard user to remove, from dnsfilter_organization_users_list. Example: 12345.
- `organization_id` (`integer`, required): ID of the organization. Example: 4567.

Example input: `{"id":12345,"organization_id":4567}`

### `dnsfilter_policy_delete`

Delete Policy · Destructive

Delete a DNSFilter policy.
Returns an empty success response.
Use this to remove a policy that no network or client uses.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Policy ID. Example: 12345.

Example input: `{"id":12345}`

### `dnsfilter_roaming_client_delete`

Delete Roaming Client · Destructive

Delete a DNSFilter roaming client record.
Returns an empty success response.
Use this to remove a device that is gone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): User agent UUID. Example: 12345.
- `clear_registry` (`boolean`, optional): Clear registry when uninstalling user agent. Example: true.
- `queue_uninstall` (`boolean`, optional): Uninstall user agent. Example: true.

Example input: `{"id":"<id>"}`

## Related

Other Monitoring connectors ([all 48](/agentkit/connectors/?category=monitoring)):

- [Datadog](/agentkit/connectors/datadog/): Scalekit connector, API key, 105 tools
- [1Password](/agentkit/connectors/onepassword/): Scalekit connector, Access token, 4 tools
- [Malwarebytes](/agentkit/connectors/malwarebytes/): Scalekit connector, Service account, 74 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
