Skip to main content
Customer Support Customer Support

Webroot® Unity API

Support for Unity Thrust API, Universal Reporter, and Syslog Connector.

  • 124 Topics
  • 287 Replies
124 Topics
cbullas
cbullasRetired Webrooter
published in Webroot® Unity API
Unity API - Open API preview release

As part of making it easier to use the Unity API we have released a preview version of Open API support. Here are a few details. Unity API users can now start with a documented ‘API library’ instead of having to set everything up from scratch, making it easier to generate code/scripts, use testing tools and self-educate. Open API is supported by loads of tools. Files in both JSON and YAML for flexibility For more information see https://unityapi.webrootcloudav.com/Docs/en/APIDoc/APIReference#get-openapi-definition Those interested to learn about Open API https://www.openapis.org/ Note this is a public preview release, you will still need to setup access/ refresh token calls, see https://unityapi.webrootcloudav.com/Docs/en/APIDoc/GettingStarted#gettingStarted Let us know what you think!

8744
ngoknel
Administrator
cbullas
cbullasRetired Webrooter
published in Webroot® Unity API
Universal Reporter - create customer value add reports for your customers

We have just launched our Universal Reporter tool that's been created by the Integrations team here at Webroot. This tool allows MSPs to create custom reports that show value to your end customers. We've also made it really easy to be able to schedule and automatically email selected reports to your customers. The tool uses the concept of templates for reports that are built using Microsoft Excel and PowerShell Scripts. Included are a sample of templates to for you to play with. We've created our knowledge base to help you get up and running . Download the Universal Reporter For the coders / scripters among you check out the new Unity API SDK, PowerShell cmdlet included. It only covers reporting functions in the Unity API at present, but we would love to know what you think about it. Plus no need to worry about access and refresh tokens. Thanks

3730
cbullas
JosephRi
JosephRiRetired Webrooter
posted in Webroot® Unity API
IMPORTANT - Identifying your Application

[h4]IMPORTANT - Identifying your Application[/h4] When using the Unity API you need to specify a valid user agent string for all requests in the corresponding User-Agent request header. The string needs to be made up of one or more name and version pairs separated by a whitespace character (e.g. "MyCustomApplication/1.2.759 ThirdpartyPlatform/1.0.r3"), according to the HTTP/1.1 standard. Please be aware that Webroot reserves the right to reject Unity API requests that do not follow above requirement anytime in the future. Identifying your application is important and enables Webroot to provide a more targeted and streamlined API experience. If you have any questions please do not hesitate to reach out to Webroot support.

2780
JosephRi
C
New Voice
chrisroseNew Voice
asked in Webroot® Unity API
DNS ProtectionPolicy mapping via UnityAPI

Good day, I am working on enabling DNS Protection and setting some of its options using Unity API. I can successfully enable and disable the module using Unity API and I can set the site policy to one that includes DNS Protection on our endpoints, and the network wide DNS Protection Policy for a Static IP. However, I cannot see a way to set the Agent/Endpoint DNS Protection Policy. It does not even seem this is possible with the current set of commands. Am I missing something? Or is this not possible? Might it be an option that will be enabled in the future? Thanks,Chris

704
JonathanB
S
New Member
SFCSANew Member
posted in Webroot® Unity API
Get-UnityAPISkyStatusReportingEndpointUsageSite Failing

Can’t create fully extended data reports. Error every time.

220
S
New Member
A
New Member
andystewartNew Member
asked in Webroot® Unity API
Universal Syslog Connector - current state

Hi - the most recent conversation re your UCS was 10 months ago, where it was called out that it doesn’t run as a service. Has this been resolved yet? The install docs don’t reference anything about services. Thanks,Andy

631
aqila
Community Manager
I
New Member
it4mtsysadminNew Member
asked in Webroot® Unity API
It MSO/Excel really necessary to pull reports?

I have not tried the Universal Reporter yet and I am wondering if there is a way to avoid having to bother with MSO/Excel. Can the data pulled via PowerShell direclty so I can parse it with something else? Thanks For Your Help

271
aqila
Community Manager
J
Fresh Face
Jared.henryFresh Face
asked in Webroot® Unity API
Unity API: SkyStatus request failed (No parameterless constructor defined for type of 'System.String'.)

Starting on October 12th we noticed a rise in API call failures specific to the https://unityapi.webrootcloudav.com/service/api/status/site/ {GSMKey} endpoint. The receive the following response: "statusCode: 500,""requestId: '',"error: null,""error_description: ""SkyStatus request failed (No parameterless constructor defined for type of 'System.String'.)","AdditionalInformation: {}

803
aqila
Community Manager
J
New Member
JB4New Member
posted in Webroot® Unity API
SkyStatus request failed (No parameterless constructor defined...

Had been running this report (Endpoint:List) with no problems. I added a couple of new sites. Universal Reporter is log indicates it is successful on the first site, and I get output for it. It fails on the second site (the first NEW site), with the error: :: ERROR [2023-10-12 15:54:16Z] Exception occurred. Exiting processing.... {"statusCode":500,"requestId":"31205b99-c3da-4e7b-8618-cd183536f303","error":null,"error_description":"SkyStatus request failed (No parameterless constructor defined for type of 'System.String'.)","AdditionalInformation":{}} At C:\Users\Me\OneDrive - MyCompany\Documents\Webroot Reporting\Runs\20231012T2153265213848Z\Templates\Endpoint List - 1.3\Scripts\template.psm1:275 char:5+ Get-UnityAPISkyStatusSiteEndpointStatusSite -UnityAPIClient $Scri ... The output for the failed site appears to have legitimate Parameters, Site, and ConsoleEndpoints sheets, but the other sheets all have headers but no endpoints.

973
F
New Voice
M
Fresh Face
Matthew_LangFresh Face
posted in Webroot® Unity API
SkyStatus request failed (No parameterless constructor defined for type of 'System.String'.)

We have been using the API https://unityapi.webrootcloudav.com/service/api/status/site/ {GSMKey} for many months now and it has been working fine until this morning. I have started receiving the following response and was wondering why this woudl suddenly be the case. I am getting the same result from other API calls for the endpoint status. { "statusCode": 500, "requestId": ", "error": null, "error_description": "SkyStatus request failed (No parameterless constructor defined for type of 'System.String'.)", "AdditionalInformation": {} }

931
aqila
Community Manager
R
Fresh Face
RockRidderFresh Face
posted in Webroot® Unity API
Universal syslog connector: Run as Service

I was really excited to see this Application, we use Rapid7 and there was no good way to get this data into IDR. My excitement was quickly diminished immediately after I installed this software. Why create a software that is to redirect logs, and in this case to a SIEM and not make it run as a service? I tested it, right after I set it up, I monitored the service running and as soon as I logged off my admin account the service stopped and I can only assume the logging stopped as well. Is there anyway to run this as a service? I really don’t need to see the Scrolling CLI, that feature is pretty much pointless.

1523
aqila
Community Manager
A
Fresh Face
antonioocorreiaFresh Face
asked in Webroot® Unity API
Automating Email Sending with Webroot Universal Reporter

Hello, I would like to have assistance regarding the webroot Universal Reporter tool. My focus is to automate webroot emails with all the information automated but with my design. At the moment, I am in a testing phase where the email is configured, but it doesn't send anything automatically. When I click on "run reporting" in the "Run Reports" tab, it only gives me the PDF file and not via email. Could someone help me configure the automation of email sending? Best regards, António Correia

734
aqila
Community Manager
P
New Member
papabolromeNew Member
posted in Webroot® Unity API
AgentStatus endpoint no QueryResults

Hello, I need to get my client’s Agentstatus data but the queryresults aren't giving me any results when trying to query it. Am I doing something wrong? Thank you!

882
B
New Member
R
New Voice
RickkeeNew Voice
posted in Webroot® Unity API
How do I report in individual entities in a site? With Universal Reporter

Hi, I get one report for 682 devices. How do I run a report for the individual customers (entities) ?Do I need to configure them as individual sites, each with a different parent / install keycode?

782
Haris1999
New Member
R
Fresh Face
rspauldingFresh Face
asked in Webroot® Unity API
Exception during Template processing erro

Running the “DNS Allowed DU Streaming Median and Social Networking” script, I continually get an error with v1.3 that I did not get with v1.2. The error is “Exception during Template processing: Unable to deserialize error response (Invalid character '<' in input string). At C:\Users\*****\Documents\Webroot Reporting\Runs\20230517T2005153219444Z\Templates\DNS Allowed DU Streaming Media and Social Networking\Scripts\template.psm1:364 char:5+ Get-UnityAPIConsoleGSMDNSPTrafficByCategorySite -UnityAPIClient $ ...

1161
aqila
Community Manager
R
New Member
rajansajanNew Member
posted in Webroot® Unity API
Webroot API is not return all the end points

Hi All, I am calling the reports end point and it’s return only 6 endpoints, I have checked I have 7 active endpoints. or is there any way I can call the inactive endpoints using the API. If anybody can help? Thanks,

1043
TylerM
Administrator
R
New Member
rbalenaNew Member
asked in Webroot® Unity API
run SAT reports on weekly interval

Is there a way to automatically send reports on a weekly interval(7 days). Our client wants to get a report weekly to see who’s already finished and not with the training.

151
aqila
Community Manager
David-Mee
David-MeeOpenText Employee
posted in Webroot® Unity API
Processing deeper logic in Carbonite replication PowerShell scripts: Mirror Start Options

When creating a Carbonite replication job, you have to make some decisions on the Job Options. Some of these options straight forward decisions, do you want encryption, True or False, others may have to build more logic in the decision. The next set of examples include how to address some of these in-depth decisions. Mirror Start Options The Mirror Start Options has several different choices when viewed in the console. Mirror Start Options However, when processing the PowerShell (or REST API) you will need to calculate results based on the enumerated values found in the PowerShell Scripting Guide. Here is a link to the specific information in case you are interested: https://download.doubletake.com/_download/8.5/8.5.1.0/Docs/PowerShell/PowerShellScriptingGuide.htm#Enumerations/MirrorOperationOptions.htm?Highlight='mirror'%20AND%20'option' in the simple example below, I show the “Import-Csv” PowerShell Cmdlet to read a multi-line .CSV file into a PowerShell object variable ($jobstream).

420
David-Mee
David-Mee
David-MeeOpenText Employee
posted in Webroot® Unity API
Create secured XML for Credentials in PowerShell

If you write PowerShell scripts for testing and want to provide them to clients, but any credentials need to be scrubbed prior to sending them, you can try using an XML Secured Object instead. The basic concept is to create a script that receives the username and password through the secured prompt in PowerShell and outputs an XML file with the information encrypted. To note this is not a highly secured option and should not be used in any production environment. This is an example of hiding your password while testing and demoing. Use the Read-Host -AsSecuredString to keep the password hidden create a new object using the System.Management.Automation.PSCredential class then use Export-clixml to output it into a Secured XML. The xml output results in an xml file with a password value of about 460 characters…. This XML is only valid on the system it was created ON so, if you copy that secured XML to another system and try to use it, it will not work. To ‘import’ this secured XML into an

10200
David-Mee
aqila
Community Manager
aqilaCommunity Manager
posted in Webroot® Unity API
Universal Syslog Connector Installation & Overview Guide

The following guide is also included as a readme file in the download package for the Universal Syslog Connector

5460
aqila
Community Manager
D
dengOpenText Employee
posted in Webroot® Unity API
Unity API event notification service adoption

Tell us how you are using the new Unity API event notification service. And what are some of the new events that you like us to publish through this API endpoint?

390
D
D
dengOpenText Employee
posted in Webroot® Unity API
what are some improvement that you want to see in Unity API

please share your thoughts

130
D
M
Fresh Face
Matthew_LangFresh Face
asked in Webroot® Unity API
Error(BLOCKEDPROGRAMS0021)

I have been using ADF to query the endpoint threat history API. https://unityapi.webrootcloudav.com//service/api/console/gsm/xxxxxx/sites/xxxxxxx/threathistory This has been working successfully for many weeks. we have been nearing the end of our subscription period and have been granted an extension of 30 days for our license, but now when I query this API I get the following error. Error(BLOCKEDPROGRAMS0021): Users endpoint protection access has expired" I can still get results back from other API’s I call using the same credentials so it seems isolated to the endpoint threat protection history Is this something to do with this being a temporary license? How can I go about resolving? Many thanks Matt Lang

521
aqila
Community Manager
A
New Voice
ArjanNew Voice
posted in Webroot® Unity API
Restrict API to site

Is it possible to create an API key that has only access to a single site?

813
L
New Member
J
Fresh Face
jseumo2Fresh Face
asked in Webroot® Unity API
Adding a scope to an access token

Hi, I need to be able to use the notifications endpoints for the Unity API, but I am not sure where to go to add the correct scope for my testing access token. Can anyone direct me? The token already has access to the following scopes: scope": "[\"SkyStatus.Site\",\"SkyStatus.GSM\",\"SkyStatus.Usage\",\"SkyStatus.Reporting\",\"Console.GSM\"]" Thanks

1366
J
Fresh Face

Latest solutions

Leaderboard

Badges

  • Most Wanted
    Tarnakhas earned the badge Most Wanted
  • Beta To The Max
    Tarnakhas earned the badge Beta To The Max
  • Most Wanted
    Muddy7has earned the badge Most Wanted
  • Beta To The Max
    Muddy7has earned the badge Beta To The Max
  • Beta To The Max
    pierrequiroulehas earned the badge Beta To The Max
Show all badges

Popular Tags

Join the Conversation

Terms & Conditions