API Access

API Access

API access is available for certain account types, allowing admins to self-manage API tokens for the standard ScoutDNS Operator API.

Info
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 ...
    • 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 ...
    • DNS IPs List

      ScoutDNS operates a global Anycast network for improved resiliency and performance. All resolver IP addresses can be found within the application under the Help Icon > IPs list ScoutDNS operates a closed, private resolver network for enhanced ...