Actions & Endpoints

Introduction

The Dns Filter Integration with Rewst delivers a robust set of actions and endpoints for interacting with Dns Filter. Below is a summary of each section, highlighting the diverse capabilities and opportunities provided through the Dns Filter Integration:

• Agent Local User

• Billings

• Block Pages

• Categories

• Collection Users

• Collections

• Domains

• Generic Request

• Invoices

• IP Addresses

• Mac Addresses

• Network Lan IPs

• Network Subnets

• Networks

• Organization Users

• Organizations

• Policies

• Policy IPs

• Scheduled Policies

• Traffic Reports

• User Agents

• Users

Actions

Agent Local User

List Agent Local Users

GET api.dnsfilter.com/v1/agent_local_users

Gets the agent local users associated to an organization with basic information

List All Agent Local Users

GET api.dnsfilter.com/v1/agent_local_users/all

Gets ALL agent local users associated to an user organization with basic information

Get Agent Local User

GET api.dnsfilter.com/v1/agent_local_users/{id}

Gets basic information of the specified agent local user

Update Agent Local User

PUT api.dnsfilter.com/v1/agent_local_users/{id}

Updates an agent local user with the specified data

Billings

List User Organization Billing

GET api.dnsfilter.com/v1/billing

List basic billing information of the user organization registered in Stripe platform

Create Payment Method

POST api.dnsfilter.com/v1/billing

Register a newly created payment method in database

Block Pages

List Block Pages

GET api.dnsfilter.com/v1/block_pages

Gets the list of block pages associated with the current user

Create Block Page

POST api.dnsfilter.com/v1/block_pages

Creates a new block page

List All Block Pages

GET api.dnsfilter.com/v1/block_pages/all

Gets ALL block pages associated with the current user

Get Block Page

GET api.dnsfilter.com/v1/block_pages/{id}

Gets the specified block page

Update Block Page

PUT api.dnsfilter.com/v1/block_pages/{id}

Updates a block_page in the database with the specified data

Delete Block Page

DELETE api.dnsfilter.com/v1/block_pages/{id}

Removes a block page from the database

Categories

List Categories

GET api.dnsfilter.com/v1/categories

List categories basic information

List All Categories

GET api.dnsfilter.com/v1/categories/all

List all categories including internal categories

Get Category

GET api.dnsfilter.com/v1/categories/{id}

Gets basic information of a specific category

Collection Users

Create Collection User With Filter And Sort

GET api.dnsfilter.com/v1/collections/{collection_id}/users/

Add a new user to a specific collection with the specified id

Create Collection User

POST api.dnsfilter.com/v1/collections/{collection_id}/users/

Add a new user to a specific collection with the specified id

Get User Permissions

GET api.dnsfilter.com/v1/collections/{collection_id}/users/{id}

Gets the user details and permissions for the specified organization

Delete User From Collection

DELETE api.dnsfilter.com/v1/collections/{collection_id}/users/{id}

Deletes a user from a collection

Collections

List Agent Local Users With Class Type

GET api.dnsfilter.com/v1/sync_tool/:class_type/:id/users

Gets the agent local users associated to a collection or group

List Agent Local Users In Organization

GET api.dnsfilter.com/v1/sync_tool/

Gets the agent local users associated to a collection or group

Domains

List Domains By FQDN

GET api.dnsfilter.com/v1/domains/user_lookup

Gets all the domains associated for a particular FQDN

List Domains And Categories For FQDNs

GET api.dnsfilter.com/v1/domains/bulk_lookup

Gets the domains and categories associated for each FQDN of the specified list

Mark FQDN For Categorization Verification

POST api.dnsfilter.com/v1/domains/suggest_categories

Mark a FQDN to verify its categorization with suggested ones

Update FQDN Threat Categorization

POST api.dnsfilter.com/v1/domains/suggest_threat

Mark a FQDN to verify its threat categorization

Generic Request

DNS API Request

GET api.dnsfilter.com/<url_path>

Generic action for making authenticated requests against the DNS Filter API

Invoices

Get User Estimated Invoice For Next Month

GET api.dnsfilter.com/v1/invoices/current

Gets user estimated invoice for next month. WARNING: almost all invoice data are `null` values, take that into consideration when using this endpoint

List User Invoices

GET api.dnsfilter.com/v1/invoices

Gets user associated invoices, most recent first

Get Invoice

GET api.dnsfilter.com/v1/invoices/{id}

Gets basic information of the specified invoice

Ip Addresses

Get User IP Addresses

GET api.dnsfilter.com/v1/ip_addresses

Gets user associated IP addresses basic information

Create IP Address

POST api.dnsfilter.com/v1/ip_addresses

Creates a new IP address with the specified data

List User IP Addresses

GET api.dnsfilter.com/v1/ip_addresses/all

Gets ALL user associated IP addresses basic information

Get IP Address

GET api.dnsfilter.com/v1/ip_addresses/{id}

Gets basic information of the specified IP address

Update IP Address

PUT api.dnsfilter.com/v1/ip_addresses/{id}

Updates an IP address with the specified data

Delete IP Address

DELETE api.dnsfilter.com/v1/ip_addresses/{id}

Removes an IP address

List IP Addresses

GET api.dnsfilter.com/v1/ip_addresses/verify

Verification call to ensure IP address is not already in the system `TODO:` make this API friendly and return different status codes for responses

Get Requester IP Address

GET api.dnsfilter.com/v1/ip_addresses/myip

Responds with the requester reported IP address

Mac Addresses

List MAC Addresses

GET api.dnsfilter.com/v1/mac_addresses

Gets the MAC addresses associated to an organization with basic information

Create MAC Address

POST api.dnsfilter.com/v1/mac_addresses

Creates a new MAC address with the specified data

List User MAC Addresses

GET api.dnsfilter.com/v1/mac_addresses/all

Gets ALL MAC addresses associated to an user with basic information

Get MAC Address Info

GET api.dnsfilter.com/v1/mac_addresses/{id}

Gets basic information of the specified MAC address

Update MAC Address

PUT api.dnsfilter.com/v1/mac_addresses/{id}

Updates a MAC address with the specified data

Delete MAC Address

DELETE api.dnsfilter.com/v1/mac_addresses/{id}

Removes a MAC address

Network Lan Ips

List Network Lan IPs

GET api.dnsfilter.com/v1/networks/{id}/lan_ips

Gets network associated LAN IPs with basic information

Get Network Lan IP

GET api.dnsfilter.com/v1/networks/{id}/lan_ips/{lan_ip_id}

Gets network associated LAN IP with basic information

Update Network Lan IP

PUT api.dnsfilter.com/v1/networks/{id}/lan_ips/{lan_ip_id}

Updates a network LAN IP in the database with the specified data

Network Subnets

List Site Subnets

GET api.dnsfilter.com/v1/networks/subnets

List site subnets with basic information

List Network Subnets

GET api.dnsfilter.com/v1/networks/{id}/subnets

Gets network associated subnets with basic information

Create Network Subnet

POST api.dnsfilter.com/v1/networks/{id}/subnets

Creates a network subnet in the database with the specified data

Get Network Subnet

GET api.dnsfilter.com/v1/networks/{id}/subnets/{subnet_id}

Gets network associated subnet with basic information

Update Network Subnet

PUT api.dnsfilter.com/v1/networks/{id}/subnets/{subnet_id}

Updates a network subnet in the database with the specified data

Delete Network Subnet

DELETE api.dnsfilter.com/v1/networks/{id}/subnets/{subnet_id}

Deletes a network subnet in the database with the specified data

Networks

List User Associated Networks

GET api.dnsfilter.com/v1/networks

Gets users associated networks with basic information

Create Network

POST api.dnsfilter.com/v1/networks

Creates a new network with the specified data

List User Networks

GET api.dnsfilter.com/v1/networks/all

Gets ALL networks associated to the user with its basic information

List Msp User Networks

GET api.dnsfilter.com/v1/networks/msp

Gets MSP user associated networks with basic information

List All Msp User Networks

GET api.dnsfilter.com/v1/networks/msp/all

Gets ALL networks associated to the MSP user with its basic information

Get Network Info By IP Addresses

GET api.dnsfilter.com/v1/networks/lookup

Gets basic information of a network based on its associated IP addresses

Get Network

GET api.dnsfilter.com/v1/networks/{id}

Gets basic information of the specified network

Update Network

PUT api.dnsfilter.com/v1/networks/{id}

Updates a network with the specified data

Delete Network

DELETE api.dnsfilter.com/v1/networks/{id}

Deletes a network

Create Network Secret Key

POST api.dnsfilter.com/v1/networks/{id}/secret_key

Creates a new network secret key to be used by agents

Delete Network Secret Key

DELETE api.dnsfilter.com/v1/networks/{id}/secret_key

Revokes a network secret key

Update Network Secret Key

PATCH api.dnsfilter.com/v1/networks/{id}/secret_key

Rotates (renew) a network secret key to be used by agents

Organization Users

List Organization Users

GET api.dnsfilter.com/v1/organizations/{organization_id}/users/

Gets the users for the specified organization

Get Organization User

GET api.dnsfilter.com/v1/organizations/{organization_id}/users/{id}

Gets the user details and permissions for the specified organization

Update User Or Permissions

PATCH api.dnsfilter.com/v1/organizations/{organization_id}/users/{id}

Updates a user or permissions with the specified data

Delete Organization User

DELETE api.dnsfilter.com/v1/organizations/{organization_id}/users/{id}

Removes a user from the organization. This will not actually delete the user account.

Create Organization User

POST api.dnsfilter.com/v1/organizations/{organization_id}/users

Adds a new or existing user with the specified email to the specified organization.

Organizations

List User Organizations

GET api.dnsfilter.com/v1/organizations

Gets users associated organizations basic information

Create Organization

POST api.dnsfilter.com/v1/organizations

Creates a new organization with the specified data

List Organizations Basic

GET api.dnsfilter.com/v1/organizations/all

Gets all organizations basic information

Get Organization Information

GET api.dnsfilter.com/v1/organizations/{id}

Gets basic information of the specified organization

Update Organization

PUT api.dnsfilter.com/v1/organizations/{id}

Updates an organization with the specified data

Delete Msp Customer

DELETE api.dnsfilter.com/v1/organizations/{id}

Deletes an MSP customer

Update Organization Status To Canceled

POST api.dnsfilter.com/v1/organizations/{id}/cancel

Sets an organization as 'Canceled'

Promote Organization To Msp

POST api.dnsfilter.com/v1/organizations/promote_to_msp/

Promote an organization to a MSP

Policies

Get User Associated Policies

GET api.dnsfilter.com/v1/policies

Gets user associated policies basic information from database

Create Policy

POST api.dnsfilter.com/v1/policies

Creates a new policy with the specified data

List User Policies

GET api.dnsfilter.com/v1/policies/all

Gets ALL user associated policies basic information from database

Get Policy

GET api.dnsfilter.com/v1/policies/{id}

Gets basic information of the specified policy

Update Policy

PUT api.dnsfilter.com/v1/policies/{id}

Updates a policy with the specified data

Delete Policy

DELETE api.dnsfilter.com/v1/policies/{id}

Deletes a policy

Add Blacklist Domain to Policy

POST api.dnsfilter.com/v1/policies/{id}/add_blacklist_domain

Adds a domain to the blacklist of the specified policy

Remove Domain from Blacklist of Policy

POST api.dnsfilter.com/v1/policies/{id}/remove_blacklist_domain

Removes a domain from the blacklist of the specified policy

Add Whitelist Domain to Policy

POST api.dnsfilter.com/v1/policies/{id}/add_whitelist_domain

Adds a domain to the whitelist of the specified policy

Remove Domain from Whitelist of Policy

POST api.dnsfilter.com/v1/policies/{id}/remove_whitelist_domain

Removes a domain from the whitelist of the specified policy

Add Blacklist Category to Policy

POST api.dnsfilter.com/v1/policies/{id}/add_blacklist_category

Adds a category to the blacklist of the specified policy

Remove Category from Blacklist of Policy

POST api.dnsfilter.com/v1/policies/{id}/remove_blacklist_category

Removes a category from the blacklist of the specified policy

Add Allowed Application to Policy

POST api.dnsfilter.com/v1/policies/{id}/add_allowed_application

Adds an application to the allowed list of the specified policy

Remove Allowed Application from Policy

POST api.dnsfilter.com/v1/policies/{id}/remove_allowed_application

Removes an application from the allowed list of the specified policy

Add Blocked Application to Policy

POST api.dnsfilter.com/v1/policies/{id}/add_blocked_application

Adds an application to the blocked list of the specified policy

Remove Blocked Application from Policy

POST api.dnsfilter.com/v1/policies/{id}/remove_blocked_application

Removes an application from the blocked list of the specified policy

Policy Ips

Get User Policies Ips

GET api.dnsfilter.com/v1/policy_ips

Gets user associated policies IPs basic information from database

Get Policy IP

GET api.dnsfilter.com/v1/policy_ips/{id}

Gets basic information of the specified Policy IP

Scheduled Policies

List Scheduled Policies

GET api.dnsfilter.com/v1/scheduled_policies

Gets the list of scheduled policies associated with the current user

Create Scheduled Policy

POST api.dnsfilter.com/v1/scheduled_policies

Creates a new scheduled policy

List All Scheduled Policies

GET api.dnsfilter.com/v1/scheduled_policies/all

Gets ALL scheduled policies associated with the current user

Get Scheduled Policy

GET api.dnsfilter.com/v1/scheduled_policies/{id}

Gets the specified scheduled policy

Update Scheduled Policy

PUT api.dnsfilter.com/v1/scheduled_policies/{id}

Updates a scheduled policy in the database with the specified data

Delete Scheduled Policy

DELETE api.dnsfilter.com/v1/scheduled_policies/{id}

Removes a scheduled policy from the database

Traffic Reports

Get Total Requests

GET api.dnsfilter.com/v1/traffic_reports/total_requests

Gets the total number of requests for sites in a period of time

Get Total Requests For Organizations In Time Period

GET api.dnsfilter.com/v1/traffic_reports/total_requests_organizations

Gets the total number of requests for organizations in a period of time

Get Total Requests For Roaming Clients

GET api.dnsfilter.com/v1/traffic_reports/total_requests_agents

Gets the total number of requests for roaming clients in a period of time

Get Total Requests For Users

GET api.dnsfilter.com/v1/traffic_reports/total_requests_users

Gets the total number of requests for users in a period of time

Get Total Requests For Collections

GET api.dnsfilter.com/v1/traffic_reports/total_requests_collections

Gets the total number of requests for collections in a period of time

Get Total Threats For Sites In Time Period

GET api.dnsfilter.com/v1/traffic_reports/total_threats

Gets the total number of threats for sites in a period of time

Get Total Threats For Organizations

GET api.dnsfilter.com/v1/traffic_reports/total_threats_organizations

Gets the total number of threats for organizations in a period of time

Get Total Threats For Roaming Clients

GET api.dnsfilter.com/v1/traffic_reports/total_threats_agents

Gets the total number of threats for roaming clients in a period of time

Get Total Threats For Users In Time Period

GET api.dnsfilter.com/v1/traffic_reports/total_threats_users

Gets the total number of threats for users in a period of time

List Total Threats For Collections

GET api.dnsfilter.com/v1/traffic_reports/total_threats_collections

Gets the total number of threats for collections in a period of time

List Total Requests By Category

GET api.dnsfilter.com/v1/traffic_reports/total_categories

Gets the total number of requests by category for sites in a period of time

List Total Requests By Category For Organizations

GET api.dnsfilter.com/v1/traffic_reports/total_categories_organizations

Gets the total number of requests by category for organizations in a period of time

List Requests By Category For Roaming Clients

GET api.dnsfilter.com/v1/traffic_reports/total_categories_agents

Gets the total number of requests by category for roaming clients in a period of time

List Requests By Category

GET api.dnsfilter.com/v1/traffic_reports/total_categories_users

Gets the total number of requests by category for users in a period of time

List Requests By Category For Collections

GET api.dnsfilter.com/v1/traffic_reports/total_categories_collections

Gets the total number of requests by category for collections in a period of time

Get Total Requests By Domain

GET api.dnsfilter.com/v1/traffic_reports/total_domains

Gets the total number of requests by domain for sites in a period of time

Get Total Requests By Domain For Organizations

GET api.dnsfilter.com/v1/traffic_reports/total_domains_organizations

Gets the total number of requests by domain for organizations in a period of time

Get Total Requests By Domain For Roaming Clients

GET api.dnsfilter.com/v1/traffic_reports/total_domains_agents

Gets the total number of requests by domain for roaming clients in a period of time

List Domain Requests

GET api.dnsfilter.com/v1/traffic_reports/total_domains_users

Gets the total number of requests by domain for users in a period of time

List Total Requests By Domain For Collections

GET api.dnsfilter.com/v1/traffic_reports/total_domains_collections

Gets the total number of requests by domain for collections in a period of time

Get Total Requests By Collection

GET api.dnsfilter.com/v1/traffic_reports/total_collections

Gets the total number of requests by collection for sites in a period of time

Get Total Requests By Collection For Organizations

GET api.dnsfilter.com/v1/traffic_reports/total_collections_organizations

Gets the total number of requests by collection for organizations in a period of time

List Total Requests By Collection For Roaming Clients In Time Period

GET api.dnsfilter.com/v1/traffic_reports/total_collections_agents

Gets the total number of requests by collection for roaming clients in a period of time

Gets The Total Number Of Requests By Collection For Users In A Period Of Time

GET api.dnsfilter.com/v1/traffic_reports/total_collections_users

Gets the total number of requests by collection for users in a period of time

List Qps For Sites

GET api.dnsfilter.com/v1/traffic_reports/qps

Gets the total number of queries per second in a period of time for sites

Get Total Qps For Organizations

GET api.dnsfilter.com/v1/traffic_reports/qps_active_organizations

Gets the total number of queries per second in a period of time (maximum 20 minutes) for organizations

Get Roaming Clients Qps

GET api.dnsfilter.com/v1/traffic_reports/qps_active_agents

Gets the total number of queries per second in a period of time (maximum 20 minutes) for roaming clients

Get Qps For Users

GET api.dnsfilter.com/v1/traffic_reports/qps_active_users

Gets the total number of queries per second in a period of time (maximum 20 minutes) for users

Get Total Qps For Collections

GET api.dnsfilter.com/v1/traffic_reports/qps_active_collections

Gets the total number of queries per second in a period of time (maximum 20 minutes) for collections

Gets The Top Requested Domains In A Period Of Time

GET api.dnsfilter.com/v1/traffic_reports/top_domains

Gets the top requested domains in a period of time

List Top Categories Domains

GET api.dnsfilter.com/v1/traffic_reports/top_categories

Gets the top categories domains in a period of time

List Top Organizations

GET api.dnsfilter.com/v1/traffic_reports/top_organizations

Gets the top organizations in a period of time

List Top Networks

GET api.dnsfilter.com/v1/traffic_reports/top_networks

Gets the top networks in a period of time

List Top Agents

GET api.dnsfilter.com/v1/traffic_reports/top_agents

Gets the top agents in a period of time

List Top Users

GET api.dnsfilter.com/v1/traffic_reports/top_users

Gets the top users in a period of time

List Top Collections

GET api.dnsfilter.com/v1/traffic_reports/top_collections

Gets the top collections in a period of time

List Query Raw Logs

GET api.dnsfilter.com/v1/traffic_reports/query_logs

Gets the query raw logs in a period of time

NOTE: maximum time range is 72 hours

User Agents

List User Agents

GET api.dnsfilter.com/v1/user_agents

Gets a list of user agents with basic information

List All User Agents

GET api.dnsfilter.com/v1/user_agents/all

Gets a list of ALL user agents with basic information

Get User Agent

GET api.dnsfilter.com/v1/user_agents/{id}

Gets the specified user agent with basic information

Update User Agent

PUT api.dnsfilter.com/v1/user_agents/{id}

Updates an user agent with the specified data

Delete User Agent

DELETE api.dnsfilter.com/v1/user_agents/{id}

Soft deletes an user agent

List User Agent Tags

GET api.dnsfilter.com/v1/user_agents/tags

Gets ALL tags used by user agents on a network or organization

Users

List Users Basic Information

GET api.dnsfilter.com/v1/users

Gets users basic information

List All Users Basic Information

GET api.dnsfilter.com/v1/users/all

Gets ALL users basic information

Get Information of User

GET api.dnsfilter.com/v1/users/{id}

Gets basic information of the specified user

Update Email Verification Status

POST api.dnsfilter.com/v1/users/check_email_verification

Sets the specified email address as verified

Create User Email Verification

POST api.dnsfilter.com/v1/users/send_email_verification

Sends an email to the user to verify his email address