API Access
API access is available for certain account types, allowing admins to self-manage API tokens for the standard ScoutDNS Operator API.
This help article covers the Public Operator API. For access to other APIs, such as the OEM API, please contact support.
Create API Token
Accessing and using the Operator API requires authentication with a token. To create a token, select the API Access Management page from the profile icon at the top right.
API Limits
The number of APIs you can create and manage depends on your account subscription level. To generate an API, select "New API" at the top right. This will create a new access token, which you can copy using the "Copy" option on the right-hand side of the UI. Operators can revoke and reissue keys at any time as needed.
API Documentation
ScoutDNS maintains official API documentation on its online Swagger Hub page. You can use this page to track updates, view available capabilities, and stay informed about any changes. Features and capabilities are subject to change, so please refer to the official Swagger Hub for the latest API information.
Related Articles
Add System Users - Role Based Access
ScoutDNS supports role-based access, allowing multiple operators within a single account to access the system. This article describes how to configure role-based access directly in ScoutDNS. To configure and manage role-based access from Entra ID ...Single Sign On (SSO) Configuration - Entra ID
Entra ID SSO Enabling Single Sign On (SSO), allows admins to manage access for their instance through Entra ID SSO. ScoutDNS uses the Open ID Connect (OIDC) protocol for secure commination with Entra ID. SSO will disable all existing ScoutDNS ...Configure Entra ID based Policies
ScoutDNS supports policy enforcement by user groups synced from Entra ID (formerly Azure AD). This is useful when admins want policy decisions to follow the user regardless of the device or device profile in use. This guide explains how ScoutDNS ...Roaming Clients / Device Agents - Setup, Configure, and Manage
ScoutDNS provides device agents for organizations that wish to protect devices with DNS-layer security both on and off the network. The ScoutDNS device agent is an extremely lightweight application, best installed on managed devices where ...2FA/MFA - Two Factor Authentication
Enabling 2FA for your account enhances security for operators accessing your data. ScoutDNS supports token-based 2FA, which can be enforced for all operators with account access. Once enabled, operators must authenticate using a token sent to the ...
Popular Articles
Working with Whitelist and Blacklist
At times, it may be helpful to fully block or allow a domain based on your desired outcome. The White/Black List tab allows you to create and manage custom block and allow lists. You can associate these lists with all policies (global) or assign them ...Quick Start Setup Guide - WAN Forwarding
This quick start guide is meant to help get up and running quickly with the various deployment methods offered. This is the general use guide. If you are an MSP, please visit the MSP Setup Guide. There are three methods you can use to protect your ...Content Categories
Below is a list of Content Categories and their descriptions. Adult Abortions These are sites that present arguments either in favor of or against abortion. This includes information on abortion procedures, sites that offer assistance in obtaining ...Mixing DNS Providers
It is generally not recommended to mix DNS providers. Most routers and systems randomly select which DNS server receives each packet, which can lead to issues with filtering and reporting due to mixed rules in the system cache. To avoid these ...YouTube Restricted Mode Explained
ScoutDNS supports YouTube's restricted modes, allowing for a level of content control on the platform. While individual videos cannot be allowed or blocked at the URL level, Google G Suite users can approve specific videos for others within the same ...
Recent Articles
SIEM Data Export
Overview The SIEM Data Export feature allows administrators to stream DNS query and event data from ScoutDNS directly into their SIEM or log analytics platform for advanced analysis, threat correlation, and compliance reporting. ScoutDNS currently ...Applications Categories - Zero Trust App Management
The ScoutDNS Application Policy sub-tab lets you block whole groups of web applications while still allowing specific apps through an allow list. It covers tens of thousands of domains and supports a zero-trust security approach. For example, you can ...Configure Entra ID based Policies
ScoutDNS supports policy enforcement by user groups synced from Entra ID (formerly Azure AD). This is useful when admins want policy decisions to follow the user regardless of the device or device profile in use. This guide explains how ScoutDNS ...Setup and Use Guide for MSPs
ScoutDNS is built for Managed Service Providers (MSPs) to deliver robust DNS protection to their customers and end users. Setup is straightforward, thanks to our object-based configuration approach. Here is a brief outline of what this guide covers. ...Configure AD (Active Directory) Policies
ScoutDNS supports policy enforcement by user groups synced from Active Directory. This is useful when admins want policy decisions to follow the user regardless of the device or device profile in use. This guide explains how ScoutDNS syncs with ...