Documentation - Change Logs

Change History

Below you will find the list of changes introduced by each published Unity API service build.

Published on Monday, November 18, 2024

Version 1.0.24319.1 - Maintenance Update

Miscellaneous service improvements and documentation refinements

Published on Monday, October 28, 2024

Version 1.0.24297.2 - Feature Update

Added new API actions to the SkyStatus.Reporting scope for querying Pillr usage reports. Details can be found here.

Published on Tuesday, October 15, 2024

Version 1.0.24284.1 - Feature Update

Added support for the authorization code flow in AuthServer. To learn about generating access tokens using Postman or custom client applications, click here. To see a flow chart for the new authorization code flow, check the section 'Authorization Code Flow' on this page. Further details can be found here.
Implemented token exchange flow. See here for more information.
Introduced API actions for querying OpenText Secure Cloud related subscription charges and events. More details are available here. Additionally, a guide has been added which covers filter operations and expressions for 'SecureCloud.Usage' methods. It can be found in the 'Filter Formats' section.
Added statistics APIs for endpoints, DNSP agents and Webroot Security Awareness Training (WSAT).

Published on Tuesday, August 13, 2024

Version 1.0.24222.1 - Feature Update

Added support for sysisolate commands in command management and endpoint management APIs.
Extended some ECom.Shop APIs to accommodate special needs by individual e-commerce partners.

Published on Tuesday, April 30, 2024

Version 1.0.24115.1 - Feature Update

Added new DNSP reports which allow querying for traffic summaries grouped by categories/users. See the DNS Protection traffic information API group of the Console.GSM scope for information about respective APIs.
Extended some ECom.Shop APIs to accommodate special needs by individual e-commerce partners.
Miscellaneous service improvements and documentation refinements

Published on Thursday, June 1, 2023

Version 1.0.23117.1 - Maintenance Update

Miscellaneous service improvements and documentation refinements

Published on Wednesday, March 29, 2023

Version 1.0.23026.1 - Feature Update

Added possibility for adding an existing or new user as admin to a GSM console or site, as well as for editing certain user account attributes and removing admins from a GSM console or site. See the User Management API group of the Console.GSM scope for information about respective APIs.
Removed deprecated APIs from documentation (SkyStatus.Usage, ECom.Licenses, and ECom.Orders API scopes). Respective APIs still continue to work but are no longer visible in documentation. If you still make use of these deprecated APIs, please migrate to other APIs / plan migration with your Webroot business partner as soon as possible.
Miscellaneous service improvements and documentation refinements

Published on Wednesday, October 19, 2022

Version 1.0.22279.1 - Maintenance Update

Miscellaneous service improvements and documentation refinements

Published on Tuesday, June 14, 2022

Version 1.0.22160.2 - Feature Update

NEW: Event Notifications APIs are now available. The Event Notifications feature is a brand new API scope, allowing subscribing to and consuming notifications when events occur relating to your endpoint environment. See the Event Notifications guide for information about how notifications can be enabled for your applications, which event types are currently supported, how to subscribe to and consume event notifications, and more. Then delve into the reference documentation of notifications APIs here for a direct look at related API specifications.
Made some improvements to the OpenAPI definition to enhance texts visualization (using markdown formatting) and include additional API information
Miscellaneous service improvements and documentation refinements

Published on Wednesday, June 16, 2021

Version 1.0.21151.1 - Maintenance Update

Removed restriction to query DNS Protection traffic for a selected set of categories only. The trafficbycategory API now allows querying any list of available DNS Protection categories.
Miscellaneous service improvements and documentation refinements

Published on Thursday, May 6, 2021

Version 1.0.21118.1 - Feature Update

ECom: Added a new API action to the ECom.Shop scope to query the status of orders associated with a keycode. See the GetOrderStatus API for more information.
ECom: Extended the LicenseProfile information that is returned by various ECom.Shop APIs to provide a list of data vaults for backup products. See the license profile documentation for the GetLicense API for example. The list of vaults supersedes the related individual fields in license profile information which are still available for backwards compatibility.

Published on Thursday, March 25, 2021

Version 1.0.21081.1 - Feature Update

Console: Added possibility to query information about Web Threat Shield blocked URLs actions via the Console.GSM scope. See the added APIs under Web Threat Shield Blocked URLs for more information.
ECom: Added possibility to specify desired data vault and product platform values when creating trial licenses for Carbonite Backup related products or license modules. Refer to the API documentation of calls for creating trials and adding trial modules for related information.
ECom: Updated CreateOrder response to include item hierarchy and bundle identifiers for easier identification and grouping of related order items.
Miscellaneous service improvements and documentation refinements

Published on Thursday, December 10, 2020

Version 1.0.20338.1 - Maintenance Update

Miscellaneous service improvements and documentation refinements

Published on Tuesday, September 15, 2020

Version 1.0.20245.1 - Feature Update

ECom: Added CompanyName field to the Customer record of the Get License and Create Trial Module API responses.
ECom: Added possibility to specify additional pricing characteristics as well as Carbonite Backup related product characteristics (data vault location, retention model, and product platform) when Creating a Cart. Also extended returned item level information accordingly in responses of the Create Cart, Get Cart, and Create Order calls.
SkyStatus: Added ScriptShieldStatus field to the EnabledFeatures record when querying endpoint status on GSM level (see here) or on Site level (see here)
Added information about deprecated APIs to the OpenAPI definition files. Download the updated OpenAPI definition files here.
Miscellaneous service improvements and documentation refinements

Published on Thursday, July 23, 2020

Version 1.0.20202.2 - Maintenance Update

Miscellaneous service improvements and documentation refinements

Published on Tuesday, July 7, 2020

Version 1.0.20178.1 - Feature Update

A preview version of the OpenAPI definition for Unity API is available for download. See the API Reference here for more information.

Published on Thursday, June 4, 2020

Version 1.0.20154.1 - Maintenance Update

ECom.Shop: Added SiteName field to response entries when querying child licenses (see here)
Miscellaneous service improvements and documentation refinements

Published on Thursday, April 9, 2020

Version 1.0.20093.2 - Feature Update

ECom.Shop: Added possibility to add a trial license module (e.g. SDNS) onto an existing SAEP parent keycode (see here)
ECom.Shop: Included additional response information about the order's items when creating an order from a cart: LicenseAttributeValue, LicenseAttributeValueDescription, LicenseAttributeDescription, UsagePricingModelId, and UsagePricingModelName (see the Response Information of Items here)
Miscellaneous service improvements and documentation refinements

Published on Thursday, January 16, 2020

Version 1.0.20009.1 - Maintenance Update

ECom.Shop: Added possibility to specify a custom value for the VendorCustomerCode when creating a trial license. See the request Body Parameters description of the create trial call here.
ECom.Shop: Added information about the usage pricing model (if applicable) and the usage check date when querying details of an existing license. See the Profile member fields of the get license response here.
Miscellaneous error handling improvements and documentation refinements

Published on Wednesday, December 11, 2019

Version 1.0.19338.1 - Feature Update

NEW: Added possibility to order Carbonite O365 Backup via the ECom Shop APIs. The OTSF license category is now supported as well as specifying the desired usage pricing model (see the ItemsByAttributes specification when creating a cart here for example).

Published on Thursday, December 5, 2019

Version 1.0.19323.1 - Maintenance Update

Miscellaneous documentation refinements

Published on Thursday, November 7, 2019

Version 1.0.19294.1 - Feature Update

NEW: The ECom.Shop scope offers three additional APIs to obtain product license information (GetLicense and GetChildLicenses) and to create a trial license (CreateTrial)
NEW: Added one or more URI samples to the documentation of each API call. Scroll to the URI Sample(s) section of the endpoint status API specification here for example.
Miscellaneous documentation refinements and service optimizations

Published on Monday, September 23, 2019

Version 1.0.19226.1 - Feature Update

NEW: Added API methods to the SkyStatus.Site and SkyStatus.GSM scopes for querying DNS Protection agent status information. Further details can be found here and here.
Miscellaneous documentation refinements and service optimizations

Published on Thursday, June 27, 2019

Version 1.0.19170.1 - Feature Update

NEW: Added an OS field to endpoint-level usage reports that provides the endpoints' operating system. See the response information of related API actions here and here.

Published on Tuesday, May 28, 2019

Version 1.0.19135.1 - Feature Update

NEW: Added possibility to query user activity information for Webroot Security Awareness Training (WSAT) campaigns (see here)
Made some improvements to input and request parameters validation across multiple APIs
Added authentication API documentation to the API Reference section (in addition to what is already available in the Guide section here)
Miscellaneous documentation refinements

Published on Tuesday, March 12, 2019

Version 1.0.19070.2 - Maintenance Update

Resolved a problem in the ECom.Shop scope where an "invalid state" error was returned in case the state field was legitimately omitted (in applicable cases) when setting customers on a cart
Resolved a problem in the ECom.Licenses scope where an incorrect company name was returned when creating licenses
Miscellaneous documentation refinements

Published on Wednesday, February 27, 2019

Version 1.0.19042.1 - Feature Update

NEW: Added initial set of API methods for the new ECom.Shop scope, which will provide a new experience for ordering products via the API going forward
Miscellaneous documentation refinements

Published on Thursday, October 11, 2018

Version 1.0.18263.2 - Feature Update

Added possibility to query DNS Protection request records for certain categories (see here for details about the added by-category query or here for information about all available DNS Protection traffic information calls)
Miscellaneous documentation refinements and service optimizations

Published on Thursday, July 5, 2018

Version 1.0.18179.1 - Feature Update

NEW: Added possibility to query DNS Protection traffic summary data and blocked requests information (see here for available queries)
Adjusted handling of SkyStatus usage report queries when an effectiveDate is specified for which no report data is available yet (see the description of the effectiveDate parameter here for example)
Adjusted the default behavior when no effectiveDate value is passed to SkyStatus usage report queries. The behavior is now to return the most recent available report data, which will be the report data for the day before yesterday under normal circumstances.
Miscellaneous documentation refinements and service optimizations

Published on Monday, May 14, 2018

Version 1.0.18128.1 - Maintenance Update

Miscellaneous refinements and service optimizations

Published on Thursday, April 26, 2018

Version 1.0.18108.1 - Maintenance Update

Deprecated functionality: For DNS Protection management, removed possibility to create or modify DNSP policy mappings of type 'DynamicIP'

Published on Thursday, April 5, 2018

Version 1.0.18088.1 - Feature Update

NEW: Added a SkyStatus.Reporting scope which allows querying 30-day and one-day usage reports for the following areas:
Endpoint usage reports provide comprehensive GSM-level and Site-level information about WSA endpoints usage
DNS Protection usage reports provide a GSM-level and Site-level overview of seen DNS Protection activity
WSAT usage reports provide basic GSM-level and Site-level information about Webroot Security Awareness Training (WSAT) usage
Miscellaneous refinements and service optimizations

Published on Tuesday, March 27, 2018

Version 1.0.18080.1 - Feature Update

NEW: Added possibility to query a single sign-on link for accessing the console website without having to authenticate again (see here)
Included information in the API documentation to inform about the upcoming deprecation of DNSP policy mappings of type 'DynamicIP' (see here for more information)
Miscellaneous refinements and service optimizations

Published on Tuesday, February 27, 2018

Version 1.0.18050.4 - Feature Update

NEW: Added support for managing activation of the Webroot Security Awareness Training (WSAT) module for GSM sites via the console API
WSAT is now returned as a module when getting information about a given GSM console that has WSAT enabled (see here)
If WSAT is enabled for a site, it is now returned as a module when getting information about the list of sites on a GSM console (see here) or about a specific GSM site (see here)
Added the possibility to specify WSAT as a module when creating or editing a GSM site
NEW: Added a call to the console API which allows looking up site details by a given site keycode (see here)
Added a requirement notice about specifying a reasonable user-agent string in all API requests to the API Reference section
Added links to the Webroot website and the Webroot community location to the documentation homepage
Miscellaneous refinements and service optimizations

Published on Monday, December 18, 2017

Version 1.0.17346.1 - Maintenance Update

Corrected an issue in the ecom service extension which prevented updating module seats for a license while leaving endpoint protection seats unchanged
Corrected an issue in the ecom service extension which prevented license updates when using an alpha-numeric partner product identifier
Made some smaller refinements to the ecom, console, and skystatus service documentation
Miscellaneous refinements and service optimizations

Published on Thursday, October 19, 2017

Version 1.0.17291.1 - Maintenance Update

Miscellaneous documentation refinements and service optimizations

Published on Tuesday, September 26, 2017

Version 1.0.17262.1 - Feature Update

NEW: Added support for DNS Protection management to the console API
Added the possibility to provide a modules array when creating or editing a GSM site (see here and here)
Added a call to get information about a given GSM console including modules (see here)
Added a call to get information about DNS Protection categories (see here)
Added calls to get information about DNS Protection policies (see here and here)
Added calls to get information about DNS Protection policy mappings (see here and here)
Added calls to create and edit DNS Protection policy mappings (see here and here)
Added a call to delete DNS Protection mappings (see here)
Added modules array to response records when getting a list of sites for a GSM console (see here)
Added modules array to response records when getting information about a site (see here)

Published on Thursday, July 27, 2017

Version 1.0.17199.1 - Maintenance Update

Miscellaneous refinements and service optimizations

Published on Thursday, July 27, 2017

Version 1.0.17129.2 - Feature Update

NEW: Added support for managing license modules (e.g. DNS Protection) to ecom service extension calls
Added modules array to response record when querying details about an individual license (see here and here)
Added modules array to response record when querying child licenses (see here)
Added modules array to request and response records when creating a full license or a trial license (see here and here)
Added calls for adding a trial module to a given keycode or license id (see here and here)
Added modules array to request and response records when updating a license (see here and here)
Added calls for cancelling a module for a given keycode or license id (see here and here)

Published on Tuesday, April 11, 2017

Version 1.0.17096.1 - Feature Update

NEW: Parts of the Unity API documentation are now available in Japanese language. The language can be changed via the respective link in the page footer.
Miscellaneous service refinements

Published on Wednesday, March 15, 2017

Version 1.0.17067.1 - Maintenance Update

Extended the API Reference left-side navigation menu to include groups of API actions, if available (e.g. for Console GSM actions)
Added ContinuationToken field to the response of endpoint status requests (see here and here) to better facilitate custom continuation queries
Miscellaneous refinements and service optimizations

Published on Wednesday, December 21, 2016

Version 1.0.16355.2 - Maintenance Update

Added IsTrial field to response records when information about child licenses is queried via the ecom service extension (see here)
Added ExternalAccountId field to the response when information about a license is queried via the ecom service extension (see here and here)
Minor miscellaneous documentation refinements

Published on Tuesday, December 6, 2016

Version 1.0.16336.1 - Maintenance Update

Extended API reference documentation to show more suitable sample request and response data
Added service security improvements for better tracking invalid authentication attempts

Published on Wednesday, November 16, 2016

Version 1.0.16316.2 - Maintenance Update

Added AccessLevel field to information returned by the console get sites and get site queries to indicate the querying user's access permissions on the site(s)
Added information to the console addadminrequest documentation on how to obtain site access
Added usage information to the console edit site admins action
Adjusted API URLs displayed in images in the Getting Started guide

Published on Tuesday, October 11, 2016

Version 1.0.16280.1 - Maintenance Update

ECom service requests now return status code 403 (Forbidden) instead of 401 (Unauthorized) when a license request is denied, which better reflects the request result
Console service requests now return status code 403 (Forbidden) instead of 400 (Bad Request) for applicable error scenarios to better reflect the request result
Made some smaller refinements to parameter validation for certain Console and SkyStatus actions in order to prevent invalid input

Published on Monday, September 26, 2016

Version 1.0.16259.1 - Maintenance Update

Resolved a problem with the Endpoint Status GSM request which prevented querying individual endpoints using the machineId parameter
Added a notice to the console addadminrequest to warn about inherent consequences for the API-only user
Made some smaller updates to the documentation of certain API actions and model fields to correct minor inconsistencies

Published on Monday, August 29, 2016

Version 1.0.16237.3 - Feature Update

NEW: Added API methods for querying threat history information for a site, a group of endpoints, or a specific endpoint (see the Console GSM scope reference for more information)
NEW: Authenticating with a GSM console user also grants access to SkyStatus.GSM, SkyStatus.Site, and SkyStatus.Usage scopes for querying endpoint status information
Updated the documentation for the Comments field for the create site action to be a required field in accordance to the Global Site Manager (GSM) console
Made some smaller adjustments to the documentation of console actions to better align it with terms used in the GSM console
Deprecated duplicate routes to SkyStatus endpoint status queries in order to avoid confusion (see here and here). The duplicate routes will remain available for the foreseeable future, but it is advised to use the remaining API action in your implementations from now on.

Published on Monday, July 11, 2016

Version 1.0.16188.1 - Feature Update

NEW: Made the console APIs available on production environment (see the API Reference for more information)
Corrected a problem which caused ecom request to fail when the number of seats for a license is decreased (see here or here for more information)
Extended internal logging in order to better capture information about authentication related requests
Improved internal tracking and validation of data flowing to and from sub services
Streamlined the internal authentication process to be less dependent on sub service extensions

Published on Wednesday, June 15, 2016

Version 1.0.16167.1 - Maintenance Update

Corrected a problem which could cause authentication to fail in case the user name included dashes
Corrected not being able to renew client secrets under certain circumstances

Published on Monday, June 13, 2016

Version 1.0.16160.1 - Maintenance Update

Allow specifying keycodes with or without dashes in URL paths of ecom requests (previously keycodes had to be specified without dashes only)
Adjusted description of ecom delete license actions to say "cancel license" instead of "delete license", as it more clearly describes the executed operation
Streamlined various internal areas to reduce general resource usage

Published on Wednesday, April 13, 2016

Version 1.0.16095.1 - Maintenance Update

Improved reliability of SkyStatus requests when data does not match expected formats
Corrected some minor service framework and logging inconsistencies

Published on Thursday, March 17, 2016

Version 1.0.16075.2 - Maintenance Update

Added system to show important information on demand in the API documentation
Extended internal authentication data models to fit upcoming API needs
Improved flexibility of internal statistics reporting
Improved error handling and response when problems are encountered while browsing the online documentation
Implemented some minor service framework performance and reliability improvements

Published on Tuesday, February 9, 2016

Version 1.0.16039.1 - Maintenance Update

Extended documentation to enable displaying information about deprecated actions
Corrected a potentially misleading link in step 5 of the Getting Started guide
Made some smaller improvements to the internal logging system

Published on Thursday, January 14, 2016

Version 1.0.16014.2 - Maintenance Update

Added a Hidden field to endpoint information returned by SkyStatus requests (see the EndpointInfo response model for more information)
Corrected certain values not being processed properly in ecom requests for creating or updating licenses
Enabled the new layout for the API documentation to improve its legibility and presentation
Included additional remarks in documentation of individual actions and fields where applicable
Added a getting started guide to the API documentation, which describes a sample request flow including authentication and access token refresh
Made some smaller refinements to the authentication documentation

Published on Tuesday, October 20, 2015

Version 1.0.15293.2 - Maintenance Update

Resolved a problem with certain SkyStatus requests causing high CPU load

Published on Friday, October 16, 2015

Version 1.0.15271.1 - Maintenance Update

Added Deactivated and ActivationStatusTime fields to endpoint information returned by SkyStatus requests
Enhanced flexiblity of internal authentication flow in preparation for future service extensions
Adjusted log messages to improve consistency and to ease troubleshooting
Made some smaller enhancements to background worker components for logging

Published on Tuesday, September 15, 2015

Version 1.0.15258.3 - Maintenance Update

Corrected an error being returned when SkyStatus is queried with a GSM key that does not have any sites associated yet
Cleaned up and refined internal logging to improve overall resource consumption

Published on Monday, September 14, 2015

Version 1.0.15253.1 - Maintenance Update

Reduced the length of SkyStatus continuation URIs to avoid running into length limits
Corrected wrong scheme name being set in SkyStatus continuation URIs
Resolved a (de-)serialization problem with SkyStatus continuation URIs that could cause continuation requests to fail
Resolved a problem that caused the API reference documentation not consistently showing all available groups of API methods
Added information to the authentication documentation about how to identify expired refresh tokens
Cleaned up a number of minor documentation shortcomings

Published on Tuesday, September 1, 2015

Version 1.0.15243.3 - Maintenance Update

NEW: Added method to query orders by vendor code (GetOrderByVendorCode) to the ecom service extension
Resolved a data conversion error when specifying optional date-time values in ecom requests
Ensured that the kind of date-time values is consistently handled with all ecom requests

Published on Wednesday, August 19, 2015

Version 1.0.15231.1 - Maintenance Update

Extended and cleaned up internal data models in preparation for supporting upcoming APIs
Applied various smaller bug fixes

Published on Tuesday, August 4, 2015

Version 1.0.15216.2 - Feature Update

NEW: Added API methods to query device usage statistics for a given site or gsm keycode
NEW: Added a set of additional data points (e.g. hostname) to endpoint information returned in SkyStatus requests
Documentation: Added information describing new API methods and data points
Integrated enhanced caching for improved API request performance
Made some further smaller improvements to error information returned in case of request errors

Published on Thursday, July 16, 2015

Version 1.0.15197.1 - Maintenance Update

Applied change to return correct error status code 401, instead of 500, when using an access token that has already been superseded by a refreshed access token
Corrected that an error response body was occasionally encoded in the default JSON format although the request specified accept type XML
Made some further smaller improvements to error information returned in case of request errors
Documentation: For authentication, added recommendation to specify client id and client secret in the Authorization header as suggested by the OAuth standard
Documentation: Changed API Reference menu item at the top of the page into a drop-down menu, providing direct access to individual API documentation areas
Documentation: Added general information about request authorization on the API Reference page
Documentation: Added information about required scope for each group of API methods on the API Reference page
Documentation: Made some smaller text improvements and corrections

Published on Thursday, July 9, 2015

Version 1.0.15190.2 - Maintenance Update

Applied smaller corrections to API documentation
Made some general service reliability improvements
Enhanced information returned in case of request errors
Resolved a problem with refreshing access tokens when using explicit scopes
Improved handling of scopes that are allowed for the calling user

Published on Tuesday, June 30, 2015

Version 1.0.15181.1 - Maintenance Update

Split SkyStatus scopes from SkyStatus.Endpoints to SkyStatus.Site and SkyStatus.GSM
Corrected route prefix values for authentication request
Updated SkyStatus service module to resolve various smaller shortcomings
Added endpoint for querying service version information (api/health/version)
Improved handling of 404 (Not Found) and 405 (Method Not Allowed) errors
Corrected error 500 (Internal Server Error) returned for ecom API requests

Published on Tuesday, June 16, 2015

Version 1.0.15168.1 - Initial Stable Development Build

Single, scope based authentication
Support for e-commerce licensing and ordering API
Support for endpoint status queries
Initial version of API documentation made available