The CloudRadial AutomationAI Webroot Endpoint Protection extension lets a workflow or agent work with your Webroot GSM console through the OpenText Webroot Unity API: inventory sites and endpoints, investigate threat history, review policies, groups, and protection statistics, and, with approval, deactivate or reactivate endpoints. This article covers what the extension can do, the credentials 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
- Getting the Credentials and GSM Keycode
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Skills
- Tips for Working With Webroot Data
What the Extension Covers
The extension calls the Webroot Unity API and provides 16 tools across these areas:
| Area | What you can automate |
| GSM console and sites | Read the GSM console, which also confirms the credentials and keycode work, list and read sites, and find a site by its site keycode |
| Endpoints | List the endpoints in a site, filtered by type, host name, or machine id, read one endpoint's detail and status, and deactivate or reactivate endpoints |
| Threat history | List the threat history for a site or for one endpoint, within a start and end date |
| Policies and groups | List the policies defined at the GSM level or available to a site, and list and read the device groups in a site |
| Protection statistics | Read endpoint-protection statistics, such as protected, infected, and expired counts, for the whole console or for one site |
Install it from Extensions like any other catalog extension. It appears in the catalog as Webroot Endpoint Protection. See Browsing and installing extensions for the general install flow.
Getting the Credentials and GSM Keycode
The extension signs in to the Unity API with two pairs of credentials, plus your GSM keycode on every request:
- A Unity API client id and client secret. In the Webroot management console's Managed Service Provider view, open Settings > Unity API Access, select Create New Client Credential, and complete the three steps. Note the client secret when it is shown. If it is lost, Renew Secret issues a new one and expires the old one.
- The email address and password of a Webroot GSM console user. Every GSM console user can use the console API by default.
- Your GSM keycode, shown as Parent Keycode under Settings > Account Information
For details on client credentials, see Webroot's Managed Service Provider view settings documentation.
The GSM keycode is not stored in your runner's Key Vault. The Unity API has no way to list the GSM keycodes available to a user, so you supply the keycode in your prompt or workflow input each time; see Tips for Working With Webroot Data.
Providing the Credentials to Your Runner
Store five secrets in your runner's Key Vault with these exact names:
| Secret | Value |
Webroot-ApiUrl |
The Unity API base URL, normally https://unityapi.webrootcloudav.com
|
Webroot-ClientId |
The Unity API client id |
Webroot-ClientSecret |
The client secret that pairs with the client id |
Webroot-Username |
The GSM console user's login (email-style) |
Webroot-Password |
That user's password |
The extension uses all four credentials to request a short-lived access token from Webroot and renews it as needed. For how to add secrets, see Accessing and updating your runner's Key Vault.
The agent reads the credentials from the runner and never asks you for them. Once the secrets are in place, ask the AI Playground to read your GSM console, giving it your GSM keycode, to confirm the connection works.
Reads and Approval-Gated Changes
Of the 16 tools, 14 are read-only and run without interruption. The other 2 change endpoint state, and both are 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 | Deactivate endpoints; reactivate endpoints |
| Read-only | Read the GSM console; list, read, and look up sites; list and read endpoints; list site and endpoint threat history; list GSM and site policies; read GSM and site statistics; list and read groups |
A deactivated endpoint stops counting against your license and stops reporting. Deactivate and reactivate act on the set of endpoint ids in the request, so the agent resolves the exact endpoints and confirms the site first. Check the endpoints listed in the approval request before you approve it.
Skills
The extension ships four skills that guide an agent through common Webroot tasks:
| Skill | Use it to |
| Inventory Sites and Endpoints | List the sites under a GSM console or the endpoints within a site. Read-only. |
| Investigate Endpoint Threats | Review threats seen on a site or on one endpoint over a date window. Read-only. |
| Deactivate or Reactivate Endpoints | Deactivate endpoints, for example to free licenses for retired devices, or reactivate endpoints that were deactivated. Both steps are approval-gated. |
| Review Policies and Protection Statistics | Review GSM or site policies, a site's device groups, or protected, infected, and expired counts for the console or a site. Read-only. |
To give an agent these skills, see Creating custom agents and using them in workflows.
Tips for Working With Webroot Data
- Include your GSM keycode in every prompt or workflow that uses the extension. Every tool needs it, and the agent cannot look it up.
- Refer to sites by name, or give a site keycode, and let the agent look up the numeric site id. Most tools need a site id.
- Give a start and end date when you ask about threat history, to keep the report bounded
- Endpoint and threat lists are paged. For large sites, the agent requests more pages until it has every result.
- If every call fails, check all five secrets and that the GSM keycode you supplied is correct. Asking the agent to read the GSM console is a quick way to test both.
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.