Skip to main content
Server path: /dnsfilter | Type: Application | PCID required: Yes

Tools

ToolDescription
dnsfilter_create_ip_addressTool to create a new ip address in dnsfilter.
dnsfilter_get_application_categoryTool to get basic information of a specific application category.
dnsfilter_get_billing_informationTool to retrieve basic billing information for an organization.
dnsfilter_get_categoryTool to get basic information of a specific category.
dnsfilter_get_ip_addressTool to get basic information of the specified ip address.
dnsfilter_list_all_categoriesTool to list all categories including internal categories.
dnsfilter_list_all_ip_addressesTool to list all user-associated ip addresses with basic information.
dnsfilter_list_all_mac_addressesTool to list all mac addresses with basic information.
dnsfilter_list_application_categoriesTool to list application categories with basic information.
dnsfilter_list_applicationsTool to list applications with basic information.
dnsfilter_list_block_pagesTool to list block pages associated with the current user.
dnsfilter_list_categoriesTool to list categories with basic information.
dnsfilter_list_invoicesTool to list invoices for an organization, most recent first.
dnsfilter_list_ip_addressesTool to list user-associated ip addresses with basic information.
dnsfilter_list_mac_addressesTool to list mac addresses associated with an organization.
dnsfilter_list_networksTool to list all networks.
dnsfilter_list_organizationsTool to list all organizations.
dnsfilter_suggest_domain_threatTool to suggest a fqdn as a potential threat.
dnsfilter_verify_ip_addressTool to verify that an ip address is not already in the system.

dnsfilter_create_ip_address

Tool to create a new ip address in dnsfilter. Parameters:
ParameterTypeRequiredDefaultDescription
ip_addressobjectYesIP address creation request parameters

dnsfilter_get_application_category

Tool to get basic information of a specific application category. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesApplication category ID

dnsfilter_get_billing_information

Tool to retrieve basic billing information for an organization. Parameters:
ParameterTypeRequiredDefaultDescription
organization_idintegerYesUser organization ID

dnsfilter_get_category

Tool to get basic information of a specific category. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCategory ID

dnsfilter_get_ip_address

Tool to get basic information of the specified ip address. Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesIP address ID

dnsfilter_list_all_categories

Tool to list all categories including internal categories. Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPagination parameters

dnsfilter_list_all_ip_addresses

Tool to list all user-associated ip addresses with basic information. Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPagination parameters

dnsfilter_list_all_mac_addresses

Tool to list all mac addresses with basic information. Parameters:
ParameterTypeRequiredDefaultDescription
organization_idsany[]NoOrganization IDs, defaults to user organization ID
pageobjectNoPagination parameters

dnsfilter_list_application_categories

Tool to list application categories with basic information. Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPagination parameters

dnsfilter_list_applications

Tool to list applications with basic information. Parameters:
ParameterTypeRequiredDefaultDescription
category_idsany[]NoCategory IDs, defaults to all
pageobjectNoPagination parameters

dnsfilter_list_block_pages

Tool to list block pages associated with the current user. Parameters:
ParameterTypeRequiredDefaultDescription
organization_idintegerNoOrganization ID
pageobjectNoPagination parameters

dnsfilter_list_categories

Tool to list categories with basic information. Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPagination parameters

dnsfilter_list_invoices

Tool to list invoices for an organization, most recent first. Parameters:
ParameterTypeRequiredDefaultDescription
organization_idintegerYesUser organization ID

dnsfilter_list_ip_addresses

Tool to list user-associated ip addresses with basic information. Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPagination parameters
searchstringNoSearch specific IP information

dnsfilter_list_mac_addresses

Tool to list mac addresses associated with an organization. Parameters:
ParameterTypeRequiredDefaultDescription
organization_idsany[]NoOrganization IDs, defaults to user organization ID
pageobjectNoPagination parameters

dnsfilter_list_networks

Tool to list all networks. Parameters:
ParameterTypeRequiredDefaultDescription
basic_infobooleanNoReturn most basic Network Info only. Defaults to False
count_network_ipsbooleanNoReturn count of IP Addresses. Defaults to False
force_truncate_ipsbooleanNoReturn Network info without IP Addresses. Defaults to False
pageobjectNoPagination parameters
protectedbooleanNoFilter networks with assigned policy
searchstringNoSearch for the given value among the network name, hostname, ip address, etc.
unprotectedbooleanNoFilter networks without assigned policy

dnsfilter_list_organizations

Tool to list all organizations. Parameters:
ParameterTypeRequiredDefaultDescription
basic_infobooleanNojust return organizations basic info true/false, defaults to false
exclude_inherit_privacy_modebooleanNoExclude organizations that have inherit privacy mode
managed_by_msp_idintegerNoMSPs sub-organizations whose MSP ID matches this value
namestringNoFilter by organization name
owned_msp_idintegerNoParent organizations whose MSP ID matches this value
pageobjectNoPagination parameters
pii_grid_searchstringNoFilter by organization name or privacy mode for pii grid search
typestringNoFilter by organization type

dnsfilter_suggest_domain_threat

Tool to suggest a fqdn as a potential threat. Parameters:
ParameterTypeRequiredDefaultDescription
categoriesstringNoSuggested security categories, comma separated IDs
fqdnstringYesFQDN to verify
notesstringYesUser notes about the threat suggestion/verification

dnsfilter_verify_ip_address

Tool to verify that an ip address is not already in the system. Parameters:
ParameterTypeRequiredDefaultDescription
ip_addressobjectYesIP address to verify