Dnsfilter

Learn how to use Dnsfilter with Composio

Overview

SLUG: DNSFILTER

Description

DNSFilter provides cloud-based DNS security and content filtering solutions to protect networks from online threats and manage internet usage.

Authentication Details

generic_api_key
stringRequired

Connecting to Dnsfilter

Create an auth config

Use the dashboard to create an auth config for the Dnsfilter toolkit. This allows you to connect multiple Dnsfilter accounts to Composio for agents to use.

1

Select App

Navigate to Dnsfilter.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Dnsfilter Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4dnsfilter_auth_config_id = "ac_YOUR_DNSFILTER_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": user_api_key}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Dnsfilter for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, dnsfilter_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Dnsfilter toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["DNSFILTER"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create IP Address

Description

Tool to create a new ip address in dnsfilter. use after confirming the target network id exists.

Action Parameters

address
stringRequired
description
string
network_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Application Category

Description

Tool to get basic information of a specific application category. use when you need details for a given application category id.

Action Parameters

application_category_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Billing Information

Description

Tool to retrieve basic billing information for an organization. use when you need to obtain billing details for reporting or automation tasks.

Action Parameters

organization_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Category

Description

Tool to get basic information of a specific category. use when you need to retrieve details for a category by its id.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get IP Address

Description

Tool to get basic information of the specified ip address. use when you need to fetch metadata for a particular ip after authentication.

Action Parameters

ip_address
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Categories

Description

Tool to list all categories including internal categories. use when you need the complete set of filtering categories.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List All IP Addresses

Description

Tool to list all user-associated ip addresses. use when you need a comprehensive list of all ip address entries in your organization.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List All MAC Addresses

Description

Tool to list all mac addresses with basic information. use when you need to retrieve all mac address entries in your organization.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List Applications

Description

Tool to list applications with basic information. use when you need to retrieve all applications for your dnsfilter organization.

Action Parameters

page
integer
size
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Application Categories

Description

Tool to list application categories with basic information. use after authentication to retrieve all categories.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List Block Pages

Description

Tool to list block pages associated with the current user. use when you need to retrieve all block pages for review or update.

Action Parameters

page
integer
per_page
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List Categories

Description

Tool to list categories with basic information. use when retrieving all dnsfilter categories for policy configuration.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List Invoices

Description

Tool to list invoices for an organization, most recent first. use after obtaining the organization id when needing paginated invoice data.

Action Parameters

direction
string
organization_id
stringRequired
page
integer
per_page
integer
sort
string

Action Response

data
arrayRequired
error
string
page
integerRequired
per_page
integerRequired
successful
booleanRequired
total
integerRequired

Tool Name: List IP Addresses

Description

Tool to list user-associated ip addresses basic information. use when you need to retrieve paginated ip address records filtered by location or device after authentication.

Action Parameters

device_id
integer
location_id
integer
page
integer
per_page
integer

Action Response

data
arrayRequired
error
string
page
integerRequired
per_page
integerRequired
successful
booleanRequired
total
integerRequired

Tool Name: List MAC Addresses

Description

Tool to list mac addresses associated with an organization. use when you need to retrieve basic mac address information, optionally filtered by organization or paginated.

Action Parameters

organization_id
string
page
integer
per_page
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List Networks

Description

Tool to list all networks. use when you need to retrieve all network configurations for your organization.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Organizations

Description

Tool to list all organizations. use when you need to retrieve all organizations tied to the authenticated dnsfilter account.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Suggest Domain Threat

Description

Tool to suggest a fqdn as a potential threat. use after identifying a suspicious domain to verify its threat categorization.

Action Parameters

categories
array
fqdn
stringRequired
notes
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Validate Auth0 JWT

Description

Tool to validate a jwt with auth0. use when you need to confirm token validity before making dnsfilter api calls.

Action Parameters

jwt
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired