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 handles bulk deletion operations for agent local users in the DNSFilter system. It is designed to create bulk delete requests by specifying arrays of user IDs to be deleted, with options to exclude certain IDs or filter by client name. This is useful for administrators who need to efficiently manage and remove multiple local users from the system in a single operation, saving time and reducing manual effort.

Use Case Examples

  1. An administrator wants to delete multiple agent local users at once by providing their IDs in an array.
  2. A user wants to exclude certain agent local users from deletion while deleting others in bulk by specifying exclude IDs.
  3. A user wants to filter the bulk delete operation by searching for client names to target specific users for deletion.

Properties

Name Meaning
Ids Array of IDs representing the agent local users that will be deleted in bulk.
Name Search A search term to filter client name fields (friendly_name) to narrow down which users to delete.
Exclude Ids Array of IDs representing agent local users to exclude from the bulk delete operation.

Output

JSON

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

Dependencies

  • An API key credential for DNSFilter to authenticate requests.

Troubleshooting

  • Ensure the 'Ids' property is provided and contains valid user IDs; otherwise, the API request will fail.
  • If using the 'Exclude Ids' or 'Name Search' filters, verify the values are correctly formatted and valid.
  • If the API rate limit is exceeded, the node may throw a 429 error; consider using batching options to avoid this.
  • Enable the 'Debug' option to get detailed request and response information for troubleshooting.

Links

Discussion