Skip to main content
Nextdns logo
  • Category: security & identity tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 68
  • Triggers: 0
  • Slug: NEXTDNS
  • Version: 20261101_00

Tools

Slug: NEXTDNS_ADD_ALLOWLIST_ENTRYTool to add a domain to the allowlist of a NextDNS profile. Use when allowing specific domains under a profile after obtaining its ID.

Input Parameters

boolean
Whether the allowlist entry is active. Defaults to true.
string
required
The domain to add to the allowlist.
string
required
The 6-character alphanumeric identifier of the NextDNS profile. Use NEXTDNS_LIST_CONFIGURATIONS to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_ADD_BLOCKED_TLDTool to add a top-level domain to the security blocklist for a NextDNS profile. Use after listing current security settings to ensure the TLD is not already blocked.

Input Parameters

string
required
The top-level domain to block without the leading dot (e.g., ‘io’, ‘xyz’, ‘network’).
string
required
ID of the NextDNS profile to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_ADD_DENYLIST_DOMAINTool to add a domain to the denylist of a NextDNS profile. Use when blocking specific domains under a profile after obtaining its ID.

Input Parameters

boolean
Whether the denylist entry is active. Defaults to true.
string
required
NextDNS profile configuration ID.
string
required
The domain to add to the denylist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_ADD_PARENTAL_CONTROL_CATEGORYTool to add a content category to the parental control categories list. Use when you need to add a new category to block or allow specific content types like pornography, gambling, or social networks.

Input Parameters

boolean
Whether the category block is active. Set to true to block this category, false to add it as unblocked.
string
required
The unique 6-character alphanumeric identifier of the NextDNS profile. Obtain this from the LIST_CONFIGURATIONS action.
string
required
The category identifier to add (e.g., ‘porn’, ‘gambling’, ‘dating’, ‘piracy’, ‘social-networks’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_ADD_PARENTAL_CONTROL_SERVICETool to add a service to the parental control services list of a NextDNS profile. Use when blocking specific services (like social media platforms) under a profile.

Input Parameters

string
required
The service ID to add (e.g., ‘tiktok’, ‘facebook’, ‘instagram’).
boolean
Whether the service is blocked (true) or allowed (false). Defaults to true.
string
required
The profile ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_ADD_PRIVACY_BLOCKLISTTool to add a blocklist to the privacy blocklists for a NextDNS profile. Use when enabling additional privacy blocklists for a profile.

Input Parameters

string
required
The blocklist ID to add. Common IDs include ‘nextdns-recommended’, ‘oisd’, ‘easylist’, ‘adguard-dns-filter’.
string
required
NextDNS profile configuration ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_ADD_PRIVACY_NATIVETool to add a native tracking service to the blocked list for a NextDNS profile. Use when blocking native trackers from specific vendors.

Input Parameters

string
required
The native tracking service ID to block (e.g., ‘xiaomi’, ‘apple’, ‘samsung’, ‘huawei’, ‘windows’, ‘amazon’, ‘sonos’, ‘roku’).
string
required
NextDNS profile ID to add the native tracking service to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_ADD_REWRITETool to add a DNS rewrite rule to a NextDNS profile. Use when you need to configure custom DNS resolution for specific domains.

Input Parameters

string
required
The domain name to rewrite. Can be a full domain or subdomain.
string
required
The IP address or domain to rewrite to. This is the target that the domain will resolve to.
string
required
The 6-character alphanumeric identifier of the NextDNS profile. Use NEXTDNS_LIST_CONFIGURATIONS to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_CLEAR_LOGSTool to clear DNS logs for a NextDNS profile. Use when you want to remove all existing query logs for a given profile. Note: this operation cannot be undone.

Input Parameters

string
required
The unique 6-character alphanumeric ID of the NextDNS profile to clear logs for. Obtain this from NEXTDNS_LIST_CONFIGURATIONS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_CREATE_PROFILEThis tool allows users to create a new NextDNS profile. It uses the POST method at the endpoint https://api.nextdns.io/profiles. A profile is a distinct configuration set for DNS filtering and security settings.

Input Parameters

string
required
Name of the new profile.
object
Privacy settings for the profile.
array
List of domains to denylist.
object
Security settings for the profile.
object
General settings for the profile.
array
List of domains to allowlist.
object
Parental control settings for the profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_DELETE_ALLOWLIST_ENTRYTool to remove a domain from a NextDNS profile’s allowlist. Use when you need to stop allowing a previously whitelisted domain.

Input Parameters

string
required
The domain to remove from the profile’s allowlist. Must exactly match a domain currently in the allowlist.
string
required
The 6-character alphanumeric ID of the NextDNS profile. Use ‘List Configurations’ to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_DELETE_CONFIGTool to delete a NextDNS configuration profile. Use when you need to remove an existing profile by its ID. Use after confirming the profile exists.

Input Parameters

string
required
The ID of the NextDNS configuration profile to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_DELETE_PARENTAL_CONTROL_CATEGORYTool to remove a category from parental control blocked categories. Use when you need to unblock a content category that was previously blocked. Use ‘Get Parental Control Categories’ first to verify the category is currently blocked.

Input Parameters

string
required
The unique 6-character alphanumeric identifier of the NextDNS profile. Obtain this from the LIST_CONFIGURATIONS action.
string
required
The category identifier to remove from blocked categories (e.g., ‘dating’, ‘porn’, ‘gambling’, ‘social-networks’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_DELETE_PARENTAL_CONTROL_SERVICETool to remove a service from parental control blocked services. Use when you need to unblock a service (like TikTok, Instagram, or other apps) that was previously blocked.

Input Parameters

string
required
The unique 6-character alphanumeric identifier of the NextDNS profile. Obtain this from the LIST_CONFIGURATIONS action.
string
required
The service identifier to remove from blocked services (e.g., ‘tiktok’, ‘instagram’, ‘facebook’, ‘snapchat’, ‘twitter’, ‘youtube’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_DELETE_PRIVACY_BLOCKLISTTool to remove a blocklist from the privacy blocklists for a NextDNS profile. Use when disabling or removing privacy blocklists from a profile.

Input Parameters

string
required
The ID of the NextDNS profile. This is the unique 6-character alphanumeric identifier for the profile.
string
required
The blocklist identifier to remove. Common IDs include ‘nextdns-recommended’, ‘oisd’, ‘easylist’, ‘adguard-dns-filter’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_DELETE_PRIVACY_NATIVETool to remove a native tracking entry from a NextDNS profile’s privacy settings. Use when you need to stop blocking a specific native app tracker (like Apple, Samsung, Huawei, etc.).

Input Parameters

string
required
The 6-character alphanumeric ID of the NextDNS profile. Use ‘List Configurations’ to get available profile IDs.
string
required
The native tracking identifier to remove. Must exactly match a native tracker currently in the profile’s privacy settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_DELETE_REWRITETool to delete a DNS rewrite rule from a NextDNS profile. Use when you need to remove an existing DNS rewrite rule by its ID.

Input Parameters

string
required
The 6-character alphanumeric ID of the NextDNS profile. Use ‘List Configurations’ to get available profile IDs.
string
required
The unique identifier of the DNS rewrite rule to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_DOWNLOAD_LOGSRetrieves the download URL for exported DNS query logs from a NextDNS profile. Returns a time-limited URL pointing to a CSV file containing the profile’s DNS logs. Use this to export log data for analysis, backup, or compliance purposes. The profile_id can be obtained from the list_configurations action.

Input Parameters

boolean
Controls the API response format. When True (default), the API returns a 302 redirect with the log file URL in the Location header. When False, the API returns a JSON response containing the ‘url’ field. Either way, this tool extracts and returns the URL.
string
required
ID of the NextDNS profile to download logs for (e.g., ‘abc123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ALLOWLISTTool to retrieve the list of allowed domains for a NextDNS profile. Use when you need to view all domains currently whitelisted in a profile.

Input Parameters

string
required
The 6-character alphanumeric identifier of the NextDNS profile. Use LIST_CONFIGURATIONS to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ANALYTICS_DESTINATIONSTool to retrieve destination analytics for a profile showing query destinations by country or GAFAM company. Use when you need to understand geographic distribution or big tech company query patterns.

Input Parameters

string ("countries" | "gafam")
required
Destination type: ‘countries’ for geographic distribution by country code, or ‘gafam’ for GAFAM (Google, Apple, Facebook, Amazon, Microsoft) company distribution.
integer
Limit number of items to return (1-500)
string
Opaque pagination cursor for next page
string
Filter analytics for a specific device ID. Use ‘UNIDENTIFIED’ for unidentified devices.
string
required
The 6-character alphanumeric NextDNS profile ID (e.g., ‘ef5c1a’). Use LIST_CONFIGURATIONS to get available profile IDs.
string
Filter out entities with date newer or equal (exclusive). Same formats as from_date.
string
Filter out entities with date older than (inclusive). Supports ISO8601, Unix timestamps, and relative dates (e.g. ‘-7d’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ANALYTICS_DEVICES2Tool to retrieve device analytics for a profile showing identified devices with names, models, and query counts. Use when you need per-device query metrics within a specific time frame.

Input Parameters

integer
Limit results per page (1-500, default: 10).
string
Pagination cursor for next page
string
Filter by specific device ID. Use ‘UNIDENTIFIED’ to target unidentified devices.
string
required
ID of the NextDNS profile to query
string
Filter out entities with newer or equal date (exclusive). Supports same formats as from_date.
string
Filter out entities with older date (inclusive). Supports ISO 8601, Unix timestamps (s/ms), relative (e.g., ‘-7d’), or common date formats.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ANALYTICS_DNSSECTool to retrieve DNSSEC validation analytics for a profile showing validated vs non-validated query counts. Use after selecting a profile to analyze DNSSEC validation statistics.

Input Parameters

integer
Number of results per page (1-500).
string
Opaque pagination cursor for next page.
string
Filter analytics for a specific device ID. Use ‘UNIDENTIFIED’ to filter unidentified devices only.
string
required
NextDNS profile ID (6-character alphanumeric identifier). Obtain from NEXTDNS_LIST_CONFIGURATIONS.
string
Exclusive end date filter. Same formats as from_date.
string
Inclusive start date filter. Supports ISO8601, Unix timestamps, and relative formats (e.g., ‘-7d’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ANALYTICS_DOMAINSTool to retrieve analytics data for domains within a specific profile. Use after confirming the profile ID to get per-domain query stats.

Input Parameters

boolean
Return root domains instead of full hostnames (e.g. ‘icloud.com’ instead of ‘gateway.icloud.com’).
integer
Limit number of items to return (1-500)
string
Opaque pagination cursor for next page
string
Filter analytics for a specific device ID. Use ‘UNIDENTIFIED’ for unidentified devices.
string ("default" | "blocked" | "allowed")
Filter domains by resolution status: ‘default’ (resolved normally), ‘blocked’ (blocked by rules/security), or ‘allowed’ (explicitly allowed).
string
required
The 6-character alphanumeric NextDNS profile ID (e.g., ‘ef5c1a’). Use LIST_CONFIGURATIONS to get available profile IDs.
string
Filter out entities with date newer or equal (exclusive). Same formats as from_date.
string
Filter out entities with date older than (inclusive). Supports ISO8601, Unix timestamps, and relative dates (e.g. ‘-7d’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ANALYTICS_ENCRYPTIONTool to retrieve encryption analytics for a profile showing encrypted vs unencrypted query counts. Use when you need to understand the breakdown of DNS queries by encryption status (DoH/DoT vs plain DNS).

Input Parameters

string
Filter out entities with newer or equal date (exclusive). Same formats as from.
string
Filter out entities with older date (inclusive). Supports ISO8601, Unix timestamps, and relative dates (e.g., ‘-7d’).
integer
Limit number of results per page (1-500).
string
Pagination cursor for next page
string
Filter analytics for a specific device ID. Use ‘UNIDENTIFIED’ for unidentified devices.
string
required
The 6-character alphanumeric NextDNS profile ID (e.g., ‘ef5c1a’). Use LIST_CONFIGURATIONS to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ANALYTICS_IPSTool to retrieve analytics aggregated by client IP addresses. Use when you need to analyze DNS query distribution per client IP for a given profile.

Input Parameters

string
Exclusive end date filter. Same formats as from.
string
Inclusive start date filter. Supports ISO8601, Unix timestamps (s/ms), relative (e.g. ‘-7d’) or common date formats.
integer
Limit number of items to return (1-500).
string
Opaque pagination cursor for next page.
string
Filter analytics for a specific device ID. Use ‘UNIDENTIFIED’ for unidentified devices.
string
required
ID of the NextDNS profile to query

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ANALYTICS_IP_VERSIONSTool to retrieve analytics grouped by IP version within a specific profile. Use after you have a profile ID to see IPv4 vs IPv6 query counts.

Input Parameters

string
Filter out entities with date newer or equal (exclusive). Same formats as from_date.
string
Filter out entities with date older than (inclusive). Supports ISO8601, Unix timestamps (s/ms), relative dates (e.g. ‘-7d’), or common date formats.
integer
Limit number of items to return (1-500)
string
Opaque pagination cursor for next page
string
Filter analytics for a specific device ID. Use ‘UNIDENTIFIED’ for unidentified devices.
string
required
The 6-character alphanumeric NextDNS profile ID (e.g., ‘ef5c1a’). Obtain this from the list_configurations action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ANALYTICS_PROTOCOLSTool to retrieve protocol analytics for a specific profile showing DNS protocol distribution (DNS-over-HTTPS, DNS-over-TLS, UDP). Use after confirming the profile ID to analyze protocol usage patterns.

Input Parameters

integer
Limit number of items to return (1-500)
string
Opaque pagination cursor for next page
string
Filter analytics for a specific device ID. Use ‘UNIDENTIFIED’ for unidentified devices.
string
required
The 6-character alphanumeric NextDNS profile ID (e.g., ‘ef5c1a’). Use LIST_CONFIGURATIONS to get available profile IDs.
string
Filter out entities with date newer or equal (exclusive). Same formats as from_date.
string
Filter out entities with date older than (inclusive). Supports ISO8601, Unix timestamps, and relative dates (e.g. ‘-7d’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ANALYTICS_QUERY_TYPESTool to retrieve DNS query counts broken down by query type. Use after selecting a profile and specifying date filters to analyze distribution by type.

Input Parameters

integer
Number of results per page (1-500).
string
Opaque pagination cursor for next page.
string
Filter by device ID; use ‘UNIDENTIFIED’ for unidentified devices.
string
required
ID of the NextDNS profile to query
string
Exclusive end date filter (exclusive). Same formats as from_date.
string
Inclusive start date filter (inclusive). Supports ISO 8601, Unix timestamps (s/ms), relative dates (e.g., ‘-7d’), or common date formats.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ANALYTICS_REASONS2Tool to retrieve blocking reasons analytics showing blocklists, native tracking protection, and other reasons for blocked queries. Use after selecting a profile to understand what categories are blocking queries.

Input Parameters

integer
Number of results per page (1-500, default: 10).
string
Opaque pagination cursor for next page.
string
Filter analytics for a specific device ID. Use ‘UNIDENTIFIED’ to filter unidentified devices only.
string
required
NextDNS profile ID (6-character alphanumeric identifier). Obtain from NEXTDNS_LIST_CONFIGURATIONS.
string
Exclusive end date filter. Same formats as from_date.
string
Inclusive start date filter. Supports ISO8601, Unix timestamps, and relative formats (e.g., ‘-7d’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_ANALYTICS_STATUSTool to retrieve analytics status for a specific profile. Use when you need counts of DNS queries broken down by status categories.

Input Parameters

string
Exclusive end date filter (exclusive). Same formats as from.
string
Inclusive start date filter (inclusive). Supports ISO 8601, Unix timestamps (s/ms), relative (e.g., ‘-7d’), or common date formats.
integer
Number of results per page (1-500).
string
Pagination cursor for the next page.
string
Filter results by device ID. Use ‘UNIDENTIFIED’ for unidentified devices.
string
required
ID of the NextDNS profile to query

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_LOGSTool to retrieve logs for a specific NextDNS profile with optional filters. Use after confirming the profile ID to fetch raw or filtered DNS logs.

Input Parameters

string
Filter out logs newer or equal to this date (exclusive). Same formats as from.
boolean
Return raw DNS queries instead of filtered navigational ones.
string
Filter out logs older than or equal to this date (inclusive). Accepts ISO8601, unix timestamps, relative (e.g. ‘-1d’), or common date formats.
string ("asc" | "desc")
Order of returned logs: ‘asc’ for oldest→newest or ‘desc’ for newest→oldest.
integer
Maximum number of logs to return (10–1000).
string
Opaque pagination cursor from previous response.
string
Filter logs for a specific device ID.
Search logs by domain or substring. E.g., ‘facebook’ matches any domain containing that substring.
string ("default" | "error" | "blocked" | "allowed")
Filter logs by status.
string
required
ID of the NextDNS profile to retrieve logs for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_PARENTAL_CONTROLTool to get parental control settings for a profile. Returns services, categories, safe search, YouTube restricted mode, and bypass blocking status.

Input Parameters

string
required
The unique 6-character alphanumeric identifier of the NextDNS profile. Obtain this from the LIST_CONFIGURATIONS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_PARENTAL_CONTROL_CATEGORIESTool to get the list of blocked/allowed content categories for parental control. Use when you need to check which content categories are currently blocked or allowed for a specific profile.

Input Parameters

string
required
The unique 6-character alphanumeric identifier of the NextDNS profile. Obtain this from the LIST_CONFIGURATIONS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_PARENTAL_CONTROL_SERVICESTool to get the list of blocked/allowed services for parental control. Use when you need to review which services (like TikTok, Facebook, Netflix) are currently blocked or allowed in a profile’s parental control settings.

Input Parameters

string
required
The unique 6-character alphanumeric identifier of the NextDNS profile. Obtain this from the LIST_CONFIGURATIONS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_PERFORMANCE_SETTINGSTool to get performance settings for a profile including ECS, cache boost, and CNAME flattening configuration. Use when you need to check current performance optimization settings before making changes.

Input Parameters

string
required
The unique 6-character alphanumeric identifier of the NextDNS profile to retrieve performance settings for. Obtain this from the LIST_CONFIGURATIONS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_PRIVACY_SETTINGSTool to get privacy settings for a profile including blocklists, native tracking settings, disguised trackers, and affiliate settings. Use when you need to check the current privacy configuration before making changes.

Input Parameters

string
required
The unique 6-character alphanumeric identifier of the NextDNS profile to retrieve privacy settings for. Obtain this from the LIST_CONFIGURATIONS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_PROFILERetrieves the details of a specific NextDNS profile. It requires a ‘profileId’ as a path parameter and returns the profile details including name, security, privacy, parental control, denylist, allowlist, and general settings.

Input Parameters

string
required
The unique 6-character alphanumeric identifier of the NextDNS profile to retrieve. Obtain this from the LIST_CONFIGURATIONS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_REWRITESTool to retrieve the list of DNS rewrites for a NextDNS profile. Use when you need to view all custom DNS rewrite rules configured in a profile.

Input Parameters

string
required
The 6-character alphanumeric identifier of the NextDNS profile. Use LIST_CONFIGURATIONS to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_SECURITY_TLDSTool to get the list of blocked TLDs (top-level domains) for a profile’s security settings. Use when you need to retrieve only the blocked TLDs without fetching all security settings.

Input Parameters

string
required
The profile ID to retrieve blocked TLDs for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_SETTINGSGet a NextDNS profile’s settings for logs, block page, performance, and Web3.

Input Parameters

string
required
The unique 6-character alphanumeric identifier of the NextDNS profile to retrieve settings for. Obtain this from the list_profiles action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_SETTINGS_BLOCKPAGETool to retrieve the block page settings for a NextDNS profile. Use when you need to check if the block page is currently enabled or disabled for a specific profile.

Input Parameters

string
required
The unique identifier of the NextDNS profile. Use LIST_CONFIGURATIONS to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_GET_SETTINGS_LOGSTool to retrieve the logging settings for a NextDNS profile. Use when you need to check logging status, data retention period, storage location, or privacy options.

Input Parameters

string
required
The unique identifier of the NextDNS profile. Use LIST_CONFIGURATIONS to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_LIST_DENYLIST_DOMAINSTool to list domains in the denylist for a profile. Use after confirming the profile ID to review all blocked domains. Example: “List denylist domains for profile abc123.”

Input Parameters

string
required
The 6-character alphanumeric identifier of the NextDNS profile whose denylist to retrieve. Use NEXTDNS_LIST_CONFIGURATIONS to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_LIST_PROFILESList all NextDNS profiles for the authenticated user, returning profile IDs and configurations. Returns all profiles with their IDs, names, fingerprints, and user roles. Profile IDs returned by this action are used as the ‘profileId’ or ‘config_id’ parameter for other NextDNS actions (e.g., get profile details, update profile, etc.).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_LIST_SECURITY_SETTINGSTool to list current security options for a NextDNS configuration. Use after obtaining the configuration ID to review active security settings.

Input Parameters

string
required
NextDNS profile configuration ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_LOG_CLIENT_IPSTool to enable or disable logging of client IPs for a NextDNS configuration. Use when you need to toggle whether client IPs are recorded in DNS logs.

Input Parameters

boolean
required
True to enable logging of client IPs, False to disable.
string
required
NextDNS configuration (profile) ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_LOG_DOMAINSTool to enable or disable logging of domains for a NextDNS profile. Use after retrieving profile settings when you need to adjust domain logging. Example: “Enable domain logging for profile abc123.”

Input Parameters

boolean
required
Whether to enable (True) or disable (False) logging of domains in the profile’s DNS logs.
string
required
ID of the NextDNS profile to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_REMOVE_BLOCKED_TLDTool to remove a top-level domain from the security blocklist for a NextDNS profile. Use after listing current security settings to confirm the TLD is currently blocked.

Input Parameters

string
required
The top-level domain to unblock (without leading dot, e.g., ‘io’ not ‘.io’).
string
required
ID of the NextDNS profile to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_REMOVE_DENYLIST_DOMAINRemoves a domain from a NextDNS profile’s denylist (blocklist). The domain will no longer be blocked by the DNS filter after removal. Use ‘List Denylist Domains’ first to verify the domain exists in the denylist before attempting removal.

Input Parameters

string
required
The domain to remove from the profile’s denylist. Must exactly match a domain currently in the denylist.
string
required
The 6-character alphanumeric ID of the NextDNS profile. Use ‘List Configurations’ to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_RENAME_CONFIGTool to rename a NextDNS configuration (profile). Use when you need to update a profile’s name after obtaining its ID. Example: RenameConfig(name=“Home Profile”, config_id=“d46a5b”)

Input Parameters

string
required
The new name for the configuration. Must be non-empty and at most 100 characters.
string
required
The NextDNS configuration (profile) ID to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_REPLACE_ALLOWLISTTool to replace the entire allowlist for a NextDNS profile. Use when you need to set a complete list of allowed domains, replacing all existing entries.

Input Parameters

string
required
The 6-character alphanumeric identifier of the NextDNS profile. Use NEXTDNS_LIST_CONFIGURATIONS to get available profile IDs.
array
required
Array of domain objects to set as the complete allowlist. This will replace all existing allowlist entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_REPLACE_DENYLISTTool to replace the entire denylist (blocked domains) for a NextDNS profile. This operation completely replaces all existing denylist entries with the provided list. Use when you need to bulk update the denylist or clear all blocked domains. To add/remove individual domains, use NEXTDNS_ADD_DENYLIST_DOMAIN or NEXTDNS_REMOVE_DENYLIST_DOMAIN instead.

Input Parameters

string
required
The 6-character alphanumeric identifier of the NextDNS profile whose denylist to replace. Use NEXTDNS_LIST_CONFIGURATIONS to get available profile IDs.
array
required
Array of domain objects to set as the complete denylist. This will replace all existing denylist entries. Each entry requires ‘id’ (domain name) and ‘active’ (boolean) fields. Pass an empty array to clear the denylist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_REPLACE_PARENTAL_CONTROL_CATEGORIESTool to replace the entire list of blocked/allowed content categories for parental control. Use this to set which content categories should be blocked or allowed for a profile.

Input Parameters

string
required
The 6-character alphanumeric NextDNS profile ID. Use NEXTDNS_LIST_CONFIGURATIONS to get available profile IDs.
array
required
Complete array of category objects to replace the existing list. Each object must have ‘id’ (category name) and ‘active’ (boolean) properties. This replaces the entire categories list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_REPLACE_PARENTAL_CONTROL_SERVICESTool to replace the entire list of blocked/allowed services for parental control. Use when you need to set all service restrictions at once, replacing existing settings.

Input Parameters

string
required
The 6-character alphanumeric NextDNS profile ID. Get this from NEXTDNS_LIST_CONFIGURATIONS.
array
required
Complete list of services to set. Each entry requires ‘id’ (service identifier) and ‘active’ (true to block, false to allow). Use an empty list [] to clear all service restrictions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_REPLACE_PRIVACY_BLOCKLISTSTool to replace the entire list of privacy blocklists for a NextDNS profile. This operation completely replaces all existing blocklists with the provided list. Use when you need to bulk update privacy blocklists or clear all blocklists.

Input Parameters

string
required
The unique 6-character alphanumeric identifier of the NextDNS profile. Obtain this from the LIST_PROFILES or LIST_CONFIGURATIONS action.
array
required
Array of blocklist objects to set as the complete privacy blocklists. This will replace all existing blocklists. Each entry requires ‘id’ field. Pass an empty array to clear all blocklists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_REPLACE_PRIVACY_NATIVESTool to replace the entire list of blocked native tracking services for a NextDNS profile. This operation completely replaces all existing native tracking service blocks with the provided list. Use when you need to bulk update blocked native trackers or clear all blocks.

Input Parameters

array
required
Array of native tracking service objects to set as the complete list. This will replace all existing native tracking service entries. Each entry requires an ‘id’ field with the service identifier. Pass an empty array to unblock all native tracking services.
string
required
The 6-character alphanumeric identifier of the NextDNS profile whose native tracking services to replace. Use NEXTDNS_LIST_CONFIGURATIONS to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_REPLACE_SECURITY_TLDSTool to replace the entire list of blocked TLDs (top-level domains) for a NextDNS profile’s security settings. This operation completely replaces all existing blocked TLDs with the provided list. Use when you need to bulk update blocked TLDs or clear all TLD blocks. To add/remove individual TLDs, use NEXTDNS_ADD_BLOCKED_TLD or NEXTDNS_REMOVE_BLOCKED_TLD instead.

Input Parameters

array
required
Array of TLD objects to set as the complete blocked TLD list. This will replace all existing blocked TLDs. Pass an empty array to clear all blocked TLDs.
string
required
The 6-character alphanumeric identifier of the NextDNS profile. Use NEXTDNS_LIST_CONFIGURATIONS to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_UPDATE_ALLOWLIST_ENTRYTool to update a specific allowlist entry in a NextDNS profile. Use when toggling the active status of a domain in the allowlist.

Input Parameters

boolean
required
Whether the allowlist entry should be active (true) or inactive (false). When inactive, the domain will not be allowed through the filter.
string
required
The domain name of the allowlist entry to update. Must exactly match a domain currently in the allowlist.
string
required
The 6-character alphanumeric ID of the NextDNS profile. Use NEXTDNS_LIST_CONFIGURATIONS to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_UPDATE_DENYLIST_ENTRYUpdates a specific denylist entry in a NextDNS profile, typically to toggle its active status. Use when you need to temporarily enable or disable blocking for a domain without removing it from the denylist.

Input Parameters

boolean
required
Whether the denylist entry should be active (true) or inactive (false). Set to false to temporarily disable blocking without removing the entry.
string
required
The domain name of the denylist entry to update. Must exactly match a domain currently in the denylist.
string
required
The 6-character alphanumeric ID of the NextDNS profile. Use ‘List Configurations’ to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_UPDATE_LINKED_IPUpdates the linked IP address for a NextDNS profile using the public IP of the tool’s outgoing request. This can be used for dynamic DNS setups.

Input Parameters

string
required
The unique 6-character alphanumeric ID of the NextDNS profile (configuration). Obtain this from the ‘List Configurations’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_UPDATE_PARENTAL_CONTROLTool to update parental control settings for a NextDNS profile. Use when you need to change safe search, YouTube restricted mode, or bypass blocking settings.

Input Parameters

string
required
The 6-character alphanumeric NextDNS profile ID to update parental control settings for. Get this from the list_configurations action.
Enable (true) or disable (false) safe search enforcement on search engines like Google, Bing, DuckDuckGo, etc.
boolean
Block (true) or allow (false) bypass methods such as VPNs, proxies, and Tor to prevent circumventing parental controls.
boolean
Enable (true) or disable (false) YouTube Restricted Mode to filter out potentially mature content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_UPDATE_PARENTAL_CONTROL_CATEGORYTool to update a specific category entry in parental control settings. Use when you need to enable or disable blocking for a specific content category like pornography, gambling, or social networks.

Input Parameters

boolean
required
Whether the category block is active. Set to true to block this category, false to unblock.
string
required
NextDNS profile configuration ID. Get this from NEXTDNS_LIST_CONFIGURATIONS.
string
required
The category identifier to update (e.g., ‘porn’, ‘gambling’, ‘dating’, ‘piracy’, ‘social-networks’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_UPDATE_PARENTAL_CONTROL_SERVICETool to update a specific service entry in parental control settings. Use when toggling individual service blocks (e.g., blocking TikTok, Instagram, or other social media/gaming services).

Input Parameters

boolean
required
Set to true to block the service, or false to allow it. When active=true, the service will be blocked by the DNS filter.
string
required
The 6-character alphanumeric NextDNS profile ID. Use NEXTDNS_LIST_CONFIGURATIONS to get available profile IDs.
string
required
The service identifier to update. Common service IDs include: tiktok, instagram, facebook, snapchat, twitter, youtube, netflix, fortnite, roblox, minecraft, discord, telegram, whatsapp, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_UPDATE_PERFORMANCE_SETTINGSUpdates a NextDNS profile’s performance settings. All three settings—ECS, cache boost, and CNAME flattening—must be supplied and are sent together.

Input Parameters

boolean
required
Enable (true) or disable (false) EDNS Client Subnet (ECS).
string
required
NextDNS profile configuration ID to update.
boolean
required
Enable (true) or disable (false) cache boost.
boolean
required
Enable (true) or disable (false) CNAME flattening.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_UPDATE_PRIVACY_SETTINGSTool to update privacy settings for a profile. Use when you need to change blocklists, native trackers, disguisedTrackers, or allowAffiliate in one call.

Input Parameters

string
required
NextDNS profile configuration ID to update privacy settings for. Get this from the list_configurations action.
array
List of native trackers to block. When provided, replaces ALL existing native trackers. Use an empty list [] to remove all. Common IDs: ‘apple’, ‘samsung’, ‘windows’, ‘huawei’, ‘xiaomi’, ‘amazon’, ‘sonos’, ‘roku’.
array
List of blocklists to enable. When provided, replaces ALL existing blocklists. Use an empty list [] to remove all blocklists. Common IDs: ‘nextdns-recommended’, ‘oisd’, ‘easylist’, ‘adguard-dns-filter’.
boolean
Allow (true) or block (false) affiliate and tracking links while preserving privacy.
boolean
Enable (true) or disable (false) blocking of disguised third-party trackers using CNAME cloaking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_UPDATE_SECURITY_SETTINGSTool to update security settings for a profile. Use when you need to change multiple security settings like threat intelligence, AI detection, safe browsing, and other protections in one call.

Input Parameters

boolean
Enable (true) or disable (false) blocking of DGA (Domain Generation Algorithm) domains often used by malware.
boolean
Enable (true) or disable (false) blocking of newly registered domains (less than 30 days old) to prevent zero-day attacks.
boolean
Enable (true) or disable (false) blocking of domains associated with child sexual abuse material (CSAM).
boolean
Enable (true) or disable (false) blocking of dynamic DNS domains often used by malware for command and control.
boolean
Enable (true) or disable (false) blocking of parked domains that display ads or redirect traffic.
string
required
NextDNS profile ID to update security settings for. Get this from the list_profiles action.
boolean
Enable (true) or disable (false) DNS rebinding protection to prevent attacks on your local network.
boolean
Enable (true) or disable (false) blocking of cryptojacking domains that mine cryptocurrency using your device.
boolean
Enable (true) or disable (false) protection against IDN homograph attacks that use look-alike characters to impersonate domains.
boolean
Enable (true) or disable (false) protection against typosquatting domains that exploit common typing mistakes.
boolean
Enable (true) or disable (false) AI-powered threat detection to identify and block emerging threats.
boolean
Enable (true) or disable (false) Google Safe Browsing for malware and phishing protection.
boolean
Enable (true) or disable (false) real-time threat intelligence feeds to block domains associated with known threats.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_UPDATE_SETTINGSTool to update settings for a NextDNS profile including logs, block page, performance, and web3 settings. Use when you need to modify multiple settings categories in one operation. Only provide the specific settings you want to change - all fields are optional except profile ID.

Input Parameters

object
Log configuration settings for query logging and retention.
boolean
Enable (true) or disable (false) Web3 domain resolution (e.g., .eth, .crypto domains via ENS/Unstoppable Domains).
string
required
Unique identifier of the NextDNS profile to update settings for. Get this from list_profiles or list_configurations.
object
Block page display settings.
object
Performance optimization settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEXTDNS_UPDATE_SETTINGS_BLOCKPAGETool to update block page settings for a NextDNS profile. Use when you need to enable or disable the branded block page that users see when accessing blocked domains.

Input Parameters

boolean
required
Enable (true) or disable (false) the block page. When enabled, users see a branded page when accessing blocked domains. When disabled, blocked domains return NXDOMAIN silently.
string
required
The NextDNS profile ID to update block page settings for. Use LIST_PROFILES to get available profile IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not