API Access

API Access

API access is available to certain account types.  API access gives admins the ability to self manage API tokens for access to the standard ScoutDNS Operator API.


This help article is about the public operator API. For any other API access such as the OEM API please contact support. 

Create API Token


Access and use of the operator API requires authentication with a token. In order to create a token you must select the API Access Management page from the profile icon at top right.





API Limits

The number of APIs you can create and manage depends on your account subscription level. To generate an API simply select New API at the top right. This will create a new access token that can be copied using the Copy option on the right hand side of the UI.  Operators may revoke and reissue new keys at anytime as needed. 




API Documentation


ScoutDNS maintains official API doc at its online Swagger hub page. You can use this page to track any updates or changes and view available capabilities.  Features and capabilities are subject to change, so please track the official Swagger hub for latest API capabilities. 









    • Related Articles

    • Add System Users - Role Based Access

      ScoutDNS supports Role Based Access allowing multiple operators within a single account to access the system. Roles There are three possible roles in any account. Super Admin: One per account. Can create and remove and users. Has access to create, ...

    • 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 ...

    • 2FA/MFA - Two Factor Authentication

      Enabling 2FA for your account can increase the security for operators accessing your data. ScoutDNS supports token based 2FA and this can be enforced for all operators with access to an account. Once enabled, any operator accessing your account will ...

    • Configure Custom Block Pages

      Admins have the ability to edit the default block page and to create multiple custom block pages to present to end users. Block pages are rendered in our block page service engine. You can assign custom block pages to WANs under Sites, and Roaming ...

    • Roaming Clients / Device Agents - Setup, Configure, and Manage

      ScoutDNS provides device agents for organizations what wish to cover devices with DNS layer protection on and off the network. The ScoutDNS device agent is an extremely lightweight application best installed on managed devices where administrative ...