Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to DNSFilter

Scalekit connector
Open markdown

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

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  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.

  4. 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.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)
    Terminal window
    npx tsx quickstart.mts

    Each 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 to execute_tool
Try in PlaygroundRequest a tool
  • dnsfilter_agent_local_user_getGet one local device user seen by DNSFilter roaming clients.Read-only

    Get 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-only

    List 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-only

    List 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-only

    Get 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-only

    List 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-only

    List 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-only

    Get 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-only

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