- Category: security & identity tools
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 170
- Triggers: 0
- Slug:
DNSFILTER - Version: 20261101_00
Tools
Add Allowed Application
Add Allowed Application
DNSFILTER_ADD_ALLOWED_APPLICATIONAdds a single application to the allow list of a policy in DNSFilter. Use this action when you need to permit a specific application through the filtering policy. The application will be added to the policy’s allow_applications list and will be allowed regardless of other blocking rules. This is useful for whitelisting specific applications that need to function while maintaining strict filtering policies for other traffic.Input Parameters
Output
Add Allowlist Domains to Policies
Add Allowlist Domains to Policies
DNSFILTER_ADD_ALLOWLIST_DOMAINS_TO_POLICIESTool to bulk add one or more domains to one or more policies’ allow lists. Use when you need to permit specific domains across multiple policies efficiently, bypassing filtering rules for trusted sites.Input Parameters
Output
Add Blacklist Category To Policy
Add Blacklist Category To Policy
DNSFILTER_ADD_BLACKLIST_CATEGORY_TO_POLICYTool to add a single category to a policy’s blocklist. Use when you need to block a specific content category for a DNS filtering policy. The category will be added to the existing blacklist categories without affecting other policy settings.Input Parameters
Output
Add Blacklist Domain To Policy
Add Blacklist Domain To Policy
DNSFILTER_ADD_BLACKLIST_DOMAIN_TO_POLICYTool to add a single domain to a policy’s blocklist. Use when you need to block a specific domain under a DNS filtering policy. The domain will be added to the policy’s blacklist and blocked from access for users under that policy.Input Parameters
Output
Add Blocked Application
Add Blocked Application
DNSFILTER_ADD_BLOCKED_APPLICATIONAdds a single application to the block list of a policy in DNSFilter. Use this action when you need to block a specific application through the filtering policy. The application will be added to the policy’s block_applications list and will be blocked regardless of other allow rules. This is useful for blocking specific applications that should not be accessible while maintaining other filtering policies.Input Parameters
Output
Add Blocklist Domains To Policies
Add Blocklist Domains To Policies
DNSFILTER_ADD_BLOCKLIST_DOMAINS_TO_POLICIESBulk add one or more domains to the blocklists of one or more policies in a single API call. The response can report successful, failed, and unchanged policies.Input Parameters
Output
Add Whitelist Domain
Add Whitelist Domain
DNSFILTER_ADD_WHITELIST_DOMAINTool to add a single domain to a policy’s allowlist. Use when you need to permit a specific domain for a policy, bypassing filtering rules for that trusted site.Input Parameters
Output
Cancel Organization
Cancel Organization
DNSFILTER_CANCEL_ORGANIZATIONSets an organization as ‘Canceled’ in DNSFilter by its unique ID. Use this action when you need to cancel an organization’s service. The organization will be marked as canceled but may not be immediately deleted depending on billing cycles.Input Parameters
Output
Check User Agent Bulk Updates Has Mixed
Check User Agent Bulk Updates Has Mixed
DNSFILTER_CHECK_USER_AGENT_BULK_UPDATES_HAS_MIXEDCheck if user agent attributes are mixed in a bulk selection. Use this to determine whether block pages, policies, sites, or tags differ across the selected user agents before performing bulk updates. This helps identify configuration inconsistencies and plan bulk update operations.Input Parameters
Output
Create API Keys
Create API Keys
DNSFILTER_CREATE_API_KEYSCreates a DNSFilter API key for authentication using a name and required expiration date. Store the key securely when returned, as it is available only at creation.Input Parameters
Output
Create CyberSight CSV Export
Create CyberSight CSV Export
DNSFILTER_CREATE_CYBER_SIGHT_CSV_EXPORTCreates a CyberSight activity-log CSV export for a specified time range, with optional organization, activity and other filters. The response may include an export UUID, download URL or error.Input Parameters
Output
Create IP Address
Create IP Address
DNSFILTER_CREATE_IP_ADDRESSCreates a new IP address entry in DNSFilter for network filtering and policy enforcement. This action registers an IPv4 or IPv6 address with a specific network in DNSFilter, allowing that IP to be subject to the network’s filtering policies. Common use cases include: - Adding gateway or router IP addresses - Registering office or branch location IPs - Including failover or WAN link IPs Prerequisites: - Must have a valid network_id (use LIST_NETWORKS to retrieve available networks) - The IP address must be a valid IPv4 or IPv6 format - User must have authorization to create IP addresses in the target network Returns the created IP address details including its unique ID and UUID for future reference.Input Parameters
Output
Create MAC Address
Create MAC Address
DNSFILTER_CREATE_MAC_ADDRESSCreates a new MAC address entry in DNSFilter with the specified data. This action registers a MAC address with a specific organization in DNSFilter, allowing that MAC address to be subject to custom filtering policies and block pages. Common use cases include: - Adding device MAC addresses for network access control - Assigning custom policies to specific devices - Managing device-level filtering in BYOD environments Prerequisites: - Must have a valid organization_id (use LIST_ORGANIZATIONS to retrieve available organizations) - The MAC address should be in valid format with colons (e.g., ‘00:11:22:33:44:55’) - User must have authorization to create MAC addresses in the target organization Returns the created MAC address details including its unique ID for future reference.Input Parameters
Output
Create Networks
Create Networks
DNSFILTER_CREATE_NETWORKSCreates a new network with the specified configuration in DNSFilter. Networks represent locations or groups of devices that will be protected by DNSFilter’s DNS filtering policies. Use this action to set up filtering for office locations, remote workers, or any group of devices that need DNS security. Required fields are network name and organization_id. Optional settings include custom block pages, IP addresses, local domain handling, and policy assignments. The action returns the complete network details including its unique ID and UUID for future operations.Input Parameters
Output
Bulk Create Networks
Bulk Create Networks
DNSFILTER_CREATE_NETWORKS_BULKBulk create multiple networks in DNSFilter with a single API call. Use when you need to create multiple networks at once for efficiency. Each network requires at minimum a name; optional fields like physical address, coordinates, description, and policy assignment can be included for better organization.Input Parameters
Output
Create Organization User
Create Organization User
DNSFILTER_CREATE_ORGANIZATION_USERAdds a new or existing user with the specified email to an organization in DNSFilter. This action creates a user association with a specific organization, assigning them a role (administrator or read_only). If the user email already exists in DNSFilter, it adds that existing user to the organization. If the email is new, it creates a new user account. Common use cases: - Adding administrators to manage organization settings - Granting read-only access to stakeholders or auditors - Managing multi-organization access with permission lists Prerequisites: - Must have a valid organization_id (use LIST_ORGANIZATIONS to retrieve) - User must have administrator permissions in the organization - Email must be valid and unique within the organization Returns the created user details including their ID, role, and contact information.Input Parameters
Output
Create Policies
Create Policies
DNSFILTER_CREATE_POLICIESCreates a new DNS filtering policy with the specified configuration in DNSFilter. Policies define filtering rules including blocked/allowed categories, domain lists, safe search enforcement, and application controls. Use this action to create filtering policies that can be applied to networks, IP addresses, or MAC addresses for content filtering and security enforcement. Required fields are policy name and organization_id. Optional settings include category blocking, domain allow/block lists, safe search enforcement for multiple search engines, application controls, and YouTube restrictions.Input Parameters
Output
Create Scheduled Policy
Create Scheduled Policy
DNSFILTER_CREATE_SCHEDULED_POLICYCreates a new scheduled (time-based) policy in DNSFilter. Scheduled policies allow different filtering policies to be applied during different times of the week based on a weekly schedule divided into 15-minute intervals. Use this action to implement time-based filtering rules such as stricter policies during school/work hours and relaxed policies during evenings or weekends. The policy_ids array must contain exactly 672 integers representing each 15-minute block of the week starting from Monday 12:01am. Each policy ID can be reused for multiple time blocks to create consistent filtering periods.Input Parameters
Output
Create Scheduled Report Previews
Create Scheduled Report Previews
DNSFILTER_CREATE_SCHEDULED_REPORT_PREVIEWSCreates a scheduled report preview for an organization, triggering background report generation. Content category and threat summaries can be included according to the requested settings.Input Parameters
Output
Create Scheduled Report
Create Scheduled Report
DNSFILTER_CREATE_SCHEDULED_REPORTSCreates a scheduled report for an organization to automate regular delivery of network activity and security summaries, with options for summaries and recipients. Organization and frequency are required; weekly and bi-weekly reports also require a day of the week.Input Parameters
Output
Create User Agent Bulk Deletes
Create User Agent Bulk Deletes
DNSFILTER_CREATE_USER_AGENT_BULK_DELETESCreate a user agent bulk delete operation in DNSFilter. Use when you need to delete multiple user agents at once based on explicit IDs or filter criteria. This action allows you to either: 1. Delete specific agents by providing their IDs in the ‘ids’ parameter 2. Delete agents matching filter criteria (agent_state, network_ids, tags, etc.) 3. Combine filters with exclude_ids to protect specific agents from bulk deletion The ‘queue_uninstall’ parameter determines deletion behavior: - True: Hard delete with agent uninstallation - False: Soft delete (agent deactivation) Common use cases: - Remove all unprotected agents from a specific network - Delete agents that haven’t received traffic recently - Clean up agents with a specific version or status - Bulk remove agents by tags or organizationInput Parameters
Output
Create User Agent Cleanup
Create User Agent Cleanup
DNSFILTER_CREATE_USER_AGENT_CLEANUPCreates a user agent cleanup to track bulk deletion of inactive user agents in DNSFilter. This action initiates a cleanup process that identifies and deletes user agents that have been inactive for a specified number of days across one or more organizations. The cleanup helps maintain an accurate inventory by removing stale agent entries that are no longer in use. Use cases: - Removing outdated agents from decommissioned devices - Cleaning up test agents after evaluation periods - Maintaining accurate license counts by removing inactive agents Returns details about the cleanup operation including which agents will be deleted and the status of the cleanup process.Input Parameters
Output
Delete API Key
Delete API Key
Delete IP Address
Delete IP Address
DNSFILTER_DELETE_IP_ADDRESSRemoves an IP address from DNSFilter by its unique ID. Use this action when you need to unregister an IP address from a network, such as when decommissioning equipment or removing access.Input Parameters
Output
Delete MAC Address
Delete MAC Address
DNSFILTER_DELETE_MAC_ADDRESSDeletes a DNSFilter MAC address entry by numeric ID. Returns resource identifiers when available; for an empty successful response, the UUID is returned as an empty string.Input Parameters
Output
Delete Networks (Bulk)
Delete Networks (Bulk)
DNSFILTER_DELETE_NETWORKS_BULKBulk destroy multiple networks in DNSFilter. Use when you need to delete multiple networks at once or all networks in an organization.Input Parameters
Output
Delete Policies
Delete Policies
DNSFILTER_DELETE_POLICIESDeletes a DNS filtering policy from DNSFilter by its unique ID. Use this action when you need to remove a policy that is no longer needed. Note that the API performs a soft deletion, setting a deleted_at timestamp on the policy record.Input Parameters
Output
Delete Scheduled Policies
Delete Scheduled Policies
DNSFILTER_DELETE_SCHEDULED_POLICIESRemoves a scheduled policy from the DNSFilter database by its unique ID. Use this action when you need to delete a scheduled policy that is no longer needed or was created in error.Input Parameters
Output
Delete Scheduled Report
Delete Scheduled Report
Get API Key
Get API Key
Get Application Category
Get Application Category
DNSFILTER_GET_APPLICATION_CATEGORYRetrieves 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.Input Parameters
Output
Get Billing Address
Get Billing Address
Get Billing Information
Get Billing Information
Get Category
Get Category
Get IP Address
Get IP Address
DNSFILTER_GET_IP_ADDRESSRetrieves 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 short and full notation, along with associated network and organization IDs.Input Parameters
Output
Get MAC Address
Get MAC Address
DNSFILTER_GET_MAC_ADDRESSRetrieves a DNSFilter MAC address record by ID in JSON:API format. The returned attributes can include the MAC address, name, organization and location IDs, and timestamps.Input Parameters
Output
Get Organization Usage Metrics
Get Organization Usage Metrics
DNSFILTER_GET_METRICS_ORGANIZATION_USAGERetrieves 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.Input Parameters
Output
Get Organization Usage Detailed Metrics
Get Organization Usage Detailed Metrics
DNSFILTER_GET_METRICS_ORGANIZATION_USAGE_DETAILEDRetrieves 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 roaming client counts.Input Parameters
Output
Get My IP Address
Get My IP Address
Get Networks Bulk Create Status
Get Networks Bulk Create Status
DNSFILTER_GET_NETWORKS_BULK_CREATETool 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.Input Parameters
Output
Get Networks Bulk Destroy Status
Get Networks Bulk Destroy Status
DNSFILTER_GET_NETWORKS_BULK_DESTROYChecks the status of a bulk network destroy operation by job ID. Returns completion status and counts of successful, failed, and skipped networks, with IDs for failed or skipped networks when available.Input Parameters
Output
Get Networks Bulk Update Status
Get Networks Bulk Update Status
DNSFILTER_GET_NETWORKS_BULK_UPDATE_STATUSChecks a bulk network update job’s status by ID, including completion status, counts, and failed or skipped network IDs. Missing or unrecognized status and count values may be returned as false or zero.Input Parameters
Output
Get Networks CSV Export
Get Networks CSV Export
Get Notes
Get Notes
DNSFILTER_GET_NOTESTool 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.Input Parameters
Output
Get Organization
Get Organization
Get Organization User
Get Organization User
Get Policy
Get Policy
Get Policy Permissive Mode
Get Policy Permissive Mode
Get Policy IP
Get Policy IP
Get Scheduled Report Preview
Get Scheduled Report Preview
Get User
Get User
Get User Agent Cleanup
Get User Agent Cleanup
Get User Agent CSV Export
Get User Agent CSV Export
Get User Agents Uninstall PIN
Get User Agents Uninstall PIN
List All Agent Local Users
List All Agent Local Users
List All Block Pages
List All Block Pages
List All IP Addresses
List All IP Addresses
DNSFILTER_LIST_ALL_IP_ADDRESSESRetrieves 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.Input Parameters
page[number] on the DNSFilter /v1/ip_addresses endpoint.page[size] on the DNSFilter /v1/ip_addresses endpoint. The API caps this at 1500.Output
List API Keys
List API Keys
DNSFILTER_LIST_API_KEYSRetrieves 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.Input Parameters
Output
List Application Categories
List Application Categories
DNSFILTER_LIST_APPLICATION_CATEGORIESRetrieves 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 available categories before configuring policies or filtering rules.Output
List All Applications
List All Applications
DNSFILTER_LIST_APPLICATIONS_ALLLists basic information about applications, including deleted ones, with optional category filtering and pagination. Use the returned pagination links to navigate results.Input Parameters
Output
List Billing
List Billing
List All Categories (Including Internal)
List All Categories (Including Internal)
List Current User
List Current User
List CyberSight Activity Types
List CyberSight Activity Types
List Domains Bulk Lookup
List Domains Bulk Lookup
DNSFILTER_LIST_DOMAINS_BULK_LOOKUPRetrieves domain information and category classifications for multiple FQDNs in a single request. Use this action to perform bulk lookups of domain categories and classifications. This is useful when you need to check the category status of multiple domains at once, rather than making individual requests for each domain. The response includes category information and other domain attributes for each requested FQDN.Input Parameters
Output
List Domains User Lookup
List Domains User Lookup
List Enterprise Connections
List Enterprise Connections
List Invoices
List Invoices
DNSFILTER_LIST_INVOICESRetrieves billing invoices for a DNSFilter organization with pagination and sorting support, including amounts, statuses and dates. An HTTP 404 is returned as an empty invoice list.Input Parameters
Output
List All IP Addresses (All Endpoint)
List All IP Addresses (All Endpoint)
List MAC Addresses
List MAC Addresses
List All Networks
List All Networks
DNSFILTER_LIST_NETWORKS_ALLTool to retrieve ALL networks associated with the user with basic information. Use when you need a comprehensive list of all networks with optional filtering by protection status or search terms. Supports pagination and various options to control the level of detail returned.Input Parameters
Output
List Networks Geo
List Networks Geo
DNSFILTER_LIST_NETWORKS_GEOTool to retrieve networks with geographical information only. Use when you need location data (latitude, longitude, physical address) for networks in your DNSFilter organization. This action returns a simplified view focused on network location data without full configuration details.Output
List All MSP Networks
List All MSP Networks
DNSFILTER_LIST_NETWORKS_MSP_ALLTool to retrieve ALL networks associated with the MSP user with basic information. Use when you need a comprehensive list of all MSP-managed networks for a specific organization ID. Supports pagination and various options to control IP address details.Input Parameters
Output
List Network Subnets
List Network Subnets
List All Organizations
List All Organizations
DNSFILTER_LIST_ORGANIZATIONS_ALLTool to get all organizations with optional filtering by type, MSP relationships, or name. Use when you need to retrieve organizations with specific criteria or pagination. Supports filtering by organization type (normal, msp, sub_organization), MSP ownership, and name patterns.Input Parameters
Output
List Organizations Settings
List Organizations Settings
List Organization Users
List Organization Users
List Policies
List Policies
List All Policies
List All Policies
DNSFILTER_LIST_POLICIES_ALLTool to retrieve ALL user-associated policies with basic information. Use when you need a comprehensive list of all policies associated with the user account, with optional filtering by organization or inclusion of global policies. Supports pagination for large datasets.Input Parameters
Output
List Policies for Application
List Policies for Application
List Policy IPs
List Policy IPs
List QP Methods
List QP Methods
List All Scheduled Policies
List All Scheduled Policies
List Traffic Reports QPS
List Traffic Reports QPS
DNSFILTER_LIST_TRAFFIC_REPORTS_QPSGet queries per second (QPS) metrics for DNS traffic over a specified time period. Returns time-series data showing DNS query volume aggregated by configurable time buckets (1 minute, 15 minutes, or 1 day). Use this to analyze traffic patterns, identify peak usage times, and monitor DNS query volumes. Supports extensive filtering by networks, organizations, agents, applications, IP addresses, and traffic type (allowed/blocked/threats).Input Parameters
Output
List Traffic Reports QPS Active Agents
List Traffic Reports QPS Active Agents
DNSFILTER_LIST_TRAFFIC_REPORTS_QPS_ACTIVE_AGENTSGet queries per second (QPS) statistics for roaming clients over a time period. Returns the total number of DNS queries per second for active agents (roaming clients) with optional filtering by agent, organization, application, network, and other criteria. The maximum time range is 20 minutes. Use this action to monitor real-time DNS query loads and analyze traffic patterns for roaming clients.Input Parameters
Output
List Traffic Reports QPS Active Collections
List Traffic Reports QPS Active Collections
DNSFILTER_LIST_TRAFFIC_REPORTS_QPS_ACTIVE_COLLECTIONSTool to retrieve queries per second (QPS) metrics for active collections over a specified time period. Returns the total number of DNS queries per second grouped by collections. The maximum time range is 20 minutes. Use this to monitor query volume and traffic patterns across different collections in your DNSFilter organization.Input Parameters
Output
List Traffic Reports QPS Active Organizations
List Traffic Reports QPS Active Organizations
DNSFILTER_LIST_TRAFFIC_REPORTS_QPS_ACTIVE_ORGANIZATIONSRetrieves the total number of queries per second (QPS) over a time period for active organizations. Use this action to analyze DNS query traffic patterns and volume for organizations. The maximum time range is 20 minutes between the from and to parameters.Input Parameters
Output
List Traffic Reports QPS Active Users
List Traffic Reports QPS Active Users
DNSFILTER_LIST_TRAFFIC_REPORTS_QPS_ACTIVE_USERSGet the total number of queries per second (QPS) in a time period (maximum 20 minutes) for active users. Use this to monitor traffic patterns and identify high-activity users. Supports filtering by user agents, networks, organizations, IP addresses, and traffic types (allowed/blocked/threats).Input Parameters
Output
List Traffic Reports Query Logs
List Traffic Reports Query Logs
DNSFILTER_LIST_TRAFFIC_REPORTS_QUERY_LOGSGet query raw logs from DNSFilter traffic reports in a specified period of time. Use this to retrieve detailed DNS query logs with extensive filtering options including time range, domains, networks, user agents, IP addresses, and query results (allowed/blocked). Supports pagination for large result sets.Input Parameters
Output
List Traffic Reports Top Agents
List Traffic Reports Top Agents
DNSFILTER_LIST_TRAFFIC_REPORTS_TOP_AGENTSGet the top user agents by DNS traffic volume in a specified time period. Returns ranked list of agents with associated traffic metrics. Use this to identify most active agents, analyze agent-level usage patterns, and monitor individual device or user traffic. Supports filtering by agent attributes, networks, organizations, IP addresses, and traffic type. Results are paginated for large datasets.Input Parameters
Output
List Traffic Reports Top Application Categories
List Traffic Reports Top Application Categories
DNSFILTER_LIST_TRAFFIC_REPORTS_TOP_APPLICATION_CATEGORIESGet the top application categories domains in a period of time. Returns a paginated list of application categories ranked by DNS query volume, with support for filtering by networks, organizations, agents, time range, and traffic type. Use this to analyze which application categories (e.g., social media, streaming, productivity) are most frequently accessed in your network.Input Parameters
Output
List Traffic Reports Top Categories
List Traffic Reports Top Categories
DNSFILTER_LIST_TRAFFIC_REPORTS_TOP_CATEGORIESGet the top domain categories accessed during a specified time period. Returns category-level statistics showing which website categories (e.g., Social Networking, News, Streaming) are most frequently accessed. Use this to understand browsing patterns, identify potential policy needs, and analyze category-level traffic trends across your organization.Input Parameters
Output
List Traffic Reports Top Collections
List Traffic Reports Top Collections
DNSFILTER_LIST_TRAFFIC_REPORTS_TOP_COLLECTIONSTool to retrieve the top collections by traffic volume over a specified time period. Returns collection-level metrics showing which collections have the most DNS query activity. Use this to identify the most active collections in your DNSFilter organization and analyze traffic distribution across collections.Input Parameters
Output
List Traffic Reports Top Domains
List Traffic Reports Top Domains
DNSFILTER_LIST_TRAFFIC_REPORTS_TOP_DOMAINSGet the top requested domains over a specified time period. Returns a list of the most frequently queried domains with request counts, helping identify popular sites, potential issues, or security concerns. Use this to analyze domain access patterns, monitor bandwidth usage, and detect anomalous traffic. Supports extensive filtering by networks, organizations, agents, applications, IP addresses, and traffic type (allowed/blocked/threats). Results are paginated and can be filtered by domain prefix or FQDN substring.Input Parameters
Output
List Traffic Reports Top Networks
List Traffic Reports Top Networks
DNSFILTER_LIST_TRAFFIC_REPORTS_TOP_NETWORKSGet the top networks ranked by DNS traffic volume over a specified time period. Returns network traffic metrics showing which networks generated the most DNS queries. Use this to identify high-traffic networks, monitor network activity levels, and analyze traffic distribution across your organization.Input Parameters
Output
List Traffic Reports Top Organizations
List Traffic Reports Top Organizations
DNSFILTER_LIST_TRAFFIC_REPORTS_TOP_ORGANIZATIONSGets the top organizations by DNS traffic volume over a specified time period. Use this action to identify which organizations are generating the most DNS queries. Supports pagination and extensive filtering by time range, networks, agents, applications, IP addresses, and traffic type.Input Parameters
Output
List Top Organizations by Requests
List Top Organizations by Requests
DNSFILTER_LIST_TRAFFIC_REPORTS_TOP_ORGANIZATIONS_REQUESTSGet the top organizations ranked by total number of DNS requests over a specified time period. Returns organizations with the highest request volumes, useful for identifying most active organizations and analyzing usage patterns. Results are paginated with configurable page size (max 100 per page).Input Parameters
Output
List Traffic Reports Top Users
List Traffic Reports Top Users
DNSFILTER_LIST_TRAFFIC_REPORTS_TOP_USERSGet the top users by DNS query volume over a specified time period. Returns user activity metrics showing which users generated the most DNS traffic, with support for pagination and extensive filtering. Use this to identify high-volume users, analyze user behavior patterns, and monitor individual user activity across networks and organizations.Input Parameters
Output
List Traffic Reports Total Applications Stats
List Traffic Reports Total Applications Stats
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_APPLICATIONS_STATSGet statistics of number of requests by application in a time period. Returns aggregated data showing how many requests were made to each application, useful for understanding traffic patterns and application usage across your DNSFilter deployment. Use when you need to analyze application-level traffic patterns or generate usage reports.Input Parameters
Output
List Traffic Reports Total Applications Agents Stats
List Traffic Reports Total Applications Agents Stats
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_APPS_AGENTS_STATSGet statistics of number of requests for roaming clients by application in a period of time. Returns aggregated request counts grouped by application for active agents (roaming clients) with optional filtering by agent, organization, application, network, and other criteria. Use this action to analyze which applications are generating the most DNS traffic from roaming clients.Input Parameters
Output
List Traffic Reports Total Applications Collections Stats
List Traffic Reports Total Applications Collections Stats
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_APPS_COLLECTIONS_STATSGet statistics of number of requests for collections by application over a specified time period. Returns aggregated data showing how many DNS requests were made for each application within different collections. Use this to analyze application usage patterns across collections and understand which applications are generating the most traffic.Input Parameters
Output
List Traffic Reports Total Applications Networks Stats
List Traffic Reports Total Applications Networks Stats
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_APPS_NETWORKS_STATSGet statistics showing the number of requests for sites by application across networks over a specified time period. Use this to analyze application usage patterns and DNS query volumes per application across your network infrastructure. Supports extensive filtering by networks, organizations, agents, applications, application categories, IP addresses, and traffic type (allowed/blocked/threats).Input Parameters
Output
List Traffic Reports Total Applications Organizations
List Traffic Reports Total Applications Organizations
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_APPS_ORGANIZATIONSTool to get statistics of number of requests for organizations by application in a period of time. Use when you need to analyze application usage patterns across different organizations within a specified time range.Input Parameters
Output
List Traffic Reports Total Applications Users Stats
List Traffic Reports Total Applications Users Stats
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_APPS_USERS_STATSGet statistics of the number of requests for users by application within a specified time period. Returns detailed application usage data broken down by user, showing which users are accessing which applications and how frequently. Use this to understand application usage patterns across users, identify heavy application users, and analyze user-level application access trends.Input Parameters
Output
List Traffic Reports Total Categories
List Traffic Reports Total Categories
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_CATEGORIESGet the total number of requests by category for sites in a period of time. Returns aggregated statistics showing how many DNS requests were made to each website category during the specified time range. Use this to understand category-level traffic patterns and analyze DNS request volumes across different website categories.Input Parameters
Output
List Traffic Reports Total Categories for Agents
List Traffic Reports Total Categories for Agents
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_CATEGORIES_AGENTSGet the total number of requests by category for roaming clients (user agents) during a specified time period. Use this to analyze category-level traffic patterns for roaming/mobile users, understand which website categories roaming users access most, and track security threats by category across your roaming user base.Input Parameters
Output
List Traffic Reports Total Categories Collections
List Traffic Reports Total Categories Collections
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_CATEGORIES_COLLECTIONSGet the total number of DNS requests by category for collections over a specified time period. Returns aggregated statistics showing request counts grouped by website categories across collections. Use this to analyze category-level traffic patterns for collection-based deployments and identify browsing trends.Input Parameters
Output
List Total Categories by Organizations
List Total Categories by Organizations
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_CATEGORIES_ORGSGet the total number of DNS requests by category for organizations over a specified time period. Returns aggregated statistics showing how many requests were made to each category (e.g., Social Networking, News, Streaming) across one or more organizations. Use this to analyze category-level traffic distribution, understand which content types are most accessed, and track trends across organizational boundaries.Input Parameters
Output
List Traffic Reports by Category for Users
List Traffic Reports by Category for Users
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_CATEGORIES_USERSGets the total number of DNS requests by category for users in a specified time period. Returns aggregated traffic data showing which content categories were accessed and by which users. Use this to analyze user browsing patterns, identify high-traffic categories, or generate security reports for a given time range.Input Parameters
Output
List Traffic Reports Total Category Stats
List Traffic Reports Total Category Stats
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_CATEGORY_STATSTool to get the total number of stats for a category in a period of time. Use when you need to analyze category-level request statistics including allowed, blocked, and threat requests within a specified time range.Input Parameters
Output
List Traffic Reports Total Client Stats
List Traffic Reports Total Client Stats
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_CLIENT_STATSGets the organization network, users and client stats from traffic reports. Returns total and active counts for sites, users, roaming clients, and relays. Use this when you need to understand the deployment scale and active usage of DNSFilter protection across an organization. Note: The time period between ‘from’ and ‘to’ parameters must not exceed 20 minutes.Input Parameters
Output
List Traffic Reports Total Collections
List Traffic Reports Total Collections
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_COLLECTIONSGet the total number of DNS requests by collection for sites over a specified time period. Returns aggregated data showing how many requests were made for each collection, optionally grouped by network. Use this to analyze DNS query volume across collections and understand which collections are receiving the most traffic.Input Parameters
Output
List Traffic Reports Total Collections Agents
List Traffic Reports Total Collections Agents
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_COLLECTIONS_AGENTSGet the total number of requests by collection for roaming clients over a specified time period. Returns aggregated request counts grouped by collection with support for extensive filtering by agents, organizations, networks, applications, IP addresses, and traffic type. Use this action to analyze DNS traffic patterns for roaming clients across different collections.Input Parameters
Output
List Traffic Reports Total Collections Organizations
List Traffic Reports Total Collections Organizations
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_COLLECTIONS_ORGSGet the total number of DNS requests by collection for organizations over a specified time period. Returns aggregated data showing how many DNS requests were made for each collection within different organizations. Use this to analyze collection usage patterns across organizations and understand which collections are generating the most traffic.Input Parameters
Output
List Traffic Reports Total Collections Users
List Traffic Reports Total Collections Users
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_COLLECTIONS_USERSGet the total number of DNS requests by collection for users over a specified time period. Returns aggregated request counts grouped by collections and users, with support for time bucketing and extensive filtering. Use this to analyze collection-level traffic patterns per user, identify high-volume collections for specific users, and generate detailed usage reports across organizations.Input Parameters
Output
List Traffic Reports Total Deployments
List Traffic Reports Total Deployments
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_DEPLOYMENTSGets the organization deployments information including collections, relays, sync tools, user agents, and users. Use this to retrieve deployment metrics and statistics for an organization or filtered by MSP/networks.Input Parameters
Output
List Traffic Reports Total Domain Requests
List Traffic Reports Total Domain Requests
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_DOMAIN_REQUESTSGet the total number of requests for a domain over a specified time period. Returns aggregate request counts for domains, helping analyze domain access patterns and traffic volumes. Supports filtering by domain prefix, networks, organizations, and MSP accounts.Input Parameters
Output
List Traffic Reports Total Domains
List Traffic Reports Total Domains
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_DOMAINSGet the total number of requests by domain for sites in a period of time. Returns aggregated statistics showing how many DNS requests were made to each domain during the specified time range. Use this to understand domain-level traffic patterns and analyze DNS request volumes across different domains.Input Parameters
Output
List Traffic Reports Total Domains Collections
List Traffic Reports Total Domains Collections
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_DOMAINS_COLLECTIONSTool to retrieve the total number of DNS requests by domain for collections within a specified time period. Use when you need to analyze which domains are being accessed most frequently, track collection-level traffic patterns, or generate domain usage reports. Supports extensive filtering by agents, networks, organizations, collections, time ranges, and traffic types (allowed/blocked). Results can be grouped by individual collections or aggregated across all collections.Input Parameters
Output
List Total Domains by Organizations
List Total Domains by Organizations
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_DOMAINS_ORGANIZATIONSGet the total number of DNS requests by domain for organizations over a specified time period. Returns aggregated statistics showing how many requests were made to each domain across one or more organizations. Use this to analyze domain-level traffic distribution, understand which domains are most accessed, and track trends across organizational boundaries.Input Parameters
Output
List Traffic Reports Total Domain Stats
List Traffic Reports Total Domain Stats
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_DOMAIN_STATSTool to get the total number of stats for a domain in a period of time. Use when you need to analyze domain-level request statistics including allowed, blocked, and threat requests within a specified time range.Input Parameters
Output
List Traffic Reports Total Domains Users
List Traffic Reports Total Domains Users
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_DOMAINS_USERSGets the total number of DNS requests by domain for users in a period of time. Use this when you need to analyze domain traffic patterns across users or generate traffic reports. At least one query parameter must be provided for the endpoint to work successfully.Input Parameters
Output
List Total Organizations Requests
List Total Organizations Requests
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_ORGANIZATIONS_REQUESTSGet the total number of DNS requests for organizations in a specified time period. Returns time-series data showing request volumes aggregated by configurable time buckets. Use this to analyze overall traffic patterns and monitor DNS query volumes across organizations. Supports extensive filtering by agents, applications, categories, networks, domains, and traffic type.Input Parameters
Output
List Traffic Reports Total Organizations Stats
List Traffic Reports Total Organizations Stats
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_ORGANIZATIONS_STATSRetrieves aggregated DNS traffic statistics across organizations for a specified time period. Returns total request counts (allowed, blocked, threats) and the organizations included in the report. Use this to monitor overall traffic patterns, identify security threats, and analyze DNS filtering effectiveness across your DNSFilter deployment.Input Parameters
Output
List Traffic Reports Total Requests
List Traffic Reports Total Requests
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_REQUESTSGet the total number of DNS requests over a specified time period. Returns time-series data showing DNS request volumes aggregated by configurable time buckets (15 minutes or 1 day). Use this to analyze traffic patterns, identify peak usage times, and monitor DNS request volumes broken down by allowed, blocked, and total counts.Input Parameters
Output
List Traffic Reports Total Requests for Agents
List Traffic Reports Total Requests for Agents
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_REQUESTS_AGENTSGet the total number of requests for roaming clients (user agents) during a specified time period. Use this to analyze overall traffic volume from roaming/mobile users, track request patterns over time, and monitor total DNS query activity across your roaming user base.Input Parameters
Output
List Traffic Reports Total Requests Collections
List Traffic Reports Total Requests Collections
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_REQUESTS_COLLECTIONSGet the total number of requests for collections over a specified time period. Returns time-series data showing collection request volumes aggregated by configurable time buckets. Use this to analyze collection-specific traffic patterns and identify which collections are being used most frequently.Input Parameters
Output
List Traffic Reports Total Requests Geo
List Traffic Reports Total Requests Geo
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_REQUESTS_GEOGets the total number of DNS requests by geographic location for organizations in a specified time period. Used for generating heatmap visualizations on the overview dashboard. Returns network IDs, organization IDs, and request counts grouped by geographic location.Input Parameters
Output
List Total Requests Organizations
List Total Requests Organizations
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_REQUESTS_ORGANIZATIONSGet the total number of DNS requests for organizations in a specified time period. Returns time-series data showing request volumes aggregated by configurable time buckets (15 minutes or 1 day). Use this to analyze traffic patterns by organization, identify peak usage times, and monitor DNS request volumes broken down by allowed, blocked, and total counts.Input Parameters
Output
List Traffic Reports Total Requests Users
List Traffic Reports Total Requests Users
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_REQUESTS_USERSGets the total number of requests for users in a period of time. Use this to analyze DNS traffic patterns, monitor user activity, and generate reports on request volume. Supports extensive filtering by time range, user agents, networks, applications, and more. Results can be aggregated by different time buckets (15min or 1day) and optionally grouped by individual users.Input Parameters
Output
List Traffic Reports Total Roaming Clients
List Traffic Reports Total Roaming Clients
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_ROAMING_CLIENTSGets the roaming clients information for the specified organization. Use this to retrieve roaming client statistics and deployment information across organizations.Input Parameters
Output
List Traffic Reports Total Threats
List Traffic Reports Total Threats
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_THREATSGet the total number of threats detected over a specified time period. Returns time-series data showing threat volumes aggregated by configurable time buckets (15 minutes or 1 day). Use this to monitor security threats, analyze threat patterns over time, and identify when threat activity is highest across networks and organizations.Input Parameters
Output
List Traffic Reports Total Threats Agents
List Traffic Reports Total Threats Agents
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_THREATS_AGENTSGet the total number of threats for roaming clients in a period of time. Returns time-series data showing threat counts aggregated by configurable time buckets for agents (roaming clients). Use this to analyze security threat patterns and monitor blocked malicious domains or categories detected for roaming clients.Input Parameters
Output
List Total Threats by Collections
List Total Threats by Collections
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_THREATS_COLLECTIONSTool to retrieve the total number of threats for collections over a specified time period. Use when you need to analyze threat patterns, generate security reports, or monitor DNS-based threats blocked by DNSFilter across different collections.Input Parameters
Output
List Total Threats by Organizations
List Total Threats by Organizations
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_THREATS_ORGANIZATIONSGet the total number of threats detected for organizations over a specified time period. Returns aggregated threat statistics showing how many malicious or dangerous DNS requests were identified across one or more organizations. Use this to monitor security posture, identify at-risk organizations, and track threat trends over time.Input Parameters
Output
List Traffic Reports Total Threats Users
List Traffic Reports Total Threats Users
DNSFILTER_LIST_TRAFFIC_REPORTS_TOTAL_THREATS_USERSGet the total number of threats for users in a period of time. Returns aggregated statistics showing security threats detected across users during the specified time range. Use this to monitor user-level threat activity and identify users encountering security issues.Input Parameters
Output
List User Agent Bulk Deletes Counts
List User Agent Bulk Deletes Counts
DNSFILTER_LIST_USER_AGENT_BULK_DELETES_COUNTSTool to get user agent bulk delete counts by filtering criteria. Use when you need to determine how many user agents can be deleted or uninstalled and deleted based on various filters like agent state, network, tags, or online/offline status.Input Parameters
Output
List User Agent Bulk Updates Counts
List User Agent Bulk Updates Counts
DNSFILTER_LIST_USER_AGENT_BULK_UPDATES_COUNTSGet user agent bulk update counts using filters such as agent state, network, policy, tags, and online status. The response can include counts for undoing uninstall and for operations with no effect.Input Parameters
Output
List User Agent Releases
List User Agent Releases
List User Agent Releases Relay
List User Agent Releases Relay
List All User Agents
List All User Agents
DNSFILTER_LIST_USER_AGENTS_ALLLists user agents with basic information, with optional filters, pagination, and sorting. Returns one requested page at a time.Input Parameters
Output
List User Agents Counts
List User Agents Counts
DNSFILTER_LIST_USER_AGENTS_COUNTSTool to get counts of user agents for each status. Use when you need to retrieve statistics about user agents grouped by their protection status (protected, unprotected, bypassed, etc.). Supports filtering by organization, network, tags, and various other criteria.Input Parameters
Output
List User Agents CSV
List User Agents CSV
List All Users
List All Users
Lookup Network By IP
Lookup Network By IP
Remove Allowed Application
Remove Allowed Application
DNSFILTER_REMOVE_ALLOWED_APPLICATIONRemoves a single application from the allow list of a policy in DNSFilter. Use this action when you need to revoke access for a specific application that was previously allowed. The application will be removed from the policy’s allow_applications list and will no longer bypass filtering rules. This is useful for tightening security policies or removing applications that are no longer needed while maintaining the rest of the filtering configuration.Input Parameters
Output
Remove Allowlist Domains from Policies
Remove Allowlist Domains from Policies
DNSFILTER_REMOVE_ALLOWLIST_DOMAINS_FROM_POLICIESTool to remove one or more domains from one or more policies’ allow lists. Use when you need to bulk remove previously allowed domains from multiple policies at once, useful for security updates or policy cleanup.Input Parameters
Output
Remove Blacklist Category
Remove Blacklist Category
DNSFILTER_REMOVE_BLACKLIST_CATEGORYTool to remove a single category from a policy’s blocklist. Use when you need to unblock a specific content category that was previously restricted in a DNS filtering policy. The category will be removed from the policy’s blacklist_categories array, allowing domains in that category to be accessed.Input Parameters
Output
Remove Blacklist Domain From Policy
Remove Blacklist Domain From Policy
DNSFILTER_REMOVE_BLACKLIST_DOMAIN_FROM_POLICYTool to remove a single domain from a policy’s blocklist. Use when you need to unblock a specific domain that was previously blocked by a policy, such as when correcting false positives or updating filtering rules. The domain will be removed from the specified policy’s blacklist_domains list.Input Parameters
Output
Remove Blocked Application
Remove Blocked Application
DNSFILTER_REMOVE_BLOCKED_APPLICATIONRemoves a single application from the block list of a policy in DNSFilter. Use this action when you need to unblock a specific application that was previously blocked by the filtering policy. The application will be removed from the policy’s block_applications list and will no longer be blocked by this policy. This is useful for allowing previously blocked applications while maintaining other filtering rules.Input Parameters
Output
Remove Blocklist Domains
Remove Blocklist Domains
DNSFILTER_REMOVE_BLOCKLIST_DOMAINSTool to remove one or more domains from one or more policy block lists in bulk. Use when you need to unblock domains across multiple policies simultaneously, such as when removing false positives or updating block list policies.Input Parameters
Output
Remove Whitelist Domain from Policy
Remove Whitelist Domain from Policy
DNSFILTER_REMOVE_WHITELIST_DOMAIN_FROM_POLICYTool to remove a single domain from a policy’s whitelist/allowlist. Use when you need to revoke access for a previously allowed domain, useful for security updates or policy cleanup.Input Parameters
Output
Resend User Invite
Resend User Invite
Suggest Domain Threat
Suggest Domain Threat
DNSFILTER_SUGGEST_DOMAIN_THREATSubmit a domain threat report to DNSFilter for review and potential threat categorization. Use this action when you have identified a suspicious or malicious domain that should be reported to DNSFilter. The submission will be reviewed by DNSFilter’s security team and may result in the domain being categorized as a threat, which will improve protection for all DNSFilter users. This is typically used for reporting newly discovered phishing sites, malware distribution domains, spam sources, or other malicious domains that are not yet properly categorized.Input Parameters
Output
Update Billing Address
Update Billing Address
DNSFILTER_UPDATE_BILLING_ADDRESSUpdates the billing address for a DNSFilter organization. Use this when you need to modify billing contact information, shipping addresses, or invoice recipient details for an organization.Input Parameters
Output
Update Current User
Update Current User
DNSFILTER_UPDATE_CURRENT_USERUpdates profile attributes for the currently authenticated DNSFilter user. Use this action to modify the user’s first name, last name, or phone number. At least one field must be provided in the update request. Common use cases include updating contact information or correcting profile details.Input Parameters
Output
Update Enterprise Connection
Update Enterprise Connection
DNSFILTER_UPDATE_ENTERPRISE_CONNECTIONUpdates an existing enterprise connection for SSO authentication in DNSFilter. Use this action to modify enterprise connection settings such as display name, identity provider configuration, authorized domains, role mappings, and OAuth credentials. Commonly used for updating OIDC, Okta, Azure AD, or Google Workspace SSO integrations. Note: To set a custom login URL, update the organization’s ‘unique_id’ attribute using the PATCH /v1/organizations endpoint.Input Parameters
Output
Update IP Address
Update IP Address
DNSFILTER_UPDATE_IP_ADDRESSUpdates an existing IP address record in DNSFilter with new data. This action modifies an IP address entry by its ID, allowing you to change the IP address itself, reassign it to a different network or organization, or update its dynamic hostname. Common use cases include: - Updating an IP address when your gateway IP changes - Moving an IP address to a different network - Setting or updating the dynamic hostname for better identification Prerequisites: - Must have a valid IP address ID (use GET_IP_ADDRESS or LIST_IP_ADDRESSES to retrieve IDs) - Must provide all required fields (address, organization_id, network_id) even if only changing one - User must have authorization to update IP addresses in the target networkInput Parameters
Output
Update MAC Address
Update MAC Address
DNSFILTER_UPDATE_MAC_ADDRESSESUpdates an existing MAC address entry in DNSFilter with new configuration. This action allows you to modify MAC address settings including the physical address itself, organization assignment, filtering policies, block pages, and custom filter values. Common use cases include: - Correcting a MAC address that was entered incorrectly - Reassigning a MAC address to a different organization - Applying custom filtering policies to specific devices - Setting custom block pages for certain MAC addresses Prerequisites: - Must have a valid MAC address ID (use LIST_MAC_ADDRESSES or LIST_ALL_MAC_ADDRESSES to retrieve) - Must provide organization_id in the update payload - User must have authorization to update MAC addresses Notes: - If both policy_id and scheduled_policy_id are provided, scheduled_policy_id takes precedence - The filter_value defaults to the MAC address without colons if not specified - Returns HTTP 422 if the update cannot be processed with the specified dataInput Parameters
Output
Bulk Update Networks
Bulk Update Networks
DNSFILTER_UPDATE_NETWORKS_BULKTool to bulk update multiple networks with specified configuration changes. Use when you need to apply the same settings (policy, block page, VPN status) to multiple networks simultaneously instead of updating them one by one. This action creates an asynchronous bulk update job that processes multiple networks. Common use cases include: - Applying a new policy to multiple branch office networks - Enabling/disabling legacy VPN across multiple locations - Standardizing block page settings for multiple networks - Updating scheduled policies for multiple sites The operation returns a job ID immediately and processes updates in the background. For updating all networks in an organization, use ids=‘all’ and provide organization_id.Input Parameters
Output
Update Organizations
Update Organizations
DNSFILTER_UPDATE_ORGANIZATIONSUpdates an existing organization with the specified data in DNSFilter. Use this action to modify organization information such as name, billing contacts, address, licensing, MSP management settings, or custom login configurations. Common use cases include updating billing information, changing the organization name, adjusting license quantities, or configuring enterprise SSO settings.Input Parameters
Output
Update Organization User
Update Organization User
DNSFILTER_UPDATE_ORGANIZATIONS_USERSUpdates a user or permissions within an organization in DNSFilter. Use this action to modify user details such as email, name, phone, role, or organization permissions. Common use cases include updating contact information, changing user roles between administrator and read-only, or modifying organization access permissions.Input Parameters
Output
Update Policies
Update Policies
DNSFILTER_UPDATE_POLICIESUpdates an existing DNSFilter policy by ID using a policy update object. Supports changes to category blocking, domain lists, safe search and application controls, with an option to append domains to existing lists.Input Parameters
Output
Update Policies Application
Update Policies Application
DNSFILTER_UPDATE_POLICIES_APPLICATIONUpdates a policy with the specified application data, configuring which policies allow or block access to an application. This action assigns allow and block policy rules to a specific application, controlling which users (based on their assigned policies) can access the application. Common use cases include: - Setting up application-level filtering rules for specific user groups - Blocking access to certain applications for specific policies - Allowing access to applications only for designated policies Prerequisites: - Must have a valid organization_id - Must have a valid application_id (use LIST_APPLICATIONS to retrieve available applications) - Must provide both allow_policies and block_policies lists (can be empty arrays) - User must have authorization to update policies in the target organizationInput Parameters
Output
Update Policy Permissive Mode
Update Policy Permissive Mode
DNSFILTER_UPDATE_POLICIES_PERMISSIVE_MODETool to update the permissive mode setting for a specific policy. Use when you need to enable or disable permissive mode for a DNS filtering policy.Input Parameters
Output
Update Scheduled Policies
Update Scheduled Policies
DNSFILTER_UPDATE_SCHEDULED_POLICIESUpdates an existing scheduled policy in DNSFilter with the specified data. Use this action to modify time-based policy configurations that control filtering rules based on schedules throughout the week. Only include fields you want to update - all fields except the ID are optional. Scheduled policies allow you to apply different filtering policies at different times. Common use cases include stricter filtering during work hours, relaxed filtering during breaks, or different policies for weekdays vs weekends.Input Parameters
Output
Update Scheduled Reports
Update Scheduled Reports
DNSFILTER_UPDATE_SCHEDULED_REPORTSUpdates an existing scheduled report configuration in DNSFilter. Use this action to modify report frequency, delivery schedule, content options, or recipient settings. Common use cases include changing the day of the week for report delivery, adjusting which content categories are included, or enabling/disabling threat summaries.Input Parameters
Output
Update User Agent Cleanups
Update User Agent Cleanups
DNSFILTER_UPDATE_USER_AGENT_CLEANUPSUpdates a user agent cleanup operation in DNSFilter. Use this to modify the inactivity threshold or start/restart a cleanup job. This action allows you to: 1. Change the ‘inactive_for’ threshold to adjust which agents are included in the cleanup (automatically restarts the job) 2. Start the cleanup process by setting ‘start’ to true (only works if ‘inactive_for’ is not provided) Common use cases: - Adjust the inactivity threshold from 30 to 45 days to be more conservative about deletions - Start a previously configured cleanup job that hasn’t been started yet - Restart a cleanup job with a new threshold to recalculate which agents should be deleted Note: When ‘inactive_for’ is provided, it takes precedence and restarts the job, making ‘start’ parameter ineffective.