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 allows users to create a new policy in the DNSFilter system by sending the specified policy data to the API. It supports additional options such as including relationships in the response and appending allowlist/blocklist domains to existing ones. This node is useful for automating policy management in DNSFilter, such as creating new filtering rules or security policies programmatically.

Use Case Examples

  1. Create a new DNSFilter policy with specific filtering rules and options to include relationships in the response.
  2. Automate the creation of policies with appended allowlist or blocklist domains for network security management.

Properties

Name Meaning
Policy The JSON object containing the policy creation request parameters, defining the details of the new policy to be created.
Include Relationships Boolean flag to include relationships in the response, indicating whether related entities should be included in the API response.
Append Domains Boolean flag to append allowlist/blocklist domains to the existing ones, controlling whether new domains are added to existing lists or replace them.

Output

JSON

  • json - The JSON response from the DNSFilter API representing the created policy or error information.

Dependencies

  • DNSFilter API key credential for authentication

Troubleshooting

  • Ensure the policy JSON is correctly formatted and contains all required fields to avoid API validation errors.
  • Check that the API key credential is valid and has the necessary permissions to create policies.
  • If the node returns rate limit errors (HTTP 429), consider using batching options to space out requests.

Links

Discussion