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...}}}```

Actions256

IPAddresses → Verify IP

AI-generated

Overview

This node interacts with the DNSFilter API to verify IP addresses. Specifically, the 'Verify IP' operation under the 'IPAddresses' resource checks if an IP address is already present in the system. It supports options such as returning all results or a single page, custom request body, headers, query filters, batching, debugging, pagination, and timeout settings. This node is useful for scenarios where you need to validate IP addresses against DNSFilter's database to avoid duplicates or confirm existence before further processing.

Use Case Examples

  1. Verify if a given IP address exists in the DNSFilter system before adding it to a network policy.
  2. Batch verify multiple IP addresses to ensure they are not already registered in the system.

Properties

Name Meaning
Return All Whether to return all results or only a single page. When disabled, no pagination parameters are sent and only one page of results is returned.
Ip Address IP address creation request parameters, used as input for the verification API call.
Options Additional optional settings including custom request body, headers, query filters, batching, debug mode, pagination, and timeout.

Output

JSON

  • json
    • debug - Debug information including the actual URL, query parameters, headers, and body sent for the API request, present if debug option is enabled.

Dependencies

  • DNSFilter API key credential for authentication

Troubleshooting

  • Ensure the DNSFilter API key credential is correctly configured and has the necessary permissions.
  • Check network connectivity to the DNSFilter API endpoint.
  • If rate limited (HTTP 429), respect the Retry-After header and retry after the specified time.
  • Validate the IP address format before sending the request to avoid API errors.
  • Enable debug mode to get detailed request and response information for troubleshooting.

Links

Discussion