API_KEY
dnsfilter_api_key
Developer setup
No fields declared in this snapshot.
User connection
- DNSFilter API Keygeneric_api_key · stringRequired
DNSFILTER
DNSFilter provides cloud-based DNS security and content filtering solutions to protect networks from online threats and manage internet usage.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
170
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 31–60 of 170 actions
DNSFILTER_GET_APPLICATION_CATEGORY
Retrieves detailed information about a specific DNSFilter application category by its ID. Application categories group applications for filtering policies (e.g., Business, VPN And Proxy, GenAI & ML). Use LIST_APPLICATION_CATEGORIES to discover available category IDs first.
Untrusted display-only summary
DNSFILTER_GET_BILLING_ADDRESS
Retrieves the billing address for a specific DNSFilter organization. Use when you need to access or verify billing contact information, shipping addresses, or organization location details for invoicing purposes.
Untrusted display-only summary
DNSFILTER_GET_BILLING_INFORMATION
Retrieves billing records for a specific DNSFilter organization. Returns a list of billing records including amounts, payment status, and billing periods. Returns an empty list if no billing records exist for the organization. Use this when you need to access billing history, verify payment status, or generate billing…
Untrusted display-only summary
DNSFILTER_GET_CATEGORY
Tool to get basic information of a specific category. Use when you need to retrieve details for a category by its ID.
Untrusted display-only summary
DNSFILTER_GET_IP_ADDRESS
Retrieves detailed information for a specific IP address record by its ID. Use this action when you need to fetch complete metadata, network relationships, and attributes for a particular IP address that you've already identified (e.g., from the List IP Addresses action). The response includes the IP address in both s…
Untrusted display-only summary
DNSFILTER_GET_MAC_ADDRESS
Retrieves detailed information for a specific MAC address record by its ID. Use this action when you need to fetch complete metadata and attributes for a particular MAC address that you've already identified (e.g., from the List MAC Addresses action). The response includes the MAC address value, name/label, organizati…
Untrusted display-only summary
DNSFILTER_GET_METRICS_ORGANIZATION_USAGE
Retrieves usage metrics for a DNSFilter organization over a specified date range. Returns DNS query counts, user statistics, and billing information. The maximum allowed date range is 365 days. Use this when you need to analyze organization activity, generate usage reports, or monitor DNS request volumes.
Untrusted display-only summary
DNSFILTER_GET_METRICS_ORGANIZATION_USAGE_DETAILED
Retrieves detailed usage metrics for a specific DNSFilter organization. Use this when you need comprehensive usage statistics including user counts, WiFi networks, roaming clients, and DNS request volumes for a given time period. This endpoint fetches user_count and wifi_count directly from the database and includes r…
Untrusted display-only summary
DNSFILTER_GET_MY_IP_ADDRESS
Tool to retrieve the requester's IP address as reported by DNSFilter API. Use when you need to determine the public IP address from which API requests are being made.
Untrusted display-only summary
DNSFILTER_GET_NETWORKS_BULK_CREATE
Tool to check the status of a bulk network creation job. Use when you need to monitor the progress or completion of a bulk network creation operation, or to retrieve the results (successful, failed, and skipped counts) of a completed bulk job.
Untrusted display-only summary
DNSFILTER_GET_NETWORKS_BULK_DESTROY
Check the status of a bulk network destroy operation. Use this action after initiating a bulk destroy to monitor progress and see which networks were successfully destroyed, failed, or skipped.
Untrusted display-only summary
DNSFILTER_GET_NETWORKS_BULK_UPDATE_STATUS
Check the status of a bulk network update job. Use this action to monitor the progress and results of a bulk update operation after initiating it. The response indicates completion status, success/failure counts, and IDs of affected networks.
Untrusted display-only summary
DNSFILTER_GET_NETWORKS_CSV_EXPORT
Retrieves a networks CSV export by its ID. Use this action when you need to check the status of a CSV export or get the download URL for the exported data.
Untrusted display-only summary
DNSFILTER_GET_NOTES
Tool to retrieve notes associated with a specific resource (policy, MSP, or organization) and domain. Use when you need to fetch allow/block notes for a particular domain within a given resource context.
Untrusted display-only summary
DNSFILTER_GET_ORGANIZATION
Tool to get basic information of a specific organization by ID. Use when you need to retrieve detailed organization configuration, billing details, feature flags, and network relationships for a particular organization.
Untrusted display-only summary
DNSFILTER_GET_ORGANIZATIONS_USERS
Tool to retrieve user details and permissions for a specific organization. Use when you need to fetch information about a particular user within an organization, including their role, contact details, and permission settings.
Untrusted display-only summary
DNSFILTER_GET_POLICIES
Tool to get basic information of the specified policy. Use when you need to retrieve details for a specific policy by its ID.
Untrusted display-only summary
DNSFILTER_GET_POLICIES_PERMISSIVE_MODE
Tool to retrieve the permissive mode setting for a specific policy. Use when you need to check if a policy has permissive mode enabled or disabled.
Untrusted display-only summary
DNSFILTER_GET_POLICY_IP
Retrieves basic information for a specific Policy IP by its ID. Use this action when you need to fetch DNS server IP addresses (primary and secondary) associated with a particular policy. The response includes the Policy IP's UUID and the DNS server addresses that can be used for DNS filtering.
Untrusted display-only summary
DNSFILTER_GET_SCHEDULED_REPORT_PREVIEWS
Tool to retrieve a specific scheduled report preview by its ID. Use when you need to view the preview data for a scheduled report before it's sent.
Untrusted display-only summary
DNSFILTER_GET_USER
Tool to get basic information of a specified user by ID. Use when you need to retrieve user details such as email, name, role, and verification status.
Untrusted display-only summary
DNSFILTER_GET_USER_AGENT_CLEANUP
Tool to get the specific user agent cleanup by ID. Use when you need to retrieve the status and details of a user agent cleanup process, including which agents are marked for deletion and whether the cleanup has completed.
Untrusted display-only summary
DNSFILTER_GET_USER_AGENT_CSV_EXPORTS
Tool to retrieve a specific user agent CSV export by its ID. Use when you need to check the status of a CSV export and obtain the download URL once ready.
Untrusted display-only summary
DNSFILTER_GET_USER_AGENTS_UNINSTALL_PIN
Tool to get the uninstall PIN for an organization's user agents. Use when you need to retrieve the PIN required to uninstall user agents protected by PIN authentication.
Untrusted display-only summary
DNSFILTER_LIST_ALL_AGENT_LOCAL_USERS
Get all agent local users associated with a user organization. Returns basic information about agent local users including their IDs, types, and relationships. Use filters to narrow results by collection membership, name, or organization.
Untrusted display-only summary
DNSFILTER_LIST_ALL_BLOCK_PAGES
Retrieves all block pages associated with the current user. Block pages are custom HTML pages displayed when users attempt to access blocked websites. Use this when you need a complete list of all configured block pages without pagination.
Untrusted display-only summary
DNSFILTER_LIST_ALL_IP_ADDRESSES
Retrieves one page of IP addresses across all networks in your organization. Pagination is caller-driven: pass `page` and `per_page` to fetch a specific page; inspect `has_next_page` / `next_page` in the response to advance. Exactly ONE DNSFilter API call is made per invocation.
Untrusted display-only summary
DNSFILTER_LIST_API_KEYS
Retrieves the list of API keys associated with the authenticated user. Use this to view all API keys, check their expiration status, or filter by specific criteria such as name or organization. Supports filtering by expiration, ID, name, organization, and last four characters of the token.
Untrusted display-only summary
DNSFILTER_LIST_APPLICATION_CATEGORIES
Retrieves all available application categories from DNSFilter. Application categories group SaaS applications and services (e.g., Business, Messaging, File Sharing, VPN And Proxy) and are used to apply filtering policies. Returns a list of categories with their IDs, names, UUIDs, and descriptions. Use this to discover…
Untrusted display-only summary
DNSFILTER_LIST_APPLICATIONS_ALL
Tool to list all applications basic information including deleted ones. Use when you need a comprehensive list of all application entries without filtering out deleted applications.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.