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 deletion of networks in the DNSFilter system. It allows users to specify multiple network IDs or use the keyword 'all' to delete all networks within an organization. The node supports additional options such as specifying the organization ID when deleting all networks, adding custom request headers, query filters, batching settings to control request rate, pagination settings, and timeout configuration. It is useful for administrators who need to efficiently remove multiple networks in a single operation, for example, when cleaning up outdated or unused network entries.

Use Case Examples

  1. Bulk delete specific networks by providing a comma-separated list of network IDs.
  2. Delete all networks within a specified organization by using the keyword 'all' and providing the organization ID.

Properties

Name Meaning
Ids Comma delimited Network IDs or keyword 'all' to specify which networks to delete.
Additional Fields Optional fields such as Organization ID, required if 'all' is used for IDs.
Options Additional request options including custom body, headers, query filters, batching, debug, pagination, and timeout settings.

Output

JSON

  • debug - Debug information including actual URL, query parameters, headers, and body sent for each API request (if debug option is enabled).
  • json - Response data from the bulk delete operation.

Dependencies

  • An API key credential for DNSFilter API authentication.

Troubleshooting

  • Ensure the 'Ids' field is correctly formatted as a comma-separated list or the keyword 'all'.
  • If using 'all' for IDs, the 'Organization Id' must be provided in additional fields.
  • Check API rate limits and use batching options to avoid 429 errors.
  • Enable debug option to get detailed request information for troubleshooting.
  • Handle errors gracefully and check error messages returned by the API for guidance.

Links

Discussion