API access

The ScoutDNS Operator API exposes the same primitives as the console, sites, networks, policies, allow/block lists, activity, and reports, as a REST/JSON service. Admins self-manage the account’s keys under Settings → API Keys.

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

Create an API key

1. Open Settings → API Keys and click New API Key.
2. Enter a description (what the key is for, which system uses it) and Save.
3. Use the Copy button in the API Key column to grab the key value.

Every key has two values, and they are not interchangeable:

• Key ID: a UUID that identifies the key in the list. It cannot authenticate anything.
• API Key: the bearer credential itself. It is never displayed on screen, but you can copy it at any time with its Copy button, at creation or later.

Keys have no per-key scopes or expiry; each key carries full Operator API access for the account. The number of keys you can hold is your plan’s API keys allowed allowance, shown under Settings → Subscription.

[!IMPORTANT] Revoking a key is instant and cannot be undone; anything still using it starts failing immediately. To rotate a key, create the new key first, move your integrations over, then revoke the old one.

Authenticate API requests

Send the key 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 key into the “Authorize” dialog. Quick way to validate a key without writing any code.

Related

• Settings Overview - Account Administration
• SIEM data export for streaming query logs into Splunk or Huntress
• Two-factor authentication for protecting the console accounts that mint keys