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

Tools


dnsfilter_create_ip_address

Create Parameters:
ParameterTypeRequiredDefaultDescription
ip_addressobjectYesIP address creation request parameters

dnsfilter_get_application_category

Show category Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesApplication category ID

dnsfilter_get_billing_information

Show Parameters:
ParameterTypeRequiredDefaultDescription
organization_idintegerYesUser organization ID

dnsfilter_get_category

Show category Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCategory ID

dnsfilter_get_ip_address

Show IP Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesIP address ID

dnsfilter_list_all_categories

Get all Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPage number and size

dnsfilter_list_all_ip_addresses

Get all Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPage number and size

dnsfilter_list_all_mac_addresses

Get all Parameters:
ParameterTypeRequiredDefaultDescription
organization_idsany[]NoOrganization IDs, defaults to user organization ID
pageobjectNoPage number and size

dnsfilter_list_application_categories

Get extant Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPage number and size

dnsfilter_list_applications

Get extant Parameters:
ParameterTypeRequiredDefaultDescription
category_idsany[]NoCategory IDs, defaults to all
pageobjectNoPage number and size

dnsfilter_list_block_pages

Get extant Parameters:
ParameterTypeRequiredDefaultDescription
organization_idintegerNoOrganization ID
pageobjectNoPage number and size

dnsfilter_list_categories

Get extant Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPage number and size

dnsfilter_list_invoices

Get invoices Parameters:
ParameterTypeRequiredDefaultDescription
organization_idintegerYesUser organization ID

dnsfilter_list_ip_addresses

Get extant Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPage number and size
searchstringNoSearch specific IP information

dnsfilter_list_mac_addresses

Get extant Parameters:
ParameterTypeRequiredDefaultDescription
organization_idsany[]NoOrganization IDs, defaults to user organization ID
pageobjectNoPage number and size

dnsfilter_list_networks

Get extant 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
pageobjectNoPage number and size
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

Get extant 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
pageobjectNoPage number and size
pii_grid_searchstringNoFilter by organization name or privacy mode for pii grid search
typestringNoFilter by organization type

dnsfilter_suggest_domain_threat

Suggest threat Parameters:
ParameterTypeRequiredDefaultDescription
categoriesstringNoSuggested security categories, comma separated IDs
fqdnstringYesFQDN to verify
notesstringYesUser notes about the threat suggestion/verification

dnsfilter_verify_ip_address

Verify IP Parameters:
ParameterTypeRequiredDefaultDescription
ip_addressobjectYesIP address creation request parameters