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...}}}```
Join our community

Actions328

Overview

This node performs bulk operations on DNSFilter policies, specifically allowing users to add multiple domains to the blocklist of one or more policies in a single API request. It is useful for administrators managing network security policies who want to efficiently update blocklists across multiple policies without making individual requests for each domain or policy.

Use Case Examples

  1. Add a list of malicious domains to the blocklist of several policies to enhance network security.
  2. Bulk update blocklists when new threat domains are identified, applying changes to multiple policies at once.

Properties

Name Meaning
Additional Fields Optional fields to specify domains to add, notes for each domain, and policy IDs to apply the blocklist changes to.
Options Additional request options such as custom request body, headers, query filters, batching, debugging, pagination, and timeout settings.

Output

JSON

  • json - The JSON response from the DNSFilter API for the bulk add blocklist domains operation.

Dependencies

  • DNSFilter API key credential

Troubleshooting

  • Ensure the API key credential is correctly configured and has permissions to modify policies.
  • Check that the policy IDs and domains provided are valid and exist in the DNSFilter system.
  • If rate limiting errors occur, adjust batching settings or increase batch interval to avoid hitting API limits.
  • Enable debug option to see detailed request and response data for troubleshooting.

Links

Discussion