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

Distributors → MSP Search

AI-generated

Overview

This node operation allows users to search for Managed Service Providers (MSPs) through the Distributors resource in the DNSFilter API. It supports filtering MSPs based on various criteria such as cancellation status, creation date, distributor ID, MSP name, and more. The operation handles pagination and can return either a single page or all available results. This is useful for distributors who need to retrieve and manage lists of MSPs matching specific search criteria, for example, to generate reports or synchronize MSP data.

Use Case Examples

  1. Fetch all MSPs that are not canceled and have been created after a specific date.
  2. Search MSPs by distributor ID and MSP name with pagination to handle large result sets.

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 Optional filters to refine the MSP search, including date ranges, distributor details, MSP name, cancellation status, and pagination settings.

Output

JSON

  • debug - Debug information including actual URL, query parameters, headers, and body sent for each API request (if debug option is enabled).
  • * - The JSON response from the MSP search API call, which includes the list of MSPs and their details matching the search criteria.

Dependencies

  • An API key credential for DNSFilter API authentication is required.

Troubleshooting

  • Ensure the API key is correctly set in the credentials to avoid authentication errors.
  • If pagination is enabled, verify the pagination parameters to avoid incomplete data retrieval.
  • Check the filter values for correct data types and formats, especially timestamps and ISO8601 dates.
  • Enable debug option to get detailed request and response information for troubleshooting.

Links

Discussion