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

Organizations → Bulk update

AI-generated

Overview

This node performs bulk update operations on organizations within the DNSFilter API. It allows users to update multiple organizations at once by specifying organization IDs or an MSP ID to scope the update. Users can set various fields such as GDPR status, notification preferences, and auto-update settings for user agents. This node is useful for administrators managing multiple organizations in DNSFilter, enabling efficient batch updates to organization settings.

Use Case Examples

  1. An MSP administrator wants to enable GDPR functionality and auto-update for user agents across all accessible sub-organizations. They use this node to bulk update these settings by specifying the MSP ID and the desired fields.
  2. A user needs to exclude certain organizations from a bulk update operation. They provide a list of organization IDs to exclude and update other organizations with new notification settings.

Properties

Name Meaning
Organization Ids List of organization IDs to update in the bulk operation.
Msp Id MSP ID to scope the update to all accessible sub-organizations, overriding specific organization IDs.
Exclude Organization Ids List of organization IDs to exclude from the bulk update.
Gdpr Boolean flag indicating if GDPR related functionality is enabled for the organization (MSPs only).
Send Uninstall Notifications To Admin Users Boolean flag to send uninstall notifications to admin users.
Show Pii Rc Hostnames Boolean flag to show RC names on RC management screen (MSPs only).
User Agent Uninstall Notification Boolean flag indicating if user agent uninstalls should trigger notifications.
User Agent Uninstall Notification Recipient Emails List of recipient emails to receive uninstalled user agent notifications.
User Agents Auto Update Boolean flag indicating if user agents will auto update.

Output

JSON

  • json - Response data from the bulk update operation, including status and details of updated organizations.

Dependencies

  • Requires an API key credential for DNSFilter API authentication.

Troubleshooting

  • Ensure the API key is valid and has the necessary permissions to perform bulk updates on organizations.
  • Verify that the organization IDs and MSP ID provided are correct and accessible by the API key user.
  • Check for rate limiting errors (HTTP 429) and use batching options to avoid hitting rate limits.
  • If the API returns errors, review the error message for details and adjust the request parameters accordingly.

Links

Discussion