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 interacts with the DNSFilter API to manage policies, specifically to remove an allowed application category from a policy. It is useful in scenarios where you need to update security policies by removing certain application categories from the allow list, helping to control network access and enforce security rules. For example, an administrator can use this node to remove a category of applications that should no longer be allowed under a specific policy.

Use Case Examples

  1. Remove an allowed application category named 'Social Media' from a policy with ID 123 to restrict access to social media apps.
  2. Update a policy to remove an application category by name to tighten security controls.

Properties

Name Meaning
Id Policy ID to identify which policy to update.
Name Name of the application category to remove from the allow list.
Additional Fields Optional parameters such as including relationships in the response.
Options Additional request options like custom body, headers, query filters, batching, debug, pagination, and timeout settings.

Output

JSON

  • json - The JSON response from the DNSFilter API after removing the allowed application category from the specified policy.

Dependencies

  • DNSFilter API key credential

Troubleshooting

  • Ensure the Policy ID and Application Name are correct and exist in the DNSFilter system.
  • Check API key credentials and permissions to modify policies.
  • Verify network connectivity to the DNSFilter API endpoint.
  • If rate limited, adjust batching and interval settings in the options to avoid hitting limits.
  • Enable debug mode to see detailed request and response information for troubleshooting.

Links

Discussion