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

NetworkSubnets → Get extant

AI-generated

Overview

This node operation fetches the list of subnets associated with a specific network using the DNSFilter API. It is useful for network administrators or IT professionals who need to retrieve subnet information for network management, monitoring, or auditing purposes. For example, it can be used to get all subnets of a network to analyze network segmentation or to verify subnet configurations.

Use Case Examples

  1. Retrieve all subnets for a network with ID 12345 to audit network segmentation.
  2. Fetch subnets for a network to monitor IP address allocation and usage.

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.
Id The ID of the network for which to retrieve subnets.
Additional Fields Optional additional parameters such as pagination settings (e.g., page number and size).
Options Additional request options including custom body, headers, query filters, batching, debug mode, pagination settings, and timeout.

Output

JSON

  • json - The JSON response from the DNSFilter API containing the list of subnets or subnet details.

Dependencies

  • An API key credential for DNSFilter API authentication.

Troubleshooting

  • Ensure the network ID provided is valid and accessible with the API key used.
  • Check API rate limits and use batching or delays if hitting rate limits.
  • Enable debug mode to see the actual request and response details for troubleshooting.
  • Verify pagination settings if expecting multiple pages of results.
  • Handle API errors gracefully and check error messages for guidance.

Links

Discussion