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.
- Tools
- 59
- What they doRead · write · destructive
- 33 · 20 · 633 read20 write6 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the DNSFilter connection
In AgentKit > Connections, create a DNSFilter connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'dnsfilter'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'dnsfilter_current_user_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "dnsfilter"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="dnsfilter_current_user_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their DNSFilter credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooldnsfilter_agent_local_user_getGet one local device user seen by DNSFilter roaming clients.Read-onlyGet Agent Local User
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.
Inputs
idintegerrequired- Agent local user ID. Example: 12345.
dnsfilter_agent_local_users_listList the local device users seen by DNSFilter roaming clients.Read-onlyList Agent Local Users
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.
Inputs
msp_idinteger- MSP ID. When provided, returns agent local users across all organizations belonging to this MSP. Example: 10.
namestring- filter by name. If friendly_name not found, will search by user_name. Example: office.
organization_idsstring- 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_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
searchstring- Filter by name or user_login. Example: office.
sortstring- Sort options, valid attributes: name, first_seen, last_seen. Prefix with - for descending (e.g. -first_seen). Example: -last_seen.
dnsfilter_applications_listList the applications DNSFilter can block or allow.Read-onlyList Applications
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.
Inputs
category_idsstring- Category IDs, defaults to all. Comma-separated. Example: 12,33.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
dnsfilter_block_page_getGet one DNSFilter block page.Read-onlyGet Block Page
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.
Inputs
idintegerrequired- BlockPage ID. Example: 12345.
include_relationshipsboolean- Include relationships in the response true/false, defaults to true. Example: true.
dnsfilter_block_pages_listList the DNSFilter block pages, shown to users when a site is blocked.Read-onlyList Block Pages
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.
Inputs
organization_idinteger- Organization ID. Example: 4567.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
dnsfilter_categories_listList all DNSFilter content categories.Read-onlyList Categories
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.
Inputs
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
dnsfilter_current_user_getGet the DNSFilter user the API key belongs to.Read-onlyGet Current User
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.
Inputs
This tool takes no inputs.
dnsfilter_domain_lookupLook up how DNSFilter categorizes a domain or FQDN.Read-onlyLook Up Domain
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.
Inputs
fqdnstring- FQDN to lookup. Example: mail.example.com.
dnsfilter_ip_address_getGet one IP address registered in DNSFilter.Read-onlyGet IP Address
Get one IP address registered in DNSFilter. Returns the address with its network, organization and dynamic hostname. Use this for an IP's details.
Inputs
idintegerrequired- IP address ID. Example: 12345.
dnsfilter_ip_addresses_listList the public IP addresses registered to DNSFilter networks.Read-onlyList IP Addresses
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.
Inputs
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
searchstring- Search specific IP information. Example: office.
dnsfilter_network_getGet one DNSFilter network (site).Read-onlyGet Network
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.
Inputs
idintegerrequired- Network ID. Example: 12345.
count_network_ipsboolean- Return count of IP Addresses. Defaults to False. Example: true.
dnsfilter_network_lookupFind the DNSFilter network that a public IP address belongs to.Read-onlyLook Up Network by IP
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.
Inputs
requesting_ip_addressstringrequired- IP address to lookup. Example: 203.0.113.10.
dnsfilter_networks_listList the DNSFilter networks (sites) the user can access.Read-onlyList Networks
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.
Inputs
basic_infoboolean- Return most basic Network Info only. Defaults to False. Example: true.
count_network_ipsboolean- Return count of IP Addresses. Defaults to False. Example: true.
force_truncate_ipsboolean- Return Network info without IP Addresses. Defaults to False. Example: true.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
protectedboolean- Filter networks with assigned policy. Example: true.
searchstring- Search for the given value among the network name, hostname, ip address, etc. Example: office.
unprotectedboolean- Filter networks without assigned policy. Example: true.
dnsfilter_organization_getGet one DNSFilter organization.Read-onlyGet Organization
Get one DNSFilter organization. Returns the organization with name, type, billing contact, address and settings. Use this for an organization's details.
Inputs
idintegerrequired- Organization ID. Example: 12345.
include_current_mrrboolean- Optionally Include current MRR information. Example: true.
dnsfilter_organization_users_listList the dashboard users of a DNSFilter organization.Read-onlyList Organization Users
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.
Inputs
organization_idintegerrequired- The ID of the organization to search. Example: 4567.
include_auth_providersboolean- Return user's authentication providers if true (default: false). Example: true.
dnsfilter_organizations_listList the DNSFilter organizations the user can access, including MSP sub-organizations.Read-onlyList Organizations
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.
Inputs
basic_infoboolean- just return organizations basic info true/false, defaults to false. Example: true.
managed_by_msp_idinteger- MSPs sub-organizations whose MSP ID matches this value. Example: 10.
namestring- Filter by organization name. Example: office.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
typestring- Filter by organization type. Example: normal.one of
normalmspsub_organization
dnsfilter_policies_listList the DNSFilter filtering policies the user can access.Read-onlyList Policies
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.
Inputs
include_global_policiesboolean- include global policies to listing. Example: true.
organization_idinteger- Organization ID. Example: 4567.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
dnsfilter_policy_getGet one DNSFilter policy.Read-onlyGet Policy
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.
Inputs
idintegerrequired- Policy ID. Example: 12345.
include_relationshipsboolean- Include relationships in the response true/false, defaults to true. Example: true.
dnsfilter_policy_permissive_mode_getGet whether permissive mode is on for a DNSFilter policy; in permissive mode traffic is logged but not blocked.Read-onlyGet Policy Permissive Mode
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.
Inputs
idintegerrequired- Policy ID. Example: 12345.
dnsfilter_query_logs_listList 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.Read-onlyList Query Logs
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.
Inputs
agent_idstring- User agent UUID. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
category_idsstring- Comma separated list of category IDs to include, defaults to all. Example: 12,33.
domainstring- Only returns records whose registered domain exactly matches this value (case insensitive); can be combined with exclude_domain. Example: example.com.
fqdnstring- search for FQDNs that contains this value. Example: mail.example.com.
fromstring- 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_idinteger- Network ID. Example: 10.
network_idsstring- Comma separated list of networks IDs. Example: 2201,2202.
organization_idinteger- Organization ID, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
policy_idsstring- Comma separated list of policy IDs, defaults to all. Example: 901.
question_typestring- Question Type of queries (exact match); comma separated for multiple values, defaults to all. Example: A.
resultstring- Type of report (all, blocked only, allowed only), defaults to all. Example: all.one of
allallowedblocked security_reportboolean- Threats report true/false, *both* (threats and non-threats) if it is empty or not sent. Example: true.
sourcestring- 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
allnetworksagentsproxiesclientless tostring- 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_idinteger- User local ID. Example: 10.
dnsfilter_roaming_client_getGet one DNSFilter roaming client.Read-onlyGet Roaming Client
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.
Inputs
idstringrequired- User agent UUID. Example: 12345.
dnsfilter_roaming_clients_listList DNSFilter roaming clients (agents installed on devices), filtered by state, policy, network or keyword.Read-onlyList Roaming Clients
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.
Inputs
agent_statestring- filter by agent state. Example: protected.one of
protectedunprotectedbypassedpending_uninstalluninstalledoffline network_idsstring- Networks IDs, defaults to all. Comma-separated. Example: 2201,2202.
organization_idsstring- Organization IDs, defaults to user organization ID. Comma-separated. Example: 4567.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
policy_idinteger- Filter user agents by policy ID. Example: 10.
searchstring- User agent list by keyword(s) (space delimited), this could be: status, hostname, friendly name, current logged in user. Example: office.
sortstring- Sort options, valid attributes: hostname, friendly_name, agent_version, last_sync, agent_state, vpn_status, private_network (connected, not_connected, disabled). Example: -last_seen.
statestring- filter by user agent online/offline state. Example: online.one of
onlineoffline statusstring- filter by user agent status, valid attributes: active, disabled, uninstalled, uninstall_queued, uninstalling. Example: active.
typestring- User agent type, defaults to non-proxy/no-relays user agents. Example: proxy.one of
proxyagents
dnsfilter_scheduled_policies_listList the DNSFilter scheduled policies, which switch policies by time of day and weekday.Read-onlyList Scheduled Policies
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.
Inputs
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
dnsfilter_scheduled_policy_getGet one DNSFilter scheduled policy.Read-onlyGet Scheduled Policy
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.
Inputs
idintegerrequired- ScheduledPolicy ID. Example: 12345.
dnsfilter_top_categories_getGet the most requested content categories for a period.Read-onlyGet Top Categories
Get the most requested content categories for a period. Returns categories with request counts. Use this to see what kind of content users reach.
Inputs
agent_idsstring- Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
fromstring- 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.
namestring- Only categories whose name contains this value. Example: office.
network_idsstring- Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
organization_idsstring- Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
security_reportstring- Threats report true/false, *both* (threats and non-threats) if set to all. Example: all.one of
alltruefalse sourcestring- 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
allnetworksagentsproxiesclientless tostring- 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.
typestring- Type of report (all, allowed, blocked), defaults to all. Example: all.one of
allallowedblocked user_idsstring- Comma separated list of local user IDs, defaults to all. Example: 880,881.
dnsfilter_top_domains_getGet the most requested domains for a period, optionally only allowed or blocked ones.Read-onlyGet Top Domains
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.
Inputs
agent_idsstring- Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
domainstring- Only search for domains that starts with this value. Example: example.com.
fqdnstring- search for FQDNs that contains this value. Example: mail.example.com.
fromstring- 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_idsstring- Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
organization_idsstring- Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
security_reportstring- Threats report true/false, *both* (threats and non-threats) if set to all. Example: all.one of
alltruefalse sourcestring- 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
allnetworksagentsproxiesclientless tostring- 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.
typestring- Type of report (all, allowed, blocked), defaults to all. Example: all.one of
allallowedblocked user_idsstring- Comma separated list of local user IDs, defaults to all. Example: 880,881.
dnsfilter_top_networks_getGet the networks (sites) with the most DNS requests for a period.Read-onlyGet Top Networks
Get the networks (sites) with the most DNS requests for a period. Returns networks with request counts. Use this to compare sites.
Inputs
agent_idsstring- Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
fromstring- 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.
namestring- Only networks whose name contains this value. Example: office.
network_idsstring- Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
organization_idsstring- Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
security_reportboolean- Threats report true/false, *both* (threats and non-threats) if it is empty or not sent. Example: true.
sourcestring- 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
allnetworksagentsproxiesclientless tostring- 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.
typestring- Type of report (all, allowed, blocked), defaults to all. Example: all.one of
allallowedblocked user_idsstring- Comma separated list of local user IDs, defaults to all. Example: 880,881.
dnsfilter_top_roaming_clients_getGet the roaming clients with the most DNS requests for a period.Read-onlyGet Top Roaming Clients
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.
Inputs
agent_idsstring- Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
fromstring- 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.
namestring- Only user agents whose name contains this value. Example: office.
network_idsstring- Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
organization_idsstring- Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
security_reportboolean- Threats report true/false, *both* (threats and non-threats) if it is empty or not sent. Example: true.
sourcestring- 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
allnetworksagentsproxiesclientless tostring- 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.
typestring- Type of report (all, allowed, blocked), defaults to all. Example: all.one of
allallowedblocked user_idsstring- Comma separated list of local user IDs, defaults to all. Example: 880,881.
dnsfilter_top_users_getGet the local users with the most DNS requests for a period.Read-onlyGet Top Users
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.
Inputs
agent_idsstring- Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
fromstring- 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.
namestring- Only local users whose name contains this value. Example: office.
network_idsstring- Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
organization_idsstring- Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
security_reportboolean- Threats report true/false, *both* (threats and non-threats) if it is empty or not sent. Example: true.
sourcestring- 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
allnetworksagentsproxiesclientless tostring- 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.
typestring- Type of report (all, allowed, blocked), defaults to all. Example: all.one of
allallowedblocked user_idsstring- Comma separated list of local user IDs, defaults to all. Example: 880,881.
dnsfilter_total_requests_getGet DNS request counts over time for a period, split into time buckets.Read-onlyGet Total Requests
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.
Inputs
agent_idsstring- Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
bucket_sizestring- 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.
fromstring- 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_idsstring- Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
organization_idsstring- Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
security_reportboolean- Threats report true/false, *both* (threats and non-threats) if it is empty or not sent. Example: true.
show_individual_networksboolean- Group report result by network id, defaults to false. Example: true.
sourcestring- 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
allnetworksagentsproxiesclientless tostring- 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.
typestring- Type of report (all, allowed, blocked), defaults to all. Example: all.one of
allallowedblocked user_idsstring- Comma separated list of local user IDs, defaults to all. Example: 880,881.
dnsfilter_total_threats_getGet counts of security threats blocked over time for a period, split into time buckets.Read-onlyGet Total Threats
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.
Inputs
agent_idsstring- Comma separated list of user agent UUIDs, defaults to all. Example: 3f2b8c1e-7d4a-4b9e-9a51-2c6d8e0f1a23.
bucket_sizestring- 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.
fromstring- 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_idsstring- Comma separated list of networks IDs, defaults to all. Example: 2201,2202.
organization_idsstring- Comma separated list of organization IDs, defaults to user organization ID. An inaccessible or unknown ID returns a 403. Example: 4567.
show_individual_networksboolean- Group report result by network id, defaults to false. Example: true.
sourcestring- 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
allnetworksagentsproxiesclientless tostring- 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.
typestring- Type of report (all, allowed, blocked), defaults to all. Example: all.one of
allallowedblocked user_idsstring- Comma separated list of local user IDs, defaults to all. Example: 880,881.
dnsfilter_unblock_request_getGet one unblock request with everything needed to decide on it.Read-onlyGet Unblock Request
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.
Inputs
idstringrequired- Unblock request UUID. Example: 12345.
dnsfilter_unblock_requests_listList users' requests to unblock sites, on the active tab (pending) or the history tab.Read-onlyList Unblock Requests
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.
Inputs
msp_idinteger- MSP ID. When provided, returns requests across all organizations belonging to this MSP. Example: 10.
organization_idinteger- Organization ID. Optional. Omit for the caller's full administrable set (all EDIT_POLICIES orgs, including MSP-inherited). Example: 4567.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 25.
searchstring- Free-text search across the tab's text-bearing columns. Example: office.
sortstring- 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.
tabstring- Which grid to populate: "active" (default) or "history". Example: active.
dnsfilter_block_page_createCreate a DNSFilter block page with the organization name and contact email to show.WriteCreate Block Page
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.
Inputs
namestringrequired- Block page name. Example: Acme block page.
block_email_addrstring- Contact email shown on the block page. Example: it@acme.com.
block_org_namestring- Organization name shown on the block page. Example: Acme IT.
organization_idinteger- ID of the organization that owns the block page. Example: 4567.
dnsfilter_block_page_updateUpdate a DNSFilter block page's name, organization name or contact email.WriteUpdate Block Page
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.
- Idempotent
Inputs
idintegerrequired- BlockPage ID. Example: 12345.
namestringrequired- Block page name. Example: Acme block page.
block_email_addrstring- Contact email shown on the block page. Example: it@acme.com.
block_org_namestring- Organization name shown on the block page. Example: Acme IT.
organization_idinteger- ID of the organization that owns the block page. Example: 4567.
dnsfilter_ip_address_createRegister a public IP address (or dynamic hostname) to a DNSFilter network so its DNS traffic is filtered.WriteAdd IP Address
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.
Inputs
addressstringrequired- Public IPv4 or IPv6 address. Example: 203.0.113.10.
network_idintegerrequired- ID of the network to add it to. Example: 2201.
organization_idintegerrequired- ID of the network's organization. Example: 4567.
dynamic_hostnamestring- Dynamic DNS hostname that tracks the IP, for sites without a static IP. Example: office.dyndns.org.
dnsfilter_network_createCreate a DNSFilter network (site) whose DNS traffic is filtered by its policies.WriteCreate Network
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.
Inputs
namestringrequired- Network (site) name. Example: Head office.
organization_idintegerrequired- ID of the organization the network belongs to, from dnsfilter_organizations_list. Example: 4567.
block_page_idinteger- ID of the block page to show when a site is blocked. Example: 55.
external_idstring- Your own ID for the network. Example: site-001.
ip_addresses_attributesarray- 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_domainsarray- Local domains resolved by the local resolvers. Example: ["corp.local"]
local_resolversarray- IP addresses of local DNS resolvers for the local domains. Example: ["10.0.0.2"]
physical_addressstring- Street address of the site. Example: 1 Main St, Austin, TX.
policy_idsarray- IDs of the policies to apply to the network. Example: [901]
dnsfilter_network_updateUpdate a DNSFilter network (site): name, policies, block page, address or local resolvers; name and organization_id are required.WriteUpdate Network
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.
- Idempotent
Inputs
idintegerrequired- Network ID. Example: 12345.
namestringrequired- Network (site) name. Example: Head office.
organization_idintegerrequired- ID of the organization the network belongs to, from dnsfilter_organizations_list. Example: 4567.
block_page_idinteger- ID of the block page to show when a site is blocked. Example: 55.
external_idstring- Your own ID for the network. Example: site-001.
ip_addresses_attributesarray- 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_domainsarray- Local domains resolved by the local resolvers. Example: ["corp.local"]
local_resolversarray- IP addresses of local DNS resolvers for the local domains. Example: ["10.0.0.2"]
physical_addressstring- Street address of the site. Example: 1 Main St, Austin, TX.
policy_idsarray- IDs of the policies to apply to the network. Example: [901]
dnsfilter_organization_updateUpdate a DNSFilter organization's name, billing contact or address.WriteUpdate Organization
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.
- Idempotent
Inputs
idintegerrequired- Organization ID. Example: 12345.
managed_by_msp_idintegerrequired- ID of the MSP that manages the organization; send its current value to keep it. Example: 321.
namestringrequired- Organization name. Example: Acme Inc.
addressstring- Organization address. Example: 1 Main St, Austin, TX.
billing_contact_emailstring- Billing contact email. Example: billing@acme.com.
billing_contact_namestring- Billing contact name. Example: Jane Doe.
billing_contact_phonestring- Billing contact phone. Example: +15125550123.
dnsfilter_organization_user_addAdd a new or existing dashboard user to a DNSFilter organization by email; new users get an invite.WriteAdd Organization User
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.
Inputs
emailstringrequired- User's email address. Example: jane@acme.com.
organization_idintegerrequired- The ID of the organization. Example: 4567.
first_namestring- First name. Example: Jane.
last_namestring- Last name. Example: Doe.
rolestring- Dashboard role, such as owner, super_administrator, administrator, policy_manager or read_only. Example: read_only.
dnsfilter_policy_allow_domain_addAdd one domain to a DNSFilter policy's allowlist.WriteAdd Allowed Domain
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.
- Idempotent
Inputs
domainstringrequired- Domain to allow. Example: badsite.com.
idintegerrequired- Policy ID. Example: 12345.
notestringrequired- Note explaining the change. Example: Requested by IT ticket 4521.
include_relationshipsboolean- Include related objects in the response (default true). Example: false.
dnsfilter_policy_allow_domain_removeRemove one domain from a DNSFilter policy's allowlist.WriteRemove Allowed Domain
Remove one domain from a DNSFilter policy's allowlist. Returns the updated policy. Use this to stop always allowing a site.
- Idempotent
Inputs
domainstringrequired- Domain to remove from the allowlist. Example: badsite.com.
idintegerrequired- Policy ID. Example: 12345.
notestringrequired- Note explaining the change. Example: Requested by IT ticket 4521.
include_relationshipsboolean- Include related objects in the response (default true). Example: false.
dnsfilter_policy_block_application_addBlock one application in a DNSFilter policy.WriteAdd Blocked Application
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.
- Idempotent
Inputs
idintegerrequired- Policy ID. Example: 12345.
namestringrequired- Name of the application to block, from dnsfilter_applications_list. Example: TikTok.
include_relationshipsboolean- Include related objects in the response (default true). Example: false.
dnsfilter_policy_block_application_removeUnblock one application in a DNSFilter policy.WriteRemove Blocked Application
Unblock one application in a DNSFilter policy. Returns the updated policy. Use this to undo dnsfilter_policy_block_application_add.
- Idempotent
Inputs
idintegerrequired- Policy ID. Example: 12345.
namestringrequired- Name of the application to unblock. Example: TikTok.
include_relationshipsboolean- Include related objects in the response (default true). Example: false.
dnsfilter_policy_block_category_addBlock one content category in a DNSFilter policy.WriteAdd Blocked Category
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.
- Idempotent
Inputs
category_idintegerrequired- ID of the category to block, from dnsfilter_categories_list. Example: 12.
idintegerrequired- Policy ID. Example: 12345.
include_relationshipsboolean- Include related objects in the response (default true). Example: false.
dnsfilter_policy_block_category_removeUnblock one content category in a DNSFilter policy.WriteRemove Blocked Category
Unblock one content category in a DNSFilter policy. Returns the updated policy. Use this to undo dnsfilter_policy_block_category_add.
- Idempotent
Inputs
category_idintegerrequired- ID of the category to unblock. Example: 12.
idintegerrequired- Policy ID. Example: 12345.
include_relationshipsboolean- Include related objects in the response (default true). Example: false.
dnsfilter_policy_block_domain_addAdd one domain to a DNSFilter policy's blocklist.WriteAdd Blocked Domain
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.
- Idempotent
Inputs
domainstringrequired- Domain to block. Example: badsite.com.
idintegerrequired- Policy ID. Example: 12345.
notestringrequired- Note explaining the change. Example: Requested by IT ticket 4521.
include_relationshipsboolean- Include related objects in the response (default true). Example: false.
dnsfilter_policy_block_domain_removeRemove one domain from a DNSFilter policy's blocklist.WriteRemove Blocked Domain
Remove one domain from a DNSFilter policy's blocklist. Returns the updated policy. Use this to unblock a site you blocked.
- Idempotent
Inputs
domainstringrequired- Domain to remove from the blocklist. Example: badsite.com.
idintegerrequired- Policy ID. Example: 12345.
notestringrequired- Note explaining the change. Example: Requested by IT ticket 4521.
include_relationshipsboolean- Include related objects in the response (default true). Example: false.
dnsfilter_policy_createCreate a DNSFilter filtering policy with blocked categories, applications and domains and SafeSearch settings.WriteCreate Policy
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.
Inputs
namestringrequired- Policy name. Example: Default office policy.
organization_idintegerrequired- ID of the organization the policy belongs to. Example: 4567.
allow_applicationsarray- Names of applications to allow. Example: ["Zoom"]
allow_list_onlyboolean- Block everything except the allowlist. Example: false.
allow_unknown_domainsboolean- Allow domains that DNSFilter has not categorized yet. Example: true.
bing_safe_searchboolean- Enforce Bing SafeSearch. Example: true.
blacklist_categoriesarray- IDs of categories to block, from dnsfilter_categories_list. Example: [12, 33]
blacklist_domainsarray- Domains to block. Example: ["badsite.com"]
block_applicationsarray- Names of applications to block, from dnsfilter_applications_list. Example: ["TikTok"]
blocked_countriesarray- Country codes whose domains to block. Example: ["KP"]
google_safesearchboolean- Enforce Google SafeSearch. Example: true.
interstitialboolean- Show an interstitial page instead of a hard block. Example: false.
whitelist_domainsarray- Domains to always allow. Example: ["partner.com"]
youtube_restrictedboolean- Enforce YouTube Restricted Mode. Example: true.
youtube_restricted_levelstring- YouTube Restricted Mode level: strict or none. Example: strict.one of
strictnone
dnsfilter_policy_permissive_mode_updateTurn permissive mode on or off for a DNSFilter policy; in permissive mode traffic is logged but not blocked.WriteUpdate Policy Permissive Mode
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.
- Idempotent
Inputs
idintegerrequired- Policy ID. Example: 12345.
permissive_modebooleanrequired- Updated permissive mode value. Example: true.
dnsfilter_policy_updateUpdate a DNSFilter policy's settings and lists; name and organization_id are required.WriteUpdate Policy
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.
- Idempotent
Inputs
idintegerrequired- Policy ID. Example: 12345.
namestringrequired- Policy name. Example: Default office policy.
organization_idintegerrequired- ID of the organization the policy belongs to. Example: 4567.
allow_applicationsarray- Names of applications to allow. Example: ["Zoom"]
allow_list_onlyboolean- Block everything except the allowlist. Example: false.
allow_unknown_domainsboolean- Allow domains that DNSFilter has not categorized yet. Example: true.
append_domainsboolean- True appends the allowlist and blocklist domains to the existing ones instead of replacing them. Example: true.
bing_safe_searchboolean- Enforce Bing SafeSearch. Example: true.
blacklist_categoriesarray- IDs of categories to block, from dnsfilter_categories_list. Example: [12, 33]
blacklist_domainsarray- Domains to block. Example: ["badsite.com"]
block_applicationsarray- Names of applications to block, from dnsfilter_applications_list. Example: ["TikTok"]
blocked_countriesarray- Country codes whose domains to block. Example: ["KP"]
google_safesearchboolean- Enforce Google SafeSearch. Example: true.
interstitialboolean- Show an interstitial page instead of a hard block. Example: false.
whitelist_domainsarray- Domains to always allow. Example: ["partner.com"]
youtube_restrictedboolean- Enforce YouTube Restricted Mode. Example: true.
youtube_restricted_levelstring- YouTube Restricted Mode level: strict or none. Example: strict.one of
strictnone
dnsfilter_roaming_client_updateUpdate a DNSFilter roaming client's name, status, policy, scheduled policy, block page or network.WriteUpdate Roaming Client
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.
- Idempotent
Inputs
idstringrequired- User agent UUID. Example: 12345.
block_page_idinteger- ID of the block page for the client. Example: 55.
friendly_namestring- Display name of the roaming client. Example: Jane's laptop.
network_idinteger- ID of the network (site) to associate the client with. Example: 2201.
policy_idinteger- ID of the policy to apply to the client. Example: 901.
scheduled_policy_idinteger- ID of the scheduled policy to apply to the client. Example: 77.
statusstring- Client status: active, disabled or uninstalled. Example: active.one of
activedisableduninstalled
dnsfilter_unblock_request_decideAllow, deny or resolve a pending DNSFilter unblock request; allowing adds the domains to the request's policy (or the universal allowlist).WriteDecide Unblock Request
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.
Inputs
decisionstringrequired- Action: allow, allow-universal, deny, deny-and-ignore or resolve-already-allowed. Example: allow.one of
allowallow-universaldenydeny-and-ignoreresolve-already-allowed idstringrequired- Unblock request UUID. Example: 12345.
domainsarray- Allow and allow-universal only: the domains to add to the allowlist. Defaults to the requested domain. Example: ["example.com"]
internal_notesstring- Admin-only notes, up to 512 characters. Example: Approved by IT lead.
messagestring- Deny only: message to the requester, up to 500 characters. Example: This site is not needed for work.
dnsfilter_block_page_deleteDelete a DNSFilter block page.DestructiveDelete Block Page
Delete a DNSFilter block page. Returns an empty success response. Use this to remove a block page no network or client uses.
- Idempotent
Inputs
idintegerrequired- BlockPage ID. Example: 12345.
dnsfilter_ip_address_deleteRemove a public IP address from its DNSFilter network.DestructiveDelete IP Address
Remove a public IP address from its DNSFilter network. Returns an empty success response. Use this when a site no longer uses an IP.
- Idempotent
Inputs
idintegerrequired- IP address ID. Example: 12345.
dnsfilter_network_deleteDelete a DNSFilter network (site); its traffic is no longer filtered.DestructiveDelete Network
Delete a DNSFilter network (site); its traffic is no longer filtered. Returns an empty success response. Use this to remove a site for good.
- Idempotent
Inputs
idintegerrequired- Network ID. Example: 12345.
dnsfilter_organization_user_removeRemove a dashboard user from a DNSFilter organization; the user account itself is not deleted.DestructiveRemove Organization User
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.
- Idempotent
Inputs
idintegerrequired- ID of the dashboard user to remove, from dnsfilter_organization_users_list. Example: 12345.
organization_idintegerrequired- ID of the organization. Example: 4567.
dnsfilter_policy_deleteDelete a DNSFilter policy.DestructiveDelete Policy
Delete a DNSFilter policy. Returns an empty success response. Use this to remove a policy that no network or client uses.
- Idempotent
Inputs
idintegerrequired- Policy ID. Example: 12345.
dnsfilter_roaming_client_deleteDelete a DNSFilter roaming client record.DestructiveDelete Roaming Client
Delete a DNSFilter roaming client record. Returns an empty success response. Use this to remove a device that is gone.
- Idempotent
Inputs
idstringrequired- User agent UUID. Example: 12345.
clear_registryboolean- Clear registry when uninstalling user agent. Example: true.
queue_uninstallboolean- Uninstall user agent. Example: true.
No tools match.