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 update operations on networks within the DNSFilter API. It allows users to update multiple network records at once by specifying network IDs or using the keyword 'all'. Users can provide various additional fields such as organization ID, policy ID, scheduled policy ID, block page ID, and VPN status to update the networks accordingly. This is useful for administrators managing large sets of network configurations efficiently, for example, updating policies or VPN settings across multiple networks in a single API call.

Use Case Examples

  1. Bulk update multiple networks by specifying their IDs and changing the policy ID for all of them.
  2. Update all networks within a specific organization by using the 'all' keyword for IDs and providing the organization ID along with other fields to update.

Properties

Name Meaning
Ids Comma delimited Network IDs or keyword 'all' to specify which networks to update.
Additional Fields Optional fields to update on the networks such as organization ID, policy ID, scheduled policy ID, block page ID, and legacy VPN status.
Options Additional request options including custom body, headers, query filters, batching, debug mode, pagination, and timeout settings.

Output

JSON

  • json - The JSON response from the bulk update API call, containing the result of the operation.

Dependencies

  • DNSFilter API key credential

Troubleshooting

  • Ensure the 'Ids' field is correctly formatted as comma separated values 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 and response information for troubleshooting.

Links

Discussion