The CloudRadial AutomationAI ScoutDNS extension lets a workflow or agent manage and report on ScoutDNS protective DNS: browse your organizations, locations, networks, and client agents; maintain client profiles, allow/block lists, TLD filters, and block pages; and pull threat, traffic, and usage analytics. This article covers what the extension can do, the secrets it needs, which tools require approval, and the skills that ship with it. It is for workspace users who build automations (Admin or Owner Role).
- What the Extension Covers
- Creating the API Key
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Skills
- Tips for Working With ScoutDNS Data
What the Extension Covers
The extension calls the ScoutDNS API and provides 63 tools across these areas:
| Area | What you can automate |
| Account (2 tools) | Confirm the identity and account the API key belongs to, and list the operators on the account |
| Organizations, locations, and networks (16 tools) | List and read organizations, locations, and networks, check network online status, and create, edit, or delete an organization or location. Networks can be created by WAN IP and edited. |
| Client agents (8 tools) | List and read client agents (devices), review a client's sessions and client counts, and edit, enable, disable, or uninstall a client agent |
| Client profiles (6 tools) | List and read client profiles, list the profiles that belong to an organization, and create, edit, or delete a profile |
| Policies (6 tools) | List and read filtering policies, read the baseline policy template, and delete a policy |
| Allow/block lists and TLD filters (10 tools) | List, read, create, edit, and delete allow/block lists and TLD filters |
| Block pages (4 tools) | List and read the block pages shown when a request is blocked, and create or edit a block page |
| Reporting (11 tools) | Pull threat statistics, top domains and categories, request statistics by decision, requests per second and per network, average latency, the DNS audit log, domain and category statistics, and usage and billing statistics |
Two of the policy tools, create a policy and edit a policy, are listed with the extension but can't run through it. The extension can read and delete policies; create or change a policy in ScoutDNS itself.
Install it from Extensions like any other catalog extension. It appears in the catalog as ScoutDNS. See Browsing and installing extensions for the general install flow.
Creating the API Key
The extension authenticates with a ScoutDNS API key. Account admins create keys in the ScoutDNS console:
- Go to Settings > API Keys and click New API Key.
- Enter a description, such as which system uses the key, and click Save.
- Use the Copy button in the API Key column to copy the key. Copy the API Key value, not the Key ID, which can't authenticate.
ScoutDNS doesn't display the key on screen, but you can copy it again at any time. A key has no scopes or expiry and carries full API access to your ScoutDNS account, and the number of keys you can hold depends on your ScoutDNS plan. For ScoutDNS's own steps, see API access. You also need the API base URL for your account.
Providing the Credentials to Your Runner
Store two secrets in your runner's Key Vault with these exact names:
| Secret | Value |
ScoutDNS-ApiUrl |
The ScoutDNS API base URL, for example https://api.scoutdns.com/app. OEM accounts use a different host, so use the base URL for your account. |
ScoutDNS-ApiKey |
The ScoutDNS API key |
Each tool's endpoint is added to the end of ScoutDNS-ApiUrl, so store only the base URL. The extension sends the key in the X-API-ACCESS-KEY header for you. For how to add secrets, see Accessing and updating your runner's Key Vault. If you keep a separate ScoutDNS account per client, see Managing companies and per-company credentials.
The agent reads the credentials from the runner and never asks you for them. Once the secrets are in place, ask the AI Playground which ScoutDNS account the key belongs to, or to list your organizations, to confirm the connection works.
Reads and Approval-Gated Changes
Of the 63 tools, 37 are read-only and run without interruption, including every reporting tool. The other 26 create, edit, delete, enable, disable, or uninstall something, and every one of them is approval-gated: the run pauses and the request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox.
| Tool behavior | Tools |
| Approval-gated | Create, edit, or delete an organization, location, client profile, allow/block list, or TLD filter; create or edit a network or block page; delete a policy; edit, enable, disable, or uninstall a client agent |
| Read-only | Every list and read tool for the account, organizations, locations, networks, client agents, client profiles, policies, allow/block lists, TLD filters, and block pages, plus all 11 reporting tools |
Uninstalling a client agent removes it from the device, and a delete removes the item from ScoutDNS, so review the target carefully before you approve.
Skills
The extension ships eight skills that guide an agent through common ScoutDNS tasks:
| Skill | Use it to |
| Browse ScoutDNS directory | Browse operators, organizations, locations, networks, and their status. Read-only. |
| DNS reporting and analytics | Pull threat, traffic, latency, audit, and usage analytics. Read-only. |
| Manage allow/block and TLD filter lists | Read and change allow/block lists and TLD filters. Creates, edits, and deletes wait for approval. |
| Manage block pages | Read and change the block pages shown when a request is blocked. Creates and edits wait for approval. |
| Manage client agents and devices | Inspect client agents and edit, enable, disable, or uninstall one. Changes wait for approval. |
| Manage client profiles | Read and change client profiles and the policies they bind to. Creates, edits, and deletes wait for approval. |
| Manage organizations, locations and networks | Read and change organizations, locations, and networks. Creates, edits, and deletes wait for approval. |
| Manage policies | Read filtering policies and the policy template, and delete a policy. The delete waits for approval. |
Tips for Working With ScoutDNS Data
- Most reports take a fixed period:
Last Hour,Today,Last 24 Hours,Yesterday,This Week,Last Week,This Month, orLast 30 Days. Ask for one of these windows when you request a report. - Reports can be narrowed by decision, organization, client profile, or client. Most reports use
ALLOWEDandFORBIDDENdecisions; the audit log usesALLOWED,BLOCKED, andDROP. - ScoutDNS ids are UUID strings, such as
7c9e6679-7425-40de-944b-e07fc1f90ae7, not numbers. Let the agent look up an id by name rather than typing one in. - Listing client agents returns the complete list in one call, so you don't need to ask for more pages
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.