dnsfilter

n8n node for DNSFilter

Package Information

Downloads: 5 weekly / 42 monthly
Latest Version: 0.1.6
Author: AvantGuard LLC

Available Nodes

DNSFilter icon
DNSFilter
**Note:** If you are a distributor integrating with DNSFilter, please check out our [Distributors Development Guide](/docs/distributors).### Authentication- Authentication is required for most, but not all, endpoints.- Authentication is done by setting the `Authorization` request header. The header value is the API key itself. For example: `Authorization: eyJ...`- An API key can be obtained through the DNSFilter dashboard under Account Settings. For additional information see [this KB article](https://help.dnsfilter.com/hc/en-us/articles/21169189058323-API-Tokens).### Rate Limiting- All endpoints are rate limited.- The limits may vary by endpoint, but are generally consistent.- When the rate limit is exceeded the API will return the standard `429` HTTP status.- The following headers will also be provided in the response: `Retry-After`, `RateLimit-Policy`, `RateLimit`, `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset`. For details on the values of these headers, see the following articles [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After), [here](https://www.ietf.org/archive/id/draft-ietf-httpapi-ratelimit-headers-08.html), and [here](https://www.ietf.org/archive/id/draft-polli-ratelimit-headers-05.html).- For additional information see [this KB article](https://help.dnsfilter.com/hc/en-us/articles/38202811088403-API-Rate-Limits).### Error Handling- The API uses standard HTTP status codes to indicate success or failure.- For _V1_ endpoints the response format is: ```json { "error": "string", "type": "string(optional)" } ```- For _V2_ endpoints the response format is: ```json { "error": { "message": "string", "type": "string(optional)" } } ```### PaginationFor the _V1_ endpoints, the pagination parameters are nested. That is to say,if passed as JSON they look like this: `{"page[number]": 1, "page[size]": 10}`.To pass this information in the URL query string, it would be formatted likethis: `...?page%5Bnumber%5D=1&page%5Bsize%5D=10`.In this guide, the UI will indicate that `page` is an `object` and if youwant to set values when trying the request, you must enter it as if it wasthe JSON above.### A Quick ExampleThe following will return information about the currentlyauthenticated user.```bash% curl -H 'Authorization: ***' https://api.dnsfilter.com/v1/users/self{ "data": { "id": "12345", "type": "users", "attributes": { "name": "John Doe", "email": "john@example.com", ...additional fields...}}}```

Documentation

n8n      AvantGuard

DNSFilter n8n Node

n8n community node npm

Note: If you are a distributor integrating with DNSFilter, please check out our Distributors Development Guide.### Authentication- Authentication is required for most, but not all, endpoints.- Authentication is done by setting the Authorization request header. The header value is the API key itself. For example: Authorization: eyJ...- An API key can be obtained through the DNSFilter dashboard under Account Settings. For additional information see this KB article.### Rate Limiting- All endpoints are rate limited.- The limits may vary by endpoint, but are generally consistent.- When the rate limit is exceeded the API will return the standard 429 HTTP status.- The following headers will also be provided in the response: Retry-After, RateLimit-Policy, RateLimit, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset. For details on the values of these headers, see the following articles here, here, and here.- For additional information see this KB article.### Error Handling- The API uses standard HTTP status codes to indicate success or failure.- For V1 endpoints the response format is: json { "error": "string", "type": "string(optional)" } - For V2 endpoints the response format is: json { "error": { "message": "string", "type": "string(optional)" } } ### PaginationFor the V1 endpoints, the pagination parameters are nested. That is to say,if passed as JSON they look like this: {"page[number]": 1, "page[size]": 10}.To pass this information in the URL query string, it would be formatted likethis: ...?page%5Bnumber%5D=1&page%5Bsize%5D=10.In this guide, the UI will indicate that page is an object and if youwant to set values when trying the request, you must enter it as if it wasthe JSON above.### A Quick ExampleThe following will return information about the currentlyauthenticated user.bash% curl -H 'Authorization: ***' https://api.dnsfilter.com/v1/users/self{ "data": { "id": "12345", "type": "users", "attributes": { "name": "John Doe", "email": "john@example.com", ...additional fields...}}}

Table of Contents

Installation

Follow the n8n community node installation guide.

Or install directly via npm:

npm install @avantguardllc/n8n-nodes-dnsfilter

Authentication

This node authenticates using an API Key.

Setting Value
Type API Key
Sent in header
Header / Query name Authorization
Base URL https://api.dnsfilter.com (editable in credentials)

Tip: The Base URL can be changed in the credential settings if your instance uses a different host.

Resources & Operations

Base URL: https://api.dnsfilter.com

AgentLocalUserBulkDeletes

Endpoint Description
🟢 POST /v1/agent_local_users_bulk_delete Create
🔵 GET /v1/agent_local_users_bulk_delete/{id} Show bulk delete
🔵 GET /v1/agent_local_users_bulk_delete/counts{id} Count

AgentLocalUsers

Endpoint Description
🔵 GET /v1/agent_local_users Gets extant users
🔵 GET /v1/agent_local_users/all Gets ALL users
🔵 GET /v1/agent_local_users/{id} Show extant user
🟣 PATCH /v1/agent_local_users/{id} Update
🔴 DELETE /v1/agent_local_users/{id} Delete

ApiKeys

Endpoint Description
🔵 GET /v1/api_keys List
🟢 POST /v1/api_keys Create
🔵 GET /v1/api_keys/{id} Show
🔴 DELETE /v1/api_keys/{id} Delete
🟢 POST /v1/api_keys/{id}/revoke Revoke

ApplicationCategories

Endpoint Description
🔵 GET /v1/application_categories Get extant
🔵 GET /v1/application_categories/{id} Show category

Applications

Endpoint Description
🔵 GET /v1/applications Get extant
🔵 GET /v1/applications/all Get all
🔵 GET /v1/applications/{id} Show

Billings

Endpoint Description
🔵 GET /v1/billing Show
🟢 POST /v1/billing Create
🔵 GET /v1/billing/address/{organization_id} Show address
🟣 PATCH /v1/billing/address/{organization_id} Update address

BlockPages

Endpoint Description
🔵 GET /v1/block_pages Get extant
🟢 POST /v1/block_pages Create
🔵 GET /v1/block_pages/all Get all
🔵 GET /v1/block_pages/{id} Show page
🟣 PATCH /v1/block_pages/{id} Update
🔴 DELETE /v1/block_pages/{id} Delete

Categories

Endpoint Description
🔵 GET /v1/categories Get extant
🔵 GET /v1/categories/all Get all
🔵 GET /v1/categories/{id} Show category

CollectionUsers

Endpoint Description
🔵 GET /v1/collections/{collection_id}/users Gets collection users
🟢 POST /v1/collections/{collection_id}/users Update
🔵 GET /v1/collections/{collection_id}/users/{id} Show user
🔴 DELETE /v1/collections/{collection_id}/users/{id} Delete user

User(Current)

Endpoint Description
🔵 GET /v1/current_user Get
🟣 PATCH /v1/current_user Update

DictionaryLookups

Endpoint Description
🔵 GET /v1/dictionary/qp_methods List QP Methods
🔵 GET /v2/dictionary/cyber_sight_activity_types CyberSight Activity Types

Distributors

Endpoint Description
🔵 GET /v1/distributors/health Health Check
🔵 GET /v1/distributors/distributors Get
🟣 PATCH /v1/distributors/distributors Update
🔵 GET /v1/distributors/msps MSP Search
🟢 POST /v1/distributors/msps Create
🔵 GET /v1/distributors/msps/{id} Show MSP
🟣 PATCH /v1/distributors/msps/{id} Update
🟢 POST /v1/distributors/msps/{id}/cancel Cancel
🟢 POST /v1/distributors/msps/{id}/reactivate Reactivate
🔵 GET /v1/distributors/organizations Organizations Search
🟢 POST /v1/distributors/organizations Create suborganization
🔵 GET /v1/distributors/organizations/{id} Show Organization
🟣 PATCH /v1/distributors/organizations/{id} Update suborganization
🟢 POST /v1/distributors/organizations/{id}/cancel Cancel suborganization
🟢 POST /v1/distributors/organizations/{id}/reactivate Reactivate suborg
🟢 POST /v1/distributors/organizations/{id}/add_sku Add Sku
🟢 POST /v1/distributors/organizations/{id}/remove_sku Remove Sku
🔵 GET /v1/distributors/users Users Search
🟢 POST /v1/distributors/users Create user
🔵 GET /v1/distributors/users/{id} Show User
🟢 POST /v1/distributors/users/{id}/add_membership Add membership
🟢 POST /v1/distributors/users/{id}/update_membership Update membership
🟢 POST /v1/distributors/users/{id}/remove_membership Remove membership
🟢 POST /v1/distributors/users/{id}/send_reset_password_email Reset password
🟢 POST /v1/distributors/users/{id}/reset_password_url Reset password URL
🔵 GET /v1/distributors/reports/usage_by_organization Get usage info
🔵 GET /v1/distributors/reports/usage_by_sku Get usage info by SKU
🔵 GET /v1/distributors/reports/covered_users_summary_by_organization Get user info by date

DomainNotes

Endpoint Description
🔵 GET /v1/notes/{resource}/{id}/{domain} Show
🟣 PATCH /v1/notes/{resource}/{id}/{domain} Update
🟣 PATCH /v1/notes/{resource}/{id}/batch_update Bulk update
🔴 DELETE /v1/notes/{resource}/{id}/notes/{domain} Delete
🔴 DELETE /v1/notes/{resource}/{id}/notes/batch_destroy Batch destroy

Domains

Endpoint Description
🔵 GET /v1/domains/user_lookup Lookup
🔵 GET /v1/domains/bulk_lookup Bulk lookup
🟢 POST /v1/domains/suggest_threat Suggest threat

EnterpriseConnections

Endpoint Description
🔵 GET /v1/enterprise_connections Get extant
🟢 POST /v1/enterprise_connections Create
🔵 GET /v1/enterprise_connections/{id} Show connection
🟣 PATCH /v1/enterprise_connections/{id} Update
🔴 DELETE /v1/enterprise_connections/{id} Delete

Invoices

Endpoint Description
🔵 GET /v1/invoices/current Get current invoice
🔵 GET /v1/invoices Get invoices
🔵 GET /v1/invoices/{id} Get invoice

IPAddresses

Endpoint Description
🔵 GET /v1/ip_addresses Get extant
🟢 POST /v1/ip_addresses Create
🔵 GET /v1/ip_addresses/all Get all
🔵 GET /v1/ip_addresses/{id} Show IP
🟣 PATCH /v1/ip_addresses/{id} Update
🔴 DELETE /v1/ip_addresses/{id} Delete
🔵 GET /v1/ip_addresses/verify Verify IP
🔵 GET /v1/ip_addresses/myip Get my IP

MACAddresses

Endpoint Description
🔵 GET /v1/mac_addresses Get extant
🟢 POST /v1/mac_addresses Create
🔵 GET /v1/mac_addresses/all Get all
🔵 GET /v1/mac_addresses/{id} Show address
🟣 PATCH /v1/mac_addresses/{id} Update
🔴 DELETE /v1/mac_addresses/{id} Delete

Metrics

Endpoint Description
🔵 GET /v1/metrics/organization_usage/{id} Get usage
🔵 GET /v1/metrics/organization_usage_detailed/{id} Get usage detailed

NetworkLANIPs

Endpoint Description
🔵 GET /v1/networks/{id}/lan_ips Get
🔵 GET /v1/networks/{id}/lan_ips/{lan_ip_id} Show Lan IP
🟣 PATCH /v1/networks/{id}/lan_ips/{lan_ip_id} Update

NetworkSubnets

Endpoint Description
🔵 GET /v1/networks/subnets Get all
🔵 GET /v1/networks/{id}/subnets Get extant
🟢 POST /v1/networks/{id}/subnets Create
🔵 GET /v1/networks/{id}/subnets/{subnet_id} Show subnet
🟣 PATCH /v1/networks/{id}/subnets/{subnet_id} Update
🔴 DELETE /v1/networks/{id}/subnets/{subnet_id} Delete

Networks

Endpoint Description
🔵 GET /v1/networks Get extant
🟢 POST /v1/networks Create
🔵 GET /v1/networks/all Get all
🔵 GET /v1/networks/counts Counts
🔵 GET /v1/networks/msp Get extant MSP
🔵 GET /v1/networks/msp/all Get all MSP
🔵 GET /v1/networks/geo Get Geo
🔵 GET /v1/networks/lookup Get by IP
🔵 GET /v1/networks/{id} Show network
🟣 PATCH /v1/networks/{id} Update
🔴 DELETE /v1/networks/{id} Delete
🟢 POST /v1/networks/bulk_create Bulk create
🔵 GET /v1/networks/bulk_create/{id} Bulk create status
🟢 POST /v1/networks/bulk_update Bulk update
🔵 GET /v1/networks/bulk_update/{id} Bulk udpate status
🔴 DELETE /v1/networks/bulk_destroy Bulk Delete
🔵 GET /v1/networks/bulk_destroy/{id} Bulk delete status
🟢 POST /v1/networks/{id}/secret_key Create Key
🟣 PATCH /v1/networks/{id}/secret_key Rotate key
🔴 DELETE /v1/networks/{id}/secret_key Delete Key

OrganizationUsers

Endpoint Description
🔵 GET /v1/organizations/{organization_id}/users Get
🟢 POST /v1/organizations/{organization_id}/users Create
🔵 GET /v1/organizations/{organization_id}/users/{id} Show user
🟣 PATCH /v1/organizations/{organization_id}/users/{id} Update
🔴 DELETE /v1/organizations/{organization_id}/users/{id} Delete
🟢 POST /v1/organizations/{organization_id}/users/{id}/resend_invite Resend Invite

Organizations

Endpoint Description
🔵 GET /v1/organizations Get extant
🟢 POST /v1/organizations Create
🔵 GET /v1/organizations/all Get all
🔵 GET /v1/organizations/{id} Show organization
🟣 PATCH /v1/organizations/{id} Update
🔴 DELETE /v1/organizations/{id} Delete MSP
🔵 GET /v1/organizations/settings Get settings
🟣 PATCH /v1/organizations/bulk_update Bulk update
🟢 POST /v1/organizations/{id}/cancel Cancel
🟢 POST /v1/organizations/promote_to_msp Promote

PoliciesBulkActions

Endpoint Description
🟢 POST /v1/policies/bulk/add_allowlist_domains Bulk add allow
🟢 POST /v1/policies/bulk/remove_allowlist_domains Bulk delete allow
🟢 POST /v1/policies/bulk/add_blocklist_domains Bulk add block
🟢 POST /v1/policies/bulk/remove_blocklist_domains Bulk delete block

Policies

Endpoint Description
🔵 GET /v1/policies Get extant
🟢 POST /v1/policies Create
🔵 GET /v1/policies/all Get all
🔵 GET /v1/policies/{id} Show policy
🟣 PATCH /v1/policies/{id} Update
🔴 DELETE /v1/policies/{id} Delete
🔵 GET /v1/policies/application Get application
🟢 POST /v1/policies/application_update Update application
🟢 POST /v1/policies/{id}/add_blacklist_domain Add block domain
🟢 POST /v1/policies/{id}/remove_blacklist_domain Remove block domain
🟢 POST /v1/policies/{id}/add_whitelist_domain Add allow domain
🟢 POST /v1/policies/{id}/remove_whitelist_domain Remove allow domain
🟢 POST /v1/policies/{id}/add_blacklist_category Add block category
🟢 POST /v1/policies/{id}/remove_blacklist_category Remove block category
🟢 POST /v1/policies/{id}/add_allowed_application Add allow category
🟢 POST /v1/policies/{id}/remove_allowed_application Remove allow category
🟢 POST /v1/policies/{id}/add_blocked_application Add block application
🟢 POST /v1/policies/{id}/remove_blocked_application Remove block application
🔵 GET /v1/policies/{id}/permissive_mode Get permissive mode
🟢 POST /v1/policies/{id}/permissive_mode Update permissive mode

PolicyIPs

Endpoint Description
🔵 GET /v1/policy_ips Get
🔵 GET /v1/policy_ips/{id} Show IP

PSAIntegrations

Endpoint Description
🔵 GET /v1/psa_integrations/redirect_link Create link

ScheduledPolicies

Endpoint Description
🔵 GET /v1/scheduled_policies Get extant
🟢 POST /v1/scheduled_policies Create
🔵 GET /v1/scheduled_policies/all Get all
🔵 GET /v1/scheduled_policies/{id} Show policy
🟣 PATCH /v1/scheduled_policies/{id} Update
🔴 DELETE /v1/scheduled_policies/{id} Delete

ScheduledReportPreviews

Endpoint Description
🔵 GET /v1/scheduled_report_previews/{id} Show preview
🟢 POST /v1/scheduled_report_previews Create

ScheduledReports

Endpoint Description
🔵 GET /v1/scheduled_reports Get
🟢 POST /v1/scheduled_reports Create
🔵 GET /v1/scheduled_reports/{id} Show report
🟣 PATCH /v1/scheduled_reports/{id} Update
🔴 DELETE /v1/scheduled_reports/{id} Delete

TrafficReports

Endpoint Description
🔵 GET /v1/traffic_reports/total_requests Total requests/time
🔵 GET /v1/traffic_reports/total_requests_geo Total requests geo
🔵 GET /v1/traffic_reports/total_requests_organizations Total requests/organizations
🔵 GET /v1/traffic_reports/total_requests_agents Total requests clients
🔵 GET /v1/traffic_reports/total_requests_users Total requests users
🔵 GET /v1/traffic_reports/total_requests_collections Total requests collections
🔵 GET /v1/traffic_reports/total_threats Total threats/time
🔵 GET /v1/traffic_reports/total_threats_organizations Total threats organizations
🔵 GET /v1/traffic_reports/total_threats_agents Total threats clients
🔵 GET /v1/traffic_reports/total_threats_users Total threats users
🔵 GET /v1/traffic_reports/total_threats_collections Total threats collections
🔵 GET /v1/traffic_reports/total_categories Total category requests
🔵 GET /v1/traffic_reports/total_categories_organizations Category reqs organizations
🔵 GET /v1/traffic_reports/total_categories_agents Category reqs clients
🔵 GET /v1/traffic_reports/total_categories_users Category reqs users
🔵 GET /v1/traffic_reports/total_categories_collections Category reqs collections
🔵 GET /v1/traffic_reports/total_domains Total domain reqs
🔵 GET /v1/traffic_reports/total_domains_organizations Domain reqs organizations
🔵 GET /v1/traffic_reports/total_domains_users Domain reqs users
🔵 GET /v1/traffic_reports/total_domains_collections Domain reqs collections
🔵 GET /v1/traffic_reports/total_collections Total collection reqs
🔵 GET /v1/traffic_reports/total_collections_organizations Collection reqs orgs
🔵 GET /v1/traffic_reports/total_collections_agents Collection reqs clients
🔵 GET /v1/traffic_reports/total_collections_users Collection reqs users
🔵 GET /v1/traffic_reports/qps Queries per second
🔵 GET /v1/traffic_reports/qps_active_organizations QPS organizations
🔵 GET /v1/traffic_reports/qps_active_agents QPS clients
🔵 GET /v1/traffic_reports/qps_active_users QPS users
🔵 GET /v1/traffic_reports/qps_active_collections QPS collections
🔵 GET /v1/traffic_reports/top_domains Top domains
🔵 GET /v1/traffic_reports/top_categories Top categories
🔵 GET /v1/traffic_reports/top_application_categories Top application categories
🔵 GET /v1/traffic_reports/top_organizations Top organizations
🔵 GET /v1/traffic_reports/top_networks Top networks
🔵 GET /v1/traffic_reports/top_agents Top agents
🔵 GET /v1/traffic_reports/top_users Top users
🔵 GET /v1/traffic_reports/top_collections Top collections
🔵 GET /v1/traffic_reports/query_logs Query Logs
🔵 GET /v1/traffic_reports/total_organizations_stats Organization stats
🔵 GET /v1/traffic_reports/total_domain_stats Domain stats
🔵 GET /v1/traffic_reports/total_category_stats Category stats
🔵 GET /v1/traffic_reports/total_organizations_requests Total Org Requests
🔵 GET /v1/traffic_reports/total_domain_requests Total Domain Requests
🔵 GET /v1/traffic_reports/top_organizations_requests Top Organizations Requests
🔵 GET /v1/traffic_reports/total_client_stats Total client stats
🔵 GET /v1/traffic_reports/total_deployments Deployments
🔵 GET /v1/traffic_reports/total_roaming_clients Roaming clients
🔵 GET /v1/traffic_reports/total_applications_stats Application requests
🔵 GET /v1/traffic_reports/total_applications_organizations_stats Application reqs org
🔵 GET /v1/traffic_reports/total_applications_networks_stats Applications reqs networks
🔵 GET /v1/traffic_reports/total_applications_agents_stats Application reqs clients
🔵 GET /v1/traffic_reports/total_applications_users_stats Application reqs users
🔵 GET /v1/traffic_reports/total_applications_collections_stats Application reqs collections

Trials

Endpoint Description
🟢 POST /v1/trials Create

UserAgentBulkDeletes

Endpoint Description
🟢 POST /v1/user_agent_bulk_deletes Create
🔵 GET /v1/user_agent_bulk_deletes/{id} Show
🔵 GET /v1/user_agent_bulk_deletes/counts Counts

UserAgentBulkUpdates

Endpoint Description
🟢 POST /v1/user_agent_bulk_updates Create
🔵 GET /v1/user_agent_bulk_updates/{id} Show
🟢 POST /v1/user_agent_bulk_updates/has_mixed Check agent values
🔵 GET /v1/user_agent_bulk_updates/counts Counts

UserAgentCleanups

Endpoint Description
🟢 POST /v1/user_agent_cleanups Create
🔵 GET /v1/user_agent_cleanups/{id} Show
🟡 PUT /v1/user_agent_cleanups/{id} Update

UserAgentCSVExports

Endpoint Description
🟢 POST /v1/user_agent_csv_exports Create
🔵 GET /v1/user_agent_csv_exports/{id} Show

UserAgentReleases

Endpoint Description
🔵 GET /v1/user_agent_releases Get
🔵 GET /v1/user_agent_releases/relay Get relay

UserAgents

Endpoint Description
🔵 GET /v1/user_agents Get extant agents
🔵 GET /v1/user_agents/all Get all agents
🔵 GET /v1/user_agents/counts Counts
🔵 GET /v1/user_agents/{id} Show agent
🟣 PATCH /v1/user_agents/{id} Update
🔴 DELETE /v1/user_agents/{id} Delete
🔵 GET /v1/user_agents/tags Get tags
🟢 POST /v1/user_agents/dequeue_uninstall Remove queue
🔵 GET /v1/user_agents/csv CSV Export
🔵 GET /v1/user_agents/uninstall_pin PIN
🟣 PATCH /v2/user_agents/{id}/update_settings Update settings

Users

Endpoint Description
🔵 GET /v1/users Get extant
🔵 GET /v1/users/all Get all
🔵 GET /v1/users/{id} Show user

UserUISettingsV2

Endpoint Description
🔵 GET /v2/current_user/ui_settings Get UI Settings
🟣 PATCH /v2/current_user/ui_settings Update UI Settings

CybersightCSVExports

Endpoint Description
🟢 POST /v2/cyber_sight/csv_exports/create Create
🔵 GET /v2/cyber_sight/csv_exports/{id} Show

NetworksCSVExports

Endpoint Description
🟢 POST /v2/networks_csv_export Create
🔵 GET /v2/networks_csv_export/{id} Show

Compatibility

  • n8n version: 1.0+ (tested on 2.x)
  • Node.js version: 18+

License

MIT

Discussion