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 interacts with the DNSFilter API to retrieve a list of existing user agents with basic information. It supports filtering, sorting, and pagination to customize the results. This is useful for scenarios where you need to monitor or manage user agents in your network, such as fetching all protected agents or filtering by agent state or version.

Use Case Examples

  1. Fetch all user agents with the state 'protected'.
  2. Retrieve user agents filtered by agent type and version.
  3. Get a paginated list of user agents sorted by last sync time.

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.
Additional Fields Additional filters and options to refine the user agents query, including agent state, type, version, auto update status, block page ID, MSP ID, name search, network IDs, new agent states, organization IDs, pagination, policy ID, policy schedule, release channels, scheduled policy ID, search keywords, sort options, online/offline state, status, tags, traffic received in last 15 minutes, and user agent type.

Output

JSON

  • json - The JSON response containing the list of user agents and their details.

Dependencies

  • DNSFilter API key credential

Troubleshooting

  • Ensure the DNSFilter API key credential is correctly configured and has the necessary permissions.
  • Check the network connectivity to the DNSFilter API endpoint.
  • Verify that the input parameters for filtering and pagination are correctly formatted.
  • If the node returns a rate limit error (HTTP 429), consider enabling batching with appropriate batch size and interval to avoid hitting the rate limit.

Links

Discussion