API access

The ScoutDNS Operator API exposes the same primitives as the Admin Console, sites, networks, policies, allow/block lists, activity, and reports, as a REST/JSON service. Admins self-manage their own tokens.

[!NOTE] This article covers the public Operator API. For access to specialized APIs (e.g. the OEM API), contact support directly.

Create an API token

1. Click the profile icon (top right of the Admin Console) and open API Access Management.

   

2. Click New API in the top right to mint a new token.

3. Use Copy to grab the token value.

[!IMPORTANT] Token values are only displayed once at creation. Copy and store the token in a secret manager before leaving the page. If you lose the value, revoke the token and mint a new one.

You can revoke and reissue tokens at any time. The number of tokens you can hold simultaneously depends on your subscription tier.

Authenticate API requests

Send the token as a bearer credential in the Authorization header on every request:

curl -H "Authorization: Bearer <YOUR_TOKEN>" \
     https://api.scoutdns.com/v1/sites

import requests

resp = requests.get(
    "https://api.scoutdns.com/v1/sites",
    headers={"Authorization": f"Bearer {TOKEN}"},
)
resp.raise_for_status()
print(resp.json())

API reference

The complete, machine-readable API specification lives on SwaggerHub. Use it to discover endpoints, request/response shapes, and example payloads:

app.swaggerhub.com/apis/ScoutDNS/ScoutDNS

[!TIP] The SwaggerHub page lets you execute requests directly from the browser once you paste a token into the “Authorize” dialog. Quick way to validate token scope without writing any code.

Related

• SIEM data export for streaming query logs into Splunk or Huntress
• Two-factor authentication for protecting the Admin Console accounts that mint tokens