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 operation fetches all networks associated with a Managed Service Provider (MSP) user, providing detailed network information. It supports filtering, pagination, and options to customize the data returned, such as counting IP addresses or excluding IP details. This is useful for MSPs managing multiple networks under their organization, allowing them to retrieve comprehensive network data efficiently.

Use Case Examples

  1. An MSP wants to retrieve all networks under their management to audit network configurations and statuses.
  2. A network administrator needs to get a list of all networks associated with their MSP account, including IP counts, for reporting purposes.

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.
Organization Id The ID of the organization (MSP) whose networks are to be retrieved.
Additional Fields Optional filters and settings to customize the network data retrieval, including counting IPs, truncating IP details, pagination settings, and filtering by protection status.

Output

JSON

  • json - The JSON response containing the list of networks associated with the MSP user, including network details as per the applied filters and options.

Dependencies

  • An API key credential for DNSFilter to authenticate API requests.

Troubleshooting

  • Ensure the Organization Id is correct and the API key has permissions to access MSP network data.
  • If pagination is enabled, verify pagination parameters are correctly set to avoid incomplete data.
  • Check for rate limiting errors (HTTP 429) and use batching options to manage request rates.
  • Enable debug option to see the actual API request details for troubleshooting.

Links

Discussion